From d6c2d6bd66cd60ce5ae87cc5bc5bee1909b59b4f Mon Sep 17 00:00:00 2001 From: Arnau Casau <47946624+arnaucasau@users.noreply.github.com> Date: Tue, 23 Jan 2024 22:29:18 +0100 Subject: [PATCH] Regeneration Qiskit v0.32 API docs (#684) Part of #542. Regeneration of the Qiskit API docs (historical versions) with the methods inlined and the GitHub source links. Given the number of files modified, the regeneration is split into different PRs. This one only updates the version 0.32. All the GitHub source links work! --- docs/api/qiskit/0.32/_toc.json | 5977 ++++++++++++++++- docs/api/qiskit/0.32/aer_extensions.md | 16 +- docs/api/qiskit/0.32/aer_jobs.md | 8 +- docs/api/qiskit/0.32/aer_library.md | 148 +- docs/api/qiskit/0.32/aer_noise.md | 64 +- docs/api/qiskit/0.32/aer_provider.md | 30 +- docs/api/qiskit/0.32/aer_pulse.md | 12 +- docs/api/qiskit/0.32/aer_utils.md | 20 +- docs/api/qiskit/0.32/algorithms.md | 110 +- docs/api/qiskit/0.32/assembler.md | 24 +- docs/api/qiskit/0.32/characterization.md | 68 +- docs/api/qiskit/0.32/circuit.md | 62 +- docs/api/qiskit/0.32/circuit_library.md | 436 +- docs/api/qiskit/0.32/classicalfunction.md | 18 +- docs/api/qiskit/0.32/compiler.md | 12 +- docs/api/qiskit/0.32/converters.md | 22 +- docs/api/qiskit/0.32/dagcircuit.md | 18 +- docs/api/qiskit/0.32/execute.md | 28 +- docs/api/qiskit/0.32/extensions.md | 20 +- docs/api/qiskit/0.32/ibmq_credentials.md | 16 +- docs/api/qiskit/0.32/ibmq_experiment.md | 22 +- docs/api/qiskit/0.32/ibmq_job.md | 28 +- docs/api/qiskit/0.32/ibmq_managed.md | 28 +- docs/api/qiskit/0.32/ibmq_provider.md | 50 +- docs/api/qiskit/0.32/ibmq_random.md | 10 +- docs/api/qiskit/0.32/ibmq_runtime.md | 38 +- docs/api/qiskit/0.32/ibmq_utils.md | 22 +- docs/api/qiskit/0.32/logging.md | 16 +- docs/api/qiskit/0.32/measurement.md | 14 +- docs/api/qiskit/0.32/mitigation.md | 32 +- docs/api/qiskit/0.32/opflow.md | 24 +- docs/api/qiskit/0.32/providers.md | 92 +- docs/api/qiskit/0.32/providers_basicaer.md | 28 +- docs/api/qiskit/0.32/providers_models.md | 24 +- docs/api/qiskit/0.32/pulse.md | 214 +- docs/api/qiskit/0.32/qasm.md | 18 +- .../0.32/qiskit.algorithms.AlgorithmError.md | 13 +- .../qiskit.algorithms.AmplificationProblem.md | 27 +- .../qiskit.algorithms.AmplitudeEstimation.md | 139 +- ...it.algorithms.AmplitudeEstimationResult.md | 61 +- .../qiskit.algorithms.AmplitudeEstimator.md | 31 +- ...kit.algorithms.AmplitudeEstimatorResult.md | 47 +- .../0.32/qiskit.algorithms.Eigensolver.md | 53 +- .../qiskit.algorithms.EigensolverResult.md | 37 +- .../qiskit.algorithms.EstimationProblem.md | 45 +- ...it.algorithms.FasterAmplitudeEstimation.md | 58 +- ...orithms.FasterAmplitudeEstimationResult.md | 55 +- .../qiskit/0.32/qiskit.algorithms.Grover.md | 88 +- .../0.32/qiskit.algorithms.GroverResult.md | 43 +- docs/api/qiskit/0.32/qiskit.algorithms.HHL.md | 76 +- ...t.algorithms.HamiltonianPhaseEstimation.md | 47 +- ...rithms.HamiltonianPhaseEstimationResult.md | 64 +- ...algorithms.IterativeAmplitudeEstimation.md | 62 +- ...thms.IterativeAmplitudeEstimationResult.md | 63 +- ...kit.algorithms.IterativePhaseEstimation.md | 63 +- .../0.32/qiskit.algorithms.LinearSolver.md | 39 +- .../qiskit.algorithms.LinearSolverResult.md | 39 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 112 +- ...imumLikelihoodAmplitudeEstimationResult.md | 57 +- .../qiskit.algorithms.MinimumEigensolver.md | 55 +- ...kit.algorithms.MinimumEigensolverResult.md | 37 +- .../qiskit.algorithms.NumPyEigensolver.md | 57 +- .../qiskit.algorithms.NumPyLinearSolver.md | 39 +- ...skit.algorithms.NumPyMinimumEigensolver.md | 57 +- .../0.32/qiskit.algorithms.PhaseEstimation.md | 73 +- ...qiskit.algorithms.PhaseEstimationResult.md | 63 +- .../qiskit.algorithms.PhaseEstimationScale.md | 91 +- .../api/qiskit/0.32/qiskit.algorithms.QAOA.md | 269 +- .../api/qiskit/0.32/qiskit.algorithms.Shor.md | 81 +- .../0.32/qiskit.algorithms.ShorResult.md | 37 +- docs/api/qiskit/0.32/qiskit.algorithms.VQE.md | 263 +- .../0.32/qiskit.algorithms.optimizers.ADAM.md | 222 +- .../0.32/qiskit.algorithms.optimizers.AQGD.md | 173 +- .../qiskit.algorithms.optimizers.BOBYQA.md | 141 +- .../0.32/qiskit.algorithms.optimizers.CG.md | 157 +- .../qiskit.algorithms.optimizers.COBYLA.md | 157 +- .../0.32/qiskit.algorithms.optimizers.CRS.md | 174 +- .../qiskit.algorithms.optimizers.DIRECT_L.md | 172 +- ...kit.algorithms.optimizers.DIRECT_L_RAND.md | 174 +- .../0.32/qiskit.algorithms.optimizers.ESCH.md | 172 +- .../0.32/qiskit.algorithms.optimizers.GSLS.md | 278 +- ...t.algorithms.optimizers.GradientDescent.md | 157 +- .../qiskit.algorithms.optimizers.IMFIL.md | 141 +- .../qiskit.algorithms.optimizers.ISRES.md | 172 +- .../qiskit.algorithms.optimizers.L_BFGS_B.md | 157 +- ...iskit.algorithms.optimizers.NELDER_MEAD.md | 157 +- .../0.32/qiskit.algorithms.optimizers.NFT.md | 157 +- .../qiskit.algorithms.optimizers.Optimizer.md | 157 +- ...rithms.optimizers.OptimizerSupportLevel.md | 21 +- .../qiskit.algorithms.optimizers.POWELL.md | 157 +- .../qiskit.algorithms.optimizers.P_BFGS.md | 159 +- .../qiskit.algorithms.optimizers.QNSPSA.md | 237 +- .../qiskit.algorithms.optimizers.SLSQP.md | 157 +- .../qiskit.algorithms.optimizers.SNOBFIT.md | 141 +- .../0.32/qiskit.algorithms.optimizers.SPSA.md | 206 +- ...it.algorithms.optimizers.SciPyOptimizer.md | 157 +- .../0.32/qiskit.algorithms.optimizers.TNC.md | 159 +- .../0.32/qiskit.algorithms.optimizers.md | 70 +- docs/api/qiskit/0.32/qiskit.aqua.AquaError.md | 13 +- ...qiskit.aqua.MissingOptionalLibraryError.md | 13 +- .../0.32/qiskit.aqua.QuantumInstance.md | 174 +- ...kit.aqua.algorithms.AmplitudeEstimation.md | 167 +- ...thms.AmplitudeEstimationAlgorithmResult.md | 151 +- ...ua.algorithms.AmplitudeEstimationResult.md | 171 +- ...iskit.aqua.algorithms.BernsteinVazirani.md | 80 +- ...skit.aqua.algorithms.ClassicalAlgorithm.md | 33 +- .../qiskit.aqua.algorithms.ClassicalCPLEX.md | 35 +- .../qiskit.aqua.algorithms.DeutschJozsa.md | 82 +- .../qiskit/0.32/qiskit.aqua.algorithms.EOH.md | 76 +- .../qiskit.aqua.algorithms.Eigensolver.md | 57 +- ...iskit.aqua.algorithms.EigensolverResult.md | 149 +- .../0.32/qiskit.aqua.algorithms.Grover.md | 157 +- .../qiskit.aqua.algorithms.GroverResult.md | 153 +- .../qiskit/0.32/qiskit.aqua.algorithms.HHL.md | 152 +- .../0.32/qiskit.aqua.algorithms.HHLResult.md | 155 +- .../0.32/qiskit.aqua.algorithms.IQPE.md | 131 +- ...algorithms.IterativeAmplitudeEstimation.md | 147 +- ...thms.IterativeAmplitudeEstimationResult.md | 165 +- ...skit.aqua.algorithms.LinearsolverResult.md | 145 +- ...ms.MaximumLikelihoodAmplitudeEstimation.md | 169 +- ...imumLikelihoodAmplitudeEstimationResult.md | 157 +- ...skit.aqua.algorithms.MinimumEigensolver.md | 59 +- ...qua.algorithms.MinimumEigensolverResult.md | 149 +- ...qiskit.aqua.algorithms.NumPyEigensolver.md | 80 +- .../qiskit.aqua.algorithms.NumPyLSsolver.md | 35 +- ...kit.aqua.algorithms.NumPyLSsolverResult.md | 147 +- ...aqua.algorithms.NumPyMinimumEigensolver.md | 80 +- .../0.32/qiskit.aqua.algorithms.QAOA.md | 282 +- .../0.32/qiskit.aqua.algorithms.QGAN.md | 136 +- .../qiskit/0.32/qiskit.aqua.algorithms.QPE.md | 125 +- .../0.32/qiskit.aqua.algorithms.QSVM.md | 287 +- ...qiskit.aqua.algorithms.QuantumAlgorithm.md | 59 +- .../0.32/qiskit.aqua.algorithms.Shor.md | 93 +- .../0.32/qiskit.aqua.algorithms.Simon.md | 82 +- .../0.32/qiskit.aqua.algorithms.SklearnSVM.md | 126 +- .../qiskit/0.32/qiskit.aqua.algorithms.VQC.md | 296 +- .../qiskit/0.32/qiskit.aqua.algorithms.VQE.md | 276 +- .../api/qiskit/0.32/qiskit.aqua.algorithms.md | 126 +- .../qiskit/0.32/qiskit.aqua.circuits.CNF.md | 67 +- .../qiskit/0.32/qiskit.aqua.circuits.DNF.md | 67 +- .../qiskit/0.32/qiskit.aqua.circuits.ESOP.md | 69 +- ...it.aqua.circuits.PhaseEstimationCircuit.md | 53 +- ...qiskit.aqua.circuits.StateVectorCircuit.md | 42 +- ...iskit.aqua.circuits.WeightedSumOperator.md | 172 +- docs/api/qiskit/0.32/qiskit.aqua.circuits.md | 16 +- ...qiskit.aqua.components.eigs.Eigenvalues.md | 87 +- .../qiskit.aqua.components.eigs.EigsQPE.md | 89 +- .../0.32/qiskit.aqua.components.eigs.md | 14 +- ...aqua.components.feature_maps.FeatureMap.md | 61 +- ...omponents.feature_maps.RawFeatureVector.md | 66 +- .../qiskit.aqua.components.feature_maps.md | 12 +- ...t.aqua.components.initial_states.Custom.md | 46 +- ....components.initial_states.InitialState.md | 42 +- ....components.initial_states.VarFormBased.md | 45 +- ...kit.aqua.components.initial_states.Zero.md | 42 +- .../qiskit.aqua.components.initial_states.md | 20 +- .../api/qiskit/0.32/qiskit.aqua.components.md | 6 +- ...mponents.multiclass_extensions.AllPairs.md | 88 +- ...lticlass_extensions.ErrorCorrectingCode.md | 84 +- ...lticlass_extensions.MulticlassExtension.md | 68 +- ...ts.multiclass_extensions.OneAgainstRest.md | 88 +- ...t.aqua.components.multiclass_extensions.md | 18 +- ...s.neural_networks.DiscriminativeNetwork.md | 117 +- ...nents.neural_networks.GenerativeNetwork.md | 108 +- ...ents.neural_networks.NumPyDiscriminator.md | 115 +- ...ts.neural_networks.PyTorchDiscriminator.md | 153 +- ...onents.neural_networks.QuantumGenerator.md | 148 +- .../qiskit.aqua.components.neural_networks.md | 20 +- .../qiskit.aqua.components.optimizers.ADAM.md | 220 +- .../qiskit.aqua.components.optimizers.AQGD.md | 171 +- ...iskit.aqua.components.optimizers.BOBYQA.md | 139 +- .../qiskit.aqua.components.optimizers.CG.md | 155 +- ...iskit.aqua.components.optimizers.COBYLA.md | 155 +- .../qiskit.aqua.components.optimizers.CRS.md | 172 +- ...kit.aqua.components.optimizers.DIRECT_L.md | 170 +- ...qua.components.optimizers.DIRECT_L_RAND.md | 172 +- .../qiskit.aqua.components.optimizers.ESCH.md | 170 +- .../qiskit.aqua.components.optimizers.GSLS.md | 276 +- ...qiskit.aqua.components.optimizers.IMFIL.md | 139 +- ...qiskit.aqua.components.optimizers.ISRES.md | 170 +- ...kit.aqua.components.optimizers.L_BFGS_B.md | 155 +- ....aqua.components.optimizers.NELDER_MEAD.md | 155 +- .../qiskit.aqua.components.optimizers.NFT.md | 155 +- ...it.aqua.components.optimizers.Optimizer.md | 155 +- ...onents.optimizers.OptimizerSupportLevel.md | 21 +- ...iskit.aqua.components.optimizers.POWELL.md | 155 +- ...iskit.aqua.components.optimizers.P_BFGS.md | 157 +- ...qiskit.aqua.components.optimizers.SLSQP.md | 155 +- ...skit.aqua.components.optimizers.SNOBFIT.md | 139 +- .../qiskit.aqua.components.optimizers.SPSA.md | 155 +- .../qiskit.aqua.components.optimizers.TNC.md | 157 +- .../0.32/qiskit.aqua.components.optimizers.md | 64 +- ....components.oracles.CustomCircuitOracle.md | 47 +- ...ponents.oracles.LogicalExpressionOracle.md | 42 +- .../qiskit.aqua.components.oracles.Oracle.md | 35 +- ...qua.components.oracles.TruthTableOracle.md | 46 +- .../0.32/qiskit.aqua.components.oracles.md | 18 +- ...qua.components.reciprocals.LongDivision.md | 59 +- ...a.components.reciprocals.LookupRotation.md | 58 +- ....aqua.components.reciprocals.Reciprocal.md | 51 +- .../qiskit.aqua.components.reciprocals.md | 16 +- ...ncertainty_models.BernoulliDistribution.md | 180 +- ...ls.GaussianConditionalIndependenceModel.md | 169 +- ...ncertainty_models.LogNormalDistribution.md | 178 +- ...rtainty_models.MultivariateDistribution.md | 169 +- ...odels.MultivariateLogNormalDistribution.md | 169 +- ...y_models.MultivariateNormalDistribution.md | 169 +- ..._models.MultivariateUniformDistribution.md | 169 +- ...els.MultivariateVariationalDistribution.md | 182 +- ...s.uncertainty_models.NormalDistribution.md | 178 +- ...nts.uncertainty_models.UncertaintyModel.md | 153 +- ....uncertainty_models.UniformDistribution.md | 178 +- ...certainty_models.UnivariateDistribution.md | 180 +- ...odels.UnivariateVariationalDistribution.md | 191 +- ...skit.aqua.components.uncertainty_models.md | 40 +- ...ncertainty_problems.MultivariateProblem.md | 162 +- ...uncertainty_problems.UncertaintyProblem.md | 162 +- ...lems.UnivariatePiecewiseLinearObjective.md | 153 +- ....uncertainty_problems.UnivariateProblem.md | 162 +- ...it.aqua.components.uncertainty_problems.md | 20 +- ...nents.variational_forms.VariationalForm.md | 66 +- ...iskit.aqua.components.variational_forms.md | 8 +- .../qiskit.aqua.operators.OperatorBase.md | 367 +- ...qua.operators.converters.AbelianGrouper.md | 62 +- ...qua.operators.converters.CircuitSampler.md | 87 +- ...aqua.operators.converters.ConverterBase.md | 35 +- ...a.operators.converters.DictToCircuitSum.md | 35 +- ...a.operators.converters.PauliBasisChange.md | 245 +- .../0.32/qiskit.aqua.operators.converters.md | 22 +- ...aqua.operators.evolutions.EvolutionBase.md | 35 +- ...a.operators.evolutions.EvolutionFactory.md | 39 +- ...kit.aqua.operators.evolutions.EvolvedOp.md | 466 +- ...ua.operators.evolutions.MatrixEvolution.md | 35 +- ...rators.evolutions.PauliTrotterEvolution.md | 71 +- ...qiskit.aqua.operators.evolutions.QDrift.md | 41 +- ...qiskit.aqua.operators.evolutions.Suzuki.md | 43 +- ...iskit.aqua.operators.evolutions.Trotter.md | 43 +- ...operators.evolutions.TrotterizationBase.md | 41 +- ...rators.evolutions.TrotterizationFactory.md | 40 +- .../0.32/qiskit.aqua.operators.evolutions.md | 40 +- ...rators.expectations.AerPauliExpectation.md | 56 +- ....operators.expectations.CVaRExpectation.md | 58 +- ....operators.expectations.ExpectationBase.md | 56 +- ...erators.expectations.ExpectationFactory.md | 41 +- ...perators.expectations.MatrixExpectation.md | 56 +- ...operators.expectations.PauliExpectation.md | 56 +- .../qiskit.aqua.operators.expectations.md | 24 +- ...qua.operators.gradients.CircuitGradient.md | 38 +- ...kit.aqua.operators.gradients.CircuitQFI.md | 38 +- ...aqua.operators.gradients.DerivativeBase.md | 84 +- ...iskit.aqua.operators.gradients.Gradient.md | 116 +- ...t.aqua.operators.gradients.GradientBase.md | 86 +- ...qiskit.aqua.operators.gradients.Hessian.md | 116 +- ...it.aqua.operators.gradients.HessianBase.md | 86 +- ...qua.operators.gradients.NaturalGradient.md | 91 +- .../qiskit.aqua.operators.gradients.QFI.md | 84 +- ...qiskit.aqua.operators.gradients.QFIBase.md | 88 +- .../0.32/qiskit.aqua.operators.gradients.md | 32 +- ...qua.operators.legacy.LegacyBaseOperator.md | 83 +- ...it.aqua.operators.legacy.MatrixOperator.md | 225 +- ...qiskit.aqua.operators.legacy.PauliGraph.md | 15 +- ....legacy.TPBGroupedWeightedPauliOperator.md | 600 +- ....operators.legacy.WeightedPauliOperator.md | 545 +- ...skit.aqua.operators.legacy.Z2Symmetries.md | 160 +- ...ua.operators.legacy.check_commutativity.md | 17 +- ...qiskit.aqua.operators.legacy.commutator.md | 21 +- ...qiskit.aqua.operators.legacy.covariance.md | 17 +- ....operators.legacy.evolution_instruction.md | 21 +- .../qiskit.aqua.operators.legacy.kernel_F2.md | 13 +- .../0.32/qiskit.aqua.operators.legacy.md | 38 +- ...t.aqua.operators.legacy.measure_pauli_z.md | 15 +- ...aqua.operators.legacy.pauli_measurement.md | 23 +- ...it.aqua.operators.legacy.row_echelon_F2.md | 13 +- ...egacy.suzuki_expansion_slice_pauli_list.md | 15 +- ...skit.aqua.operators.list_ops.ComposedOp.md | 531 +- .../qiskit.aqua.operators.list_ops.ListOp.md | 493 +- ...qiskit.aqua.operators.list_ops.SummedOp.md | 563 +- ...skit.aqua.operators.list_ops.TensoredOp.md | 514 +- .../0.32/qiskit.aqua.operators.list_ops.md | 20 +- docs/api/qiskit/0.32/qiskit.aqua.operators.md | 8 +- ....aqua.operators.primitive_ops.CircuitOp.md | 462 +- ...t.aqua.operators.primitive_ops.MatrixOp.md | 466 +- ...it.aqua.operators.primitive_ops.PauliOp.md | 508 +- ...qua.operators.primitive_ops.PrimitiveOp.md | 466 +- .../qiskit.aqua.operators.primitive_ops.md | 12 +- ...qua.operators.state_fns.CVaRMeasurement.md | 541 +- ...aqua.operators.state_fns.CircuitStateFn.md | 517 +- ...it.aqua.operators.state_fns.DictStateFn.md | 496 +- ...qua.operators.state_fns.OperatorStateFn.md | 465 +- ...qiskit.aqua.operators.state_fns.StateFn.md | 462 +- ....aqua.operators.state_fns.VectorStateFn.md | 492 +- .../0.32/qiskit.aqua.operators.state_fns.md | 16 +- .../0.32/qiskit.aqua.utils.CircuitFactory.md | 153 +- .../qiskit.aqua.utils.decimal_to_binary.md | 13 +- .../qiskit.aqua.utils.get_entangler_map.md | 13 +- ...qiskit.aqua.utils.get_feature_dimension.md | 13 +- .../0.32/qiskit.aqua.utils.get_num_classes.md | 13 +- ...aqua.utils.get_subsystem_density_matrix.md | 13 +- ...qiskit.aqua.utils.get_subsystems_counts.md | 13 +- .../qiskit/0.32/qiskit.aqua.utils.has_aer.md | 13 +- .../qiskit/0.32/qiskit.aqua.utils.has_ibmq.md | 13 +- ...skit.aqua.utils.map_label_to_class_name.md | 13 +- docs/api/qiskit/0.32/qiskit.aqua.utils.md | 48 +- .../0.32/qiskit.aqua.utils.name_args.md | 13 +- .../0.32/qiskit.aqua.utils.optimize_svm.md | 15 +- .../0.32/qiskit.aqua.utils.random_h1_body.md | 13 +- .../0.32/qiskit.aqua.utils.random_h2_body.md | 13 +- .../qiskit.aqua.utils.random_hermitian.md | 13 +- .../qiskit.aqua.utils.random_non_hermitian.md | 13 +- .../0.32/qiskit.aqua.utils.random_unitary.md | 13 +- ...qiskit.aqua.utils.reduce_dim_to_via_pca.md | 13 +- ....utils.split_dataset_to_data_and_labels.md | 13 +- .../qiskit.aqua.utils.summarize_circuits.md | 15 +- .../0.32/qiskit.aqua.utils.tensorproduct.md | 13 +- ...iskit.aqua.utils.validate_entangler_map.md | 13 +- .../qiskit/0.32/qiskit.assembler.RunConfig.md | 62 +- .../qiskit.assembler.assemble_circuits.md | 13 +- .../qiskit.assembler.assemble_schedules.md | 13 +- .../0.32/qiskit.assembler.disassemble.md | 15 +- .../0.32/qiskit.chemistry.BosonicOperator.md | 84 +- .../qiskit.chemistry.FermionicOperator.md | 179 +- .../qiskit/0.32/qiskit.chemistry.MP2Info.md | 71 +- .../qiskit/0.32/qiskit.chemistry.QMolecule.md | 196 +- .../qiskit.chemistry.QiskitChemistryError.md | 13 +- .../qiskit.chemistry.WatsonHamiltonian.md | 17 +- .../qiskit.chemistry.algorithms.AdaptVQE.md | 79 +- ...iskit.chemistry.algorithms.BOPESSampler.md | 42 +- ...chemistry.algorithms.EigensolverFactory.md | 35 +- ...try.algorithms.ExcitedStatesEigensolver.md | 44 +- ...hemistry.algorithms.ExcitedStatesSolver.md | 36 +- ...istry.algorithms.GroundStateEigensolver.md | 79 +- ....chemistry.algorithms.GroundStateSolver.md | 77 +- ...ry.algorithms.MinimumEigensolverFactory.md | 48 +- ...stry.algorithms.NumPyEigensolverFactory.md | 41 +- ...gorithms.NumPyMinimumEigensolverFactory.md | 48 +- ...istry.algorithms.OrbitalOptimizationVQE.md | 81 +- .../0.32/qiskit.chemistry.algorithms.QEOM.md | 40 +- .../qiskit.chemistry.algorithms.QEomEE.md | 80 +- .../qiskit.chemistry.algorithms.QEomVQE.md | 274 +- .../qiskit.chemistry.algorithms.VQEAdapt.md | 150 +- ...it.chemistry.algorithms.VQEUCCSDFactory.md | 70 +- ...t.chemistry.algorithms.VQEUVCCSDFactory.md | 58 +- .../0.32/qiskit.chemistry.algorithms.md | 72 +- ...ry.algorithms.pes_samplers.BOPESSampler.md | 42 +- ...s.pes_samplers.DifferentialExtrapolator.md | 63 +- ...thms.pes_samplers.EnergySurface1DSpline.md | 108 +- ...gorithms.pes_samplers.EnergySurfaceBase.md | 120 +- ...ry.algorithms.pes_samplers.Extrapolator.md | 62 +- ...gorithms.pes_samplers.HarmonicPotential.md | 289 +- ....algorithms.pes_samplers.MorsePotential.md | 268 +- ...algorithms.pes_samplers.PCAExtrapolator.md | 65 +- ...hms.pes_samplers.PolynomialExtrapolator.md | 62 +- ...y.algorithms.pes_samplers.PotentialBase.md | 203 +- ...gorithms.pes_samplers.SieveExtrapolator.md | 62 +- ...thms.pes_samplers.VibronicStructureBase.md | 94 +- ...orithms.pes_samplers.WindowExtrapolator.md | 66 +- ...iskit.chemistry.algorithms.pes_samplers.md | 38 +- ...applications.MolecularGroundStateEnergy.md | 64 +- .../0.32/qiskit.chemistry.applications.md | 6 +- ...y.components.bosonic_bases.BosonicBasis.md | 39 +- ....components.bosonic_bases.HarmonicBasis.md | 39 +- ...skit.chemistry.components.bosonic_bases.md | 8 +- ...y.components.initial_states.HartreeFock.md | 42 +- ...hemistry.components.initial_states.VSCF.md | 42 +- ...kit.chemistry.components.initial_states.md | 10 +- ...mistry.components.variational_forms.CHC.md | 72 +- ...stry.components.variational_forms.UCCSD.md | 255 +- ...istry.components.variational_forms.UVCC.md | 116 +- ....chemistry.components.variational_forms.md | 12 +- ...qiskit.chemistry.core.ChemistryOperator.md | 66 +- .../0.32/qiskit.chemistry.core.Hamiltonian.md | 60 +- ...chemistry.core.MolecularChemistryResult.md | 138 +- ...istry.core.MolecularExcitedStatesResult.md | 140 +- ...emistry.core.MolecularGroundStateResult.md | 198 +- .../qiskit.chemistry.core.QubitMappingType.md | 19 +- ...iskit.chemistry.core.TransformationType.md | 17 +- docs/api/qiskit/0.32/qiskit.chemistry.core.md | 26 +- .../qiskit.chemistry.drivers.BaseDriver.md | 23 +- .../qiskit.chemistry.drivers.BasisType.md | 19 +- .../qiskit.chemistry.drivers.BosonicDriver.md | 41 +- .../qiskit.chemistry.drivers.FCIDumpDriver.md | 61 +- ...iskit.chemistry.drivers.FermionicDriver.md | 41 +- ...qiskit.chemistry.drivers.GaussianDriver.md | 41 +- ....chemistry.drivers.GaussianForcesDriver.md | 41 +- ...kit.chemistry.drivers.GaussianLogDriver.md | 49 +- ...kit.chemistry.drivers.GaussianLogResult.md | 45 +- .../qiskit.chemistry.drivers.HDF5Driver.md | 47 +- .../qiskit.chemistry.drivers.HFMethodType.md | 19 +- .../qiskit.chemistry.drivers.InitialGuess.md | 19 +- .../0.32/qiskit.chemistry.drivers.Molecule.md | 152 +- .../qiskit.chemistry.drivers.PSI4Driver.md | 41 +- ...qiskit.chemistry.drivers.PyQuanteDriver.md | 41 +- .../qiskit.chemistry.drivers.PySCFDriver.md | 41 +- .../qiskit.chemistry.drivers.UnitsType.md | 17 +- .../qiskit/0.32/qiskit.chemistry.drivers.md | 62 +- ...it.chemistry.results.BOPESSamplerResult.md | 33 +- ...skit.chemistry.results.EigenstateResult.md | 142 +- ...istry.results.ElectronicStructureResult.md | 208 +- ...emistry.results.VibronicStructureResult.md | 150 +- .../qiskit/0.32/qiskit.chemistry.results.md | 12 +- ...transformations.BosonicQubitMappingType.md | 15 +- ...y.transformations.BosonicTransformation.md | 97 +- ...ansformations.BosonicTransformationType.md | 15 +- ...ansformations.FermionicQubitMappingType.md | 19 +- ...transformations.FermionicTransformation.md | 103 +- ...sformations.FermionicTransformationType.md | 17 +- ...hemistry.transformations.Transformation.md | 91 +- .../0.32/qiskit.chemistry.transformations.md | 26 +- .../0.32/qiskit.circuit.AncillaQubit.md | 21 +- .../0.32/qiskit.circuit.AncillaRegister.md | 33 +- .../0.32/qiskit.circuit.ClassicalRegister.md | 33 +- docs/api/qiskit/0.32/qiskit.circuit.Clbit.md | 21 +- .../0.32/qiskit.circuit.ControlledGate.md | 341 +- docs/api/qiskit/0.32/qiskit.circuit.Delay.md | 239 +- .../0.32/qiskit.circuit.EquivalenceLibrary.md | 123 +- docs/api/qiskit/0.32/qiskit.circuit.Gate.md | 345 +- .../qiskit/0.32/qiskit.circuit.Instruction.md | 238 +- .../0.32/qiskit.circuit.InstructionSet.md | 41 +- .../api/qiskit/0.32/qiskit.circuit.Measure.md | 238 +- .../qiskit/0.32/qiskit.circuit.Parameter.md | 195 +- .../qiskit.circuit.ParameterExpression.md | 215 +- .../0.32/qiskit.circuit.ParameterVector.md | 38 +- .../0.32/qiskit.circuit.QuantumCircuit.md | 3003 ++++++++- .../0.32/qiskit.circuit.QuantumRegister.md | 33 +- docs/api/qiskit/0.32/qiskit.circuit.Qubit.md | 21 +- docs/api/qiskit/0.32/qiskit.circuit.Reset.md | 238 +- ...uit.classicalfunction.BooleanExpression.md | 411 +- ...uit.classicalfunction.ClassicalFunction.md | 430 +- ...tion.ClassicalFunctionCompilerTypeError.md | 13 +- ...calfunction.ClassicalFunctionParseError.md | 13 +- .../qiskit/0.32/qiskit.circuit.library.AND.md | 45 +- .../0.32/qiskit.circuit.library.Barrier.md | 66 +- .../0.32/qiskit.circuit.library.C3SXGate.md | 41 +- .../0.32/qiskit.circuit.library.C3XGate.md | 64 +- .../0.32/qiskit.circuit.library.C4XGate.md | 64 +- .../0.32/qiskit.circuit.library.CCXGate.md | 64 +- ...it.circuit.library.CDKMRippleCarryAdder.md | 47 +- .../0.32/qiskit.circuit.library.CHGate.md | 41 +- .../0.32/qiskit.circuit.library.CPhaseGate.md | 64 +- .../0.32/qiskit.circuit.library.CRXGate.md | 41 +- .../0.32/qiskit.circuit.library.CRYGate.md | 41 +- .../0.32/qiskit.circuit.library.CRZGate.md | 41 +- .../0.32/qiskit.circuit.library.CSXGate.md | 31 +- .../0.32/qiskit.circuit.library.CSwapGate.md | 41 +- .../0.32/qiskit.circuit.library.CU1Gate.md | 64 +- .../0.32/qiskit.circuit.library.CU3Gate.md | 43 +- .../0.32/qiskit.circuit.library.CUGate.md | 43 +- .../0.32/qiskit.circuit.library.CXGate.md | 64 +- .../0.32/qiskit.circuit.library.CYGate.md | 41 +- .../0.32/qiskit.circuit.library.CZGate.md | 41 +- .../0.32/qiskit.circuit.library.DCXGate.md | 25 +- .../0.32/qiskit.circuit.library.Diagonal.md | 45 +- .../qiskit.circuit.library.DraperQFTAdder.md | 47 +- .../0.32/qiskit.circuit.library.ECRGate.md | 35 +- .../qiskit.circuit.library.EfficientSU2.md | 77 +- ...t.circuit.library.EvolvedOperatorAnsatz.md | 63 +- ...it.circuit.library.ExcitationPreserving.md | 77 +- .../qiskit.circuit.library.FourierChecking.md | 45 +- ...ircuit.library.FunctionalPauliRotations.md | 53 +- .../qiskit/0.32/qiskit.circuit.library.GMS.md | 45 +- .../qiskit/0.32/qiskit.circuit.library.GR.md | 45 +- .../qiskit/0.32/qiskit.circuit.library.GRX.md | 45 +- .../qiskit/0.32/qiskit.circuit.library.GRY.md | 45 +- .../qiskit/0.32/qiskit.circuit.library.GRZ.md | 45 +- .../0.32/qiskit.circuit.library.GraphState.md | 45 +- .../qiskit.circuit.library.GroverOperator.md | 53 +- .../0.32/qiskit.circuit.library.HGate.md | 60 +- ...circuit.library.HRSCumulativeMultiplier.md | 49 +- ...it.circuit.library.HiddenLinearFunction.md | 45 +- .../0.32/qiskit.circuit.library.IGate.md | 35 +- .../qiskit/0.32/qiskit.circuit.library.IQP.md | 45 +- .../qiskit.circuit.library.InnerProduct.md | 45 +- ...iskit.circuit.library.IntegerComparator.md | 55 +- ...circuit.library.LinearAmplitudeFunction.md | 67 +- ...it.circuit.library.LinearPauliRotations.md | 57 +- ...t.circuit.library.LogNormalDistribution.md | 51 +- .../0.32/qiskit.circuit.library.MCMT.md | 68 +- .../0.32/qiskit.circuit.library.MCMTVChain.md | 59 +- .../qiskit.circuit.library.MCPhaseGate.md | 64 +- .../0.32/qiskit.circuit.library.MCXGate.md | 77 +- .../qiskit.circuit.library.MCXGrayCode.md | 43 +- .../qiskit.circuit.library.MCXRecursive.md | 52 +- .../0.32/qiskit.circuit.library.MCXVChain.md | 52 +- .../0.32/qiskit.circuit.library.MSGate.md | 25 +- .../0.32/qiskit.circuit.library.Measure.md | 48 +- .../0.32/qiskit.circuit.library.NLocal.md | 193 +- ...skit.circuit.library.NormalDistribution.md | 51 +- .../qiskit/0.32/qiskit.circuit.library.OR.md | 45 +- .../qiskit.circuit.library.PauliFeatureMap.md | 98 +- .../0.32/qiskit.circuit.library.PauliGate.md | 44 +- .../qiskit.circuit.library.PauliTwoDesign.md | 69 +- .../qiskit.circuit.library.Permutation.md | 45 +- .../qiskit.circuit.library.PhaseEstimation.md | 47 +- .../0.32/qiskit.circuit.library.PhaseGate.md | 58 +- .../qiskit.circuit.library.PhaseOracle.md | 106 +- ...skit.circuit.library.PiecewiseChebyshev.md | 57 +- ...t.library.PiecewiseLinearPauliRotations.md | 87 +- ...brary.PiecewisePolynomialPauliRotations.md | 83 +- ...ircuit.library.PolynomialPauliRotations.md | 59 +- .../0.32/qiskit.circuit.library.QAOAAnsatz.md | 79 +- .../qiskit/0.32/qiskit.circuit.library.QFT.md | 88 +- .../qiskit.circuit.library.QuadraticForm.md | 69 +- .../qiskit.circuit.library.QuantumVolume.md | 45 +- .../0.32/qiskit.circuit.library.RC3XGate.md | 25 +- .../0.32/qiskit.circuit.library.RCCXGate.md | 25 +- .../qiskit.circuit.library.RGQFTMultiplier.md | 49 +- .../0.32/qiskit.circuit.library.RGate.md | 37 +- .../0.32/qiskit.circuit.library.RVGate.md | 44 +- .../0.32/qiskit.circuit.library.RXGate.md | 60 +- .../0.32/qiskit.circuit.library.RXXGate.md | 35 +- .../0.32/qiskit.circuit.library.RYGate.md | 60 +- .../0.32/qiskit.circuit.library.RYYGate.md | 35 +- .../0.32/qiskit.circuit.library.RZGate.md | 60 +- .../0.32/qiskit.circuit.library.RZXGate.md | 35 +- .../0.32/qiskit.circuit.library.RZZGate.md | 35 +- .../qiskit.circuit.library.RealAmplitudes.md | 77 +- .../0.32/qiskit.circuit.library.Reset.md | 48 +- .../0.32/qiskit.circuit.library.SGate.md | 35 +- .../0.32/qiskit.circuit.library.SXGate.md | 60 +- .../0.32/qiskit.circuit.library.SXdgGate.md | 35 +- .../0.32/qiskit.circuit.library.SdgGate.md | 35 +- .../0.32/qiskit.circuit.library.SwapGate.md | 60 +- .../0.32/qiskit.circuit.library.TGate.md | 35 +- .../0.32/qiskit.circuit.library.TdgGate.md | 35 +- .../0.32/qiskit.circuit.library.TwoLocal.md | 87 +- .../0.32/qiskit.circuit.library.U1Gate.md | 58 +- .../0.32/qiskit.circuit.library.U2Gate.md | 37 +- .../0.32/qiskit.circuit.library.U3Gate.md | 60 +- .../0.32/qiskit.circuit.library.UGate.md | 60 +- ...kit.circuit.library.UniformDistribution.md | 45 +- ...kit.circuit.library.VBERippleCarryAdder.md | 47 +- .../qiskit.circuit.library.WeightedAdder.md | 59 +- .../0.32/qiskit.circuit.library.XGate.md | 60 +- .../qiskit/0.32/qiskit.circuit.library.XOR.md | 45 +- .../0.32/qiskit.circuit.library.YGate.md | 60 +- .../qiskit.circuit.library.ZFeatureMap.md | 77 +- .../0.32/qiskit.circuit.library.ZGate.md | 60 +- .../qiskit.circuit.library.ZZFeatureMap.md | 77 +- .../qiskit.circuit.library.clifford_2_1.md | 15 +- .../qiskit.circuit.library.clifford_2_2.md | 15 +- .../qiskit.circuit.library.clifford_2_3.md | 15 +- .../qiskit.circuit.library.clifford_2_4.md | 15 +- .../qiskit.circuit.library.clifford_3_1.md | 15 +- .../qiskit.circuit.library.clifford_4_1.md | 15 +- .../qiskit.circuit.library.clifford_4_2.md | 15 +- .../qiskit.circuit.library.clifford_4_3.md | 15 +- .../qiskit.circuit.library.clifford_4_4.md | 15 +- .../qiskit.circuit.library.clifford_5_1.md | 15 +- .../qiskit.circuit.library.clifford_6_1.md | 15 +- .../qiskit.circuit.library.clifford_6_2.md | 15 +- .../qiskit.circuit.library.clifford_6_3.md | 15 +- .../qiskit.circuit.library.clifford_6_4.md | 15 +- .../qiskit.circuit.library.clifford_6_5.md | 15 +- .../qiskit.circuit.library.clifford_8_1.md | 15 +- .../qiskit.circuit.library.clifford_8_2.md | 15 +- .../qiskit.circuit.library.clifford_8_3.md | 15 +- .../0.32/qiskit.circuit.library.iSwapGate.md | 25 +- .../0.32/qiskit.circuit.library.rzx_cy.md | 13 +- .../0.32/qiskit.circuit.library.rzx_xz.md | 13 +- .../0.32/qiskit.circuit.library.rzx_yz.md | 13 +- .../0.32/qiskit.circuit.library.rzx_zz1.md | 13 +- .../0.32/qiskit.circuit.library.rzx_zz2.md | 13 +- .../0.32/qiskit.circuit.library.rzx_zz3.md | 13 +- ...library.templates.nct.template_nct_2a_1.md | 15 +- ...library.templates.nct.template_nct_2a_2.md | 15 +- ...library.templates.nct.template_nct_2a_3.md | 15 +- ...library.templates.nct.template_nct_4a_1.md | 15 +- ...library.templates.nct.template_nct_4a_2.md | 15 +- ...library.templates.nct.template_nct_4a_3.md | 15 +- ...library.templates.nct.template_nct_4b_1.md | 15 +- ...library.templates.nct.template_nct_4b_2.md | 15 +- ...library.templates.nct.template_nct_5a_1.md | 15 +- ...library.templates.nct.template_nct_5a_2.md | 15 +- ...library.templates.nct.template_nct_5a_3.md | 15 +- ...library.templates.nct.template_nct_5a_4.md | 15 +- ...library.templates.nct.template_nct_6a_1.md | 15 +- ...library.templates.nct.template_nct_6a_2.md | 15 +- ...library.templates.nct.template_nct_6a_3.md | 15 +- ...library.templates.nct.template_nct_6a_4.md | 15 +- ...library.templates.nct.template_nct_6b_1.md | 15 +- ...library.templates.nct.template_nct_6b_2.md | 15 +- ...library.templates.nct.template_nct_6c_1.md | 15 +- ...library.templates.nct.template_nct_7a_1.md | 15 +- ...library.templates.nct.template_nct_7b_1.md | 15 +- ...library.templates.nct.template_nct_7c_1.md | 15 +- ...library.templates.nct.template_nct_7d_1.md | 15 +- ...library.templates.nct.template_nct_7e_1.md | 15 +- ...library.templates.nct.template_nct_9a_1.md | 15 +- ...library.templates.nct.template_nct_9c_1.md | 15 +- ...ibrary.templates.nct.template_nct_9c_10.md | 15 +- ...ibrary.templates.nct.template_nct_9c_11.md | 15 +- ...ibrary.templates.nct.template_nct_9c_12.md | 15 +- ...library.templates.nct.template_nct_9c_2.md | 15 +- ...library.templates.nct.template_nct_9c_3.md | 15 +- ...library.templates.nct.template_nct_9c_4.md | 15 +- ...library.templates.nct.template_nct_9c_5.md | 15 +- ...library.templates.nct.template_nct_9c_6.md | 15 +- ...library.templates.nct.template_nct_9c_7.md | 15 +- ...library.templates.nct.template_nct_9c_8.md | 15 +- ...library.templates.nct.template_nct_9c_9.md | 15 +- ...library.templates.nct.template_nct_9d_1.md | 15 +- ...ibrary.templates.nct.template_nct_9d_10.md | 15 +- ...library.templates.nct.template_nct_9d_2.md | 15 +- ...library.templates.nct.template_nct_9d_3.md | 15 +- ...library.templates.nct.template_nct_9d_4.md | 15 +- ...library.templates.nct.template_nct_9d_5.md | 15 +- ...library.templates.nct.template_nct_9d_6.md | 15 +- ...library.templates.nct.template_nct_9d_7.md | 15 +- ...library.templates.nct.template_nct_9d_8.md | 15 +- ...library.templates.nct.template_nct_9d_9.md | 15 +- .../qiskit.circuit.qpy_serialization.dump.md | 15 +- .../qiskit.circuit.qpy_serialization.load.md | 19 +- .../qiskit.circuit.random.random_circuit.md | 15 +- .../qiskit/0.32/qiskit.compiler.assemble.md | 15 +- .../qiskit/0.32/qiskit.compiler.schedule.md | 13 +- .../qiskit/0.32/qiskit.compiler.sequence.md | 13 +- .../qiskit/0.32/qiskit.compiler.transpile.md | 15 +- .../0.32/qiskit.converters.ast_to_dag.md | 15 +- .../0.32/qiskit.converters.circuit_to_dag.md | 17 +- ...kit.converters.circuit_to_dagdependency.md | 17 +- .../0.32/qiskit.converters.circuit_to_gate.md | 19 +- ...iskit.converters.circuit_to_instruction.md | 19 +- .../0.32/qiskit.converters.dag_to_circuit.md | 17 +- .../qiskit.converters.dag_to_dagdependency.md | 17 +- ...kit.converters.dagdependency_to_circuit.md | 17 +- .../qiskit.converters.dagdependency_to_dag.md | 15 +- .../0.32/qiskit.dagcircuit.DAGCircuit.md | 836 ++- .../0.32/qiskit.dagcircuit.DAGCircuitError.md | 13 +- .../0.32/qiskit.dagcircuit.DAGDepNode.md | 77 +- .../0.32/qiskit.dagcircuit.DAGDependency.md | 357 +- .../qiskit/0.32/qiskit.dagcircuit.DAGNode.md | 54 +- .../0.32/qiskit.extensions.HamiltonianGate.md | 356 +- .../0.32/qiskit.extensions.Initialize.md | 255 +- .../qiskit/0.32/qiskit.extensions.Snapshot.md | 224 +- .../0.32/qiskit.extensions.UnitaryGate.md | 357 +- .../0.32/qiskit.finance.QiskitFinanceError.md | 13 +- ....uncertainty_problems.EuropeanCallDelta.md | 162 +- ...inty_problems.EuropeanCallExpectedValue.md | 162 +- ...ainty_problems.FixedIncomeExpectedValue.md | 162 +- ...finance.components.uncertainty_problems.md | 12 +- ...finance.data_providers.BaseDataProvider.md | 145 +- ...nce.data_providers.DataOnDemandProvider.md | 145 +- ...nce.data_providers.ExchangeDataProvider.md | 149 +- ...nance.data_providers.RandomDataProvider.md | 147 +- ...skit.finance.data_providers.StockMarket.md | 19 +- ...ce.data_providers.WikipediaDataProvider.md | 145 +- ...inance.data_providers.YahooDataProvider.md | 147 +- .../0.32/qiskit.finance.data_providers.md | 26 +- ...t.ignis.characterization.AmpCalCXFitter.md | 114 +- ...kit.ignis.characterization.AmpCalFitter.md | 135 +- ...ignis.characterization.AngleCalCXFitter.md | 114 +- ...t.ignis.characterization.AngleCalFitter.md | 114 +- ...is.characterization.BaseCoherenceFitter.md | 137 +- ...t.ignis.characterization.BaseGateFitter.md | 93 +- ...iskit.ignis.characterization.DragFitter.md | 133 +- ...iskit.ignis.characterization.RabiFitter.md | 154 +- .../qiskit.ignis.characterization.T1Fitter.md | 137 +- .../qiskit.ignis.characterization.T2Fitter.md | 137 +- ...kit.ignis.characterization.T2StarFitter.md | 158 +- .../qiskit.ignis.characterization.ZZFitter.md | 185 +- ...nis.characterization.ampcal_1Q_circuits.md | 13 +- ...nis.characterization.ampcal_cx_circuits.md | 13 +- ...s.characterization.anglecal_1Q_circuits.md | 13 +- ...s.characterization.anglecal_cx_circuits.md | 13 +- ...t.ignis.characterization.drag_schedules.md | 17 +- ...nis.characterization.get_single_q_pulse.md | 13 +- ...t.ignis.characterization.rabi_schedules.md | 17 +- ...skit.ignis.characterization.t1_circuits.md | 13 +- ...skit.ignis.characterization.t2_circuits.md | 13 +- ....ignis.characterization.t2star_circuits.md | 13 +- ...t.ignis.characterization.update_u_gates.md | 15 +- ...skit.ignis.characterization.zz_circuits.md | 13 +- .../qiskit.ignis.logging.IgnisLogReader.md | 60 +- .../0.32/qiskit.ignis.logging.IgnisLogger.md | 322 +- .../0.32/qiskit.ignis.logging.IgnisLogging.md | 88 +- ....ignis.measurement.DiscriminationFilter.md | 87 +- ...gnis.measurement.IQDiscriminationFitter.md | 219 +- ...ignis.measurement.LinearIQDiscriminator.md | 219 +- ...is.measurement.QuadraticIQDiscriminator.md | 219 +- ...gnis.measurement.SklearnIQDiscriminator.md | 219 +- ...gnis.mitigation.CTMPExpvalMeasMitigator.md | 285 +- ....mitigation.CompleteExpvalMeasMitigator.md | 244 +- ...kit.ignis.mitigation.CompleteMeasFitter.md | 102 +- ...is.mitigation.ExpvalMeasMitigatorFitter.md | 31 +- ...skit.ignis.mitigation.MeasurementFilter.md | 61 +- ....mitigation.TensoredExpvalMeasMitigator.md | 240 +- .../qiskit.ignis.mitigation.TensoredFilter.md | 104 +- ...kit.ignis.mitigation.TensoredMeasFitter.md | 86 +- ...skit.ignis.mitigation.complete_meas_cal.md | 13 +- ...skit.ignis.mitigation.expectation_value.md | 15 +- ...tigation.expval_meas_mitigator_circuits.md | 21 +- ...skit.ignis.mitigation.tensored_meas_cal.md | 13 +- ...gnis.verification.AccreditationCircuits.md | 54 +- ....ignis.verification.AccreditationFitter.md | 58 +- .../0.32/qiskit.ignis.verification.BConfig.md | 186 +- .../qiskit.ignis.verification.CNOTDihedral.md | 345 +- ...ignis.verification.CNOTDihedralRBFitter.md | 132 +- ...is.verification.GatesetTomographyFitter.md | 60 +- .../qiskit.ignis.verification.GraphDecoder.md | 125 +- ....ignis.verification.InterleavedRBFitter.md | 129 +- .../0.32/qiskit.ignis.verification.Plotter.md | 66 +- ...is.verification.ProcessTomographyFitter.md | 147 +- ...iskit.ignis.verification.PurityRBFitter.md | 143 +- .../0.32/qiskit.ignis.verification.QOTP.md | 15 +- ...it.ignis.verification.QOTPCorrectCounts.md | 13 +- .../qiskit.ignis.verification.QVFitter.md | 247 +- .../qiskit.ignis.verification.RBFitter.md | 134 +- ...iskit.ignis.verification.RepetitionCode.md | 91 +- ...gnis.verification.StateTomographyFitter.md | 137 +- ...kit.ignis.verification.TomographyFitter.md | 140 +- ...kit.ignis.verification.calculate_1q_epc.md | 15 +- ...kit.ignis.verification.calculate_1q_epg.md | 17 +- ...kit.ignis.verification.calculate_2q_epc.md | 15 +- ...kit.ignis.verification.calculate_2q_epg.md | 17 +- ...skit.ignis.verification.coherence_limit.md | 13 +- ...iskit.ignis.verification.combine_counts.md | 13 +- ...it.ignis.verification.composite_pauli_z.md | 13 +- ...verification.composite_pauli_z_expvalue.md | 13 +- .../qiskit.ignis.verification.count_gates.md | 13 +- .../qiskit.ignis.verification.count_keys.md | 13 +- ...t.ignis.verification.expectation_counts.md | 13 +- ...t.ignis.verification.gates_per_clifford.md | 13 +- ...erification.gateset_tomography_circuits.md | 13 +- .../qiskit.ignis.verification.get_ghz_mqc.md | 13 +- ...kit.ignis.verification.get_ghz_mqc_para.md | 13 +- .../qiskit.ignis.verification.get_ghz_po.md | 13 +- ...skit.ignis.verification.get_ghz_po_para.md | 13 +- ...iskit.ignis.verification.get_ghz_simple.md | 13 +- ...ignis.verification.lookuptable_decoding.md | 13 +- ...skit.ignis.verification.marginal_counts.md | 13 +- ...nis.verification.ordered_list_generator.md | 13 +- ...nis.verification.postselection_decoding.md | 13 +- ...erification.process_tomography_circuits.md | 13 +- .../qiskit.ignis.verification.qv_circuits.md | 17 +- ...erification.randomized_benchmarking_seq.md | 13 +- ...skit.ignis.verification.rho_to_fidelity.md | 13 +- ....verification.state_tomography_circuits.md | 13 +- ....ignis.verification.twoQ_clifford_error.md | 13 +- ...kit.ml.circuit.library.RawFeatureVector.md | 2907 +++++++- .../qiskit/0.32/qiskit.ml.circuit.library.md | 6 +- .../0.32/qiskit.ml.datasets.ad_hoc_data.md | 13 +- .../0.32/qiskit.ml.datasets.breast_cancer.md | 13 +- .../qiskit/0.32/qiskit.ml.datasets.digits.md | 13 +- .../0.32/qiskit.ml.datasets.gaussian.md | 13 +- .../qiskit/0.32/qiskit.ml.datasets.iris.md | 13 +- docs/api/qiskit/0.32/qiskit.ml.datasets.md | 18 +- .../qiskit.ml.datasets.sample_ad_hoc_data.md | 13 +- .../qiskit/0.32/qiskit.ml.datasets.wine.md | 13 +- .../qiskit/0.32/qiskit.opflow.OperatorBase.md | 381 +- .../qiskit/0.32/qiskit.opflow.OpflowError.md | 13 +- .../0.32/qiskit.opflow.anti_commutator.md | 15 +- .../qiskit/0.32/qiskit.opflow.commutator.md | 15 +- ...qiskit.opflow.converters.AbelianGrouper.md | 60 +- ...qiskit.opflow.converters.CircuitSampler.md | 81 +- .../qiskit.opflow.converters.ConverterBase.md | 35 +- ...skit.opflow.converters.DictToCircuitSum.md | 35 +- ...skit.opflow.converters.PauliBasisChange.md | 245 +- ...kit.opflow.converters.TwoQubitReduction.md | 35 +- .../qiskit/0.32/qiskit.opflow.converters.md | 24 +- .../0.32/qiskit.opflow.double_commutator.md | 15 +- .../qiskit.opflow.evolutions.EvolutionBase.md | 35 +- ...skit.opflow.evolutions.EvolutionFactory.md | 39 +- .../qiskit.opflow.evolutions.EvolvedOp.md | 300 +- ...iskit.opflow.evolutions.MatrixEvolution.md | 35 +- ...opflow.evolutions.PauliTrotterEvolution.md | 71 +- .../0.32/qiskit.opflow.evolutions.QDrift.md | 41 +- .../0.32/qiskit.opflow.evolutions.Suzuki.md | 43 +- .../0.32/qiskit.opflow.evolutions.Trotter.md | 17 +- ...it.opflow.evolutions.TrotterizationBase.md | 41 +- ...opflow.evolutions.TrotterizationFactory.md | 40 +- .../qiskit/0.32/qiskit.opflow.evolutions.md | 40 +- ...opflow.expectations.AerPauliExpectation.md | 56 +- ...kit.opflow.expectations.CVaRExpectation.md | 58 +- ...kit.opflow.expectations.ExpectationBase.md | 56 +- ....opflow.expectations.ExpectationFactory.md | 41 +- ...t.opflow.expectations.MatrixExpectation.md | 56 +- ...it.opflow.expectations.PauliExpectation.md | 56 +- .../qiskit/0.32/qiskit.opflow.expectations.md | 24 +- ...qiskit.opflow.gradients.CircuitGradient.md | 38 +- .../qiskit.opflow.gradients.CircuitQFI.md | 38 +- .../qiskit.opflow.gradients.DerivativeBase.md | 85 +- .../0.32/qiskit.opflow.gradients.Gradient.md | 72 +- .../qiskit.opflow.gradients.GradientBase.md | 15 +- .../0.32/qiskit.opflow.gradients.Hessian.md | 69 +- .../qiskit.opflow.gradients.HessianBase.md | 15 +- ...qiskit.opflow.gradients.NaturalGradient.md | 46 +- .../0.32/qiskit.opflow.gradients.QFI.md | 42 +- .../0.32/qiskit.opflow.gradients.QFIBase.md | 17 +- .../qiskit/0.32/qiskit.opflow.gradients.md | 32 +- .../0.32/qiskit.opflow.list_ops.ComposedOp.md | 166 +- .../0.32/qiskit.opflow.list_ops.ListOp.md | 447 +- .../0.32/qiskit.opflow.list_ops.SummedOp.md | 182 +- .../0.32/qiskit.opflow.list_ops.TensoredOp.md | 128 +- .../api/qiskit/0.32/qiskit.opflow.list_ops.md | 20 +- .../qiskit.opflow.primitive_ops.CircuitOp.md | 296 +- .../qiskit.opflow.primitive_ops.MatrixOp.md | 262 +- .../qiskit.opflow.primitive_ops.PauliOp.md | 296 +- .../qiskit.opflow.primitive_ops.PauliSumOp.md | 388 +- ...qiskit.opflow.primitive_ops.PrimitiveOp.md | 394 +- ....opflow.primitive_ops.TaperedPauliSumOp.md | 55 +- ...iskit.opflow.primitive_ops.Z2Symmetries.md | 113 +- .../0.32/qiskit.opflow.primitive_ops.md | 22 +- ...qiskit.opflow.state_fns.CVaRMeasurement.md | 300 +- .../qiskit.opflow.state_fns.CircuitStateFn.md | 339 +- .../qiskit.opflow.state_fns.DictStateFn.md | 266 +- ...qiskit.opflow.state_fns.OperatorStateFn.md | 235 +- ...it.opflow.state_fns.SparseVectorStateFn.md | 237 +- .../0.32/qiskit.opflow.state_fns.StateFn.md | 424 +- .../qiskit.opflow.state_fns.VectorStateFn.md | 270 +- .../qiskit/0.32/qiskit.opflow.state_fns.md | 18 +- ...it.optimization.QiskitOptimizationError.md | 13 +- .../qiskit.optimization.QuadraticProgram.md | 886 ++- ...ation.algorithms.ADMMOptimizationResult.md | 31 +- ...t.optimization.algorithms.ADMMOptimizer.md | 91 +- ....optimization.algorithms.ADMMParameters.md | 13 +- ...iskit.optimization.algorithms.ADMMState.md | 13 +- ...optimization.algorithms.CobylaOptimizer.md | 115 +- ....optimization.algorithms.CplexOptimizer.md | 100 +- ...ion.algorithms.GroverOptimizationResult.md | 39 +- ...optimization.algorithms.GroverOptimizer.md | 92 +- ...imization.algorithms.IntermediateResult.md | 21 +- ...gorithms.MinimumEigenOptimizationResult.md | 47 +- ...zation.algorithms.MinimumEigenOptimizer.md | 91 +- ...mization.algorithms.MultiStartOptimizer.md | 109 +- ...zation.algorithms.OptimizationAlgorithm.md | 83 +- ...imization.algorithms.OptimizationResult.md | 31 +- ...ion.algorithms.OptimizationResultStatus.md | 19 +- ...RecursiveMinimumEigenOptimizationResult.md | 37 +- ...gorithms.RecursiveMinimumEigenOptimizer.md | 94 +- ...tion.algorithms.SlsqpOptimizationResult.md | 37 +- ....optimization.algorithms.SlsqpOptimizer.md | 115 +- ....optimization.algorithms.SolutionSample.md | 21 +- .../0.32/qiskit.optimization.algorithms.md | 48 +- ...ization.converters.InequalityToEquality.md | 64 +- ...optimization.converters.IntegerToBinary.md | 62 +- ...tion.converters.LinearEqualityToPenalty.md | 66 +- ...on.converters.QuadraticProgramConverter.md | 40 +- ...ation.converters.QuadraticProgramToQubo.md | 106 +- .../0.32/qiskit.optimization.converters.md | 20 +- ...qiskit.optimization.problems.Constraint.md | 43 +- ....optimization.problems.LinearConstraint.md | 45 +- ....optimization.problems.LinearExpression.md | 98 +- ...timization.problems.QuadraticConstraint.md | 47 +- ...timization.problems.QuadraticExpression.md | 103 +- ...ptimization.problems.QuadraticObjective.md | 66 +- ....optimization.problems.QuadraticProgram.md | 886 ++- ...zation.problems.QuadraticProgramElement.md | 15 +- .../qiskit.optimization.problems.Variable.md | 43 +- .../0.32/qiskit.optimization.problems.md | 28 +- .../qiskit/0.32/qiskit.providers.Backend.md | 15 +- .../qiskit.providers.BackendPropertyError.md | 13 +- .../qiskit/0.32/qiskit.providers.BackendV1.md | 162 +- .../0.32/qiskit.providers.BaseBackend.md | 133 +- .../qiskit/0.32/qiskit.providers.BaseJob.md | 161 +- .../0.32/qiskit.providers.BaseProvider.md | 64 +- docs/api/qiskit/0.32/qiskit.providers.Job.md | 15 +- .../qiskit/0.32/qiskit.providers.JobError.md | 13 +- .../qiskit/0.32/qiskit.providers.JobStatus.md | 27 +- .../0.32/qiskit.providers.JobTimeoutError.md | 13 +- .../api/qiskit/0.32/qiskit.providers.JobV1.md | 163 +- .../qiskit/0.32/qiskit.providers.Options.md | 32 +- .../qiskit/0.32/qiskit.providers.Provider.md | 15 +- .../0.32/qiskit.providers.ProviderV1.md | 66 +- ...it.providers.QiskitBackendNotFoundError.md | 13 +- .../0.32/qiskit.providers.aer.AerError.md | 13 +- .../0.32/qiskit.providers.aer.AerProvider.md | 66 +- .../0.32/qiskit.providers.aer.AerSimulator.md | 256 +- .../qiskit.providers.aer.PulseSimulator.md | 209 +- .../qiskit.providers.aer.QasmSimulator.md | 258 +- ...skit.providers.aer.StatevectorSimulator.md | 245 +- .../qiskit.providers.aer.UnitarySimulator.md | 245 +- ...iskit.providers.aer.extensions.Snapshot.md | 233 +- ...rs.aer.extensions.SnapshotDensityMatrix.md | 235 +- ...aer.extensions.SnapshotExpectationValue.md | 237 +- ...rs.aer.extensions.SnapshotProbabilities.md | 235 +- ...iders.aer.extensions.SnapshotStabilizer.md | 235 +- ...ders.aer.extensions.SnapshotStatevector.md | 235 +- .../0.32/qiskit.providers.aer.jobs.AerJob.md | 225 +- .../qiskit.providers.aer.jobs.AerJobSet.md | 331 +- ...it.providers.aer.library.SaveAmplitudes.md | 222 +- ...iders.aer.library.SaveAmplitudesSquared.md | 222 +- ...providers.aer.library.SaveDensityMatrix.md | 222 +- ...viders.aer.library.SaveExpectationValue.md | 226 +- ...er.library.SaveExpectationValueVariance.md | 226 +- ...ders.aer.library.SaveMatrixProductState.md | 222 +- ...providers.aer.library.SaveProbabilities.md | 222 +- ...iders.aer.library.SaveProbabilitiesDict.md | 222 +- ...it.providers.aer.library.SaveStabilizer.md | 222 +- .../qiskit.providers.aer.library.SaveState.md | 222 +- ...t.providers.aer.library.SaveStatevector.md | 222 +- ...oviders.aer.library.SaveStatevectorDict.md | 222 +- ...iskit.providers.aer.library.SaveSuperOp.md | 222 +- ...iskit.providers.aer.library.SaveUnitary.md | 222 +- ....providers.aer.library.SetDensityMatrix.md | 240 +- ...iders.aer.library.SetMatrixProductState.md | 238 +- ...kit.providers.aer.library.SetStabilizer.md | 240 +- ...it.providers.aer.library.SetStatevector.md | 240 +- ...qiskit.providers.aer.library.SetSuperOp.md | 238 +- ...qiskit.providers.aer.library.SetUnitary.md | 240 +- ...t.providers.aer.library.save_amplitudes.md | 15 +- ...ers.aer.library.save_amplitudes_squared.md | 15 +- ...oviders.aer.library.save_density_matrix.md | 15 +- ...ders.aer.library.save_expectation_value.md | 19 +- ...library.save_expectation_value_variance.md | 19 +- ...s.aer.library.save_matrix_product_state.md | 15 +- ...roviders.aer.library.save_probabilities.md | 15 +- ...ers.aer.library.save_probabilities_dict.md | 15 +- ...t.providers.aer.library.save_stabilizer.md | 15 +- ...qiskit.providers.aer.library.save_state.md | 15 +- ....providers.aer.library.save_statevector.md | 15 +- ...iders.aer.library.save_statevector_dict.md | 15 +- ...skit.providers.aer.library.save_unitary.md | 15 +- ...roviders.aer.library.set_density_matrix.md | 17 +- ...rs.aer.library.set_matrix_product_state.md | 15 +- ...it.providers.aer.library.set_stabilizer.md | 17 +- ...t.providers.aer.library.set_statevector.md | 17 +- ...iskit.providers.aer.library.set_superop.md | 15 +- ...iskit.providers.aer.library.set_unitary.md | 17 +- .../qiskit.providers.aer.noise.NoiseModel.md | 294 +- ...qiskit.providers.aer.noise.QuantumError.md | 245 +- ...qiskit.providers.aer.noise.ReadoutError.md | 206 +- ...iders.aer.noise.amplitude_damping_error.md | 15 +- ...viders.aer.noise.coherent_unitary_error.md | 15 +- ....providers.aer.noise.depolarizing_error.md | 15 +- ...r.noise.device.basic_device_gate_errors.md | 15 +- ...oise.device.basic_device_readout_errors.md | 15 +- ...ders.aer.noise.device.gate_error_values.md | 15 +- ...ers.aer.noise.device.gate_length_values.md | 15 +- ...ders.aer.noise.device.gate_param_values.md | 15 +- ...s.aer.noise.device.readout_error_values.md | 15 +- ....noise.device.thermal_relaxation_values.md | 15 +- .../qiskit.providers.aer.noise.kraus_error.md | 15 +- ...providers.aer.noise.mixed_unitary_error.md | 15 +- .../qiskit.providers.aer.noise.pauli_error.md | 17 +- ...aer.noise.phase_amplitude_damping_error.md | 15 +- ...providers.aer.noise.phase_damping_error.md | 15 +- .../qiskit.providers.aer.noise.reset_error.md | 15 +- ...ders.aer.noise.thermal_relaxation_error.md | 15 +- ...it.providers.aer.pulse.PulseSystemModel.md | 101 +- ...roviders.aer.pulse.duffing_system_model.md | 19 +- ...it.providers.aer.utils.NoiseTransformer.md | 400 +- ...iders.aer.utils.approximate_noise_model.md | 17 +- ...ers.aer.utils.approximate_quantum_error.md | 17 +- ...qiskit.providers.aer.utils.insert_noise.md | 21 +- ...t.providers.aer.utils.remap_noise_model.md | 17 +- ...qiskit.providers.basicaer.BasicAerError.md | 13 +- .../qiskit.providers.basicaer.BasicAerJob.md | 179 +- ...kit.providers.basicaer.BasicAerProvider.md | 66 +- ...skit.providers.basicaer.QasmSimulatorPy.md | 221 +- ...oviders.basicaer.StatevectorSimulatorPy.md | 221 +- ...t.providers.basicaer.UnitarySimulatorPy.md | 231 +- .../qiskit.providers.ibmq.AccountProvider.md | 204 +- .../qiskit.providers.ibmq.BackendJobLimit.md | 19 +- ...bmq.IBMQAccountCredentialsInvalidFormat.md | 13 +- ...ibmq.IBMQAccountCredentialsInvalidToken.md | 13 +- ...s.ibmq.IBMQAccountCredentialsInvalidUrl.md | 13 +- ...ers.ibmq.IBMQAccountCredentialsNotFound.md | 13 +- .../qiskit.providers.ibmq.IBMQAccountError.md | 13 +- ...bmq.IBMQAccountMultipleCredentialsFound.md | 13 +- .../0.32/qiskit.providers.ibmq.IBMQBackend.md | 483 +- ...skit.providers.ibmq.IBMQBackendApiError.md | 13 +- ...viders.ibmq.IBMQBackendApiProtocolError.md | 13 +- .../qiskit.providers.ibmq.IBMQBackendError.md | 13 +- ...iskit.providers.ibmq.IBMQBackendService.md | 173 +- ...it.providers.ibmq.IBMQBackendValueError.md | 13 +- .../0.32/qiskit.providers.ibmq.IBMQError.md | 13 +- .../0.32/qiskit.providers.ibmq.IBMQFactory.md | 273 +- ...qiskit.providers.ibmq.IBMQProviderError.md | 13 +- .../qiskit.providers.ibmq.RunnerResult.md | 237 +- ....providers.ibmq.credentials.Credentials.md | 63 +- ...iders.ibmq.credentials.CredentialsError.md | 13 +- ...mq.credentials.CredentialsNotFoundError.md | 13 +- ...edentials.InvalidCredentialsFormatError.md | 13 +- ...oviders.ibmq.experiment.DeviceComponent.md | 13 +- ...bmq.experiment.IBMExperimentEntryExists.md | 13 +- ...q.experiment.IBMExperimentEntryNotFound.md | 13 +- ...ders.ibmq.experiment.IBMExperimentError.md | 13 +- ...rs.ibmq.experiment.IBMExperimentService.md | 618 +- ...providers.ibmq.experiment.ResultQuality.md | 19 +- .../0.32/qiskit.providers.ibmq.job.IBMQJob.md | 633 +- ...skit.providers.ibmq.job.IBMQJobApiError.md | 13 +- .../qiskit.providers.ibmq.job.IBMQJobError.md | 13 +- ....providers.ibmq.job.IBMQJobFailureError.md | 13 +- ...iders.ibmq.job.IBMQJobInvalidStateError.md | 13 +- ....providers.ibmq.job.IBMQJobTimeoutError.md | 13 +- .../qiskit.providers.ibmq.job.QueueInfo.md | 35 +- .../qiskit.providers.ibmq.job.job_monitor.md | 13 +- .../0.32/qiskit.providers.ibmq.least_busy.md | 15 +- ...t.providers.ibmq.managed.IBMQJobManager.md | 135 +- ...viders.ibmq.managed.IBMQJobManagerError.md | 13 +- ...managed.IBMQJobManagerInvalidStateError.md | 13 +- ....ibmq.managed.IBMQJobManagerJobNotFound.md | 13 +- ...ibmq.managed.IBMQJobManagerTimeoutError.md | 13 +- ...bmq.managed.IBMQJobManagerUnknownJobSet.md | 13 +- ...naged.IBMQManagedResultDataNotAvailable.md | 13 +- ...iskit.providers.ibmq.managed.ManagedJob.md | 129 +- ...it.providers.ibmq.managed.ManagedJobSet.md | 380 +- ...t.providers.ibmq.managed.ManagedResults.md | 186 +- ...skit.providers.ibmq.random.CQCExtractor.md | 118 +- ...t.providers.ibmq.random.CQCExtractorJob.md | 67 +- ...providers.ibmq.random.IBMQRandomService.md | 54 +- ...roviders.ibmq.runtime.IBMRuntimeService.md | 365 +- ...oviders.ibmq.runtime.ParameterNamespace.md | 37 +- ...t.providers.ibmq.runtime.ProgramBackend.md | 167 +- ...it.providers.ibmq.runtime.ResultDecoder.md | 39 +- ...t.providers.ibmq.runtime.RuntimeDecoder.md | 47 +- ...t.providers.ibmq.runtime.RuntimeEncoder.md | 76 +- ...iskit.providers.ibmq.runtime.RuntimeJob.md | 233 +- ...t.providers.ibmq.runtime.RuntimeProgram.md | 76 +- ...it.providers.ibmq.runtime.UserMessenger.md | 37 +- ...roviders.ibmq.utils.seconds_to_duration.md | 13 +- ...oviders.ibmq.utils.to_python_identifier.md | 13 +- ...providers.ibmq.utils.update_qobj_config.md | 13 +- ...iskit.providers.ibmq.utils.utc_to_local.md | 13 +- ....providers.ibmq.utils.validate_job_tags.md | 13 +- ...t.providers.models.BackendConfiguration.md | 54 +- ...skit.providers.models.BackendProperties.md | 317 +- .../qiskit.providers.models.BackendStatus.md | 52 +- .../0.32/qiskit.providers.models.Command.md | 58 +- .../qiskit.providers.models.GateConfig.md | 58 +- .../0.32/qiskit.providers.models.JobStatus.md | 60 +- ...viders.models.PulseBackendConfiguration.md | 228 +- .../qiskit.providers.models.PulseDefaults.md | 44 +- ...oviders.models.QasmBackendConfiguration.md | 76 +- .../qiskit.providers.models.UchannelLO.md | 56 +- docs/api/qiskit/0.32/qiskit.pulse.Acquire.md | 243 +- .../0.32/qiskit.pulse.AcquireChannel.md | 61 +- docs/api/qiskit/0.32/qiskit.pulse.Call.md | 264 +- docs/api/qiskit/0.32/qiskit.pulse.Constant.md | 150 +- .../0.32/qiskit.pulse.ControlChannel.md | 61 +- docs/api/qiskit/0.32/qiskit.pulse.Delay.md | 231 +- docs/api/qiskit/0.32/qiskit.pulse.Drag.md | 154 +- .../qiskit/0.32/qiskit.pulse.DriveChannel.md | 61 +- docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md | 152 +- .../0.32/qiskit.pulse.GaussianSquare.md | 156 +- .../qiskit/0.32/qiskit.pulse.Instruction.md | 233 +- .../qiskit.pulse.InstructionScheduleMap.md | 228 +- .../0.32/qiskit.pulse.MeasureChannel.md | 61 +- .../qiskit/0.32/qiskit.pulse.MemorySlot.md | 61 +- docs/api/qiskit/0.32/qiskit.pulse.Play.md | 237 +- .../qiskit/0.32/qiskit.pulse.PulseError.md | 13 +- .../qiskit/0.32/qiskit.pulse.RegisterSlot.md | 61 +- docs/api/qiskit/0.32/qiskit.pulse.Schedule.md | 438 +- .../qiskit/0.32/qiskit.pulse.ScheduleBlock.md | 428 +- .../qiskit/0.32/qiskit.pulse.SetFrequency.md | 233 +- docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md | 233 +- .../0.32/qiskit.pulse.ShiftFrequency.md | 233 +- .../qiskit/0.32/qiskit.pulse.ShiftPhase.md | 233 +- docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md | 237 +- docs/api/qiskit/0.32/qiskit.pulse.Waveform.md | 107 +- .../0.32/qiskit.pulse.builder.acquire.md | 15 +- .../qiskit.pulse.builder.acquire_channel.md | 13 +- .../qiskit.pulse.builder.active_backend.md | 15 +- ...ilder.active_circuit_scheduler_settings.md | 13 +- ...ulse.builder.active_transpiler_settings.md | 13 +- .../qiskit.pulse.builder.align_equispaced.md | 13 +- .../0.32/qiskit.pulse.builder.align_func.md | 13 +- .../0.32/qiskit.pulse.builder.align_left.md | 13 +- .../0.32/qiskit.pulse.builder.align_right.md | 13 +- .../qiskit.pulse.builder.align_sequential.md | 13 +- .../0.32/qiskit.pulse.builder.barrier.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.build.md | 15 +- .../qiskit/0.32/qiskit.pulse.builder.call.md | 15 +- ...ulse.builder.circuit_scheduler_settings.md | 13 +- .../qiskit.pulse.builder.control_channels.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.cx.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.delay.md | 13 +- .../0.32/qiskit.pulse.builder.delay_qubits.md | 13 +- .../qiskit.pulse.builder.drive_channel.md | 13 +- .../qiskit.pulse.builder.frequency_offset.md | 13 +- .../0.32/qiskit.pulse.builder.inline.md | 13 +- .../0.32/qiskit.pulse.builder.measure.md | 15 +- .../0.32/qiskit.pulse.builder.measure_all.md | 13 +- .../qiskit.pulse.builder.measure_channel.md | 13 +- .../0.32/qiskit.pulse.builder.num_qubits.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.pad.md | 13 +- .../0.32/qiskit.pulse.builder.phase_offset.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.play.md | 13 +- .../qiskit.pulse.builder.qubit_channels.md | 13 +- ...qiskit.pulse.builder.samples_to_seconds.md | 13 +- ...qiskit.pulse.builder.seconds_to_samples.md | 13 +- .../qiskit.pulse.builder.set_frequency.md | 13 +- .../0.32/qiskit.pulse.builder.set_phase.md | 13 +- .../qiskit.pulse.builder.shift_frequency.md | 13 +- .../0.32/qiskit.pulse.builder.shift_phase.md | 13 +- .../0.32/qiskit.pulse.builder.snapshot.md | 13 +- ...iskit.pulse.builder.transpiler_settings.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.u1.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.u2.md | 13 +- .../qiskit/0.32/qiskit.pulse.builder.u3.md | 13 +- .../api/qiskit/0.32/qiskit.pulse.builder.x.md | 13 +- .../0.32/qiskit.pulse.instructions.Acquire.md | 243 +- .../0.32/qiskit.pulse.instructions.Call.md | 264 +- .../0.32/qiskit.pulse.instructions.Delay.md | 231 +- .../qiskit.pulse.instructions.Instruction.md | 233 +- .../0.32/qiskit.pulse.instructions.Play.md | 237 +- .../qiskit.pulse.instructions.SetFrequency.md | 233 +- .../qiskit.pulse.instructions.SetPhase.md | 233 +- ...iskit.pulse.instructions.ShiftFrequency.md | 233 +- .../qiskit.pulse.instructions.ShiftPhase.md | 233 +- .../qiskit.pulse.instructions.Snapshot.md | 237 +- .../qiskit/0.32/qiskit.pulse.instructions.md | 34 +- .../0.32/qiskit.pulse.library.Constant.md | 150 +- .../qiskit/0.32/qiskit.pulse.library.Drag.md | 154 +- .../0.32/qiskit.pulse.library.Gaussian.md | 152 +- .../qiskit.pulse.library.GaussianSquare.md | 156 +- .../0.32/qiskit.pulse.library.Waveform.md | 107 +- .../0.32/qiskit.pulse.library.discrete.md | 30 +- docs/api/qiskit/0.32/qiskit.pulse.library.md | 22 +- ....pulse.transforms.add_implicit_acquires.md | 13 +- .../qiskit.pulse.transforms.align_measures.md | 19 +- .../0.32/qiskit.pulse.transforms.pad.md | 13 +- .../qiskit/0.32/qiskit.qasm.OpenQASMLexer.md | 74 +- docs/api/qiskit/0.32/qiskit.qasm.Qasm.md | 41 +- docs/api/qiskit/0.32/qiskit.qasm.QasmError.md | 13 +- .../qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md | 29 +- .../0.32/qiskit.qasm.QasmTerminalStyle.md | 29 +- .../0.32/qiskit.qobj.GateCalibration.md | 54 +- .../0.32/qiskit.qobj.PulseLibraryItem.md | 52 +- docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md | 79 +- .../0.32/qiskit.qobj.PulseQobjConfig.md | 54 +- .../0.32/qiskit.qobj.PulseQobjExperiment.md | 56 +- .../qiskit.qobj.PulseQobjExperimentConfig.md | 52 +- .../0.32/qiskit.qobj.PulseQobjInstruction.md | 56 +- .../qiskit.qobj.QasmExperimentCalibrations.md | 54 +- docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md | 77 +- .../qiskit/0.32/qiskit.qobj.QasmQobjConfig.md | 56 +- .../0.32/qiskit.qobj.QasmQobjExperiment.md | 56 +- .../qiskit.qobj.QasmQobjExperimentConfig.md | 54 +- .../0.32/qiskit.qobj.QasmQobjInstruction.md | 52 +- docs/api/qiskit/0.32/qiskit.qobj.Qobj.md | 73 +- .../0.32/qiskit.qobj.QobjExperimentHeader.md | 52 +- .../api/qiskit/0.32/qiskit.qobj.QobjHeader.md | 52 +- .../0.32/qiskit.qobj.QobjMeasurementOption.md | 52 +- .../0.32/qiskit.quantum_info.CNOTDihedral.md | 290 +- .../qiskit/0.32/qiskit.quantum_info.Chi.md | 327 +- .../qiskit/0.32/qiskit.quantum_info.Choi.md | 327 +- .../0.32/qiskit.quantum_info.Clifford.md | 405 +- .../0.32/qiskit.quantum_info.DensityMatrix.md | 647 +- .../qiskit/0.32/qiskit.quantum_info.Kraus.md | 325 +- ...it.quantum_info.OneQubitEulerDecomposer.md | 58 +- .../0.32/qiskit.quantum_info.Operator.md | 341 +- .../qiskit/0.32/qiskit.quantum_info.PTM.md | 327 +- .../qiskit/0.32/qiskit.quantum_info.Pauli.md | 753 ++- .../0.32/qiskit.quantum_info.PauliList.md | 720 +- .../0.32/qiskit.quantum_info.PauliTable.md | 701 +- .../0.32/qiskit.quantum_info.Quaternion.md | 126 +- .../0.32/qiskit.quantum_info.ScalarOp.md | 264 +- .../0.32/qiskit.quantum_info.SparsePauliOp.md | 426 +- .../qiskit.quantum_info.StabilizerState.md | 373 +- .../qiskit.quantum_info.StabilizerTable.md | 755 ++- .../0.32/qiskit.quantum_info.Statevector.md | 650 +- .../0.32/qiskit.quantum_info.Stinespring.md | 327 +- .../0.32/qiskit.quantum_info.SuperOp.md | 325 +- ...it.quantum_info.TwoQubitBasisDecomposer.md | 84 +- ...skit.quantum_info.average_gate_fidelity.md | 19 +- .../0.32/qiskit.quantum_info.concurrence.md | 19 +- .../qiskit.quantum_info.decompose_clifford.md | 17 +- .../0.32/qiskit.quantum_info.diamond_norm.md | 15 +- ....quantum_info.entanglement_of_formation.md | 15 +- .../0.32/qiskit.quantum_info.entropy.md | 15 +- .../0.32/qiskit.quantum_info.gate_error.md | 17 +- .../qiskit.quantum_info.hellinger_distance.md | 13 +- .../qiskit.quantum_info.hellinger_fidelity.md | 13 +- .../qiskit.quantum_info.mutual_information.md | 15 +- .../0.32/qiskit.quantum_info.partial_trace.md | 19 +- .../0.32/qiskit.quantum_info.pauli_basis.md | 15 +- .../0.32/qiskit.quantum_info.pauli_group.md | 15 +- .../qiskit.quantum_info.process_fidelity.md | 21 +- .../qiskit/0.32/qiskit.quantum_info.purity.md | 15 +- .../qiskit.quantum_info.random_clifford.md | 15 +- ...qiskit.quantum_info.random_cnotdihedral.md | 15 +- ...skit.quantum_info.random_density_matrix.md | 15 +- .../qiskit.quantum_info.random_hermitian.md | 15 +- .../0.32/qiskit.quantum_info.random_pauli.md | 15 +- .../qiskit.quantum_info.random_pauli_table.md | 15 +- ...kit.quantum_info.random_quantum_channel.md | 15 +- ...it.quantum_info.random_stabilizer_table.md | 15 +- .../qiskit.quantum_info.random_statevector.md | 15 +- .../qiskit.quantum_info.random_unitary.md | 15 +- .../qiskit.quantum_info.shannon_entropy.md | 13 +- .../qiskit.quantum_info.state_fidelity.md | 17 +- ...t.quantum_info.two_qubit_cnot_decompose.md | 2 +- docs/api/qiskit/0.32/qiskit.result.Counts.md | 174 +- .../0.32/qiskit.result.ProbDistribution.md | 147 +- .../0.32/qiskit.result.QuasiDistribution.md | 172 +- docs/api/qiskit/0.32/qiskit.result.Result.md | 211 +- .../qiskit/0.32/qiskit.result.ResultError.md | 13 +- .../0.32/qiskit.result.marginal_counts.md | 17 +- .../0.32/qiskit.scheduler.ScheduleConfig.md | 13 +- .../0.32/qiskit.tools.backend_monitor.md | 17 +- .../0.32/qiskit.tools.backend_overview.md | 13 +- .../qiskit/0.32/qiskit.tools.job_monitor.md | 15 +- .../qiskit/0.32/qiskit.tools.parallel_map.md | 13 +- .../0.32/qiskit.transpiler.AnalysisPass.md | 44 +- .../0.32/qiskit.transpiler.CouplingMap.md | 259 +- .../qiskit.transpiler.FencedDAGCircuit.md | 13 +- .../qiskit.transpiler.FencedPropertySet.md | 13 +- .../0.32/qiskit.transpiler.FlowController.md | 91 +- .../qiskit.transpiler.InstructionDurations.md | 109 +- .../qiskit/0.32/qiskit.transpiler.Layout.md | 273 +- .../0.32/qiskit.transpiler.PassManager.md | 187 +- .../qiskit.transpiler.PassManagerConfig.md | 21 +- .../0.32/qiskit.transpiler.PropertySet.md | 105 +- .../qiskit.transpiler.TransformationPass.md | 44 +- ...qiskit.transpiler.TranspilerAccessError.md | 13 +- .../0.32/qiskit.transpiler.TranspilerError.md | 13 +- .../qiskit.transpiler.passes.ALAPSchedule.md | 54 +- .../qiskit.transpiler.passes.ASAPSchedule.md | 54 +- .../qiskit.transpiler.passes.AlignMeasures.md | 54 +- .../qiskit.transpiler.passes.ApplyLayout.md | 52 +- .../qiskit.transpiler.passes.BIPMapping.md | 61 +- ...r.passes.BarrierBeforeFinalMeasurements.md | 36 +- .../qiskit.transpiler.passes.BasicSwap.md | 55 +- ...iskit.transpiler.passes.BasisTranslator.md | 54 +- .../qiskit.transpiler.passes.CSPLayout.md | 36 +- ...qiskit.transpiler.passes.CXCancellation.md | 48 +- .../qiskit.transpiler.passes.CXDirection.md | 58 +- ...skit.transpiler.passes.CheckCXDirection.md | 46 +- ...it.transpiler.passes.CheckGateDirection.md | 44 +- .../0.32/qiskit.transpiler.passes.CheckMap.md | 44 +- ...iskit.transpiler.passes.Collect2qBlocks.md | 40 +- ...t.transpiler.passes.CommutationAnalysis.md | 38 +- ...anspiler.passes.CommutativeCancellation.md | 52 +- ...kit.transpiler.passes.ConsolidateBlocks.md | 40 +- .../0.32/qiskit.transpiler.passes.CountOps.md | 36 +- ...t.transpiler.passes.CountOpsLongestPath.md | 36 +- ...spiler.passes.CrosstalkAdaptiveSchedule.md | 272 +- .../qiskit.transpiler.passes.DAGFixedPoint.md | 36 +- ...qiskit.transpiler.passes.DAGLongestPath.md | 36 +- .../qiskit.transpiler.passes.Decompose.md | 48 +- .../qiskit.transpiler.passes.DenseLayout.md | 48 +- .../0.32/qiskit.transpiler.passes.Depth.md | 36 +- ...t.transpiler.passes.DynamicalDecoupling.md | 58 +- ...it.transpiler.passes.EnlargeWithAncilla.md | 52 +- .../qiskit.transpiler.passes.FixedPoint.md | 36 +- ...transpiler.passes.FullAncillaAllocation.md | 65 +- .../qiskit.transpiler.passes.GateDirection.md | 56 +- ...skit.transpiler.passes.Layout2qDistance.md | 38 +- .../qiskit.transpiler.passes.LookaheadSwap.md | 57 +- ...transpiler.passes.MergeAdjacentBarriers.md | 36 +- ...t.transpiler.passes.NoiseAdaptiveLayout.md | 66 +- ...skit.transpiler.passes.NumTensorFactors.md | 36 +- ...iskit.transpiler.passes.Optimize1qGates.md | 87 +- ...ler.passes.Optimize1qGatesDecomposition.md | 48 +- ...transpiler.passes.RZXCalibrationBuilder.md | 118 +- ...iler.passes.RZXCalibrationBuilderNoEcho.md | 122 +- ...qiskit.transpiler.passes.RemoveBarriers.md | 40 +- ...passes.RemoveDiagonalGatesBeforeMeasure.md | 48 +- ...anspiler.passes.RemoveFinalMeasurements.md | 48 +- ...ranspiler.passes.RemoveResetInZeroState.md | 48 +- .../qiskit.transpiler.passes.SabreLayout.md | 44 +- .../qiskit.transpiler.passes.SabreSwap.md | 55 +- .../qiskit.transpiler.passes.SetLayout.md | 50 +- .../0.32/qiskit.transpiler.passes.Size.md | 36 +- ...qiskit.transpiler.passes.StochasticSwap.md | 55 +- ....transpiler.passes.TemplateOptimization.md | 52 +- ...it.transpiler.passes.TimeUnitConversion.md | 54 +- .../qiskit.transpiler.passes.TrivialLayout.md | 46 +- ...skit.transpiler.passes.UnitarySynthesis.md | 58 +- ...qiskit.transpiler.passes.Unroll3qOrMore.md | 52 +- ...anspiler.passes.UnrollCustomDefinitions.md | 55 +- .../0.32/qiskit.transpiler.passes.Unroller.md | 53 +- ...it.transpiler.passes.ValidatePulseGates.md | 52 +- .../0.32/qiskit.transpiler.passes.Width.md | 36 +- ...reset_passmanagers.level_0_pass_manager.md | 15 +- ...reset_passmanagers.level_1_pass_manager.md | 15 +- ...reset_passmanagers.level_2_pass_manager.md | 15 +- ...reset_passmanagers.level_3_pass_manager.md | 15 +- .../0.32/qiskit.utils.QuantumInstance.md | 176 +- .../qiskit/0.32/qiskit.utils.apply_prefix.md | 13 +- .../0.32/qiskit.utils.deprecate_arguments.md | 13 +- .../0.32/qiskit.utils.deprecate_function.md | 13 +- .../0.32/qiskit.utils.get_entangler_map.md | 13 +- docs/api/qiskit/0.32/qiskit.utils.has_aer.md | 13 +- docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md | 13 +- .../0.32/qiskit.utils.is_main_process.md | 13 +- .../0.32/qiskit.utils.local_hardware_info.md | 13 +- .../api/qiskit/0.32/qiskit.utils.name_args.md | 13 +- .../0.32/qiskit.utils.summarize_circuits.md | 15 +- .../qiskit.utils.validate_entangler_map.md | 13 +- ...dation.jsonschema.SchemaValidationError.md | 13 +- ...jsonschema.validate_json_against_schema.md | 15 +- ...qiskit.visualization.VisualizationError.md | 13 +- .../qiskit.visualization.array_to_latex.md | 15 +- .../qiskit.visualization.circuit_drawer.md | 21 +- .../0.32/qiskit.visualization.dag_drawer.md | 19 +- ...iskit.visualization.pass_manager_drawer.md | 19 +- ...it.visualization.plot_bloch_multivector.md | 19 +- .../qiskit.visualization.plot_bloch_vector.md | 15 +- ...iskit.visualization.plot_circuit_layout.md | 19 +- .../qiskit.visualization.plot_error_map.md | 21 +- .../qiskit.visualization.plot_gate_map.md | 17 +- .../qiskit.visualization.plot_histogram.md | 17 +- .../qiskit.visualization.plot_state_city.md | 19 +- .../qiskit.visualization.plot_state_hinton.md | 19 +- ...iskit.visualization.plot_state_paulivec.md | 19 +- ...qiskit.visualization.plot_state_qsphere.md | 19 +- ...kit.visualization.pulse_v2.IQXDebugging.md | 105 +- ...qiskit.visualization.pulse_v2.IQXSimple.md | 105 +- ...skit.visualization.pulse_v2.IQXStandard.md | 105 +- .../qiskit.visualization.pulse_v2.draw.md | 17 +- ...skit.visualization.qcstyle.DefaultStyle.md | 13 +- .../qiskit.visualization.timeline.draw.md | 17 +- .../qiskit.visualization.timeline_drawer.md | 15 +- ...skit.visualization.visualize_transition.md | 19 +- docs/api/qiskit/0.32/qiskit_aqua.md | 16 +- docs/api/qiskit/0.32/qiskit_chemistry.md | 26 +- docs/api/qiskit/0.32/qiskit_finance.md | 6 +- docs/api/qiskit/0.32/qiskit_optimization.md | 14 +- docs/api/qiskit/0.32/qobj.md | 46 +- docs/api/qiskit/0.32/qpy.md | 20 +- docs/api/qiskit/0.32/quantum_info.md | 130 +- docs/api/qiskit/0.32/result.md | 20 +- docs/api/qiskit/0.32/scheduler.md | 8 +- docs/api/qiskit/0.32/tools.md | 16 +- docs/api/qiskit/0.32/transpiler.md | 54 +- docs/api/qiskit/0.32/transpiler_passes.md | 148 +- docs/api/qiskit/0.32/transpiler_preset.md | 12 +- docs/api/qiskit/0.32/utils.md | 40 +- docs/api/qiskit/0.32/validation.md | 12 +- docs/api/qiskit/0.32/verification.md | 118 +- docs/api/qiskit/0.32/visualization.md | 86 +- ...skit.circuit.random.random_circuit_0_0.png | Bin 5431 -> 6770 bytes ...ion.expval_meas_mitigator_circuits_0_1.png | Bin 15608 -> 15524 bytes ...iskit.visualization.plot_histogram_0_0.png | Bin 9882 -> 9805 bytes 1326 files changed, 113030 insertions(+), 16946 deletions(-) diff --git a/docs/api/qiskit/0.32/_toc.json b/docs/api/qiskit/0.32/_toc.json index 110470e6fdd..c8ebc3dbc41 100644 --- a/docs/api/qiskit/0.32/_toc.json +++ b/docs/api/qiskit/0.32/_toc.json @@ -7,7 +7,256 @@ }, { "title": "qiskit.algorithms", - "url": "/api/qiskit/0.32/algorithms" + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/algorithms" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM" + }, + { + "title": "AlgorithmError", + "url": "/api/qiskit/0.32/qiskit.algorithms.AlgorithmError" + }, + { + "title": "AmplificationProblem", + "url": "/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem" + }, + { + "title": "AmplitudeEstimation", + "url": "/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation" + }, + { + "title": "AmplitudeEstimationResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult" + }, + { + "title": "AmplitudeEstimator", + "url": "/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator" + }, + { + "title": "AmplitudeEstimatorResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.DIRECT_L_RAND" + }, + { + "title": "Eigensolver", + "url": "/api/qiskit/0.32/qiskit.algorithms.Eigensolver" + }, + { + "title": "EigensolverResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.EigensolverResult" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH" + }, + { + "title": "EstimationProblem", + "url": "/api/qiskit/0.32/qiskit.algorithms.EstimationProblem" + }, + { + "title": "FasterAmplitudeEstimation", + "url": "/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation" + }, + { + "title": "FasterAmplitudeEstimationResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult" + }, + { + "title": "GradientDescent", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent" + }, + { + "title": "Grover", + "url": "/api/qiskit/0.32/qiskit.algorithms.Grover" + }, + { + "title": "GroverResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.GroverResult" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS" + }, + { + "title": "HamiltonianPhaseEstimation", + "url": "/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation" + }, + { + "title": "HamiltonianPhaseEstimationResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult" + }, + { + "title": "HHL", + "url": "/api/qiskit/0.32/qiskit.algorithms.HHL" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES" + }, + { + "title": "IterativeAmplitudeEstimation", + "url": "/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation" + }, + { + "title": "IterativeAmplitudeEstimationResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult" + }, + { + "title": "IterativePhaseEstimation", + "url": "/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.L_BFGS_B" + }, + { + "title": "LinearSolver", + "url": "/api/qiskit/0.32/qiskit.algorithms.LinearSolver" + }, + { + "title": "LinearSolverResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult" + }, + { + "title": "MaximumLikelihoodAmplitudeEstimation", + "url": "/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation" + }, + { + "title": "MaximumLikelihoodAmplitudeEstimationResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult" + }, + { + "title": "MinimumEigensolver", + "url": "/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver" + }, + { + "title": "MinimumEigensolverResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT" + }, + { + "title": "NumPyEigensolver", + "url": "/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver" + }, + { + "title": "NumPyLinearSolver", + "url": "/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver" + }, + { + "title": "NumPyMinimumEigensolver", + "url": "/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.P_BFGS" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation" + }, + { + "title": "PhaseEstimationResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult" + }, + { + "title": "PhaseEstimationScale", + "url": "/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL" + }, + { + "title": "QAOA", + "url": "/api/qiskit/0.32/qiskit.algorithms.QAOA" + }, + { + "title": "QNSPSA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA" + }, + { + "title": "SciPyOptimizer", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer" + }, + { + "title": "Shor", + "url": "/api/qiskit/0.32/qiskit.algorithms.Shor" + }, + { + "title": "ShorResult", + "url": "/api/qiskit/0.32/qiskit.algorithms.ShorResult" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC" + }, + { + "title": "VQE", + "url": "/api/qiskit/0.32/qiskit.algorithms.VQE" + } + ] }, { "title": "qiskit.aqua", @@ -17,12 +266,16 @@ "url": "/api/qiskit/0.32/qiskit_aqua" }, { - "title": "qiskit.aqua.circuits", - "url": "/api/qiskit/0.32/qiskit.aqua.circuits" + "title": "AquaError", + "url": "/api/qiskit/0.32/qiskit.aqua.AquaError" }, { - "title": "qiskit.aqua.utils", - "url": "/api/qiskit/0.32/qiskit.aqua.utils" + "title": "MissingOptionalLibraryError", + "url": "/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError" + }, + { + "title": "QuantumInstance", + "url": "/api/qiskit/0.32/qiskit.aqua.QuantumInstance" }, { "title": "qiskit.aqua.algorithms", @@ -32,517 +285,5507 @@ "url": "/api/qiskit/0.32/qiskit.aqua.algorithms" }, { - "title": "qiskit.aqua.algorithms.minimum_eigen_solvers.cplex", - "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.minimum_eigen_solvers.cplex" - } - ] - }, - { - "title": "qiskit.aqua.components", - "children": [ + "title": "AmplitudeEstimation", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.aqua.components" + "title": "AmplitudeEstimationAlgorithmResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult" }, { - "title": "qiskit.aqua.components.eigs", - "url": "/api/qiskit/0.32/qiskit.aqua.components.eigs" + "title": "AmplitudeEstimationResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult" }, { - "title": "qiskit.aqua.components.feature_maps", - "url": "/api/qiskit/0.32/qiskit.aqua.components.feature_maps" + "title": "BernsteinVazirani", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani" }, { - "title": "qiskit.aqua.components.initial_states", - "url": "/api/qiskit/0.32/qiskit.aqua.components.initial_states" + "title": "ClassicalAlgorithm", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm" }, { - "title": "qiskit.aqua.components.multiclass_extensions", - "url": "/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions" + "title": "ClassicalCPLEX", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX" }, { - "title": "qiskit.aqua.components.neural_networks", - "url": "/api/qiskit/0.32/qiskit.aqua.components.neural_networks" + "title": "DeutschJozsa", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa" }, { - "title": "qiskit.aqua.components.oracles", - "url": "/api/qiskit/0.32/qiskit.aqua.components.oracles" + "title": "Eigensolver", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver" }, { - "title": "qiskit.aqua.components.reciprocals", - "url": "/api/qiskit/0.32/qiskit.aqua.components.reciprocals" + "title": "EigensolverResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult" }, { - "title": "qiskit.aqua.components.uncertainty_models", - "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models" + "title": "EOH", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.EOH" }, { - "title": "qiskit.aqua.components.uncertainty_problems", - "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems" + "title": "Grover", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.Grover" }, { - "title": "qiskit.aqua.components.variational_forms", - "url": "/api/qiskit/0.32/qiskit.aqua.components.variational_forms" + "title": "GroverResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult" }, { - "title": "qiskit.aqua.components.optimizers", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers" - }, - { - "title": "qiskit.aqua.components.optimizers.nlopts", - "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.nlopts" - } - ] - } - ] - }, - { - "title": "qiskit.aqua.operators", - "children": [ + "title": "HHL", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.HHL" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.aqua.operators" + "title": "HHLResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult" }, { - "title": "qiskit.aqua.operators.converters", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.converters" + "title": "IQPE", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE" }, { - "title": "qiskit.aqua.operators.evolutions", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions" + "title": "IterativeAmplitudeEstimation", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation" }, { - "title": "qiskit.aqua.operators.expectations", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations" + "title": "IterativeAmplitudeEstimationResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult" }, { - "title": "qiskit.aqua.operators.gradients", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients" + "title": "LinearsolverResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult" }, { - "title": "qiskit.aqua.operators.legacy", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy" + "title": "MaximumLikelihoodAmplitudeEstimation", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation" }, { - "title": "qiskit.aqua.operators.list_ops", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.list_ops" + "title": "MaximumLikelihoodAmplitudeEstimationResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult" }, { - "title": "qiskit.aqua.operators.primitive_ops", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops" + "title": "MinimumEigensolver", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver" }, { - "title": "qiskit.aqua.operators.state_fns", - "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns" + "title": "MinimumEigensolverResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult" + }, + { + "title": "NumPyEigensolver", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver" + }, + { + "title": "NumPyLSsolver", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver" + }, + { + "title": "NumPyLSsolverResult", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult" + }, + { + "title": "NumPyMinimumEigensolver", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver" + }, + { + "title": "QAOA", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA" + }, + { + "title": "QGAN", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN" + }, + { + "title": "qiskit.aqua.algorithms.minimum_eigen_solvers.cplex", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.minimum_eigen_solvers.cplex" + }, + { + "title": "QPE", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.QPE" + }, + { + "title": "QSVM", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM" + }, + { + "title": "QuantumAlgorithm", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm" + }, + { + "title": "Shor", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.Shor" + }, + { + "title": "Simon", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.Simon" + }, + { + "title": "SklearnSVM", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM" + }, + { + "title": "VQC", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.VQC" + }, + { + "title": "VQE", + "url": "/api/qiskit/0.32/qiskit.aqua.algorithms.VQE" } ] - } - ] - }, - { - "title": "qiskit.assembler", - "url": "/api/qiskit/0.32/assembler" - }, - { - "title": "qiskit.chemistry", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit_chemistry" }, { - "title": "qiskit.chemistry.applications", - "url": "/api/qiskit/0.32/qiskit.chemistry.applications" - }, - { - "title": "qiskit.chemistry.core", - "url": "/api/qiskit/0.32/qiskit.chemistry.core" - }, - { - "title": "qiskit.chemistry.results", - "url": "/api/qiskit/0.32/qiskit.chemistry.results" - }, - { - "title": "qiskit.chemistry.transformations", - "url": "/api/qiskit/0.32/qiskit.chemistry.transformations" + "title": "qiskit.aqua.circuits", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.circuits" + }, + { + "title": "CNF", + "url": "/api/qiskit/0.32/qiskit.aqua.circuits.CNF" + }, + { + "title": "DNF", + "url": "/api/qiskit/0.32/qiskit.aqua.circuits.DNF" + }, + { + "title": "ESOP", + "url": "/api/qiskit/0.32/qiskit.aqua.circuits.ESOP" + }, + { + "title": "PhaseEstimationCircuit", + "url": "/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit" + }, + { + "title": "StateVectorCircuit", + "url": "/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit" + }, + { + "title": "WeightedSumOperator", + "url": "/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator" + } + ] }, { - "title": "qiskit.chemistry.algorithms", + "title": "qiskit.aqua.components", "children": [ { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms" + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components" + }, + { + "title": "qiskit.aqua.components.eigs", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.eigs" + }, + { + "title": "Eigenvalues", + "url": "/api/qiskit/0.32/qiskit.aqua.components.eigs.Eigenvalues" + }, + { + "title": "EigsQPE", + "url": "/api/qiskit/0.32/qiskit.aqua.components.eigs.EigsQPE" + } + ] + }, + { + "title": "qiskit.aqua.components.feature_maps", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.feature_maps" + }, + { + "title": "FeatureMap", + "url": "/api/qiskit/0.32/qiskit.aqua.components.feature_maps.FeatureMap" + }, + { + "title": "RawFeatureVector", + "url": "/api/qiskit/0.32/qiskit.aqua.components.feature_maps.RawFeatureVector" + } + ] + }, + { + "title": "qiskit.aqua.components.initial_states", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.initial_states" + }, + { + "title": "Custom", + "url": "/api/qiskit/0.32/qiskit.aqua.components.initial_states.Custom" + }, + { + "title": "InitialState", + "url": "/api/qiskit/0.32/qiskit.aqua.components.initial_states.InitialState" + }, + { + "title": "VarFormBased", + "url": "/api/qiskit/0.32/qiskit.aqua.components.initial_states.VarFormBased" + }, + { + "title": "Zero", + "url": "/api/qiskit/0.32/qiskit.aqua.components.initial_states.Zero" + } + ] + }, + { + "title": "qiskit.aqua.components.multiclass_extensions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions" + }, + { + "title": "AllPairs", + "url": "/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.AllPairs" + }, + { + "title": "ErrorCorrectingCode", + "url": "/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode" + }, + { + "title": "MulticlassExtension", + "url": "/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.MulticlassExtension" + }, + { + "title": "OneAgainstRest", + "url": "/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.OneAgainstRest" + } + ] + }, + { + "title": "qiskit.aqua.components.neural_networks", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.neural_networks" + }, + { + "title": "DiscriminativeNetwork", + "url": "/api/qiskit/0.32/qiskit.aqua.components.neural_networks.DiscriminativeNetwork" + }, + { + "title": "GenerativeNetwork", + "url": "/api/qiskit/0.32/qiskit.aqua.components.neural_networks.GenerativeNetwork" + }, + { + "title": "NumPyDiscriminator", + "url": "/api/qiskit/0.32/qiskit.aqua.components.neural_networks.NumPyDiscriminator" + }, + { + "title": "PyTorchDiscriminator", + "url": "/api/qiskit/0.32/qiskit.aqua.components.neural_networks.PyTorchDiscriminator" + }, + { + "title": "QuantumGenerator", + "url": "/api/qiskit/0.32/qiskit.aqua.components.neural_networks.QuantumGenerator" + } + ] + }, + { + "title": "qiskit.aqua.components.optimizers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers" + }, + { + "title": "ADAM", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.ADAM" + }, + { + "title": "AQGD", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.AQGD" + }, + { + "title": "BOBYQA", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.BOBYQA" + }, + { + "title": "CG", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.CG" + }, + { + "title": "COBYLA", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.COBYLA" + }, + { + "title": "CRS", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.CRS" + }, + { + "title": "DIRECT_L", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L" + }, + { + "title": "DIRECT_L_RAND", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.DIRECT_L_RAND" + }, + { + "title": "ESCH", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.ESCH" + }, + { + "title": "GSLS", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.GSLS" + }, + { + "title": "IMFIL", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.IMFIL" + }, + { + "title": "ISRES", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.ISRES" + }, + { + "title": "L_BFGS_B", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.L_BFGS_B" + }, + { + "title": "NELDER_MEAD", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.NELDER_MEAD" + }, + { + "title": "NFT", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.NFT" + }, + { + "title": "Optimizer", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.Optimizer" + }, + { + "title": "OptimizerSupportLevel", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.OptimizerSupportLevel" + }, + { + "title": "P_BFGS", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.P_BFGS" + }, + { + "title": "POWELL", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.POWELL" + }, + { + "title": "qiskit.aqua.components.optimizers.nlopts", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.nlopts" + }, + { + "title": "SLSQP", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.SLSQP" + }, + { + "title": "SNOBFIT", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.SNOBFIT" + }, + { + "title": "SPSA", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.SPSA" + }, + { + "title": "TNC", + "url": "/api/qiskit/0.32/qiskit.aqua.components.optimizers.TNC" + } + ] + }, + { + "title": "qiskit.aqua.components.oracles", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.oracles" + }, + { + "title": "CustomCircuitOracle", + "url": "/api/qiskit/0.32/qiskit.aqua.components.oracles.CustomCircuitOracle" + }, + { + "title": "LogicalExpressionOracle", + "url": "/api/qiskit/0.32/qiskit.aqua.components.oracles.LogicalExpressionOracle" + }, + { + "title": "Oracle", + "url": "/api/qiskit/0.32/qiskit.aqua.components.oracles.Oracle" + }, + { + "title": "TruthTableOracle", + "url": "/api/qiskit/0.32/qiskit.aqua.components.oracles.TruthTableOracle" + } + ] + }, + { + "title": "qiskit.aqua.components.reciprocals", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.reciprocals" + }, + { + "title": "LongDivision", + "url": "/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LongDivision" + }, + { + "title": "LookupRotation", + "url": "/api/qiskit/0.32/qiskit.aqua.components.reciprocals.LookupRotation" + }, + { + "title": "Reciprocal", + "url": "/api/qiskit/0.32/qiskit.aqua.components.reciprocals.Reciprocal" + } + ] + }, + { + "title": "qiskit.aqua.components.uncertainty_models", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models" + }, + { + "title": "BernoulliDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.BernoulliDistribution" + }, + { + "title": "GaussianConditionalIndependenceModel", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.LogNormalDistribution" + }, + { + "title": "MultivariateDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateDistribution" + }, + { + "title": "MultivariateLogNormalDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution" + }, + { + "title": "MultivariateNormalDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution" + }, + { + "title": "MultivariateUniformDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution" + }, + { + "title": "MultivariateVariationalDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.NormalDistribution" + }, + { + "title": "UncertaintyModel", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UncertaintyModel" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UniformDistribution" + }, + { + "title": "UnivariateDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateDistribution" + }, + { + "title": "UnivariateVariationalDistribution", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution" + } + ] + }, + { + "title": "qiskit.aqua.components.uncertainty_problems", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems" + }, + { + "title": "MultivariateProblem", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.MultivariateProblem" + }, + { + "title": "UncertaintyProblem", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UncertaintyProblem" + }, + { + "title": "UnivariatePiecewiseLinearObjective", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective" + }, + { + "title": "UnivariateProblem", + "url": "/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.UnivariateProblem" + } + ] + }, + { + "title": "qiskit.aqua.components.variational_forms", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.components.variational_forms" + }, + { + "title": "VariationalForm", + "url": "/api/qiskit/0.32/qiskit.aqua.components.variational_forms.VariationalForm" + } + ] + } + ] + }, + { + "title": "qiskit.aqua.operators", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators" + }, + { + "title": "OperatorBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase" + }, + { + "title": "qiskit.aqua.operators.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.converters" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.converters.AbelianGrouper" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.converters.CircuitSampler" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.converters.ConverterBase" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.converters.DictToCircuitSum" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.converters.PauliBasisChange" + } + ] + }, + { + "title": "qiskit.aqua.operators.evolutions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.EvolvedOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.MatrixEvolution" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.PauliTrotterEvolution" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.QDrift" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Suzuki" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.evolutions.TrotterizationFactory" + } + ] + }, + { + "title": "qiskit.aqua.operators.expectations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations.AerPauliExpectation" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations.CVaRExpectation" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations.ExpectationFactory" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations.MatrixExpectation" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.expectations.PauliExpectation" + } + ] + }, + { + "title": "qiskit.aqua.operators.gradients", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitGradient" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.CircuitQFI" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.DerivativeBase" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.HessianBase" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.NaturalGradient" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.gradients.QFIBase" + } + ] + }, + { + "title": "qiskit.aqua.operators.legacy", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy" + }, + { + "title": "check_commutativity", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.check_commutativity" + }, + { + "title": "commutator", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.commutator" + }, + { + "title": "covariance", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.covariance" + }, + { + "title": "evolution_instruction", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.evolution_instruction" + }, + { + "title": "kernel_F2", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.kernel_F2" + }, + { + "title": "LegacyBaseOperator", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.LegacyBaseOperator" + }, + { + "title": "MatrixOperator", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.MatrixOperator" + }, + { + "title": "measure_pauli_z", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.measure_pauli_z" + }, + { + "title": "pauli_measurement", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.pauli_measurement" + }, + { + "title": "PauliGraph", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.PauliGraph" + }, + { + "title": "row_echelon_F2", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.row_echelon_F2" + }, + { + "title": "suzuki_expansion_slice_pauli_list", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list" + }, + { + "title": "TPBGroupedWeightedPauliOperator", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator" + }, + { + "title": "WeightedPauliOperator", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.WeightedPauliOperator" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.legacy.Z2Symmetries" + } + ] + }, + { + "title": "qiskit.aqua.operators.list_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.list_ops" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ComposedOp" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.list_ops.ListOp" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.list_ops.SummedOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.list_ops.TensoredOp" + } + ] + }, + { + "title": "qiskit.aqua.operators.primitive_ops", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.CircuitOp" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.MatrixOp" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PauliOp" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.PrimitiveOp" + } + ] + }, + { + "title": "qiskit.aqua.operators.state_fns", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CircuitStateFn" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns.CVaRMeasurement" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns.DictStateFn" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns.OperatorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns.StateFn" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.32/qiskit.aqua.operators.state_fns.VectorStateFn" + } + ] + } + ] + }, + { + "title": "qiskit.aqua.utils", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.aqua.utils" + }, + { + "title": "CircuitFactory", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory" + }, + { + "title": "decimal_to_binary", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.decimal_to_binary" + }, + { + "title": "get_entangler_map", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.get_entangler_map" + }, + { + "title": "get_feature_dimension", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.get_feature_dimension" + }, + { + "title": "get_num_classes", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.get_num_classes" + }, + { + "title": "get_subsystem_density_matrix", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.get_subsystem_density_matrix" + }, + { + "title": "get_subsystems_counts", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.get_subsystems_counts" + }, + { + "title": "has_aer", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.has_aer" + }, + { + "title": "has_ibmq", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.has_ibmq" + }, + { + "title": "map_label_to_class_name", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.map_label_to_class_name" + }, + { + "title": "name_args", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.name_args" + }, + { + "title": "optimize_svm", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.optimize_svm" + }, + { + "title": "random_h1_body", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.random_h1_body" + }, + { + "title": "random_h2_body", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.random_h2_body" + }, + { + "title": "random_hermitian", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.random_hermitian" + }, + { + "title": "random_non_hermitian", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.random_non_hermitian" + }, + { + "title": "random_unitary", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.random_unitary" + }, + { + "title": "reduce_dim_to_via_pca", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.reduce_dim_to_via_pca" + }, + { + "title": "split_dataset_to_data_and_labels", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.split_dataset_to_data_and_labels" + }, + { + "title": "summarize_circuits", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.summarize_circuits" + }, + { + "title": "tensorproduct", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.tensorproduct" + }, + { + "title": "validate_entangler_map", + "url": "/api/qiskit/0.32/qiskit.aqua.utils.validate_entangler_map" + } + ] + } + ] + }, + { + "title": "qiskit.assembler", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/assembler" + }, + { + "title": "assemble_circuits", + "url": "/api/qiskit/0.32/qiskit.assembler.assemble_circuits" + }, + { + "title": "assemble_schedules", + "url": "/api/qiskit/0.32/qiskit.assembler.assemble_schedules" + }, + { + "title": "disassemble", + "url": "/api/qiskit/0.32/qiskit.assembler.disassemble" + }, + { + "title": "RunConfig", + "url": "/api/qiskit/0.32/qiskit.assembler.RunConfig" + } + ] + }, + { + "title": "qiskit.chemistry", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit_chemistry" + }, + { + "title": "BosonicOperator", + "url": "/api/qiskit/0.32/qiskit.chemistry.BosonicOperator" + }, + { + "title": "FermionicOperator", + "url": "/api/qiskit/0.32/qiskit.chemistry.FermionicOperator" + }, + { + "title": "MP2Info", + "url": "/api/qiskit/0.32/qiskit.chemistry.MP2Info" + }, + { + "title": "QiskitChemistryError", + "url": "/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError" + }, + { + "title": "QMolecule", + "url": "/api/qiskit/0.32/qiskit.chemistry.QMolecule" + }, + { + "title": "WatsonHamiltonian", + "url": "/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian" + }, + { + "title": "qiskit.chemistry.algorithms", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms" + }, + { + "title": "AdaptVQE", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE" + }, + { + "title": "BOPESSampler", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler" + }, + { + "title": "EigensolverFactory", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory" + }, + { + "title": "ExcitedStatesEigensolver", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver" + }, + { + "title": "ExcitedStatesSolver", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver" + }, + { + "title": "GroundStateEigensolver", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver" + }, + { + "title": "GroundStateSolver", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver" + }, + { + "title": "MinimumEigensolverFactory", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory" + }, + { + "title": "NumPyEigensolverFactory", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory" + }, + { + "title": "NumPyMinimumEigensolverFactory", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory" + }, + { + "title": "OrbitalOptimizationVQE", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE" + }, + { + "title": "QEOM", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM" + }, + { + "title": "QEomEE", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE" + }, + { + "title": "QEomVQE", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE" + }, + { + "title": "VQEAdapt", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt" + }, + { + "title": "VQEUCCSDFactory", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory" + }, + { + "title": "VQEUVCCSDFactory", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory" + }, + { + "title": "qiskit.chemistry.algorithms.pes_samplers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers" + }, + { + "title": "BOPESSampler", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.BOPESSampler" + }, + { + "title": "DifferentialExtrapolator", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator" + }, + { + "title": "EnergySurface1DSpline", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline" + }, + { + "title": "EnergySurfaceBase", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase" + }, + { + "title": "Extrapolator", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.Extrapolator" + }, + { + "title": "HarmonicPotential", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential" + }, + { + "title": "MorsePotential", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.MorsePotential" + }, + { + "title": "PCAExtrapolator", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator" + }, + { + "title": "PolynomialExtrapolator", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator" + }, + { + "title": "PotentialBase", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.PotentialBase" + }, + { + "title": "SieveExtrapolator", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator" + }, + { + "title": "VibronicStructureBase", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase" + }, + { + "title": "WindowExtrapolator", + "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator" + } + ] + } + ] + }, + { + "title": "qiskit.chemistry.applications", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.applications" + }, + { + "title": "MolecularGroundStateEnergy", + "url": "/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy" + } + ] + }, + { + "title": "qiskit.chemistry.components", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.components" + }, + { + "title": "qiskit.chemistry.components.bosonic_bases", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases" + }, + { + "title": "BosonicBasis", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.BosonicBasis" + }, + { + "title": "HarmonicBasis", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.HarmonicBasis" + } + ] + }, + { + "title": "qiskit.chemistry.components.initial_states", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.initial_states" + }, + { + "title": "HartreeFock", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.initial_states.HartreeFock" + }, + { + "title": "VSCF", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.initial_states.VSCF" + } + ] + }, + { + "title": "qiskit.chemistry.components.variational_forms", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.variational_forms" + }, + { + "title": "CHC", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.CHC" + }, + { + "title": "UCCSD", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UCCSD" + }, + { + "title": "UVCC", + "url": "/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.UVCC" + } + ] + } + ] + }, + { + "title": "qiskit.chemistry.core", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.core" + }, + { + "title": "ChemistryOperator", + "url": "/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator" + }, + { + "title": "Hamiltonian", + "url": "/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian" + }, + { + "title": "MolecularChemistryResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult" + }, + { + "title": "MolecularExcitedStatesResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult" + }, + { + "title": "MolecularGroundStateResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult" + }, + { + "title": "QubitMappingType", + "url": "/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType" + }, + { + "title": "TransformationType", + "url": "/api/qiskit/0.32/qiskit.chemistry.core.TransformationType" + } + ] + }, + { + "title": "qiskit.chemistry.drivers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers" + }, + { + "title": "BaseDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver" + }, + { + "title": "BasisType", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType" + }, + { + "title": "BosonicDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver" + }, + { + "title": "FCIDumpDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver" + }, + { + "title": "FermionicDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver" + }, + { + "title": "GaussianDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver" + }, + { + "title": "GaussianForcesDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver" + }, + { + "title": "GaussianLogDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver" + }, + { + "title": "GaussianLogResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult" + }, + { + "title": "HDF5Driver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver" + }, + { + "title": "HFMethodType", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType" + }, + { + "title": "InitialGuess", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess" + }, + { + "title": "Molecule", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule" + }, + { + "title": "PSI4Driver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver" + }, + { + "title": "PyQuanteDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver" + }, + { + "title": "PySCFDriver", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver" + }, + { + "title": "qiskit.chemistry.drivers.gaussiand", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.gaussiand" + }, + { + "title": "qiskit.chemistry.drivers.psi4d", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.psi4d" + }, + { + "title": "qiskit.chemistry.drivers.pyquanted", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.pyquanted" + }, + { + "title": "qiskit.chemistry.drivers.pyscfd", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.pyscfd" + }, + { + "title": "UnitsType", + "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType" + } + ] + }, + { + "title": "qiskit.chemistry.results", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.results" + }, + { + "title": "BOPESSamplerResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult" + }, + { + "title": "EigenstateResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult" + }, + { + "title": "ElectronicStructureResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult" + }, + { + "title": "VibronicStructureResult", + "url": "/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult" + } + ] + }, + { + "title": "qiskit.chemistry.transformations", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations" + }, + { + "title": "BosonicQubitMappingType", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType" + }, + { + "title": "BosonicTransformation", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation" + }, + { + "title": "BosonicTransformationType", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType" + }, + { + "title": "FermionicQubitMappingType", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType" + }, + { + "title": "FermionicTransformation", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation" + }, + { + "title": "FermionicTransformationType", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType" + }, + { + "title": "Transformation", + "url": "/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation" + } + ] + } + ] + }, + { + "title": "qiskit.circuit", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/circuit" + }, + { + "title": "AncillaQubit", + "url": "/api/qiskit/0.32/qiskit.circuit.AncillaQubit" + }, + { + "title": "AncillaRegister", + "url": "/api/qiskit/0.32/qiskit.circuit.AncillaRegister" + }, + { + "title": "AND", + "url": "/api/qiskit/0.32/qiskit.circuit.library.AND" + }, + { + "title": "Barrier", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Barrier" + }, + { + "title": "C3SXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.C3SXGate" + }, + { + "title": "C3XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.C3XGate" + }, + { + "title": "C4XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.C4XGate" + }, + { + "title": "CCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CCXGate" + }, + { + "title": "CDKMRippleCarryAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder" + }, + { + "title": "CHGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CHGate" + }, + { + "title": "ClassicalRegister", + "url": "/api/qiskit/0.32/qiskit.circuit.ClassicalRegister" + }, + { + "title": "Clbit", + "url": "/api/qiskit/0.32/qiskit.circuit.Clbit" + }, + { + "title": "clifford_2_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_1" + }, + { + "title": "clifford_2_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_2" + }, + { + "title": "clifford_2_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_3" + }, + { + "title": "clifford_2_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_2_4" + }, + { + "title": "clifford_3_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_3_1" + }, + { + "title": "clifford_4_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_1" + }, + { + "title": "clifford_4_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_2" + }, + { + "title": "clifford_4_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_3" + }, + { + "title": "clifford_4_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_4_4" + }, + { + "title": "clifford_5_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_5_1" + }, + { + "title": "clifford_6_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_1" + }, + { + "title": "clifford_6_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_2" + }, + { + "title": "clifford_6_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_3" + }, + { + "title": "clifford_6_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_4" + }, + { + "title": "clifford_6_5", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_6_5" + }, + { + "title": "clifford_8_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_1" + }, + { + "title": "clifford_8_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_2" + }, + { + "title": "clifford_8_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.clifford_8_3" + }, + { + "title": "ControlledGate", + "url": "/api/qiskit/0.32/qiskit.circuit.ControlledGate" + }, + { + "title": "CPhaseGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate" + }, + { + "title": "CRXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CRXGate" + }, + { + "title": "CRYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CRYGate" + }, + { + "title": "CRZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CRZGate" + }, + { + "title": "CSwapGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CSwapGate" + }, + { + "title": "CSXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CSXGate" + }, + { + "title": "CU1Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CU1Gate" + }, + { + "title": "CU3Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CU3Gate" + }, + { + "title": "CUGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CUGate" + }, + { + "title": "CXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CXGate" + }, + { + "title": "CYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CYGate" + }, + { + "title": "CZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.CZGate" + }, + { + "title": "DCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.DCXGate" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.32/qiskit.circuit.Delay" + }, + { + "title": "Diagonal", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Diagonal" + }, + { + "title": "DraperQFTAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder" + }, + { + "title": "ECRGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ECRGate" + }, + { + "title": "EfficientSU2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2" + }, + { + "title": "EquivalenceLibrary", + "url": "/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary" + }, + { + "title": "EvolvedOperatorAnsatz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz" + }, + { + "title": "ExcitationPreserving", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving" + }, + { + "title": "FourierChecking", + "url": "/api/qiskit/0.32/qiskit.circuit.library.FourierChecking" + }, + { + "title": "FunctionalPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations" + }, + { + "title": "Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.Gate" + }, + { + "title": "GMS", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GMS" + }, + { + "title": "GR", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GR" + }, + { + "title": "GraphState", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GraphState" + }, + { + "title": "GroverOperator", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GroverOperator" + }, + { + "title": "GRX", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GRX" + }, + { + "title": "GRY", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GRY" + }, + { + "title": "GRZ", + "url": "/api/qiskit/0.32/qiskit.circuit.library.GRZ" + }, + { + "title": "HGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.HGate" + }, + { + "title": "HiddenLinearFunction", + "url": "/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction" + }, + { + "title": "HRSCumulativeMultiplier", + "url": "/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier" + }, + { + "title": "IGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.IGate" + }, + { + "title": "InnerProduct", + "url": "/api/qiskit/0.32/qiskit.circuit.library.InnerProduct" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.32/qiskit.circuit.Instruction" + }, + { + "title": "InstructionSet", + "url": "/api/qiskit/0.32/qiskit.circuit.InstructionSet" + }, + { + "title": "IntegerComparator", + "url": "/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator" + }, + { + "title": "IQP", + "url": "/api/qiskit/0.32/qiskit.circuit.library.IQP" + }, + { + "title": "iSwapGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.iSwapGate" + }, + { + "title": "LinearAmplitudeFunction", + "url": "/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction" + }, + { + "title": "LinearPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations" + }, + { + "title": "LogNormalDistribution", + "url": "/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution" + }, + { + "title": "MCMT", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCMT" + }, + { + "title": "MCMTVChain", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain" + }, + { + "title": "MCPhaseGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate" + }, + { + "title": "MCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXGate" + }, + { + "title": "MCXGrayCode", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode" + }, + { + "title": "MCXRecursive", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive" + }, + { + "title": "MCXVChain", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MCXVChain" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.32/qiskit.circuit.Measure" + }, + { + "title": "Measure", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Measure" + }, + { + "title": "MSGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.MSGate" + }, + { + "title": "NLocal", + "url": "/api/qiskit/0.32/qiskit.circuit.library.NLocal" + }, + { + "title": "NormalDistribution", + "url": "/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution" + }, + { + "title": "OR", + "url": "/api/qiskit/0.32/qiskit.circuit.library.OR" + }, + { + "title": "Parameter", + "url": "/api/qiskit/0.32/qiskit.circuit.Parameter" + }, + { + "title": "ParameterExpression", + "url": "/api/qiskit/0.32/qiskit.circuit.ParameterExpression" + }, + { + "title": "ParameterVector", + "url": "/api/qiskit/0.32/qiskit.circuit.ParameterVector" + }, + { + "title": "PauliFeatureMap", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap" + }, + { + "title": "PauliGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliGate" + }, + { + "title": "PauliTwoDesign", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign" + }, + { + "title": "Permutation", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Permutation" + }, + { + "title": "PhaseEstimation", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation" + }, + { + "title": "PhaseGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseGate" + }, + { + "title": "PhaseOracle", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle" + }, + { + "title": "PiecewiseChebyshev", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev" + }, + { + "title": "PiecewiseLinearPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations" + }, + { + "title": "PiecewisePolynomialPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations" + }, + { + "title": "PolynomialPauliRotations", + "url": "/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations" + }, + { + "title": "QAOAAnsatz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz" + }, + { + "title": "QFT", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QFT" + }, + { + "title": "QuadraticForm", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm" + }, + { + "title": "QuantumCircuit", + "url": "/api/qiskit/0.32/qiskit.circuit.QuantumCircuit" + }, + { + "title": "QuantumRegister", + "url": "/api/qiskit/0.32/qiskit.circuit.QuantumRegister" + }, + { + "title": "QuantumVolume", + "url": "/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume" + }, + { + "title": "Qubit", + "url": "/api/qiskit/0.32/qiskit.circuit.Qubit" + }, + { + "title": "random_circuit", + "url": "/api/qiskit/0.32/qiskit.circuit.random.random_circuit" + }, + { + "title": "RC3XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RC3XGate" + }, + { + "title": "RCCXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RCCXGate" + }, + { + "title": "RealAmplitudes", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.32/qiskit.circuit.Reset" + }, + { + "title": "Reset", + "url": "/api/qiskit/0.32/qiskit.circuit.library.Reset" + }, + { + "title": "RGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RGate" + }, + { + "title": "RGQFTMultiplier", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier" + }, + { + "title": "RVGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RVGate" + }, + { + "title": "RXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RXGate" + }, + { + "title": "RXXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RXXGate" + }, + { + "title": "RYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RYGate" + }, + { + "title": "RYYGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RYYGate" + }, + { + "title": "RZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RZGate" + }, + { + "title": "rzx_cy", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_cy" + }, + { + "title": "rzx_xz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_xz" + }, + { + "title": "rzx_yz", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_yz" + }, + { + "title": "rzx_zz1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz1" + }, + { + "title": "rzx_zz2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz2" + }, + { + "title": "rzx_zz3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.rzx_zz3" + }, + { + "title": "RZXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RZXGate" + }, + { + "title": "RZZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.RZZGate" + }, + { + "title": "SdgGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SdgGate" + }, + { + "title": "SGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SGate" + }, + { + "title": "SwapGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SwapGate" + }, + { + "title": "SXdgGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SXdgGate" + }, + { + "title": "SXGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.SXGate" + }, + { + "title": "TdgGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.TdgGate" + }, + { + "title": "template_nct_2a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_1" + }, + { + "title": "template_nct_2a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_2" + }, + { + "title": "template_nct_2a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_2a_3" + }, + { + "title": "template_nct_4a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_1" + }, + { + "title": "template_nct_4a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_2" + }, + { + "title": "template_nct_4a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4a_3" + }, + { + "title": "template_nct_4b_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_1" + }, + { + "title": "template_nct_4b_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_4b_2" + }, + { + "title": "template_nct_5a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_1" + }, + { + "title": "template_nct_5a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_2" + }, + { + "title": "template_nct_5a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_3" + }, + { + "title": "template_nct_5a_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_5a_4" + }, + { + "title": "template_nct_6a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_1" + }, + { + "title": "template_nct_6a_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_2" + }, + { + "title": "template_nct_6a_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_3" + }, + { + "title": "template_nct_6a_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6a_4" + }, + { + "title": "template_nct_6b_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_1" + }, + { + "title": "template_nct_6b_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6b_2" + }, + { + "title": "template_nct_6c_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_6c_1" + }, + { + "title": "template_nct_7a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7a_1" + }, + { + "title": "template_nct_7b_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7b_1" + }, + { + "title": "template_nct_7c_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7c_1" + }, + { + "title": "template_nct_7d_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7d_1" + }, + { + "title": "template_nct_7e_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_7e_1" + }, + { + "title": "template_nct_9a_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9a_1" + }, + { + "title": "template_nct_9c_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_1" + }, + { + "title": "template_nct_9c_10", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_10" + }, + { + "title": "template_nct_9c_11", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_11" + }, + { + "title": "template_nct_9c_12", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_12" + }, + { + "title": "template_nct_9c_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_2" + }, + { + "title": "template_nct_9c_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_3" + }, + { + "title": "template_nct_9c_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_4" + }, + { + "title": "template_nct_9c_5", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_5" + }, + { + "title": "template_nct_9c_6", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_6" + }, + { + "title": "template_nct_9c_7", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_7" + }, + { + "title": "template_nct_9c_8", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_8" + }, + { + "title": "template_nct_9c_9", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9c_9" + }, + { + "title": "template_nct_9d_1", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_1" + }, + { + "title": "template_nct_9d_10", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_10" + }, + { + "title": "template_nct_9d_2", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_2" + }, + { + "title": "template_nct_9d_3", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_3" + }, + { + "title": "template_nct_9d_4", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_4" + }, + { + "title": "template_nct_9d_5", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_5" + }, + { + "title": "template_nct_9d_6", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_6" + }, + { + "title": "template_nct_9d_7", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_7" + }, + { + "title": "template_nct_9d_8", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_8" + }, + { + "title": "template_nct_9d_9", + "url": "/api/qiskit/0.32/qiskit.circuit.library.templates.nct.template_nct_9d_9" + }, + { + "title": "TGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.TGate" + }, + { + "title": "TwoLocal", + "url": "/api/qiskit/0.32/qiskit.circuit.library.TwoLocal" + }, + { + "title": "U1Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.U1Gate" + }, + { + "title": "U2Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.U2Gate" + }, + { + "title": "U3Gate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.U3Gate" + }, + { + "title": "UGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.UGate" + }, + { + "title": "UniformDistribution", + "url": "/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution" + }, + { + "title": "VBERippleCarryAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder" + }, + { + "title": "WeightedAdder", + "url": "/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder" + }, + { + "title": "XGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.XGate" + }, + { + "title": "XOR", + "url": "/api/qiskit/0.32/qiskit.circuit.library.XOR" + }, + { + "title": "YGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.YGate" + }, + { + "title": "ZFeatureMap", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap" + }, + { + "title": "ZGate", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ZGate" + }, + { + "title": "ZZFeatureMap", + "url": "/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap" + }, + { + "title": "qiskit.circuit.classicalfunction", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/classicalfunction" + }, + { + "title": "BooleanExpression", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression" + }, + { + "title": "ClassicalFunction", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction" + }, + { + "title": "ClassicalFunctionCompilerTypeError", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError" + }, + { + "title": "ClassicalFunctionParseError", + "url": "/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError" + } + ] + }, + { + "title": "qiskit.circuit.qpy_serialization", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qpy" + }, + { + "title": "dump", + "url": "/api/qiskit/0.32/qiskit.circuit.qpy_serialization.dump" + }, + { + "title": "load", + "url": "/api/qiskit/0.32/qiskit.circuit.qpy_serialization.load" + } + ] + } + ] + }, + { + "title": "qiskit.compiler", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/compiler" + }, + { + "title": "assemble", + "url": "/api/qiskit/0.32/qiskit.compiler.assemble" + }, + { + "title": "schedule", + "url": "/api/qiskit/0.32/qiskit.compiler.schedule" + }, + { + "title": "sequence", + "url": "/api/qiskit/0.32/qiskit.compiler.sequence" + }, + { + "title": "transpile", + "url": "/api/qiskit/0.32/qiskit.compiler.transpile" + } + ] + }, + { + "title": "qiskit.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/converters" + }, + { + "title": "ast_to_dag", + "url": "/api/qiskit/0.32/qiskit.converters.ast_to_dag" + }, + { + "title": "circuit_to_dag", + "url": "/api/qiskit/0.32/qiskit.converters.circuit_to_dag" + }, + { + "title": "circuit_to_dagdependency", + "url": "/api/qiskit/0.32/qiskit.converters.circuit_to_dagdependency" + }, + { + "title": "circuit_to_gate", + "url": "/api/qiskit/0.32/qiskit.converters.circuit_to_gate" + }, + { + "title": "circuit_to_instruction", + "url": "/api/qiskit/0.32/qiskit.converters.circuit_to_instruction" + }, + { + "title": "dag_to_circuit", + "url": "/api/qiskit/0.32/qiskit.converters.dag_to_circuit" + }, + { + "title": "dag_to_dagdependency", + "url": "/api/qiskit/0.32/qiskit.converters.dag_to_dagdependency" + }, + { + "title": "dagdependency_to_circuit", + "url": "/api/qiskit/0.32/qiskit.converters.dagdependency_to_circuit" + }, + { + "title": "dagdependency_to_dag", + "url": "/api/qiskit/0.32/qiskit.converters.dagdependency_to_dag" + } + ] + }, + { + "title": "qiskit.dagcircuit", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/dagcircuit" + }, + { + "title": "DAGCircuit", + "url": "/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit" + }, + { + "title": "DAGCircuitError", + "url": "/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError" + }, + { + "title": "DAGDependency", + "url": "/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency" + }, + { + "title": "DAGDepNode", + "url": "/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode" + }, + { + "title": "DAGNode", + "url": "/api/qiskit/0.32/qiskit.dagcircuit.DAGNode" + } + ] + }, + { + "title": "qiskit.execute_function", + "url": "/api/qiskit/0.32/execute" + }, + { + "title": "qiskit.extensions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/extensions" + }, + { + "title": "HamiltonianGate", + "url": "/api/qiskit/0.32/qiskit.extensions.HamiltonianGate" + }, + { + "title": "Initialize", + "url": "/api/qiskit/0.32/qiskit.extensions.Initialize" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.32/qiskit.extensions.Snapshot" + }, + { + "title": "UnitaryGate", + "url": "/api/qiskit/0.32/qiskit.extensions.UnitaryGate" + } + ] + }, + { + "title": "qiskit.finance", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit_finance" + }, + { + "title": "QiskitFinanceError", + "url": "/api/qiskit/0.32/qiskit.finance.QiskitFinanceError" + }, + { + "title": "qiskit.finance.applications", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.finance.applications" + }, + { + "title": "qiskit.finance.applications.ising", + "url": "/api/qiskit/0.32/qiskit.finance.applications.ising" + } + ] + }, + { + "title": "qiskit.finance.components", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.finance.components" + }, + { + "title": "qiskit.finance.components.uncertainty_problems", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems" + }, + { + "title": "EuropeanCallDelta", + "url": "/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallDelta" + }, + { + "title": "EuropeanCallExpectedValue", + "url": "/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue" + }, + { + "title": "FixedIncomeExpectedValue", + "url": "/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue" + } + ] + } + ] + }, + { + "title": "qiskit.finance.data_providers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers" + }, + { + "title": "BaseDataProvider", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers.BaseDataProvider" + }, + { + "title": "DataOnDemandProvider", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers.DataOnDemandProvider" + }, + { + "title": "ExchangeDataProvider", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers.ExchangeDataProvider" + }, + { + "title": "RandomDataProvider", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers.RandomDataProvider" + }, + { + "title": "StockMarket", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers.StockMarket" + }, + { + "title": "WikipediaDataProvider", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers.WikipediaDataProvider" + }, + { + "title": "YahooDataProvider", + "url": "/api/qiskit/0.32/qiskit.finance.data_providers.YahooDataProvider" + } + ] + } + ] + }, + { + "title": "qiskit.ignis", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ignis" + }, + { + "title": "qiskit.ignis.characterization", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/characterization" + }, + { + "title": "ampcal_1Q_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_1Q_circuits" + }, + { + "title": "ampcal_cx_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.ampcal_cx_circuits" + }, + { + "title": "AmpCalCXFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter" + }, + { + "title": "AmpCalFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter" + }, + { + "title": "anglecal_1Q_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_1Q_circuits" + }, + { + "title": "anglecal_cx_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.anglecal_cx_circuits" + }, + { + "title": "AngleCalCXFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter" + }, + { + "title": "AngleCalFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter" + }, + { + "title": "BaseCoherenceFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter" + }, + { + "title": "BaseGateFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter" + }, + { + "title": "drag_schedules", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.drag_schedules" + }, + { + "title": "DragFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter" + }, + { + "title": "get_single_q_pulse", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.get_single_q_pulse" + }, + { + "title": "rabi_schedules", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.rabi_schedules" + }, + { + "title": "RabiFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter" + }, + { + "title": "t1_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.t1_circuits" + }, + { + "title": "T1Fitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter" + }, + { + "title": "t2_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.t2_circuits" + }, + { + "title": "T2Fitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter" + }, + { + "title": "t2star_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.t2star_circuits" + }, + { + "title": "T2StarFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter" + }, + { + "title": "update_u_gates", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.update_u_gates" + }, + { + "title": "zz_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.zz_circuits" + }, + { + "title": "ZZFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter" + } + ] + }, + { + "title": "qiskit.ignis.logging", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/logging" + }, + { + "title": "IgnisLogger", + "url": "/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger" + }, + { + "title": "IgnisLogging", + "url": "/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging" + }, + { + "title": "IgnisLogReader", + "url": "/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader" + } + ] + }, + { + "title": "qiskit.ignis.measurement", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/measurement" + }, + { + "title": "DiscriminationFilter", + "url": "/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter" + }, + { + "title": "IQDiscriminationFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter" + }, + { + "title": "LinearIQDiscriminator", + "url": "/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator" + }, + { + "title": "QuadraticIQDiscriminator", + "url": "/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator" + }, + { + "title": "SklearnIQDiscriminator", + "url": "/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator" + } + ] + }, + { + "title": "qiskit.ignis.mitigation", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/mitigation" + }, + { + "title": "complete_meas_cal", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.complete_meas_cal" + }, + { + "title": "CompleteExpvalMeasMitigator", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator" + }, + { + "title": "CompleteMeasFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter" + }, + { + "title": "CTMPExpvalMeasMitigator", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator" + }, + { + "title": "expectation_value", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.expectation_value" + }, + { + "title": "expval_meas_mitigator_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.expval_meas_mitigator_circuits" + }, + { + "title": "ExpvalMeasMitigatorFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter" + }, + { + "title": "MeasurementFilter", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter" + }, + { + "title": "tensored_meas_cal", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.tensored_meas_cal" + }, + { + "title": "TensoredExpvalMeasMitigator", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator" + }, + { + "title": "TensoredFilter", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter" + }, + { + "title": "TensoredMeasFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter" + } + ] + }, + { + "title": "qiskit.ignis.verification", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/verification" + }, + { + "title": "AccreditationCircuits", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits" + }, + { + "title": "AccreditationFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter" + }, + { + "title": "BConfig", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.BConfig" + }, + { + "title": "calculate_1q_epc", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epc" + }, + { + "title": "calculate_1q_epg", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.calculate_1q_epg" + }, + { + "title": "calculate_2q_epc", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epc" + }, + { + "title": "calculate_2q_epg", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.calculate_2q_epg" + }, + { + "title": "CNOTDihedral", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral" + }, + { + "title": "CNOTDihedralRBFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter" + }, + { + "title": "coherence_limit", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.coherence_limit" + }, + { + "title": "combine_counts", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.combine_counts" + }, + { + "title": "composite_pauli_z", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z" + }, + { + "title": "composite_pauli_z_expvalue", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.composite_pauli_z_expvalue" + }, + { + "title": "count_gates", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.count_gates" + }, + { + "title": "count_keys", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.count_keys" + }, + { + "title": "expectation_counts", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.expectation_counts" + }, + { + "title": "gates_per_clifford", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.gates_per_clifford" + }, + { + "title": "gateset_tomography_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.gateset_tomography_circuits" + }, + { + "title": "GatesetTomographyFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter" + }, + { + "title": "get_ghz_mqc", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc" + }, + { + "title": "get_ghz_mqc_para", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_mqc_para" + }, + { + "title": "get_ghz_po", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po" + }, + { + "title": "get_ghz_po_para", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_po_para" + }, + { + "title": "get_ghz_simple", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.get_ghz_simple" + }, + { + "title": "GraphDecoder", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.GraphDecoder" + }, + { + "title": "InterleavedRBFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter" + }, + { + "title": "lookuptable_decoding", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.lookuptable_decoding" + }, + { + "title": "marginal_counts", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.marginal_counts" + }, + { + "title": "ordered_list_generator", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.ordered_list_generator" + }, + { + "title": "Plotter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.Plotter" + }, + { + "title": "postselection_decoding", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.postselection_decoding" + }, + { + "title": "process_tomography_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.process_tomography_circuits" + }, + { + "title": "ProcessTomographyFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter" + }, + { + "title": "PurityRBFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter" + }, + { + "title": "QOTP", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.QOTP" + }, + { + "title": "QOTPCorrectCounts", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.QOTPCorrectCounts" + }, + { + "title": "qv_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.qv_circuits" + }, + { + "title": "QVFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.QVFitter" + }, + { + "title": "randomized_benchmarking_seq", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.randomized_benchmarking_seq" + }, + { + "title": "RBFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.RBFitter" + }, + { + "title": "RepetitionCode", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode" + }, + { + "title": "rho_to_fidelity", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.rho_to_fidelity" + }, + { + "title": "state_tomography_circuits", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.state_tomography_circuits" + }, + { + "title": "StateTomographyFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter" + }, + { + "title": "TomographyFitter", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter" + }, + { + "title": "twoQ_clifford_error", + "url": "/api/qiskit/0.32/qiskit.ignis.verification.twoQ_clifford_error" + } + ] + } + ] + }, + { + "title": "qiskit.ml", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit_ml" + }, + { + "title": "qiskit.ml.circuit.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.ml.circuit.library" + }, + { + "title": "RawFeatureVector", + "url": "/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector" + } + ] + }, + { + "title": "qiskit.ml.datasets", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.ml.datasets" + }, + { + "title": "ad_hoc_data", + "url": "/api/qiskit/0.32/qiskit.ml.datasets.ad_hoc_data" + }, + { + "title": "breast_cancer", + "url": "/api/qiskit/0.32/qiskit.ml.datasets.breast_cancer" + }, + { + "title": "digits", + "url": "/api/qiskit/0.32/qiskit.ml.datasets.digits" + }, + { + "title": "gaussian", + "url": "/api/qiskit/0.32/qiskit.ml.datasets.gaussian" + }, + { + "title": "iris", + "url": "/api/qiskit/0.32/qiskit.ml.datasets.iris" + }, + { + "title": "sample_ad_hoc_data", + "url": "/api/qiskit/0.32/qiskit.ml.datasets.sample_ad_hoc_data" + }, + { + "title": "wine", + "url": "/api/qiskit/0.32/qiskit.ml.datasets.wine" + } + ] + } + ] + }, + { + "title": "qiskit.opflow", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/opflow" + }, + { + "title": "AbelianGrouper", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper" + }, + { + "title": "AerPauliExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation" + }, + { + "title": "anti_commutator", + "url": "/api/qiskit/0.32/qiskit.opflow.anti_commutator" + }, + { + "title": "CircuitGradient", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient" + }, + { + "title": "CircuitOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.CircuitOp" + }, + { + "title": "CircuitQFI", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI" + }, + { + "title": "CircuitSampler", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler" + }, + { + "title": "CircuitStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.CircuitStateFn" + }, + { + "title": "commutator", + "url": "/api/qiskit/0.32/qiskit.opflow.commutator" + }, + { + "title": "ComposedOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.ComposedOp" + }, + { + "title": "ConverterBase", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase" + }, + { + "title": "CVaRExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation" + }, + { + "title": "CVaRMeasurement", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.CVaRMeasurement" + }, + { + "title": "DerivativeBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase" + }, + { + "title": "DictStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.DictStateFn" + }, + { + "title": "DictToCircuitSum", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum" + }, + { + "title": "double_commutator", + "url": "/api/qiskit/0.32/qiskit.opflow.double_commutator" + }, + { + "title": "EvolutionBase", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase" + }, + { + "title": "EvolutionFactory", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory" + }, + { + "title": "EvolvedOp", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp" + }, + { + "title": "ExpectationBase", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase" + }, + { + "title": "ExpectationFactory", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory" + }, + { + "title": "Gradient", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.Gradient" + }, + { + "title": "GradientBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase" + }, + { + "title": "Hessian", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.Hessian" + }, + { + "title": "HessianBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase" + }, + { + "title": "ListOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.ListOp" + }, + { + "title": "MatrixEvolution", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution" + }, + { + "title": "MatrixExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation" + }, + { + "title": "MatrixOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.MatrixOp" + }, + { + "title": "NaturalGradient", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient" + }, + { + "title": "OperatorBase", + "url": "/api/qiskit/0.32/qiskit.opflow.OperatorBase" + }, + { + "title": "OperatorStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.OperatorStateFn" + }, + { + "title": "OpflowError", + "url": "/api/qiskit/0.32/qiskit.opflow.OpflowError" + }, + { + "title": "PauliBasisChange", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange" + }, + { + "title": "PauliExpectation", + "url": "/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation" + }, + { + "title": "PauliOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliOp" + }, + { + "title": "PauliSumOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PauliSumOp" + }, + { + "title": "PauliTrotterEvolution", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution" + }, + { + "title": "PrimitiveOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.PrimitiveOp" + }, + { + "title": "QDrift", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift" + }, + { + "title": "QFI", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.QFI" + }, + { + "title": "QFIBase", + "url": "/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase" + }, + { + "title": "SparseVectorStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.SparseVectorStateFn" + }, + { + "title": "StateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.StateFn" + }, + { + "title": "SummedOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.SummedOp" + }, + { + "title": "Suzuki", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki" + }, + { + "title": "TaperedPauliSumOp", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.TaperedPauliSumOp" + }, + { + "title": "TensoredOp", + "url": "/api/qiskit/0.32/qiskit.opflow.list_ops.TensoredOp" + }, + { + "title": "Trotter", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter" + }, + { + "title": "TrotterizationBase", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase" + }, + { + "title": "TrotterizationFactory", + "url": "/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory" + }, + { + "title": "TwoQubitReduction", + "url": "/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction" + }, + { + "title": "VectorStateFn", + "url": "/api/qiskit/0.32/qiskit.opflow.state_fns.VectorStateFn" + }, + { + "title": "Z2Symmetries", + "url": "/api/qiskit/0.32/qiskit.opflow.primitive_ops.Z2Symmetries" + } + ] + }, + { + "title": "qiskit.optimization", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit_optimization" + }, + { + "title": "QiskitOptimizationError", + "url": "/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError" + }, + { + "title": "QuadraticProgram", + "url": "/api/qiskit/0.32/qiskit.optimization.QuadraticProgram" + }, + { + "title": "qiskit.optimization.algorithms", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms" + }, + { + "title": "ADMMOptimizationResult", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult" + }, + { + "title": "ADMMOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer" + }, + { + "title": "ADMMParameters", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters" + }, + { + "title": "ADMMState", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState" + }, + { + "title": "CobylaOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer" + }, + { + "title": "CplexOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer" + }, + { + "title": "GroverOptimizationResult", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult" + }, + { + "title": "GroverOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer" + }, + { + "title": "IntermediateResult", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult" + }, + { + "title": "MinimumEigenOptimizationResult", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult" + }, + { + "title": "MinimumEigenOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer" + }, + { + "title": "MultiStartOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer" + }, + { + "title": "OptimizationAlgorithm", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm" + }, + { + "title": "OptimizationResult", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult" + }, + { + "title": "OptimizationResultStatus", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus" + }, + { + "title": "RecursiveMinimumEigenOptimizationResult", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult" + }, + { + "title": "RecursiveMinimumEigenOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer" + }, + { + "title": "SlsqpOptimizationResult", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult" + }, + { + "title": "SlsqpOptimizer", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer" + }, + { + "title": "SolutionSample", + "url": "/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample" + } + ] + }, + { + "title": "qiskit.optimization.applications", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.optimization.applications" + }, + { + "title": "qiskit.optimization.applications.ising", + "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising" + } + ] + }, + { + "title": "qiskit.optimization.converters", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.optimization.converters" + }, + { + "title": "InequalityToEquality", + "url": "/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality" + }, + { + "title": "IntegerToBinary", + "url": "/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary" + }, + { + "title": "LinearEqualityToPenalty", + "url": "/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty" + }, + { + "title": "QuadraticProgramConverter", + "url": "/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter" + }, + { + "title": "QuadraticProgramToQubo", + "url": "/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo" + } + ] + }, + { + "title": "qiskit.optimization.problems", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qiskit.optimization.problems" + }, + { + "title": "Constraint", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.Constraint" + }, + { + "title": "LinearConstraint", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint" + }, + { + "title": "LinearExpression", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression" + }, + { + "title": "QuadraticConstraint", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint" + }, + { + "title": "QuadraticExpression", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression" + }, + { + "title": "QuadraticObjective", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective" + }, + { + "title": "QuadraticProgram", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram" + }, + { + "title": "QuadraticProgramElement", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement" + }, + { + "title": "Variable", + "url": "/api/qiskit/0.32/qiskit.optimization.problems.Variable" + } + ] + } + ] + }, + { + "title": "qiskit.providers", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/providers" + }, + { + "title": "Backend", + "url": "/api/qiskit/0.32/qiskit.providers.Backend" + }, + { + "title": "BackendPropertyError", + "url": "/api/qiskit/0.32/qiskit.providers.BackendPropertyError" + }, + { + "title": "BackendV1", + "url": "/api/qiskit/0.32/qiskit.providers.BackendV1" + }, + { + "title": "BaseBackend", + "url": "/api/qiskit/0.32/qiskit.providers.BaseBackend" + }, + { + "title": "BaseJob", + "url": "/api/qiskit/0.32/qiskit.providers.BaseJob" + }, + { + "title": "BaseProvider", + "url": "/api/qiskit/0.32/qiskit.providers.BaseProvider" + }, + { + "title": "Job", + "url": "/api/qiskit/0.32/qiskit.providers.Job" + }, + { + "title": "JobError", + "url": "/api/qiskit/0.32/qiskit.providers.JobError" + }, + { + "title": "JobStatus", + "url": "/api/qiskit/0.32/qiskit.providers.JobStatus" + }, + { + "title": "JobTimeoutError", + "url": "/api/qiskit/0.32/qiskit.providers.JobTimeoutError" + }, + { + "title": "JobV1", + "url": "/api/qiskit/0.32/qiskit.providers.JobV1" + }, + { + "title": "Options", + "url": "/api/qiskit/0.32/qiskit.providers.Options" + }, + { + "title": "Provider", + "url": "/api/qiskit/0.32/qiskit.providers.Provider" + }, + { + "title": "ProviderV1", + "url": "/api/qiskit/0.32/qiskit.providers.ProviderV1" + }, + { + "title": "QiskitBackendNotFoundError", + "url": "/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError" + }, + { + "title": "qiskit.providers.aer", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/aer_provider" + }, + { + "title": "AerError", + "url": "/api/qiskit/0.32/qiskit.providers.aer.AerError" + }, + { + "title": "AerProvider", + "url": "/api/qiskit/0.32/qiskit.providers.aer.AerProvider" + }, + { + "title": "AerSimulator", + "url": "/api/qiskit/0.32/qiskit.providers.aer.AerSimulator" + }, + { + "title": "PulseSimulator", + "url": "/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator" + }, + { + "title": "QasmSimulator", + "url": "/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator" + }, + { + "title": "StatevectorSimulator", + "url": "/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator" + }, + { + "title": "UnitarySimulator", + "url": "/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator" + }, + { + "title": "qiskit.providers.aer.extensions", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/aer_extensions" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.32/qiskit.providers.aer.extensions.Snapshot" + }, + { + "title": "SnapshotDensityMatrix", + "url": "/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotDensityMatrix" + }, + { + "title": "SnapshotExpectationValue", + "url": "/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotExpectationValue" + }, + { + "title": "SnapshotProbabilities", + "url": "/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotProbabilities" + }, + { + "title": "SnapshotStabilizer", + "url": "/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStabilizer" + }, + { + "title": "SnapshotStatevector", + "url": "/api/qiskit/0.32/qiskit.providers.aer.extensions.SnapshotStatevector" + } + ] + }, + { + "title": "qiskit.providers.aer.jobs", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/aer_jobs" + }, + { + "title": "AerJob", + "url": "/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJob" + }, + { + "title": "AerJobSet", + "url": "/api/qiskit/0.32/qiskit.providers.aer.jobs.AerJobSet" + } + ] + }, + { + "title": "qiskit.providers.aer.library", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/aer_library" + }, + { + "title": "save_amplitudes", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes" + }, + { + "title": "save_amplitudes_squared", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_amplitudes_squared" + }, + { + "title": "save_density_matrix", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_density_matrix" + }, + { + "title": "save_expectation_value", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value" + }, + { + "title": "save_expectation_value_variance", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_expectation_value_variance" + }, + { + "title": "save_matrix_product_state", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_matrix_product_state" + }, + { + "title": "save_probabilities", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities" + }, + { + "title": "save_probabilities_dict", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_probabilities_dict" + }, + { + "title": "save_stabilizer", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_stabilizer" + }, + { + "title": "save_state", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_state" + }, + { + "title": "save_statevector", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector" + }, + { + "title": "save_statevector_dict", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_statevector_dict" + }, + { + "title": "save_unitary", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.save_unitary" + }, + { + "title": "SaveAmplitudes", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudes" + }, + { + "title": "SaveAmplitudesSquared", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveAmplitudesSquared" + }, + { + "title": "SaveDensityMatrix", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveDensityMatrix" + }, + { + "title": "SaveExpectationValue", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValue" + }, + { + "title": "SaveExpectationValueVariance", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveExpectationValueVariance" + }, + { + "title": "SaveMatrixProductState", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveMatrixProductState" + }, + { + "title": "SaveProbabilities", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilities" + }, + { + "title": "SaveProbabilitiesDict", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveProbabilitiesDict" + }, + { + "title": "SaveStabilizer", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveStabilizer" + }, + { + "title": "SaveState", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveState" + }, + { + "title": "SaveStatevector", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevector" + }, + { + "title": "SaveStatevectorDict", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveStatevectorDict" + }, + { + "title": "SaveSuperOp", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveSuperOp" + }, + { + "title": "SaveUnitary", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SaveUnitary" + }, + { + "title": "set_density_matrix", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.set_density_matrix" + }, + { + "title": "set_matrix_product_state", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.set_matrix_product_state" + }, + { + "title": "set_stabilizer", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.set_stabilizer" + }, + { + "title": "set_statevector", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.set_statevector" + }, + { + "title": "set_superop", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.set_superop" + }, + { + "title": "set_unitary", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.set_unitary" + }, + { + "title": "SetDensityMatrix", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SetDensityMatrix" + }, + { + "title": "SetMatrixProductState", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SetMatrixProductState" + }, + { + "title": "SetStabilizer", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SetStabilizer" + }, + { + "title": "SetStatevector", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SetStatevector" + }, + { + "title": "SetSuperOp", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SetSuperOp" + }, + { + "title": "SetUnitary", + "url": "/api/qiskit/0.32/qiskit.providers.aer.library.SetUnitary" + } + ] + }, + { + "title": "qiskit.providers.aer.noise", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/aer_noise" + }, + { + "title": "amplitude_damping_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.amplitude_damping_error" + }, + { + "title": "basic_device_gate_errors", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_gate_errors" + }, + { + "title": "basic_device_readout_errors", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.device.basic_device_readout_errors" + }, + { + "title": "coherent_unitary_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.coherent_unitary_error" + }, + { + "title": "depolarizing_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.depolarizing_error" + }, + { + "title": "gate_error_values", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_error_values" + }, + { + "title": "gate_length_values", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_length_values" + }, + { + "title": "gate_param_values", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.device.gate_param_values" + }, + { + "title": "kraus_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.kraus_error" + }, + { + "title": "mixed_unitary_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.mixed_unitary_error" + }, + { + "title": "NoiseModel", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.NoiseModel" + }, + { + "title": "pauli_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.pauli_error" + }, + { + "title": "phase_amplitude_damping_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.phase_amplitude_damping_error" + }, + { + "title": "phase_damping_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.phase_damping_error" + }, + { + "title": "QuantumError", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError" + }, + { + "title": "readout_error_values", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.device.readout_error_values" + }, + { + "title": "ReadoutError", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.ReadoutError" + }, + { + "title": "reset_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.reset_error" + }, + { + "title": "thermal_relaxation_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.thermal_relaxation_error" + }, + { + "title": "thermal_relaxation_values", + "url": "/api/qiskit/0.32/qiskit.providers.aer.noise.device.thermal_relaxation_values" + } + ] + }, + { + "title": "qiskit.providers.aer.pulse", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/aer_pulse" + }, + { + "title": "duffing_system_model", + "url": "/api/qiskit/0.32/qiskit.providers.aer.pulse.duffing_system_model" + }, + { + "title": "PulseSystemModel", + "url": "/api/qiskit/0.32/qiskit.providers.aer.pulse.PulseSystemModel" + } + ] + }, + { + "title": "qiskit.providers.aer.utils", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/aer_utils" + }, + { + "title": "approximate_noise_model", + "url": "/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_noise_model" + }, + { + "title": "approximate_quantum_error", + "url": "/api/qiskit/0.32/qiskit.providers.aer.utils.approximate_quantum_error" + }, + { + "title": "insert_noise", + "url": "/api/qiskit/0.32/qiskit.providers.aer.utils.insert_noise" + }, + { + "title": "NoiseTransformer", + "url": "/api/qiskit/0.32/qiskit.providers.aer.utils.NoiseTransformer" + }, + { + "title": "remap_noise_model", + "url": "/api/qiskit/0.32/qiskit.providers.aer.utils.remap_noise_model" + } + ] + } + ] + }, + { + "title": "qiskit.providers.basicaer", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/providers_basicaer" + }, + { + "title": "BasicAerError", + "url": "/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError" + }, + { + "title": "BasicAerJob", + "url": "/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob" + }, + { + "title": "BasicAerProvider", + "url": "/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider" + }, + { + "title": "QasmSimulatorPy", + "url": "/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy" + }, + { + "title": "StatevectorSimulatorPy", + "url": "/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy" + }, + { + "title": "UnitarySimulatorPy", + "url": "/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy" + } + ] + }, + { + "title": "qiskit.providers.ibmq", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_provider" + }, + { + "title": "AccountProvider", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider" + }, + { + "title": "BackendJobLimit", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit" + }, + { + "title": "IBMQAccountCredentialsInvalidFormat", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat" + }, + { + "title": "IBMQAccountCredentialsInvalidToken", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken" + }, + { + "title": "IBMQAccountCredentialsInvalidUrl", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl" + }, + { + "title": "IBMQAccountCredentialsNotFound", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound" + }, + { + "title": "IBMQAccountError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError" + }, + { + "title": "IBMQAccountMultipleCredentialsFound", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound" + }, + { + "title": "IBMQBackend", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend" + }, + { + "title": "IBMQBackendApiError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError" + }, + { + "title": "IBMQBackendApiProtocolError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError" + }, + { + "title": "IBMQBackendError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError" + }, + { + "title": "IBMQBackendService", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService" + }, + { + "title": "IBMQBackendValueError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError" + }, + { + "title": "IBMQError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError" + }, + { + "title": "IBMQFactory", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory" + }, + { + "title": "IBMQProviderError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError" + }, + { + "title": "least_busy", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.least_busy" + }, + { + "title": "RunnerResult", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult" + }, + { + "title": "qiskit.providers.ibmq.credentials", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_credentials" + }, + { + "title": "Credentials", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.credentials.Credentials" + }, + { + "title": "CredentialsError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsError" + }, + { + "title": "CredentialsNotFoundError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.credentials.CredentialsNotFoundError" + }, + { + "title": "InvalidCredentialsFormatError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError" + } + ] + }, + { + "title": "qiskit.providers.ibmq.experiment", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_experiment" + }, + { + "title": "DeviceComponent", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.experiment.DeviceComponent" + }, + { + "title": "IBMExperimentEntryExists", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryExists" + }, + { + "title": "IBMExperimentEntryNotFound", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound" + }, + { + "title": "IBMExperimentError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentError" + }, + { + "title": "IBMExperimentService", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.experiment.IBMExperimentService" + }, + { + "title": "ResultQuality", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.experiment.ResultQuality" + } + ] + }, + { + "title": "qiskit.providers.ibmq.job", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_job" + }, + { + "title": "IBMQJob", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJob" + }, + { + "title": "IBMQJobApiError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobApiError" + }, + { + "title": "IBMQJobError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobError" + }, + { + "title": "IBMQJobFailureError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobFailureError" + }, + { + "title": "IBMQJobInvalidStateError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobInvalidStateError" + }, + { + "title": "IBMQJobTimeoutError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.IBMQJobTimeoutError" + }, + { + "title": "job_monitor", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.job_monitor" + }, + { + "title": "QueueInfo", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.job.QueueInfo" + } + ] + }, + { + "title": "qiskit.providers.ibmq.managed", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_managed" + }, + { + "title": "IBMQJobManager", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManager" + }, + { + "title": "IBMQJobManagerError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerError" + }, + { + "title": "IBMQJobManagerInvalidStateError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError" + }, + { + "title": "IBMQJobManagerJobNotFound", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound" + }, + { + "title": "IBMQJobManagerTimeoutError", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError" + }, + { + "title": "IBMQJobManagerUnknownJobSet", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet" + }, + { + "title": "IBMQManagedResultDataNotAvailable", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable" + }, + { + "title": "ManagedJob", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJob" + }, + { + "title": "ManagedJobSet", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedJobSet" + }, + { + "title": "ManagedResults", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.managed.ManagedResults" + } + ] + }, + { + "title": "qiskit.providers.ibmq.random", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_random" + }, + { + "title": "CQCExtractor", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractor" + }, + { + "title": "CQCExtractorJob", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.random.CQCExtractorJob" + }, + { + "title": "IBMQRandomService", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.random.IBMQRandomService" + } + ] + }, + { + "title": "qiskit.providers.ibmq.runtime", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_runtime" + }, + { + "title": "IBMRuntimeService", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.IBMRuntimeService" + }, + { + "title": "ParameterNamespace", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ParameterNamespace" + }, + { + "title": "ProgramBackend", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ProgramBackend" + }, + { + "title": "ResultDecoder", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.ResultDecoder" + }, + { + "title": "RuntimeDecoder", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeDecoder" + }, + { + "title": "RuntimeEncoder", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeEncoder" + }, + { + "title": "RuntimeJob", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeJob" + }, + { + "title": "RuntimeProgram", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.RuntimeProgram" + }, + { + "title": "UserMessenger", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.runtime.UserMessenger" + } + ] + }, + { + "title": "qiskit.providers.ibmq.utils", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/ibmq_utils" + }, + { + "title": "seconds_to_duration", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.utils.seconds_to_duration" + }, + { + "title": "to_python_identifier", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.utils.to_python_identifier" + }, + { + "title": "update_qobj_config", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.utils.update_qobj_config" + }, + { + "title": "utc_to_local", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.utils.utc_to_local" + }, + { + "title": "validate_job_tags", + "url": "/api/qiskit/0.32/qiskit.providers.ibmq.utils.validate_job_tags" + } + ] + } + ] + }, + { + "title": "qiskit.providers.models", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/providers_models" + }, + { + "title": "BackendConfiguration", + "url": "/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration" + }, + { + "title": "BackendProperties", + "url": "/api/qiskit/0.32/qiskit.providers.models.BackendProperties" + }, + { + "title": "BackendStatus", + "url": "/api/qiskit/0.32/qiskit.providers.models.BackendStatus" + }, + { + "title": "Command", + "url": "/api/qiskit/0.32/qiskit.providers.models.Command" + }, + { + "title": "GateConfig", + "url": "/api/qiskit/0.32/qiskit.providers.models.GateConfig" + }, + { + "title": "JobStatus", + "url": "/api/qiskit/0.32/qiskit.providers.models.JobStatus" + }, + { + "title": "PulseBackendConfiguration", + "url": "/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration" + }, + { + "title": "PulseDefaults", + "url": "/api/qiskit/0.32/qiskit.providers.models.PulseDefaults" + }, + { + "title": "QasmBackendConfiguration", + "url": "/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration" + }, + { + "title": "UchannelLO", + "url": "/api/qiskit/0.32/qiskit.providers.models.UchannelLO" + } + ] + } + ] + }, + { + "title": "qiskit.pulse", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/pulse" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.32/qiskit.pulse.Acquire" + }, + { + "title": "acquire", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.acquire" + }, + { + "title": "Acquire", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Acquire" + }, + { + "title": "acquire_channel", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.acquire_channel" + }, + { + "title": "AcquireChannel", + "url": "/api/qiskit/0.32/qiskit.pulse.AcquireChannel" + }, + { + "title": "active_backend", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.active_backend" + }, + { + "title": "active_circuit_scheduler_settings", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.active_circuit_scheduler_settings" + }, + { + "title": "active_transpiler_settings", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.active_transpiler_settings" + }, + { + "title": "add_implicit_acquires", + "url": "/api/qiskit/0.32/qiskit.pulse.transforms.add_implicit_acquires" + }, + { + "title": "align_equispaced", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.align_equispaced" + }, + { + "title": "align_func", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.align_func" + }, + { + "title": "align_left", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.align_left" + }, + { + "title": "align_measures", + "url": "/api/qiskit/0.32/qiskit.pulse.transforms.align_measures" + }, + { + "title": "align_right", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.align_right" + }, + { + "title": "align_sequential", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.align_sequential" + }, + { + "title": "barrier", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.barrier" + }, + { + "title": "build", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.build" + }, + { + "title": "Call", + "url": "/api/qiskit/0.32/qiskit.pulse.Call" + }, + { + "title": "call", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.call" + }, + { + "title": "Call", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Call" + }, + { + "title": "circuit_scheduler_settings", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.circuit_scheduler_settings" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.32/qiskit.pulse.Constant" + }, + { + "title": "Constant", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Constant" + }, + { + "title": "control_channels", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.control_channels" + }, + { + "title": "ControlChannel", + "url": "/api/qiskit/0.32/qiskit.pulse.ControlChannel" + }, + { + "title": "cx", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.cx" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.32/qiskit.pulse.Delay" + }, + { + "title": "delay", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.delay" + }, + { + "title": "Delay", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Delay" + }, + { + "title": "delay_qubits", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.delay_qubits" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.32/qiskit.pulse.Drag" + }, + { + "title": "Drag", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Drag" + }, + { + "title": "drive_channel", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.drive_channel" + }, + { + "title": "DriveChannel", + "url": "/api/qiskit/0.32/qiskit.pulse.DriveChannel" + }, + { + "title": "frequency_offset", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.frequency_offset" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.32/qiskit.pulse.Gaussian" + }, + { + "title": "Gaussian", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Gaussian" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.32/qiskit.pulse.GaussianSquare" + }, + { + "title": "GaussianSquare", + "url": "/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare" + }, + { + "title": "inline", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.inline" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.32/qiskit.pulse.Instruction" + }, + { + "title": "Instruction", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Instruction" + }, + { + "title": "InstructionScheduleMap", + "url": "/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap" + }, + { + "title": "measure", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.measure" + }, + { + "title": "measure_all", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.measure_all" + }, + { + "title": "measure_channel", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.measure_channel" + }, + { + "title": "MeasureChannel", + "url": "/api/qiskit/0.32/qiskit.pulse.MeasureChannel" + }, + { + "title": "MemorySlot", + "url": "/api/qiskit/0.32/qiskit.pulse.MemorySlot" + }, + { + "title": "num_qubits", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.num_qubits" + }, + { + "title": "pad", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.pad" + }, + { + "title": "pad", + "url": "/api/qiskit/0.32/qiskit.pulse.transforms.pad" + }, + { + "title": "phase_offset", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.phase_offset" + }, + { + "title": "Play", + "url": "/api/qiskit/0.32/qiskit.pulse.Play" + }, + { + "title": "play", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.play" + }, + { + "title": "Play", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Play" + }, + { + "title": "PulseError", + "url": "/api/qiskit/0.32/qiskit.pulse.PulseError" + }, + { + "title": "qubit_channels", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.qubit_channels" + }, + { + "title": "RegisterSlot", + "url": "/api/qiskit/0.32/qiskit.pulse.RegisterSlot" + }, + { + "title": "samples_to_seconds", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.samples_to_seconds" + }, + { + "title": "Schedule", + "url": "/api/qiskit/0.32/qiskit.pulse.Schedule" + }, + { + "title": "ScheduleBlock", + "url": "/api/qiskit/0.32/qiskit.pulse.ScheduleBlock" + }, + { + "title": "seconds_to_samples", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.seconds_to_samples" + }, + { + "title": "set_frequency", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.set_frequency" + }, + { + "title": "set_phase", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.set_phase" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.32/qiskit.pulse.SetFrequency" + }, + { + "title": "SetFrequency", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.32/qiskit.pulse.SetPhase" + }, + { + "title": "SetPhase", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase" + }, + { + "title": "shift_frequency", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.shift_frequency" + }, + { + "title": "shift_phase", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.shift_phase" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.32/qiskit.pulse.ShiftFrequency" + }, + { + "title": "ShiftFrequency", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.32/qiskit.pulse.ShiftPhase" + }, + { + "title": "ShiftPhase", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.32/qiskit.pulse.Snapshot" + }, + { + "title": "snapshot", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.snapshot" + }, + { + "title": "Snapshot", + "url": "/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot" + }, + { + "title": "transpiler_settings", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.transpiler_settings" + }, + { + "title": "u1", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.u1" + }, + { + "title": "u2", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.u2" + }, + { + "title": "u3", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.u3" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.32/qiskit.pulse.Waveform" + }, + { + "title": "Waveform", + "url": "/api/qiskit/0.32/qiskit.pulse.library.Waveform" + }, + { + "title": "x", + "url": "/api/qiskit/0.32/qiskit.pulse.builder.x" + } + ] + }, + { + "title": "qiskit.qasm", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qasm" + }, + { + "title": "OpenQASMLexer", + "url": "/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer" + }, + { + "title": "Qasm", + "url": "/api/qiskit/0.32/qiskit.qasm.Qasm" + }, + { + "title": "QasmError", + "url": "/api/qiskit/0.32/qiskit.qasm.QasmError" + }, + { + "title": "QasmHTMLStyle", + "url": "/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle" + }, + { + "title": "QasmTerminalStyle", + "url": "/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle" + } + ] + }, + { + "title": "qiskit.qobj", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/qobj" + }, + { + "title": "GateCalibration", + "url": "/api/qiskit/0.32/qiskit.qobj.GateCalibration" + }, + { + "title": "PulseLibraryItem", + "url": "/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem" + }, + { + "title": "PulseQobj", + "url": "/api/qiskit/0.32/qiskit.qobj.PulseQobj" + }, + { + "title": "PulseQobjConfig", + "url": "/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig" + }, + { + "title": "PulseQobjExperiment", + "url": "/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment" + }, + { + "title": "PulseQobjExperimentConfig", + "url": "/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig" + }, + { + "title": "PulseQobjInstruction", + "url": "/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction" + }, + { + "title": "QasmExperimentCalibrations", + "url": "/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations" + }, + { + "title": "QasmQobj", + "url": "/api/qiskit/0.32/qiskit.qobj.QasmQobj" + }, + { + "title": "QasmQobjConfig", + "url": "/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig" + }, + { + "title": "QasmQobjExperiment", + "url": "/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment" + }, + { + "title": "QasmQobjExperimentConfig", + "url": "/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig" + }, + { + "title": "QasmQobjInstruction", + "url": "/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction" + }, + { + "title": "Qobj", + "url": "/api/qiskit/0.32/qiskit.qobj.Qobj" + }, + { + "title": "QobjExperimentHeader", + "url": "/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader" + }, + { + "title": "QobjHeader", + "url": "/api/qiskit/0.32/qiskit.qobj.QobjHeader" + }, + { + "title": "QobjMeasurementOption", + "url": "/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption" + } + ] + }, + { + "title": "qiskit.quantum_info", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/quantum_info" + }, + { + "title": "average_gate_fidelity", + "url": "/api/qiskit/0.32/qiskit.quantum_info.average_gate_fidelity" + }, + { + "title": "Chi", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Chi" + }, + { + "title": "Choi", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Choi" + }, + { + "title": "Clifford", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Clifford" + }, + { + "title": "CNOTDihedral", + "url": "/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral" + }, + { + "title": "concurrence", + "url": "/api/qiskit/0.32/qiskit.quantum_info.concurrence" + }, + { + "title": "decompose_clifford", + "url": "/api/qiskit/0.32/qiskit.quantum_info.decompose_clifford" + }, + { + "title": "DensityMatrix", + "url": "/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix" + }, + { + "title": "diamond_norm", + "url": "/api/qiskit/0.32/qiskit.quantum_info.diamond_norm" + }, + { + "title": "entanglement_of_formation", + "url": "/api/qiskit/0.32/qiskit.quantum_info.entanglement_of_formation" + }, + { + "title": "entropy", + "url": "/api/qiskit/0.32/qiskit.quantum_info.entropy" + }, + { + "title": "gate_error", + "url": "/api/qiskit/0.32/qiskit.quantum_info.gate_error" + }, + { + "title": "hellinger_distance", + "url": "/api/qiskit/0.32/qiskit.quantum_info.hellinger_distance" + }, + { + "title": "hellinger_fidelity", + "url": "/api/qiskit/0.32/qiskit.quantum_info.hellinger_fidelity" + }, + { + "title": "Kraus", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Kraus" + }, + { + "title": "mutual_information", + "url": "/api/qiskit/0.32/qiskit.quantum_info.mutual_information" + }, + { + "title": "OneQubitEulerDecomposer", + "url": "/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer" + }, + { + "title": "Operator", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Operator" + }, + { + "title": "partial_trace", + "url": "/api/qiskit/0.32/qiskit.quantum_info.partial_trace" + }, + { + "title": "Pauli", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Pauli" + }, + { + "title": "pauli_basis", + "url": "/api/qiskit/0.32/qiskit.quantum_info.pauli_basis" + }, + { + "title": "pauli_group", + "url": "/api/qiskit/0.32/qiskit.quantum_info.pauli_group" + }, + { + "title": "PauliList", + "url": "/api/qiskit/0.32/qiskit.quantum_info.PauliList" + }, + { + "title": "PauliTable", + "url": "/api/qiskit/0.32/qiskit.quantum_info.PauliTable" + }, + { + "title": "process_fidelity", + "url": "/api/qiskit/0.32/qiskit.quantum_info.process_fidelity" + }, + { + "title": "PTM", + "url": "/api/qiskit/0.32/qiskit.quantum_info.PTM" + }, + { + "title": "purity", + "url": "/api/qiskit/0.32/qiskit.quantum_info.purity" + }, + { + "title": "Quaternion", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Quaternion" + }, + { + "title": "random_clifford", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_clifford" + }, + { + "title": "random_cnotdihedral", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_cnotdihedral" + }, + { + "title": "random_density_matrix", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_density_matrix" + }, + { + "title": "random_hermitian", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_hermitian" + }, + { + "title": "random_pauli", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_pauli" + }, + { + "title": "random_pauli_table", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_pauli_table" + }, + { + "title": "random_quantum_channel", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_quantum_channel" + }, + { + "title": "random_stabilizer_table", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_stabilizer_table" + }, + { + "title": "random_statevector", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_statevector" + }, + { + "title": "random_unitary", + "url": "/api/qiskit/0.32/qiskit.quantum_info.random_unitary" + }, + { + "title": "ScalarOp", + "url": "/api/qiskit/0.32/qiskit.quantum_info.ScalarOp" + }, + { + "title": "shannon_entropy", + "url": "/api/qiskit/0.32/qiskit.quantum_info.shannon_entropy" + }, + { + "title": "SparsePauliOp", + "url": "/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp" + }, + { + "title": "StabilizerState", + "url": "/api/qiskit/0.32/qiskit.quantum_info.StabilizerState" + }, + { + "title": "StabilizerTable", + "url": "/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable" + }, + { + "title": "state_fidelity", + "url": "/api/qiskit/0.32/qiskit.quantum_info.state_fidelity" + }, + { + "title": "Statevector", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Statevector" + }, + { + "title": "Stinespring", + "url": "/api/qiskit/0.32/qiskit.quantum_info.Stinespring" + }, + { + "title": "SuperOp", + "url": "/api/qiskit/0.32/qiskit.quantum_info.SuperOp" + }, + { + "title": "TwoQubitBasisDecomposer", + "url": "/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer" + } + ] + }, + { + "title": "qiskit.result", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/result" + }, + { + "title": "Counts", + "url": "/api/qiskit/0.32/qiskit.result.Counts" + }, + { + "title": "marginal_counts", + "url": "/api/qiskit/0.32/qiskit.result.marginal_counts" + }, + { + "title": "ProbDistribution", + "url": "/api/qiskit/0.32/qiskit.result.ProbDistribution" + }, + { + "title": "QuasiDistribution", + "url": "/api/qiskit/0.32/qiskit.result.QuasiDistribution" + }, + { + "title": "Result", + "url": "/api/qiskit/0.32/qiskit.result.Result" + }, + { + "title": "ResultError", + "url": "/api/qiskit/0.32/qiskit.result.ResultError" + } + ] + }, + { + "title": "qiskit.scheduler", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/scheduler" + }, + { + "title": "ScheduleConfig", + "url": "/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig" + } + ] + }, + { + "title": "qiskit.tools", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/tools" + }, + { + "title": "backend_monitor", + "url": "/api/qiskit/0.32/qiskit.tools.backend_monitor" + }, + { + "title": "backend_overview", + "url": "/api/qiskit/0.32/qiskit.tools.backend_overview" + }, + { + "title": "job_monitor", + "url": "/api/qiskit/0.32/qiskit.tools.job_monitor" + }, + { + "title": "parallel_map", + "url": "/api/qiskit/0.32/qiskit.tools.parallel_map" + }, + { + "title": "qiskit.tools.jupyter", + "url": "/api/qiskit/0.32/tools_jupyter" + } + ] + }, + { + "title": "qiskit.transpiler", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/transpiler" + }, + { + "title": "AnalysisPass", + "url": "/api/qiskit/0.32/qiskit.transpiler.AnalysisPass" + }, + { + "title": "CouplingMap", + "url": "/api/qiskit/0.32/qiskit.transpiler.CouplingMap" + }, + { + "title": "FencedDAGCircuit", + "url": "/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit" + }, + { + "title": "FencedPropertySet", + "url": "/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet" + }, + { + "title": "FlowController", + "url": "/api/qiskit/0.32/qiskit.transpiler.FlowController" + }, + { + "title": "InstructionDurations", + "url": "/api/qiskit/0.32/qiskit.transpiler.InstructionDurations" + }, + { + "title": "Layout", + "url": "/api/qiskit/0.32/qiskit.transpiler.Layout" + }, + { + "title": "PassManager", + "url": "/api/qiskit/0.32/qiskit.transpiler.PassManager" + }, + { + "title": "PassManagerConfig", + "url": "/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig" + }, + { + "title": "PropertySet", + "url": "/api/qiskit/0.32/qiskit.transpiler.PropertySet" + }, + { + "title": "TransformationPass", + "url": "/api/qiskit/0.32/qiskit.transpiler.TransformationPass" + }, + { + "title": "TranspilerAccessError", + "url": "/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError" + }, + { + "title": "TranspilerError", + "url": "/api/qiskit/0.32/qiskit.transpiler.TranspilerError" + }, + { + "title": "qiskit.transpiler.passes", + "children": [ + { + "title": "Overview", + "url": "/api/qiskit/0.32/transpiler_passes" + }, + { + "title": "ALAPSchedule", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule" + }, + { + "title": "AlignMeasures", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures" + }, + { + "title": "ApplyLayout", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout" + }, + { + "title": "ASAPSchedule", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule" + }, + { + "title": "BarrierBeforeFinalMeasurements", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements" + }, + { + "title": "BasicSwap", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap" + }, + { + "title": "BasisTranslator", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator" + }, + { + "title": "BIPMapping", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping" + }, + { + "title": "CheckCXDirection", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection" + }, + { + "title": "CheckGateDirection", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection" + }, + { + "title": "CheckMap", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap" + }, + { + "title": "Collect2qBlocks", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks" + }, + { + "title": "CommutationAnalysis", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis" + }, + { + "title": "CommutativeCancellation", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation" + }, + { + "title": "ConsolidateBlocks", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks" + }, + { + "title": "CountOps", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CountOps" + }, + { + "title": "CountOpsLongestPath", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath" + }, + { + "title": "CrosstalkAdaptiveSchedule", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule" + }, + { + "title": "CSPLayout", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout" + }, + { + "title": "CXCancellation", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation" + }, + { + "title": "CXDirection", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection" + }, + { + "title": "DAGFixedPoint", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint" + }, + { + "title": "DAGLongestPath", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath" + }, + { + "title": "Decompose", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Decompose" + }, + { + "title": "DenseLayout", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout" + }, + { + "title": "Depth", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Depth" + }, + { + "title": "DynamicalDecoupling", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling" + }, + { + "title": "EnlargeWithAncilla", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla" + }, + { + "title": "FixedPoint", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint" + }, + { + "title": "FullAncillaAllocation", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation" + }, + { + "title": "GateDirection", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection" + }, + { + "title": "Layout2qDistance", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance" + }, + { + "title": "LookaheadSwap", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap" + }, + { + "title": "MergeAdjacentBarriers", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers" + }, + { + "title": "NoiseAdaptiveLayout", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout" + }, + { + "title": "NumTensorFactors", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors" + }, + { + "title": "Optimize1qGates", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates" + }, + { + "title": "Optimize1qGatesDecomposition", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition" + }, + { + "title": "RemoveBarriers", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers" + }, + { + "title": "RemoveDiagonalGatesBeforeMeasure", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure" + }, + { + "title": "RemoveFinalMeasurements", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements" + }, + { + "title": "RemoveResetInZeroState", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState" + }, + { + "title": "RZXCalibrationBuilder", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder" + }, + { + "title": "RZXCalibrationBuilderNoEcho", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho" + }, + { + "title": "SabreLayout", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout" + }, + { + "title": "SabreSwap", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap" + }, + { + "title": "SetLayout", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout" + }, + { + "title": "Size", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Size" + }, + { + "title": "StochasticSwap", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap" }, { - "title": "qiskit.chemistry.algorithms.pes_samplers", - "url": "/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers" - } - ] - }, - { - "title": "qiskit.chemistry.components", - "children": [ + "title": "TemplateOptimization", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.chemistry.components" + "title": "TimeUnitConversion", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion" }, { - "title": "qiskit.chemistry.components.bosonic_bases", - "url": "/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases" + "title": "TrivialLayout", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout" }, { - "title": "qiskit.chemistry.components.initial_states", - "url": "/api/qiskit/0.32/qiskit.chemistry.components.initial_states" + "title": "UnitarySynthesis", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis" }, { - "title": "qiskit.chemistry.components.variational_forms", - "url": "/api/qiskit/0.32/qiskit.chemistry.components.variational_forms" + "title": "Unroll3qOrMore", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore" + }, + { + "title": "UnrollCustomDefinitions", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions" + }, + { + "title": "Unroller", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Unroller" + }, + { + "title": "ValidatePulseGates", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates" + }, + { + "title": "Width", + "url": "/api/qiskit/0.32/qiskit.transpiler.passes.Width" } ] }, { - "title": "qiskit.chemistry.drivers", + "title": "qiskit.transpiler.preset_passmanagers", "children": [ { "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.chemistry.drivers" + "url": "/api/qiskit/0.32/transpiler_preset" }, { - "title": "qiskit.chemistry.drivers.gaussiand", - "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.gaussiand" + "title": "level_0_pass_manager", + "url": "/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_0_pass_manager" }, { - "title": "qiskit.chemistry.drivers.psi4d", - "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.psi4d" + "title": "level_1_pass_manager", + "url": "/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_1_pass_manager" }, { - "title": "qiskit.chemistry.drivers.pyquanted", - "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.pyquanted" + "title": "level_2_pass_manager", + "url": "/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_2_pass_manager" }, { - "title": "qiskit.chemistry.drivers.pyscfd", - "url": "/api/qiskit/0.32/qiskit.chemistry.drivers.pyscfd" + "title": "level_3_pass_manager", + "url": "/api/qiskit/0.32/qiskit.transpiler.preset_passmanagers.level_3_pass_manager" } ] } ] }, { - "title": "qiskit.circuit", + "title": "qiskit.utils", "children": [ { "title": "Overview", - "url": "/api/qiskit/0.32/circuit" + "url": "/api/qiskit/0.32/utils" }, { - "title": "qiskit.circuit.classicalfunction", - "url": "/api/qiskit/0.32/classicalfunction" + "title": "apply_prefix", + "url": "/api/qiskit/0.32/qiskit.utils.apply_prefix" }, { - "title": "qiskit.circuit.qpy_serialization", - "url": "/api/qiskit/0.32/qpy" - } - ] - }, - { - "title": "qiskit.compiler", - "url": "/api/qiskit/0.32/compiler" - }, - { - "title": "qiskit.converters", - "url": "/api/qiskit/0.32/converters" - }, - { - "title": "qiskit.dagcircuit", - "url": "/api/qiskit/0.32/dagcircuit" - }, - { - "title": "qiskit.execute_function", - "url": "/api/qiskit/0.32/execute" - }, - { - "title": "qiskit.extensions", - "url": "/api/qiskit/0.32/extensions" - }, - { - "title": "qiskit.finance", - "children": [ + "title": "deprecate_arguments", + "url": "/api/qiskit/0.32/qiskit.utils.deprecate_arguments" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit_finance" + "title": "deprecate_function", + "url": "/api/qiskit/0.32/qiskit.utils.deprecate_function" }, { - "title": "qiskit.finance.data_providers", - "url": "/api/qiskit/0.32/qiskit.finance.data_providers" + "title": "get_entangler_map", + "url": "/api/qiskit/0.32/qiskit.utils.get_entangler_map" }, { - "title": "qiskit.finance.applications", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.finance.applications" - }, - { - "title": "qiskit.finance.applications.ising", - "url": "/api/qiskit/0.32/qiskit.finance.applications.ising" - } - ] + "title": "has_aer", + "url": "/api/qiskit/0.32/qiskit.utils.has_aer" }, { - "title": "qiskit.finance.components", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.finance.components" - }, - { - "title": "qiskit.finance.components.uncertainty_problems", - "url": "/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems" - } - ] - } - ] - }, - { - "title": "qiskit.ignis", - "children": [ + "title": "has_ibmq", + "url": "/api/qiskit/0.32/qiskit.utils.has_ibmq" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/ignis" + "title": "is_main_process", + "url": "/api/qiskit/0.32/qiskit.utils.is_main_process" }, { - "title": "qiskit.ignis.characterization", - "url": "/api/qiskit/0.32/characterization" + "title": "local_hardware_info", + "url": "/api/qiskit/0.32/qiskit.utils.local_hardware_info" }, { - "title": "qiskit.ignis.logging", - "url": "/api/qiskit/0.32/logging" + "title": "name_args", + "url": "/api/qiskit/0.32/qiskit.utils.name_args" }, { - "title": "qiskit.ignis.measurement", - "url": "/api/qiskit/0.32/measurement" + "title": "QuantumInstance", + "url": "/api/qiskit/0.32/qiskit.utils.QuantumInstance" }, { - "title": "qiskit.ignis.mitigation", - "url": "/api/qiskit/0.32/mitigation" + "title": "summarize_circuits", + "url": "/api/qiskit/0.32/qiskit.utils.summarize_circuits" }, { - "title": "qiskit.ignis.verification", - "url": "/api/qiskit/0.32/verification" + "title": "validate_entangler_map", + "url": "/api/qiskit/0.32/qiskit.utils.validate_entangler_map" } ] }, { - "title": "qiskit.ml", + "title": "qiskit.validation", "children": [ { "title": "Overview", - "url": "/api/qiskit/0.32/qiskit_ml" + "url": "/api/qiskit/0.32/validation" }, { - "title": "qiskit.ml.circuit.library", - "url": "/api/qiskit/0.32/qiskit.ml.circuit.library" + "title": "SchemaValidationError", + "url": "/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError" }, { - "title": "qiskit.ml.datasets", - "url": "/api/qiskit/0.32/qiskit.ml.datasets" + "title": "validate_json_against_schema", + "url": "/api/qiskit/0.32/qiskit.validation.jsonschema.validate_json_against_schema" } ] }, { - "title": "qiskit.opflow", - "url": "/api/qiskit/0.32/opflow" - }, - { - "title": "qiskit.optimization", + "title": "qiskit.visualization", "children": [ { "title": "Overview", - "url": "/api/qiskit/0.32/qiskit_optimization" + "url": "/api/qiskit/0.32/visualization" }, { - "title": "qiskit.optimization.algorithms", - "url": "/api/qiskit/0.32/qiskit.optimization.algorithms" + "title": "array_to_latex", + "url": "/api/qiskit/0.32/qiskit.visualization.array_to_latex" }, { - "title": "qiskit.optimization.converters", - "url": "/api/qiskit/0.32/qiskit.optimization.converters" + "title": "circuit_drawer", + "url": "/api/qiskit/0.32/qiskit.visualization.circuit_drawer" }, { - "title": "qiskit.optimization.problems", - "url": "/api/qiskit/0.32/qiskit.optimization.problems" + "title": "dag_drawer", + "url": "/api/qiskit/0.32/qiskit.visualization.dag_drawer" }, { - "title": "qiskit.optimization.applications", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.32/qiskit.optimization.applications" - }, - { - "title": "qiskit.optimization.applications.ising", - "url": "/api/qiskit/0.32/qiskit.optimization.applications.ising" - } - ] - } - ] - }, - { - "title": "qiskit.providers", - "children": [ + "title": "DefaultStyle", + "url": "/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/providers" + "title": "draw", + "url": "/api/qiskit/0.32/qiskit.visualization.pulse_v2.draw" }, { - "title": "qiskit.providers.basicaer", - "url": "/api/qiskit/0.32/providers_basicaer" + "title": "draw", + "url": "/api/qiskit/0.32/qiskit.visualization.timeline.draw" }, { - "title": "qiskit.providers.models", - "url": "/api/qiskit/0.32/providers_models" + "title": "IQXDebugging", + "url": "/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXDebugging" }, { - "title": "qiskit.providers.aer", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.32/aer_provider" - }, - { - "title": "qiskit.providers.aer.extensions", - "url": "/api/qiskit/0.32/aer_extensions" - }, - { - "title": "qiskit.providers.aer.jobs", - "url": "/api/qiskit/0.32/aer_jobs" - }, - { - "title": "qiskit.providers.aer.library", - "url": "/api/qiskit/0.32/aer_library" - }, - { - "title": "qiskit.providers.aer.noise", - "url": "/api/qiskit/0.32/aer_noise" - }, - { - "title": "qiskit.providers.aer.pulse", - "url": "/api/qiskit/0.32/aer_pulse" - }, - { - "title": "qiskit.providers.aer.utils", - "url": "/api/qiskit/0.32/aer_utils" - } - ] + "title": "IQXSimple", + "url": "/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXSimple" }, { - "title": "qiskit.providers.ibmq", - "children": [ - { - "title": "Overview", - "url": "/api/qiskit/0.32/ibmq_provider" - }, - { - "title": "qiskit.providers.ibmq.credentials", - "url": "/api/qiskit/0.32/ibmq_credentials" - }, - { - "title": "qiskit.providers.ibmq.experiment", - "url": "/api/qiskit/0.32/ibmq_experiment" - }, - { - "title": "qiskit.providers.ibmq.job", - "url": "/api/qiskit/0.32/ibmq_job" - }, - { - "title": "qiskit.providers.ibmq.managed", - "url": "/api/qiskit/0.32/ibmq_managed" - }, - { - "title": "qiskit.providers.ibmq.random", - "url": "/api/qiskit/0.32/ibmq_random" - }, - { - "title": "qiskit.providers.ibmq.runtime", - "url": "/api/qiskit/0.32/ibmq_runtime" - }, - { - "title": "qiskit.providers.ibmq.utils", - "url": "/api/qiskit/0.32/ibmq_utils" - } - ] - } - ] - }, - { - "title": "qiskit.pulse", - "url": "/api/qiskit/0.32/pulse" - }, - { - "title": "qiskit.qasm", - "url": "/api/qiskit/0.32/qasm" - }, - { - "title": "qiskit.qobj", - "url": "/api/qiskit/0.32/qobj" - }, - { - "title": "qiskit.quantum_info", - "url": "/api/qiskit/0.32/quantum_info" - }, - { - "title": "qiskit.result", - "url": "/api/qiskit/0.32/result" - }, - { - "title": "qiskit.scheduler", - "url": "/api/qiskit/0.32/scheduler" - }, - { - "title": "qiskit.tools", - "children": [ + "title": "IQXStandard", + "url": "/api/qiskit/0.32/qiskit.visualization.pulse_v2.IQXStandard" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/tools" + "title": "pass_manager_drawer", + "url": "/api/qiskit/0.32/qiskit.visualization.pass_manager_drawer" }, { - "title": "qiskit.tools.jupyter", - "url": "/api/qiskit/0.32/tools_jupyter" - } - ] - }, - { - "title": "qiskit.transpiler", - "children": [ + "title": "plot_bloch_multivector", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_bloch_multivector" + }, { - "title": "Overview", - "url": "/api/qiskit/0.32/transpiler" + "title": "plot_bloch_vector", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_bloch_vector" }, { - "title": "qiskit.transpiler.passes", - "url": "/api/qiskit/0.32/transpiler_passes" + "title": "plot_circuit_layout", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_circuit_layout" }, { - "title": "qiskit.transpiler.preset_passmanagers", - "url": "/api/qiskit/0.32/transpiler_preset" + "title": "plot_error_map", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_error_map" + }, + { + "title": "plot_gate_map", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_gate_map" + }, + { + "title": "plot_histogram", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_histogram" + }, + { + "title": "plot_state_city", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_state_city" + }, + { + "title": "plot_state_hinton", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_state_hinton" + }, + { + "title": "plot_state_paulivec", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_state_paulivec" + }, + { + "title": "plot_state_qsphere", + "url": "/api/qiskit/0.32/qiskit.visualization.plot_state_qsphere" + }, + { + "title": "timeline_drawer", + "url": "/api/qiskit/0.32/qiskit.visualization.timeline_drawer" + }, + { + "title": "VisualizationError", + "url": "/api/qiskit/0.32/qiskit.visualization.VisualizationError" + }, + { + "title": "visualize_transition", + "url": "/api/qiskit/0.32/qiskit.visualization.visualize_transition" } ] }, - { - "title": "qiskit.utils", - "url": "/api/qiskit/0.32/utils" - }, - { - "title": "qiskit.validation", - "url": "/api/qiskit/0.32/validation" - }, - { - "title": "qiskit.visualization", - "url": "/api/qiskit/0.32/visualization" - }, { "title": "Release notes", "children": [ diff --git a/docs/api/qiskit/0.32/aer_extensions.md b/docs/api/qiskit/0.32/aer_extensions.md index 1db9d691807..49429214c49 100644 --- a/docs/api/qiskit/0.32/aer_extensions.md +++ b/docs/api/qiskit/0.32/aer_extensions.md @@ -24,12 +24,12 @@ python_api_name: qiskit.providers.aer.extensions Snapshot instructions allow taking a snapshot of the current state of the simulator without effecting the outcome of the simulation. These can be used with the QasmSimulator backend to return the expectation value of an operator or the probability of measurement outcomes. -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`Snapshot`](qiskit.providers.aer.extensions.Snapshot#qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, …]) | Simulator snapshot instruction. | -| [`SnapshotProbabilities`](qiskit.providers.aer.extensions.SnapshotProbabilities#qiskit.providers.aer.extensions.SnapshotProbabilities "qiskit.providers.aer.extensions.SnapshotProbabilities")(label, num\_qubits\[, …]) | Snapshot instruction for all methods of Qasm simulator. | -| [`SnapshotExpectationValue`](qiskit.providers.aer.extensions.SnapshotExpectationValue#qiskit.providers.aer.extensions.SnapshotExpectationValue "qiskit.providers.aer.extensions.SnapshotExpectationValue")(label, op\[, …]) | Snapshot instruction for supported methods of Qasm simulator. | -| [`SnapshotStatevector`](qiskit.providers.aer.extensions.SnapshotStatevector#qiskit.providers.aer.extensions.SnapshotStatevector "qiskit.providers.aer.extensions.SnapshotStatevector")(label\[, num\_qubits]) | Snapshot instruction for statevector snapshot type | -| [`SnapshotDensityMatrix`](qiskit.providers.aer.extensions.SnapshotDensityMatrix#qiskit.providers.aer.extensions.SnapshotDensityMatrix "qiskit.providers.aer.extensions.SnapshotDensityMatrix")(label, num\_qubits) | Snapshot instruction for density matrix method of Qasm simulator. | -| [`SnapshotStabilizer`](qiskit.providers.aer.extensions.SnapshotStabilizer#qiskit.providers.aer.extensions.SnapshotStabilizer "qiskit.providers.aer.extensions.SnapshotStabilizer")(label\[, num\_qubits]) | Snapshot instruction for stabilizer method of Qasm simulator. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- | +| [`Snapshot`](qiskit.providers.aer.extensions.Snapshot "qiskit.providers.aer.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, …]) | Simulator snapshot instruction. | +| [`SnapshotProbabilities`](qiskit.providers.aer.extensions.SnapshotProbabilities "qiskit.providers.aer.extensions.SnapshotProbabilities")(label, num\_qubits\[, …]) | Snapshot instruction for all methods of Qasm simulator. | +| [`SnapshotExpectationValue`](qiskit.providers.aer.extensions.SnapshotExpectationValue "qiskit.providers.aer.extensions.SnapshotExpectationValue")(label, op\[, …]) | Snapshot instruction for supported methods of Qasm simulator. | +| [`SnapshotStatevector`](qiskit.providers.aer.extensions.SnapshotStatevector "qiskit.providers.aer.extensions.SnapshotStatevector")(label\[, num\_qubits]) | Snapshot instruction for statevector snapshot type | +| [`SnapshotDensityMatrix`](qiskit.providers.aer.extensions.SnapshotDensityMatrix "qiskit.providers.aer.extensions.SnapshotDensityMatrix")(label, num\_qubits) | Snapshot instruction for density matrix method of Qasm simulator. | +| [`SnapshotStabilizer`](qiskit.providers.aer.extensions.SnapshotStabilizer "qiskit.providers.aer.extensions.SnapshotStabilizer")(label\[, num\_qubits]) | Snapshot instruction for stabilizer method of Qasm simulator. | diff --git a/docs/api/qiskit/0.32/aer_jobs.md b/docs/api/qiskit/0.32/aer_jobs.md index 88186c2f4c4..6ac5e10d9f7 100644 --- a/docs/api/qiskit/0.32/aer_jobs.md +++ b/docs/api/qiskit/0.32/aer_jobs.md @@ -20,8 +20,8 @@ This module contains classes and functions to manage Aer jobs. The following are the classes used to manage job submissions. -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`AerJob`](qiskit.providers.aer.jobs.AerJob#qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob")(backend, job\_id, fn, qobj\[, executor]) | AerJob class for Qiskit Aer Simulators. | -| [`AerJobSet`](qiskit.providers.aer.jobs.AerJobSet#qiskit.providers.aer.jobs.AerJobSet "qiskit.providers.aer.jobs.AerJobSet")(backend, job\_id, fn, experiments) | A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob#qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. | +| | | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob")(backend, job\_id, fn, qobj\[, executor]) | AerJob class for Qiskit Aer Simulators. | +| [`AerJobSet`](qiskit.providers.aer.jobs.AerJobSet "qiskit.providers.aer.jobs.AerJobSet")(backend, job\_id, fn, experiments) | A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. | diff --git a/docs/api/qiskit/0.32/aer_library.md b/docs/api/qiskit/0.32/aer_library.md index 36175f7e45b..9342dbe709b 100644 --- a/docs/api/qiskit/0.32/aer_library.md +++ b/docs/api/qiskit/0.32/aer_library.md @@ -16,7 +16,7 @@ python_api_name: qiskit.providers.aer.library `qiskit.providers.aer.library` -This library contains custom qiskit `QuantumCircuit` [`Instruction`](qiskit.circuit.Instruction#qiskit.circuit.Instruction "qiskit.circuit.Instruction") subclasses that can be used with the Aer circuit simulator backends. +This library contains custom qiskit `QuantumCircuit` [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") subclasses that can be used with the Aer circuit simulator backends. ## Setting a Custom Simulator State @@ -24,51 +24,51 @@ The following instruction classes can be used to set the specific simulator meth ### Instruction Classes -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`SetStatevector`](qiskit.providers.aer.library.SetStatevector#qiskit.providers.aer.library.SetStatevector "qiskit.providers.aer.library.SetStatevector")(state) | Set the statevector state of the simulator | -| [`SetDensityMatrix`](qiskit.providers.aer.library.SetDensityMatrix#qiskit.providers.aer.library.SetDensityMatrix "qiskit.providers.aer.library.SetDensityMatrix")(state) | Set density matrix state of the simulator | -| [`SetStabilizer`](qiskit.providers.aer.library.SetStabilizer#qiskit.providers.aer.library.SetStabilizer "qiskit.providers.aer.library.SetStabilizer")(state) | Set the Clifford stabilizer state of the simulator | -| [`SetSuperOp`](qiskit.providers.aer.library.SetSuperOp#qiskit.providers.aer.library.SetSuperOp "qiskit.providers.aer.library.SetSuperOp")(state) | Set superop state of the simulator | -| [`SetUnitary`](qiskit.providers.aer.library.SetUnitary#qiskit.providers.aer.library.SetUnitary "qiskit.providers.aer.library.SetUnitary")(state) | Set unitary state of the simulator | -| [`SetMatrixProductState`](qiskit.providers.aer.library.SetMatrixProductState#qiskit.providers.aer.library.SetMatrixProductState "qiskit.providers.aer.library.SetMatrixProductState")(state) | Set the matrix product state of the simulator | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | +| [`SetStatevector`](qiskit.providers.aer.library.SetStatevector "qiskit.providers.aer.library.SetStatevector")(state) | Set the statevector state of the simulator | +| [`SetDensityMatrix`](qiskit.providers.aer.library.SetDensityMatrix "qiskit.providers.aer.library.SetDensityMatrix")(state) | Set density matrix state of the simulator | +| [`SetStabilizer`](qiskit.providers.aer.library.SetStabilizer "qiskit.providers.aer.library.SetStabilizer")(state) | Set the Clifford stabilizer state of the simulator | +| [`SetSuperOp`](qiskit.providers.aer.library.SetSuperOp "qiskit.providers.aer.library.SetSuperOp")(state) | Set superop state of the simulator | +| [`SetUnitary`](qiskit.providers.aer.library.SetUnitary "qiskit.providers.aer.library.SetUnitary")(state) | Set unitary state of the simulator | +| [`SetMatrixProductState`](qiskit.providers.aer.library.SetMatrixProductState "qiskit.providers.aer.library.SetMatrixProductState")(state) | Set the matrix product state of the simulator | ### QuantumCircuit Methods The set instructions can also be added to circuits by using the following `QuantumCircuit` methods which are patched when importing Aer. -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`set_statevector`](qiskit.providers.aer.library.set_statevector#qiskit.providers.aer.library.set_statevector "qiskit.providers.aer.library.set_statevector")(self, state) | Set the statevector state of the simulator. | -| [`set_density_matrix`](qiskit.providers.aer.library.set_density_matrix#qiskit.providers.aer.library.set_density_matrix "qiskit.providers.aer.library.set_density_matrix")(self, state) | Set the density matrix state of the simulator. | -| [`set_stabilizer`](qiskit.providers.aer.library.set_stabilizer#qiskit.providers.aer.library.set_stabilizer "qiskit.providers.aer.library.set_stabilizer")(self, state) | Set the Clifford stabilizer state of the simulator. | -| [`set_unitary`](qiskit.providers.aer.library.set_unitary#qiskit.providers.aer.library.set_unitary "qiskit.providers.aer.library.set_unitary")(self, state) | Set the state state of the simulator. | -| [`set_superop`](qiskit.providers.aer.library.set_superop#qiskit.providers.aer.library.set_superop "qiskit.providers.aer.library.set_superop")(self, state) | Set the superop state of the simulator. | -| [`set_matrix_product_state`](qiskit.providers.aer.library.set_matrix_product_state#qiskit.providers.aer.library.set_matrix_product_state "qiskit.providers.aer.library.set_matrix_product_state")(self, state) | Set the matrix product state of the simulator. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| [`set_statevector`](qiskit.providers.aer.library.set_statevector "qiskit.providers.aer.library.set_statevector")(self, state) | Set the statevector state of the simulator. | +| [`set_density_matrix`](qiskit.providers.aer.library.set_density_matrix "qiskit.providers.aer.library.set_density_matrix")(self, state) | Set the density matrix state of the simulator. | +| [`set_stabilizer`](qiskit.providers.aer.library.set_stabilizer "qiskit.providers.aer.library.set_stabilizer")(self, state) | Set the Clifford stabilizer state of the simulator. | +| [`set_unitary`](qiskit.providers.aer.library.set_unitary "qiskit.providers.aer.library.set_unitary")(self, state) | Set the state state of the simulator. | +| [`set_superop`](qiskit.providers.aer.library.set_superop "qiskit.providers.aer.library.set_superop")(self, state) | Set the superop state of the simulator. | +| [`set_matrix_product_state`](qiskit.providers.aer.library.set_matrix_product_state "qiskit.providers.aer.library.set_matrix_product_state")(self, state) | Set the matrix product state of the simulator. | ## Saving Simulator Data ### Simulator State Save Instruction Classes -The following instructions can be used to save the state of the simulator into the returned result object. The [`SaveState`](qiskit.providers.aer.library.SaveState#qiskit.providers.aer.library.SaveState "qiskit.providers.aer.library.SaveState") instruction will automatically select the format based on the simulation method (eg. [`SaveStatevector`](qiskit.providers.aer.library.SaveStatevector#qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector") for statevector method, [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix#qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") for density matrix method etc.). +The following instructions can be used to save the state of the simulator into the returned result object. The [`SaveState`](qiskit.providers.aer.library.SaveState "qiskit.providers.aer.library.SaveState") instruction will automatically select the format based on the simulation method (eg. [`SaveStatevector`](qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector") for statevector method, [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") for density matrix method etc.). -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`SaveState`](qiskit.providers.aer.library.SaveState#qiskit.providers.aer.library.SaveState "qiskit.providers.aer.library.SaveState")(num\_qubits\[, label, pershot, …]) | Save simulator state | -| [`SaveStatevector`](qiskit.providers.aer.library.SaveStatevector#qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector")(num\_qubits\[, label, …]) | Save statevector | -| [`SaveStatevectorDict`](qiskit.providers.aer.library.SaveStatevectorDict#qiskit.providers.aer.library.SaveStatevectorDict "qiskit.providers.aer.library.SaveStatevectorDict")(num\_qubits\[, label, …]) | Save statevector as ket-form dictionary. | -| [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix#qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix")(num\_qubits\[, label, …]) | Save a reduced density matrix. | -| [`SaveMatrixProductState`](qiskit.providers.aer.library.SaveMatrixProductState#qiskit.providers.aer.library.SaveMatrixProductState "qiskit.providers.aer.library.SaveMatrixProductState")(num\_qubits\[, label, …]) | Save matrix product state instruction | -| [`SaveStabilizer`](qiskit.providers.aer.library.SaveStabilizer#qiskit.providers.aer.library.SaveStabilizer "qiskit.providers.aer.library.SaveStabilizer")(num\_qubits\[, label, pershot, …]) | Save Stabilizer instruction | -| [`SaveSuperOp`](qiskit.providers.aer.library.SaveSuperOp#qiskit.providers.aer.library.SaveSuperOp "qiskit.providers.aer.library.SaveSuperOp")(num\_qubits\[, label, pershot]) | Save a SuperOp matrix. | -| [`SaveUnitary`](qiskit.providers.aer.library.SaveUnitary#qiskit.providers.aer.library.SaveUnitary "qiskit.providers.aer.library.SaveUnitary")(num\_qubits\[, label, pershot]) | Save Unitary | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| [`SaveState`](qiskit.providers.aer.library.SaveState "qiskit.providers.aer.library.SaveState")(num\_qubits\[, label, pershot, …]) | Save simulator state | +| [`SaveStatevector`](qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector")(num\_qubits\[, label, …]) | Save statevector | +| [`SaveStatevectorDict`](qiskit.providers.aer.library.SaveStatevectorDict "qiskit.providers.aer.library.SaveStatevectorDict")(num\_qubits\[, label, …]) | Save statevector as ket-form dictionary. | +| [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix")(num\_qubits\[, label, …]) | Save a reduced density matrix. | +| [`SaveMatrixProductState`](qiskit.providers.aer.library.SaveMatrixProductState "qiskit.providers.aer.library.SaveMatrixProductState")(num\_qubits\[, label, …]) | Save matrix product state instruction | +| [`SaveStabilizer`](qiskit.providers.aer.library.SaveStabilizer "qiskit.providers.aer.library.SaveStabilizer")(num\_qubits\[, label, pershot, …]) | Save Stabilizer instruction | +| [`SaveSuperOp`](qiskit.providers.aer.library.SaveSuperOp "qiskit.providers.aer.library.SaveSuperOp")(num\_qubits\[, label, pershot]) | Save a SuperOp matrix. | +| [`SaveUnitary`](qiskit.providers.aer.library.SaveUnitary "qiskit.providers.aer.library.SaveUnitary")(num\_qubits\[, label, pershot]) | Save Unitary | - The [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix#qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") instruction can be used to save the reduced densit matrix of a subset of qubits for supported simulation methods, however all other save state instructions must be applied to all qubits in a run circuit. + The [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") instruction can be used to save the reduced densit matrix of a subset of qubits for supported simulation methods, however all other save state instructions must be applied to all qubits in a run circuit. - The [`StatevectorSimulator`](qiskit.providers.aer.StatevectorSimulator#qiskit.providers.aer.StatevectorSimulator "qiskit.providers.aer.StatevectorSimulator") (and [`UnitarySimulator`](qiskit.providers.aer.UnitarySimulator#qiskit.providers.aer.UnitarySimulator "qiskit.providers.aer.UnitarySimulator")) backend automatically append every run circuit with the a ``SaveStatevector`()`` (``SaveUnitary`()``) instruction using the default label. Hence adding any additional save instructions of that type will require specifying a custom label for those instructions. + The [`StatevectorSimulator`](qiskit.providers.aer.StatevectorSimulator "qiskit.providers.aer.StatevectorSimulator") (and [`UnitarySimulator`](qiskit.providers.aer.UnitarySimulator "qiskit.providers.aer.UnitarySimulator")) backend automatically append every run circuit with the a ``SaveStatevector`()`` (``SaveUnitary`()``) instruction using the default label. Hence adding any additional save instructions of that type will require specifying a custom label for those instructions. ### Simulator Derived Data Save Instruction Classes @@ -77,14 +77,14 @@ The following classes can be used to directly save data derived from the simulat For convenience the save instructions can be accessed using custom `QuantumCircuit` methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| [`SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue#qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue")(operator\[, label, …]) | Save expectation value of an operator. | -| [`SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance#qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance")(operator\[, …]) | Save expectation value and variance of an operator. | -| [`SaveProbabilities`](qiskit.providers.aer.library.SaveProbabilities#qiskit.providers.aer.library.SaveProbabilities "qiskit.providers.aer.library.SaveProbabilities")(num\_qubits\[, label, …]) | Save measurement outcome probabilities vector. | -| [`SaveProbabilitiesDict`](qiskit.providers.aer.library.SaveProbabilitiesDict#qiskit.providers.aer.library.SaveProbabilitiesDict "qiskit.providers.aer.library.SaveProbabilitiesDict")(num\_qubits\[, label, …]) | Save measurement outcome probabilities dict. | -| [`SaveAmplitudes`](qiskit.providers.aer.library.SaveAmplitudes#qiskit.providers.aer.library.SaveAmplitudes "qiskit.providers.aer.library.SaveAmplitudes")(num\_qubits, params\[, label, …]) | Save complex statevector amplitudes. | -| [`SaveAmplitudesSquared`](qiskit.providers.aer.library.SaveAmplitudesSquared#qiskit.providers.aer.library.SaveAmplitudesSquared "qiskit.providers.aer.library.SaveAmplitudesSquared")(num\_qubits, params\[, …]) | Save squared statevector amplitudes (probabilities). | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| [`SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue")(operator\[, label, …]) | Save expectation value of an operator. | +| [`SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance")(operator\[, …]) | Save expectation value and variance of an operator. | +| [`SaveProbabilities`](qiskit.providers.aer.library.SaveProbabilities "qiskit.providers.aer.library.SaveProbabilities")(num\_qubits\[, label, …]) | Save measurement outcome probabilities vector. | +| [`SaveProbabilitiesDict`](qiskit.providers.aer.library.SaveProbabilitiesDict "qiskit.providers.aer.library.SaveProbabilitiesDict")(num\_qubits\[, label, …]) | Save measurement outcome probabilities dict. | +| [`SaveAmplitudes`](qiskit.providers.aer.library.SaveAmplitudes "qiskit.providers.aer.library.SaveAmplitudes")(num\_qubits, params\[, label, …]) | Save complex statevector amplitudes. | +| [`SaveAmplitudesSquared`](qiskit.providers.aer.library.SaveAmplitudesSquared "qiskit.providers.aer.library.SaveAmplitudesSquared")(num\_qubits, params\[, …]) | Save squared statevector amplitudes (probabilities). | When saving pershot data by using the `pershot=True` kwarg in the above instructions, the resulting list may only contain a single value rather than the number of shots. This happens when a run circuit supports measurement sampling because it is either @@ -104,45 +104,45 @@ The save instructions can also be added to circuits by using the following `Quan Each save method has a default label for accessing from the circuit result data, however duplicate labels in results will result in an exception being raised. If you use more than 1 instance of a specific save instruction you must set a custom label for the additional instructions. -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`save_amplitudes`](qiskit.providers.aer.library.save_amplitudes#qiskit.providers.aer.library.save_amplitudes "qiskit.providers.aer.library.save_amplitudes")(self, params\[, label, …]) | Save complex statevector amplitudes. | -| [`save_amplitudes_squared`](qiskit.providers.aer.library.save_amplitudes_squared#qiskit.providers.aer.library.save_amplitudes_squared "qiskit.providers.aer.library.save_amplitudes_squared")(self, params\[, …]) | Save squared statevector amplitudes (probabilities). | -| [`save_density_matrix`](qiskit.providers.aer.library.save_density_matrix#qiskit.providers.aer.library.save_density_matrix "qiskit.providers.aer.library.save_density_matrix")(self\[, qubits, label, …]) | Save the current simulator quantum state as a density matrix. | -| [`save_expectation_value`](qiskit.providers.aer.library.save_expectation_value#qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value")(self, operator, qubits) | Save the expectation value of a Hermitian operator. | -| [`save_expectation_value_variance`](qiskit.providers.aer.library.save_expectation_value_variance#qiskit.providers.aer.library.save_expectation_value_variance "qiskit.providers.aer.library.save_expectation_value_variance")(self, …\[, …]) | Save the expectation value of a Hermitian operator. | -| [`save_matrix_product_state`](qiskit.providers.aer.library.save_matrix_product_state#qiskit.providers.aer.library.save_matrix_product_state "qiskit.providers.aer.library.save_matrix_product_state")(self\[, label, …]) | Save the current simulator quantum state as a matrix product state. | -| [`save_probabilities`](qiskit.providers.aer.library.save_probabilities#qiskit.providers.aer.library.save_probabilities "qiskit.providers.aer.library.save_probabilities")(self\[, qubits, label, …]) | Save measurement outcome probabilities vector. | -| [`save_probabilities_dict`](qiskit.providers.aer.library.save_probabilities_dict#qiskit.providers.aer.library.save_probabilities_dict "qiskit.providers.aer.library.save_probabilities_dict")(self\[, qubits, …]) | Save measurement outcome probabilities vector. | -| [`save_stabilizer`](qiskit.providers.aer.library.save_stabilizer#qiskit.providers.aer.library.save_stabilizer "qiskit.providers.aer.library.save_stabilizer")(self\[, label, pershot, …]) | Save the current stabilizer simulator quantum state as a Clifford. | -| [`save_state`](qiskit.providers.aer.library.save_state#qiskit.providers.aer.library.save_state "qiskit.providers.aer.library.save_state")(self\[, label, pershot, conditional]) | Save the current simulator quantum state. | -| [`save_statevector`](qiskit.providers.aer.library.save_statevector#qiskit.providers.aer.library.save_statevector "qiskit.providers.aer.library.save_statevector")(self\[, label, pershot, …]) | Save the current simulator quantum state as a statevector. | -| [`save_statevector_dict`](qiskit.providers.aer.library.save_statevector_dict#qiskit.providers.aer.library.save_statevector_dict "qiskit.providers.aer.library.save_statevector_dict")(self\[, label, …]) | Save the current simulator quantum state as a statevector as a dict. | -| [`save_unitary`](qiskit.providers.aer.library.save_unitary#qiskit.providers.aer.library.save_unitary "qiskit.providers.aer.library.save_unitary")(self\[, label, pershot]) | Save the current state of the unitary simulator. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| [`save_amplitudes`](qiskit.providers.aer.library.save_amplitudes "qiskit.providers.aer.library.save_amplitudes")(self, params\[, label, …]) | Save complex statevector amplitudes. | +| [`save_amplitudes_squared`](qiskit.providers.aer.library.save_amplitudes_squared "qiskit.providers.aer.library.save_amplitudes_squared")(self, params\[, …]) | Save squared statevector amplitudes (probabilities). | +| [`save_density_matrix`](qiskit.providers.aer.library.save_density_matrix "qiskit.providers.aer.library.save_density_matrix")(self\[, qubits, label, …]) | Save the current simulator quantum state as a density matrix. | +| [`save_expectation_value`](qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value")(self, operator, qubits) | Save the expectation value of a Hermitian operator. | +| [`save_expectation_value_variance`](qiskit.providers.aer.library.save_expectation_value_variance "qiskit.providers.aer.library.save_expectation_value_variance")(self, …\[, …]) | Save the expectation value of a Hermitian operator. | +| [`save_matrix_product_state`](qiskit.providers.aer.library.save_matrix_product_state "qiskit.providers.aer.library.save_matrix_product_state")(self\[, label, …]) | Save the current simulator quantum state as a matrix product state. | +| [`save_probabilities`](qiskit.providers.aer.library.save_probabilities "qiskit.providers.aer.library.save_probabilities")(self\[, qubits, label, …]) | Save measurement outcome probabilities vector. | +| [`save_probabilities_dict`](qiskit.providers.aer.library.save_probabilities_dict "qiskit.providers.aer.library.save_probabilities_dict")(self\[, qubits, …]) | Save measurement outcome probabilities vector. | +| [`save_stabilizer`](qiskit.providers.aer.library.save_stabilizer "qiskit.providers.aer.library.save_stabilizer")(self\[, label, pershot, …]) | Save the current stabilizer simulator quantum state as a Clifford. | +| [`save_state`](qiskit.providers.aer.library.save_state "qiskit.providers.aer.library.save_state")(self\[, label, pershot, conditional]) | Save the current simulator quantum state. | +| [`save_statevector`](qiskit.providers.aer.library.save_statevector "qiskit.providers.aer.library.save_statevector")(self\[, label, pershot, …]) | Save the current simulator quantum state as a statevector. | +| [`save_statevector_dict`](qiskit.providers.aer.library.save_statevector_dict "qiskit.providers.aer.library.save_statevector_dict")(self\[, label, …]) | Save the current simulator quantum state as a statevector as a dict. | +| [`save_unitary`](qiskit.providers.aer.library.save_unitary "qiskit.providers.aer.library.save_unitary")(self\[, label, pershot]) | Save the current state of the unitary simulator. | ## Method Compatibility The following table summarizes which instructions are compatible with which simulation methods -| Instruction | Automatic | Statevector | Density Matrix | MPS | Stabilizer | Ext. Stabilizer | Unitary | SuperOp | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- | -------------- | --- | ---------- | --------------- | ------- | ------- | -| [`SaveAmplitudes`](qiskit.providers.aer.library.SaveAmplitudes#qiskit.providers.aer.library.SaveAmplitudes "qiskit.providers.aer.library.SaveAmplitudes") | ✔ | ✔ | ✘ | ✔ | ✘ | ✘ | ✘ | ✘ | -| [`SaveAmplitudesSquared`](qiskit.providers.aer.library.SaveAmplitudesSquared#qiskit.providers.aer.library.SaveAmplitudesSquared "qiskit.providers.aer.library.SaveAmplitudesSquared") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | -| [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix#qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | ✘ | -| [`SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue#qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | -| [`SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance#qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | -| [`SaveMatrixProductState`](qiskit.providers.aer.library.SaveMatrixProductState#qiskit.providers.aer.library.SaveMatrixProductState "qiskit.providers.aer.library.SaveMatrixProductState") | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ | ✘ | ✘ | -| [`SaveProbabilities`](qiskit.providers.aer.library.SaveProbabilities#qiskit.providers.aer.library.SaveProbabilities "qiskit.providers.aer.library.SaveProbabilities") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | -| [`SaveProbabilitiesDict`](qiskit.providers.aer.library.SaveProbabilitiesDict#qiskit.providers.aer.library.SaveProbabilitiesDict "qiskit.providers.aer.library.SaveProbabilitiesDict") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | -| [`SaveStabilizer`](qiskit.providers.aer.library.SaveStabilizer#qiskit.providers.aer.library.SaveStabilizer "qiskit.providers.aer.library.SaveStabilizer") | ✔ | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ | ✘ | -| [`SaveState`](qiskit.providers.aer.library.SaveState#qiskit.providers.aer.library.SaveState "qiskit.providers.aer.library.SaveState") | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | -| [`SaveStatevector`](qiskit.providers.aer.library.SaveStatevector#qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector") | ✔ | ✔ | ✘ | ✔ | ✘ | ✔ | ✘ | ✘ | -| [`SaveStatevectorDict`](qiskit.providers.aer.library.SaveStatevectorDict#qiskit.providers.aer.library.SaveStatevectorDict "qiskit.providers.aer.library.SaveStatevectorDict") | ✔ | ✔ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | -| [`SaveSuperOp`](qiskit.providers.aer.library.SaveSuperOp#qiskit.providers.aer.library.SaveSuperOp "qiskit.providers.aer.library.SaveSuperOp") | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✔ | -| [`SaveUnitary`](qiskit.providers.aer.library.SaveUnitary#qiskit.providers.aer.library.SaveUnitary "qiskit.providers.aer.library.SaveUnitary") | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✔ | ✘ | -| [`SetDensityMatrix`](qiskit.providers.aer.library.SetDensityMatrix#qiskit.providers.aer.library.SetDensityMatrix "qiskit.providers.aer.library.SetDensityMatrix") | ✔ | ✘ | ✔ | ✘ | ✘ | ✘ | ✘ | ✘ | -| [`SetStabilizer`](qiskit.providers.aer.library.SetStabilizer#qiskit.providers.aer.library.SetStabilizer "qiskit.providers.aer.library.SetStabilizer") | ✔ | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ | ✘ | -| [`SetStatevector`](qiskit.providers.aer.library.SetStatevector#qiskit.providers.aer.library.SetStatevector "qiskit.providers.aer.library.SetStatevector") | ✔ | ✔ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | -| [`SetUnitary`](qiskit.providers.aer.library.SetUnitary#qiskit.providers.aer.library.SetUnitary "qiskit.providers.aer.library.SetUnitary") | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✔ | ✘ | -| | | | | | | | | | +| Instruction | Automatic | Statevector | Density Matrix | MPS | Stabilizer | Ext. Stabilizer | Unitary | SuperOp | +| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- | -------------- | --- | ---------- | --------------- | ------- | ------- | +| [`SaveAmplitudes`](qiskit.providers.aer.library.SaveAmplitudes "qiskit.providers.aer.library.SaveAmplitudes") | ✔ | ✔ | ✘ | ✔ | ✘ | ✘ | ✘ | ✘ | +| [`SaveAmplitudesSquared`](qiskit.providers.aer.library.SaveAmplitudesSquared "qiskit.providers.aer.library.SaveAmplitudesSquared") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | +| [`SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | ✘ | +| [`SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | +| [`SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | +| [`SaveMatrixProductState`](qiskit.providers.aer.library.SaveMatrixProductState "qiskit.providers.aer.library.SaveMatrixProductState") | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ | ✘ | ✘ | +| [`SaveProbabilities`](qiskit.providers.aer.library.SaveProbabilities "qiskit.providers.aer.library.SaveProbabilities") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | +| [`SaveProbabilitiesDict`](qiskit.providers.aer.library.SaveProbabilitiesDict "qiskit.providers.aer.library.SaveProbabilitiesDict") | ✔ | ✔ | ✔ | ✔ | ✔ | ✘ | ✘ | ✘ | +| [`SaveStabilizer`](qiskit.providers.aer.library.SaveStabilizer "qiskit.providers.aer.library.SaveStabilizer") | ✔ | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ | ✘ | +| [`SaveState`](qiskit.providers.aer.library.SaveState "qiskit.providers.aer.library.SaveState") | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | +| [`SaveStatevector`](qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector") | ✔ | ✔ | ✘ | ✔ | ✘ | ✔ | ✘ | ✘ | +| [`SaveStatevectorDict`](qiskit.providers.aer.library.SaveStatevectorDict "qiskit.providers.aer.library.SaveStatevectorDict") | ✔ | ✔ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | +| [`SaveSuperOp`](qiskit.providers.aer.library.SaveSuperOp "qiskit.providers.aer.library.SaveSuperOp") | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✔ | +| [`SaveUnitary`](qiskit.providers.aer.library.SaveUnitary "qiskit.providers.aer.library.SaveUnitary") | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✔ | ✘ | +| [`SetDensityMatrix`](qiskit.providers.aer.library.SetDensityMatrix "qiskit.providers.aer.library.SetDensityMatrix") | ✔ | ✘ | ✔ | ✘ | ✘ | ✘ | ✘ | ✘ | +| [`SetStabilizer`](qiskit.providers.aer.library.SetStabilizer "qiskit.providers.aer.library.SetStabilizer") | ✔ | ✘ | ✘ | ✘ | ✔ | ✘ | ✘ | ✘ | +| [`SetStatevector`](qiskit.providers.aer.library.SetStatevector "qiskit.providers.aer.library.SetStatevector") | ✔ | ✔ | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | +| [`SetUnitary`](qiskit.providers.aer.library.SetUnitary "qiskit.providers.aer.library.SetUnitary") | ✘ | ✘ | ✘ | ✘ | ✘ | ✘ | ✔ | ✘ | +| | | | | | | | | | diff --git a/docs/api/qiskit/0.32/aer_noise.md b/docs/api/qiskit/0.32/aer_noise.md index 928839263f2..f3e04572121 100644 --- a/docs/api/qiskit/0.32/aer_noise.md +++ b/docs/api/qiskit/0.32/aer_noise.md @@ -20,11 +20,11 @@ This module contains classes and functions to build a noise model for simulating ## Building Noise Models -The [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator#qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, to to automatically generate a basic device noise model for an IBMQ backend. +The [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, to to automatically generate a basic device noise model for an IBMQ backend. ### Device Noise Models -A simplified approximate [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") can be generated automatically from the properties of real device backends from the IBMQ provider using the [`NoiseModel.from_backend()`](qiskit.providers.aer.noise.NoiseModel.from_backend#qiskit.providers.aer.noise.NoiseModel.from_backend "qiskit.providers.aer.noise.NoiseModel.from_backend") method. See the method documentation for details. +A simplified approximate [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") can be generated automatically from the properties of real device backends from the IBMQ provider using the [`NoiseModel.from_backend()`](qiskit.providers.aer.noise.NoiseModel#from_backend "qiskit.providers.aer.noise.NoiseModel.from_backend") method. See the method documentation for details. **Example: Basic device noise model** @@ -63,7 +63,7 @@ plot_histogram(counts) ### Custom Noise Models -Custom noise models can be used by adding [`QuantumError`](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") to circuit gate, reset or measure instructions, and [`ReadoutError`](qiskit.providers.aer.noise.ReadoutError#qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") to measure instructions. This module includes several helper functions for generating [`QuantumError`](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") instances based on canonical error models used in Quantum Information Theory that can simplify building noise models. See the documentation for the [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") class for additional details. +Custom noise models can be used by adding [`QuantumError`](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") to circuit gate, reset or measure instructions, and [`ReadoutError`](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") to measure instructions. This module includes several helper functions for generating [`QuantumError`](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") instances based on canonical error models used in Quantum Information Theory that can simplify building noise models. See the documentation for the [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") class for additional details. **Example: depolarizing noise model** @@ -107,41 +107,41 @@ plot_histogram(counts) The following are the classes used to represented noise and error terms. -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")(\[basis\_gates]) | Noise model class for Qiskit Aer simulators. | -| [`QuantumError`](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")(noise\_ops\[, number\_of\_qubits, …]) | Quantum error class for Qiskit Aer noise model | -| [`ReadoutError`](qiskit.providers.aer.noise.ReadoutError#qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")(probabilities\[, atol]) | Readout error class for Qiskit Aer noise model. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")(\[basis\_gates]) | Noise model class for Qiskit Aer simulators. | +| [`QuantumError`](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")(noise\_ops\[, number\_of\_qubits, …]) | Quantum error class for Qiskit Aer noise model | +| [`ReadoutError`](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")(probabilities\[, atol]) | Readout error class for Qiskit Aer noise model. | ## Quantum Error Functions -The following functions can be used to generate many common types of [`QuantumError`](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") objects for inclusion in a [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel"). - -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | -| [`pauli_error`](qiskit.providers.aer.noise.pauli_error#qiskit.providers.aer.noise.pauli_error "qiskit.providers.aer.noise.pauli_error")(noise\_ops\[, standard\_gates]) | Return a mixed Pauli quantum error channel. | -| [`depolarizing_error`](qiskit.providers.aer.noise.depolarizing_error#qiskit.providers.aer.noise.depolarizing_error "qiskit.providers.aer.noise.depolarizing_error")(param, num\_qubits\[, …]) | Return a depolarizing quantum error channel. | -| [`pauli_error`](qiskit.providers.aer.noise.pauli_error#qiskit.providers.aer.noise.pauli_error "qiskit.providers.aer.noise.pauli_error")(noise\_ops\[, standard\_gates]) | Return a mixed Pauli quantum error channel. | -| [`mixed_unitary_error`](qiskit.providers.aer.noise.mixed_unitary_error#qiskit.providers.aer.noise.mixed_unitary_error "qiskit.providers.aer.noise.mixed_unitary_error")(noise\_ops\[, standard\_gates]) | Return a mixed unitary quantum error channel. | -| [`coherent_unitary_error`](qiskit.providers.aer.noise.coherent_unitary_error#qiskit.providers.aer.noise.coherent_unitary_error "qiskit.providers.aer.noise.coherent_unitary_error")(unitary) | Return a coherent unitary quantum error channel. | -| [`reset_error`](qiskit.providers.aer.noise.reset_error#qiskit.providers.aer.noise.reset_error "qiskit.providers.aer.noise.reset_error")(prob0\[, prob1]) | Return a single qubit reset quantum error channel. | -| [`amplitude_damping_error`](qiskit.providers.aer.noise.amplitude_damping_error#qiskit.providers.aer.noise.amplitude_damping_error "qiskit.providers.aer.noise.amplitude_damping_error")(param\_amp\[, …]) | Return a single-qubit generalized amplitude damping quantum error channel. | -| [`phase_damping_error`](qiskit.providers.aer.noise.phase_damping_error#qiskit.providers.aer.noise.phase_damping_error "qiskit.providers.aer.noise.phase_damping_error")(param\_phase\[, …]) | Return a single-qubit generalized phase damping quantum error channel. | -| [`phase_amplitude_damping_error`](qiskit.providers.aer.noise.phase_amplitude_damping_error#qiskit.providers.aer.noise.phase_amplitude_damping_error "qiskit.providers.aer.noise.phase_amplitude_damping_error")(param\_amp, …) | Return a single-qubit combined phase and amplitude damping quantum error channel. | -| [`thermal_relaxation_error`](qiskit.providers.aer.noise.thermal_relaxation_error#qiskit.providers.aer.noise.thermal_relaxation_error "qiskit.providers.aer.noise.thermal_relaxation_error")(t1, t2, time\[, …]) | Return a single-qubit thermal relaxation quantum error channel. | -| [`kraus_error`](qiskit.providers.aer.noise.kraus_error#qiskit.providers.aer.noise.kraus_error "qiskit.providers.aer.noise.kraus_error")(noise\_ops\[, standard\_gates, …]) | Return a Kraus quantum error channel. | +The following functions can be used to generate many common types of [`QuantumError`](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") objects for inclusion in a [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel"). + +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| [`pauli_error`](qiskit.providers.aer.noise.pauli_error "qiskit.providers.aer.noise.pauli_error")(noise\_ops\[, standard\_gates]) | Return a mixed Pauli quantum error channel. | +| [`depolarizing_error`](qiskit.providers.aer.noise.depolarizing_error "qiskit.providers.aer.noise.depolarizing_error")(param, num\_qubits\[, …]) | Return a depolarizing quantum error channel. | +| [`pauli_error`](qiskit.providers.aer.noise.pauli_error "qiskit.providers.aer.noise.pauli_error")(noise\_ops\[, standard\_gates]) | Return a mixed Pauli quantum error channel. | +| [`mixed_unitary_error`](qiskit.providers.aer.noise.mixed_unitary_error "qiskit.providers.aer.noise.mixed_unitary_error")(noise\_ops\[, standard\_gates]) | Return a mixed unitary quantum error channel. | +| [`coherent_unitary_error`](qiskit.providers.aer.noise.coherent_unitary_error "qiskit.providers.aer.noise.coherent_unitary_error")(unitary) | Return a coherent unitary quantum error channel. | +| [`reset_error`](qiskit.providers.aer.noise.reset_error "qiskit.providers.aer.noise.reset_error")(prob0\[, prob1]) | Return a single qubit reset quantum error channel. | +| [`amplitude_damping_error`](qiskit.providers.aer.noise.amplitude_damping_error "qiskit.providers.aer.noise.amplitude_damping_error")(param\_amp\[, …]) | Return a single-qubit generalized amplitude damping quantum error channel. | +| [`phase_damping_error`](qiskit.providers.aer.noise.phase_damping_error "qiskit.providers.aer.noise.phase_damping_error")(param\_phase\[, …]) | Return a single-qubit generalized phase damping quantum error channel. | +| [`phase_amplitude_damping_error`](qiskit.providers.aer.noise.phase_amplitude_damping_error "qiskit.providers.aer.noise.phase_amplitude_damping_error")(param\_amp, …) | Return a single-qubit combined phase and amplitude damping quantum error channel. | +| [`thermal_relaxation_error`](qiskit.providers.aer.noise.thermal_relaxation_error "qiskit.providers.aer.noise.thermal_relaxation_error")(t1, t2, time\[, …]) | Return a single-qubit thermal relaxation quantum error channel. | +| [`kraus_error`](qiskit.providers.aer.noise.kraus_error "qiskit.providers.aer.noise.kraus_error")(noise\_ops\[, standard\_gates, …]) | Return a Kraus quantum error channel. | ## Device Noise Parameters The following are utility functions which can be used for extracting error parameters and error objects from device BackendProperties. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`device.basic_device_readout_errors`](qiskit.providers.aer.noise.device.basic_device_readout_errors#qiskit.providers.aer.noise.device.basic_device_readout_errors "qiskit.providers.aer.noise.device.basic_device_readout_errors")(properties) | Return readout error parameters from a devices BackendProperties. | -| [`device.basic_device_gate_errors`](qiskit.providers.aer.noise.device.basic_device_gate_errors#qiskit.providers.aer.noise.device.basic_device_gate_errors "qiskit.providers.aer.noise.device.basic_device_gate_errors")(properties) | Return QuantumErrors derived from a devices BackendProperties. | -| [`device.gate_param_values`](qiskit.providers.aer.noise.device.gate_param_values#qiskit.providers.aer.noise.device.gate_param_values "qiskit.providers.aer.noise.device.gate_param_values")(properties) | Return parameter error values from a devices BackendProperties. | -| [`device.gate_error_values`](qiskit.providers.aer.noise.device.gate_error_values#qiskit.providers.aer.noise.device.gate_error_values "qiskit.providers.aer.noise.device.gate_error_values")(properties) | Return gate error values from a devices BackendProperties. | -| [`device.gate_length_values`](qiskit.providers.aer.noise.device.gate_length_values#qiskit.providers.aer.noise.device.gate_length_values "qiskit.providers.aer.noise.device.gate_length_values")(properties) | Return gate length values from a devices BackendProperties. | -| [`device.readout_error_values`](qiskit.providers.aer.noise.device.readout_error_values#qiskit.providers.aer.noise.device.readout_error_values "qiskit.providers.aer.noise.device.readout_error_values")(properties) | Return readout error values from a devices BackendProperties. | -| [`device.thermal_relaxation_values`](qiskit.providers.aer.noise.device.thermal_relaxation_values#qiskit.providers.aer.noise.device.thermal_relaxation_values "qiskit.providers.aer.noise.device.thermal_relaxation_values")(properties) | Return T1, T2 and frequency values from a devices BackendProperties. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| [`device.basic_device_readout_errors`](qiskit.providers.aer.noise.device.basic_device_readout_errors "qiskit.providers.aer.noise.device.basic_device_readout_errors")(properties) | Return readout error parameters from a devices BackendProperties. | +| [`device.basic_device_gate_errors`](qiskit.providers.aer.noise.device.basic_device_gate_errors "qiskit.providers.aer.noise.device.basic_device_gate_errors")(properties) | Return QuantumErrors derived from a devices BackendProperties. | +| [`device.gate_param_values`](qiskit.providers.aer.noise.device.gate_param_values "qiskit.providers.aer.noise.device.gate_param_values")(properties) | Return parameter error values from a devices BackendProperties. | +| [`device.gate_error_values`](qiskit.providers.aer.noise.device.gate_error_values "qiskit.providers.aer.noise.device.gate_error_values")(properties) | Return gate error values from a devices BackendProperties. | +| [`device.gate_length_values`](qiskit.providers.aer.noise.device.gate_length_values "qiskit.providers.aer.noise.device.gate_length_values")(properties) | Return gate length values from a devices BackendProperties. | +| [`device.readout_error_values`](qiskit.providers.aer.noise.device.readout_error_values "qiskit.providers.aer.noise.device.readout_error_values")(properties) | Return readout error values from a devices BackendProperties. | +| [`device.thermal_relaxation_values`](qiskit.providers.aer.noise.device.thermal_relaxation_values "qiskit.providers.aer.noise.device.thermal_relaxation_values")(properties) | Return T1, T2 and frequency values from a devices BackendProperties. | diff --git a/docs/api/qiskit/0.32/aer_provider.md b/docs/api/qiskit/0.32/aer_provider.md index 76bbd7d92c6..f7cc06e1b60 100644 --- a/docs/api/qiskit/0.32/aer_provider.md +++ b/docs/api/qiskit/0.32/aer_provider.md @@ -16,28 +16,28 @@ python_api_name: qiskit.providers.aer ## Simulator Provider -| | | -| ----------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`AerProvider`](qiskit.providers.aer.AerProvider#qiskit.providers.aer.AerProvider "qiskit.providers.aer.AerProvider")() | Provider for Qiskit Aer backends. | +| | | +| -------------------------------------------------------------------------------------- | --------------------------------- | +| [`AerProvider`](qiskit.providers.aer.AerProvider "qiskit.providers.aer.AerProvider")() | Provider for Qiskit Aer backends. | ## Simulator Backends -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | -| [`AerSimulator`](qiskit.providers.aer.AerSimulator#qiskit.providers.aer.AerSimulator "qiskit.providers.aer.AerSimulator")(\[configuration, properties, …]) | Noisy quantum circuit simulator backend. | -| [`PulseSimulator`](qiskit.providers.aer.PulseSimulator#qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator")(\[configuration, properties, …]) | Pulse schedule simulator backend. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | +| [`AerSimulator`](qiskit.providers.aer.AerSimulator "qiskit.providers.aer.AerSimulator")(\[configuration, properties, …]) | Noisy quantum circuit simulator backend. | +| [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator")(\[configuration, properties, …]) | Pulse schedule simulator backend. | ## Legacy Simulator Backends -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | -| [`QasmSimulator`](qiskit.providers.aer.QasmSimulator#qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator")(\[configuration, properties, …]) | Noisy quantum circuit simulator backend. | -| [`StatevectorSimulator`](qiskit.providers.aer.StatevectorSimulator#qiskit.providers.aer.StatevectorSimulator "qiskit.providers.aer.StatevectorSimulator")(\[configuration, …]) | Ideal quantum circuit statevector simulator | -| [`UnitarySimulator`](qiskit.providers.aer.UnitarySimulator#qiskit.providers.aer.UnitarySimulator "qiskit.providers.aer.UnitarySimulator")(\[configuration, …]) | Ideal quantum circuit unitary simulator. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | +| [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator")(\[configuration, properties, …]) | Noisy quantum circuit simulator backend. | +| [`StatevectorSimulator`](qiskit.providers.aer.StatevectorSimulator "qiskit.providers.aer.StatevectorSimulator")(\[configuration, …]) | Ideal quantum circuit statevector simulator | +| [`UnitarySimulator`](qiskit.providers.aer.UnitarySimulator "qiskit.providers.aer.UnitarySimulator")(\[configuration, …]) | Ideal quantum circuit unitary simulator. | ## Exceptions -| | | -| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| [`AerError`](qiskit.providers.aer.AerError#qiskit.providers.aer.AerError "qiskit.providers.aer.AerError")(\*message) | Base class for errors raised by simulators. | +| | | +| -------------------------------------------------------------------------------------- | ------------------------------------------- | +| [`AerError`](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError")(\*message) | Base class for errors raised by simulators. | diff --git a/docs/api/qiskit/0.32/aer_pulse.md b/docs/api/qiskit/0.32/aer_pulse.md index 94962832aac..a23c9c83058 100644 --- a/docs/api/qiskit/0.32/aer_pulse.md +++ b/docs/api/qiskit/0.32/aer_pulse.md @@ -20,15 +20,15 @@ This module contains classes and functions to build a pulse system model for sim ## Classes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | -| [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel")(\[hamiltonian, …]) | Physical model object for pulse simulator. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | +| [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel")(\[hamiltonian, …]) | Physical model object for pulse simulator. | ## Functions These functions can be used to generate a pulse system model for certain types of systems. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`duffing_system_model`](qiskit.providers.aer.pulse.duffing_system_model#qiskit.providers.aer.pulse.duffing_system_model "qiskit.providers.aer.pulse.duffing_system_model")(dim\_oscillators, …) | Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`duffing_system_model`](qiskit.providers.aer.pulse.duffing_system_model "qiskit.providers.aer.pulse.duffing_system_model")(dim\_oscillators, …) | 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/aer_utils.md b/docs/api/qiskit/0.32/aer_utils.md index 137306a2e9f..f4885849887 100644 --- a/docs/api/qiskit/0.32/aer_utils.md +++ b/docs/api/qiskit/0.32/aer_utils.md @@ -16,20 +16,20 @@ python_api_name: qiskit.providers.aer.utils `qiskit.providers.aer.utils` -This module contains utility functions for modifying [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") objects and `QuantumCircuits` using noise models. +This module contains utility functions for modifying [`NoiseModel`](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") objects and `QuantumCircuits` using noise models. ## Classes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`NoiseTransformer`](qiskit.providers.aer.utils.NoiseTransformer#qiskit.providers.aer.utils.NoiseTransformer "qiskit.providers.aer.utils.NoiseTransformer")() | Transforms one quantum channel to another based on a specified criteria. | +| | | +| ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [`NoiseTransformer`](qiskit.providers.aer.utils.NoiseTransformer "qiskit.providers.aer.utils.NoiseTransformer")() | Transforms one quantum channel to another based on a specified criteria. | ## Functions -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [`remap_noise_model`](qiskit.providers.aer.utils.remap_noise_model#qiskit.providers.aer.utils.remap_noise_model "qiskit.providers.aer.utils.remap_noise_model")(noise\_model, remapping\[, …]) | Remap qubits in a noise model. | -| [`insert_noise`](qiskit.providers.aer.utils.insert_noise#qiskit.providers.aer.utils.insert_noise "qiskit.providers.aer.utils.insert_noise")(circuits, noise\_model\[, transpile]) | Return a noisy version of a QuantumCircuit. | -| [`approximate_quantum_error`](qiskit.providers.aer.utils.approximate_quantum_error#qiskit.providers.aer.utils.approximate_quantum_error "qiskit.providers.aer.utils.approximate_quantum_error")(error, \*\[, …]) | Return an approximate QuantumError bases on the Hilbert-Schmidt metric. | -| [`approximate_noise_model`](qiskit.providers.aer.utils.approximate_noise_model#qiskit.providers.aer.utils.approximate_noise_model "qiskit.providers.aer.utils.approximate_noise_model")(model, \*\[, …]) | Return an approximate noise model. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| [`remap_noise_model`](qiskit.providers.aer.utils.remap_noise_model "qiskit.providers.aer.utils.remap_noise_model")(noise\_model, remapping\[, …]) | Remap qubits in a noise model. | +| [`insert_noise`](qiskit.providers.aer.utils.insert_noise "qiskit.providers.aer.utils.insert_noise")(circuits, noise\_model\[, transpile]) | Return a noisy version of a QuantumCircuit. | +| [`approximate_quantum_error`](qiskit.providers.aer.utils.approximate_quantum_error "qiskit.providers.aer.utils.approximate_quantum_error")(error, \*\[, …]) | Return an approximate QuantumError bases on the Hilbert-Schmidt metric. | +| [`approximate_noise_model`](qiskit.providers.aer.utils.approximate_noise_model "qiskit.providers.aer.utils.approximate_noise_model")(model, \*\[, …]) | Return an approximate noise model. | diff --git a/docs/api/qiskit/0.32/algorithms.md b/docs/api/qiskit/0.32/algorithms.md index f4d9a9b192e..8be86485387 100644 --- a/docs/api/qiskit/0.32/algorithms.md +++ b/docs/api/qiskit/0.32/algorithms.md @@ -28,75 +28,75 @@ It contains a variety of quantum algorithms and these have been grouped by logic ### Amplitude Amplifiers -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | -| [`AmplificationProblem`](qiskit.algorithms.AmplificationProblem#qiskit.algorithms.AmplificationProblem "qiskit.algorithms.AmplificationProblem") | The amplification problem is the input to amplitude amplification algorithms, like Grover. | -| [`Grover`](qiskit.algorithms.Grover#qiskit.algorithms.Grover "qiskit.algorithms.Grover") | Grover’s Search algorithm. | -| [`GroverResult`](qiskit.algorithms.GroverResult#qiskit.algorithms.GroverResult "qiskit.algorithms.GroverResult") | Grover Result. | +| | | +| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| [`AmplificationProblem`](qiskit.algorithms.AmplificationProblem "qiskit.algorithms.AmplificationProblem") | The amplification problem is the input to amplitude amplification algorithms, like Grover. | +| [`Grover`](qiskit.algorithms.Grover "qiskit.algorithms.Grover") | Grover’s Search algorithm. | +| [`GroverResult`](qiskit.algorithms.GroverResult "qiskit.algorithms.GroverResult") | Grover Result. | ### Amplitude Estimators -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator#qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.AmplitudeEstimator") | The Amplitude Estimation interface. | -| [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult#qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.AmplitudeEstimatorResult") | The results object for amplitude estimation algorithms. | -| [`AmplitudeEstimation`](qiskit.algorithms.AmplitudeEstimation#qiskit.algorithms.AmplitudeEstimation "qiskit.algorithms.AmplitudeEstimation") | The Quantum Phase Estimation-based Amplitude Estimation algorithm. | -| [`AmplitudeEstimationResult`](qiskit.algorithms.AmplitudeEstimationResult#qiskit.algorithms.AmplitudeEstimationResult "qiskit.algorithms.AmplitudeEstimationResult") | The `AmplitudeEstimation` result object. | -| [`EstimationProblem`](qiskit.algorithms.EstimationProblem#qiskit.algorithms.EstimationProblem "qiskit.algorithms.EstimationProblem") | The estimation problem is the input to amplitude estimation algorithm. | -| [`FasterAmplitudeEstimation`](qiskit.algorithms.FasterAmplitudeEstimation#qiskit.algorithms.FasterAmplitudeEstimation "qiskit.algorithms.FasterAmplitudeEstimation") | The Faster Amplitude Estimation algorithm. | -| [`FasterAmplitudeEstimationResult`](qiskit.algorithms.FasterAmplitudeEstimationResult#qiskit.algorithms.FasterAmplitudeEstimationResult "qiskit.algorithms.FasterAmplitudeEstimationResult") | The result object for the Faster Amplitude Estimation algorithm. | -| [`IterativeAmplitudeEstimation`](qiskit.algorithms.IterativeAmplitudeEstimation#qiskit.algorithms.IterativeAmplitudeEstimation "qiskit.algorithms.IterativeAmplitudeEstimation") | The Iterative Amplitude Estimation algorithm. | -| [`IterativeAmplitudeEstimationResult`](qiskit.algorithms.IterativeAmplitudeEstimationResult#qiskit.algorithms.IterativeAmplitudeEstimationResult "qiskit.algorithms.IterativeAmplitudeEstimationResult") | The `IterativeAmplitudeEstimation` result object. | -| [`MaximumLikelihoodAmplitudeEstimation`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation#qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation") | The Maximum Likelihood Amplitude Estimation algorithm. | -| [`MaximumLikelihoodAmplitudeEstimationResult`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult#qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult") | The `MaximumLikelihoodAmplitudeEstimation` result object. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| [`AmplitudeEstimator`](qiskit.algorithms.AmplitudeEstimator "qiskit.algorithms.AmplitudeEstimator") | The Amplitude Estimation interface. | +| [`AmplitudeEstimatorResult`](qiskit.algorithms.AmplitudeEstimatorResult "qiskit.algorithms.AmplitudeEstimatorResult") | The results object for amplitude estimation algorithms. | +| [`AmplitudeEstimation`](qiskit.algorithms.AmplitudeEstimation "qiskit.algorithms.AmplitudeEstimation") | The Quantum Phase Estimation-based Amplitude Estimation algorithm. | +| [`AmplitudeEstimationResult`](qiskit.algorithms.AmplitudeEstimationResult "qiskit.algorithms.AmplitudeEstimationResult") | The `AmplitudeEstimation` result object. | +| [`EstimationProblem`](qiskit.algorithms.EstimationProblem "qiskit.algorithms.EstimationProblem") | The estimation problem is the input to amplitude estimation algorithm. | +| [`FasterAmplitudeEstimation`](qiskit.algorithms.FasterAmplitudeEstimation "qiskit.algorithms.FasterAmplitudeEstimation") | The Faster Amplitude Estimation algorithm. | +| [`FasterAmplitudeEstimationResult`](qiskit.algorithms.FasterAmplitudeEstimationResult "qiskit.algorithms.FasterAmplitudeEstimationResult") | The result object for the Faster Amplitude Estimation algorithm. | +| [`IterativeAmplitudeEstimation`](qiskit.algorithms.IterativeAmplitudeEstimation "qiskit.algorithms.IterativeAmplitudeEstimation") | The Iterative Amplitude Estimation algorithm. | +| [`IterativeAmplitudeEstimationResult`](qiskit.algorithms.IterativeAmplitudeEstimationResult "qiskit.algorithms.IterativeAmplitudeEstimationResult") | The `IterativeAmplitudeEstimation` result object. | +| [`MaximumLikelihoodAmplitudeEstimation`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation") | The Maximum Likelihood Amplitude Estimation algorithm. | +| [`MaximumLikelihoodAmplitudeEstimationResult`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult") | The `MaximumLikelihoodAmplitudeEstimation` result object. | ### Eigensolvers Algorithms to find eigenvalues of an operator. For chemistry these can be used to find excited states of a molecule and qiskit.chemistry has some algorithms that leverage chemistry specific knowledge to do this in that application domain. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- | -| [`Eigensolver`](qiskit.algorithms.Eigensolver#qiskit.algorithms.Eigensolver "qiskit.algorithms.Eigensolver") | The Eigensolver Interface. | -| [`EigensolverResult`](qiskit.algorithms.EigensolverResult#qiskit.algorithms.EigensolverResult "qiskit.algorithms.EigensolverResult") | Eigensolver Result. | +| | | +| ------------------------------------------------------------------------------------------------ | -------------------------- | +| [`Eigensolver`](qiskit.algorithms.Eigensolver "qiskit.algorithms.Eigensolver") | The Eigensolver Interface. | +| [`EigensolverResult`](qiskit.algorithms.EigensolverResult "qiskit.algorithms.EigensolverResult") | Eigensolver Result. | -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`NumPyEigensolver`](qiskit.algorithms.NumPyEigensolver#qiskit.algorithms.NumPyEigensolver "qiskit.algorithms.NumPyEigensolver") | The NumPy Eigensolver algorithm. | +| | | +| --------------------------------------------------------------------------------------------- | -------------------------------- | +| [`NumPyEigensolver`](qiskit.algorithms.NumPyEigensolver "qiskit.algorithms.NumPyEigensolver") | The NumPy Eigensolver algorithm. | ### Factorizers Algorithms to find factors of a number. -| | | -| -------------------------------------------------------------------------------------------------------- | --------------------------- | -| [`Shor`](qiskit.algorithms.Shor#qiskit.algorithms.Shor "qiskit.algorithms.Shor") | Shor’s factoring algorithm. | -| [`ShorResult`](qiskit.algorithms.ShorResult#qiskit.algorithms.ShorResult "qiskit.algorithms.ShorResult") | Shor Result. | +| | | +| --------------------------------------------------------------------------- | --------------------------- | +| [`Shor`](qiskit.algorithms.Shor "qiskit.algorithms.Shor") | Shor’s factoring algorithm. | +| [`ShorResult`](qiskit.algorithms.ShorResult "qiskit.algorithms.ShorResult") | Shor Result. | ### Linear Solvers Algorithms to solve linear systems of equations. -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`HHL`](qiskit.algorithms.HHL#qiskit.algorithms.HHL "qiskit.algorithms.HHL") | Systems of linear equations arise naturally in many real-life applications in a wide range of areas, such as in the solution of Partial Differential Equations, the calibration of financial models, fluid simulation or numerical field calculation. | -| [`NumPyLinearSolver`](qiskit.algorithms.NumPyLinearSolver#qiskit.algorithms.NumPyLinearSolver "qiskit.algorithms.NumPyLinearSolver") | The Numpy Linear Solver algorithm (classical). | -| [`LinearSolver`](qiskit.algorithms.LinearSolver#qiskit.algorithms.LinearSolver "qiskit.algorithms.LinearSolver") | An abstract class for linear system solvers in Qiskit. | -| [`LinearSolverResult`](qiskit.algorithms.LinearSolverResult#qiskit.algorithms.LinearSolverResult "qiskit.algorithms.LinearSolverResult") | A base class for linear systems results. | +| | | +| --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`HHL`](qiskit.algorithms.HHL "qiskit.algorithms.HHL") | Systems of linear equations arise naturally in many real-life applications in a wide range of areas, such as in the solution of Partial Differential Equations, the calibration of financial models, fluid simulation or numerical field calculation. | +| [`NumPyLinearSolver`](qiskit.algorithms.NumPyLinearSolver "qiskit.algorithms.NumPyLinearSolver") | The Numpy Linear Solver algorithm (classical). | +| [`LinearSolver`](qiskit.algorithms.LinearSolver "qiskit.algorithms.LinearSolver") | An abstract class for linear system solvers in Qiskit. | +| [`LinearSolverResult`](qiskit.algorithms.LinearSolverResult "qiskit.algorithms.LinearSolverResult") | A base class for linear systems results. | ### Minimum Eigensolvers Algorithms that can find the minimum eigenvalue of an operator. -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver#qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.MinimumEigensolver") | The Minimum Eigensolver Interface. | -| [`MinimumEigensolverResult`](qiskit.algorithms.MinimumEigensolverResult#qiskit.algorithms.MinimumEigensolverResult "qiskit.algorithms.MinimumEigensolverResult") | Minimum Eigensolver Result. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| [`MinimumEigensolver`](qiskit.algorithms.MinimumEigensolver "qiskit.algorithms.MinimumEigensolver") | The Minimum Eigensolver Interface. | +| [`MinimumEigensolverResult`](qiskit.algorithms.MinimumEigensolverResult "qiskit.algorithms.MinimumEigensolverResult") | Minimum Eigensolver Result. | -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | -| [`NumPyMinimumEigensolver`](qiskit.algorithms.NumPyMinimumEigensolver#qiskit.algorithms.NumPyMinimumEigensolver "qiskit.algorithms.NumPyMinimumEigensolver") | The Numpy Minimum Eigensolver algorithm. | -| [`QAOA`](qiskit.algorithms.QAOA#qiskit.algorithms.QAOA "qiskit.algorithms.QAOA") | The Quantum Approximate Optimization Algorithm. | -| [`VQE`](qiskit.algorithms.VQE#qiskit.algorithms.VQE "qiskit.algorithms.VQE") | The Variational Quantum Eigensolver algorithm. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | +| [`NumPyMinimumEigensolver`](qiskit.algorithms.NumPyMinimumEigensolver "qiskit.algorithms.NumPyMinimumEigensolver") | The Numpy Minimum Eigensolver algorithm. | +| [`QAOA`](qiskit.algorithms.QAOA "qiskit.algorithms.QAOA") | The Quantum Approximate Optimization Algorithm. | +| [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE") | The Variational Quantum Eigensolver algorithm. | ### Optimizers @@ -110,18 +110,18 @@ Classical optimizers for use by quantum variational algorithms. Algorithms that estimate the phases of eigenstates of a unitary. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`HamiltonianPhaseEstimation`](qiskit.algorithms.HamiltonianPhaseEstimation#qiskit.algorithms.HamiltonianPhaseEstimation "qiskit.algorithms.HamiltonianPhaseEstimation") | Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. | -| [`HamiltonianPhaseEstimationResult`](qiskit.algorithms.HamiltonianPhaseEstimationResult#qiskit.algorithms.HamiltonianPhaseEstimationResult "qiskit.algorithms.HamiltonianPhaseEstimationResult") | Store and manipulate results from running HamiltonianPhaseEstimation. | -| [`PhaseEstimationScale`](qiskit.algorithms.PhaseEstimationScale#qiskit.algorithms.PhaseEstimationScale "qiskit.algorithms.PhaseEstimationScale") | Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. | -| [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation#qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation") | Run the Quantum Phase Estimation (QPE) algorithm. | -| [`PhaseEstimationResult`](qiskit.algorithms.PhaseEstimationResult#qiskit.algorithms.PhaseEstimationResult "qiskit.algorithms.PhaseEstimationResult") | Store and manipulate results from running PhaseEstimation. | -| [`IterativePhaseEstimation`](qiskit.algorithms.IterativePhaseEstimation#qiskit.algorithms.IterativePhaseEstimation "qiskit.algorithms.IterativePhaseEstimation") | Run the Iterative quantum phase estimation (QPE) algorithm. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`HamiltonianPhaseEstimation`](qiskit.algorithms.HamiltonianPhaseEstimation "qiskit.algorithms.HamiltonianPhaseEstimation") | Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. | +| [`HamiltonianPhaseEstimationResult`](qiskit.algorithms.HamiltonianPhaseEstimationResult "qiskit.algorithms.HamiltonianPhaseEstimationResult") | Store and manipulate results from running HamiltonianPhaseEstimation. | +| [`PhaseEstimationScale`](qiskit.algorithms.PhaseEstimationScale "qiskit.algorithms.PhaseEstimationScale") | Set and use a bound on eigenvalues of a Hermitian operator in order to ensure phases are in the desired range and to convert measured phases into eigenvectors. | +| [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation") | Run the Quantum Phase Estimation (QPE) algorithm. | +| [`PhaseEstimationResult`](qiskit.algorithms.PhaseEstimationResult "qiskit.algorithms.PhaseEstimationResult") | Store and manipulate results from running PhaseEstimation. | +| [`IterativePhaseEstimation`](qiskit.algorithms.IterativePhaseEstimation "qiskit.algorithms.IterativePhaseEstimation") | Run the Iterative quantum phase estimation (QPE) algorithm. | ## Exceptions -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`AlgorithmError`](qiskit.algorithms.AlgorithmError#qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError")(\*message) | For Algorithm specific errors. | +| | | +| -------------------------------------------------------------------------------------------------- | ------------------------------ | +| [`AlgorithmError`](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError")(\*message) | For Algorithm specific errors. | diff --git a/docs/api/qiskit/0.32/assembler.md b/docs/api/qiskit/0.32/assembler.md index c27b2e4c495..a0b1d0b87a1 100644 --- a/docs/api/qiskit/0.32/assembler.md +++ b/docs/api/qiskit/0.32/assembler.md @@ -18,25 +18,25 @@ python_api_name: qiskit.assembler ## Circuit Assembler -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`assemble_circuits`](qiskit.assembler.assemble_circuits#qiskit.assembler.assemble_circuits "qiskit.assembler.assemble_circuits")(circuits, run\_config, …) | Assembles a list of circuits into a qobj that can be run on the backend. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------ | +| [`assemble_circuits`](qiskit.assembler.assemble_circuits "qiskit.assembler.assemble_circuits")(circuits, run\_config, …) | Assembles a list of circuits into a qobj that can be run on the backend. | ## Schedule Assembler -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`assemble_schedules`](qiskit.assembler.assemble_schedules#qiskit.assembler.assemble_schedules "qiskit.assembler.assemble_schedules")(schedules, qobj\_id, …) | Assembles a list of schedules into a qobj that can be run on the backend. | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| [`assemble_schedules`](qiskit.assembler.assemble_schedules "qiskit.assembler.assemble_schedules")(schedules, qobj\_id, …) | Assembles a list of schedules into a qobj that can be run on the backend. | ## Disassembler -| | | -| --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| [`disassemble`](qiskit.assembler.disassemble#qiskit.assembler.disassemble "qiskit.assembler.disassemble")(qobj) | Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. | +| | | +| ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| [`disassemble`](qiskit.assembler.disassemble "qiskit.assembler.disassemble")(qobj) | Disassemble a qobj and return the circuits or pulse schedules, run\_config, and user header. | ## RunConfig -| | | -| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`RunConfig`](qiskit.assembler.RunConfig#qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")(\[shots, max\_credits, …]) | Class for Run Configuration. | +| | | +| ------------------------------------------------------------------------------------------------- | ---------------------------- | +| [`RunConfig`](qiskit.assembler.RunConfig "qiskit.assembler.RunConfig")(\[shots, max\_credits, …]) | Class for Run Configuration. | diff --git a/docs/api/qiskit/0.32/characterization.md b/docs/api/qiskit/0.32/characterization.md index 264d2f23c36..9db221f3dbc 100644 --- a/docs/api/qiskit/0.32/characterization.md +++ b/docs/api/qiskit/0.32/characterization.md @@ -18,14 +18,14 @@ python_api_name: qiskit.ignis.characterization ## Calibrations -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`rabi_schedules`](qiskit.ignis.characterization.rabi_schedules#qiskit.ignis.characterization.rabi_schedules "qiskit.ignis.characterization.rabi_schedules")(amp\_list, qubits, pulse\_width) | Generates schedules for a rabi experiment using a Gaussian pulse | -| [`drag_schedules`](qiskit.ignis.characterization.drag_schedules#qiskit.ignis.characterization.drag_schedules "qiskit.ignis.characterization.drag_schedules")(beta\_list, qubits, pulse\_amp, …) | Generates schedules for a drag experiment doing a pulse then the - pulse | -| [`RabiFitter`](qiskit.ignis.characterization.RabiFitter#qiskit.ignis.characterization.RabiFitter "qiskit.ignis.characterization.RabiFitter")(backend\_result, xdata, qubits, fit\_p0) | Rabi Experiment fitter | -| [`DragFitter`](qiskit.ignis.characterization.DragFitter#qiskit.ignis.characterization.DragFitter "qiskit.ignis.characterization.DragFitter")(backend\_result, xdata, qubits, fit\_p0) | Drag Experiment fitter | -| [`get_single_q_pulse`](qiskit.ignis.characterization.get_single_q_pulse#qiskit.ignis.characterization.get_single_q_pulse "qiskit.ignis.characterization.get_single_q_pulse")(inst\_map, qubits) | Get the DRAG parameters for the single qubit pulse | -| [`update_u_gates`](qiskit.ignis.characterization.update_u_gates#qiskit.ignis.characterization.update_u_gates "qiskit.ignis.characterization.update_u_gates")(drag\_params\[, …]) | Update the cmd\_def with new single qubit gate values | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [`rabi_schedules`](qiskit.ignis.characterization.rabi_schedules "qiskit.ignis.characterization.rabi_schedules")(amp\_list, qubits, pulse\_width) | Generates schedules for a rabi experiment using a Gaussian pulse | +| [`drag_schedules`](qiskit.ignis.characterization.drag_schedules "qiskit.ignis.characterization.drag_schedules")(beta\_list, qubits, pulse\_amp, …) | Generates schedules for a drag experiment doing a pulse then the - pulse | +| [`RabiFitter`](qiskit.ignis.characterization.RabiFitter "qiskit.ignis.characterization.RabiFitter")(backend\_result, xdata, qubits, fit\_p0) | Rabi Experiment fitter | +| [`DragFitter`](qiskit.ignis.characterization.DragFitter "qiskit.ignis.characterization.DragFitter")(backend\_result, xdata, qubits, fit\_p0) | Drag Experiment fitter | +| [`get_single_q_pulse`](qiskit.ignis.characterization.get_single_q_pulse "qiskit.ignis.characterization.get_single_q_pulse")(inst\_map, qubits) | Get the DRAG parameters for the single qubit pulse | +| [`update_u_gates`](qiskit.ignis.characterization.update_u_gates "qiskit.ignis.characterization.update_u_gates")(drag\_params\[, …]) | Update the cmd\_def with new single qubit gate values | ## Coherence @@ -125,39 +125,39 @@ plt.show() ![../\_images/characterization\_3\_0.png](/images/api/qiskit/0.32/characterization_3_0.png) -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`t1_circuits`](qiskit.ignis.characterization.t1_circuits#qiskit.ignis.characterization.t1_circuits "qiskit.ignis.characterization.t1_circuits")(num\_of\_gates, gate\_time, qubits) | Generate circuits for T1 measurement. | -| [`t2_circuits`](qiskit.ignis.characterization.t2_circuits#qiskit.ignis.characterization.t2_circuits "qiskit.ignis.characterization.t2_circuits")(num\_of\_gates, gate\_time, qubits) | Generate circuits for T2 (echo) measurement, by a CPMG sequence. | -| [`t2star_circuits`](qiskit.ignis.characterization.t2star_circuits#qiskit.ignis.characterization.t2star_circuits "qiskit.ignis.characterization.t2star_circuits")(num\_of\_gates, gate\_time, qubits) | Generate circuits for T2\* measurement. | -| [`T1Fitter`](qiskit.ignis.characterization.T1Fitter#qiskit.ignis.characterization.T1Fitter "qiskit.ignis.characterization.T1Fitter")(backend\_result, xdata, qubits, …) | Estimate T1, based on experiments outcomes, | -| [`T2Fitter`](qiskit.ignis.characterization.T2Fitter#qiskit.ignis.characterization.T2Fitter "qiskit.ignis.characterization.T2Fitter")(backend\_result, xdata, qubits, …) | Estimate T2, based on experiments outcomes. | -| [`T2StarFitter`](qiskit.ignis.characterization.T2StarFitter#qiskit.ignis.characterization.T2StarFitter "qiskit.ignis.characterization.T2StarFitter")(backend\_result, xdata, qubits, …) | Estimate T2\*, based on experiments outcomes. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | +| [`t1_circuits`](qiskit.ignis.characterization.t1_circuits "qiskit.ignis.characterization.t1_circuits")(num\_of\_gates, gate\_time, qubits) | Generate circuits for T1 measurement. | +| [`t2_circuits`](qiskit.ignis.characterization.t2_circuits "qiskit.ignis.characterization.t2_circuits")(num\_of\_gates, gate\_time, qubits) | Generate circuits for T2 (echo) measurement, by a CPMG sequence. | +| [`t2star_circuits`](qiskit.ignis.characterization.t2star_circuits "qiskit.ignis.characterization.t2star_circuits")(num\_of\_gates, gate\_time, qubits) | Generate circuits for T2\* measurement. | +| [`T1Fitter`](qiskit.ignis.characterization.T1Fitter "qiskit.ignis.characterization.T1Fitter")(backend\_result, xdata, qubits, …) | Estimate T1, based on experiments outcomes, | +| [`T2Fitter`](qiskit.ignis.characterization.T2Fitter "qiskit.ignis.characterization.T2Fitter")(backend\_result, xdata, qubits, …) | Estimate T2, based on experiments outcomes. | +| [`T2StarFitter`](qiskit.ignis.characterization.T2StarFitter "qiskit.ignis.characterization.T2StarFitter")(backend\_result, xdata, qubits, …) | Estimate T2\*, based on experiments outcomes. | ## Gates -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`ampcal_1Q_circuits`](qiskit.ignis.characterization.ampcal_1Q_circuits#qiskit.ignis.characterization.ampcal_1Q_circuits "qiskit.ignis.characterization.ampcal_1Q_circuits")(max\_reps, qubits) | Generates circuit for measuring the amplitude error of the single qubit gates | -| [`anglecal_1Q_circuits`](qiskit.ignis.characterization.anglecal_1Q_circuits#qiskit.ignis.characterization.anglecal_1Q_circuits "qiskit.ignis.characterization.anglecal_1Q_circuits")(max\_reps, qubits\[, …]) | Generates circuit for measuring the angle error of the single qubit gate | -| [`ampcal_cx_circuits`](qiskit.ignis.characterization.ampcal_cx_circuits#qiskit.ignis.characterization.ampcal_cx_circuits "qiskit.ignis.characterization.ampcal_cx_circuits")(max\_reps, qubits, …) | Generates circuit for measuring the amplitude error of the cx gate | -| [`anglecal_cx_circuits`](qiskit.ignis.characterization.anglecal_cx_circuits#qiskit.ignis.characterization.anglecal_cx_circuits "qiskit.ignis.characterization.anglecal_cx_circuits")(max\_reps, qubits, …) | Generates circuit for measuring the angle error of the cx gate | -| [`AmpCalFitter`](qiskit.ignis.characterization.AmpCalFitter#qiskit.ignis.characterization.AmpCalFitter "qiskit.ignis.characterization.AmpCalFitter")(backend\_result, xdata, qubits, …) | Amplitude error fitter | -| [`AngleCalFitter`](qiskit.ignis.characterization.AngleCalFitter#qiskit.ignis.characterization.AngleCalFitter "qiskit.ignis.characterization.AngleCalFitter")(backend\_result, xdata, …) | Amplitude error fitter | -| [`AmpCalCXFitter`](qiskit.ignis.characterization.AmpCalCXFitter#qiskit.ignis.characterization.AmpCalCXFitter "qiskit.ignis.characterization.AmpCalCXFitter")(backend\_result, xdata, …) | Amplitude error fitter | -| [`AngleCalCXFitter`](qiskit.ignis.characterization.AngleCalCXFitter#qiskit.ignis.characterization.AngleCalCXFitter "qiskit.ignis.characterization.AngleCalCXFitter")(backend\_result, xdata, …) | Amplitude error fitter | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [`ampcal_1Q_circuits`](qiskit.ignis.characterization.ampcal_1Q_circuits "qiskit.ignis.characterization.ampcal_1Q_circuits")(max\_reps, qubits) | Generates circuit for measuring the amplitude error of the single qubit gates | +| [`anglecal_1Q_circuits`](qiskit.ignis.characterization.anglecal_1Q_circuits "qiskit.ignis.characterization.anglecal_1Q_circuits")(max\_reps, qubits\[, …]) | Generates circuit for measuring the angle error of the single qubit gate | +| [`ampcal_cx_circuits`](qiskit.ignis.characterization.ampcal_cx_circuits "qiskit.ignis.characterization.ampcal_cx_circuits")(max\_reps, qubits, …) | Generates circuit for measuring the amplitude error of the cx gate | +| [`anglecal_cx_circuits`](qiskit.ignis.characterization.anglecal_cx_circuits "qiskit.ignis.characterization.anglecal_cx_circuits")(max\_reps, qubits, …) | Generates circuit for measuring the angle error of the cx gate | +| [`AmpCalFitter`](qiskit.ignis.characterization.AmpCalFitter "qiskit.ignis.characterization.AmpCalFitter")(backend\_result, xdata, qubits, …) | Amplitude error fitter | +| [`AngleCalFitter`](qiskit.ignis.characterization.AngleCalFitter "qiskit.ignis.characterization.AngleCalFitter")(backend\_result, xdata, …) | Amplitude error fitter | +| [`AmpCalCXFitter`](qiskit.ignis.characterization.AmpCalCXFitter "qiskit.ignis.characterization.AmpCalCXFitter")(backend\_result, xdata, …) | Amplitude error fitter | +| [`AngleCalCXFitter`](qiskit.ignis.characterization.AngleCalCXFitter "qiskit.ignis.characterization.AngleCalCXFitter")(backend\_result, xdata, …) | Amplitude error fitter | ## Hamiltonian -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`zz_circuits`](qiskit.ignis.characterization.zz_circuits#qiskit.ignis.characterization.zz_circuits "qiskit.ignis.characterization.zz_circuits")(num\_of\_gates, gate\_time, qubits, …) | Generates circuit for measuring ZZ. | -| [`ZZFitter`](qiskit.ignis.characterization.ZZFitter#qiskit.ignis.characterization.ZZFitter "qiskit.ignis.characterization.ZZFitter")(backend\_result, xdata, qubits, …) | ZZ fitter | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | +| [`zz_circuits`](qiskit.ignis.characterization.zz_circuits "qiskit.ignis.characterization.zz_circuits")(num\_of\_gates, gate\_time, qubits, …) | Generates circuit for measuring ZZ. | +| [`ZZFitter`](qiskit.ignis.characterization.ZZFitter "qiskit.ignis.characterization.ZZFitter")(backend\_result, xdata, qubits, …) | ZZ fitter | ## Base Fitters -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | -| [`BaseCoherenceFitter`](qiskit.ignis.characterization.BaseCoherenceFitter#qiskit.ignis.characterization.BaseCoherenceFitter "qiskit.ignis.characterization.BaseCoherenceFitter")(description, …\[, …]) | Base class for fitters of characteristic times | -| [`BaseGateFitter`](qiskit.ignis.characterization.BaseGateFitter#qiskit.ignis.characterization.BaseGateFitter "qiskit.ignis.characterization.BaseGateFitter")(description, backend\_result, …) | Base class for fitters of gate errors | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | +| [`BaseCoherenceFitter`](qiskit.ignis.characterization.BaseCoherenceFitter "qiskit.ignis.characterization.BaseCoherenceFitter")(description, …\[, …]) | Base class for fitters of characteristic times | +| [`BaseGateFitter`](qiskit.ignis.characterization.BaseGateFitter "qiskit.ignis.characterization.BaseGateFitter")(description, backend\_result, …) | Base class for fitters of gate errors | diff --git a/docs/api/qiskit/0.32/circuit.md b/docs/api/qiskit/0.32/circuit.md index 07b6aef9068..c619bdf64c5 100644 --- a/docs/api/qiskit/0.32/circuit.md +++ b/docs/api/qiskit/0.32/circuit.md @@ -20,7 +20,7 @@ python_api_name: qiskit.circuit The fundamental element of quantum computing is the **quantum circuit**. A quantum circuit is a computational routine consisting of coherent quantum operations on quantum data, such as qubits. It is an ordered sequence of quantum gates, measurements and resets, which may be conditioned on real-time classical computation. A set of quantum gates is said to be universal if any unitary transformation of the quantum data can be efficiently approximated arbitrarily well as as sequence of gates in the set. Any quantum program can be represented by a sequence of quantum circuits and classical near-time computation. -In Qiskit, this core element is represented by the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class. Below is an example of a quantum circuit that makes a three-qubit GHZ state defined as: +In Qiskit, this core element is represented by the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class. Below is an example of a quantum circuit that makes a three-qubit GHZ state defined as: $$ |\psi\rangle = \left(|000\rangle+|111\rangle\right)/\sqrt{2} @@ -129,7 +129,7 @@ qc.num_qubits For a quantum circuit composed from just qubits, the circuit width is equal to the number of qubits. This is the definition used in quantum computing. However, for more complicated circuits with classical registers, and classically controlled gates, this equivalence breaks down. As such, from now on we will not refer to the number of qubits in a quantum circuit as the width. -It is also straightforward to get the number and type of the gates in a circuit using [`QuantumCircuit.count_ops()`](qiskit.circuit.QuantumCircuit.count_ops#qiskit.circuit.QuantumCircuit.count_ops "qiskit.circuit.QuantumCircuit.count_ops"): +It is also straightforward to get the number and type of the gates in a circuit using [`QuantumCircuit.count_ops()`](qiskit.circuit.QuantumCircuit#count_ops "qiskit.circuit.QuantumCircuit.count_ops"): ```python qc.count_ops() @@ -139,7 +139,7 @@ qc.count_ops() OrderedDict([('cx', 8), ('h', 5), ('x', 3), ('swap', 3)]) ``` -We can also get just the raw count of operations by computing the circuits [`QuantumCircuit.size()`](qiskit.circuit.QuantumCircuit.size#qiskit.circuit.QuantumCircuit.size "qiskit.circuit.QuantumCircuit.size"): +We can also get just the raw count of operations by computing the circuits [`QuantumCircuit.size()`](qiskit.circuit.QuantumCircuit#size "qiskit.circuit.QuantumCircuit.size"): ```python qc.size() @@ -155,7 +155,7 @@ The depth of a quantum circuit has a mathematical definition as the longest path ![../\_images/depth.gif](/images/api/qiskit/0.32/depth.gif) -We can verify our graphical result using [`QuantumCircuit.depth()`](qiskit.circuit.QuantumCircuit.depth#qiskit.circuit.QuantumCircuit.depth "qiskit.circuit.QuantumCircuit.depth"): +We can verify our graphical result using [`QuantumCircuit.depth()`](qiskit.circuit.QuantumCircuit#depth "qiskit.circuit.QuantumCircuit.depth"): ```python qc.depth() @@ -169,40 +169,40 @@ qc.depth() ### Quantum Circuit Construction -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")(\*regs\[, name, global\_phase, …]) | Create a new circuit. | -| [`QuantumRegister`](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")(\[size, name, bits]) | Implement a quantum register. | -| [`Qubit`](qiskit.circuit.Qubit#qiskit.circuit.Qubit "qiskit.circuit.Qubit")(\[register, index]) | Implement a quantum bit. | -| [`ClassicalRegister`](qiskit.circuit.ClassicalRegister#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")(\[size, name, bits]) | Implement a classical register. | -| [`Clbit`](qiskit.circuit.Clbit#qiskit.circuit.Clbit "qiskit.circuit.Clbit")(\[register, index]) | Implement a classical bit. | -| [`AncillaRegister`](qiskit.circuit.AncillaRegister#qiskit.circuit.AncillaRegister "qiskit.circuit.AncillaRegister")(\[size, name, bits]) | Implement an ancilla register. | -| [`AncillaQubit`](qiskit.circuit.AncillaQubit#qiskit.circuit.AncillaQubit "qiskit.circuit.AncillaQubit")(\[register, index]) | A qubit used as ancillary qubit. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------- | +| [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")(\*regs\[, name, global\_phase, …]) | Create a new circuit. | +| [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")(\[size, name, bits]) | Implement a quantum register. | +| [`Qubit`](qiskit.circuit.Qubit "qiskit.circuit.Qubit")(\[register, index]) | Implement a quantum bit. | +| [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")(\[size, name, bits]) | Implement a classical register. | +| [`Clbit`](qiskit.circuit.Clbit "qiskit.circuit.Clbit")(\[register, index]) | Implement a classical bit. | +| [`AncillaRegister`](qiskit.circuit.AncillaRegister "qiskit.circuit.AncillaRegister")(\[size, name, bits]) | Implement an ancilla register. | +| [`AncillaQubit`](qiskit.circuit.AncillaQubit "qiskit.circuit.AncillaQubit")(\[register, index]) | A qubit used as ancillary qubit. | ### Gates and Instructions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | -| [`Gate`](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate")(name, num\_qubits, params\[, label]) | Unitary gate. | -| [`ControlledGate`](qiskit.circuit.ControlledGate#qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")(name, num\_qubits, params\[, …]) | Controlled unitary gate. | -| [`Delay`](qiskit.circuit.Delay#qiskit.circuit.Delay "qiskit.circuit.Delay")(duration\[, unit]) | Do nothing and just delay/wait/idle for a specified duration. | -| [`Measure`](qiskit.circuit.Measure#qiskit.circuit.Measure "qiskit.circuit.Measure")() | Quantum measurement in the computational basis. | -| [`Reset`](qiskit.circuit.Reset#qiskit.circuit.Reset "qiskit.circuit.Reset")() | Qubit reset. | -| [`Instruction`](qiskit.circuit.Instruction#qiskit.circuit.Instruction "qiskit.circuit.Instruction")(name, num\_qubits, num\_clbits, params) | Generic quantum instruction. | -| [`InstructionSet`](qiskit.circuit.InstructionSet#qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")() | Instruction collection, and their contexts. | -| [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")(\*\[, base]) | A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | +| [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate")(name, num\_qubits, params\[, label]) | Unitary gate. | +| [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")(name, num\_qubits, params\[, …]) | Controlled unitary gate. | +| [`Delay`](qiskit.circuit.Delay "qiskit.circuit.Delay")(duration\[, unit]) | Do nothing and just delay/wait/idle for a specified duration. | +| [`Measure`](qiskit.circuit.Measure "qiskit.circuit.Measure")() | Quantum measurement in the computational basis. | +| [`Reset`](qiskit.circuit.Reset "qiskit.circuit.Reset")() | Qubit reset. | +| [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction")(name, num\_qubits, num\_clbits, params) | Generic quantum instruction. | +| [`InstructionSet`](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet")() | Instruction collection, and their contexts. | +| [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")(\*\[, base]) | A library providing a one-way mapping of Gates to their equivalent implementations as QuantumCircuits. | ### Parametric Quantum Circuits -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | -| [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter")(name) | Parameter Class for variable parameters. | -| [`ParameterVector`](qiskit.circuit.ParameterVector#qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")(name\[, length]) | ParameterVector class to quickly generate lists of parameters. | -| [`ParameterExpression`](qiskit.circuit.ParameterExpression#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")(symbol\_map, expr) | ParameterExpression class to enable creating expressions of Parameters. | +| | | +| ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")(name) | Parameter Class for variable parameters. | +| [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")(name\[, length]) | ParameterVector class to quickly generate lists of parameters. | +| [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")(symbol\_map, expr) | ParameterExpression class to enable creating expressions of Parameters. | ### Random Circuits -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`random.random_circuit`](qiskit.circuit.random.random_circuit#qiskit.circuit.random.random_circuit "qiskit.circuit.random.random_circuit")(num\_qubits, depth\[, …]) | Generate random circuit of arbitrary size and form. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| [`random.random_circuit`](qiskit.circuit.random.random_circuit "qiskit.circuit.random.random_circuit")(num\_qubits, depth\[, …]) | Generate random circuit of arbitrary size and form. | diff --git a/docs/api/qiskit/0.32/circuit_library.md b/docs/api/qiskit/0.32/circuit_library.md index 03aaa74be73..5690a237078 100644 --- a/docs/api/qiskit/0.32/circuit_library.md +++ b/docs/api/qiskit/0.32/circuit_library.md @@ -6,274 +6,274 @@ ### Standard Gates -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`Barrier`](qiskit.circuit.library.Barrier#qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier")(num\_qubits) | Barrier instruction. | -| [`C3XGate`](qiskit.circuit.library.C3XGate#qiskit.circuit.library.C3XGate "qiskit.circuit.library.C3XGate")(\[angle, label, ctrl\_state]) | The X gate controlled on 3 qubits. | -| [`C3SXGate`](qiskit.circuit.library.C3SXGate#qiskit.circuit.library.C3SXGate "qiskit.circuit.library.C3SXGate")(\[label, ctrl\_state, angle]) | The 3-qubit controlled sqrt-X gate. | -| [`C4XGate`](qiskit.circuit.library.C4XGate#qiskit.circuit.library.C4XGate "qiskit.circuit.library.C4XGate")(\[label, ctrl\_state]) | The 4-qubit controlled X gate. | -| [`CCXGate`](qiskit.circuit.library.CCXGate#qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate")(\[label, ctrl\_state]) | CCX gate, also known as Toffoli gate. | -| [`DCXGate`](qiskit.circuit.library.DCXGate#qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate")() | Double-CNOT gate. | -| [`CHGate`](qiskit.circuit.library.CHGate#qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate")(\[label, ctrl\_state]) | Controlled-Hadamard gate. | -| [`CPhaseGate`](qiskit.circuit.library.CPhaseGate#qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate")(theta\[, label, ctrl\_state]) | Controlled-Phase gate. | -| [`CRXGate`](qiskit.circuit.library.CRXGate#qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate")(theta\[, label, ctrl\_state]) | Controlled-RX gate. | -| [`CRYGate`](qiskit.circuit.library.CRYGate#qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate")(theta\[, label, ctrl\_state]) | Controlled-RY gate. | -| [`CRZGate`](qiskit.circuit.library.CRZGate#qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate")(theta\[, label, ctrl\_state]) | Controlled-RZ gate. | -| [`CSwapGate`](qiskit.circuit.library.CSwapGate#qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate")(\[label, ctrl\_state]) | Controlled-SWAP gate, also known as the Fredkin gate. | -| [`CSXGate`](qiskit.circuit.library.CSXGate#qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate")(\[label, ctrl\_state]) | Controlled-√X gate. | -| [`CUGate`](qiskit.circuit.library.CUGate#qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate")(theta, phi, lam, gamma\[, label, …]) | Controlled-U gate (4-parameter two-qubit gate). | -| [`CU1Gate`](qiskit.circuit.library.CU1Gate#qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate")(theta\[, label, ctrl\_state]) | Controlled-U1 gate. | -| [`CU3Gate`](qiskit.circuit.library.CU3Gate#qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate")(theta, phi, lam\[, label, ctrl\_state]) | Controlled-U3 gate (3-parameter two-qubit gate). | -| [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate")(\[label, ctrl\_state]) | Controlled-X gate. | -| [`CYGate`](qiskit.circuit.library.CYGate#qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate")(\[label, ctrl\_state]) | Controlled-Y gate. | -| [`CZGate`](qiskit.circuit.library.CZGate#qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate")(\[label, ctrl\_state]) | Controlled-Z gate. | -| [`HGate`](qiskit.circuit.library.HGate#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate")(\[label]) | Single-qubit Hadamard gate. | -| [`IGate`](qiskit.circuit.library.IGate#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate")(\[label]) | Identity gate. | -| [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate#qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate")(lam, num\_ctrl\_qubits\[, label]) | Multi-controlled-Phase gate. | -| [`MCXGate`](qiskit.circuit.library.MCXGate#qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate")(\[num\_ctrl\_qubits, label, ctrl\_state]) | The general, multi-controlled X gate. | -| [`MCXGrayCode`](qiskit.circuit.library.MCXGrayCode#qiskit.circuit.library.MCXGrayCode "qiskit.circuit.library.MCXGrayCode")(\[num\_ctrl\_qubits, label, ctrl\_state]) | Implement the multi-controlled X gate using the Gray code. | -| [`MCXRecursive`](qiskit.circuit.library.MCXRecursive#qiskit.circuit.library.MCXRecursive "qiskit.circuit.library.MCXRecursive")(\[num\_ctrl\_qubits, label, …]) | Implement the multi-controlled X gate using recursion. | -| [`MCXVChain`](qiskit.circuit.library.MCXVChain#qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain")(\[num\_ctrl\_qubits, dirty\_ancillas, …]) | Implement the multi-controlled X gate using a V-chain of CX gates. | -| [`Measure`](qiskit.circuit.library.Measure#qiskit.circuit.library.Measure "qiskit.circuit.library.Measure")() | Quantum measurement in the computational basis. | -| [`MSGate`](qiskit.circuit.library.MSGate#qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate")(num\_qubits, theta\[, label]) | MSGate has been deprecated. | -| [`PhaseGate`](qiskit.circuit.library.PhaseGate#qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate")(theta\[, label]) | Single-qubit rotation about the Z axis. | -| [`RCCXGate`](qiskit.circuit.library.RCCXGate#qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate")(\[label]) | The simplified Toffoli gate, also referred to as Margolus gate. | -| [`RC3XGate`](qiskit.circuit.library.RC3XGate#qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate")(\[label]) | The simplified 3-controlled Toffoli gate. | -| [`Reset`](qiskit.circuit.library.Reset#qiskit.circuit.library.Reset "qiskit.circuit.library.Reset")() | Qubit reset. | -| [`RGate`](qiskit.circuit.library.RGate#qiskit.circuit.library.RGate "qiskit.circuit.library.RGate")(theta, phi) | Rotation θ around the cos(φ)x + sin(φ)y axis. | -| [`RXGate`](qiskit.circuit.library.RXGate#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate")(theta\[, label]) | Single-qubit rotation about the X axis. | -| [`RXXGate`](qiskit.circuit.library.RXXGate#qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate")(theta) | A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). | -| [`RYGate`](qiskit.circuit.library.RYGate#qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")(theta\[, label]) | Single-qubit rotation about the Y axis. | -| [`RYYGate`](qiskit.circuit.library.RYYGate#qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate")(theta) | A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). | -| [`RZGate`](qiskit.circuit.library.RZGate#qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate")(phi\[, label]) | Single-qubit rotation about the Z axis. | -| [`RZZGate`](qiskit.circuit.library.RZZGate#qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate")(theta) | A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). | -| [`RZXGate`](qiskit.circuit.library.RZXGate#qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate")(theta) | A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). | -| [`ECRGate`](qiskit.circuit.library.ECRGate#qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate")() | An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). | -| [`SGate`](qiskit.circuit.library.SGate#qiskit.circuit.library.SGate "qiskit.circuit.library.SGate")(\[label]) | Single qubit S gate (Z\*\*0.5). | -| [`SdgGate`](qiskit.circuit.library.SdgGate#qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate")(\[label]) | Single qubit S-adjoint gate (\~Z\*\*0.5). | -| [`SwapGate`](qiskit.circuit.library.SwapGate#qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")(\[label]) | The SWAP gate. | -| [`iSwapGate`](qiskit.circuit.library.iSwapGate#qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate")() | iSWAP gate. | -| [`SXGate`](qiskit.circuit.library.SXGate#qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate")(\[label]) | The single-qubit Sqrt(X) gate ($\sqrt{X}$). | -| [`SXdgGate`](qiskit.circuit.library.SXdgGate#qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate")(\[label]) | The inverse single-qubit Sqrt(X) gate. | -| [`TGate`](qiskit.circuit.library.TGate#qiskit.circuit.library.TGate "qiskit.circuit.library.TGate")(\[label]) | Single qubit T gate (Z\*\*0.25). | -| [`TdgGate`](qiskit.circuit.library.TdgGate#qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate")(\[label]) | Single qubit T-adjoint gate (\~Z\*\*0.25). | -| [`UGate`](qiskit.circuit.library.UGate#qiskit.circuit.library.UGate "qiskit.circuit.library.UGate")(theta, phi, lam\[, label]) | Generic single-qubit rotation gate with 3 Euler angles. | -| [`U1Gate`](qiskit.circuit.library.U1Gate#qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate")(theta\[, label]) | Single-qubit rotation about the Z axis. | -| [`U2Gate`](qiskit.circuit.library.U2Gate#qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate")(phi, lam\[, label]) | Single-qubit rotation about the X+Z axis. | -| [`U3Gate`](qiskit.circuit.library.U3Gate#qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate")(theta, phi, lam\[, label]) | Generic single-qubit rotation gate with 3 Euler angles. | -| [`XGate`](qiskit.circuit.library.XGate#qiskit.circuit.library.XGate "qiskit.circuit.library.XGate")(\[label]) | The single-qubit Pauli-X gate ($\sigma_x$). | -| [`YGate`](qiskit.circuit.library.YGate#qiskit.circuit.library.YGate "qiskit.circuit.library.YGate")(\[label]) | The single-qubit Pauli-Y gate ($\sigma_y$). | -| [`ZGate`](qiskit.circuit.library.ZGate#qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate")(\[label]) | The single-qubit Pauli-Z gate ($\sigma_z$). | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| [`Barrier`](qiskit.circuit.library.Barrier "qiskit.circuit.library.Barrier")(num\_qubits) | Barrier instruction. | +| [`C3XGate`](qiskit.circuit.library.C3XGate "qiskit.circuit.library.C3XGate")(\[angle, label, ctrl\_state]) | The X gate controlled on 3 qubits. | +| [`C3SXGate`](qiskit.circuit.library.C3SXGate "qiskit.circuit.library.C3SXGate")(\[label, ctrl\_state, angle]) | The 3-qubit controlled sqrt-X gate. | +| [`C4XGate`](qiskit.circuit.library.C4XGate "qiskit.circuit.library.C4XGate")(\[label, ctrl\_state]) | The 4-qubit controlled X gate. | +| [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate")(\[label, ctrl\_state]) | CCX gate, also known as Toffoli gate. | +| [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate")() | Double-CNOT gate. | +| [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate")(\[label, ctrl\_state]) | Controlled-Hadamard gate. | +| [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate")(theta\[, label, ctrl\_state]) | Controlled-Phase gate. | +| [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate")(theta\[, label, ctrl\_state]) | Controlled-RX gate. | +| [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate")(theta\[, label, ctrl\_state]) | Controlled-RY gate. | +| [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate")(theta\[, label, ctrl\_state]) | Controlled-RZ gate. | +| [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate")(\[label, ctrl\_state]) | Controlled-SWAP gate, also known as the Fredkin gate. | +| [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate")(\[label, ctrl\_state]) | Controlled-√X gate. | +| [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate")(theta, phi, lam, gamma\[, label, …]) | Controlled-U gate (4-parameter two-qubit gate). | +| [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate")(theta\[, label, ctrl\_state]) | Controlled-U1 gate. | +| [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate")(theta, phi, lam\[, label, ctrl\_state]) | Controlled-U3 gate (3-parameter two-qubit gate). | +| [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate")(\[label, ctrl\_state]) | Controlled-X gate. | +| [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate")(\[label, ctrl\_state]) | Controlled-Y gate. | +| [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate")(\[label, ctrl\_state]) | Controlled-Z gate. | +| [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate")(\[label]) | Single-qubit Hadamard gate. | +| [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate")(\[label]) | Identity gate. | +| [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate")(lam, num\_ctrl\_qubits\[, label]) | Multi-controlled-Phase gate. | +| [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate")(\[num\_ctrl\_qubits, label, ctrl\_state]) | The general, multi-controlled X gate. | +| [`MCXGrayCode`](qiskit.circuit.library.MCXGrayCode "qiskit.circuit.library.MCXGrayCode")(\[num\_ctrl\_qubits, label, ctrl\_state]) | Implement the multi-controlled X gate using the Gray code. | +| [`MCXRecursive`](qiskit.circuit.library.MCXRecursive "qiskit.circuit.library.MCXRecursive")(\[num\_ctrl\_qubits, label, …]) | Implement the multi-controlled X gate using recursion. | +| [`MCXVChain`](qiskit.circuit.library.MCXVChain "qiskit.circuit.library.MCXVChain")(\[num\_ctrl\_qubits, dirty\_ancillas, …]) | Implement the multi-controlled X gate using a V-chain of CX gates. | +| [`Measure`](qiskit.circuit.library.Measure "qiskit.circuit.library.Measure")() | Quantum measurement in the computational basis. | +| [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate")(num\_qubits, theta\[, label]) | MSGate has been deprecated. | +| [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate")(theta\[, label]) | Single-qubit rotation about the Z axis. | +| [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate")(\[label]) | The simplified Toffoli gate, also referred to as Margolus gate. | +| [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate")(\[label]) | The simplified 3-controlled Toffoli gate. | +| [`Reset`](qiskit.circuit.library.Reset "qiskit.circuit.library.Reset")() | Qubit reset. | +| [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate")(theta, phi) | Rotation θ around the cos(φ)x + sin(φ)y axis. | +| [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate")(theta\[, label]) | Single-qubit rotation about the X axis. | +| [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate")(theta) | A parametric 2-qubit $X \otimes X$ interaction (rotation about XX). | +| [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate")(theta\[, label]) | Single-qubit rotation about the Y axis. | +| [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate")(theta) | A parametric 2-qubit $Y \otimes Y$ interaction (rotation about YY). | +| [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate")(phi\[, label]) | Single-qubit rotation about the Z axis. | +| [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate")(theta) | A parametric 2-qubit $Z \otimes Z$ interaction (rotation about ZZ). | +| [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate")(theta) | A parametric 2-qubit $Z \otimes X$ interaction (rotation about ZX). | +| [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate")() | An echoed RZX(pi/2) gate implemented using RZX(pi/4) and RZX(-pi/4). | +| [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate")(\[label]) | Single qubit S gate (Z\*\*0.5). | +| [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate")(\[label]) | Single qubit S-adjoint gate (\~Z\*\*0.5). | +| [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate")(\[label]) | The SWAP gate. | +| [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate")() | iSWAP gate. | +| [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate")(\[label]) | The single-qubit Sqrt(X) gate ($\sqrt{X}$). | +| [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate")(\[label]) | The inverse single-qubit Sqrt(X) gate. | +| [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate")(\[label]) | Single qubit T gate (Z\*\*0.25). | +| [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate")(\[label]) | Single qubit T-adjoint gate (\~Z\*\*0.25). | +| [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate")(theta, phi, lam\[, label]) | Generic single-qubit rotation gate with 3 Euler angles. | +| [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate")(theta\[, label]) | Single-qubit rotation about the Z axis. | +| [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate")(phi, lam\[, label]) | Single-qubit rotation about the X+Z axis. | +| [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate")(theta, phi, lam\[, label]) | Generic single-qubit rotation gate with 3 Euler angles. | +| [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate")(\[label]) | The single-qubit Pauli-X gate ($\sigma_x$). | +| [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate")(\[label]) | The single-qubit Pauli-Y gate ($\sigma_y$). | +| [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate")(\[label]) | The single-qubit Pauli-Z gate ($\sigma_z$). | ### Generalized Gates -| | | | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | - | ----------------------------------- | -| [`Diagonal`](qiskit.circuit.library.Diagonal#qiskit.circuit.library.Diagonal "qiskit.circuit.library.Diagonal")(diag) | Diagonal circuit. | | | -| [`MCMT`](qiskit.circuit.library.MCMT#qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT")(gate, num\_ctrl\_qubits, num\_target\_qubits) | The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. | | | -| [`MCMTVChain`](qiskit.circuit.library.MCMTVChain#qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain")(gate, num\_ctrl\_qubits, …\[, label]) | The MCMT implementation using the CCX V-chain. | | | -| [`Permutation`](qiskit.circuit.library.Permutation#qiskit.circuit.library.Permutation "qiskit.circuit.library.Permutation")(num\_qubits\[, pattern, seed]) | An n\_qubit circuit that permutes qubits. | | | -| [`GMS`](qiskit.circuit.library.GMS#qiskit.circuit.library.GMS "qiskit.circuit.library.GMS")(num\_qubits, theta) | Global Mølmer–Sørensen gate. | | | -| [`GR`](qiskit.circuit.library.GR#qiskit.circuit.library.GR "qiskit.circuit.library.GR")(num\_qubits, theta, phi) | Global R gate. | | | -| [`GRX`](qiskit.circuit.library.GRX#qiskit.circuit.library.GRX "qiskit.circuit.library.GRX")(num\_qubits, theta) | Global RX gate. | | | -| [`GRY`](qiskit.circuit.library.GRY#qiskit.circuit.library.GRY "qiskit.circuit.library.GRY")(num\_qubits, theta) | Global RY gate. | | | -| [`GRZ`](qiskit.circuit.library.GRZ#qiskit.circuit.library.GRZ "qiskit.circuit.library.GRZ")(num\_qubits, phi) | Global RZ gate. | | | -| [`RVGate`](qiskit.circuit.library.RVGate#qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate")(v\_x, v\_y, v\_z\[, basis]) | Rotation around arbitrary rotation axis $v$ where \$ | v | \$ is angle of rotation in radians. | -| [`PauliGate`](qiskit.circuit.library.PauliGate#qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate")(label) | A multi-qubit Pauli gate. | | | +| | | | | +| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | - | ----------------------------------- | +| [`Diagonal`](qiskit.circuit.library.Diagonal "qiskit.circuit.library.Diagonal")(diag) | Diagonal circuit. | | | +| [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT")(gate, num\_ctrl\_qubits, num\_target\_qubits) | The multi-controlled multi-target gate, for an arbitrary singly controlled target gate. | | | +| [`MCMTVChain`](qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain")(gate, num\_ctrl\_qubits, …\[, label]) | The MCMT implementation using the CCX V-chain. | | | +| [`Permutation`](qiskit.circuit.library.Permutation "qiskit.circuit.library.Permutation")(num\_qubits\[, pattern, seed]) | An n\_qubit circuit that permutes qubits. | | | +| [`GMS`](qiskit.circuit.library.GMS "qiskit.circuit.library.GMS")(num\_qubits, theta) | Global Mølmer–Sørensen gate. | | | +| [`GR`](qiskit.circuit.library.GR "qiskit.circuit.library.GR")(num\_qubits, theta, phi) | Global R gate. | | | +| [`GRX`](qiskit.circuit.library.GRX "qiskit.circuit.library.GRX")(num\_qubits, theta) | Global RX gate. | | | +| [`GRY`](qiskit.circuit.library.GRY "qiskit.circuit.library.GRY")(num\_qubits, theta) | Global RY gate. | | | +| [`GRZ`](qiskit.circuit.library.GRZ "qiskit.circuit.library.GRZ")(num\_qubits, phi) | Global RZ gate. | | | +| [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate")(v\_x, v\_y, v\_z\[, basis]) | Rotation around arbitrary rotation axis $v$ where \$ | v | \$ is angle of rotation in radians. | +| [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate")(label) | A multi-qubit Pauli gate. | | | ### Boolean Logic Circuits -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`AND`](qiskit.circuit.library.AND#qiskit.circuit.library.AND "qiskit.circuit.library.AND")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical AND operation on a number of qubits. | -| [`OR`](qiskit.circuit.library.OR#qiskit.circuit.library.OR "qiskit.circuit.library.OR")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical OR operation on a number of qubits. | -| [`XOR`](qiskit.circuit.library.XOR#qiskit.circuit.library.XOR "qiskit.circuit.library.XOR")(num\_qubits\[, amount, seed]) | An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. | -| [`InnerProduct`](qiskit.circuit.library.InnerProduct#qiskit.circuit.library.InnerProduct "qiskit.circuit.library.InnerProduct")(num\_qubits) | A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. | +| | | +| ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | +| [`AND`](qiskit.circuit.library.AND "qiskit.circuit.library.AND")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical AND operation on a number of qubits. | +| [`OR`](qiskit.circuit.library.OR "qiskit.circuit.library.OR")(num\_variable\_qubits\[, flags, mcx\_mode]) | A circuit implementing the logical OR operation on a number of qubits. | +| [`XOR`](qiskit.circuit.library.XOR "qiskit.circuit.library.XOR")(num\_qubits\[, amount, seed]) | An n\_qubit circuit for bitwise xor-ing the input with some integer `amount`. | +| [`InnerProduct`](qiskit.circuit.library.InnerProduct "qiskit.circuit.library.InnerProduct")(num\_qubits) | A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$. | ### Basis Change Circuits -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`QFT`](qiskit.circuit.library.QFT#qiskit.circuit.library.QFT "qiskit.circuit.library.QFT")(\[num\_qubits, approximation\_degree, …]) | Quantum Fourier Transform Circuit. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT")(\[num\_qubits, approximation\_degree, …]) | Quantum Fourier Transform Circuit. | ### Arithmetic Circuits #### Amplitude Functions -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`LinearAmplitudeFunction`](qiskit.circuit.library.LinearAmplitudeFunction#qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")(num\_state\_qubits, …) | A circuit implementing a (piecewise) linear function on qubit amplitudes. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| [`LinearAmplitudeFunction`](qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")(num\_state\_qubits, …) | A circuit implementing a (piecewise) linear function on qubit amplitudes. | #### Functional Pauli Rotations -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations#qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.FunctionalPauliRotations")(\[num\_state\_qubits, …]) | Base class for functional Pauli rotations. | -| [`LinearPauliRotations`](qiskit.circuit.library.LinearPauliRotations#qiskit.circuit.library.LinearPauliRotations "qiskit.circuit.library.LinearPauliRotations")(\[num\_state\_qubits, …]) | Linearly-controlled X, Y or Z rotation. | -| [`PolynomialPauliRotations`](qiskit.circuit.library.PolynomialPauliRotations#qiskit.circuit.library.PolynomialPauliRotations "qiskit.circuit.library.PolynomialPauliRotations")(\[num\_state\_qubits, …]) | A circuit implementing polynomial Pauli rotations. | -| [`PiecewiseLinearPauliRotations`](qiskit.circuit.library.PiecewiseLinearPauliRotations#qiskit.circuit.library.PiecewiseLinearPauliRotations "qiskit.circuit.library.PiecewiseLinearPauliRotations")(\[…]) | Piecewise-linearly-controlled Pauli rotations. | -| [`PiecewisePolynomialPauliRotations`](qiskit.circuit.library.PiecewisePolynomialPauliRotations#qiskit.circuit.library.PiecewisePolynomialPauliRotations "qiskit.circuit.library.PiecewisePolynomialPauliRotations")(\[…]) | Piecewise-polynomially-controlled Pauli rotations. | -| [`PiecewiseChebyshev`](qiskit.circuit.library.PiecewiseChebyshev#qiskit.circuit.library.PiecewiseChebyshev "qiskit.circuit.library.PiecewiseChebyshev")(f\_x\[, degree, …]) | Piecewise Chebyshev approximation to an input function. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| [`FunctionalPauliRotations`](qiskit.circuit.library.FunctionalPauliRotations "qiskit.circuit.library.FunctionalPauliRotations")(\[num\_state\_qubits, …]) | Base class for functional Pauli rotations. | +| [`LinearPauliRotations`](qiskit.circuit.library.LinearPauliRotations "qiskit.circuit.library.LinearPauliRotations")(\[num\_state\_qubits, …]) | Linearly-controlled X, Y or Z rotation. | +| [`PolynomialPauliRotations`](qiskit.circuit.library.PolynomialPauliRotations "qiskit.circuit.library.PolynomialPauliRotations")(\[num\_state\_qubits, …]) | A circuit implementing polynomial Pauli rotations. | +| [`PiecewiseLinearPauliRotations`](qiskit.circuit.library.PiecewiseLinearPauliRotations "qiskit.circuit.library.PiecewiseLinearPauliRotations")(\[…]) | Piecewise-linearly-controlled Pauli rotations. | +| [`PiecewisePolynomialPauliRotations`](qiskit.circuit.library.PiecewisePolynomialPauliRotations "qiskit.circuit.library.PiecewisePolynomialPauliRotations")(\[…]) | Piecewise-polynomially-controlled Pauli rotations. | +| [`PiecewiseChebyshev`](qiskit.circuit.library.PiecewiseChebyshev "qiskit.circuit.library.PiecewiseChebyshev")(f\_x\[, degree, …]) | Piecewise Chebyshev approximation to an input function. | #### Adders -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`DraperQFTAdder`](qiskit.circuit.library.DraperQFTAdder#qiskit.circuit.library.DraperQFTAdder "qiskit.circuit.library.DraperQFTAdder")(num\_state\_qubits\[, kind, name]) | A circuit that uses QFT to perform in-place addition on two qubit registers. | -| [`CDKMRippleCarryAdder`](qiskit.circuit.library.CDKMRippleCarryAdder#qiskit.circuit.library.CDKMRippleCarryAdder "qiskit.circuit.library.CDKMRippleCarryAdder")(num\_state\_qubits\[, …]) | A ripple-carry circuit to perform in-place addition on two qubit registers. | -| [`VBERippleCarryAdder`](qiskit.circuit.library.VBERippleCarryAdder#qiskit.circuit.library.VBERippleCarryAdder "qiskit.circuit.library.VBERippleCarryAdder")(num\_state\_qubits\[, …]) | The VBE ripple carry adder \[1]. | -| [`WeightedAdder`](qiskit.circuit.library.WeightedAdder#qiskit.circuit.library.WeightedAdder "qiskit.circuit.library.WeightedAdder")(\[num\_state\_qubits, weights, name]) | A circuit to compute the weighted sum of qubit registers. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`DraperQFTAdder`](qiskit.circuit.library.DraperQFTAdder "qiskit.circuit.library.DraperQFTAdder")(num\_state\_qubits\[, kind, name]) | A circuit that uses QFT to perform in-place addition on two qubit registers. | +| [`CDKMRippleCarryAdder`](qiskit.circuit.library.CDKMRippleCarryAdder "qiskit.circuit.library.CDKMRippleCarryAdder")(num\_state\_qubits\[, …]) | A ripple-carry circuit to perform in-place addition on two qubit registers. | +| [`VBERippleCarryAdder`](qiskit.circuit.library.VBERippleCarryAdder "qiskit.circuit.library.VBERippleCarryAdder")(num\_state\_qubits\[, …]) | The VBE ripple carry adder \[1]. | +| [`WeightedAdder`](qiskit.circuit.library.WeightedAdder "qiskit.circuit.library.WeightedAdder")(\[num\_state\_qubits, weights, name]) | A circuit to compute the weighted sum of qubit registers. | #### Multipliers -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [`HRSCumulativeMultiplier`](qiskit.circuit.library.HRSCumulativeMultiplier#qiskit.circuit.library.HRSCumulativeMultiplier "qiskit.circuit.library.HRSCumulativeMultiplier")(num\_state\_qubits\[, …]) | A multiplication circuit to store product of two input registers out-of-place. | -| [`RGQFTMultiplier`](qiskit.circuit.library.RGQFTMultiplier#qiskit.circuit.library.RGQFTMultiplier "qiskit.circuit.library.RGQFTMultiplier")(num\_state\_qubits\[, …]) | A QFT multiplication circuit to store product of two input registers out-of-place. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | +| [`HRSCumulativeMultiplier`](qiskit.circuit.library.HRSCumulativeMultiplier "qiskit.circuit.library.HRSCumulativeMultiplier")(num\_state\_qubits\[, …]) | A multiplication circuit to store product of two input registers out-of-place. | +| [`RGQFTMultiplier`](qiskit.circuit.library.RGQFTMultiplier "qiskit.circuit.library.RGQFTMultiplier")(num\_state\_qubits\[, …]) | A QFT multiplication circuit to store product of two input registers out-of-place. | #### Comparators -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- | -| [`IntegerComparator`](qiskit.circuit.library.IntegerComparator#qiskit.circuit.library.IntegerComparator "qiskit.circuit.library.IntegerComparator")(\[num\_state\_qubits, value, …]) | Integer Comparator. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | +| [`IntegerComparator`](qiskit.circuit.library.IntegerComparator "qiskit.circuit.library.IntegerComparator")(\[num\_state\_qubits, value, …]) | Integer Comparator. | #### Functions on binary variables -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| [`QuadraticForm`](qiskit.circuit.library.QuadraticForm#qiskit.circuit.library.QuadraticForm "qiskit.circuit.library.QuadraticForm")(\[num\_result\_qubits, …]) | Implements a quadratic form on binary variables encoded in qubit registers. | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| [`QuadraticForm`](qiskit.circuit.library.QuadraticForm "qiskit.circuit.library.QuadraticForm")(\[num\_result\_qubits, …]) | Implements a quadratic form on binary variables encoded in qubit registers. | ### Amplitude Functions -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`LinearAmplitudeFunction`](qiskit.circuit.library.LinearAmplitudeFunction#qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")(num\_state\_qubits, …) | A circuit implementing a (piecewise) linear function on qubit amplitudes. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| [`LinearAmplitudeFunction`](qiskit.circuit.library.LinearAmplitudeFunction "qiskit.circuit.library.LinearAmplitudeFunction")(num\_state\_qubits, …) | A circuit implementing a (piecewise) linear function on qubit amplitudes. | ### Particular Quantum Circuits -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | -| [`FourierChecking`](qiskit.circuit.library.FourierChecking#qiskit.circuit.library.FourierChecking "qiskit.circuit.library.FourierChecking")(f, g) | Fourier checking circuit. | -| [`GraphState`](qiskit.circuit.library.GraphState#qiskit.circuit.library.GraphState "qiskit.circuit.library.GraphState")(adjacency\_matrix) | Circuit to prepare a graph state. | -| [`HiddenLinearFunction`](qiskit.circuit.library.HiddenLinearFunction#qiskit.circuit.library.HiddenLinearFunction "qiskit.circuit.library.HiddenLinearFunction")(adjacency\_matrix) | Circuit to solve the hidden linear function problem. | -| [`IQP`](qiskit.circuit.library.IQP#qiskit.circuit.library.IQP "qiskit.circuit.library.IQP")(interactions) | Instantaneous quantum polynomial (IQP) circuit. | -| [`QuantumVolume`](qiskit.circuit.library.QuantumVolume#qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume")(num\_qubits\[, depth, seed, …]) | A quantum volume model circuit. | -| [`PhaseEstimation`](qiskit.circuit.library.PhaseEstimation#qiskit.circuit.library.PhaseEstimation "qiskit.circuit.library.PhaseEstimation")(num\_evaluation\_qubits, unitary) | Phase Estimation circuit. | -| [`GroverOperator`](qiskit.circuit.library.GroverOperator#qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator")(oracle\[, state\_preparation, …]) | The Grover operator. | -| [`PhaseOracle`](qiskit.circuit.library.PhaseOracle#qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle")(expression\[, synthesizer]) | Phase Oracle. | -| [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz#qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz")(\[operators, reps, …]) | The evolved operator ansatz. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| [`FourierChecking`](qiskit.circuit.library.FourierChecking "qiskit.circuit.library.FourierChecking")(f, g) | Fourier checking circuit. | +| [`GraphState`](qiskit.circuit.library.GraphState "qiskit.circuit.library.GraphState")(adjacency\_matrix) | Circuit to prepare a graph state. | +| [`HiddenLinearFunction`](qiskit.circuit.library.HiddenLinearFunction "qiskit.circuit.library.HiddenLinearFunction")(adjacency\_matrix) | Circuit to solve the hidden linear function problem. | +| [`IQP`](qiskit.circuit.library.IQP "qiskit.circuit.library.IQP")(interactions) | Instantaneous quantum polynomial (IQP) circuit. | +| [`QuantumVolume`](qiskit.circuit.library.QuantumVolume "qiskit.circuit.library.QuantumVolume")(num\_qubits\[, depth, seed, …]) | A quantum volume model circuit. | +| [`PhaseEstimation`](qiskit.circuit.library.PhaseEstimation "qiskit.circuit.library.PhaseEstimation")(num\_evaluation\_qubits, unitary) | Phase Estimation circuit. | +| [`GroverOperator`](qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator")(oracle\[, state\_preparation, …]) | The Grover operator. | +| [`PhaseOracle`](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle")(expression\[, synthesizer]) | Phase Oracle. | +| [`EvolvedOperatorAnsatz`](qiskit.circuit.library.EvolvedOperatorAnsatz "qiskit.circuit.library.EvolvedOperatorAnsatz")(\[operators, reps, …]) | The evolved operator ansatz. | ### Probability distributions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| [`UniformDistribution`](qiskit.circuit.library.UniformDistribution#qiskit.circuit.library.UniformDistribution "qiskit.circuit.library.UniformDistribution")(num\_qubits\[, name]) | A circuit to encode a discretized uniform distribution in qubit amplitudes. | -| [`NormalDistribution`](qiskit.circuit.library.NormalDistribution#qiskit.circuit.library.NormalDistribution "qiskit.circuit.library.NormalDistribution")(num\_qubits\[, mu, sigma, …]) | A circuit to encode a discretized normal distribution in qubit amplitudes. | -| [`LogNormalDistribution`](qiskit.circuit.library.LogNormalDistribution#qiskit.circuit.library.LogNormalDistribution "qiskit.circuit.library.LogNormalDistribution")(num\_qubits\[, mu, …]) | A circuit to encode a discretized log-normal distribution in qubit amplitudes. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| [`UniformDistribution`](qiskit.circuit.library.UniformDistribution "qiskit.circuit.library.UniformDistribution")(num\_qubits\[, name]) | A circuit to encode a discretized uniform distribution in qubit amplitudes. | +| [`NormalDistribution`](qiskit.circuit.library.NormalDistribution "qiskit.circuit.library.NormalDistribution")(num\_qubits\[, mu, sigma, …]) | A circuit to encode a discretized normal distribution in qubit amplitudes. | +| [`LogNormalDistribution`](qiskit.circuit.library.LogNormalDistribution "qiskit.circuit.library.LogNormalDistribution")(num\_qubits\[, mu, …]) | A circuit to encode a discretized log-normal distribution in qubit amplitudes. | ### N-local circuits -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| [`NLocal`](qiskit.circuit.library.NLocal#qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal")(\[num\_qubits, rotation\_blocks, …]) | The n-local circuit class. | -| [`TwoLocal`](qiskit.circuit.library.TwoLocal#qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal")(\[num\_qubits, rotation\_blocks, …]) | The two-local circuit. | -| [`PauliTwoDesign`](qiskit.circuit.library.PauliTwoDesign#qiskit.circuit.library.PauliTwoDesign "qiskit.circuit.library.PauliTwoDesign")(\[num\_qubits, reps, seed, …]) | The Pauli Two-Design ansatz. | -| [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes#qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes")(\[num\_qubits, entanglement, …]) | The real-amplitudes 2-local circuit. | -| [`EfficientSU2`](qiskit.circuit.library.EfficientSU2#qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2")(\[num\_qubits, su2\_gates, …]) | The hardware efficient SU(2) 2-local circuit. | -| [`ExcitationPreserving`](qiskit.circuit.library.ExcitationPreserving#qiskit.circuit.library.ExcitationPreserving "qiskit.circuit.library.ExcitationPreserving")(\[num\_qubits, mode, …]) | The heuristic excitation-preserving wave function ansatz. | -| [`QAOAAnsatz`](qiskit.circuit.library.QAOAAnsatz#qiskit.circuit.library.QAOAAnsatz "qiskit.circuit.library.QAOAAnsatz")(\[cost\_operator, reps, …]) | A generalized QAOA quantum circuit with a support of custom initial states and mixers. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal")(\[num\_qubits, rotation\_blocks, …]) | The n-local circuit class. | +| [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal")(\[num\_qubits, rotation\_blocks, …]) | The two-local circuit. | +| [`PauliTwoDesign`](qiskit.circuit.library.PauliTwoDesign "qiskit.circuit.library.PauliTwoDesign")(\[num\_qubits, reps, seed, …]) | The Pauli Two-Design ansatz. | +| [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes")(\[num\_qubits, entanglement, …]) | The real-amplitudes 2-local circuit. | +| [`EfficientSU2`](qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2")(\[num\_qubits, su2\_gates, …]) | The hardware efficient SU(2) 2-local circuit. | +| [`ExcitationPreserving`](qiskit.circuit.library.ExcitationPreserving "qiskit.circuit.library.ExcitationPreserving")(\[num\_qubits, mode, …]) | The heuristic excitation-preserving wave function ansatz. | +| [`QAOAAnsatz`](qiskit.circuit.library.QAOAAnsatz "qiskit.circuit.library.QAOAAnsatz")(\[cost\_operator, reps, …]) | A generalized QAOA quantum circuit with a support of custom initial states and mixers. | ### Data encoding circuits -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap#qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap")(\[feature\_dimension, reps, …]) | The Pauli Expansion circuit. | -| [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap#qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap")(feature\_dimension\[, reps, …]) | The first order Pauli Z-evolution circuit. | -| [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap#qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap")(feature\_dimension\[, reps, …]) | Second-order Pauli-Z evolution circuit. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | +| [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap")(\[feature\_dimension, reps, …]) | The Pauli Expansion circuit. | +| [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap")(feature\_dimension\[, reps, …]) | The first order Pauli Z-evolution circuit. | +| [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap")(feature\_dimension\[, reps, …]) | Second-order Pauli-Z evolution circuit. | ### NCT (Not-CNOT-Toffoli) template circuits -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`templates.nct.template_nct_2a_1`](qiskit.circuit.library.templates.nct.template_nct_2a_1#qiskit.circuit.library.templates.nct.template_nct_2a_1 "qiskit.circuit.library.templates.nct.template_nct_2a_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_2a_2`](qiskit.circuit.library.templates.nct.template_nct_2a_2#qiskit.circuit.library.templates.nct.template_nct_2a_2 "qiskit.circuit.library.templates.nct.template_nct_2a_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_2a_3`](qiskit.circuit.library.templates.nct.template_nct_2a_3#qiskit.circuit.library.templates.nct.template_nct_2a_3 "qiskit.circuit.library.templates.nct.template_nct_2a_3")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_4a_1`](qiskit.circuit.library.templates.nct.template_nct_4a_1#qiskit.circuit.library.templates.nct.template_nct_4a_1 "qiskit.circuit.library.templates.nct.template_nct_4a_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_4a_2`](qiskit.circuit.library.templates.nct.template_nct_4a_2#qiskit.circuit.library.templates.nct.template_nct_4a_2 "qiskit.circuit.library.templates.nct.template_nct_4a_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_4a_3`](qiskit.circuit.library.templates.nct.template_nct_4a_3#qiskit.circuit.library.templates.nct.template_nct_4a_3 "qiskit.circuit.library.templates.nct.template_nct_4a_3")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_4b_1`](qiskit.circuit.library.templates.nct.template_nct_4b_1#qiskit.circuit.library.templates.nct.template_nct_4b_1 "qiskit.circuit.library.templates.nct.template_nct_4b_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_4b_2`](qiskit.circuit.library.templates.nct.template_nct_4b_2#qiskit.circuit.library.templates.nct.template_nct_4b_2 "qiskit.circuit.library.templates.nct.template_nct_4b_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_5a_1`](qiskit.circuit.library.templates.nct.template_nct_5a_1#qiskit.circuit.library.templates.nct.template_nct_5a_1 "qiskit.circuit.library.templates.nct.template_nct_5a_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_5a_2`](qiskit.circuit.library.templates.nct.template_nct_5a_2#qiskit.circuit.library.templates.nct.template_nct_5a_2 "qiskit.circuit.library.templates.nct.template_nct_5a_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_5a_3`](qiskit.circuit.library.templates.nct.template_nct_5a_3#qiskit.circuit.library.templates.nct.template_nct_5a_3 "qiskit.circuit.library.templates.nct.template_nct_5a_3")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_5a_4`](qiskit.circuit.library.templates.nct.template_nct_5a_4#qiskit.circuit.library.templates.nct.template_nct_5a_4 "qiskit.circuit.library.templates.nct.template_nct_5a_4")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_6a_1`](qiskit.circuit.library.templates.nct.template_nct_6a_1#qiskit.circuit.library.templates.nct.template_nct_6a_1 "qiskit.circuit.library.templates.nct.template_nct_6a_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_6a_2`](qiskit.circuit.library.templates.nct.template_nct_6a_2#qiskit.circuit.library.templates.nct.template_nct_6a_2 "qiskit.circuit.library.templates.nct.template_nct_6a_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_6a_3`](qiskit.circuit.library.templates.nct.template_nct_6a_3#qiskit.circuit.library.templates.nct.template_nct_6a_3 "qiskit.circuit.library.templates.nct.template_nct_6a_3")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_6a_4`](qiskit.circuit.library.templates.nct.template_nct_6a_4#qiskit.circuit.library.templates.nct.template_nct_6a_4 "qiskit.circuit.library.templates.nct.template_nct_6a_4")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_6b_1`](qiskit.circuit.library.templates.nct.template_nct_6b_1#qiskit.circuit.library.templates.nct.template_nct_6b_1 "qiskit.circuit.library.templates.nct.template_nct_6b_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_6b_2`](qiskit.circuit.library.templates.nct.template_nct_6b_2#qiskit.circuit.library.templates.nct.template_nct_6b_2 "qiskit.circuit.library.templates.nct.template_nct_6b_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_6c_1`](qiskit.circuit.library.templates.nct.template_nct_6c_1#qiskit.circuit.library.templates.nct.template_nct_6c_1 "qiskit.circuit.library.templates.nct.template_nct_6c_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_7a_1`](qiskit.circuit.library.templates.nct.template_nct_7a_1#qiskit.circuit.library.templates.nct.template_nct_7a_1 "qiskit.circuit.library.templates.nct.template_nct_7a_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_7b_1`](qiskit.circuit.library.templates.nct.template_nct_7b_1#qiskit.circuit.library.templates.nct.template_nct_7b_1 "qiskit.circuit.library.templates.nct.template_nct_7b_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_7c_1`](qiskit.circuit.library.templates.nct.template_nct_7c_1#qiskit.circuit.library.templates.nct.template_nct_7c_1 "qiskit.circuit.library.templates.nct.template_nct_7c_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_7d_1`](qiskit.circuit.library.templates.nct.template_nct_7d_1#qiskit.circuit.library.templates.nct.template_nct_7d_1 "qiskit.circuit.library.templates.nct.template_nct_7d_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_7e_1`](qiskit.circuit.library.templates.nct.template_nct_7e_1#qiskit.circuit.library.templates.nct.template_nct_7e_1 "qiskit.circuit.library.templates.nct.template_nct_7e_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_2a_1`](qiskit.circuit.library.templates.nct.template_nct_2a_1#qiskit.circuit.library.templates.nct.template_nct_2a_1 "qiskit.circuit.library.templates.nct.template_nct_2a_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9a_1`](qiskit.circuit.library.templates.nct.template_nct_9a_1#qiskit.circuit.library.templates.nct.template_nct_9a_1 "qiskit.circuit.library.templates.nct.template_nct_9a_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_1`](qiskit.circuit.library.templates.nct.template_nct_9c_1#qiskit.circuit.library.templates.nct.template_nct_9c_1 "qiskit.circuit.library.templates.nct.template_nct_9c_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_2`](qiskit.circuit.library.templates.nct.template_nct_9c_2#qiskit.circuit.library.templates.nct.template_nct_9c_2 "qiskit.circuit.library.templates.nct.template_nct_9c_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_3`](qiskit.circuit.library.templates.nct.template_nct_9c_3#qiskit.circuit.library.templates.nct.template_nct_9c_3 "qiskit.circuit.library.templates.nct.template_nct_9c_3")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_4`](qiskit.circuit.library.templates.nct.template_nct_9c_4#qiskit.circuit.library.templates.nct.template_nct_9c_4 "qiskit.circuit.library.templates.nct.template_nct_9c_4")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_5`](qiskit.circuit.library.templates.nct.template_nct_9c_5#qiskit.circuit.library.templates.nct.template_nct_9c_5 "qiskit.circuit.library.templates.nct.template_nct_9c_5")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_6`](qiskit.circuit.library.templates.nct.template_nct_9c_6#qiskit.circuit.library.templates.nct.template_nct_9c_6 "qiskit.circuit.library.templates.nct.template_nct_9c_6")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_7`](qiskit.circuit.library.templates.nct.template_nct_9c_7#qiskit.circuit.library.templates.nct.template_nct_9c_7 "qiskit.circuit.library.templates.nct.template_nct_9c_7")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_8`](qiskit.circuit.library.templates.nct.template_nct_9c_8#qiskit.circuit.library.templates.nct.template_nct_9c_8 "qiskit.circuit.library.templates.nct.template_nct_9c_8")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_9`](qiskit.circuit.library.templates.nct.template_nct_9c_9#qiskit.circuit.library.templates.nct.template_nct_9c_9 "qiskit.circuit.library.templates.nct.template_nct_9c_9")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_10`](qiskit.circuit.library.templates.nct.template_nct_9c_10#qiskit.circuit.library.templates.nct.template_nct_9c_10 "qiskit.circuit.library.templates.nct.template_nct_9c_10")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_11`](qiskit.circuit.library.templates.nct.template_nct_9c_11#qiskit.circuit.library.templates.nct.template_nct_9c_11 "qiskit.circuit.library.templates.nct.template_nct_9c_11")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9c_12`](qiskit.circuit.library.templates.nct.template_nct_9c_12#qiskit.circuit.library.templates.nct.template_nct_9c_12 "qiskit.circuit.library.templates.nct.template_nct_9c_12")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_1`](qiskit.circuit.library.templates.nct.template_nct_9d_1#qiskit.circuit.library.templates.nct.template_nct_9d_1 "qiskit.circuit.library.templates.nct.template_nct_9d_1")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_2`](qiskit.circuit.library.templates.nct.template_nct_9d_2#qiskit.circuit.library.templates.nct.template_nct_9d_2 "qiskit.circuit.library.templates.nct.template_nct_9d_2")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_3`](qiskit.circuit.library.templates.nct.template_nct_9d_3#qiskit.circuit.library.templates.nct.template_nct_9d_3 "qiskit.circuit.library.templates.nct.template_nct_9d_3")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_4`](qiskit.circuit.library.templates.nct.template_nct_9d_4#qiskit.circuit.library.templates.nct.template_nct_9d_4 "qiskit.circuit.library.templates.nct.template_nct_9d_4")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_5`](qiskit.circuit.library.templates.nct.template_nct_9d_5#qiskit.circuit.library.templates.nct.template_nct_9d_5 "qiskit.circuit.library.templates.nct.template_nct_9d_5")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_6`](qiskit.circuit.library.templates.nct.template_nct_9d_6#qiskit.circuit.library.templates.nct.template_nct_9d_6 "qiskit.circuit.library.templates.nct.template_nct_9d_6")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_7`](qiskit.circuit.library.templates.nct.template_nct_9d_7#qiskit.circuit.library.templates.nct.template_nct_9d_7 "qiskit.circuit.library.templates.nct.template_nct_9d_7")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_8`](qiskit.circuit.library.templates.nct.template_nct_9d_8#qiskit.circuit.library.templates.nct.template_nct_9d_8 "qiskit.circuit.library.templates.nct.template_nct_9d_8")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_9`](qiskit.circuit.library.templates.nct.template_nct_9d_9#qiskit.circuit.library.templates.nct.template_nct_9d_9 "qiskit.circuit.library.templates.nct.template_nct_9d_9")() | **returns**template as a quantum circuit. | -| [`templates.nct.template_nct_9d_10`](qiskit.circuit.library.templates.nct.template_nct_9d_10#qiskit.circuit.library.templates.nct.template_nct_9d_10 "qiskit.circuit.library.templates.nct.template_nct_9d_10")() | **returns**template as a quantum circuit. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| [`templates.nct.template_nct_2a_1`](qiskit.circuit.library.templates.nct.template_nct_2a_1 "qiskit.circuit.library.templates.nct.template_nct_2a_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_2a_2`](qiskit.circuit.library.templates.nct.template_nct_2a_2 "qiskit.circuit.library.templates.nct.template_nct_2a_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_2a_3`](qiskit.circuit.library.templates.nct.template_nct_2a_3 "qiskit.circuit.library.templates.nct.template_nct_2a_3")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_4a_1`](qiskit.circuit.library.templates.nct.template_nct_4a_1 "qiskit.circuit.library.templates.nct.template_nct_4a_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_4a_2`](qiskit.circuit.library.templates.nct.template_nct_4a_2 "qiskit.circuit.library.templates.nct.template_nct_4a_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_4a_3`](qiskit.circuit.library.templates.nct.template_nct_4a_3 "qiskit.circuit.library.templates.nct.template_nct_4a_3")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_4b_1`](qiskit.circuit.library.templates.nct.template_nct_4b_1 "qiskit.circuit.library.templates.nct.template_nct_4b_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_4b_2`](qiskit.circuit.library.templates.nct.template_nct_4b_2 "qiskit.circuit.library.templates.nct.template_nct_4b_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_5a_1`](qiskit.circuit.library.templates.nct.template_nct_5a_1 "qiskit.circuit.library.templates.nct.template_nct_5a_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_5a_2`](qiskit.circuit.library.templates.nct.template_nct_5a_2 "qiskit.circuit.library.templates.nct.template_nct_5a_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_5a_3`](qiskit.circuit.library.templates.nct.template_nct_5a_3 "qiskit.circuit.library.templates.nct.template_nct_5a_3")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_5a_4`](qiskit.circuit.library.templates.nct.template_nct_5a_4 "qiskit.circuit.library.templates.nct.template_nct_5a_4")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_6a_1`](qiskit.circuit.library.templates.nct.template_nct_6a_1 "qiskit.circuit.library.templates.nct.template_nct_6a_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_6a_2`](qiskit.circuit.library.templates.nct.template_nct_6a_2 "qiskit.circuit.library.templates.nct.template_nct_6a_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_6a_3`](qiskit.circuit.library.templates.nct.template_nct_6a_3 "qiskit.circuit.library.templates.nct.template_nct_6a_3")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_6a_4`](qiskit.circuit.library.templates.nct.template_nct_6a_4 "qiskit.circuit.library.templates.nct.template_nct_6a_4")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_6b_1`](qiskit.circuit.library.templates.nct.template_nct_6b_1 "qiskit.circuit.library.templates.nct.template_nct_6b_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_6b_2`](qiskit.circuit.library.templates.nct.template_nct_6b_2 "qiskit.circuit.library.templates.nct.template_nct_6b_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_6c_1`](qiskit.circuit.library.templates.nct.template_nct_6c_1 "qiskit.circuit.library.templates.nct.template_nct_6c_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_7a_1`](qiskit.circuit.library.templates.nct.template_nct_7a_1 "qiskit.circuit.library.templates.nct.template_nct_7a_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_7b_1`](qiskit.circuit.library.templates.nct.template_nct_7b_1 "qiskit.circuit.library.templates.nct.template_nct_7b_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_7c_1`](qiskit.circuit.library.templates.nct.template_nct_7c_1 "qiskit.circuit.library.templates.nct.template_nct_7c_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_7d_1`](qiskit.circuit.library.templates.nct.template_nct_7d_1 "qiskit.circuit.library.templates.nct.template_nct_7d_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_7e_1`](qiskit.circuit.library.templates.nct.template_nct_7e_1 "qiskit.circuit.library.templates.nct.template_nct_7e_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_2a_1`](qiskit.circuit.library.templates.nct.template_nct_2a_1 "qiskit.circuit.library.templates.nct.template_nct_2a_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9a_1`](qiskit.circuit.library.templates.nct.template_nct_9a_1 "qiskit.circuit.library.templates.nct.template_nct_9a_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_1`](qiskit.circuit.library.templates.nct.template_nct_9c_1 "qiskit.circuit.library.templates.nct.template_nct_9c_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_2`](qiskit.circuit.library.templates.nct.template_nct_9c_2 "qiskit.circuit.library.templates.nct.template_nct_9c_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_3`](qiskit.circuit.library.templates.nct.template_nct_9c_3 "qiskit.circuit.library.templates.nct.template_nct_9c_3")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_4`](qiskit.circuit.library.templates.nct.template_nct_9c_4 "qiskit.circuit.library.templates.nct.template_nct_9c_4")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_5`](qiskit.circuit.library.templates.nct.template_nct_9c_5 "qiskit.circuit.library.templates.nct.template_nct_9c_5")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_6`](qiskit.circuit.library.templates.nct.template_nct_9c_6 "qiskit.circuit.library.templates.nct.template_nct_9c_6")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_7`](qiskit.circuit.library.templates.nct.template_nct_9c_7 "qiskit.circuit.library.templates.nct.template_nct_9c_7")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_8`](qiskit.circuit.library.templates.nct.template_nct_9c_8 "qiskit.circuit.library.templates.nct.template_nct_9c_8")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_9`](qiskit.circuit.library.templates.nct.template_nct_9c_9 "qiskit.circuit.library.templates.nct.template_nct_9c_9")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_10`](qiskit.circuit.library.templates.nct.template_nct_9c_10 "qiskit.circuit.library.templates.nct.template_nct_9c_10")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_11`](qiskit.circuit.library.templates.nct.template_nct_9c_11 "qiskit.circuit.library.templates.nct.template_nct_9c_11")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9c_12`](qiskit.circuit.library.templates.nct.template_nct_9c_12 "qiskit.circuit.library.templates.nct.template_nct_9c_12")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_1`](qiskit.circuit.library.templates.nct.template_nct_9d_1 "qiskit.circuit.library.templates.nct.template_nct_9d_1")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_2`](qiskit.circuit.library.templates.nct.template_nct_9d_2 "qiskit.circuit.library.templates.nct.template_nct_9d_2")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_3`](qiskit.circuit.library.templates.nct.template_nct_9d_3 "qiskit.circuit.library.templates.nct.template_nct_9d_3")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_4`](qiskit.circuit.library.templates.nct.template_nct_9d_4 "qiskit.circuit.library.templates.nct.template_nct_9d_4")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_5`](qiskit.circuit.library.templates.nct.template_nct_9d_5 "qiskit.circuit.library.templates.nct.template_nct_9d_5")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_6`](qiskit.circuit.library.templates.nct.template_nct_9d_6 "qiskit.circuit.library.templates.nct.template_nct_9d_6")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_7`](qiskit.circuit.library.templates.nct.template_nct_9d_7 "qiskit.circuit.library.templates.nct.template_nct_9d_7")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_8`](qiskit.circuit.library.templates.nct.template_nct_9d_8 "qiskit.circuit.library.templates.nct.template_nct_9d_8")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_9`](qiskit.circuit.library.templates.nct.template_nct_9d_9 "qiskit.circuit.library.templates.nct.template_nct_9d_9")() | **returns**template as a quantum circuit. | +| [`templates.nct.template_nct_9d_10`](qiskit.circuit.library.templates.nct.template_nct_9d_10 "qiskit.circuit.library.templates.nct.template_nct_9d_10")() | **returns**template as a quantum circuit. | ### Clifford template circuits -| | | -| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`clifford_2_1`](qiskit.circuit.library.clifford_2_1#qiskit.circuit.library.clifford_2_1 "qiskit.circuit.library.clifford_2_1")() | **returns**template as a quantum circuit. | -| [`clifford_2_2`](qiskit.circuit.library.clifford_2_2#qiskit.circuit.library.clifford_2_2 "qiskit.circuit.library.clifford_2_2")() | **returns**template as a quantum circuit. | -| [`clifford_2_3`](qiskit.circuit.library.clifford_2_3#qiskit.circuit.library.clifford_2_3 "qiskit.circuit.library.clifford_2_3")() | **returns**template as a quantum circuit. | -| [`clifford_2_4`](qiskit.circuit.library.clifford_2_4#qiskit.circuit.library.clifford_2_4 "qiskit.circuit.library.clifford_2_4")() | **returns**template as a quantum circuit. | -| [`clifford_3_1`](qiskit.circuit.library.clifford_3_1#qiskit.circuit.library.clifford_3_1 "qiskit.circuit.library.clifford_3_1")() | **returns**template as a quantum circuit. | -| [`clifford_4_1`](qiskit.circuit.library.clifford_4_1#qiskit.circuit.library.clifford_4_1 "qiskit.circuit.library.clifford_4_1")() | **returns**template as a quantum circuit. | -| [`clifford_4_2`](qiskit.circuit.library.clifford_4_2#qiskit.circuit.library.clifford_4_2 "qiskit.circuit.library.clifford_4_2")() | **returns**template as a quantum circuit. | -| [`clifford_4_3`](qiskit.circuit.library.clifford_4_3#qiskit.circuit.library.clifford_4_3 "qiskit.circuit.library.clifford_4_3")() | **returns**template as a quantum circuit. | -| [`clifford_4_4`](qiskit.circuit.library.clifford_4_4#qiskit.circuit.library.clifford_4_4 "qiskit.circuit.library.clifford_4_4")() | **returns**template as a quantum circuit. | -| [`clifford_5_1`](qiskit.circuit.library.clifford_5_1#qiskit.circuit.library.clifford_5_1 "qiskit.circuit.library.clifford_5_1")() | **returns**template as a quantum circuit. | -| [`clifford_6_1`](qiskit.circuit.library.clifford_6_1#qiskit.circuit.library.clifford_6_1 "qiskit.circuit.library.clifford_6_1")() | **returns**template as a quantum circuit. | -| [`clifford_6_2`](qiskit.circuit.library.clifford_6_2#qiskit.circuit.library.clifford_6_2 "qiskit.circuit.library.clifford_6_2")() | **returns**template as a quantum circuit. | -| [`clifford_6_3`](qiskit.circuit.library.clifford_6_3#qiskit.circuit.library.clifford_6_3 "qiskit.circuit.library.clifford_6_3")() | **returns**template as a quantum circuit. | -| [`clifford_6_4`](qiskit.circuit.library.clifford_6_4#qiskit.circuit.library.clifford_6_4 "qiskit.circuit.library.clifford_6_4")() | **returns**template as a quantum circuit. | -| [`clifford_6_5`](qiskit.circuit.library.clifford_6_5#qiskit.circuit.library.clifford_6_5 "qiskit.circuit.library.clifford_6_5")() | **returns**template as a quantum circuit. | -| [`clifford_8_1`](qiskit.circuit.library.clifford_8_1#qiskit.circuit.library.clifford_8_1 "qiskit.circuit.library.clifford_8_1")() | **returns**template as a quantum circuit. | -| [`clifford_8_2`](qiskit.circuit.library.clifford_8_2#qiskit.circuit.library.clifford_8_2 "qiskit.circuit.library.clifford_8_2")() | **returns**template as a quantum circuit. | -| [`clifford_8_3`](qiskit.circuit.library.clifford_8_3#qiskit.circuit.library.clifford_8_3 "qiskit.circuit.library.clifford_8_3")() | **returns**template as a quantum circuit. | +| | | +| --------------------------------------------------------------------------------------------- | ----------------------------------------- | +| [`clifford_2_1`](qiskit.circuit.library.clifford_2_1 "qiskit.circuit.library.clifford_2_1")() | **returns**template as a quantum circuit. | +| [`clifford_2_2`](qiskit.circuit.library.clifford_2_2 "qiskit.circuit.library.clifford_2_2")() | **returns**template as a quantum circuit. | +| [`clifford_2_3`](qiskit.circuit.library.clifford_2_3 "qiskit.circuit.library.clifford_2_3")() | **returns**template as a quantum circuit. | +| [`clifford_2_4`](qiskit.circuit.library.clifford_2_4 "qiskit.circuit.library.clifford_2_4")() | **returns**template as a quantum circuit. | +| [`clifford_3_1`](qiskit.circuit.library.clifford_3_1 "qiskit.circuit.library.clifford_3_1")() | **returns**template as a quantum circuit. | +| [`clifford_4_1`](qiskit.circuit.library.clifford_4_1 "qiskit.circuit.library.clifford_4_1")() | **returns**template as a quantum circuit. | +| [`clifford_4_2`](qiskit.circuit.library.clifford_4_2 "qiskit.circuit.library.clifford_4_2")() | **returns**template as a quantum circuit. | +| [`clifford_4_3`](qiskit.circuit.library.clifford_4_3 "qiskit.circuit.library.clifford_4_3")() | **returns**template as a quantum circuit. | +| [`clifford_4_4`](qiskit.circuit.library.clifford_4_4 "qiskit.circuit.library.clifford_4_4")() | **returns**template as a quantum circuit. | +| [`clifford_5_1`](qiskit.circuit.library.clifford_5_1 "qiskit.circuit.library.clifford_5_1")() | **returns**template as a quantum circuit. | +| [`clifford_6_1`](qiskit.circuit.library.clifford_6_1 "qiskit.circuit.library.clifford_6_1")() | **returns**template as a quantum circuit. | +| [`clifford_6_2`](qiskit.circuit.library.clifford_6_2 "qiskit.circuit.library.clifford_6_2")() | **returns**template as a quantum circuit. | +| [`clifford_6_3`](qiskit.circuit.library.clifford_6_3 "qiskit.circuit.library.clifford_6_3")() | **returns**template as a quantum circuit. | +| [`clifford_6_4`](qiskit.circuit.library.clifford_6_4 "qiskit.circuit.library.clifford_6_4")() | **returns**template as a quantum circuit. | +| [`clifford_6_5`](qiskit.circuit.library.clifford_6_5 "qiskit.circuit.library.clifford_6_5")() | **returns**template as a quantum circuit. | +| [`clifford_8_1`](qiskit.circuit.library.clifford_8_1 "qiskit.circuit.library.clifford_8_1")() | **returns**template as a quantum circuit. | +| [`clifford_8_2`](qiskit.circuit.library.clifford_8_2 "qiskit.circuit.library.clifford_8_2")() | **returns**template as a quantum circuit. | +| [`clifford_8_3`](qiskit.circuit.library.clifford_8_3 "qiskit.circuit.library.clifford_8_3")() | **returns**template as a quantum circuit. | ### RZXGate template circuits -| | | -| --------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`rzx_yz`](qiskit.circuit.library.rzx_yz#qiskit.circuit.library.rzx_yz "qiskit.circuit.library.rzx_yz")(\[theta]) | Template for CX - RYGate - CX. | -| [`rzx_xz`](qiskit.circuit.library.rzx_xz#qiskit.circuit.library.rzx_xz "qiskit.circuit.library.rzx_xz")(\[theta]) | Template for CX - RXGate - CX. | -| [`rzx_cy`](qiskit.circuit.library.rzx_cy#qiskit.circuit.library.rzx_cy "qiskit.circuit.library.rzx_cy")(\[theta]) | Template for CX - RYGate - CX. | -| [`rzx_zz1`](qiskit.circuit.library.rzx_zz1#qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | -| [`rzx_zz2`](qiskit.circuit.library.rzx_zz2#qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | -| [`rzx_zz3`](qiskit.circuit.library.rzx_zz3#qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | +| | | +| -------------------------------------------------------------------------------------- | ------------------------------ | +| [`rzx_yz`](qiskit.circuit.library.rzx_yz "qiskit.circuit.library.rzx_yz")(\[theta]) | Template for CX - RYGate - CX. | +| [`rzx_xz`](qiskit.circuit.library.rzx_xz "qiskit.circuit.library.rzx_xz")(\[theta]) | Template for CX - RXGate - CX. | +| [`rzx_cy`](qiskit.circuit.library.rzx_cy "qiskit.circuit.library.rzx_cy")(\[theta]) | Template for CX - RYGate - CX. | +| [`rzx_zz1`](qiskit.circuit.library.rzx_zz1 "qiskit.circuit.library.rzx_zz1")(\[theta]) | Template for CX - RZGate - CX. | +| [`rzx_zz2`](qiskit.circuit.library.rzx_zz2 "qiskit.circuit.library.rzx_zz2")(\[theta]) | Template for CX - RZGate - CX. | +| [`rzx_zz3`](qiskit.circuit.library.rzx_zz3 "qiskit.circuit.library.rzx_zz3")(\[theta]) | Template for CX - RZGate - CX. | diff --git a/docs/api/qiskit/0.32/classicalfunction.md b/docs/api/qiskit/0.32/classicalfunction.md index 67656e8656f..6f9dcfa9071 100644 --- a/docs/api/qiskit/0.32/classicalfunction.md +++ b/docs/api/qiskit/0.32/classicalfunction.md @@ -67,16 +67,16 @@ Decorator for a classical function that returns a ClassicalFunction object. ### ClassicalFunction -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | -| [`ClassicalFunction`](qiskit.circuit.classicalfunction.ClassicalFunction#qiskit.circuit.classicalfunction.ClassicalFunction "qiskit.circuit.classicalfunction.ClassicalFunction")(source\[, name]) | Represent a classical function function and its logic network. | -| [`BooleanExpression`](qiskit.circuit.classicalfunction.BooleanExpression#qiskit.circuit.classicalfunction.BooleanExpression "qiskit.circuit.classicalfunction.BooleanExpression")(expression\[, name]) | The Boolean Expression gate. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| [`ClassicalFunction`](qiskit.circuit.classicalfunction.ClassicalFunction "qiskit.circuit.classicalfunction.ClassicalFunction")(source\[, name]) | Represent a classical function function and its logic network. | +| [`BooleanExpression`](qiskit.circuit.classicalfunction.BooleanExpression "qiskit.circuit.classicalfunction.BooleanExpression")(expression\[, name]) | The Boolean Expression gate. | ### Exceptions -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`ClassicalFunctionCompilerTypeError`](qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError#qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError "qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError")(\*message) | ClassicalFunction compiler type error. | -| [`ClassicalFunctionParseError`](qiskit.circuit.classicalfunction.ClassicalFunctionParseError#qiskit.circuit.classicalfunction.ClassicalFunctionParseError "qiskit.circuit.classicalfunction.ClassicalFunctionParseError")(\*message) | ClassicalFunction compiler parse error. | -| [`ClassicalFunctionCompilerTypeError`](qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError#qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError "qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError")(\*message) | ClassicalFunction compiler type error. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| [`ClassicalFunctionCompilerTypeError`](qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError "qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError")(\*message) | ClassicalFunction compiler type error. | +| [`ClassicalFunctionParseError`](qiskit.circuit.classicalfunction.ClassicalFunctionParseError "qiskit.circuit.classicalfunction.ClassicalFunctionParseError")(\*message) | ClassicalFunction compiler parse error. | +| [`ClassicalFunctionCompilerTypeError`](qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError "qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError")(\*message) | ClassicalFunction compiler type error. | diff --git a/docs/api/qiskit/0.32/compiler.md b/docs/api/qiskit/0.32/compiler.md index dd1b4eae366..00c54abe362 100644 --- a/docs/api/qiskit/0.32/compiler.md +++ b/docs/api/qiskit/0.32/compiler.md @@ -18,10 +18,10 @@ python_api_name: qiskit.compiler ## Circuit and Pulse Compilation Functions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | -| [`assemble`](qiskit.compiler.assemble#qiskit.compiler.assemble "qiskit.compiler.assemble")(experiments\[, backend, qobj\_id, …]) | Assemble a list of circuits or pulse schedules into a `Qobj`. | -| [`schedule`](qiskit.compiler.schedule#qiskit.compiler.schedule "qiskit.compiler.schedule")(circuits\[, backend, inst\_map, …]) | Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. | -| [`transpile`](qiskit.compiler.transpile#qiskit.compiler.transpile "qiskit.compiler.transpile")(circuits\[, backend, basis\_gates, …]) | Transpile one or more circuits, according to some desired transpilation targets. | -| [`sequence`](qiskit.compiler.sequence#qiskit.compiler.sequence "qiskit.compiler.sequence")(scheduled\_circuits\[, backend, …]) | Schedule a scheduled circuit to a pulse `Schedule`, using the backend. | +| | | +| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | +| [`assemble`](qiskit.compiler.assemble "qiskit.compiler.assemble")(experiments\[, backend, qobj\_id, …]) | Assemble a list of circuits or pulse schedules into a `Qobj`. | +| [`schedule`](qiskit.compiler.schedule "qiskit.compiler.schedule")(circuits\[, backend, inst\_map, …]) | Schedule a circuit to a pulse `Schedule`, using the backend, according to any specified methods. | +| [`transpile`](qiskit.compiler.transpile "qiskit.compiler.transpile")(circuits\[, backend, basis\_gates, …]) | Transpile one or more circuits, according to some desired transpilation targets. | +| [`sequence`](qiskit.compiler.sequence "qiskit.compiler.sequence")(scheduled\_circuits\[, backend, …]) | Schedule a scheduled circuit to a pulse `Schedule`, using the backend. | diff --git a/docs/api/qiskit/0.32/converters.md b/docs/api/qiskit/0.32/converters.md index 44bd9ec0b3d..94dffedf7b4 100644 --- a/docs/api/qiskit/0.32/converters.md +++ b/docs/api/qiskit/0.32/converters.md @@ -16,15 +16,15 @@ python_api_name: qiskit.converters `qiskit.converters` -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`circuit_to_dag`](qiskit.converters.circuit_to_dag#qiskit.converters.circuit_to_dag "qiskit.converters.circuit_to_dag")(circuit) | Build a `DAGCircuit` object from a `QuantumCircuit`. | -| [`dag_to_circuit`](qiskit.converters.dag_to_circuit#qiskit.converters.dag_to_circuit "qiskit.converters.dag_to_circuit")(dag) | Build a `QuantumCircuit` object from a `DAGCircuit`. | -| [`circuit_to_instruction`](qiskit.converters.circuit_to_instruction#qiskit.converters.circuit_to_instruction "qiskit.converters.circuit_to_instruction")(circuit\[, …]) | Build an `Instruction` object from a `QuantumCircuit`. | -| [`circuit_to_gate`](qiskit.converters.circuit_to_gate#qiskit.converters.circuit_to_gate "qiskit.converters.circuit_to_gate")(circuit\[, parameter\_map, …]) | Build a `Gate` object from a `QuantumCircuit`. | -| [`ast_to_dag`](qiskit.converters.ast_to_dag#qiskit.converters.ast_to_dag "qiskit.converters.ast_to_dag")(ast) | Build a `DAGCircuit` object from an AST `Node` object. | -| [`dagdependency_to_circuit`](qiskit.converters.dagdependency_to_circuit#qiskit.converters.dagdependency_to_circuit "qiskit.converters.dagdependency_to_circuit")(dagdependency) | Build a `QuantumCircuit` object from a `DAGDependency`. | -| [`circuit_to_dagdependency`](qiskit.converters.circuit_to_dagdependency#qiskit.converters.circuit_to_dagdependency "qiskit.converters.circuit_to_dagdependency")(circuit) | Build a `DAGDependency` object from a `QuantumCircuit`. | -| [`dag_to_dagdependency`](qiskit.converters.dag_to_dagdependency#qiskit.converters.dag_to_dagdependency "qiskit.converters.dag_to_dagdependency")(dag) | Build a `DAGDependency` object from a `DAGCircuit`. | -| [`dagdependency_to_dag`](qiskit.converters.dagdependency_to_dag#qiskit.converters.dagdependency_to_dag "qiskit.converters.dagdependency_to_dag")(dagdependency) | Build a `DAGCircuit` object from a `DAGDependency`. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | +| [`circuit_to_dag`](qiskit.converters.circuit_to_dag "qiskit.converters.circuit_to_dag")(circuit) | Build a `DAGCircuit` object from a `QuantumCircuit`. | +| [`dag_to_circuit`](qiskit.converters.dag_to_circuit "qiskit.converters.dag_to_circuit")(dag) | Build a `QuantumCircuit` object from a `DAGCircuit`. | +| [`circuit_to_instruction`](qiskit.converters.circuit_to_instruction "qiskit.converters.circuit_to_instruction")(circuit\[, …]) | Build an `Instruction` object from a `QuantumCircuit`. | +| [`circuit_to_gate`](qiskit.converters.circuit_to_gate "qiskit.converters.circuit_to_gate")(circuit\[, parameter\_map, …]) | Build a `Gate` object from a `QuantumCircuit`. | +| [`ast_to_dag`](qiskit.converters.ast_to_dag "qiskit.converters.ast_to_dag")(ast) | Build a `DAGCircuit` object from an AST `Node` object. | +| [`dagdependency_to_circuit`](qiskit.converters.dagdependency_to_circuit "qiskit.converters.dagdependency_to_circuit")(dagdependency) | Build a `QuantumCircuit` object from a `DAGDependency`. | +| [`circuit_to_dagdependency`](qiskit.converters.circuit_to_dagdependency "qiskit.converters.circuit_to_dagdependency")(circuit) | Build a `DAGDependency` object from a `QuantumCircuit`. | +| [`dag_to_dagdependency`](qiskit.converters.dag_to_dagdependency "qiskit.converters.dag_to_dagdependency")(dag) | Build a `DAGDependency` object from a `DAGCircuit`. | +| [`dagdependency_to_dag`](qiskit.converters.dagdependency_to_dag "qiskit.converters.dagdependency_to_dag")(dagdependency) | Build a `DAGCircuit` object from a `DAGDependency`. | diff --git a/docs/api/qiskit/0.32/dagcircuit.md b/docs/api/qiskit/0.32/dagcircuit.md index af794a5d17f..83302d3a68c 100644 --- a/docs/api/qiskit/0.32/dagcircuit.md +++ b/docs/api/qiskit/0.32/dagcircuit.md @@ -18,16 +18,16 @@ python_api_name: qiskit.dagcircuit ## DAG Circuits -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. | -| [`DAGNode`](qiskit.dagcircuit.DAGNode#qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")(\[type, op, name, qargs, cargs, …]) | Object to represent the information at a node in the DAGCircuit. | -| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode#qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, …]) | Object to represent the information at a node in the DAGDependency(). | -| [`DAGDependency`](qiskit.dagcircuit.DAGDependency#qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")() | Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. | +| | | +| --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")() | Quantum circuit as a directed acyclic graph. | +| [`DAGNode`](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")(\[type, op, name, qargs, cargs, …]) | Object to represent the information at a node in the DAGCircuit. | +| [`DAGDepNode`](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")(\[type, op, name, qargs, cargs, …]) | Object to represent the information at a node in the DAGDependency(). | +| [`DAGDependency`](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")() | Object to represent a quantum circuit as a directed acyclic graph via operation dependencies (i.e. | ## Exceptions -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| [`DAGCircuitError`](qiskit.dagcircuit.DAGCircuitError#qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError")(\*msg) | Base class for errors raised by the DAGCircuit object. | +| | | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| [`DAGCircuitError`](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError")(\*msg) | Base class for errors raised by the DAGCircuit object. | diff --git a/docs/api/qiskit/0.32/execute.md b/docs/api/qiskit/0.32/execute.md index d4ef03e5849..ac35577da64 100644 --- a/docs/api/qiskit/0.32/execute.md +++ b/docs/api/qiskit/0.32/execute.md @@ -16,38 +16,38 @@ 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=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)` - -Execute a list of [`qiskit.circuit.QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") on a backend. +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. The execution is asynchronous, and a handle to a job instance is returned. **Parameters** -* **experiments** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] or* [*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or list\[*[*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]*) – Circuit(s) or pulse schedule(s) to execute +* **experiments** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*] or* [*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or list\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]*) – Circuit(s) or pulse schedule(s) to execute -* **backend** ([*BaseBackend*](qiskit.providers.BaseBackend#qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") *or*[*Backend*](qiskit.providers.Backend#qiskit.providers.Backend "qiskit.providers.Backend")) – Backend to execute circuits on. Transpiler options are automatically grabbed from backend.configuration() and backend.properties(). If any other option is explicitly set (e.g. coupling\_map), it will override the backend’s. +* **backend** ([*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") *or*[*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")) – Backend to execute circuits on. Transpiler options are automatically grabbed from backend.configuration() and backend.properties(). If any other option is explicitly set (e.g. coupling\_map), it will override the backend’s. * **basis\_gates** (*list\[str]*) – List of basis gate names to unroll to. e.g: `['u1', 'u2', 'u3', 'cx']` If `None`, do not unroll. -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *or list*) – +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") *or list*) – Coupling map (perhaps custom) to target in mapping. Multiple formats are supported: 1. CouplingMap instance 2. list Must be given as an adjacency matrix, where each entry specifies all two-qubit interactions supported by backend e.g: `[[0, 1], [0, 3], [1, 2], [1, 5], [2, 5], [4, 1], [5, 3]]` -* **backend\_properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Properties returned by a backend, including information on gate errors, readout errors, qubit coherence times, etc. Find a backend that provides this information with: `backend.properties()` +* **backend\_properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Properties returned by a backend, including information on gate errors, readout errors, qubit coherence times, etc. Find a backend that provides this information with: `backend.properties()` -* **initial\_layout** ([*Layout*](qiskit.transpiler.Layout#qiskit.transpiler.Layout "qiskit.transpiler.Layout") *or dict or list*) – +* **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout") *or dict or list*) – Initial position of virtual qubits on physical qubits. If this layout makes the circuit compatible with the coupling\_map constraints, it will be used. The final layout is not guaranteed to be the same, as the transpiler may permute qubits through swaps or other means. Multiple formats are supported: - 1. [`qiskit.transpiler.Layout`](qiskit.transpiler.Layout#qiskit.transpiler.Layout "qiskit.transpiler.Layout") instance + 1. [`qiskit.transpiler.Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout") instance 2. `dict`: virtual to physical: @@ -79,11 +79,11 @@ The execution is asynchronous, and a handle to a job instance is returned. * **optimization\_level** (*int*) – How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer transpilation time. #. No optimization #. Light optimization #. Heavy optimization #. Highest optimization If None, level 1 will be chosen as default. -* **pass\_manager** ([*PassManager*](qiskit.transpiler.PassManager#qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")) – The pass manager to use during transpilation. If this arg is present, auto-selection of pass manager based on the transpile options will be turned off and this pass manager will be used directly. +* **pass\_manager** ([*PassManager*](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")) – The pass manager to use during transpilation. If this arg is present, auto-selection of pass manager based on the transpile options will be turned off and this pass manager will be used directly. * **qobj\_id** (*str*) – String identifier to annotate the Qobj -* **qobj\_header** ([*QobjHeader*](qiskit.qobj.QobjHeader#qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader") *or dict*) – User input that will be inserted in Qobj header, and will also be copied to the corresponding [`qiskit.result.Result`](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result") header. Headers do not affect the run. +* **qobj\_header** ([*QobjHeader*](qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader") *or dict*) – User input that will be inserted in Qobj header, and will also be copied to the corresponding [`qiskit.result.Result`](qiskit.result.Result "qiskit.result.Result") header. Headers do not affect the run. * **shots** (*int*) – Number of repetitions of each circuit, for sampling. Default: 1024 @@ -123,9 +123,9 @@ The execution is asynchronous, and a handle to a job instance is returned. * **parameter\_binds** (*list\[dict]*) – List of Parameter bindings over which the set of experiments will be executed. Each list element (bind) should be of the form `{Parameter1: value1, Parameter2: value2, ...}`. All binds will be executed across all experiments, e.g. if parameter\_binds is a length-n list, and there are m experiments, a total of $m x n$ experiments will be run (one for each experiment/bind pair). -* **schedule\_circuit** (*bool*) – If `True`, `experiments` will be converted to [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects prior to execution. +* **schedule\_circuit** (*bool*) – If `True`, `experiments` will be converted to [`qiskit.pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects prior to execution. -* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap#qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – Mapping of circuit operations to pulse schedules. If None, defaults to the `instruction_schedule_map` of `backend`. +* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – Mapping of circuit operations to pulse schedules. If None, defaults to the `instruction_schedule_map` of `backend`. * **meas\_map** (*list(list(int))*) – List of sets of qubits that must be measured together. If None, defaults to the `meas_map` of `backend`. @@ -141,7 +141,7 @@ returns job instance derived from BaseJob **Return type** -[BaseJob](qiskit.providers.BaseJob#qiskit.providers.BaseJob "qiskit.providers.BaseJob") +[BaseJob](qiskit.providers.BaseJob "qiskit.providers.BaseJob") **Raises** diff --git a/docs/api/qiskit/0.32/extensions.md b/docs/api/qiskit/0.32/extensions.md index 6983e251fa4..392e5b11266 100644 --- a/docs/api/qiskit/0.32/extensions.md +++ b/docs/api/qiskit/0.32/extensions.md @@ -18,20 +18,20 @@ python_api_name: qiskit.extensions ## Unitary Extensions -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| [`UnitaryGate`](qiskit.extensions.UnitaryGate#qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate")(data\[, label]) | Class for representing unitary gates | -| [`HamiltonianGate`](qiskit.extensions.HamiltonianGate#qiskit.extensions.HamiltonianGate "qiskit.extensions.HamiltonianGate")(data, time\[, label]) | Class for representing evolution by a Hermitian Hamiltonian operator as a gate. | +| | | +| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| [`UnitaryGate`](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate")(data\[, label]) | Class for representing unitary gates | +| [`HamiltonianGate`](qiskit.extensions.HamiltonianGate "qiskit.extensions.HamiltonianGate")(data, time\[, label]) | Class for representing evolution by a Hermitian Hamiltonian operator as a gate. | ## Simulator Extensions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | -| [`Snapshot`](qiskit.extensions.Snapshot#qiskit.extensions.Snapshot "qiskit.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, …]) | Simulator snapshot instruction. | +| | | +| --------------------------------------------------------------------------------------------------------------- | ------------------------------- | +| [`Snapshot`](qiskit.extensions.Snapshot "qiskit.extensions.Snapshot")(label\[, snapshot\_type, num\_qubits, …]) | Simulator snapshot instruction. | ## Initialization -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`Initialize`](qiskit.extensions.Initialize#qiskit.extensions.Initialize "qiskit.extensions.Initialize")(params\[, num\_qubits]) | Complex amplitude initialization. | +| | | +| --------------------------------------------------------------------------------------------------- | --------------------------------- | +| [`Initialize`](qiskit.extensions.Initialize "qiskit.extensions.Initialize")(params\[, num\_qubits]) | Complex amplitude initialization. | diff --git a/docs/api/qiskit/0.32/ibmq_credentials.md b/docs/api/qiskit/0.32/ibmq_credentials.md index 870529f81a9..8c3388d813e 100644 --- a/docs/api/qiskit/0.32/ibmq_credentials.md +++ b/docs/api/qiskit/0.32/ibmq_credentials.md @@ -20,15 +20,15 @@ Utilities for working with IBM Quantum Experience account credentials. ## Classes -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`Credentials`](qiskit.providers.ibmq.credentials.Credentials#qiskit.providers.ibmq.credentials.Credentials "qiskit.providers.ibmq.credentials.Credentials")(token, url\[, websockets\_url, …]) | IBM Quantum Experience account credentials and preferences. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| [`Credentials`](qiskit.providers.ibmq.credentials.Credentials "qiskit.providers.ibmq.credentials.Credentials")(token, url\[, websockets\_url, …]) | IBM Quantum Experience account credentials and preferences. | ## Exceptions -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`CredentialsError`](qiskit.providers.ibmq.credentials.CredentialsError#qiskit.providers.ibmq.credentials.CredentialsError "qiskit.providers.ibmq.credentials.CredentialsError")(\*message) | Base class for errors raised during credential management. | -| [`InvalidCredentialsFormatError`](qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError#qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError "qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError")(\*message) | Errors raised when the credentials are in an invalid format. | -| [`CredentialsNotFoundError`](qiskit.providers.ibmq.credentials.CredentialsNotFoundError#qiskit.providers.ibmq.credentials.CredentialsNotFoundError "qiskit.providers.ibmq.credentials.CredentialsNotFoundError")(\*message) | Errors raised when the credentials are not found. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [`CredentialsError`](qiskit.providers.ibmq.credentials.CredentialsError "qiskit.providers.ibmq.credentials.CredentialsError")(\*message) | Base class for errors raised during credential management. | +| [`InvalidCredentialsFormatError`](qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError "qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError")(\*message) | Errors raised when the credentials are in an invalid format. | +| [`CredentialsNotFoundError`](qiskit.providers.ibmq.credentials.CredentialsNotFoundError "qiskit.providers.ibmq.credentials.CredentialsNotFoundError")(\*message) | Errors raised when the credentials are not found. | diff --git a/docs/api/qiskit/0.32/ibmq_experiment.md b/docs/api/qiskit/0.32/ibmq_experiment.md index 0e5a656eec5..583c14dffb3 100644 --- a/docs/api/qiskit/0.32/ibmq_experiment.md +++ b/docs/api/qiskit/0.32/ibmq_experiment.md @@ -30,23 +30,23 @@ provider = IBMQ.load_account() experiments = provider.experiment.experiments() ``` -All the available functions can be invoked using the provider.experiment attribute, which is an instance of the [`IBMExperimentService`](qiskit.providers.ibmq.experiment.IBMExperimentService#qiskit.providers.ibmq.experiment.IBMExperimentService "qiskit.providers.ibmq.experiment.IBMExperimentService") class. +All the available functions can be invoked using the provider.experiment attribute, which is an instance of the [`IBMExperimentService`](qiskit.providers.ibmq.experiment.IBMExperimentService "qiskit.providers.ibmq.experiment.IBMExperimentService") class. This service is intended to be used in conjunction with the `qiskit-experiments` package, which allows you to create different types of experiments (for example, `qiskit_experiments.library.characterization.T1`). ## Classes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`IBMExperimentService`](qiskit.providers.ibmq.experiment.IBMExperimentService#qiskit.providers.ibmq.experiment.IBMExperimentService "qiskit.providers.ibmq.experiment.IBMExperimentService")(provider) | Provides experiment related services. | -| [`ResultQuality`](qiskit.providers.ibmq.experiment.ResultQuality#qiskit.providers.ibmq.experiment.ResultQuality "qiskit.providers.ibmq.experiment.ResultQuality")(value) | Possible values for analysis result quality. | -| [`DeviceComponent`](qiskit.providers.ibmq.experiment.DeviceComponent#qiskit.providers.ibmq.experiment.DeviceComponent "qiskit.providers.ibmq.experiment.DeviceComponent")() | Class representing a device component. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| [`IBMExperimentService`](qiskit.providers.ibmq.experiment.IBMExperimentService "qiskit.providers.ibmq.experiment.IBMExperimentService")(provider) | Provides experiment related services. | +| [`ResultQuality`](qiskit.providers.ibmq.experiment.ResultQuality "qiskit.providers.ibmq.experiment.ResultQuality")(value) | Possible values for analysis result quality. | +| [`DeviceComponent`](qiskit.providers.ibmq.experiment.DeviceComponent "qiskit.providers.ibmq.experiment.DeviceComponent")() | Class representing a device component. | ## Exceptions -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| [`IBMExperimentError`](qiskit.providers.ibmq.experiment.IBMExperimentError#qiskit.providers.ibmq.experiment.IBMExperimentError "qiskit.providers.ibmq.experiment.IBMExperimentError")(\*message) | Base class for errors raised by the experiment service modules. | -| [`IBMExperimentEntryExists`](qiskit.providers.ibmq.experiment.IBMExperimentEntryExists#qiskit.providers.ibmq.experiment.IBMExperimentEntryExists "qiskit.providers.ibmq.experiment.IBMExperimentEntryExists")(\*message) | Errors raised when an experiment entry already exists. | -| [`IBMExperimentEntryNotFound`](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound#qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound")(\*message) | Errors raised when an experiment entry cannot be found. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| [`IBMExperimentError`](qiskit.providers.ibmq.experiment.IBMExperimentError "qiskit.providers.ibmq.experiment.IBMExperimentError")(\*message) | Base class for errors raised by the experiment service modules. | +| [`IBMExperimentEntryExists`](qiskit.providers.ibmq.experiment.IBMExperimentEntryExists "qiskit.providers.ibmq.experiment.IBMExperimentEntryExists")(\*message) | Errors raised when an experiment entry already exists. | +| [`IBMExperimentEntryNotFound`](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound")(\*message) | Errors raised when an experiment entry cannot be found. | diff --git a/docs/api/qiskit/0.32/ibmq_job.md b/docs/api/qiskit/0.32/ibmq_job.md index f6dc03c240b..ebaea11e2d8 100644 --- a/docs/api/qiskit/0.32/ibmq_job.md +++ b/docs/api/qiskit/0.32/ibmq_job.md @@ -20,24 +20,24 @@ Modules representing IBM Quantum Experience jobs. ## Classes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- | -| [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob#qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob")(backend, api\_client, job\_id, …\[, …]) | Representation of a job that executes on an IBM Quantum Experience backend. | -| [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo#qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.QueueInfo")(\[position, status, …]) | Queue information for a job. | +| | | +| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob")(backend, api\_client, job\_id, …\[, …]) | Representation of a job that executes on an IBM Quantum Experience backend. | +| [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.QueueInfo")(\[position, status, …]) | Queue information for a job. | ## Functions -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`job_monitor`](qiskit.providers.ibmq.job.job_monitor#qiskit.providers.ibmq.job.job_monitor "qiskit.providers.ibmq.job.job_monitor")(job\[, interval, output]) | Monitor the status of an `IBMQJob` instance. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | +| [`job_monitor`](qiskit.providers.ibmq.job.job_monitor "qiskit.providers.ibmq.job.job_monitor")(job\[, interval, output]) | Monitor the status of an `IBMQJob` instance. | ## Exception -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`IBMQJobError`](qiskit.providers.ibmq.job.IBMQJobError#qiskit.providers.ibmq.job.IBMQJobError "qiskit.providers.ibmq.job.IBMQJobError")(\*message) | Base class for errors raised by the job modules. | -| [`IBMQJobApiError`](qiskit.providers.ibmq.job.IBMQJobApiError#qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError")(\*message) | Errors that occur unexpectedly when querying the server. | -| [`IBMQJobFailureError`](qiskit.providers.ibmq.job.IBMQJobFailureError#qiskit.providers.ibmq.job.IBMQJobFailureError "qiskit.providers.ibmq.job.IBMQJobFailureError")(\*message) | Errors raised when a job failed. | -| [`IBMQJobInvalidStateError`](qiskit.providers.ibmq.job.IBMQJobInvalidStateError#qiskit.providers.ibmq.job.IBMQJobInvalidStateError "qiskit.providers.ibmq.job.IBMQJobInvalidStateError")(\*message) | Errors raised when a job is not in a valid state for the operation. | -| [`IBMQJobTimeoutError`](qiskit.providers.ibmq.job.IBMQJobTimeoutError#qiskit.providers.ibmq.job.IBMQJobTimeoutError "qiskit.providers.ibmq.job.IBMQJobTimeoutError")(\*message) | Errors raised when a job operation times out. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | +| [`IBMQJobError`](qiskit.providers.ibmq.job.IBMQJobError "qiskit.providers.ibmq.job.IBMQJobError")(\*message) | Base class for errors raised by the job modules. | +| [`IBMQJobApiError`](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError")(\*message) | Errors that occur unexpectedly when querying the server. | +| [`IBMQJobFailureError`](qiskit.providers.ibmq.job.IBMQJobFailureError "qiskit.providers.ibmq.job.IBMQJobFailureError")(\*message) | Errors raised when a job failed. | +| [`IBMQJobInvalidStateError`](qiskit.providers.ibmq.job.IBMQJobInvalidStateError "qiskit.providers.ibmq.job.IBMQJobInvalidStateError")(\*message) | Errors raised when a job is not in a valid state for the operation. | +| [`IBMQJobTimeoutError`](qiskit.providers.ibmq.job.IBMQJobTimeoutError "qiskit.providers.ibmq.job.IBMQJobTimeoutError")(\*message) | Errors raised when a job operation times out. | diff --git a/docs/api/qiskit/0.32/ibmq_managed.md b/docs/api/qiskit/0.32/ibmq_managed.md index 256abcef06d..7c475981255 100644 --- a/docs/api/qiskit/0.32/ibmq_managed.md +++ b/docs/api/qiskit/0.32/ibmq_managed.md @@ -20,21 +20,21 @@ High level mechanism for handling jobs. ## Classes -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`IBMQJobManager`](qiskit.providers.ibmq.managed.IBMQJobManager#qiskit.providers.ibmq.managed.IBMQJobManager "qiskit.providers.ibmq.managed.IBMQJobManager")() | Job Manager for IBM Quantum Experience. | -| [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet#qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet")(\[name, short\_id]) | A set of managed jobs. | -| [`ManagedJob`](qiskit.providers.ibmq.managed.ManagedJob#qiskit.providers.ibmq.managed.ManagedJob "qiskit.providers.ibmq.managed.ManagedJob")(start\_index, experiments\_count\[, job]) | Job managed by the Job Manager. | -| [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults#qiskit.providers.ibmq.managed.ManagedResults "qiskit.providers.ibmq.managed.ManagedResults")(job\_set, backend\_name, success) | Results managed by the Job Manager. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| [`IBMQJobManager`](qiskit.providers.ibmq.managed.IBMQJobManager "qiskit.providers.ibmq.managed.IBMQJobManager")() | Job Manager for IBM Quantum Experience. | +| [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet")(\[name, short\_id]) | A set of managed jobs. | +| [`ManagedJob`](qiskit.providers.ibmq.managed.ManagedJob "qiskit.providers.ibmq.managed.ManagedJob")(start\_index, experiments\_count\[, job]) | Job managed by the Job Manager. | +| [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.providers.ibmq.managed.ManagedResults")(job\_set, backend\_name, success) | Results managed by the Job Manager. | ## Exceptions -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| [`IBMQJobManagerError`](qiskit.providers.ibmq.managed.IBMQJobManagerError#qiskit.providers.ibmq.managed.IBMQJobManagerError "qiskit.providers.ibmq.managed.IBMQJobManagerError")(\*message) | Base class for errors raise by the Job Manager. | -| [`IBMQJobManagerInvalidStateError`](qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError#qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError "qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError")(\*message) | Errors raised when an operation is invoked in an invalid state. | -| [`IBMQJobManagerTimeoutError`](qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError#qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError "qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError")(\*message) | Errors raised when a Job Manager operation times out. | -| [`IBMQJobManagerJobNotFound`](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound#qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound")(\*message) | Errors raised when a job cannot be found. | -| [`IBMQManagedResultDataNotAvailable`](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable#qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable")(\*message) | Errors raised when result data is not available. | -| [`IBMQJobManagerUnknownJobSet`](qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet#qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet "qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet")(\*message) | Errors raised when the job set ID is unknown. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| [`IBMQJobManagerError`](qiskit.providers.ibmq.managed.IBMQJobManagerError "qiskit.providers.ibmq.managed.IBMQJobManagerError")(\*message) | Base class for errors raise by the Job Manager. | +| [`IBMQJobManagerInvalidStateError`](qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError "qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError")(\*message) | Errors raised when an operation is invoked in an invalid state. | +| [`IBMQJobManagerTimeoutError`](qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError "qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError")(\*message) | Errors raised when a Job Manager operation times out. | +| [`IBMQJobManagerJobNotFound`](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound")(\*message) | Errors raised when a job cannot be found. | +| [`IBMQManagedResultDataNotAvailable`](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable")(\*message) | Errors raised when result data is not available. | +| [`IBMQJobManagerUnknownJobSet`](qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet "qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet")(\*message) | Errors raised when the job set ID is unknown. | diff --git a/docs/api/qiskit/0.32/ibmq_provider.md b/docs/api/qiskit/0.32/ibmq_provider.md index eff3cafc718..0b2e1123a5d 100644 --- a/docs/api/qiskit/0.32/ibmq_provider.md +++ b/docs/api/qiskit/0.32/ibmq_provider.md @@ -36,35 +36,35 @@ logging.getLogger('qiskit.providers.ibmq').setLevel(logging.WARNING) ## Functions -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`least_busy`](qiskit.providers.ibmq.least_busy#qiskit.providers.ibmq.least_busy "qiskit.providers.ibmq.least_busy")(backends\[, reservation\_lookahead]) | Return the least busy backend from a list. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------ | +| [`least_busy`](qiskit.providers.ibmq.least_busy "qiskit.providers.ibmq.least_busy")(backends\[, reservation\_lookahead]) | Return the least busy backend from a list. | ## Classes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`AccountProvider`](qiskit.providers.ibmq.AccountProvider#qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider")(credentials, factory) | Provider for a single IBM Quantum Experience account. | -| [`BackendJobLimit`](qiskit.providers.ibmq.BackendJobLimit#qiskit.providers.ibmq.BackendJobLimit "qiskit.providers.ibmq.BackendJobLimit")(maximum\_jobs, running\_jobs, …) | Job limit for a backend. | -| [`IBMQBackend`](qiskit.providers.ibmq.IBMQBackend#qiskit.providers.ibmq.IBMQBackend "qiskit.providers.ibmq.IBMQBackend")(configuration, provider, …) | Backend class interfacing with an IBM Quantum Experience device. | -| [`IBMQBackendService`](qiskit.providers.ibmq.IBMQBackendService#qiskit.providers.ibmq.IBMQBackendService "qiskit.providers.ibmq.IBMQBackendService")(provider) | Backend namespace for an IBM Quantum Experience account provider. | -| [`IBMQFactory`](qiskit.providers.ibmq.IBMQFactory#qiskit.providers.ibmq.IBMQFactory "qiskit.providers.ibmq.IBMQFactory")() | Factory and account manager for IBM Quantum Experience. | -| [`RunnerResult`](qiskit.providers.ibmq.RunnerResult#qiskit.providers.ibmq.RunnerResult "qiskit.providers.ibmq.RunnerResult")(backend\_name, backend\_version, …) | Result class for Qiskit Runtime program circuit-runner. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider")(credentials, factory) | Provider for a single IBM Quantum Experience account. | +| [`BackendJobLimit`](qiskit.providers.ibmq.BackendJobLimit "qiskit.providers.ibmq.BackendJobLimit")(maximum\_jobs, running\_jobs, …) | Job limit for a backend. | +| [`IBMQBackend`](qiskit.providers.ibmq.IBMQBackend "qiskit.providers.ibmq.IBMQBackend")(configuration, provider, …) | Backend class interfacing with an IBM Quantum Experience device. | +| [`IBMQBackendService`](qiskit.providers.ibmq.IBMQBackendService "qiskit.providers.ibmq.IBMQBackendService")(provider) | Backend namespace for an IBM Quantum Experience account provider. | +| [`IBMQFactory`](qiskit.providers.ibmq.IBMQFactory "qiskit.providers.ibmq.IBMQFactory")() | Factory and account manager for IBM Quantum Experience. | +| [`RunnerResult`](qiskit.providers.ibmq.RunnerResult "qiskit.providers.ibmq.RunnerResult")(backend\_name, backend\_version, …) | Result class for Qiskit Runtime program circuit-runner. | ## Exceptions -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`IBMQError`](qiskit.providers.ibmq.IBMQError#qiskit.providers.ibmq.IBMQError "qiskit.providers.ibmq.IBMQError")(\*message) | Base class for errors raised by the provider modules. | -| [`IBMQAccountError`](qiskit.providers.ibmq.IBMQAccountError#qiskit.providers.ibmq.IBMQAccountError "qiskit.providers.ibmq.IBMQAccountError")(\*message) | Base class for errors raised by account management. | -| [`IBMQAccountCredentialsNotFound`](qiskit.providers.ibmq.IBMQAccountCredentialsNotFound#qiskit.providers.ibmq.IBMQAccountCredentialsNotFound "qiskit.providers.ibmq.IBMQAccountCredentialsNotFound")(\*message) | Errors raised when credentials are not found. | -| [`IBMQAccountCredentialsInvalidFormat`](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat#qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat")(\*message) | Errors raised when the credentials format is invalid. | -| [`IBMQAccountCredentialsInvalidToken`](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken#qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken")(\*message) | Errors raised when an IBM Quantum Experience token is invalid. | -| [`IBMQAccountCredentialsInvalidUrl`](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl#qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl")(\*message) | Errors raised when an IBM Quantum Experience URL is invalid. | -| [`IBMQAccountMultipleCredentialsFound`](qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound#qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound "qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound")(\*message) | Errors raised when multiple credentials are found. | -| [`IBMQBackendError`](qiskit.providers.ibmq.IBMQBackendError#qiskit.providers.ibmq.IBMQBackendError "qiskit.providers.ibmq.IBMQBackendError")(\*message) | Base class for errors raised by the backend modules. | -| [`IBMQBackendApiError`](qiskit.providers.ibmq.IBMQBackendApiError#qiskit.providers.ibmq.IBMQBackendApiError "qiskit.providers.ibmq.IBMQBackendApiError")(\*message) | Errors that occur unexpectedly when querying the server. | -| [`IBMQBackendApiProtocolError`](qiskit.providers.ibmq.IBMQBackendApiProtocolError#qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError")(\*message) | Errors raised when an unexpected value is received from the server. | -| [`IBMQBackendValueError`](qiskit.providers.ibmq.IBMQBackendValueError#qiskit.providers.ibmq.IBMQBackendValueError "qiskit.providers.ibmq.IBMQBackendValueError")(\*message) | Value errors raised by the backend modules. | -| [`IBMQProviderError`](qiskit.providers.ibmq.IBMQProviderError#qiskit.providers.ibmq.IBMQProviderError "qiskit.providers.ibmq.IBMQProviderError")(\*message) | Errors related to provider handling. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`IBMQError`](qiskit.providers.ibmq.IBMQError "qiskit.providers.ibmq.IBMQError")(\*message) | Base class for errors raised by the provider modules. | +| [`IBMQAccountError`](qiskit.providers.ibmq.IBMQAccountError "qiskit.providers.ibmq.IBMQAccountError")(\*message) | Base class for errors raised by account management. | +| [`IBMQAccountCredentialsNotFound`](qiskit.providers.ibmq.IBMQAccountCredentialsNotFound "qiskit.providers.ibmq.IBMQAccountCredentialsNotFound")(\*message) | Errors raised when credentials are not found. | +| [`IBMQAccountCredentialsInvalidFormat`](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat")(\*message) | Errors raised when the credentials format is invalid. | +| [`IBMQAccountCredentialsInvalidToken`](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken")(\*message) | Errors raised when an IBM Quantum Experience token is invalid. | +| [`IBMQAccountCredentialsInvalidUrl`](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl")(\*message) | Errors raised when an IBM Quantum Experience URL is invalid. | +| [`IBMQAccountMultipleCredentialsFound`](qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound "qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound")(\*message) | Errors raised when multiple credentials are found. | +| [`IBMQBackendError`](qiskit.providers.ibmq.IBMQBackendError "qiskit.providers.ibmq.IBMQBackendError")(\*message) | Base class for errors raised by the backend modules. | +| [`IBMQBackendApiError`](qiskit.providers.ibmq.IBMQBackendApiError "qiskit.providers.ibmq.IBMQBackendApiError")(\*message) | Errors that occur unexpectedly when querying the server. | +| [`IBMQBackendApiProtocolError`](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError")(\*message) | Errors raised when an unexpected value is received from the server. | +| [`IBMQBackendValueError`](qiskit.providers.ibmq.IBMQBackendValueError "qiskit.providers.ibmq.IBMQBackendValueError")(\*message) | Value errors raised by the backend modules. | +| [`IBMQProviderError`](qiskit.providers.ibmq.IBMQProviderError "qiskit.providers.ibmq.IBMQProviderError")(\*message) | Errors related to provider handling. | diff --git a/docs/api/qiskit/0.32/ibmq_random.md b/docs/api/qiskit/0.32/ibmq_random.md index 4ba8b0ebc46..08d9d54832c 100644 --- a/docs/api/qiskit/0.32/ibmq_random.md +++ b/docs/api/qiskit/0.32/ibmq_random.md @@ -30,9 +30,9 @@ The only service currently provided is the Cambridge Quantum Computing (CQC) ext ## Classes -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`IBMQRandomService`](qiskit.providers.ibmq.random.IBMQRandomService#qiskit.providers.ibmq.random.IBMQRandomService "qiskit.providers.ibmq.random.IBMQRandomService")(provider) | Random number services for an IBM Quantum Experience account provider. | -| [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor#qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor")(name, provider, client, methods) | Class for interfacing with a CQC remote extractor. | -| [`CQCExtractorJob`](qiskit.providers.ibmq.random.CQCExtractorJob#qiskit.providers.ibmq.random.CQCExtractorJob "qiskit.providers.ibmq.random.CQCExtractorJob")(job\_id, client\[, parameters]) | Representation of an asynchronous call to the CQC extractor. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | +| [`IBMQRandomService`](qiskit.providers.ibmq.random.IBMQRandomService "qiskit.providers.ibmq.random.IBMQRandomService")(provider) | Random number services for an IBM Quantum Experience account provider. | +| [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor")(name, provider, client, methods) | Class for interfacing with a CQC remote extractor. | +| [`CQCExtractorJob`](qiskit.providers.ibmq.random.CQCExtractorJob "qiskit.providers.ibmq.random.CQCExtractorJob")(job\_id, client\[, parameters]) | Representation of an asynchronous call to the CQC extractor. | diff --git a/docs/api/qiskit/0.32/ibmq_runtime.md b/docs/api/qiskit/0.32/ibmq_runtime.md index 03a9bbadd39..8cfb459d76a 100644 --- a/docs/api/qiskit/0.32/ibmq_runtime.md +++ b/docs/api/qiskit/0.32/ibmq_runtime.md @@ -64,11 +64,11 @@ program = provider.runtime.program('circuit-runner') print(program) ``` -In the example above, `provider.runtime` points to the runtime service class [`IBMRuntimeService`](qiskit.providers.ibmq.runtime.IBMRuntimeService#qiskit.providers.ibmq.runtime.IBMRuntimeService "qiskit.providers.ibmq.runtime.IBMRuntimeService"), which is the main entry point for using this service. The example prints the program metadata of all available runtime programs and of just the `circuit-runner` program. A program metadata consists of the program’s ID, name, description, input parameters, return values, interim results, and other information that helps you to know more about the program. +In the example above, `provider.runtime` points to the runtime service class [`IBMRuntimeService`](qiskit.providers.ibmq.runtime.IBMRuntimeService "qiskit.providers.ibmq.runtime.IBMRuntimeService"), which is the main entry point for using this service. The example prints the program metadata of all available runtime programs and of just the `circuit-runner` program. A program metadata consists of the program’s ID, name, description, input parameters, return values, interim results, and other information that helps you to know more about the program. ## Invoking a runtime program -You can use the [`IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to invoke a runtime program. For example: +You can use the [`IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to invoke a runtime program. For example: ```python from qiskit import IBMQ, QuantumCircuit @@ -105,11 +105,11 @@ The example above invokes the `circuit-runner` program, which compiles, executes ## Runtime Jobs -When you use the [`IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to invoke a runtime program, a [`RuntimeJob`](qiskit.providers.ibmq.runtime.RuntimeJob#qiskit.providers.ibmq.runtime.RuntimeJob "qiskit.providers.ibmq.runtime.RuntimeJob") instance is returned. This class has all the basic job methods, such as [`RuntimeJob.status()`](qiskit.providers.ibmq.runtime.RuntimeJob.status#qiskit.providers.ibmq.runtime.RuntimeJob.status "qiskit.providers.ibmq.runtime.RuntimeJob.status"), [`RuntimeJob.result()`](qiskit.providers.ibmq.runtime.RuntimeJob.result#qiskit.providers.ibmq.runtime.RuntimeJob.result "qiskit.providers.ibmq.runtime.RuntimeJob.result"), and [`RuntimeJob.cancel()`](qiskit.providers.ibmq.runtime.RuntimeJob.cancel#qiskit.providers.ibmq.runtime.RuntimeJob.cancel "qiskit.providers.ibmq.runtime.RuntimeJob.cancel"). Note that it does not have the same methods as regular circuit jobs, which are instances of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob#qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob"). +When you use the [`IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to invoke a runtime program, a [`RuntimeJob`](qiskit.providers.ibmq.runtime.RuntimeJob "qiskit.providers.ibmq.runtime.RuntimeJob") instance is returned. This class has all the basic job methods, such as [`RuntimeJob.status()`](qiskit.providers.ibmq.runtime.RuntimeJob#status "qiskit.providers.ibmq.runtime.RuntimeJob.status"), [`RuntimeJob.result()`](qiskit.providers.ibmq.runtime.RuntimeJob#result "qiskit.providers.ibmq.runtime.RuntimeJob.result"), and [`RuntimeJob.cancel()`](qiskit.providers.ibmq.runtime.RuntimeJob#cancel "qiskit.providers.ibmq.runtime.RuntimeJob.cancel"). Note that it does not have the same methods as regular circuit jobs, which are instances of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob"). ## Interim results -Some runtime programs provide interim results that inform you about program progress. You can choose to stream the interim results when you run the program by passing in the `callback` parameter, or at a later time using the [`RuntimeJob.stream_results()`](qiskit.providers.ibmq.runtime.RuntimeJob.stream_results#qiskit.providers.ibmq.runtime.RuntimeJob.stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") method. For example: +Some runtime programs provide interim results that inform you about program progress. You can choose to stream the interim results when you run the program by passing in the `callback` parameter, or at a later time using the [`RuntimeJob.stream_results()`](qiskit.providers.ibmq.runtime.RuntimeJob#stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") method. For example: ```python from qiskit import IBMQ, QuantumCircuit @@ -135,11 +135,11 @@ job = provider.runtime.run(program_id="circuit-runner", Each runtime program has both `data` and `metadata`. Program data is the Python code to be executed. Program metadata provides usage information, such as program description, its inputs and outputs, and backend requirements. A detailed program metadata helps the consumers of the program to know what is needed to run the program. -Each program data needs to have a `main(backend, user_messenger, **kwargs)` method, which serves as the entry point to the program. The `backend` parameter is a [`ProgramBackend`](qiskit.providers.ibmq.runtime.ProgramBackend#qiskit.providers.ibmq.runtime.ProgramBackend "qiskit.providers.ibmq.runtime.ProgramBackend") instance whose [`ProgramBackend.run()`](qiskit.providers.ibmq.runtime.ProgramBackend.run#qiskit.providers.ibmq.runtime.ProgramBackend.run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method can be used to submit circuits. The `user_messenger` is a [`UserMessenger`](qiskit.providers.ibmq.runtime.UserMessenger#qiskit.providers.ibmq.runtime.UserMessenger "qiskit.providers.ibmq.runtime.UserMessenger") instance whose [`UserMessenger.publish()`](qiskit.providers.ibmq.runtime.UserMessenger.publish#qiskit.providers.ibmq.runtime.UserMessenger.publish "qiskit.providers.ibmq.runtime.UserMessenger.publish") method can be used to publish interim and final results. See qiskit/providers/ibmq/runtime/program/program\_template.py for a program data template file. +Each program data needs to have a `main(backend, user_messenger, **kwargs)` method, which serves as the entry point to the program. The `backend` parameter is a [`ProgramBackend`](qiskit.providers.ibmq.runtime.ProgramBackend "qiskit.providers.ibmq.runtime.ProgramBackend") instance whose [`ProgramBackend.run()`](qiskit.providers.ibmq.runtime.ProgramBackend#run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method can be used to submit circuits. The `user_messenger` is a [`UserMessenger`](qiskit.providers.ibmq.runtime.UserMessenger "qiskit.providers.ibmq.runtime.UserMessenger") instance whose [`UserMessenger.publish()`](qiskit.providers.ibmq.runtime.UserMessenger#publish "qiskit.providers.ibmq.runtime.UserMessenger.publish") method can be used to publish interim and final results. See qiskit/providers/ibmq/runtime/program/program\_template.py for a program data template file. -Each program metadata must include at least the program name, description, and maximum execution time. You can find description of each metadata field in the [`IBMRuntimeService.upload_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program#qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program") method. Instead of passing in the metadata fields individually, you can pass in a JSON file or a dictionary to [`IBMRuntimeService.upload_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program#qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program") via the `metadata` parameter. qiskit/providers/ibmq/runtime/program/program\_metadata\_sample.json is a sample file of program metadata. +Each program metadata must include at least the program name, description, and maximum execution time. You can find description of each metadata field in the [`IBMRuntimeService.upload_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#upload_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program") method. Instead of passing in the metadata fields individually, you can pass in a JSON file or a dictionary to [`IBMRuntimeService.upload_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#upload_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program") via the `metadata` parameter. qiskit/providers/ibmq/runtime/program/program\_metadata\_sample.json is a sample file of program metadata. -You can use the [`IBMRuntimeService.upload_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program#qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program") to upload a program. For example: +You can use the [`IBMRuntimeService.upload_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#upload_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program") to upload a program. For example: ```python from qiskit import IBMQ @@ -153,21 +153,21 @@ program_id = provider.runtime.upload_program( In the example above, the file `my_vqe.py` contains the program data, and `my_vqe_metadata.json` contains the program metadata. -Method [`IBMRuntimeService.delete_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_program#qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_program") allows you to delete a program. +Method [`IBMRuntimeService.delete_program()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#delete_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_program") allows you to delete a program. Files related to writing a runtime program are in the `qiskit/providers/ibmq/runtime/program` directory. ### Classes -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| [`IBMRuntimeService`](qiskit.providers.ibmq.runtime.IBMRuntimeService#qiskit.providers.ibmq.runtime.IBMRuntimeService "qiskit.providers.ibmq.runtime.IBMRuntimeService")(provider) | Class for interacting with the Qiskit Runtime service. | -| [`RuntimeJob`](qiskit.providers.ibmq.runtime.RuntimeJob#qiskit.providers.ibmq.runtime.RuntimeJob "qiskit.providers.ibmq.runtime.RuntimeJob")(backend, api\_client, credentials, …) | Representation of a runtime program execution. | -| [`RuntimeProgram`](qiskit.providers.ibmq.runtime.RuntimeProgram#qiskit.providers.ibmq.runtime.RuntimeProgram "qiskit.providers.ibmq.runtime.RuntimeProgram")(program\_name, program\_id, …) | Class representing program metadata. | -| [`UserMessenger`](qiskit.providers.ibmq.runtime.UserMessenger#qiskit.providers.ibmq.runtime.UserMessenger "qiskit.providers.ibmq.runtime.UserMessenger")() | Base class for handling communication with program users. | -| [`ProgramBackend`](qiskit.providers.ibmq.runtime.ProgramBackend#qiskit.providers.ibmq.runtime.ProgramBackend "qiskit.providers.ibmq.runtime.ProgramBackend")(configuration\[, provider]) | Base class for a program backend. | -| [`ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder#qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.ResultDecoder")() | Runtime job result decoder. | -| [`RuntimeEncoder`](qiskit.providers.ibmq.runtime.RuntimeEncoder#qiskit.providers.ibmq.runtime.RuntimeEncoder "qiskit.providers.ibmq.runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, …]) | JSON Encoder used by runtime service. | -| [`RuntimeDecoder`](qiskit.providers.ibmq.runtime.RuntimeDecoder#qiskit.providers.ibmq.runtime.RuntimeDecoder "qiskit.providers.ibmq.runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | -| [`ParameterNamespace`](qiskit.providers.ibmq.runtime.ParameterNamespace#qiskit.providers.ibmq.runtime.ParameterNamespace "qiskit.providers.ibmq.runtime.ParameterNamespace")(parameters) | A namespace for program parameters with validation. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| [`IBMRuntimeService`](qiskit.providers.ibmq.runtime.IBMRuntimeService "qiskit.providers.ibmq.runtime.IBMRuntimeService")(provider) | Class for interacting with the Qiskit Runtime service. | +| [`RuntimeJob`](qiskit.providers.ibmq.runtime.RuntimeJob "qiskit.providers.ibmq.runtime.RuntimeJob")(backend, api\_client, credentials, …) | Representation of a runtime program execution. | +| [`RuntimeProgram`](qiskit.providers.ibmq.runtime.RuntimeProgram "qiskit.providers.ibmq.runtime.RuntimeProgram")(program\_name, program\_id, …) | Class representing program metadata. | +| [`UserMessenger`](qiskit.providers.ibmq.runtime.UserMessenger "qiskit.providers.ibmq.runtime.UserMessenger")() | Base class for handling communication with program users. | +| [`ProgramBackend`](qiskit.providers.ibmq.runtime.ProgramBackend "qiskit.providers.ibmq.runtime.ProgramBackend")(configuration\[, provider]) | Base class for a program backend. | +| [`ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.ResultDecoder")() | Runtime job result decoder. | +| [`RuntimeEncoder`](qiskit.providers.ibmq.runtime.RuntimeEncoder "qiskit.providers.ibmq.runtime.RuntimeEncoder")(\*\[, skipkeys, ensure\_ascii, …]) | JSON Encoder used by runtime service. | +| [`RuntimeDecoder`](qiskit.providers.ibmq.runtime.RuntimeDecoder "qiskit.providers.ibmq.runtime.RuntimeDecoder")(\*args, \*\*kwargs) | JSON Decoder used by runtime service. | +| [`ParameterNamespace`](qiskit.providers.ibmq.runtime.ParameterNamespace "qiskit.providers.ibmq.runtime.ParameterNamespace")(parameters) | A namespace for program parameters with validation. | diff --git a/docs/api/qiskit/0.32/ibmq_utils.md b/docs/api/qiskit/0.32/ibmq_utils.md index a7f8008dd0b..c7697f5f414 100644 --- a/docs/api/qiskit/0.32/ibmq_utils.md +++ b/docs/api/qiskit/0.32/ibmq_utils.md @@ -20,21 +20,21 @@ Utility functions related to the IBM Quantum Provider. ## Conversion -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`seconds_to_duration`](qiskit.providers.ibmq.utils.seconds_to_duration#qiskit.providers.ibmq.utils.seconds_to_duration "qiskit.providers.ibmq.utils.seconds_to_duration")(seconds) | Converts seconds in a datetime delta to a duration. | -| [`utc_to_local`](qiskit.providers.ibmq.utils.utc_to_local#qiskit.providers.ibmq.utils.utc_to_local "qiskit.providers.ibmq.utils.utc_to_local")(utc\_dt) | Convert a UTC `datetime` object or string to a local timezone `datetime`. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| [`seconds_to_duration`](qiskit.providers.ibmq.utils.seconds_to_duration "qiskit.providers.ibmq.utils.seconds_to_duration")(seconds) | Converts seconds in a datetime delta to a duration. | +| [`utc_to_local`](qiskit.providers.ibmq.utils.utc_to_local "qiskit.providers.ibmq.utils.utc_to_local")(utc\_dt) | Convert a UTC `datetime` object or string to a local timezone `datetime`. | ## Qobj Utils -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`update_qobj_config`](qiskit.providers.ibmq.utils.update_qobj_config#qiskit.providers.ibmq.utils.update_qobj_config "qiskit.providers.ibmq.utils.update_qobj_config")(qobj\[, backend\_options, …]) | Update a `Qobj` configuration from backend options and a noise model. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| [`update_qobj_config`](qiskit.providers.ibmq.utils.update_qobj_config "qiskit.providers.ibmq.utils.update_qobj_config")(qobj\[, backend\_options, …]) | Update a `Qobj` configuration from backend options and a noise model. | ## Misc Functions -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`to_python_identifier`](qiskit.providers.ibmq.utils.to_python_identifier#qiskit.providers.ibmq.utils.to_python_identifier "qiskit.providers.ibmq.utils.to_python_identifier")(name) | Convert a name to a valid Python identifier. | -| [`validate_job_tags`](qiskit.providers.ibmq.utils.validate_job_tags#qiskit.providers.ibmq.utils.validate_job_tags "qiskit.providers.ibmq.utils.validate_job_tags")(job\_tags, exception) | Validates input job tags. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | +| [`to_python_identifier`](qiskit.providers.ibmq.utils.to_python_identifier "qiskit.providers.ibmq.utils.to_python_identifier")(name) | Convert a name to a valid Python identifier. | +| [`validate_job_tags`](qiskit.providers.ibmq.utils.validate_job_tags "qiskit.providers.ibmq.utils.validate_job_tags")(job\_tags, exception) | Validates input job tags. | diff --git a/docs/api/qiskit/0.32/logging.md b/docs/api/qiskit/0.32/logging.md index 87557d37a4c..c89832290dc 100644 --- a/docs/api/qiskit/0.32/logging.md +++ b/docs/api/qiskit/0.32/logging.md @@ -16,19 +16,17 @@ python_api_name: qiskit.ignis.logging `qiskit.ignis.logging` -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| [`IgnisLogger`](qiskit.ignis.logging.IgnisLogger#qiskit.ignis.logging.IgnisLogger "qiskit.ignis.logging.IgnisLogger")(name\[, level]) | A logger class for Ignis | -| [`IgnisLogging`](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 "qiskit.ignis.logging.IgnisLogReader")() | Class to read from Ignis log files | +| | | +| ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| [`IgnisLogger`](qiskit.ignis.logging.IgnisLogger "qiskit.ignis.logging.IgnisLogger")(name\[, level]) | A logger class for Ignis | +| [`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)` +`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 -IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger.log_to_file#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. +IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. Refer to Python’s logging documentation for more details on how to use logging in Python diff --git a/docs/api/qiskit/0.32/measurement.md b/docs/api/qiskit/0.32/measurement.md index 0414d46836b..e39f79961f3 100644 --- a/docs/api/qiskit/0.32/measurement.md +++ b/docs/api/qiskit/0.32/measurement.md @@ -20,11 +20,11 @@ python_api_name: qiskit.ignis.measurement The discriminators are used to to discriminate level one data into level two counts. -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`DiscriminationFilter`](qiskit.ignis.measurement.DiscriminationFilter#qiskit.ignis.measurement.DiscriminationFilter "qiskit.ignis.measurement.DiscriminationFilter")(discriminator\[, base]) | Implements a filter based on a discriminator that takes level 1 data to level 2 data. | -| [`IQDiscriminationFitter`](qiskit.ignis.measurement.IQDiscriminationFitter#qiskit.ignis.measurement.IQDiscriminationFitter "qiskit.ignis.measurement.IQDiscriminationFitter")(cal\_results, qubit\_mask) | Abstract discriminator that implements the data formatting for IQ level 1 data. | -| [`LinearIQDiscriminator`](qiskit.ignis.measurement.LinearIQDiscriminator#qiskit.ignis.measurement.LinearIQDiscriminator "qiskit.ignis.measurement.LinearIQDiscriminator")(cal\_results, qubit\_mask) | Linear discriminant analysis discriminator for IQ data. | -| [`QuadraticIQDiscriminator`](qiskit.ignis.measurement.QuadraticIQDiscriminator#qiskit.ignis.measurement.QuadraticIQDiscriminator "qiskit.ignis.measurement.QuadraticIQDiscriminator")(cal\_results, qubit\_mask) | Quadratic discriminant analysis discriminator for IQ data. | -| [`SklearnIQDiscriminator`](qiskit.ignis.measurement.SklearnIQDiscriminator#qiskit.ignis.measurement.SklearnIQDiscriminator "qiskit.ignis.measurement.SklearnIQDiscriminator")(classifier, …\[, …]) | A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| [`DiscriminationFilter`](qiskit.ignis.measurement.DiscriminationFilter "qiskit.ignis.measurement.DiscriminationFilter")(discriminator\[, base]) | Implements a filter based on a discriminator that takes level 1 data to level 2 data. | +| [`IQDiscriminationFitter`](qiskit.ignis.measurement.IQDiscriminationFitter "qiskit.ignis.measurement.IQDiscriminationFitter")(cal\_results, qubit\_mask) | Abstract discriminator that implements the data formatting for IQ level 1 data. | +| [`LinearIQDiscriminator`](qiskit.ignis.measurement.LinearIQDiscriminator "qiskit.ignis.measurement.LinearIQDiscriminator")(cal\_results, qubit\_mask) | Linear discriminant analysis discriminator for IQ data. | +| [`QuadraticIQDiscriminator`](qiskit.ignis.measurement.QuadraticIQDiscriminator "qiskit.ignis.measurement.QuadraticIQDiscriminator")(cal\_results, qubit\_mask) | Quadratic discriminant analysis discriminator for IQ data. | +| [`SklearnIQDiscriminator`](qiskit.ignis.measurement.SklearnIQDiscriminator "qiskit.ignis.measurement.SklearnIQDiscriminator")(classifier, …\[, …]) | A generic discriminant analysis discriminator for IQ data that takes an sklearn classifier as an argument. | diff --git a/docs/api/qiskit/0.32/mitigation.md b/docs/api/qiskit/0.32/mitigation.md index 6ad6eed9c47..a4cdecb2cfc 100644 --- a/docs/api/qiskit/0.32/mitigation.md +++ b/docs/api/qiskit/0.32/mitigation.md @@ -20,25 +20,25 @@ python_api_name: qiskit.ignis.mitigation The measurement calibration is used to mitigate measurement errors. The main idea is to prepare all $2^n$ basis input states and compute the probability of measuring counts in the other basis states. From these calibrations, it is possible to correct the average results of another experiment of interest. -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`complete_meas_cal`](qiskit.ignis.mitigation.complete_meas_cal#qiskit.ignis.mitigation.complete_meas_cal "qiskit.ignis.mitigation.complete_meas_cal")(\[qubit\_list, qr, cr, …]) | Return a list of measurement calibration circuits for the full Hilbert space. | -| [`tensored_meas_cal`](qiskit.ignis.mitigation.tensored_meas_cal#qiskit.ignis.mitigation.tensored_meas_cal "qiskit.ignis.mitigation.tensored_meas_cal")(\[mit\_pattern, qr, cr, …]) | Return a list of calibration circuits | -| [`MeasurementFilter`](qiskit.ignis.mitigation.MeasurementFilter#qiskit.ignis.mitigation.MeasurementFilter "qiskit.ignis.mitigation.MeasurementFilter")(cal\_matrix, state\_labels) | Measurement error mitigation filter. | -| [`TensoredFilter`](qiskit.ignis.mitigation.TensoredFilter#qiskit.ignis.mitigation.TensoredFilter "qiskit.ignis.mitigation.TensoredFilter")(cal\_matrices, …) | Tensored measurement error mitigation filter. | -| [`CompleteMeasFitter`](qiskit.ignis.mitigation.CompleteMeasFitter#qiskit.ignis.mitigation.CompleteMeasFitter "qiskit.ignis.mitigation.CompleteMeasFitter")(results, state\_labels\[, …]) | Measurement correction fitter for a full calibration | -| [`TensoredMeasFitter`](qiskit.ignis.mitigation.TensoredMeasFitter#qiskit.ignis.mitigation.TensoredMeasFitter "qiskit.ignis.mitigation.TensoredMeasFitter")(results, mit\_pattern\[, …]) | Measurement correction fitter for a tensored calibration. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| [`complete_meas_cal`](qiskit.ignis.mitigation.complete_meas_cal "qiskit.ignis.mitigation.complete_meas_cal")(\[qubit\_list, qr, cr, …]) | Return a list of measurement calibration circuits for the full Hilbert space. | +| [`tensored_meas_cal`](qiskit.ignis.mitigation.tensored_meas_cal "qiskit.ignis.mitigation.tensored_meas_cal")(\[mit\_pattern, qr, cr, …]) | Return a list of calibration circuits | +| [`MeasurementFilter`](qiskit.ignis.mitigation.MeasurementFilter "qiskit.ignis.mitigation.MeasurementFilter")(cal\_matrix, state\_labels) | Measurement error mitigation filter. | +| [`TensoredFilter`](qiskit.ignis.mitigation.TensoredFilter "qiskit.ignis.mitigation.TensoredFilter")(cal\_matrices, …) | Tensored measurement error mitigation filter. | +| [`CompleteMeasFitter`](qiskit.ignis.mitigation.CompleteMeasFitter "qiskit.ignis.mitigation.CompleteMeasFitter")(results, state\_labels\[, …]) | Measurement correction fitter for a full calibration | +| [`TensoredMeasFitter`](qiskit.ignis.mitigation.TensoredMeasFitter "qiskit.ignis.mitigation.TensoredMeasFitter")(results, mit\_pattern\[, …]) | Measurement correction fitter for a tensored calibration. | ## Expectation Value Measurement The following classes allow mitigation of measurement errors when computing expectation values of diagonal operators from counts. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`expectation_value`](qiskit.ignis.mitigation.expectation_value#qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value")(counts\[, diagonal, …]) | Compute the expectation value of a diagonal operator from counts. | -| [`expval_meas_mitigator_circuits`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits#qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits")(num\_qubits\[, …]) | Generate measurement error mitigator circuits and metadata. | -| [`ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter#qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter")(result, metadata) | Expectation value measurement error mitigator calibration fitter. | -| [`CTMPExpvalMeasMitigator`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator")(generators, rates\[, …]) | N-qubit CTMP measurement error mitigator. | -| [`CompleteExpvalMeasMitigator`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator")(amat) | N-qubit measurement error mitigator. | -| [`TensoredExpvalMeasMitigator`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator")(amats) | 1-qubit tensor product measurement error mitigator. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| [`expectation_value`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value")(counts\[, diagonal, …]) | Compute the expectation value of a diagonal operator from counts. | +| [`expval_meas_mitigator_circuits`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits")(num\_qubits\[, …]) | Generate measurement error mitigator circuits and metadata. | +| [`ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter")(result, metadata) | Expectation value measurement error mitigator calibration fitter. | +| [`CTMPExpvalMeasMitigator`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator")(generators, rates\[, …]) | N-qubit CTMP measurement error mitigator. | +| [`CompleteExpvalMeasMitigator`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator")(amat) | N-qubit measurement error mitigator. | +| [`TensoredExpvalMeasMitigator`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator")(amats) | 1-qubit tensor product measurement error mitigator. | diff --git a/docs/api/qiskit/0.32/opflow.md b/docs/api/qiskit/0.32/opflow.md index 9ce7146f5e6..a09fa5c3435 100644 --- a/docs/api/qiskit/0.32/opflow.md +++ b/docs/api/qiskit/0.32/opflow.md @@ -38,9 +38,9 @@ Below, you’ll find a base class for all Operators, some convenience immutable The OperatorBase serves as the base class for all Operators, State functions and measurements, and enforces the presence and consistency of methods to manipulate these objects conveniently. -| | | -| ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | -| [`OperatorBase`](qiskit.opflow.OperatorBase#qiskit.opflow.OperatorBase "qiskit.opflow.OperatorBase")() | A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. | +| | | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| [`OperatorBase`](qiskit.opflow.OperatorBase "qiskit.opflow.OperatorBase")() | A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. | ## Operator Globals @@ -72,7 +72,7 @@ The Operators submodules include the PrimitiveOp, ListOp, and StateFn class grou ### Converters -The Converter submodules include objects which manipulate Operators, usually recursing over an Operator structure and changing certain Operators’ representation. For example, the [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation#qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") traverses an Operator structure, and replaces all of the [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn#qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements containing non-diagonal Pauli terms into diagonalizing circuits following by [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn#qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurement containing only diagonal Paulis. +The Converter submodules include objects which manipulate Operators, usually recursing over an Operator structure and changing certain Operators’ representation. For example, the [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") traverses an Operator structure, and replaces all of the [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements containing non-diagonal Pauli terms into diagonalizing circuits following by [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurement containing only diagonal Paulis. | | | | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | @@ -83,15 +83,15 @@ The Converter submodules include objects which manipulate Operators, usually rec ## Utility functions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | -| [`commutator`](qiskit.opflow.commutator#qiskit.opflow.commutator "qiskit.opflow.commutator")(op\_a, op\_b) | Compute commutator of op\_a and op\_b. | -| [`anti_commutator`](qiskit.opflow.anti_commutator#qiskit.opflow.anti_commutator "qiskit.opflow.anti_commutator")(op\_a, op\_b) | Compute anti-commutator of op\_a and op\_b. | -| [`double_commutator`](qiskit.opflow.double_commutator#qiskit.opflow.double_commutator "qiskit.opflow.double_commutator")(op\_a, op\_b, op\_c\[, sign]) | Compute symmetric double commutator of op\_a, op\_b and op\_c. | +| | | +| ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| [`commutator`](qiskit.opflow.commutator "qiskit.opflow.commutator")(op\_a, op\_b) | Compute commutator of op\_a and op\_b. | +| [`anti_commutator`](qiskit.opflow.anti_commutator "qiskit.opflow.anti_commutator")(op\_a, op\_b) | Compute anti-commutator of op\_a and op\_b. | +| [`double_commutator`](qiskit.opflow.double_commutator "qiskit.opflow.double_commutator")(op\_a, op\_b, op\_c\[, sign]) | Compute symmetric double commutator of op\_a, op\_b and op\_c. | ## Exceptions -| | | -| ----------------------------------------------------------------------------------------------------------- | --------------------------- | -| [`OpflowError`](qiskit.opflow.OpflowError#qiskit.opflow.OpflowError "qiskit.opflow.OpflowError")(\*message) | For Opflow specific errors. | +| | | +| --------------------------------------------------------------------------------- | --------------------------- | +| [`OpflowError`](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError")(\*message) | For Opflow specific errors. | diff --git a/docs/api/qiskit/0.32/providers.md b/docs/api/qiskit/0.32/providers.md index 9556ddae4fc..772d3a8501f 100644 --- a/docs/api/qiskit/0.32/providers.md +++ b/docs/api/qiskit/0.32/providers.md @@ -16,7 +16,7 @@ python_api_name: qiskit.providers `qiskit.providers` -This module contains the classes used to build external providers for Terra. A provider is anything that provides an external service to Terra. The typical example of this is a Backend provider which provides [`Backend`](qiskit.providers.Backend#qiskit.providers.Backend "qiskit.providers.Backend") objects which can be used for executing [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and/or [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects. This module contains the abstract classes which are used to define the interface between a provider and terra. +This module contains the classes used to build external providers for Terra. A provider is anything that provides an external service to Terra. The typical example of this is a Backend provider which provides [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") objects which can be used for executing [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") and/or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects. This module contains the abstract classes which are used to define the interface between a provider and terra. ## Version Support @@ -36,42 +36,42 @@ It’s worth pointing out that Terra’s version support policy doesn’t mean p ### Provider -| | | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| [`Provider`](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")() | Base common type for all versioned Provider abstract classes. | -| [`ProviderV1`](qiskit.providers.ProviderV1#qiskit.providers.ProviderV1 "qiskit.providers.ProviderV1")() | Base class for a Backend Provider. | +| | | +| --------------------------------------------------------------------------- | ------------------------------------------------------------- | +| [`Provider`](qiskit.providers.Provider "qiskit.providers.Provider")() | Base common type for all versioned Provider abstract classes. | +| [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.ProviderV1")() | Base class for a Backend Provider. | ### Backend -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`Backend`](qiskit.providers.Backend#qiskit.providers.Backend "qiskit.providers.Backend")() | Base common type for all versioned Backend abstract classes. | -| [`BackendV1`](qiskit.providers.BackendV1#qiskit.providers.BackendV1 "qiskit.providers.BackendV1")(configuration\[, provider]) | Abstract class for Backends | +| | | +| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend")() | Base common type for all versioned Backend abstract classes. | +| [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1")(configuration\[, provider]) | Abstract class for Backends | ### Options -| | | -| ----------------------------------------------------------------------------------------- | ------------------- | -| [`Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") | Base options object | +| | | +| ---------------------------------------------------------------- | ------------------- | +| [`Options`](qiskit.providers.Options "qiskit.providers.Options") | Base options object | ### Job -| | | -| --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| [`Job`](qiskit.providers.Job#qiskit.providers.Job "qiskit.providers.Job")() | Base common type for all versioned Job abstract classes. | -| [`JobV1`](qiskit.providers.JobV1#qiskit.providers.JobV1 "qiskit.providers.JobV1")(backend, job\_id, \*\*kwargs) | Class to handle jobs | +| | | +| ---------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| [`Job`](qiskit.providers.Job "qiskit.providers.Job")() | Base common type for all versioned Job abstract classes. | +| [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1")(backend, job\_id, \*\*kwargs) | Class to handle jobs | # Writing a New Provider -If you have a quantum device or simulator that you would like to integrate with Qiskit you will need to write a provider. A provider will provide Terra with a method to get available [`BackendV1`](qiskit.providers.BackendV1#qiskit.providers.BackendV1 "qiskit.providers.BackendV1") objects. The [`BackendV1`](qiskit.providers.BackendV1#qiskit.providers.BackendV1 "qiskit.providers.BackendV1") object provides both information describing a backend and its operation for the [`transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler") so that circuits can be compiled to something that is optimized and can execute on the backend. It also provides the [`run()`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method which can run the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects and/or [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects. This enables users and other Qiskit APIs, such as [`execute()`](execute#qiskit.execute_function.execute "qiskit.execute_function.execute") and higher level algorithms in Qiskit Aqua, to get results from executing circuits on devices in a standard fashion regardless of how the Backend is implemented. At a high level the basic steps for writing a provider are: +If you have a quantum device or simulator that you would like to integrate with Qiskit you will need to write a provider. A provider will provide Terra with a method to get available [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") objects. The [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") object provides both information describing a backend and its operation for the [`transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler") so that circuits can be compiled to something that is optimized and can execute on the backend. It also provides the [`run()`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method which can run the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects and/or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects. This enables users and other Qiskit APIs, such as [`execute()`](execute#qiskit.execute_function.execute "qiskit.execute_function.execute") and higher level algorithms in Qiskit Aqua, to get results from executing circuits on devices in a standard fashion regardless of how the Backend is implemented. At a high level the basic steps for writing a provider are: -> * Implement a [`ProviderV1`](qiskit.providers.ProviderV1#qiskit.providers.ProviderV1 "qiskit.providers.ProviderV1") subclass that handles access to the backend(s). +> * Implement a [`ProviderV1`](qiskit.providers.ProviderV1 "qiskit.providers.ProviderV1") subclass that handles access to the backend(s). > -> * Implement a [`BackendV1`](qiskit.providers.BackendV1#qiskit.providers.BackendV1 "qiskit.providers.BackendV1") subclass and its [`run()`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method. +> * Implement a [`BackendV1`](qiskit.providers.BackendV1 "qiskit.providers.BackendV1") subclass and its [`run()`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method. > -> * Add any custom gates for the backend’s basis to the session [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") instance. +> * Add any custom gates for the backend’s basis to the session [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") instance. > -> * Implement a [`JobV1`](qiskit.providers.JobV1#qiskit.providers.JobV1 "qiskit.providers.JobV1") subclass that handles interacting with a running job. +> * Implement a [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1") subclass that handles interacting with a running job. For a simple example of a provider the [qiskit-aqt-provider](https://github.com/qiskit-community/qiskit-aqt-provider) package is worth using as an example. @@ -103,7 +103,7 @@ Ensure that any necessary information for authentication (if required) are prese ## Backend -The backend classes are the core to the provider. These classes are what provide the interface between Qiskit and the hardware or simulator that will execute circuits. This includes providing the necessary information to describe a backend to the compiler so that it can embed and optimize any circuit for the backend. There are 3 required things in every backend object: a backend configuration property, a [`run`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method, and a [`_default_options`](qiskit.providers.BackendV1#qiskit.providers.BackendV1._default_options "qiskit.providers.BackendV1._default_options") method. For example, a minimum working example would be something like: +The backend classes are the core to the provider. These classes are what provide the interface between Qiskit and the hardware or simulator that will execute circuits. This includes providing the necessary information to describe a backend to the compiler so that it can embed and optimize any circuit for the backend. There are 3 required things in every backend object: a backend configuration property, a [`run`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method, and a [`_default_options`](qiskit.providers.BackendV1#_default_options "qiskit.providers.BackendV1._default_options") method. For example, a minimum working example would be something like: ```python from qiskit.providers import BackendV1 as Backend @@ -155,13 +155,13 @@ class Mybackend(Backend): ### Transpiler Interface -The key piece of the backend object is how it describes itself to the compiler. This is composed of three classes, the [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") which describes the immutable properties of the backend (things like the number of qubits, coupling map, etc), the [`BackendProperties`](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") which describes measured properties of the device (such as current error rates), and the [`PulseDefaults`](qiskit.providers.models.PulseDefaults#qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") which defines the default pulse behavior for the backend (such as the pulse sequences for gates). Of these only [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") is required. +The key piece of the backend object is how it describes itself to the compiler. This is composed of three classes, the [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") which describes the immutable properties of the backend (things like the number of qubits, coupling map, etc), the [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") which describes measured properties of the device (such as current error rates), and the [`PulseDefaults`](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") which defines the default pulse behavior for the backend (such as the pulse sequences for gates). Of these only [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") is required. It’s worth noting that this interface will likely evolve over time as the compiler grows and improves, thus requiring new information from the backends. This is a key reason why the providers interfaces are versioned to enable making these changes in a controlled manner. The details here will change and reflect the latest version of this interface. #### Custom Basis Gates -1\. If your backend doesn’t use gates in the Qiskit circuit library ([`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library")) you can integrate support for this into your provider. The basic method for doing this is first to define a [`Gate`](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate") class for all the custom gates in the basis set. For example: +1\. If your backend doesn’t use gates in the Qiskit circuit library ([`qiskit.circuit.library`](circuit_library#module-qiskit.circuit.library "qiskit.circuit.library")) you can integrate support for this into your provider. The basic method for doing this is first to define a [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") class for all the custom gates in the basis set. For example: ```python import numpy as np @@ -181,9 +181,9 @@ class SYGate(Gate): The key thing to ensure is that for any custom gates in your Backend’s basis set your custom gate’s name attribute (the first param on `super().__init__()` in the `__init__` definition above) does not conflict with the name of any other gates. The name attribute is what is used to identify the gate in the basis set for the transpiler. If there is a conflict the transpiler will not know which gate to use. -2\. After you’ve defined the custom gates to use for the Backend’s basis set then you need to add equivalence rules to the standard equivalence library so that the [`transpile()`](qiskit.compiler.transpile#qiskit.compiler.transpile "qiskit.compiler.transpile") function and [`transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler") module can convert an arbitrary circuit using the custom basis set. This can be done by defining equivalent circuits, in terms of the custom gate, for standard gates. Typically if you can convert from a [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") (if your basis doesn’t include a standard 2 qubit gate) and some commonly used single qubit rotation gates like the [`HGate`](qiskit.circuit.library.HGate#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate") and [`UGate`](qiskit.circuit.library.UGate#qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") that should be sufficient for the transpiler to translate any circuit into the custom basis gates. But, the more equivalence rules that are defined from standard gates to your basis the more efficient translation from an arbitrary circuit to the target basis will be (although not always, and there is a diminishing margin of return). +2\. After you’ve defined the custom gates to use for the Backend’s basis set then you need to add equivalence rules to the standard equivalence library so that the [`transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") function and [`transpiler`](transpiler#module-qiskit.transpiler "qiskit.transpiler") module can convert an arbitrary circuit using the custom basis set. This can be done by defining equivalent circuits, in terms of the custom gate, for standard gates. Typically if you can convert from a [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") (if your basis doesn’t include a standard 2 qubit gate) and some commonly used single qubit rotation gates like the [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate") and [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate") that should be sufficient for the transpiler to translate any circuit into the custom basis gates. But, the more equivalence rules that are defined from standard gates to your basis the more efficient translation from an arbitrary circuit to the target basis will be (although not always, and there is a diminishing margin of return). -For example, if you were to add some rules for the above custom `SYGate` we could define the [`U2Gate`](qiskit.circuit.library.U2Gate#qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate") and [`HGate`](qiskit.circuit.library.HGate#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"): +For example, if you were to add some rules for the above custom `SYGate` we could define the [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate") and [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"): ```python from qiskit.circuit.equivalence_library import SessionEquivalenceLibrary @@ -213,13 +213,13 @@ SessionEquivalenceLibrary.add_equivalence( U2Gate(phi, lam), def_sy_u2) ``` -You will want this to be run on import so that as soon as the provider’s package is imported it will be run. This will ensure that any time the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator#qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") pass is run with the custom gates the equivalence rules are defined. +You will want this to be run on import so that as soon as the provider’s package is imported it will be run. This will ensure that any time the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") pass is run with the custom gates the equivalence rules are defined. -It’s also worth noting that depending on the basis you’re using, some optimization passes in the transpiler, such as [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition#qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition"), may not be able to operate with your custom basis. For our `SYGate` example, the [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition#qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") will not be able to simplify runs of single qubit gates into the SY basis. This is because the [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer#qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer") class does not know how to work in the SY basis. To solve this the `SYGate` class would need to be added to Qiskit and [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer#qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer") updated to support decomposing to the `SYGate`. Longer term that is likely a better direction for custom basis gates and contributing the definitions and support in the transpiler will ensure that it continues to be well supported by Qiskit moving forward. +It’s also worth noting that depending on the basis you’re using, some optimization passes in the transpiler, such as [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition"), may not be able to operate with your custom basis. For our `SYGate` example, the [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition") will not be able to simplify runs of single qubit gates into the SY basis. This is because the [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer") class does not know how to work in the SY basis. To solve this the `SYGate` class would need to be added to Qiskit and [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer") updated to support decomposing to the `SYGate`. Longer term that is likely a better direction for custom basis gates and contributing the definitions and support in the transpiler will ensure that it continues to be well supported by Qiskit moving forward. ### Run Method -Of key importance is the [`run()`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method, which is used to actually submit circuits to a device or simulator. The run method handles submitting the circuits to the backend to be executed and returning a [`Job`](qiskit.providers.Job#qiskit.providers.Job "qiskit.providers.Job") object. Depending on the type of backend this typically involves serializing the circuit object into the API format used by a backend. For example, on IBMQ backends from the `qiskit-ibmq-provider` package this involves converting from a quantum circuit and options into a [qobj](https://arxiv.org/abs/1809.03452) JSON payload and submitting that to the IBM Quantum API. Since every backend interface is different (and in the case of the local simulators serialization may not be needed) it is expected that the backend’s [`run`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method will handle this conversion. +Of key importance is the [`run()`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method, which is used to actually submit circuits to a device or simulator. The run method handles submitting the circuits to the backend to be executed and returning a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object. Depending on the type of backend this typically involves serializing the circuit object into the API format used by a backend. For example, on IBMQ backends from the `qiskit-ibmq-provider` package this involves converting from a quantum circuit and options into a [qobj](https://arxiv.org/abs/1809.03452) JSON payload and submitting that to the IBM Quantum API. Since every backend interface is different (and in the case of the local simulators serialization may not be needed) it is expected that the backend’s [`run`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method will handle this conversion. An example run method would be something like: @@ -241,7 +241,7 @@ def run(self, circuits. **kwargs): ### Options -There are often several options for a backend that control how a circuit is run. The typical example of this is something like the number of `shots` which is how many times the circuit is to be executed. The options available for a backend are defined using an [`Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") object. This object is initially created by the [`_default_options`](qiskit.providers.BackendV1#qiskit.providers.BackendV1._default_options "qiskit.providers.BackendV1._default_options") method of a Backend class. The default options returns an initialized [`Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") object with all the default values for all the options a backend supports. For example, if the backend supports only supports `shots` the [`_default_options`](qiskit.providers.BackendV1#qiskit.providers.BackendV1._default_options "qiskit.providers.BackendV1._default_options") method would look like: +There are often several options for a backend that control how a circuit is run. The typical example of this is something like the number of `shots` which is how many times the circuit is to be executed. The options available for a backend are defined using an [`Options`](qiskit.providers.Options "qiskit.providers.Options") object. This object is initially created by the [`_default_options`](qiskit.providers.BackendV1#_default_options "qiskit.providers.BackendV1._default_options") method of a Backend class. The default options returns an initialized [`Options`](qiskit.providers.Options "qiskit.providers.Options") object with all the default values for all the options a backend supports. For example, if the backend supports only supports `shots` the [`_default_options`](qiskit.providers.BackendV1#_default_options "qiskit.providers.BackendV1._default_options") method would look like: ```python @classmethod @@ -251,9 +251,9 @@ def _default_options(cls): ## Job -The output from the [`run`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method is a [`JobV1`](qiskit.providers.JobV1#qiskit.providers.JobV1 "qiskit.providers.JobV1") object. Each provider is expected to implement a custom job subclass that defines the behavior for the provider. There are 2 types of jobs depending on the backend’s execution method, either a sync or async. By default jobs are considered async and the expectation is that it represents a handle to the async execution of the circuits submitted with `Backend.run()`. An async job object provides users the ability to query the status of the execution, cancel a running job, and block until the execution is finished. The [`result`](qiskit.providers.JobV1.result#qiskit.providers.JobV1.result "qiskit.providers.JobV1.result") is the primary user facing method which will block until the execution is complete and then will return a [`Result`](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result") object with results of the job. +The output from the [`run`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method is a [`JobV1`](qiskit.providers.JobV1 "qiskit.providers.JobV1") object. Each provider is expected to implement a custom job subclass that defines the behavior for the provider. There are 2 types of jobs depending on the backend’s execution method, either a sync or async. By default jobs are considered async and the expectation is that it represents a handle to the async execution of the circuits submitted with `Backend.run()`. An async job object provides users the ability to query the status of the execution, cancel a running job, and block until the execution is finished. The [`result`](qiskit.providers.JobV1#result "qiskit.providers.JobV1.result") is the primary user facing method which will block until the execution is complete and then will return a [`Result`](qiskit.result.Result "qiskit.result.Result") object with results of the job. -For some backends (mainly local simulators) the execution of circuits is a synchronous operation and there is no need to return a handle to a running job elsewhere. For sync jobs its expected that the [`run`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method on the backend will block until a [`Result`](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result") object is generated and the sync job will return with that inner [`Result`](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result") object. +For some backends (mainly local simulators) the execution of circuits is a synchronous operation and there is no need to return a handle to a running job elsewhere. For sync jobs its expected that the [`run`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method on the backend will block until a [`Result`](qiskit.result.Result "qiskit.result.Result") object is generated and the sync job will return with that inner [`Result`](qiskit.result.Result "qiskit.result.Result") object. An example job class for an async API based backend would look something like: @@ -344,24 +344,24 @@ These abstract interfaces are deprecated and will be removed in a future release ## Base Objects -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`BaseProvider`](qiskit.providers.BaseProvider#qiskit.providers.BaseProvider "qiskit.providers.BaseProvider")(\*args, \*\*kwargs) | Base class for a Backend Provider. | -| [`BaseBackend`](qiskit.providers.BaseBackend#qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")(configuration\[, provider]) | Legacy Base class for backends. | -| [`BaseJob`](qiskit.providers.BaseJob#qiskit.providers.BaseJob "qiskit.providers.BaseJob")(backend, job\_id) | DEPRECATED Legacy Class to handle asynchronous jobs | +| | | +| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| [`BaseProvider`](qiskit.providers.BaseProvider "qiskit.providers.BaseProvider")(\*args, \*\*kwargs) | Base class for a Backend Provider. | +| [`BaseBackend`](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")(configuration\[, provider]) | Legacy Base class for backends. | +| [`BaseJob`](qiskit.providers.BaseJob "qiskit.providers.BaseJob")(backend, job\_id) | DEPRECATED Legacy Class to handle asynchronous jobs | ## Job Status -| | | -| -------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`JobStatus`](qiskit.providers.JobStatus#qiskit.providers.JobStatus "qiskit.providers.JobStatus")(value) | Class for job status enumerated type. | +| | | +| ----------------------------------------------------------------------------- | ------------------------------------- | +| [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.JobStatus")(value) | Class for job status enumerated type. | ## Exceptions -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`QiskitBackendNotFoundError`](qiskit.providers.QiskitBackendNotFoundError#qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError")(\*message) | Base class for errors raised while looking for a backend. | -| [`BackendPropertyError`](qiskit.providers.BackendPropertyError#qiskit.providers.BackendPropertyError "qiskit.providers.BackendPropertyError")(\*message) | Base class for errors raised while looking for a backend property. | -| [`JobError`](qiskit.providers.JobError#qiskit.providers.JobError "qiskit.providers.JobError")(\*message) | Base class for errors raised by Jobs. | -| [`JobTimeoutError`](qiskit.providers.JobTimeoutError#qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError")(\*message) | Base class for timeout errors raised by jobs. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | +| [`QiskitBackendNotFoundError`](qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError")(\*message) | Base class for errors raised while looking for a backend. | +| [`BackendPropertyError`](qiskit.providers.BackendPropertyError "qiskit.providers.BackendPropertyError")(\*message) | Base class for errors raised while looking for a backend property. | +| [`JobError`](qiskit.providers.JobError "qiskit.providers.JobError")(\*message) | Base class for errors raised by Jobs. | +| [`JobTimeoutError`](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError")(\*message) | Base class for timeout errors raised by jobs. | diff --git a/docs/api/qiskit/0.32/providers_basicaer.md b/docs/api/qiskit/0.32/providers_basicaer.md index 4a6317b0061..264ac65e90e 100644 --- a/docs/api/qiskit/0.32/providers_basicaer.md +++ b/docs/api/qiskit/0.32/providers_basicaer.md @@ -26,27 +26,27 @@ backend = BasicAer.get_backend('qasm_simulator') ## Simulators -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | -| [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy#qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.QasmSimulatorPy")(\[configuration, provider]) | Python implementation of a qasm simulator. | -| [`StatevectorSimulatorPy`](qiskit.providers.basicaer.StatevectorSimulatorPy#qiskit.providers.basicaer.StatevectorSimulatorPy "qiskit.providers.basicaer.StatevectorSimulatorPy")(\[configuration, provider]) | Python statevector simulator. | -| [`UnitarySimulatorPy`](qiskit.providers.basicaer.UnitarySimulatorPy#qiskit.providers.basicaer.UnitarySimulatorPy "qiskit.providers.basicaer.UnitarySimulatorPy")(\[configuration, provider]) | Python implementation of a unitary simulator. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| [`QasmSimulatorPy`](qiskit.providers.basicaer.QasmSimulatorPy "qiskit.providers.basicaer.QasmSimulatorPy")(\[configuration, provider]) | Python implementation of a qasm simulator. | +| [`StatevectorSimulatorPy`](qiskit.providers.basicaer.StatevectorSimulatorPy "qiskit.providers.basicaer.StatevectorSimulatorPy")(\[configuration, provider]) | Python statevector simulator. | +| [`UnitarySimulatorPy`](qiskit.providers.basicaer.UnitarySimulatorPy "qiskit.providers.basicaer.UnitarySimulatorPy")(\[configuration, provider]) | Python implementation of a unitary simulator. | ## Provider -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`BasicAerProvider`](qiskit.providers.basicaer.BasicAerProvider#qiskit.providers.basicaer.BasicAerProvider "qiskit.providers.basicaer.BasicAerProvider")() | Provider for Basic Aer backends. | +| | | +| --------------------------------------------------------------------------------------------------------------- | -------------------------------- | +| [`BasicAerProvider`](qiskit.providers.basicaer.BasicAerProvider "qiskit.providers.basicaer.BasicAerProvider")() | Provider for Basic Aer backends. | ## Job Class -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | -| [`BasicAerJob`](qiskit.providers.basicaer.BasicAerJob#qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob")(backend, job\_id, result) | BasicAerJob class. | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------ | +| [`BasicAerJob`](qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob")(backend, job\_id, result) | BasicAerJob class. | ## Exceptions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`BasicAerError`](qiskit.providers.basicaer.BasicAerError#qiskit.providers.basicaer.BasicAerError "qiskit.providers.basicaer.BasicAerError")(\*message) | Base class for errors raised by Basic Aer. | +| | | +| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | +| [`BasicAerError`](qiskit.providers.basicaer.BasicAerError "qiskit.providers.basicaer.BasicAerError")(\*message) | Base class for errors raised by Basic Aer. | diff --git a/docs/api/qiskit/0.32/providers_models.md b/docs/api/qiskit/0.32/providers_models.md index 9bf5799a51d..0410883c2a5 100644 --- a/docs/api/qiskit/0.32/providers_models.md +++ b/docs/api/qiskit/0.32/providers_models.md @@ -20,16 +20,16 @@ Qiskit schema-conformant objects used by the backends and providers. ## Backend Objects -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")(backend\_name, …\[, …]) | Backwards compat shim representing an abstract backend configuration. | -| [`BackendProperties`](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")(backend\_name, …) | Class representing backend properties | -| [`BackendStatus`](qiskit.providers.models.BackendStatus#qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus")(backend\_name, backend\_version, …) | Class representing Backend Status. | -| [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration#qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.QasmBackendConfiguration")(backend\_name, …) | Class representing a Qasm Backend Configuration. | -| [`PulseBackendConfiguration`](qiskit.providers.models.PulseBackendConfiguration#qiskit.providers.models.PulseBackendConfiguration "qiskit.providers.models.PulseBackendConfiguration")(backend\_name, …) | Static configuration state for an OpenPulse enabled backend. | -| [`UchannelLO`](qiskit.providers.models.UchannelLO#qiskit.providers.models.UchannelLO "qiskit.providers.models.UchannelLO")(q, scale) | Class representing a U Channel LO | -| [`GateConfig`](qiskit.providers.models.GateConfig#qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig")(name, parameters, qasm\_def\[, …]) | Class representing a Gate Configuration | -| [`PulseDefaults`](qiskit.providers.models.PulseDefaults#qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults")(qubit\_freq\_est, meas\_freq\_est, …) | Description of default settings for Pulse systems. | -| [`Command`](qiskit.providers.models.Command#qiskit.providers.models.Command "qiskit.providers.models.Command")(name\[, qubits, sequence]) | Class representing a Command. | -| [`JobStatus`](qiskit.providers.models.JobStatus#qiskit.providers.models.JobStatus "qiskit.providers.models.JobStatus")(job\_id, status, status\_msg, \*\*kwargs) | Model for JobStatus. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | +| [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")(backend\_name, …\[, …]) | Backwards compat shim representing an abstract backend configuration. | +| [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")(backend\_name, …) | Class representing backend properties | +| [`BackendStatus`](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus")(backend\_name, backend\_version, …) | Class representing Backend Status. | +| [`QasmBackendConfiguration`](qiskit.providers.models.QasmBackendConfiguration "qiskit.providers.models.QasmBackendConfiguration")(backend\_name, …) | Class representing a Qasm Backend Configuration. | +| [`PulseBackendConfiguration`](qiskit.providers.models.PulseBackendConfiguration "qiskit.providers.models.PulseBackendConfiguration")(backend\_name, …) | Static configuration state for an OpenPulse enabled backend. | +| [`UchannelLO`](qiskit.providers.models.UchannelLO "qiskit.providers.models.UchannelLO")(q, scale) | Class representing a U Channel LO | +| [`GateConfig`](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig")(name, parameters, qasm\_def\[, …]) | Class representing a Gate Configuration | +| [`PulseDefaults`](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults")(qubit\_freq\_est, meas\_freq\_est, …) | Description of default settings for Pulse systems. | +| [`Command`](qiskit.providers.models.Command "qiskit.providers.models.Command")(name\[, qubits, sequence]) | Class representing a Command. | +| [`JobStatus`](qiskit.providers.models.JobStatus "qiskit.providers.models.JobStatus")(job\_id, status, status\_msg, \*\*kwargs) | Model for JobStatus. | diff --git a/docs/api/qiskit/0.32/pulse.md b/docs/api/qiskit/0.32/pulse.md index f3afeb242ee..7712df3aa2f 100644 --- a/docs/api/qiskit/0.32/pulse.md +++ b/docs/api/qiskit/0.32/pulse.md @@ -16,7 +16,7 @@ python_api_name: qiskit.pulse `qiskit.pulse` -Qiskit-Pulse is a pulse-level quantum programming kit. This lower level of programming offers the user more control than programming with [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") s. +Qiskit-Pulse is a pulse-level quantum programming kit. This lower level of programming offers the user more control than programming with [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") s. Extracting the greatest performance from quantum hardware requires real-time pulse-level instructions. Pulse answers that need: it enables the quantum physicist *user* to specify the exact time dynamics of an experiment. It is especially powerful for error mitigation techniques. @@ -32,18 +32,18 @@ This is sufficient to allow the quantum physicist to explore and correct for noi `qiskit.pulse.instructions` -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | -| [`Acquire`](qiskit.pulse.Acquire#qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.Call#qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.Delay#qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.Play#qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.SetFrequency#qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency#qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.SetPhase#qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.ShiftPhase#qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. | -| [`Snapshot`](qiskit.pulse.Snapshot#qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| [`instructions`](qiskit.pulse.instructions#module-qiskit.pulse.instructions "qiskit.pulse.instructions") | The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. | +| [`Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.Call "qiskit.pulse.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.Delay "qiskit.pulse.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.Play "qiskit.pulse.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.SetFrequency "qiskit.pulse.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.ShiftFrequency "qiskit.pulse.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.SetPhase "qiskit.pulse.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.ShiftPhase "qiskit.pulse.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. | +| [`Snapshot`](qiskit.pulse.Snapshot "qiskit.pulse.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Pulse Library (waveforms ) @@ -51,15 +51,15 @@ This is sufficient to allow the quantum physicist to explore and correct for noi `qiskit.pulse.library` -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| [`library`](qiskit.pulse.library#module-qiskit.pulse.library "qiskit.pulse.library") | This library provides Pulse users with convenient methods to build Pulse waveforms. | -| [`library.discrete`](qiskit.pulse.library.discrete#module-qiskit.pulse.library.discrete "qiskit.pulse.library.discrete") | Module for builtin discrete pulses. | -| [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform")(samples\[, name, epsilon, …]) | A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. | -| [`Constant`](qiskit.pulse.Constant#qiskit.pulse.Constant "qiskit.pulse.Constant")(duration, amp\[, name]) | A simple constant pulse, with an amplitude value and a duration: | -| [`Drag`](qiskit.pulse.Drag#qiskit.pulse.Drag "qiskit.pulse.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | -| [`Gaussian`](qiskit.pulse.Gaussian#qiskit.pulse.Gaussian "qiskit.pulse.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | -| [`GaussianSquare`](qiskit.pulse.GaussianSquare#qiskit.pulse.GaussianSquare "qiskit.pulse.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | +| | | +| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| [`library`](qiskit.pulse.library#module-qiskit.pulse.library "qiskit.pulse.library") | This library provides Pulse users with convenient methods to build Pulse waveforms. | +| [`library.discrete`](qiskit.pulse.library.discrete#module-qiskit.pulse.library.discrete "qiskit.pulse.library.discrete") | Module for builtin discrete pulses. | +| [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform")(samples\[, name, epsilon, …]) | A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. | +| [`Constant`](qiskit.pulse.Constant "qiskit.pulse.Constant")(duration, amp\[, name]) | A simple constant pulse, with an amplitude value and a duration: | +| [`Drag`](qiskit.pulse.Drag "qiskit.pulse.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | +| [`Gaussian`](qiskit.pulse.Gaussian "qiskit.pulse.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | +| [`GaussianSquare`](qiskit.pulse.GaussianSquare "qiskit.pulse.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | @@ -73,47 +73,47 @@ Pulse is meant to be agnostic to the underlying hardware implementation, while s Channels are characterized by their type and their index. See each channel type below to learn more. -| | | -| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`channels`](qiskit.pulse.channels#module-qiskit.pulse.channels "qiskit.pulse.channels") | This module defines Pulse Channels. | -| [`DriveChannel`](qiskit.pulse.DriveChannel#qiskit.pulse.DriveChannel "qiskit.pulse.DriveChannel")(index) | Drive channels transmit signals to qubits which enact gate operations. | -| [`MeasureChannel`](qiskit.pulse.MeasureChannel#qiskit.pulse.MeasureChannel "qiskit.pulse.MeasureChannel")(index) | Measure channels transmit measurement stimulus pulses for readout. | -| [`AcquireChannel`](qiskit.pulse.AcquireChannel#qiskit.pulse.AcquireChannel "qiskit.pulse.AcquireChannel")(index) | Acquire channels are used to collect data. | -| [`ControlChannel`](qiskit.pulse.ControlChannel#qiskit.pulse.ControlChannel "qiskit.pulse.ControlChannel")(index) | Control channels provide supplementary control over the qubit to the drive channel. | -| [`RegisterSlot`](qiskit.pulse.RegisterSlot#qiskit.pulse.RegisterSlot "qiskit.pulse.RegisterSlot")(index) | Classical resister slot channels represent classical registers (low-latency classical memory). | -| [`MemorySlot`](qiskit.pulse.MemorySlot#qiskit.pulse.MemorySlot "qiskit.pulse.MemorySlot")(index) | Memory slot channels represent classical memory storage. | +| | | +| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`channels`](qiskit.pulse.channels#module-qiskit.pulse.channels "qiskit.pulse.channels") | This module defines Pulse Channels. | +| [`DriveChannel`](qiskit.pulse.DriveChannel "qiskit.pulse.DriveChannel")(index) | Drive channels transmit signals to qubits which enact gate operations. | +| [`MeasureChannel`](qiskit.pulse.MeasureChannel "qiskit.pulse.MeasureChannel")(index) | Measure channels transmit measurement stimulus pulses for readout. | +| [`AcquireChannel`](qiskit.pulse.AcquireChannel "qiskit.pulse.AcquireChannel")(index) | Acquire channels are used to collect data. | +| [`ControlChannel`](qiskit.pulse.ControlChannel "qiskit.pulse.ControlChannel")(index) | Control channels provide supplementary control over the qubit to the drive channel. | +| [`RegisterSlot`](qiskit.pulse.RegisterSlot "qiskit.pulse.RegisterSlot")(index) | Classical resister slot channels represent classical registers (low-latency classical memory). | +| [`MemorySlot`](qiskit.pulse.MemorySlot "qiskit.pulse.MemorySlot")(index) | Memory slot channels represent classical memory storage. | ## Schedules Schedules are Pulse programs. They describe instruction sequences for the control hardware. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")(\*schedules\[, name, metadata]) | A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. | -| [`ScheduleBlock`](qiskit.pulse.ScheduleBlock#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")(\[name, metadata, …]) | A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. | -| [`Instruction`](qiskit.pulse.Instruction#qiskit.pulse.Instruction "qiskit.pulse.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | +| | | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule")(\*schedules\[, name, metadata]) | A quantum program *schedule* with exact time constraints for its instructions, operating over all input signal *channels* and supporting special syntaxes for building. | +| [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")(\[name, metadata, …]) | A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro to manage their relative timing. | +| [`Instruction`](qiskit.pulse.Instruction "qiskit.pulse.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | ## Configuration -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap#qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")() | Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction#qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type::. | +| | | +| ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`InstructionScheduleMap`](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")() | Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type::. | ## Schedule Transforms (qiskit.pulse.transforms) -Schedule transforms take [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") s as input and return modified [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. +Schedule transforms take [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s as input and return modified [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| [`transforms.align_measures`](qiskit.pulse.transforms.align_measures#qiskit.pulse.transforms.align_measures "qiskit.pulse.transforms.align_measures")(schedules\[, …]) | Return new schedules where measurements occur at the same physical time. | -| [`transforms.add_implicit_acquires`](qiskit.pulse.transforms.add_implicit_acquires#qiskit.pulse.transforms.add_implicit_acquires "qiskit.pulse.transforms.add_implicit_acquires")(schedule, …) | Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. | -| [`transforms.pad`](qiskit.pulse.transforms.pad#qiskit.pulse.transforms.pad "qiskit.pulse.transforms.pad")(schedule\[, channels, until, …]) | Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | +| [`transforms.align_measures`](qiskit.pulse.transforms.align_measures "qiskit.pulse.transforms.align_measures")(schedules\[, …]) | Return new schedules where measurements occur at the same physical time. | +| [`transforms.add_implicit_acquires`](qiskit.pulse.transforms.add_implicit_acquires "qiskit.pulse.transforms.add_implicit_acquires")(schedule, …) | Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. | +| [`transforms.pad`](qiskit.pulse.transforms.pad "qiskit.pulse.transforms.pad")(schedule\[, channels, until, …]) | Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedule.duration` or `until` if not `None`. | ## Exceptions -| | | -| ---------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`PulseError`](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError")(\*message) | Errors raised by the pulse module. | +| | | +| ---------------------------------------------------------------------------- | ---------------------------------- | +| [`PulseError`](qiskit.pulse.PulseError "qiskit.pulse.PulseError")(\*message) | Errors raised by the pulse module. | ## Pulse Builder (builder) @@ -121,7 +121,7 @@ Schedule transforms take [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedul The pulse builder interface is still in active development. It may have breaking API changes without deprecation warnings in future releases until otherwise indicated. -The pulse builder provides an imperative API for writing pulse programs with less difficulty than the [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") API. It contextually constructs a pulse schedule and then emits the schedule for execution. For example to play a series of pulses on channels is as simple as: +The pulse builder provides an imperative API for writing pulse programs with less difficulty than the [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") API. It contextually constructs a pulse schedule and then emits the schedule for execution. For example to play a series of pulses on channels is as simple as: ```python from qiskit import pulse @@ -141,11 +141,11 @@ pulse_prog.draw() ![../\_images/pulse\_0\_0.png](/images/api/qiskit/0.32/pulse_0_0.png) -In the future the pulse builder will be coupled to the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with an equivalent circuit builder interface. +In the future the pulse builder will be coupled to the [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") with an equivalent circuit builder interface. -| | | -| ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`build`](qiskit.pulse.builder.build#qiskit.pulse.builder.build "qiskit.pulse.builder.build")(\[backend, schedule, name, …]) | Create a context manager for launching the imperative pulse builder DSL. | +| | | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [`build`](qiskit.pulse.builder.build "qiskit.pulse.builder.build")(\[backend, schedule, name, …]) | Create a context manager for launching the imperative pulse builder DSL. | ### Channels @@ -166,12 +166,12 @@ with pulse.build(backend) as drive_sched: DriveChannel(0) ``` -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`acquire_channel`](qiskit.pulse.builder.acquire_channel#qiskit.pulse.builder.acquire_channel "qiskit.pulse.builder.acquire_channel")(qubit) | Return `AcquireChannel` for `qubit` on the active builder backend. | -| [`control_channels`](qiskit.pulse.builder.control_channels#qiskit.pulse.builder.control_channels "qiskit.pulse.builder.control_channels")(\*qubits) | Return `ControlChannel` for `qubit` on the active builder backend. | -| [`drive_channel`](qiskit.pulse.builder.drive_channel#qiskit.pulse.builder.drive_channel "qiskit.pulse.builder.drive_channel")(qubit) | Return `DriveChannel` for `qubit` on the active builder backend. | -| [`measure_channel`](qiskit.pulse.builder.measure_channel#qiskit.pulse.builder.measure_channel "qiskit.pulse.builder.measure_channel")(qubit) | Return `MeasureChannel` for `qubit` on the active builder backend. | +| | | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| [`acquire_channel`](qiskit.pulse.builder.acquire_channel "qiskit.pulse.builder.acquire_channel")(qubit) | Return `AcquireChannel` for `qubit` on the active builder backend. | +| [`control_channels`](qiskit.pulse.builder.control_channels "qiskit.pulse.builder.control_channels")(\*qubits) | Return `ControlChannel` for `qubit` on the active builder backend. | +| [`drive_channel`](qiskit.pulse.builder.drive_channel "qiskit.pulse.builder.drive_channel")(qubit) | Return `DriveChannel` for `qubit` on the active builder backend. | +| [`measure_channel`](qiskit.pulse.builder.measure_channel "qiskit.pulse.builder.measure_channel")(qubit) | Return `MeasureChannel` for `qubit` on the active builder backend. | ### Instructions @@ -206,22 +206,22 @@ drive_sched.draw() ![../\_images/pulse\_2\_0.png](/images/api/qiskit/0.32/pulse_2_0.png) -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](qiskit.pulse.builder.acquire#qiskit.pulse.builder.acquire "qiskit.pulse.builder.acquire")(duration, qubit\_or\_channel, …) | Acquire for a `duration` on a `channel` and store the result in a `register`. | -| [`barrier`](qiskit.pulse.builder.barrier#qiskit.pulse.builder.barrier "qiskit.pulse.builder.barrier")(\*channels\_or\_qubits\[, name]) | Barrier directive for a set of channels and qubits. | -| [`call`](qiskit.pulse.builder.call#qiskit.pulse.builder.call "qiskit.pulse.builder.call")(target\[, name, value\_dict]) | Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. | -| [`delay`](qiskit.pulse.builder.delay#qiskit.pulse.builder.delay "qiskit.pulse.builder.delay")(duration, channel\[, name]) | Delay on a `channel` for a `duration`. | -| [`play`](qiskit.pulse.builder.play#qiskit.pulse.builder.play "qiskit.pulse.builder.play")(pulse, channel\[, name]) | Play a `pulse` on a `channel`. | -| [`set_frequency`](qiskit.pulse.builder.set_frequency#qiskit.pulse.builder.set_frequency "qiskit.pulse.builder.set_frequency")(frequency, channel\[, name]) | Set the `frequency` of a pulse `channel`. | -| [`set_phase`](qiskit.pulse.builder.set_phase#qiskit.pulse.builder.set_phase "qiskit.pulse.builder.set_phase")(phase, channel\[, name]) | Set the `phase` of a pulse `channel`. | -| [`shift_frequency`](qiskit.pulse.builder.shift_frequency#qiskit.pulse.builder.shift_frequency "qiskit.pulse.builder.shift_frequency")(frequency, channel\[, name]) | Shift the `frequency` of a pulse `channel`. | -| [`shift_phase`](qiskit.pulse.builder.shift_phase#qiskit.pulse.builder.shift_phase "qiskit.pulse.builder.shift_phase")(phase, channel\[, name]) | Shift the `phase` of a pulse `channel`. | -| [`snapshot`](qiskit.pulse.builder.snapshot#qiskit.pulse.builder.snapshot "qiskit.pulse.builder.snapshot")(label\[, snapshot\_type]) | Simulator snapshot. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | +| [`acquire`](qiskit.pulse.builder.acquire "qiskit.pulse.builder.acquire")(duration, qubit\_or\_channel, …) | Acquire for a `duration` on a `channel` and store the result in a `register`. | +| [`barrier`](qiskit.pulse.builder.barrier "qiskit.pulse.builder.barrier")(\*channels\_or\_qubits\[, name]) | Barrier directive for a set of channels and qubits. | +| [`call`](qiskit.pulse.builder.call "qiskit.pulse.builder.call")(target\[, name, value\_dict]) | Call the `target` within the currently active builder context with arbitrary parameters which will be assigned to the target program. | +| [`delay`](qiskit.pulse.builder.delay "qiskit.pulse.builder.delay")(duration, channel\[, name]) | Delay on a `channel` for a `duration`. | +| [`play`](qiskit.pulse.builder.play "qiskit.pulse.builder.play")(pulse, channel\[, name]) | Play a `pulse` on a `channel`. | +| [`set_frequency`](qiskit.pulse.builder.set_frequency "qiskit.pulse.builder.set_frequency")(frequency, channel\[, name]) | Set the `frequency` of a pulse `channel`. | +| [`set_phase`](qiskit.pulse.builder.set_phase "qiskit.pulse.builder.set_phase")(phase, channel\[, name]) | Set the `phase` of a pulse `channel`. | +| [`shift_frequency`](qiskit.pulse.builder.shift_frequency "qiskit.pulse.builder.shift_frequency")(frequency, channel\[, name]) | Shift the `frequency` of a pulse `channel`. | +| [`shift_phase`](qiskit.pulse.builder.shift_phase "qiskit.pulse.builder.shift_phase")(phase, channel\[, name]) | Shift the `phase` of a pulse `channel`. | +| [`snapshot`](qiskit.pulse.builder.snapshot "qiskit.pulse.builder.snapshot")(label\[, snapshot\_type]) | Simulator snapshot. | ### Contexts -Builder aware contexts that modify the construction of a pulse program. For example an alignment context like [`align_right()`](qiskit.pulse.builder.align_right#qiskit.pulse.builder.align_right "qiskit.pulse.builder.align_right") may be used to align all pulses as late as possible in a pulse program. +Builder aware contexts that modify the construction of a pulse program. For example an alignment context like [`align_right()`](qiskit.pulse.builder.align_right "qiskit.pulse.builder.align_right") may be used to align all pulses as late as possible in a pulse program. ```python from qiskit import pulse @@ -241,19 +241,19 @@ pulse_prog.draw() ![../\_images/pulse\_3\_0.png](/images/api/qiskit/0.32/pulse_3_0.png) -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| [`align_equispaced`](qiskit.pulse.builder.align_equispaced#qiskit.pulse.builder.align_equispaced "qiskit.pulse.builder.align_equispaced")(duration) | Equispaced alignment pulse scheduling context. | -| [`align_func`](qiskit.pulse.builder.align_func#qiskit.pulse.builder.align_func "qiskit.pulse.builder.align_func")(duration, func) | Callback defined alignment pulse scheduling context. | -| [`align_left`](qiskit.pulse.builder.align_left#qiskit.pulse.builder.align_left "qiskit.pulse.builder.align_left")() | Left alignment pulse scheduling context. | -| [`align_right`](qiskit.pulse.builder.align_right#qiskit.pulse.builder.align_right "qiskit.pulse.builder.align_right")() | Right alignment pulse scheduling context. | -| [`align_sequential`](qiskit.pulse.builder.align_sequential#qiskit.pulse.builder.align_sequential "qiskit.pulse.builder.align_sequential")() | Sequential alignment pulse scheduling context. | -| [`circuit_scheduler_settings`](qiskit.pulse.builder.circuit_scheduler_settings#qiskit.pulse.builder.circuit_scheduler_settings "qiskit.pulse.builder.circuit_scheduler_settings")(\*\*settings) | Set the currently active circuit scheduler settings for this context. | -| [`frequency_offset`](qiskit.pulse.builder.frequency_offset#qiskit.pulse.builder.frequency_offset "qiskit.pulse.builder.frequency_offset")(frequency, \*channels\[, …]) | Shift the frequency of inputs channels on entry into context and undo on exit. | -| [`inline`](qiskit.pulse.builder.inline#qiskit.pulse.builder.inline "qiskit.pulse.builder.inline")() | Deprecated. | -| [`pad`](qiskit.pulse.builder.pad#qiskit.pulse.builder.pad "qiskit.pulse.builder.pad")(\*chs) | Deprecated. | -| [`phase_offset`](qiskit.pulse.builder.phase_offset#qiskit.pulse.builder.phase_offset "qiskit.pulse.builder.phase_offset")(phase, \*channels) | Shift the phase of input channels on entry into context and undo on exit. | -| [`transpiler_settings`](qiskit.pulse.builder.transpiler_settings#qiskit.pulse.builder.transpiler_settings "qiskit.pulse.builder.transpiler_settings")(\*\*settings) | Set the currently active transpiler settings for this context. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| [`align_equispaced`](qiskit.pulse.builder.align_equispaced "qiskit.pulse.builder.align_equispaced")(duration) | Equispaced alignment pulse scheduling context. | +| [`align_func`](qiskit.pulse.builder.align_func "qiskit.pulse.builder.align_func")(duration, func) | Callback defined alignment pulse scheduling context. | +| [`align_left`](qiskit.pulse.builder.align_left "qiskit.pulse.builder.align_left")() | Left alignment pulse scheduling context. | +| [`align_right`](qiskit.pulse.builder.align_right "qiskit.pulse.builder.align_right")() | Right alignment pulse scheduling context. | +| [`align_sequential`](qiskit.pulse.builder.align_sequential "qiskit.pulse.builder.align_sequential")() | Sequential alignment pulse scheduling context. | +| [`circuit_scheduler_settings`](qiskit.pulse.builder.circuit_scheduler_settings "qiskit.pulse.builder.circuit_scheduler_settings")(\*\*settings) | Set the currently active circuit scheduler settings for this context. | +| [`frequency_offset`](qiskit.pulse.builder.frequency_offset "qiskit.pulse.builder.frequency_offset")(frequency, \*channels\[, …]) | Shift the frequency of inputs channels on entry into context and undo on exit. | +| [`inline`](qiskit.pulse.builder.inline "qiskit.pulse.builder.inline")() | Deprecated. | +| [`pad`](qiskit.pulse.builder.pad "qiskit.pulse.builder.pad")(\*chs) | Deprecated. | +| [`phase_offset`](qiskit.pulse.builder.phase_offset "qiskit.pulse.builder.phase_offset")(phase, \*channels) | Shift the phase of input channels on entry into context and undo on exit. | +| [`transpiler_settings`](qiskit.pulse.builder.transpiler_settings "qiskit.pulse.builder.transpiler_settings")(\*\*settings) | Set the currently active transpiler settings for this context. | ### Macros @@ -274,15 +274,15 @@ with pulse.build(backend) as measure_sched: MemorySlot(0) ``` -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| [`measure`](qiskit.pulse.builder.measure#qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | -| [`measure_all`](qiskit.pulse.builder.measure_all#qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | -| [`delay_qubits`](qiskit.pulse.builder.delay_qubits#qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. | +| | | +| ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| [`measure`](qiskit.pulse.builder.measure "qiskit.pulse.builder.measure")(qubits\[, registers]) | Measure a qubit within the currently active builder context. | +| [`measure_all`](qiskit.pulse.builder.measure_all "qiskit.pulse.builder.measure_all")() | Measure all qubits within the currently active builder context. | +| [`delay_qubits`](qiskit.pulse.builder.delay_qubits "qiskit.pulse.builder.delay_qubits")(duration, \*qubits) | Insert delays on all of the `channels.Channel`s that correspond to the input `qubits` at the same time. | ### Circuit Gates -To use circuit level gates within your pulse program call a circuit with [`qiskit.pulse.builder.call()`](qiskit.pulse.builder.call#qiskit.pulse.builder.call "qiskit.pulse.builder.call"). +To use circuit level gates within your pulse program call a circuit with [`qiskit.pulse.builder.call()`](qiskit.pulse.builder.call "qiskit.pulse.builder.call"). These will be removed in future versions with the release of a circuit builder interface in which it will be possible to calibrate a gate in terms of pulses and use that gate in a circuit. @@ -300,13 +300,13 @@ with pulse.build(backend) as u3_sched: pulse.u3(math.pi, 0, math.pi, 0) ``` -| | | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`cx`](qiskit.pulse.builder.cx#qiskit.pulse.builder.cx "qiskit.pulse.builder.cx")(control, target) | Call a `CXGate` on the input physical qubits. | -| [`u1`](qiskit.pulse.builder.u1#qiskit.pulse.builder.u1 "qiskit.pulse.builder.u1")(theta, qubit) | Call a `U1Gate` on the input physical qubit. | -| [`u2`](qiskit.pulse.builder.u2#qiskit.pulse.builder.u2 "qiskit.pulse.builder.u2")(phi, lam, qubit) | Call a `U2Gate` on the input physical qubit. | -| [`u3`](qiskit.pulse.builder.u3#qiskit.pulse.builder.u3 "qiskit.pulse.builder.u3")(theta, phi, lam, qubit) | Call a `U3Gate` on the input physical qubit. | -| [`x`](qiskit.pulse.builder.x#qiskit.pulse.builder.x "qiskit.pulse.builder.x")(qubit) | Call a `XGate` on the input physical qubit. | +| | | +| --------------------------------------------------------------------------------- | --------------------------------------------- | +| [`cx`](qiskit.pulse.builder.cx "qiskit.pulse.builder.cx")(control, target) | Call a `CXGate` on the input physical qubits. | +| [`u1`](qiskit.pulse.builder.u1 "qiskit.pulse.builder.u1")(theta, qubit) | Call a `U1Gate` on the input physical qubit. | +| [`u2`](qiskit.pulse.builder.u2 "qiskit.pulse.builder.u2")(phi, lam, qubit) | Call a `U2Gate` on the input physical qubit. | +| [`u3`](qiskit.pulse.builder.u3 "qiskit.pulse.builder.u3")(theta, phi, lam, qubit) | Call a `U3Gate` on the input physical qubit. | +| [`x`](qiskit.pulse.builder.x "qiskit.pulse.builder.x")(qubit) | Call a `XGate` on the input physical qubit. | ### Utilities @@ -337,13 +337,13 @@ There are 160 samples in 3.5555555555555554e-08 seconds There are 1e-06 seconds in 4500 samples. ``` -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| [`active_backend`](qiskit.pulse.builder.active_backend#qiskit.pulse.builder.active_backend "qiskit.pulse.builder.active_backend")() | Get the backend of the currently active builder context. | -| [`active_transpiler_settings`](qiskit.pulse.builder.active_transpiler_settings#qiskit.pulse.builder.active_transpiler_settings "qiskit.pulse.builder.active_transpiler_settings")() | Return the current active builder context’s transpiler settings. | -| [`active_circuit_scheduler_settings`](qiskit.pulse.builder.active_circuit_scheduler_settings#qiskit.pulse.builder.active_circuit_scheduler_settings "qiskit.pulse.builder.active_circuit_scheduler_settings")() | Return the current active builder context’s circuit scheduler settings. | -| [`num_qubits`](qiskit.pulse.builder.num_qubits#qiskit.pulse.builder.num_qubits "qiskit.pulse.builder.num_qubits")() | Return number of qubits in the currently active backend. | -| [`qubit_channels`](qiskit.pulse.builder.qubit_channels#qiskit.pulse.builder.qubit_channels "qiskit.pulse.builder.qubit_channels")(qubit) | Returns the set of channels associated with a qubit. | -| [`samples_to_seconds`](qiskit.pulse.builder.samples_to_seconds#qiskit.pulse.builder.samples_to_seconds "qiskit.pulse.builder.samples_to_seconds")(samples) | Obtain the time in seconds that will elapse for the input number of samples on the active backend. | -| [`seconds_to_samples`](qiskit.pulse.builder.seconds_to_samples#qiskit.pulse.builder.seconds_to_samples "qiskit.pulse.builder.seconds_to_samples")(seconds) | Obtain the number of samples that will elapse in `seconds` on the active backend. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| [`active_backend`](qiskit.pulse.builder.active_backend "qiskit.pulse.builder.active_backend")() | Get the backend of the currently active builder context. | +| [`active_transpiler_settings`](qiskit.pulse.builder.active_transpiler_settings "qiskit.pulse.builder.active_transpiler_settings")() | Return the current active builder context’s transpiler settings. | +| [`active_circuit_scheduler_settings`](qiskit.pulse.builder.active_circuit_scheduler_settings "qiskit.pulse.builder.active_circuit_scheduler_settings")() | Return the current active builder context’s circuit scheduler settings. | +| [`num_qubits`](qiskit.pulse.builder.num_qubits "qiskit.pulse.builder.num_qubits")() | Return number of qubits in the currently active backend. | +| [`qubit_channels`](qiskit.pulse.builder.qubit_channels "qiskit.pulse.builder.qubit_channels")(qubit) | Returns the set of channels associated with a qubit. | +| [`samples_to_seconds`](qiskit.pulse.builder.samples_to_seconds "qiskit.pulse.builder.samples_to_seconds")(samples) | Obtain the time in seconds that will elapse for the input number of samples on the active backend. | +| [`seconds_to_samples`](qiskit.pulse.builder.seconds_to_samples "qiskit.pulse.builder.seconds_to_samples")(seconds) | Obtain the number of samples that will elapse in `seconds` on the active backend. | diff --git a/docs/api/qiskit/0.32/qasm.md b/docs/api/qiskit/0.32/qasm.md index 15780c51c44..e7c5e864bd4 100644 --- a/docs/api/qiskit/0.32/qasm.md +++ b/docs/api/qiskit/0.32/qasm.md @@ -18,16 +18,16 @@ python_api_name: qiskit.qasm ## QASM Routines -| | | -| ----------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| [`Qasm`](qiskit.qasm.Qasm#qiskit.qasm.Qasm "qiskit.qasm.Qasm")(\[filename, data]) | OPENQASM circuit object. | -| [`QasmError`](qiskit.qasm.QasmError#qiskit.qasm.QasmError "qiskit.qasm.QasmError")(\*msg) | Base class for errors raised while parsing OPENQASM. | +| | | +| ------------------------------------------------------------------- | ---------------------------------------------------- | +| [`Qasm`](qiskit.qasm.Qasm "qiskit.qasm.Qasm")(\[filename, data]) | OPENQASM circuit object. | +| [`QasmError`](qiskit.qasm.QasmError "qiskit.qasm.QasmError")(\*msg) | Base class for errors raised while parsing OPENQASM. | ## Pygments -| | | -| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`OpenQASMLexer`](qiskit.qasm.OpenQASMLexer#qiskit.qasm.OpenQASMLexer "qiskit.qasm.OpenQASMLexer")(\*args, \*\*kwds) | A pygments lexer for OpenQasm. | -| [`QasmHTMLStyle`](qiskit.qasm.QasmHTMLStyle#qiskit.qasm.QasmHTMLStyle "qiskit.qasm.QasmHTMLStyle")() | A style for OpenQasm in a HTML env (e.g. | -| [`QasmTerminalStyle`](qiskit.qasm.QasmTerminalStyle#qiskit.qasm.QasmTerminalStyle "qiskit.qasm.QasmTerminalStyle")() | A style for OpenQasm in a Terminal env (e.g. | +| | | +| ------------------------------------------------------------------------------------------ | -------------------------------------------- | +| [`OpenQASMLexer`](qiskit.qasm.OpenQASMLexer "qiskit.qasm.OpenQASMLexer")(\*args, \*\*kwds) | A pygments lexer for OpenQasm. | +| [`QasmHTMLStyle`](qiskit.qasm.QasmHTMLStyle "qiskit.qasm.QasmHTMLStyle")() | A style for OpenQasm in a HTML env (e.g. | +| [`QasmTerminalStyle`](qiskit.qasm.QasmTerminalStyle "qiskit.qasm.QasmTerminalStyle")() | A style for OpenQasm in a Terminal env (e.g. | diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md b/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md index 8efe4e719b6..8ca3e9ac38e 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AlgorithmError.md @@ -1,9 +1,18 @@ -# qiskit.algorithms.AlgorithmError +--- +title: AlgorithmError +description: API reference for qiskit.algorithms.AlgorithmError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.algorithms.AlgorithmError +--- +# qiskit.algorithms.AlgorithmError + -`AlgorithmError(*message)` +`AlgorithmError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/exceptions.py "view source code") For Algorithm specific errors. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md index 8469bf15a98..eda68be3b99 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplificationProblem.md @@ -1,8 +1,16 @@ -# AmplificationProblem +--- +title: AmplificationProblem +description: API reference for qiskit.algorithms.AmplificationProblem +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.AmplificationProblem +--- +# AmplificationProblem + -`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)` +`AmplificationProblem(oracle, state_preparation=None, grover_operator=None, post_processing=None, objective_qubits=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_amplifiers/amplification_problem.py "view source code") Bases: `object` @@ -17,7 +25,7 @@ This class contains all problem-specific information required to run an amplitud * **grover\_operator** (`Optional`\[`QuantumCircuit`]) – The Grover operator $\mathcal{Q}$ used as unitary in the phase estimation circuit. If None, this operator is constructed from the `oracle` and `state_preparation`. * **post\_processing** (`Optional`\[`Callable`\[\[`str`], `Any`]]) – A mapping applied to the most likely bitstring. * **objective\_qubits** (`Union`\[`int`, `List`\[`int`], `None`]) – If set, specifies the indices of the qubits that should be measured. If None, all qubits will be measured. The `is_good_state` function will be applied on the measurement outcome of these qubits. -* **is\_good\_state** (`Union`\[`Callable`\[\[`str`], `bool`], `List`\[`int`], `List`\[`str`], `Statevector`, `None`]) – A function to check whether a string represents a good state. By default if the `oracle` argument has an `evaluate_bitstring` method (currently only provided by the [`PhaseOracle`](qiskit.circuit.library.PhaseOracle#qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") class) this will be used, otherwise this kwarg is required and **must** be specified. +* **is\_good\_state** (`Union`\[`Callable`\[\[`str`], `bool`], `List`\[`int`], `List`\[`str`], `Statevector`, `None`]) – A function to check whether a string represents a good state. By default if the `oracle` argument has an `evaluate_bitstring` method (currently only provided by the [`PhaseOracle`](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") class) this will be used, otherwise this kwarg is required and **must** be specified. **Raises** @@ -25,7 +33,7 @@ This class contains all problem-specific information required to run an amplitud ## Attributes - + ### grover\_operator @@ -41,7 +49,7 @@ If the Grover operator is not set, we try to build it from the $\mathcal{A}$ ope The Grover operator, or None if neither the Grover operator nor the $\mathcal{A}$ operator is set. - + ### is\_good\_state @@ -55,7 +63,7 @@ Check whether a provided bitstring is a good state or not. A callable that takes in a bitstring and returns True if the measurement is a good state, False otherwise. - + ### objective\_qubits @@ -69,7 +77,7 @@ The indices of the objective qubits. The indices of the objective qubits as list of integers. - + ### oracle @@ -83,7 +91,7 @@ Return the oracle. The oracle. - + ### post\_processing @@ -97,7 +105,7 @@ Apply post processing to the input value. A handle to the post processing function. Acts as identity by default. - + ### state\_preparation @@ -110,3 +118,4 @@ Get the state preparation operator $\mathcal{A}$. **Returns** The $\mathcal{A}$ operator as QuantumCircuit. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md index 67afef4cc65..d357be4f5aa 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimation.md @@ -1,8 +1,16 @@ -# AmplitudeEstimation +--- +title: AmplitudeEstimation +description: API reference for qiskit.algorithms.AmplitudeEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.AmplitudeEstimation +--- +# AmplitudeEstimation + -`AmplitudeEstimation(num_eval_qubits, phase_estimation_circuit=None, iqft=None, quantum_instance=None)` +`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` @@ -41,17 +49,127 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`compute_confidence_interval`](qiskit.algorithms.AmplitudeEstimation.compute_confidence_interval#qiskit.algorithms.AmplitudeEstimation.compute_confidence_interval "qiskit.algorithms.AmplitudeEstimation.compute_confidence_interval") | Compute the (1 - alpha) confidence interval. | -| [`compute_mle`](qiskit.algorithms.AmplitudeEstimation.compute_mle#qiskit.algorithms.AmplitudeEstimation.compute_mle "qiskit.algorithms.AmplitudeEstimation.compute_mle") | Compute the Maximum Likelihood Estimator (MLE). | -| [`construct_circuit`](qiskit.algorithms.AmplitudeEstimation.construct_circuit#qiskit.algorithms.AmplitudeEstimation.construct_circuit "qiskit.algorithms.AmplitudeEstimation.construct_circuit") | Construct the Amplitude Estimation quantum circuit. | -| [`estimate`](qiskit.algorithms.AmplitudeEstimation.estimate#qiskit.algorithms.AmplitudeEstimation.estimate "qiskit.algorithms.AmplitudeEstimation.estimate") | Run the amplitude estimation algorithm on provided estimation problem. | -| [`evaluate_measurements`](qiskit.algorithms.AmplitudeEstimation.evaluate_measurements#qiskit.algorithms.AmplitudeEstimation.evaluate_measurements "qiskit.algorithms.AmplitudeEstimation.evaluate_measurements") | Evaluate the results from the circuit simulation. | +### compute\_confidence\_interval -## Attributes + + +`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. + +**Parameters** + +* **result** (`AmplitudeEstimationResult`) – An amplitude estimation result for which to compute the confidence interval. +* **alpha** (`float`) – Confidence level: compute the (1 - alpha) confidence interval. +* **kind** (`str`) – The method to compute the confidence interval, can be ‘fisher’, ‘observed\_fisher’ or ‘likelihood\_ratio’ (default) + +**Return type** + +`Tuple`\[`float`, `float`] + +**Returns** + +The (1 - alpha) confidence interval of the specified kind. + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If ‘mle’ is not in self.\_ret.keys() (i.e. run was not called yet). +* **NotImplementedError** – If the confidence interval method kind is not implemented. + +### compute\_mle + + + +`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). + +**Parameters** + +* **result** (`AmplitudeEstimationResult`) – An amplitude estimation result object. +* **apply\_post\_processing** (`bool`) – If True, apply the post processing to the MLE before returning it. + +**Return type** + +`float` + +**Returns** + +The MLE for the provided result object. + +### construct\_circuit + + + +`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. + +**Parameters** + +* **estimation\_problem** (`EstimationProblem`) – The estimation problem for which to construct the QAE circuit. +* **measurement** (`bool`) – Boolean flag to indicate if measurements should be included in the circuit. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The QuantumCircuit object for the constructed circuit. + +### estimate + + + +`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. + +**Parameters** + +**estimation\_problem** (`EstimationProblem`) – The estimation problem. + +**Return type** + +`AmplitudeEstimationResult` + +**Returns** + +An amplitude estimation results object. + +**Raises** + +**ValueError** – If state\_preparation or objective\_qubits are not set in the estimation\_problem. + +### evaluate\_measurements + + + +`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. +Given the probabilities from statevector simulation of the QAE circuit, compute the probabilities that the measurements y/gridpoints a are the best estimate. + +**Parameters** + +* **circuit\_results** (`Union`\[`Dict`\[`str`, `int`], `ndarray`]) – The circuit result from the QAE circuit. Can be either a counts dict or a statevector. +* **threshold** (`float`) – Measurements with probabilities below the threshold are discarded. + +**Return type** + +`Tuple`\[`Dict`\[`int`, `float`], `Dict`\[`float`, `float`]] + +**Returns** + +**Dictionaries containing the a gridpoints with respective probabilities and** + +y measurements with respective probabilities, in this order. + +## Attributes + + ### quantum\_instance @@ -64,3 +182,4 @@ Get the quantum instance. **Returns** The quantum instance used to run this algorithm. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md index bdb28f2a444..0ea6cb88896 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimationResult.md @@ -1,8 +1,16 @@ -# AmplitudeEstimationResult +--- +title: AmplitudeEstimationResult +description: API reference for qiskit.algorithms.AmplitudeEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.AmplitudeEstimationResult +--- +# AmplitudeEstimationResult + -`AmplitudeEstimationResult` +`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` @@ -10,13 +18,25 @@ The `AmplitudeEstimation` result object. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.AmplitudeEstimationResult.combine#qiskit.algorithms.AmplitudeEstimationResult.combine "qiskit.algorithms.AmplitudeEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`AmplitudeEstimationResult.combine(result)` +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +## Attributes + + ### circuit\_results @@ -26,7 +46,7 @@ Return the circuit results. Can be a statevector or counts dictionary. `Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`] - + ### confidence\_interval @@ -36,7 +56,7 @@ Return the confidence interval for the amplitude (95% interval by default). `Tuple`\[`float`, `float`] - + ### confidence\_interval\_processed @@ -46,7 +66,7 @@ Return the post-processed confidence interval (95% interval by default). `Tuple`\[`float`, `float`] - + ### estimation @@ -56,7 +76,7 @@ Return the estimation for the amplitude in $[0, 1]$. `float` - + ### estimation\_processed @@ -66,7 +86,7 @@ Return the estimation for the amplitude after the post-processing has been appli `float` - + ### max\_probability @@ -76,7 +96,7 @@ Return the maximum sampling probability. `float` - + ### measurements @@ -86,7 +106,7 @@ Return the measurements as integers with their measurement probability. `Dict`\[`int`, `float`] - + ### mle @@ -96,7 +116,7 @@ Return the MLE for the amplitude, in $\[0, 1]\$. `float` - + ### mle\_processed @@ -106,7 +126,7 @@ Return the post-processed MLE for the amplitude. `float` - + ### num\_evaluation\_qubits @@ -116,7 +136,7 @@ Returns the number of evaluation qubits. `int` - + ### num\_oracle\_queries @@ -126,7 +146,7 @@ Return the number of Grover oracle queries. `int` - + ### post\_processing @@ -136,7 +156,7 @@ Return a handle to the post processing function. `Callable`\[\[`float`], `float`] - + ### samples @@ -146,7 +166,7 @@ Return the measurement samples with their measurement probability. `Dict`\[`float`, `float`] - + ### samples\_processed @@ -156,7 +176,7 @@ Return the post-processed measurement samples with their measurement probability `Dict`\[`float`, `float`] - + ### shots @@ -165,3 +185,4 @@ Return the number of shots used. Is 1 for statevector-based simulations. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md index ba5d5704f4a..bd82b5983d1 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimator.md @@ -1,8 +1,16 @@ -# AmplitudeEstimator +--- +title: AmplitudeEstimator +description: API reference for qiskit.algorithms.AmplitudeEstimator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.AmplitudeEstimator +--- +# AmplitudeEstimator + -`AmplitudeEstimator` +`AmplitudeEstimator`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/amplitude_estimator.py "view source code") Bases: `object` @@ -10,6 +18,19 @@ The Amplitude Estimation interface. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`estimate`](qiskit.algorithms.AmplitudeEstimator.estimate#qiskit.algorithms.AmplitudeEstimator.estimate "qiskit.algorithms.AmplitudeEstimator.estimate") | Run the amplitude estimation algorithm. | +### estimate + + + +`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. + +**Parameters** + +**estimation\_problem** (`EstimationProblem`) – An `EstimationProblem` containing all problem-relevant information such as the state preparation and the objective qubits. + +**Return type** + +`AmplitudeEstimatorResult` + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md index 03a24d68bd2..d9fbb41272f 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.AmplitudeEstimatorResult.md @@ -1,8 +1,16 @@ -# AmplitudeEstimatorResult +--- +title: AmplitudeEstimatorResult +description: API reference for qiskit.algorithms.AmplitudeEstimatorResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.AmplitudeEstimatorResult +--- +# AmplitudeEstimatorResult + -`AmplitudeEstimatorResult` +`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` @@ -10,13 +18,25 @@ The results object for amplitude estimation algorithms. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.AmplitudeEstimatorResult.combine#qiskit.algorithms.AmplitudeEstimatorResult.combine "qiskit.algorithms.AmplitudeEstimatorResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`AmplitudeEstimatorResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. +**Raises** +**TypeError** – Argument is None + +**Return type** + +`None` + +## Attributes + + ### circuit\_results @@ -26,7 +46,7 @@ Return the circuit results. Can be a statevector or counts dictionary. `Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`] - + ### confidence\_interval @@ -36,7 +56,7 @@ Return the confidence interval for the amplitude (95% interval by default). `Tuple`\[`float`, `float`] - + ### confidence\_interval\_processed @@ -46,7 +66,7 @@ Return the post-processed confidence interval (95% interval by default). `Tuple`\[`float`, `float`] - + ### estimation @@ -56,7 +76,7 @@ Return the estimation for the amplitude in $[0, 1]$. `float` - + ### estimation\_processed @@ -66,7 +86,7 @@ Return the estimation for the amplitude after the post-processing has been appli `float` - + ### num\_oracle\_queries @@ -76,7 +96,7 @@ Return the number of Grover oracle queries. `int` - + ### post\_processing @@ -86,7 +106,7 @@ Return a handle to the post processing function. `Callable`\[\[`float`], `float`] - + ### shots @@ -95,3 +115,4 @@ Return the number of shots used. Is 1 for statevector-based simulations. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md index 1b2ace3447b..a7d3692f34c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Eigensolver.md @@ -1,8 +1,16 @@ -# Eigensolver +--- +title: Eigensolver +description: API reference for qiskit.algorithms.Eigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.Eigensolver +--- +# Eigensolver + -`Eigensolver` +`Eigensolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/eigen_solvers/eigen_solver.py "view source code") Bases: `abc.ABC` @@ -12,7 +20,40 @@ Algorithms that can compute eigenvalues for an operator may implement this inter ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_eigenvalues`](qiskit.algorithms.Eigensolver.compute_eigenvalues#qiskit.algorithms.Eigensolver.compute_eigenvalues "qiskit.algorithms.Eigensolver.compute_eigenvalues") | Computes eigenvalues. | -| [`supports_aux_operators`](qiskit.algorithms.Eigensolver.supports_aux_operators#qiskit.algorithms.Eigensolver.supports_aux_operators "qiskit.algorithms.Eigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_eigenvalues + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **aux\_operators** (`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. + +**Return type** + +`EigensolverResult` + +**Returns** + +EigensolverResult + +### supports\_aux\_operators + + + +`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. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md index a2a26e2a02f..9e8af705568 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.EigensolverResult.md @@ -1,8 +1,16 @@ -# EigensolverResult +--- +title: EigensolverResult +description: API reference for qiskit.algorithms.EigensolverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.EigensolverResult +--- +# EigensolverResult + -`EigensolverResult` +`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` @@ -10,13 +18,25 @@ Eigensolver Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.EigensolverResult.combine#qiskit.algorithms.EigensolverResult.combine "qiskit.algorithms.EigensolverResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`EigensolverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None +**Return type** + +`None` + +## Attributes + ### aux\_operator\_eigenvalues @@ -26,7 +46,7 @@ return aux operator eigen values `Optional`\[`ndarray`] - + ### eigenstates @@ -36,7 +56,7 @@ return eigen states `Optional`\[`ndarray`] - + ### eigenvalues @@ -45,3 +65,4 @@ returns eigen values **Return type** `Optional`\[`ndarray`] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md b/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md index 80544ac0ef4..0fa85780d22 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.EstimationProblem.md @@ -1,8 +1,16 @@ -# EstimationProblem +--- +title: EstimationProblem +description: API reference for qiskit.algorithms.EstimationProblem +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.EstimationProblem +--- +# EstimationProblem + -`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)` +`EstimationProblem(state_preparation, objective_qubits, grover_operator=None, post_processing=None, is_good_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/amplitude_estimators/estimation_problem.py "view source code") Bases: `object` @@ -20,13 +28,29 @@ This class contains all problem-specific information required to run an amplitud ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`rescale`](qiskit.algorithms.EstimationProblem.rescale#qiskit.algorithms.EstimationProblem.rescale "qiskit.algorithms.EstimationProblem.rescale") | Rescale the good state amplitude in the estimation problem. | +### rescale -## Attributes + + +`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. + +**Parameters** + +**scaling\_factor** (`float`) – The scaling factor in \[0, 1]. + +**Return type** +`EstimationProblem` +**Returns** + +A rescaled estimation problem. + +## Attributes + + ### grover\_operator @@ -42,7 +66,7 @@ If the Grover operator is not set, we try to build it from the $\mathcal{A}$ ope The Grover operator, or None if neither the Grover operator nor the $\mathcal{A}$ operator is set. - + ### is\_good\_state @@ -56,7 +80,7 @@ Checks whether a bitstring represents a good state. Handle to the `is_good_state` callable. - + ### objective\_qubits @@ -70,7 +94,7 @@ Get the criterion for a measurement outcome to be in a ‘good’ state. The criterion as list of qubit indices. - + ### post\_processing @@ -84,7 +108,7 @@ Apply post processing to the input value. A handle to the post processing function. Acts as identity by default. - + ### state\_preparation @@ -97,3 +121,4 @@ Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Returns** The $\mathcal{A}$ operator as QuantumCircuit. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md index 42671c66104..ccfa7df55d1 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimation.md @@ -1,8 +1,16 @@ -# FasterAmplitudeEstimation +--- +title: FasterAmplitudeEstimation +description: API reference for qiskit.algorithms.FasterAmplitudeEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.FasterAmplitudeEstimation +--- +# FasterAmplitudeEstimation + -`FasterAmplitudeEstimation(delta, maxiter, rescale=True, quantum_instance=None)` +`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` @@ -39,14 +47,49 @@ Due to the iterative version of the QPE, this algorithm does not require any add ## Methods -| | | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- | ------------ | -| [`construct_circuit`](qiskit.algorithms.FasterAmplitudeEstimation.construct_circuit#qiskit.algorithms.FasterAmplitudeEstimation.construct_circuit "qiskit.algorithms.FasterAmplitudeEstimation.construct_circuit") | Construct the circuit \$Q^k X | 0\rangle>\$. | -| [`estimate`](qiskit.algorithms.FasterAmplitudeEstimation.estimate#qiskit.algorithms.FasterAmplitudeEstimation.estimate "qiskit.algorithms.FasterAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | | +### construct\_circuit -## Attributes + + +`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>$. + +The A operator is the unitary specifying the QAE problem and Q the associated Grover operator. + +**Parameters** + +* **estimation\_problem** (`EstimationProblem`) – The estimation problem for which to construct the circuit. +* **k** (`int`) – The power of the Q operator. +* **measurement** (`bool`) – Boolean flag to indicate if measurements should be included in the circuits. + +**Return type** + +`Union`\[`QuantumCircuit`, `Tuple`\[`QuantumCircuit`, `List`\[`int`]]] + +**Returns** +The circuit $Q^k X |0\rangle$. +### estimate + + + +`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. + +**Parameters** + +**estimation\_problem** (`EstimationProblem`) – An `EstimationProblem` containing all problem-relevant information such as the state preparation and the objective qubits. + +**Return type** + +`FasterAmplitudeEstimationResult` + +## Attributes + + ### quantum\_instance @@ -59,3 +102,4 @@ Get the quantum instance. **Returns** The quantum instance used to run this algorithm. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md index 13b17f58693..7e80483cdc3 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.FasterAmplitudeEstimationResult.md @@ -1,8 +1,16 @@ -# FasterAmplitudeEstimationResult +--- +title: FasterAmplitudeEstimationResult +description: API reference for qiskit.algorithms.FasterAmplitudeEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.FasterAmplitudeEstimationResult +--- +# FasterAmplitudeEstimationResult + -`FasterAmplitudeEstimationResult` +`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` @@ -10,13 +18,25 @@ The result object for the Faster Amplitude Estimation algorithm. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.FasterAmplitudeEstimationResult.combine#qiskit.algorithms.FasterAmplitudeEstimationResult.combine "qiskit.algorithms.FasterAmplitudeEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`FasterAmplitudeEstimationResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** +**TypeError** – Argument is None +**Return type** + +`None` + +## Attributes + + ### circuit\_results @@ -26,7 +46,7 @@ Return the circuit results. Can be a statevector or counts dictionary. `Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`] - + ### confidence\_interval @@ -36,7 +56,7 @@ Return the confidence interval for the amplitude (95% interval by default). `Tuple`\[`float`, `float`] - + ### confidence\_interval\_processed @@ -46,7 +66,7 @@ Return the post-processed confidence interval (95% interval by default). `Tuple`\[`float`, `float`] - + ### estimation @@ -56,7 +76,7 @@ Return the estimation for the amplitude in $[0, 1]$. `float` - + ### estimation\_processed @@ -66,7 +86,7 @@ Return the estimation for the amplitude after the post-processing has been appli `float` - + ### num\_first\_state\_steps @@ -76,7 +96,7 @@ Return the number of steps taken in the first step of algorithm. `int` - + ### num\_oracle\_queries @@ -86,7 +106,7 @@ Return the number of Grover oracle queries. `int` - + ### num\_steps @@ -96,7 +116,7 @@ Return the total number of steps taken in the algorithm. `int` - + ### post\_processing @@ -106,7 +126,7 @@ Return a handle to the post processing function. `Callable`\[\[`float`], `float`] - + ### shots @@ -116,7 +136,7 @@ Return the number of shots used. Is 1 for statevector-based simulations. `int` - + ### success\_probability @@ -126,7 +146,7 @@ Return the success probability of the algorithm. `int` - + ### theta\_intervals @@ -135,3 +155,4 @@ Return the confidence intervals for the angles in each iteration. **Return type** `List`\[`List`\[`float`]] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md b/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md index 8ad3c33a508..c8b0ba5b749 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Grover.md @@ -1,8 +1,16 @@ -# Grover +--- +title: Grover +description: API reference for qiskit.algorithms.Grover +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.Grover +--- +# Grover + -`Grover(iterations=None, growth_rate=None, sample_from_iterations=False, quantum_instance=None)` +`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` @@ -41,7 +49,7 @@ $$ \mathcal{Q} = \mathcal{A} \mathcal{S}_0 \mathcal{A}^\dagger \mathcal{S}_f. $$ -For more information, see the [`GroverOperator`](qiskit.circuit.library.GroverOperator#qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator") in the circuit library. +For more information, see the [`GroverOperator`](qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator") in the circuit library. ## References @@ -77,16 +85,78 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`amplify`](qiskit.algorithms.Grover.amplify#qiskit.algorithms.Grover.amplify "qiskit.algorithms.Grover.amplify") | Run the Grover algorithm. | -| [`construct_circuit`](qiskit.algorithms.Grover.construct_circuit#qiskit.algorithms.Grover.construct_circuit "qiskit.algorithms.Grover.construct_circuit") | Construct the circuit for Grover’s algorithm with `power` Grover operators. | -| [`optimal_num_iterations`](qiskit.algorithms.Grover.optimal_num_iterations#qiskit.algorithms.Grover.optimal_num_iterations "qiskit.algorithms.Grover.optimal_num_iterations") | Return the optimal number of iterations, if the number of solutions is known. | +### amplify -## Attributes + + +`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. + +**Parameters** + +**amplification\_problem** (`AmplificationProblem`) – The amplification problem. + +**Return type** + +`GroverResult` + +**Returns** + +The result as a `GroverResult`, where e.g. the most likely state can be queried as `result.top_measurement`. + +### construct\_circuit + + + +`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. + +**Parameters** + +* **problem** (`AmplificationProblem`) – The amplification problem for the algorithm. +* **power** (`Optional`\[`int`]) – The number of times the Grover operator is repeated. If None, this argument is set to the first item in `iterations`. +* **measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** +the QuantumCircuit object for the constructed circuit +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ValueError** – If no power is passed and the iterations are not an integer. + +### optimal\_num\_iterations + + + +`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. + +**Parameters** + +* **num\_solutions** (`int`) – The number of solutions. +* **num\_qubits** (`int`) – The number of qubits used to encode the states. + +**Return type** + +`int` + +**Returns** + +The optimal number of iterations for Grover’s algorithm to succeed. + +## Attributes + + ### quantum\_instance Get the quantum instance. :rtype: `Optional`\[`QuantumInstance`] :returns: The quantum instance used to run this algorithm. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md index c27eba49c0e..0d3262e9fe5 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.GroverResult.md @@ -1,8 +1,16 @@ -# GroverResult +--- +title: GroverResult +description: API reference for qiskit.algorithms.GroverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.GroverResult +--- +# GroverResult + -`GroverResult` +`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` @@ -10,13 +18,25 @@ Grover Result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.GroverResult.combine#qiskit.algorithms.GroverResult.combine "qiskit.algorithms.GroverResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`GroverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. +**Raises** +**TypeError** – Argument is None + +**Return type** + +`None` + +## Attributes + + ### assignment @@ -30,7 +50,7 @@ The post-processed value of the most likely bitstring. The output of the `post_processing` function of the respective `AmplificationProblem`, where the input is the `top_measurement`. The type is the same as the return type of the post-processing function. - + ### circuit\_results @@ -40,7 +60,7 @@ Return the circuit results. Can be a statevector or counts dictionary. `Union`\[`List`\[`ndarray`], `List`\[`Dict`\[`str`, `int`]], `None`] - + ### iterations @@ -54,7 +74,7 @@ All the powers of the Grover operator that have been tried. The powers of the Grover operator tested. - + ### max\_probability @@ -64,7 +84,7 @@ Return the maximum sampling probability. `float` - + ### oracle\_evaluation @@ -78,7 +98,7 @@ Whether the classical oracle evaluation of the top measurement was True or False The classical oracle evaluation of the top measurement. - + ### top\_measurement @@ -91,3 +111,4 @@ The most frequently measured output as bitstring. **Returns** The most frequently measured output state. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md b/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md index 67cda18b0ee..2e834fb128c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HHL.md @@ -1,8 +1,16 @@ -# HHL +--- +title: HHL +description: API reference for qiskit.algorithms.HHL +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.HHL +--- +# HHL + -`HHL(epsilon=0.01, expectation=None, quantum_instance=None)` +`HHL(epsilon=0.01, expectation=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/hhl.py "view source code") Bases: `qiskit.algorithms.linear_solvers.linear_solver.LinearSolver` @@ -50,14 +58,63 @@ approx_result = solution.observable ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | -| [`construct_circuit`](qiskit.algorithms.HHL.construct_circuit#qiskit.algorithms.HHL.construct_circuit "qiskit.algorithms.HHL.construct_circuit") | Construct the HHL circuit. | -| [`solve`](qiskit.algorithms.HHL.solve#qiskit.algorithms.HHL.solve "qiskit.algorithms.HHL.solve") | Tries to solve the given linear system of equations. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **matrix** (`Union`\[`List`, `ndarray`, `QuantumCircuit`]) – The matrix specifying the system, i.e. A in Ax=b. +* **vector** (`Union`\[`List`, `ndarray`, `QuantumCircuit`]) – The vector specifying the right hand side of the equation in Ax=b. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The HHL circuit. + +**Raises** + +* **ValueError** – If the input is not in the correct format. +* **ValueError** – If the type of the input matrix is not supported. + +### solve + + +`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. + +**Parameters** + +* **matrix** (`Union`\[`List`, `ndarray`, `QuantumCircuit`]) – The matrix specifying the system, i.e. A in Ax=b. +* **vector** (`Union`\[`List`, `ndarray`, `QuantumCircuit`]) – The vector specifying the right hand side of the equation in Ax=b. +* **observable** (`Union`\[`LinearSystemObservable`, `BaseOperator`, `List`\[`LinearSystemObservable`], `List`\[`BaseOperator`], `None`]) – Optional information to be extracted from the solution. Default is the probability of success of the algorithm. +* **observable\_circuit** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `None`]) – Optional circuit to be applied to the solution to extract information. Default is None. +* **post\_processing** (`Optional`\[`Callable`\[\[`Union`\[`float`, `List`\[`float`]]], `Union`\[`float`, `List`\[`float`]]]]) – Optional function to compute the value of the observable. Default is the raw value of measuring the observable. + +**Raises** + +**ValueError** – If an invalid combination of observable, observable\_circuit and post\_processing is passed. + +**Return type** + +`LinearSolverResult` + +**Returns** + +The result object containing information about the solution vector of the linear system. + +## Attributes + + ### expectation @@ -67,7 +124,7 @@ The expectation value algorithm used to construct the expectation measurement fr `ExpectationBase` - + ### quantum\_instance @@ -81,7 +138,7 @@ Get the quantum instance. The quantum instance used to run this algorithm. - + ### scaling @@ -90,3 +147,4 @@ The scaling of the solution vector. **Return type** `float` + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md index 99a9b5d04aa..4d3d66e1511 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimation.md @@ -1,14 +1,22 @@ -# HamiltonianPhaseEstimation +--- +title: HamiltonianPhaseEstimation +description: API reference for qiskit.algorithms.HamiltonianPhaseEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.HamiltonianPhaseEstimation +--- +# HamiltonianPhaseEstimation + -`HamiltonianPhaseEstimation(num_evaluation_qubits, quantum_instance=None)` +`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` Run the Quantum Phase Estimation algorithm to find the eigenvalues of a Hermitian operator. -This class is nearly the same as [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation#qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation"), differing only in that the input in that class is a unitary operator, whereas here the input is a Hermitian operator from which a unitary will be obtained by scaling and exponentiating. The scaling is performed in order to prevent the phases from wrapping around $2\pi$. The problem of estimating eigenvalues $\lambda_j$ of the Hermitian operator $H$ is solved by running a circuit representing +This class is nearly the same as [`PhaseEstimation`](qiskit.algorithms.PhaseEstimation "qiskit.algorithms.PhaseEstimation"), differing only in that the input in that class is a unitary operator, whereas here the input is a Hermitian operator from which a unitary will be obtained by scaling and exponentiating. The scaling is performed in order to prevent the phases from wrapping around $2\pi$. The problem of estimating eigenvalues $\lambda_j$ of the Hermitian operator $H$ is solved by running a circuit representing $$ \exp(i b H) |\psi\rangle = \sum_j \exp(i b \lambda_j) c_j |\lambda_j\rangle, @@ -26,7 +34,7 @@ Here, $b$ is a scaling factor sufficiently large to map positive $\lambda$ to $[ If $H$ is a Pauli sum, the bound $b$ is computed from the sum of the absolute values of the coefficients of the terms. There is no way to reliably recover eigenvalues from phases very near the endpoints of these intervals. Because of this you should be aware that for degenerate cases, such as $H=Z$, the eigenvalues $\pm 1$ will be mapped to the same phase, $\pi$, and so cannot be distinguished. In this case, you need to specify a larger bound as an argument to the method `estimate`. -This class uses and works together with [`PhaseEstimationScale`](qiskit.algorithms.PhaseEstimationScale#qiskit.algorithms.PhaseEstimationScale "qiskit.algorithms.PhaseEstimationScale") to manage scaling the Hamiltonian and the phases that are obtained by the QPE algorithm. This includes setting, or computing, a bound on the eigenvalues of the operator, using this bound to obtain a scale factor, scaling the operator, and shifting and scaling the measured phases to recover the eigenvalues. +This class uses and works together with [`PhaseEstimationScale`](qiskit.algorithms.PhaseEstimationScale "qiskit.algorithms.PhaseEstimationScale") to manage scaling the Hamiltonian and the phases that are obtained by the QPE algorithm. This includes setting, or computing, a bound on the eigenvalues of the operator, using this bound to obtain a scale factor, scaling the operator, and shifting and scaling the measured phases to recover the eigenvalues. Note that, although we speak of “evolving” the state according the the Hamiltonian, in the present algorithm, we are not actually considering time evolution. Rather, the role of time is played by the scaling factor, which is chosen to best extract the eigenvalues of the Hamiltonian. @@ -45,6 +53,31 @@ T.E. O’Brien, B. Tarasinski, B.M. Terhal [arXiv:1809.09697](https://arxiv.org/ ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| [`estimate`](qiskit.algorithms.HamiltonianPhaseEstimation.estimate#qiskit.algorithms.HamiltonianPhaseEstimation.estimate "qiskit.algorithms.HamiltonianPhaseEstimation.estimate") | Run the Hamiltonian phase estimation algorithm. | +### estimate + + + +`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. + +**Parameters** + +* **hamiltonian** (`OperatorBase`) – A Hermitian operator. +* **state\_preparation** (`Optional`\[`StateFn`]) – The `StateFn` to be prepared, whose eigenphase will be measured. If this parameter is omitted, no preparation circuit will be run and input state will be the all-zero state in the computational basis. +* **evolution** (`Optional`\[`EvolutionBase`]) – An evolution converter that generates a unitary from `hamiltonian`. If `None`, then the default `PauliTrotterEvolution` is used. +* **bound** (`Optional`\[`float`]) – An upper bound on the absolute value of the eigenvalues of `hamiltonian`. If omitted, then `hamiltonian` must be a Pauli sum, or a `PauliOp`, in which case a bound will be computed. If `hamiltonian` is a `MatrixOp`, then `bound` may not be `None`. The tighter the bound, the higher the resolution of computed phases. + +**Return type** + +`HamiltonianPhaseEstimationResult` + +**Returns** + +HamiltonianPhaseEstimationResult instance containing the result of the estimation and diagnostic information. + +**Raises** + +* **ValueError** – If `bound` is `None` and `hamiltonian` is not a Pauli sum, i.e. a `PauliSumOp` or a `SummedOp` whose terms are of type `PauliOp`. +* **TypeError** – If `evolution` is not of type `EvolutionBase`. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md index eb7936fc3ef..ffd8680ce2a 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.HamiltonianPhaseEstimationResult.md @@ -1,8 +1,16 @@ -# HamiltonianPhaseEstimationResult +--- +title: HamiltonianPhaseEstimationResult +description: API reference for qiskit.algorithms.HamiltonianPhaseEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.HamiltonianPhaseEstimationResult +--- +# HamiltonianPhaseEstimationResult + -`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)` +`HamiltonianPhaseEstimationResult(phase_estimation_result, phase_estimation_scale, id_coefficient)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/phase_estimators/hamiltonian_phase_estimation_result.py "view source code") Bases: `qiskit.algorithms.algorithm_result.AlgorithmResult` @@ -20,14 +28,51 @@ This class is meant to be instantiated via HamiltonianPhaseEstimation.estimate. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.HamiltonianPhaseEstimationResult.combine#qiskit.algorithms.HamiltonianPhaseEstimationResult.combine "qiskit.algorithms.HamiltonianPhaseEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`filter_phases`](qiskit.algorithms.HamiltonianPhaseEstimationResult.filter_phases#qiskit.algorithms.HamiltonianPhaseEstimationResult.filter_phases "qiskit.algorithms.HamiltonianPhaseEstimationResult.filter_phases") | Filter phases as does PhaseEstimatorResult.filter\_phases, with the addition that phi is shifted and translated to return eigenvalues of the Hamiltonian. | +### combine -## Attributes + + +`HamiltonianPhaseEstimationResult.combine(result)` +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### filter\_phases + + + +`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. + +**Parameters** +* **cutoff** (`float`) – Minimum weight of number of counts required to keep a bit string. The default value is 0.0. +* **scaled** (`bool`) – If False, return phi in $[0, 1)$ rather than the eigenvalues of the Hamiltonian. +* **as\_float** (`bool`) – If True, returned keys are floats in $[0.0, 1.0)$. If False returned keys are bit strings. + +**Raises** + +**ValueError** – if as\_float is False and scaled is True. + +**Return type** + +`Dict`\[`Union`\[`str`, `float`], `float`] + +**Returns** + +A dict of filtered phases. + +## Attributes + + ### most\_likely\_eigenvalue @@ -43,7 +88,7 @@ This method calls most\_likely\_phase and scales the result to obtain an eigenva The most likely eigenvalue of the Hamiltonian. - + ### most\_likely\_phase @@ -57,7 +102,7 @@ DEPRECATED - The most likely phase of the unitary corresponding to the Hamiltoni The most likely phase. - + ### phase @@ -70,3 +115,4 @@ The most likely phase of the unitary corresponding to the Hamiltonian. **Returns** The most likely phase. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md index a792f3cd12b..9d8ce30f914 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimation.md @@ -1,8 +1,16 @@ -# IterativeAmplitudeEstimation +--- +title: IterativeAmplitudeEstimation +description: API reference for qiskit.algorithms.IterativeAmplitudeEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.IterativeAmplitudeEstimation +--- +# IterativeAmplitudeEstimation + -`IterativeAmplitudeEstimation(epsilon_target, alpha, confint_method='beta', min_ratio=2, quantum_instance=None)` +`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` @@ -34,21 +42,56 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea **Raises** -* [**AlgorithmError**](qiskit.algorithms.AlgorithmError#qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – if the method to compute the confidence intervals is not supported +* [**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – if the method to compute the confidence intervals is not supported * **ValueError** – If the target epsilon is not in (0, 0.5] * **ValueError** – If alpha is not in (0, 1) * **ValueError** – If confint\_method is not supported ## Methods -| | | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- | -| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. | -| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | | +### construct\_circuit -## Attributes + + +`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} \vert0\rangle$. + +The A operator is the unitary specifying the QAE problem and Q the associated Grover operator. + +**Parameters** + +* **estimation\_problem** (`EstimationProblem`) – The estimation problem for which to construct the QAE circuit. +* **k** (`int`) – The power of the Q operator. +* **measurement** (`bool`) – Boolean flag to indicate if measurements should be included in the circuits. + +**Return type** + +`QuantumCircuit` + +**Returns** +The circuit implementing $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. +### estimate + + + +`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. + +**Parameters** + +**estimation\_problem** (`EstimationProblem`) – An `EstimationProblem` containing all problem-relevant information such as the state preparation and the objective qubits. + +**Return type** + +`IterativeAmplitudeEstimationResult` + +## Attributes + + ### epsilon\_target @@ -62,7 +105,7 @@ Returns the target precision `epsilon_target` of the algorithm. The target precision (which is half the width of the confidence interval). - + ### quantum\_instance @@ -75,3 +118,4 @@ Get the quantum instance. **Returns** The quantum instance used to run this algorithm. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md index ecbe4b3e325..786a28ca73f 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativeAmplitudeEstimationResult.md @@ -1,8 +1,16 @@ -# IterativeAmplitudeEstimationResult +--- +title: IterativeAmplitudeEstimationResult +description: API reference for qiskit.algorithms.IterativeAmplitudeEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.IterativeAmplitudeEstimationResult +--- +# IterativeAmplitudeEstimationResult + -`IterativeAmplitudeEstimationResult` +`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` @@ -10,13 +18,25 @@ The `IterativeAmplitudeEstimation` result object. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.IterativeAmplitudeEstimationResult.combine#qiskit.algorithms.IterativeAmplitudeEstimationResult.combine "qiskit.algorithms.IterativeAmplitudeEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`IterativeAmplitudeEstimationResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None +**Return type** + +`None` + +## Attributes + ### alpha @@ -26,7 +46,7 @@ Return the confidence level $\alpha$. `float` - + ### circuit\_results @@ -36,7 +56,7 @@ Return the circuit results. Can be a statevector or counts dictionary. `Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`] - + ### confidence\_interval @@ -46,7 +66,7 @@ Return the confidence interval for the amplitude (95% interval by default). `Tuple`\[`float`, `float`] - + ### confidence\_interval\_processed @@ -56,7 +76,7 @@ Return the post-processed confidence interval. `Tuple`\[`float`, `float`] - + ### epsilon\_estimated @@ -66,7 +86,7 @@ Return the estimated half-width of the confidence interval. `float` - + ### epsilon\_estimated\_processed @@ -76,7 +96,7 @@ Return the post-processed estimated half-width of the confidence interval. `float` - + ### epsilon\_target @@ -86,7 +106,7 @@ Return the target half-width of the confidence interval. `float` - + ### estimate\_intervals @@ -96,7 +116,7 @@ Return the confidence intervals for the estimate in each iteration. `List`\[`List`\[`float`]] - + ### estimation @@ -106,7 +126,7 @@ Return the estimation for the amplitude in $[0, 1]$. `float` - + ### estimation\_processed @@ -116,7 +136,7 @@ Return the estimation for the amplitude after the post-processing has been appli `float` - + ### num\_oracle\_queries @@ -126,7 +146,7 @@ Return the number of Grover oracle queries. `int` - + ### post\_processing @@ -136,7 +156,7 @@ Return a handle to the post processing function. `Callable`\[\[`float`], `float`] - + ### powers @@ -146,7 +166,7 @@ Return the powers of the Grover operator in each iteration. `List`\[`int`] - + ### ratios @@ -156,7 +176,7 @@ Return the ratios $K_{i+1}/K_{i}$ for each iteration $i$. `List`\[`float`] - + ### shots @@ -166,7 +186,7 @@ Return the number of shots used. Is 1 for statevector-based simulations. `int` - + ### theta\_intervals @@ -175,3 +195,4 @@ Return the confidence intervals for the angles in each iteration. **Return type** `List`\[`List`\[`float`]] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md index de94cf3f9a1..734f5435191 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.IterativePhaseEstimation.md @@ -1,8 +1,16 @@ -# IterativePhaseEstimation +--- +title: IterativePhaseEstimation +description: API reference for qiskit.algorithms.IterativePhaseEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.IterativePhaseEstimation +--- +# IterativePhaseEstimation + -`IterativePhaseEstimation(num_iterations, quantum_instance=None)` +`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` @@ -25,7 +33,50 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`construct_circuit`](qiskit.algorithms.IterativePhaseEstimation.construct_circuit#qiskit.algorithms.IterativePhaseEstimation.construct_circuit "qiskit.algorithms.IterativePhaseEstimation.construct_circuit") | Construct the kth iteration Quantum Phase Estimation circuit. | -| [`estimate`](qiskit.algorithms.IterativePhaseEstimation.estimate#qiskit.algorithms.IterativePhaseEstimation.estimate "qiskit.algorithms.IterativePhaseEstimation.estimate") | Estimate the eigenphase of the input unitary and initial-state pair. | +### construct\_circuit + + + +`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. + +For details of parameters, see Fig. 2 in [https://arxiv.org/pdf/quant-ph/0610214.pdf](https://arxiv.org/pdf/quant-ph/0610214.pdf). + +**Parameters** + +* **unitary** (`QuantumCircuit`) – The circuit representing the unitary operator whose eigenvalue (via phase) will be measured. +* **state\_preparation** (`QuantumCircuit`) – The circuit that prepares the state whose eigenphase will be measured. If this parameter is omitted, no preparation circuit will be run and input state will be the all-zero state in the computational basis. +* **k** (`int`) – the iteration idx. +* **omega** (`float`) – the feedback angle. +* **measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** + +the quantum circuit per iteration + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### estimate + + + +`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. + +**Parameters** + +* **unitary** (`QuantumCircuit`) – The circuit representing the unitary operator whose eigenvalue (via phase) will be measured. +* **state\_preparation** (`QuantumCircuit`) – The circuit that prepares the state whose eigenphase will be measured. If this parameter is omitted, no preparation circuit will be run and input state will be the all-zero state in the computational basis. + +**Return type** + +`IterativePhaseEstimationResult` + +**Returns** + +Estimated phase in an IterativePhaseEstimationResult object. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md index a7ce5bec099..b467025bb12 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolver.md @@ -1,8 +1,16 @@ -# LinearSolver +--- +title: LinearSolver +description: API reference for qiskit.algorithms.LinearSolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.LinearSolver +--- +# LinearSolver + -`LinearSolver` +`LinearSolver`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/linear_solvers/linear_solver.py "view source code") Bases: `abc.ABC` @@ -10,6 +18,27 @@ An abstract class for linear system solvers in Qiskit. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| [`solve`](qiskit.algorithms.LinearSolver.solve#qiskit.algorithms.LinearSolver.solve "qiskit.algorithms.LinearSolver.solve") | Solve the system and compute the observable(s) | +### solve + + + +`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) + +**Parameters** + +* **matrix** (`Union`\[`ndarray`, `QuantumCircuit`]) – The matrix specifying the system, i.e. A in Ax=b. +* **vector** (`Union`\[`ndarray`, `QuantumCircuit`]) – The vector specifying the right hand side of the equation in Ax=b. +* **observable** (`Union`\[`LinearSystemObservable`, `BaseOperator`, `List`\[`LinearSystemObservable`], `List`\[`BaseOperator`], `None`]) – Optional information to be extracted from the solution. Default is the probability of success of the algorithm. +* **observable\_circuit** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `None`]) – Optional circuit to be applied to the solution to extract information. Default is `None`. +* **post\_processing** (`Optional`\[`Callable`\[\[`Union`\[`float`, `List`\[`float`]]], `Union`\[`float`, `List`\[`float`]]]]) – Optional function to compute the value of the observable. Default is the raw value of measuring the observable. + +**Return type** + +`LinearSolverResult` + +**Returns** + +The result of the linear system. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md index 74556df0eff..e94e8c97d93 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.LinearSolverResult.md @@ -1,8 +1,16 @@ -# LinearSolverResult +--- +title: LinearSolverResult +description: API reference for qiskit.algorithms.LinearSolverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.LinearSolverResult +--- +# LinearSolverResult + -`LinearSolverResult` +`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` @@ -12,13 +20,25 @@ The linear systems algorithms return an object of the type `LinearSystemsResult` ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.LinearSolverResult.combine#qiskit.algorithms.LinearSolverResult.combine "qiskit.algorithms.LinearSolverResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`LinearSolverResult.combine(result)` +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** +`None` + +## Attributes + + ### circuit\_results @@ -28,7 +48,7 @@ return the results from the circuits `Union`\[`List`\[`float`], `List`\[`Result`]] - + ### euclidean\_norm @@ -38,7 +58,7 @@ return the euclidean norm if the algorithm knows how to calculate it `float` - + ### observable @@ -48,7 +68,7 @@ return the (list of) calculated observable(s) `Union`\[`float`, `List`\[`float`]] - + ### state @@ -57,3 +77,4 @@ return either the circuit that prepares the solution or the solution as a vector **Return type** `Union`\[`QuantumCircuit`, `ndarray`] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md index a1c9de2b7ea..9f651ab998e 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -1,8 +1,16 @@ -# MaximumLikelihoodAmplitudeEstimation +--- +title: MaximumLikelihoodAmplitudeEstimation +description: API reference for qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation +--- +# MaximumLikelihoodAmplitudeEstimation + -`MaximumLikelihoodAmplitudeEstimation(evaluation_schedule, minimizer=None, quantum_instance=None)` +`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` @@ -32,16 +40,101 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`compute_confidence_interval`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval#qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.compute_confidence_interval") | Compute the alpha confidence interval using the method kind. | -| [`compute_mle`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.compute_mle#qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.compute_mle "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.compute_mle") | Compute the MLE via a grid-search. | -| [`construct_circuits`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.construct_circuits#qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.construct_circuits "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.construct_circuits") | Construct the Amplitude Estimation w/o QPE quantum circuits. | -| [`estimate`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.estimate#qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.estimate "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | +### compute\_confidence\_interval -## Attributes + + +`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. + +The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. + +**Parameters** +* **result** (`MaximumLikelihoodAmplitudeEstimationResult`) – A maximum likelihood amplitude estimation result. +* **alpha** (`float`) – The confidence level. +* **kind** (`str`) – The method to compute the confidence interval. Defaults to ‘fisher’, which computes the theoretical Fisher information. +* **apply\_post\_processing** (`bool`) – If True, apply post-processing to the confidence interval. +**Return type** + +`Tuple`\[`float`, `float`] + +**Returns** + +The specified confidence interval. + +**Raises** + +* [**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If run() hasn’t been called yet. +* **NotImplementedError** – If the method kind is not supported. + +### compute\_mle + + + +`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. + +This is a stable approach if sufficient gridpoints are used. + +**Parameters** + +* **circuit\_results** (`Union`\[`List`\[`Dict`\[`str`, `int`]], `List`\[`ndarray`]]) – A list of circuit outcomes. Can be counts or statevectors. +* **estimation\_problem** (`EstimationProblem`) – The estimation problem containing the evaluation schedule and the number of likelihood function evaluations used to find the minimum. +* **num\_state\_qubits** (`Optional`\[`int`]) – The number of state qubits, required for statevector simulations. +* **return\_counts** (`bool`) – If True, returns the good counts. + +**Return type** + +`Union`\[`float`, `Tuple`\[`float`, `List`\[`float`]]] + +**Returns** + +The MLE for the provided result object. + +### construct\_circuits + + + +`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. + +**Parameters** + +* **estimation\_problem** (`EstimationProblem`) – The estimation problem for which to construct the QAE circuit. +* **measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuits. + +**Return type** + +`List`\[`QuantumCircuit`] + +**Returns** + +A list with the QuantumCircuit objects for the algorithm. + +### estimate + + + +`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. + +**Parameters** + +**estimation\_problem** (`EstimationProblem`) – An `EstimationProblem` containing all problem-relevant information such as the state preparation and the objective qubits. + +**Return type** + +`MaximumLikelihoodAmplitudeEstimationResult` + +## Attributes + + ### quantum\_instance @@ -54,3 +147,4 @@ Get the quantum instance. **Returns** The quantum instance used to run this algorithm. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md index 9f4351f1a9e..a4549d470bf 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -1,8 +1,16 @@ -# MaximumLikelihoodAmplitudeEstimationResult +--- +title: MaximumLikelihoodAmplitudeEstimationResult +description: API reference for qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult +--- +# MaximumLikelihoodAmplitudeEstimationResult + -`MaximumLikelihoodAmplitudeEstimationResult` +`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` @@ -10,13 +18,25 @@ The `MaximumLikelihoodAmplitudeEstimation` result object. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.combine#qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.combine "qiskit.algorithms.MaximumLikelihoodAmplitudeEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`MaximumLikelihoodAmplitudeEstimationResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** +**TypeError** – Argument is None +**Return type** + +`None` + +## Attributes + + ### circuit\_results @@ -26,7 +46,7 @@ Return the circuit results. Can be a statevector or counts dictionary. `Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`] - + ### confidence\_interval @@ -36,7 +56,7 @@ Return the confidence interval for the amplitude (95% interval by default). `Tuple`\[`float`, `float`] - + ### confidence\_interval\_processed @@ -46,7 +66,7 @@ Return the post-processed confidence interval (95% interval by default). `Tuple`\[`float`, `float`] - + ### estimation @@ -56,7 +76,7 @@ Return the estimation for the amplitude in $[0, 1]$. `float` - + ### estimation\_processed @@ -66,7 +86,7 @@ Return the estimation for the amplitude after the post-processing has been appli `float` - + ### evaluation\_schedule @@ -76,7 +96,7 @@ Return the evaluation schedule for the powers of the Grover operator. `List`\[`int`] - + ### fisher\_information @@ -86,7 +106,7 @@ Return the Fisher information for the estimated amplitude. `float` - + ### good\_counts @@ -96,7 +116,7 @@ Return the percentage of good counts per circuit power. `List`\[`float`] - + ### minimizer @@ -106,7 +126,7 @@ Return the minimizer used for the search of the likelihood function. `callable` - + ### num\_oracle\_queries @@ -116,7 +136,7 @@ Return the number of Grover oracle queries. `int` - + ### post\_processing @@ -126,7 +146,7 @@ Return a handle to the post processing function. `Callable`\[\[`float`], `float`] - + ### shots @@ -136,7 +156,7 @@ Return the number of shots used. Is 1 for statevector-based simulations. `int` - + ### theta @@ -145,3 +165,4 @@ Return the estimate for the angle $\theta$. **Return type** `float` + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md index ac81e074306..1fa59d6cbab 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolver.md @@ -1,8 +1,16 @@ -# MinimumEigensolver +--- +title: MinimumEigensolver +description: API reference for qiskit.algorithms.MinimumEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.MinimumEigensolver +--- +# MinimumEigensolver + -`MinimumEigensolver` +`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` @@ -12,7 +20,42 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_minimum_eigenvalue`](qiskit.algorithms.MinimumEigensolver.compute_minimum_eigenvalue#qiskit.algorithms.MinimumEigensolver.compute_minimum_eigenvalue "qiskit.algorithms.MinimumEigensolver.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`supports_aux_operators`](qiskit.algorithms.MinimumEigensolver.supports_aux_operators#qiskit.algorithms.MinimumEigensolver.supports_aux_operators "qiskit.algorithms.MinimumEigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_minimum\_eigenvalue + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **aux\_operators** (`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### supports\_aux\_operators + + + +`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. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md index d88e75937aa..434d8f1b250 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.MinimumEigensolverResult.md @@ -1,8 +1,16 @@ -# MinimumEigensolverResult +--- +title: MinimumEigensolverResult +description: API reference for qiskit.algorithms.MinimumEigensolverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.MinimumEigensolverResult +--- +# MinimumEigensolverResult + -`MinimumEigensolverResult` +`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` @@ -10,13 +18,25 @@ Minimum Eigensolver Result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.MinimumEigensolverResult.combine#qiskit.algorithms.MinimumEigensolverResult.combine "qiskit.algorithms.MinimumEigensolverResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`MinimumEigensolverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None +**Return type** + +`None` + +## Attributes + ### aux\_operator\_eigenvalues @@ -26,7 +46,7 @@ return aux operator eigen values `Optional`\[`ndarray`] - + ### eigenstate @@ -36,7 +56,7 @@ return eigen state `Optional`\[`ndarray`] - + ### eigenvalue @@ -45,3 +65,4 @@ returns eigen value **Return type** `Optional`\[`complex`] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md index b29357fb239..9bbfcc4d1e1 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyEigensolver.md @@ -1,8 +1,16 @@ -# NumPyEigensolver +--- +title: NumPyEigensolver +description: API reference for qiskit.algorithms.NumPyEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.NumPyEigensolver +--- +# NumPyEigensolver + -`NumPyEigensolver(k=1, filter_criterion=None)` +`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` @@ -21,14 +29,46 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_eigenvalues`](qiskit.algorithms.NumPyEigensolver.compute_eigenvalues#qiskit.algorithms.NumPyEigensolver.compute_eigenvalues "qiskit.algorithms.NumPyEigensolver.compute_eigenvalues") | Computes eigenvalues. | -| [`supports_aux_operators`](qiskit.algorithms.NumPyEigensolver.supports_aux_operators#qiskit.algorithms.NumPyEigensolver.supports_aux_operators "qiskit.algorithms.NumPyEigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_eigenvalues -## Attributes + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **aux\_operators** (`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. + +**Return type** + +`EigensolverResult` + +**Returns** + +EigensolverResult +### supports\_aux\_operators + + +`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. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### filter\_criterion @@ -38,7 +78,7 @@ returns the filter criterion if set `Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] - + ### k @@ -47,3 +87,4 @@ returns k (number of eigenvalues requested) **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md index 3e0db5e61ae..e0429dd5e46 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyLinearSolver.md @@ -1,8 +1,16 @@ -# NumPyLinearSolver +--- +title: NumPyLinearSolver +description: API reference for qiskit.algorithms.NumPyLinearSolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.NumPyLinearSolver +--- +# NumPyLinearSolver + -`NumPyLinearSolver` +`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` @@ -30,6 +38,27 @@ result = solution.observable ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- | -| [`solve`](qiskit.algorithms.NumPyLinearSolver.solve#qiskit.algorithms.NumPyLinearSolver.solve "qiskit.algorithms.NumPyLinearSolver.solve") | Solve classically the linear system and compute the observable(s) | +### solve + + + +`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) + +**Parameters** + +* **matrix** (`Union`\[`ndarray`, `QuantumCircuit`]) – The matrix specifying the system, i.e. A in Ax=b. +* **vector** (`Union`\[`ndarray`, `QuantumCircuit`]) – The vector specifying the right hand side of the equation in Ax=b. +* **observable** (`Union`\[`LinearSystemObservable`, `BaseOperator`, `List`\[`BaseOperator`], `None`]) – Optional information to be extracted from the solution. Default is the probability of success of the algorithm. +* **observable\_circuit** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `None`]) – Optional circuit to be applied to the solution to extract information. Default is `None`. +* **post\_processing** (`Optional`\[`Callable`\[\[`Union`\[`float`, `List`\[`float`]]], `Union`\[`float`, `List`\[`float`]]]]) – Optional function to compute the value of the observable. Default is the raw value of measuring the observable. + +**Return type** + +`LinearSolverResult` + +**Returns** + +The result of the linear system. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md index 8ee1ac80e22..a468cd4132d 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.NumPyMinimumEigensolver.md @@ -1,8 +1,16 @@ -# NumPyMinimumEigensolver +--- +title: NumPyMinimumEigensolver +description: API reference for qiskit.algorithms.NumPyMinimumEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.NumPyMinimumEigensolver +--- +# NumPyMinimumEigensolver + -`NumPyMinimumEigensolver(filter_criterion=None)` +`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` @@ -14,14 +22,48 @@ The Numpy Minimum Eigensolver algorithm. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | -| [`compute_minimum_eigenvalue`](qiskit.algorithms.NumPyMinimumEigensolver.compute_minimum_eigenvalue#qiskit.algorithms.NumPyMinimumEigensolver.compute_minimum_eigenvalue "qiskit.algorithms.NumPyMinimumEigensolver.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`supports_aux_operators`](qiskit.algorithms.NumPyMinimumEigensolver.supports_aux_operators#qiskit.algorithms.NumPyMinimumEigensolver.supports_aux_operators "qiskit.algorithms.NumPyMinimumEigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_minimum\_eigenvalue -## Attributes + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **aux\_operators** (`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult +### supports\_aux\_operators + + +`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. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### filter\_criterion @@ -30,3 +72,4 @@ returns the filter criterion if set **Return type** `Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md index 75a0f4a826a..5646cc39b02 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimation.md @@ -1,8 +1,16 @@ -# PhaseEstimation +--- +title: PhaseEstimation +description: API reference for qiskit.algorithms.PhaseEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.PhaseEstimation +--- +# PhaseEstimation + -`PhaseEstimation(num_evaluation_qubits, quantum_instance=None)` +`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` @@ -49,8 +57,59 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`construct_circuit`](qiskit.algorithms.PhaseEstimation.construct_circuit#qiskit.algorithms.PhaseEstimation.construct_circuit "qiskit.algorithms.PhaseEstimation.construct_circuit") | Return the circuit to be executed to estimate phases. | -| [`estimate`](qiskit.algorithms.PhaseEstimation.estimate#qiskit.algorithms.PhaseEstimation.estimate "qiskit.algorithms.PhaseEstimation.estimate") | Build a phase estimation circuit and run the corresponding algorithm. | -| [`estimate_from_pe_circuit`](qiskit.algorithms.PhaseEstimation.estimate_from_pe_circuit#qiskit.algorithms.PhaseEstimation.estimate_from_pe_circuit "qiskit.algorithms.PhaseEstimation.estimate_from_pe_circuit") | Run the the phase estimation algorithm on a phase estimation circuit | +### construct\_circuit + + + +`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. + +This circuit includes as sub-circuits the core phase estimation circuit, with the addition of the state-preparation circuit and possibly measurement instructions. + +**Return type** + +`QuantumCircuit` + +### estimate + + + +`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. + +**Parameters** + +* **unitary** (`Optional`\[`QuantumCircuit`]) – The circuit representing the unitary operator whose eigenvalues (via phase) will be measured. +* **state\_preparation** (`Optional`\[`QuantumCircuit`]) – The circuit that prepares the state whose eigenphase will be measured. If this parameter is omitted, no preparation circuit will be run and input state will be the all-zero state in the computational basis. + +**Return type** + +`PhaseEstimationResult` + +**Returns** + +An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. + +### estimate\_from\_pe\_circuit + + + +`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 + +**Parameters** + +* **pe\_circuit** (`QuantumCircuit`) – The phase estimation circuit. +* **num\_unitary\_qubits** (`int`) – Must agree with the number of qubits in the unitary in pe\_circuit. + +**Return type** + +`PhaseEstimationResult` + +**Returns** + +An instance of qiskit.algorithms.phase\_estimator\_result.PhaseEstimationResult. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md index 2f0bdca3de2..9b7c64c8742 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationResult.md @@ -1,8 +1,16 @@ -# PhaseEstimationResult +--- +title: PhaseEstimationResult +description: API reference for qiskit.algorithms.PhaseEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.PhaseEstimationResult +--- +# PhaseEstimationResult + -`PhaseEstimationResult(num_evaluation_qubits, circuit_result, phases)` +`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` @@ -20,14 +28,48 @@ The canonical phase satisfying the `PhaseEstimator` interface, returned by the a ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.PhaseEstimationResult.combine#qiskit.algorithms.PhaseEstimationResult.combine "qiskit.algorithms.PhaseEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`filter_phases`](qiskit.algorithms.PhaseEstimationResult.filter_phases#qiskit.algorithms.PhaseEstimationResult.filter_phases "qiskit.algorithms.PhaseEstimationResult.filter_phases") | Return a filtered dict of phases (keys) and frequencies (values). | +### combine -## Attributes + + +`PhaseEstimationResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### filter\_phases + + + +`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). +Only phases with frequencies (counts) larger than cutoff are included. It is assumed that the run method has been called so that the phases have been computed. When using a noiseless, shot-based simulator to read a single phase that can be represented exactly by num\_evaluation\_qubits, all the weight will be concentrated on a single phase. In all other cases, many, or all, bit strings will have non-zero weight. This method is useful for filtering out these uninteresting bit strings. +**Parameters** + +* **cutoff** (`float`) – Minimum weight of number of counts required to keep a bit string. The default value is 0.0. +* **as\_float** (`bool`) – If True, returned keys are floats in $[0.0, 1.0)$. If False returned keys are bit strings. + +**Return type** + +`Dict` + +**Returns** + +A filtered dict of phases (keys) and frequencies (values). + +## Attributes + + ### circuit\_result @@ -39,7 +81,7 @@ This is useful for inspecting and troubleshooting the QPE algorithm. `Result` - + ### most\_likely\_phase @@ -51,7 +93,7 @@ DEPRECATED - Return the most likely phase as a number in $[0.0, 1.0)$. `float` - + ### phase @@ -63,7 +105,7 @@ Return the most likely phase as a number in $[0.0, 1.0)$. `float` - + ### phases @@ -74,3 +116,4 @@ This is an array or dict whose values correspond to weights on bit strings. **Return type** `Union`\[`ndarray`, `dict`] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md index 8fced54725b..6b02367ef38 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.PhaseEstimationScale.md @@ -1,8 +1,16 @@ -# PhaseEstimationScale +--- +title: PhaseEstimationScale +description: API reference for qiskit.algorithms.PhaseEstimationScale +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.PhaseEstimationScale +--- +# PhaseEstimationScale + -`PhaseEstimationScale(bound)` +`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` @@ -20,15 +28,81 @@ Increasing `bound` decreases the part of the interval $[0, 1)$ that is used to m ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| [`from_pauli_sum`](qiskit.algorithms.PhaseEstimationScale.from_pauli_sum#qiskit.algorithms.PhaseEstimationScale.from_pauli_sum "qiskit.algorithms.PhaseEstimationScale.from_pauli_sum") | Create a PhaseEstimationScale from a SummedOp representing a sum of Pauli Operators. | -| [`scale_phase`](qiskit.algorithms.PhaseEstimationScale.scale_phase#qiskit.algorithms.PhaseEstimationScale.scale_phase "qiskit.algorithms.PhaseEstimationScale.scale_phase") | Convert a phase into an eigenvalue. | -| [`scale_phases`](qiskit.algorithms.PhaseEstimationScale.scale_phases#qiskit.algorithms.PhaseEstimationScale.scale_phases "qiskit.algorithms.PhaseEstimationScale.scale_phases") | Convert a list or dict of phases to eigenvalues. | +### from\_pauli\_sum -## Attributes + + +`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. + +It is assumed that the `pauli_sum` is the sum of `PauliOp` objects. The bound on the absolute value of the eigenvalues of the sum is obtained as the sum of the absolute values of the coefficients of the terms. This is the best bound available in the generic case. A `PhaseEstimationScale` object is instantiated using this bound. + +**Parameters** + +**pauli\_sum** (`SummedOp`) – A `SummedOp` whose terms are `PauliOp` objects. + +**Raises** + +**ValueError** – if `pauli_sum` is not a sum of Pauli operators. + +**Return type** + +`PhaseEstimationScale` + +**Returns** + +A `PhaseEstimationScale` object + +### scale\_phase + + + +`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. + +The input phase `phi` corresponds to the eigenvalue of a unitary obtained by exponentiating a scaled Hermitian operator. Recall that the phase is obtained from `phi` as $2\pi\phi$. Furthermore, the Hermitian operator was scaled so that `phi` is restricted to $[-1/2, 1/2]$, corresponding to phases in $[-\pi, \pi]$. But the values of phi read from the phase-readout register are in $[0, 1)$. Any value of `phi` greater than $1/2$ corresponds to a raw phase of minus the complement with respect to 1. After this possible shift, the phase is scaled by the inverse of the factor by which the Hermitian operator was scaled to recover the eigenvalue of the Hermitian operator. + +**Parameters** +* **phi** (`float`) – Normalized phase in $[0, 1)$ to be converted to an eigenvalue. +* **id\_coefficient** (`float`) – All eigenvalues are shifted by this value. +**Return type** + +`float` + +**Returns** + +An eigenvalue computed from the input phase. + +### scale\_phases + + + +`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. + +The values in the list, or keys in the dict, are values of ```phi` and are converted as described in the description of ``scale_phase```. In case `phases` is a dict, the values of the dict are passed unchanged. + +**Parameters** + +* **phases** (`Union`\[`List`, `Dict`]) – a list or dict of values of `phi`. +* **id\_coefficient** (`float`) – All eigenvalues are shifted by this value. + +**Return type** + +`Union`\[`Dict`, `List`] + +**Returns** + +Eigenvalues computed from phases. + +## Attributes + + ### scale @@ -43,3 +117,4 @@ Return the scale factor by which a Hermitian operator must be multiplied so that **Returns** The scale factor. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md b/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md index 6b09fb6ac5d..3b6a7acc155 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.QAOA.md @@ -1,8 +1,16 @@ -# QAOA +--- +title: QAOA +description: API reference for qiskit.algorithms.QAOA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.QAOA +--- +# QAOA + -`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)` +`QAOA(optimizer=None, reps=1, initial_state=None, mixer=None, initial_point=None, gradient=None, expectation=None, include_custom=False, max_evals_grouped=1, callback=None, quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/minimum_eigen_solvers/qaoa.py "view source code") Bases: `qiskit.algorithms.minimum_eigen_solvers.vqe.VQE` @@ -10,7 +18,7 @@ The Quantum Approximate Optimization Algorithm. [QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. -The QAOA implementation directly extends [`VQE`](qiskit.algorithms.VQE#qiskit.algorithms.VQE "qiskit.algorithms.VQE") and inherits VQE’s optimization structure. However, unlike VQE, which can be configured with arbitrary ansatzes, QAOA uses its own fine-tuned ansatz, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the ansatz, and thus affects the approximation quality. +The QAOA implementation directly extends [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE") and inherits VQE’s optimization structure. However, unlike VQE, which can be configured with arbitrary ansatzes, QAOA uses its own fine-tuned ansatz, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the ansatz, and thus affects the approximation quality. An optional array of $2p$ parameter values, as the *initial\_point*, may be provided as the starting **beta** and **gamma** parameters (as identically named in the original [QAOA paper](https://arxiv.org/abs/1411.4028)) for the QAOA ansatz. @@ -24,7 +32,7 @@ An operator or a parameterized quantum circuit may optionally also be provided a * **mixer** (`Union`\[`QuantumCircuit`, `OperatorBase`, `None`]) – the mixer Hamiltonian to evolve with or a custom quantum circuit. Allows support of optimizations in constrained subspaces as per [https://arxiv.org/abs/1709.03489](https://arxiv.org/abs/1709.03489) as well as warm-starting the optimization as introduced in [http://arxiv.org/abs/2009.10095](http://arxiv.org/abs/2009.10095). * **initial\_point** (`Optional`\[`ndarray`]) – An optional initial point (i.e. initial parameter values) for the optimizer. If `None` then it will simply compute a random one. * **gradient** (`Union`\[`GradientBase`, `Callable`\[\[`Union`\[`ndarray`, `List`]], `List`], `None`]) – An optional gradient operator respectively a gradient function used for optimization. -* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the ansatz state function. When None (the default) an [`ExpectationFactory`](qiskit.opflow.expectations.ExpectationFactory#qiskit.opflow.expectations.ExpectationFactory "qiskit.opflow.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to True (defaults to False). +* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the ansatz state function. When None (the default) an [`ExpectationFactory`](qiskit.opflow.expectations.ExpectationFactory "qiskit.opflow.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to True (defaults to False). * **include\_custom** (`bool`) – When expectation parameter here is None setting this to True will allow the factory to include the custom Aer pauli expectation. * **max\_evals\_grouped** (`int`) – Max number of evaluations performed simultaneously. Signals the given optimizer that more than one set of parameters can be supplied so that potentially the expectation values can be computed in parallel. Typically this is possible when a finite difference gradient is used by the optimizer such that multiple points to compute the gradient can be passed and if computed in parallel improve overall execution time. Ignored if a gradient operator or function is given. * **callback** (`Optional`\[`Callable`\[\[`int`, `ndarray`, `float`, `float`], `None`]]) – a callback that can access the intermediate data during the optimization. Four parameter values are passed to the callback as follows during each evaluation by the optimizer for its current set of parameters as it works towards the minimum. These are: the evaluation count, the optimizer parameters for the ansatz, the evaluated mean and the evaluated standard deviation. @@ -32,25 +40,227 @@ An operator or a parameterized quantum circuit may optionally also be provided a ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| [`cleanup_parameterized_circuits`](qiskit.algorithms.QAOA.cleanup_parameterized_circuits#qiskit.algorithms.QAOA.cleanup_parameterized_circuits "qiskit.algorithms.QAOA.cleanup_parameterized_circuits") | set parameterized circuits to None | -| [`compute_minimum_eigenvalue`](qiskit.algorithms.QAOA.compute_minimum_eigenvalue#qiskit.algorithms.QAOA.compute_minimum_eigenvalue "qiskit.algorithms.QAOA.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`construct_circuit`](qiskit.algorithms.QAOA.construct_circuit#qiskit.algorithms.QAOA.construct_circuit "qiskit.algorithms.QAOA.construct_circuit") | Return the circuits used to compute the expectation value. | -| [`construct_expectation`](qiskit.algorithms.QAOA.construct_expectation#qiskit.algorithms.QAOA.construct_expectation "qiskit.algorithms.QAOA.construct_expectation") | Generate the ansatz circuit and expectation value measurement, and return their runnable composition. | -| [`find_minimum`](qiskit.algorithms.QAOA.find_minimum#qiskit.algorithms.QAOA.find_minimum "qiskit.algorithms.QAOA.find_minimum") | Optimize to find the minimum cost value. | -| [`get_energy_evaluation`](qiskit.algorithms.QAOA.get_energy_evaluation#qiskit.algorithms.QAOA.get_energy_evaluation "qiskit.algorithms.QAOA.get_energy_evaluation") | Returns a function handle to evaluates the energy at given parameters for the ansatz. | -| [`get_optimal_circuit`](qiskit.algorithms.QAOA.get_optimal_circuit#qiskit.algorithms.QAOA.get_optimal_circuit "qiskit.algorithms.QAOA.get_optimal_circuit") | Get the circuit with the optimal parameters. | -| [`get_optimal_cost`](qiskit.algorithms.QAOA.get_optimal_cost#qiskit.algorithms.QAOA.get_optimal_cost "qiskit.algorithms.QAOA.get_optimal_cost") | Get the minimal cost or energy found by the VQE. | -| [`get_optimal_vector`](qiskit.algorithms.QAOA.get_optimal_vector#qiskit.algorithms.QAOA.get_optimal_vector "qiskit.algorithms.QAOA.get_optimal_vector") | Get the simulation outcome of the optimal circuit. | -| [`get_prob_vector_for_params`](qiskit.algorithms.QAOA.get_prob_vector_for_params#qiskit.algorithms.QAOA.get_prob_vector_for_params "qiskit.algorithms.QAOA.get_prob_vector_for_params") | Helper function to get probability vectors for a set of params | -| [`get_probabilities_for_counts`](qiskit.algorithms.QAOA.get_probabilities_for_counts#qiskit.algorithms.QAOA.get_probabilities_for_counts "qiskit.algorithms.QAOA.get_probabilities_for_counts") | get probabilities for counts | -| [`print_settings`](qiskit.algorithms.QAOA.print_settings#qiskit.algorithms.QAOA.print_settings "qiskit.algorithms.QAOA.print_settings") | Preparing the setting of VQE into a string. | -| [`supports_aux_operators`](qiskit.algorithms.QAOA.supports_aux_operators#qiskit.algorithms.QAOA.supports_aux_operators "qiskit.algorithms.QAOA.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### cleanup\_parameterized\_circuits -## Attributes + + +`QAOA.cleanup_parameterized_circuits()` + +set parameterized circuits to None + +### compute\_minimum\_eigenvalue + + + +`QAOA.compute_minimum_eigenvalue(operator, aux_operators=None)` + +Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. + +**Parameters** + +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **aux\_operators** (`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### construct\_circuit + + + +`QAOA.construct_circuit(parameter, operator)` + +Return the circuits used to compute the expectation value. + +**Parameters** + +* **parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. +* **operator** (`OperatorBase`) – Qubit operator of the Observable + +**Return type** + +`List`\[`QuantumCircuit`] + +**Returns** + +A list of the circuits used to compute the expectation value. + +### construct\_expectation + + + +`QAOA.construct_expectation(parameter, operator, return_expectation=False)` + +Generate the ansatz circuit and expectation value measurement, and return their runnable composition. +**Parameters** + +* **parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **return\_expectation** (`bool`) – If True, return the `ExpectationBase` expectation converter used in the construction of the expectation value. Useful e.g. to compute the standard deviation of the expectation value. + +**Return type** + +`Union`\[`OperatorBase`, `Tuple`\[`OperatorBase`, `ExpectationBase`]] + +**Returns** + +The Operator equalling the measurement of the ansatz `StateFn` by the Observable’s expectation `StateFn`, and, optionally, the expectation converter. + +**Raises** + +* [**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If no operator has been provided. +* [**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If no expectation is passed and None could be inferred via the ExpectationFactory. + +### find\_minimum + + + +`QAOA.find_minimum(initial_point=None, ansatz=None, cost_fn=None, optimizer=None, gradient_fn=None)` + +Optimize to find the minimum cost value. + +**Parameters** + +* **initial\_point** (`Optional`\[`ndarray`]) – If not None will be used instead of any initial point supplied via constructor. If None and None was supplied to constructor then a random point will be used if the optimizer requires an initial point. +* **ansatz** (`Optional`\[`QuantumCircuit`]) – If not None will be used instead of any ansatz supplied via constructor. +* **cost\_fn** (`Optional`\[`Callable`]) – If not None will be used instead of any cost\_fn supplied via constructor. +* **optimizer** (`Optional`\[`Optimizer`]) – If not None will be used instead of any optimizer supplied via constructor. +* **gradient\_fn** (`Optional`\[`Callable`]) – Optional gradient function for optimizer + +**Returns** + +Optimized variational parameters, and corresponding minimum cost value. + +**Return type** + +dict + +**Raises** + +**ValueError** – invalid input + +### get\_energy\_evaluation + + + +`QAOA.get_energy_evaluation(operator, return_expectation=False)` + +Returns a function handle to evaluates the energy at given parameters for the ansatz. + +This is the objective function to be passed to the optimizer that is used for evaluation. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator whose energy to evaluate. +* **return\_expectation** (`bool`) – If True, return the `ExpectationBase` expectation converter used in the construction of the expectation value. Useful e.g. to evaluate other operators with the same expectation value converter. + +**Return type** +`Callable`\[\[`ndarray`], `Union`\[`float`, `List`\[`float`]]] + +**Returns** + +Energy of the hamiltonian of each parameter, and, optionally, the expectation converter. + +**Raises** + +**RuntimeError** – If the circuit is not parameterized (i.e. has 0 free parameters). + +### get\_optimal\_circuit + + + +`QAOA.get_optimal_circuit()` + +Get the circuit with the optimal parameters. + +**Return type** + +`QuantumCircuit` + +### get\_optimal\_cost + + + +`QAOA.get_optimal_cost()` + +Get the minimal cost or energy found by the VQE. + +**Return type** + +`float` + +### get\_optimal\_vector + + + +`QAOA.get_optimal_vector()` + +Get the simulation outcome of the optimal circuit. + +**Return type** + +`Union`\[`List`\[`float`], `Dict`\[`str`, `int`]] + +### get\_prob\_vector\_for\_params + + + +`QAOA.get_prob_vector_for_params(construct_circuit_fn, params_s, quantum_instance, construct_circuit_args=None)` + +Helper function to get probability vectors for a set of params + +### get\_probabilities\_for\_counts + + + +`QAOA.get_probabilities_for_counts(counts)` + +get probabilities for counts + +### print\_settings + + + +`QAOA.print_settings()` + +Preparing the setting of VQE into a string. + +**Returns** + +the formatted setting of VQE + +**Return type** + +str + +### supports\_aux\_operators + + + +`classmethod QAOA.supports_aux_operators()` + +Whether computing the expectation value of auxiliary operators is supported. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### ansatz @@ -60,7 +270,7 @@ Returns the ansatz. `Optional`\[`QuantumCircuit`] - + ### expectation @@ -70,7 +280,7 @@ The expectation value algorithm used to construct the expectation measurement fr `Optional`\[`ExpectationBase`] - + ### gradient @@ -80,7 +290,7 @@ Returns the gradient. `Union`\[`GradientBase`, `Callable`, `None`] - + ### initial\_point @@ -90,7 +300,7 @@ Returns initial point `Optional`\[`ndarray`] - + ### initial\_state @@ -100,7 +310,7 @@ Returns: Returns the initial state. `Optional`\[`QuantumCircuit`] - + ### mixer @@ -110,7 +320,7 @@ Returns: Returns the mixer. `Union`\[`QuantumCircuit`, `OperatorBase`] - + ### optimal\_params @@ -120,7 +330,7 @@ The optimal parameters for the ansatz. `ndarray` - + ### optimizer @@ -130,7 +340,7 @@ Returns optimizer `Optional`\[`Optimizer`] - + ### quantum\_instance @@ -140,8 +350,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### setting Prepare the setting of VQE as a string. + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md b/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md index 6ba24325a3c..943abc13d66 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.Shor.md @@ -1,8 +1,16 @@ -# Shor +--- +title: Shor +description: API reference for qiskit.algorithms.Shor +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.Shor +--- +# Shor + -`Shor(quantum_instance=None)` +`Shor(quantum_instance=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/factorizers/shor.py "view source code") Bases: `object` @@ -20,15 +28,71 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| [`construct_circuit`](qiskit.algorithms.Shor.construct_circuit#qiskit.algorithms.Shor.construct_circuit "qiskit.algorithms.Shor.construct_circuit") | Construct quantum part of the algorithm. | -| [`factor`](qiskit.algorithms.Shor.factor#qiskit.algorithms.Shor.factor "qiskit.algorithms.Shor.factor") | Execute the algorithm. | -| [`modinv`](qiskit.algorithms.Shor.modinv#qiskit.algorithms.Shor.modinv "qiskit.algorithms.Shor.modinv") | Returns the modular multiplicative inverse of a with respect to the modulus m. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **N** (`int`) – The odd integer to be factored, has a min. value of 3. +* **a** (`int`) – Any integer that satisfies 1 \< a \< N and gcd(a, N) = 1. +* **measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuit. + +**Return type** +`QuantumCircuit` + +**Returns** + +Quantum circuit. + +### factor + + + +`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. + +The input integer $N$ to be factored is expected to be odd and greater than 2. Even though this implementation is general, its capability will be limited by the capacity of the simulator/hardware. Another input integer $a$ can also be supplied, which needs to be a co-prime smaller than $N$ . + +**Parameters** +* **N** (`int`) – The odd integer to be factored, has a min. value of 3. +* **a** (`int`) – Any integer that satisfies 1 \< a \< N and gcd(a, N) = 1. + +**Returns** + +results of the algorithm. + +**Return type** + +[ShorResult](qiskit.algorithms.ShorResult "qiskit.algorithms.ShorResult") + +**Raises** + +* **ValueError** – Invalid input +* [**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If a quantum instance or backend has not been provided + +### modinv + + + +`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. + +**Return type** + +`int` + +## Attributes + + ### quantum\_instance @@ -37,3 +101,4 @@ Returns quantum instance. **Return type** `Optional`\[`QuantumInstance`] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md b/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md index afb3dd7fabe..301ee26f92b 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.ShorResult.md @@ -1,8 +1,16 @@ -# ShorResult +--- +title: ShorResult +description: API reference for qiskit.algorithms.ShorResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.ShorResult +--- +# ShorResult + -`ShorResult` +`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` @@ -10,13 +18,25 @@ Shor Result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`combine`](qiskit.algorithms.ShorResult.combine#qiskit.algorithms.ShorResult.combine "qiskit.algorithms.ShorResult.combine") | Any property from the argument that exists in the receiver is updated. | +### combine -## Attributes + + +`ShorResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None +**Return type** + +`None` + +## Attributes + ### factors @@ -26,7 +46,7 @@ returns factors `List`\[`List`\[`int`]] - + ### successful\_counts @@ -36,7 +56,7 @@ returns successful counts `int` - + ### total\_counts @@ -45,3 +65,4 @@ returns total counts **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md b/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md index 23de3faa354..85c5f13cd0b 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.VQE.md @@ -1,8 +1,16 @@ -# VQE +--- +title: VQE +description: API reference for qiskit.algorithms.VQE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.VQE +--- +# 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)` +`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` @@ -22,7 +30,7 @@ The length of the *initial\_point* list value must match the number of the param * **optimizer** (`Optional`\[`Optimizer`]) – A classical optimizer. * **initial\_point** (`Optional`\[`ndarray`]) – An optional initial point (i.e. initial parameter values) for the optimizer. If `None` then VQE will look to the ansatz for a preferred point and if not will simply compute a random one. * **gradient** (`Union`\[`GradientBase`, `Callable`, `None`]) – An optional gradient function or operator for optimizer. -* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the ansatz state function. When `None` (the default) an [`ExpectationFactory`](qiskit.opflow.expectations.ExpectationFactory#qiskit.opflow.expectations.ExpectationFactory "qiskit.opflow.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). +* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the ansatz state function. When `None` (the default) an [`ExpectationFactory`](qiskit.opflow.expectations.ExpectationFactory "qiskit.opflow.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). * **include\_custom** (`bool`) – When expectation parameter here is None setting this to `True` will allow the factory to include the custom Aer pauli expectation. * **max\_evals\_grouped** (`int`) – Max number of evaluations performed simultaneously. Signals the given optimizer that more than one set of parameters can be supplied so that potentially the expectation values can be computed in parallel. Typically this is possible when a finite difference gradient is used by the optimizer such that multiple points to compute the gradient can be passed and if computed in parallel improve overall execution time. Deprecated if a gradient operator or function is given. * **callback** (`Optional`\[`Callable`\[\[`int`, `ndarray`, `float`, `float`], `None`]]) – a callback that can access the intermediate data during the optimization. Four parameter values are passed to the callback as follows during each evaluation by the optimizer for its current set of parameters as it works towards the minimum. These are: the evaluation count, the optimizer parameters for the ansatz, the evaluated mean and the evaluated standard deviation.\` @@ -31,25 +39,227 @@ The length of the *initial\_point* list value must match the number of the param ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| [`cleanup_parameterized_circuits`](qiskit.algorithms.VQE.cleanup_parameterized_circuits#qiskit.algorithms.VQE.cleanup_parameterized_circuits "qiskit.algorithms.VQE.cleanup_parameterized_circuits") | set parameterized circuits to None | -| [`compute_minimum_eigenvalue`](qiskit.algorithms.VQE.compute_minimum_eigenvalue#qiskit.algorithms.VQE.compute_minimum_eigenvalue "qiskit.algorithms.VQE.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`construct_circuit`](qiskit.algorithms.VQE.construct_circuit#qiskit.algorithms.VQE.construct_circuit "qiskit.algorithms.VQE.construct_circuit") | Return the circuits used to compute the expectation value. | -| [`construct_expectation`](qiskit.algorithms.VQE.construct_expectation#qiskit.algorithms.VQE.construct_expectation "qiskit.algorithms.VQE.construct_expectation") | Generate the ansatz circuit and expectation value measurement, and return their runnable composition. | -| [`find_minimum`](qiskit.algorithms.VQE.find_minimum#qiskit.algorithms.VQE.find_minimum "qiskit.algorithms.VQE.find_minimum") | Optimize to find the minimum cost value. | -| [`get_energy_evaluation`](qiskit.algorithms.VQE.get_energy_evaluation#qiskit.algorithms.VQE.get_energy_evaluation "qiskit.algorithms.VQE.get_energy_evaluation") | Returns a function handle to evaluates the energy at given parameters for the ansatz. | -| [`get_optimal_circuit`](qiskit.algorithms.VQE.get_optimal_circuit#qiskit.algorithms.VQE.get_optimal_circuit "qiskit.algorithms.VQE.get_optimal_circuit") | Get the circuit with the optimal parameters. | -| [`get_optimal_cost`](qiskit.algorithms.VQE.get_optimal_cost#qiskit.algorithms.VQE.get_optimal_cost "qiskit.algorithms.VQE.get_optimal_cost") | Get the minimal cost or energy found by the VQE. | -| [`get_optimal_vector`](qiskit.algorithms.VQE.get_optimal_vector#qiskit.algorithms.VQE.get_optimal_vector "qiskit.algorithms.VQE.get_optimal_vector") | Get the simulation outcome of the optimal circuit. | -| [`get_prob_vector_for_params`](qiskit.algorithms.VQE.get_prob_vector_for_params#qiskit.algorithms.VQE.get_prob_vector_for_params "qiskit.algorithms.VQE.get_prob_vector_for_params") | Helper function to get probability vectors for a set of params | -| [`get_probabilities_for_counts`](qiskit.algorithms.VQE.get_probabilities_for_counts#qiskit.algorithms.VQE.get_probabilities_for_counts "qiskit.algorithms.VQE.get_probabilities_for_counts") | get probabilities for counts | -| [`print_settings`](qiskit.algorithms.VQE.print_settings#qiskit.algorithms.VQE.print_settings "qiskit.algorithms.VQE.print_settings") | Preparing the setting of VQE into a string. | -| [`supports_aux_operators`](qiskit.algorithms.VQE.supports_aux_operators#qiskit.algorithms.VQE.supports_aux_operators "qiskit.algorithms.VQE.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### cleanup\_parameterized\_circuits -## Attributes + + +`VQE.cleanup_parameterized_circuits()` + +set parameterized circuits to None + +### compute\_minimum\_eigenvalue + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **aux\_operators** (`Optional`\[`List`\[`Optional`\[`OperatorBase`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult +### construct\_circuit + + +`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. + +**Parameters** + +* **parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. +* **operator** (`OperatorBase`) – Qubit operator of the Observable + +**Return type** + +`List`\[`QuantumCircuit`] + +**Returns** + +A list of the circuits used to compute the expectation value. + +### construct\_expectation + + + +`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. + +**Parameters** + +* **parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. +* **operator** (`OperatorBase`) – Qubit operator of the Observable +* **return\_expectation** (`bool`) – If True, return the `ExpectationBase` expectation converter used in the construction of the expectation value. Useful e.g. to compute the standard deviation of the expectation value. + +**Return type** + +`Union`\[`OperatorBase`, `Tuple`\[`OperatorBase`, `ExpectationBase`]] + +**Returns** + +The Operator equalling the measurement of the ansatz `StateFn` by the Observable’s expectation `StateFn`, and, optionally, the expectation converter. + +**Raises** + +* [**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If no operator has been provided. +* [**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If no expectation is passed and None could be inferred via the ExpectationFactory. + +### find\_minimum + + + +`VQE.find_minimum(initial_point=None, ansatz=None, cost_fn=None, optimizer=None, gradient_fn=None)` + +Optimize to find the minimum cost value. + +**Parameters** + +* **initial\_point** (`Optional`\[`ndarray`]) – If not None will be used instead of any initial point supplied via constructor. If None and None was supplied to constructor then a random point will be used if the optimizer requires an initial point. +* **ansatz** (`Optional`\[`QuantumCircuit`]) – If not None will be used instead of any ansatz supplied via constructor. +* **cost\_fn** (`Optional`\[`Callable`]) – If not None will be used instead of any cost\_fn supplied via constructor. +* **optimizer** (`Optional`\[`Optimizer`]) – If not None will be used instead of any optimizer supplied via constructor. +* **gradient\_fn** (`Optional`\[`Callable`]) – Optional gradient function for optimizer + +**Returns** + +Optimized variational parameters, and corresponding minimum cost value. + +**Return type** + +dict + +**Raises** + +**ValueError** – invalid input + +### get\_energy\_evaluation + + + +`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. + +This is the objective function to be passed to the optimizer that is used for evaluation. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator whose energy to evaluate. +* **return\_expectation** (`bool`) – If True, return the `ExpectationBase` expectation converter used in the construction of the expectation value. Useful e.g. to evaluate other operators with the same expectation value converter. + +**Return type** + +`Callable`\[\[`ndarray`], `Union`\[`float`, `List`\[`float`]]] + +**Returns** + +Energy of the hamiltonian of each parameter, and, optionally, the expectation converter. + +**Raises** + +**RuntimeError** – If the circuit is not parameterized (i.e. has 0 free parameters). + +### get\_optimal\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +### get\_optimal\_cost + + + +`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. + +**Return type** + +`float` + +### get\_optimal\_vector + + + +`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. + +**Return type** + +`Union`\[`List`\[`float`], `Dict`\[`str`, `int`]] + +### get\_prob\_vector\_for\_params + + + +`VQE.get_prob_vector_for_params(construct_circuit_fn, params_s, quantum_instance, construct_circuit_args=None)` + +Helper function to get probability vectors for a set of params + +### get\_probabilities\_for\_counts + + + +`VQE.get_probabilities_for_counts(counts)` + +get probabilities for counts + +### print\_settings + + + +`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. + +**Returns** + +the formatted setting of VQE + +**Return type** + +str + +### supports\_aux\_operators + + + +`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. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### ansatz @@ -59,7 +269,7 @@ Returns the ansatz. `Optional`\[`QuantumCircuit`] - + ### expectation @@ -69,7 +279,7 @@ The expectation value algorithm used to construct the expectation measurement fr `Optional`\[`ExpectationBase`] - + ### gradient @@ -79,7 +289,7 @@ Returns the gradient. `Union`\[`GradientBase`, `Callable`, `None`] - + ### initial\_point @@ -89,7 +299,7 @@ Returns initial point `Optional`\[`ndarray`] - + ### optimal\_params @@ -99,7 +309,7 @@ The optimal parameters for the ansatz. `ndarray` - + ### optimizer @@ -109,7 +319,7 @@ Returns optimizer `Optional`\[`Optimizer`] - + ### quantum\_instance @@ -119,8 +329,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### setting Prepare the setting of VQE as a string. + 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 89afc48d9d8..c2c5cbbf0f6 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ADAM.md @@ -1,8 +1,16 @@ -# ADAM +--- +title: ADAM +description: API reference for qiskit.algorithms.optimizers.ADAM +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.ADAM +--- +# ADAM + -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -40,103 +48,261 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.ADAM.get_support_level#qiskit.algorithms.optimizers.ADAM.get_support_level "qiskit.algorithms.optimizers.ADAM.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.ADAM.gradient_num_diff#qiskit.algorithms.optimizers.ADAM.gradient_num_diff "qiskit.algorithms.optimizers.ADAM.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`load_params`](qiskit.algorithms.optimizers.ADAM.load_params#qiskit.algorithms.optimizers.ADAM.load_params "qiskit.algorithms.optimizers.ADAM.load_params") | Load iteration parameters for a file called `adam_params.csv`. | -| [`minimize`](qiskit.algorithms.optimizers.ADAM.minimize#qiskit.algorithms.optimizers.ADAM.minimize "qiskit.algorithms.optimizers.ADAM.minimize") | Run the minimization. | -| [`optimize`](qiskit.algorithms.optimizers.ADAM.optimize#qiskit.algorithms.optimizers.ADAM.optimize "qiskit.algorithms.optimizers.ADAM.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.ADAM.print_options#qiskit.algorithms.optimizers.ADAM.print_options "qiskit.algorithms.optimizers.ADAM.print_options") | Print algorithm-specific options. | -| [`save_params`](qiskit.algorithms.optimizers.ADAM.save_params#qiskit.algorithms.optimizers.ADAM.save_params "qiskit.algorithms.optimizers.ADAM.save_params") | Save the current iteration parameters to a file called `adam_params.csv`. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.ADAM.set_max_evals_grouped#qiskit.algorithms.optimizers.ADAM.set_max_evals_grouped "qiskit.algorithms.optimizers.ADAM.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.ADAM.set_options#qiskit.algorithms.optimizers.ADAM.set_options "qiskit.algorithms.optimizers.ADAM.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.ADAM.wrap_function#qiskit.algorithms.optimizers.ADAM.wrap_function "qiskit.algorithms.optimizers.ADAM.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static ADAM.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### load\_params + + + +`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`. + +**Parameters** + +**load\_dir** (`str`) – The directory containing `adam_params.csv`. + +**Return type** + +`None` + +### minimize + + + +`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. + +**Parameters** + +* **objective\_function** (`Callable`\[\[`ndarray`], `float`]) – A function handle to the objective function. +* **initial\_point** (`ndarray`) – The initial iteration point. +* **gradient\_function** (`Callable`\[\[`ndarray`], `float`]) – A function handle to the gradient of the objective function. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +A tuple of (optimal parameters, optimal value, number of iterations). + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (`int`) – Number of parameters to be optimized. +* **objective\_function** (`Callable`\[\[`ndarray`], `float`]) – Handle to a function that computes the objective function. +* **gradient\_function** (`Optional`\[`Callable`\[\[`ndarray`], `float`]]) – Handle to a function that computes the gradient of the objective function. +* **variable\_bounds** (`Optional`\[`List`\[`Tuple`\[`float`, `float`]]]) – deprecated +* **initial\_point** (`Optional`\[`ndarray`]) – The initial point for the optimization. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +A tuple (point, value, nfev) where + +> point: is a 1D numpy.ndarray\[float] containing the solution +> +> value: is a float with the objective function value +> +> nfev: is the number of objective function calls + +### print\_options + + +`ADAM.print_options()` +Print algorithm-specific options. + +### save\_params + + + +`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`. + + + The current parameters are appended to the file, if it exists already. The file is not overwritten. + + +**Parameters** + +**snapshot\_dir** (`str`) – The directory to store the file in. + +**Return type** + +`None` + +### set\_max\_evals\_grouped + + + +`ADAM.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`ADAM.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static ADAM.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 8fecc60bc94..9eb6256f9ba 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.AQGD.md @@ -1,8 +1,16 @@ -# AQGD +--- +title: AQGD +description: API reference for qiskit.algorithms.optimizers.AQGD +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.AQGD +--- +# AQGD + -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)` +`AQGD(maxiter=1000, eta=1.0, tol=1e-06, momentum=0.25, param_tol=1e-06, averaging=10)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/aqgd.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -28,104 +36,217 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. **Raises** -[**AlgorithmError**](qiskit.algorithms.AlgorithmError#qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If the length of `maxiter`, momentum\`, and `eta` is not the same. +[**AlgorithmError**](qiskit.algorithms.AlgorithmError "qiskit.algorithms.AlgorithmError") – If the length of `maxiter`, momentum\`, and `eta` is not the same. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.AQGD.get_support_level#qiskit.algorithms.optimizers.AQGD.get_support_level "qiskit.algorithms.optimizers.AQGD.get_support_level") | Support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.AQGD.gradient_num_diff#qiskit.algorithms.optimizers.AQGD.gradient_num_diff "qiskit.algorithms.optimizers.AQGD.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.AQGD.optimize#qiskit.algorithms.optimizers.AQGD.optimize "qiskit.algorithms.optimizers.AQGD.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.AQGD.print_options#qiskit.algorithms.optimizers.AQGD.print_options "qiskit.algorithms.optimizers.AQGD.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.AQGD.set_max_evals_grouped#qiskit.algorithms.optimizers.AQGD.set_max_evals_grouped "qiskit.algorithms.optimizers.AQGD.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.AQGD.set_options#qiskit.algorithms.optimizers.AQGD.set_options "qiskit.algorithms.optimizers.AQGD.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.AQGD.wrap_function#qiskit.algorithms.optimizers.AQGD.wrap_function "qiskit.algorithms.optimizers.AQGD.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +**Returns** + +**gradient, bounds and initial point** + +support information that is ignored/required. + +**Return type** + +Dict\[str, int] + +### gradient\_num\_diff + + + +`static AQGD.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + +`AQGD.print_options()` +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`AQGD.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`AQGD.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static AQGD.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 184c98fa669..6db1b85881e 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.BOBYQA.md @@ -1,8 +1,16 @@ -# BOBYQA +--- +title: BOBYQA +description: API reference for qiskit.algorithms.optimizers.BOBYQA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.BOBYQA +--- +# BOBYQA + -`BOBYQA(maxiter=1000)` +`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` @@ -18,104 +26,185 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.BOBYQA.get_support_level#qiskit.algorithms.optimizers.BOBYQA.get_support_level "qiskit.algorithms.optimizers.BOBYQA.get_support_level") | Returns support level dictionary. | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.BOBYQA.gradient_num_diff#qiskit.algorithms.optimizers.BOBYQA.gradient_num_diff "qiskit.algorithms.optimizers.BOBYQA.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.BOBYQA.optimize#qiskit.algorithms.optimizers.BOBYQA.optimize "qiskit.algorithms.optimizers.BOBYQA.optimize") | Runs the optimization. | -| [`print_options`](qiskit.algorithms.optimizers.BOBYQA.print_options#qiskit.algorithms.optimizers.BOBYQA.print_options "qiskit.algorithms.optimizers.BOBYQA.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.BOBYQA.set_max_evals_grouped#qiskit.algorithms.optimizers.BOBYQA.set_max_evals_grouped "qiskit.algorithms.optimizers.BOBYQA.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.BOBYQA.set_options#qiskit.algorithms.optimizers.BOBYQA.set_options "qiskit.algorithms.optimizers.BOBYQA.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.BOBYQA.wrap_function#qiskit.algorithms.optimizers.BOBYQA.wrap_function "qiskit.algorithms.optimizers.BOBYQA.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +### gradient\_num\_diff + + + +`static BOBYQA.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +### print\_options + + + +`BOBYQA.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`BOBYQA.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`BOBYQA.set_options(**kwargs)` +Sets or updates values in the options dictionary. +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static BOBYQA.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 f8ab7ebe90c..e4899ab96e1 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CG.md @@ -1,8 +1,16 @@ -# CG +--- +title: CG +description: API reference for qiskit.algorithms.optimizers.CG +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.CG +--- +# CG + -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` +`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cg.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -25,100 +33,199 @@ Uses scipy.optimize.minimize CG. For further detail, please refer to [https://do ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.CG.get_support_level#qiskit.algorithms.optimizers.CG.get_support_level "qiskit.algorithms.optimizers.CG.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.CG.gradient_num_diff#qiskit.algorithms.optimizers.CG.gradient_num_diff "qiskit.algorithms.optimizers.CG.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.CG.optimize#qiskit.algorithms.optimizers.CG.optimize "qiskit.algorithms.optimizers.CG.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.CG.print_options#qiskit.algorithms.optimizers.CG.print_options "qiskit.algorithms.optimizers.CG.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.CG.set_max_evals_grouped#qiskit.algorithms.optimizers.CG.set_max_evals_grouped "qiskit.algorithms.optimizers.CG.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.CG.set_options#qiskit.algorithms.optimizers.CG.set_options "qiskit.algorithms.optimizers.CG.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.CG.wrap_function#qiskit.algorithms.optimizers.CG.wrap_function "qiskit.algorithms.optimizers.CG.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`CG.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static CG.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`CG.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`CG.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`CG.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`CG.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static CG.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 5cb20269f30..85f09e4e59c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.COBYLA.md @@ -1,8 +1,16 @@ -# COBYLA +--- +title: COBYLA +description: API reference for qiskit.algorithms.optimizers.COBYLA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.COBYLA +--- +# COBYLA + -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)` +`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/cobyla.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -23,100 +31,199 @@ Uses scipy.optimize.minimize COBYLA. For further detail, please refer to [https: ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.COBYLA.get_support_level#qiskit.algorithms.optimizers.COBYLA.get_support_level "qiskit.algorithms.optimizers.COBYLA.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.COBYLA.gradient_num_diff#qiskit.algorithms.optimizers.COBYLA.gradient_num_diff "qiskit.algorithms.optimizers.COBYLA.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.COBYLA.optimize#qiskit.algorithms.optimizers.COBYLA.optimize "qiskit.algorithms.optimizers.COBYLA.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.COBYLA.print_options#qiskit.algorithms.optimizers.COBYLA.print_options "qiskit.algorithms.optimizers.COBYLA.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.COBYLA.set_max_evals_grouped#qiskit.algorithms.optimizers.COBYLA.set_max_evals_grouped "qiskit.algorithms.optimizers.COBYLA.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.COBYLA.set_options#qiskit.algorithms.optimizers.COBYLA.set_options "qiskit.algorithms.optimizers.COBYLA.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.COBYLA.wrap_function#qiskit.algorithms.optimizers.COBYLA.wrap_function "qiskit.algorithms.optimizers.COBYLA.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`COBYLA.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static COBYLA.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`COBYLA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`COBYLA.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`COBYLA.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`COBYLA.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static COBYLA.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 f0d57fb9a82..f52e1dd72f6 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.CRS.md @@ -1,14 +1,22 @@ -# CRS +--- +title: CRS +description: API reference for qiskit.algorithms.optimizers.CRS +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.CRS +--- +# CRS + -`CRS(max_evals=1000)` +`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` Controlled Random Search (CRS) with local mutation optimizer. -Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD#qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") local optimizer. +Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") local optimizer. NLopt global optimizer, derivative-free. For further detail, please refer to [https://nlopt.readthedocs.io/en/latest/NLopt\_Algorithms/#controlled-random-search-crs-with-local-mutation](https://nlopt.readthedocs.io/en/latest/NLopt_Algorithms/#controlled-random-search-crs-with-local-mutation) @@ -18,101 +26,211 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.algorithms.optimizers.CRS.get_nlopt_optimizer#qiskit.algorithms.optimizers.CRS.get_nlopt_optimizer "qiskit.algorithms.optimizers.CRS.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.algorithms.optimizers.CRS.get_support_level#qiskit.algorithms.optimizers.CRS.get_support_level "qiskit.algorithms.optimizers.CRS.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.CRS.gradient_num_diff#qiskit.algorithms.optimizers.CRS.gradient_num_diff "qiskit.algorithms.optimizers.CRS.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.CRS.optimize#qiskit.algorithms.optimizers.CRS.optimize "qiskit.algorithms.optimizers.CRS.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.CRS.print_options#qiskit.algorithms.optimizers.CRS.print_options "qiskit.algorithms.optimizers.CRS.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.CRS.set_max_evals_grouped#qiskit.algorithms.optimizers.CRS.set_max_evals_grouped "qiskit.algorithms.optimizers.CRS.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.CRS.set_options#qiskit.algorithms.optimizers.CRS.set_options "qiskit.algorithms.optimizers.CRS.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.CRS.wrap_function#qiskit.algorithms.optimizers.CRS.wrap_function "qiskit.algorithms.optimizers.CRS.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`CRS.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static CRS.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`CRS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`CRS.print_options()` + +Print algorithm-specific options. +### set\_max\_evals\_grouped + + +`CRS.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`CRS.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static CRS.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings + 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 307346e3e27..dccc95dd453 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 @@ -1,8 +1,16 @@ -# DIRECT\_L +--- +title: DIRECT_L +description: API reference for qiskit.algorithms.optimizers.DIRECT_L +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.DIRECT_L +--- +# DIRECT\_L + -`DIRECT_L(max_evals=1000)` +`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` @@ -18,101 +26,211 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.algorithms.optimizers.DIRECT_L.get_nlopt_optimizer#qiskit.algorithms.optimizers.DIRECT_L.get_nlopt_optimizer "qiskit.algorithms.optimizers.DIRECT_L.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.algorithms.optimizers.DIRECT_L.get_support_level#qiskit.algorithms.optimizers.DIRECT_L.get_support_level "qiskit.algorithms.optimizers.DIRECT_L.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.DIRECT_L.gradient_num_diff#qiskit.algorithms.optimizers.DIRECT_L.gradient_num_diff "qiskit.algorithms.optimizers.DIRECT_L.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.DIRECT_L.optimize#qiskit.algorithms.optimizers.DIRECT_L.optimize "qiskit.algorithms.optimizers.DIRECT_L.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.DIRECT_L.print_options#qiskit.algorithms.optimizers.DIRECT_L.print_options "qiskit.algorithms.optimizers.DIRECT_L.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.DIRECT_L.set_max_evals_grouped#qiskit.algorithms.optimizers.DIRECT_L.set_max_evals_grouped "qiskit.algorithms.optimizers.DIRECT_L.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.DIRECT_L.set_options#qiskit.algorithms.optimizers.DIRECT_L.set_options "qiskit.algorithms.optimizers.DIRECT_L.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.DIRECT_L.wrap_function#qiskit.algorithms.optimizers.DIRECT_L.wrap_function "qiskit.algorithms.optimizers.DIRECT_L.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`DIRECT_L.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static DIRECT_L.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`DIRECT_L.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`DIRECT_L.print_options()` + +Print algorithm-specific options. +### set\_max\_evals\_grouped + + +`DIRECT_L.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`DIRECT_L.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static DIRECT_L.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings + 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 6246b1549b3..5a424cb5965 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 @@ -1,14 +1,22 @@ -# DIRECT\_L\_RAND +--- +title: DIRECT_L_RAND +description: API reference for qiskit.algorithms.optimizers.DIRECT_L_RAND +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.DIRECT_L_RAND +--- +# DIRECT\_L\_RAND + -`DIRECT_L_RAND(max_evals=1000)` +`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` DIviding RECTangles Locally-biased Randomized optimizer. -DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L#qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") +DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") NLopt global optimizer, derivative-free. For further detail, please refer to [http://nlopt.readthedocs.io/en/latest/NLopt\_Algorithms/#direct-and-direct-l](http://nlopt.readthedocs.io/en/latest/NLopt_Algorithms/#direct-and-direct-l) @@ -18,101 +26,211 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.algorithms.optimizers.DIRECT_L_RAND.get_nlopt_optimizer#qiskit.algorithms.optimizers.DIRECT_L_RAND.get_nlopt_optimizer "qiskit.algorithms.optimizers.DIRECT_L_RAND.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.algorithms.optimizers.DIRECT_L_RAND.get_support_level#qiskit.algorithms.optimizers.DIRECT_L_RAND.get_support_level "qiskit.algorithms.optimizers.DIRECT_L_RAND.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.DIRECT_L_RAND.gradient_num_diff#qiskit.algorithms.optimizers.DIRECT_L_RAND.gradient_num_diff "qiskit.algorithms.optimizers.DIRECT_L_RAND.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.DIRECT_L_RAND.optimize#qiskit.algorithms.optimizers.DIRECT_L_RAND.optimize "qiskit.algorithms.optimizers.DIRECT_L_RAND.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.DIRECT_L_RAND.print_options#qiskit.algorithms.optimizers.DIRECT_L_RAND.print_options "qiskit.algorithms.optimizers.DIRECT_L_RAND.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.DIRECT_L_RAND.set_max_evals_grouped#qiskit.algorithms.optimizers.DIRECT_L_RAND.set_max_evals_grouped "qiskit.algorithms.optimizers.DIRECT_L_RAND.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.DIRECT_L_RAND.set_options#qiskit.algorithms.optimizers.DIRECT_L_RAND.set_options "qiskit.algorithms.optimizers.DIRECT_L_RAND.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.DIRECT_L_RAND.wrap_function#qiskit.algorithms.optimizers.DIRECT_L_RAND.wrap_function "qiskit.algorithms.optimizers.DIRECT_L_RAND.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`DIRECT_L_RAND.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static DIRECT_L_RAND.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`DIRECT_L_RAND.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`DIRECT_L_RAND.print_options()` + +Print algorithm-specific options. +### set\_max\_evals\_grouped + + +`DIRECT_L_RAND.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`DIRECT_L_RAND.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static DIRECT_L_RAND.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings + 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 60c12cafed6..d6e70b8e91a 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ESCH.md @@ -1,8 +1,16 @@ -# ESCH +--- +title: ESCH +description: API reference for qiskit.algorithms.optimizers.ESCH +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.ESCH +--- +# ESCH + -`ESCH(max_evals=1000)` +`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` @@ -20,101 +28,211 @@ NLopt global optimizer, derivative-free. For further detail, please refer to **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.algorithms.optimizers.ESCH.get_nlopt_optimizer#qiskit.algorithms.optimizers.ESCH.get_nlopt_optimizer "qiskit.algorithms.optimizers.ESCH.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.algorithms.optimizers.ESCH.get_support_level#qiskit.algorithms.optimizers.ESCH.get_support_level "qiskit.algorithms.optimizers.ESCH.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.ESCH.gradient_num_diff#qiskit.algorithms.optimizers.ESCH.gradient_num_diff "qiskit.algorithms.optimizers.ESCH.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.ESCH.optimize#qiskit.algorithms.optimizers.ESCH.optimize "qiskit.algorithms.optimizers.ESCH.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.ESCH.print_options#qiskit.algorithms.optimizers.ESCH.print_options "qiskit.algorithms.optimizers.ESCH.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.ESCH.set_max_evals_grouped#qiskit.algorithms.optimizers.ESCH.set_max_evals_grouped "qiskit.algorithms.optimizers.ESCH.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.ESCH.set_options#qiskit.algorithms.optimizers.ESCH.set_options "qiskit.algorithms.optimizers.ESCH.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.ESCH.wrap_function#qiskit.algorithms.optimizers.ESCH.wrap_function "qiskit.algorithms.optimizers.ESCH.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`ESCH.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static ESCH.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`ESCH.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`ESCH.print_options()` + +Print algorithm-specific options. +### set\_max\_evals\_grouped + + +`ESCH.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`ESCH.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static ESCH.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings + 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 bc9c1b47061..8f47f9e5d2c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GSLS.md @@ -1,8 +1,16 @@ -# GSLS +--- +title: GSLS +description: API reference for qiskit.algorithms.optimizers.GSLS +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.GSLS +--- +# GSLS + -`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)` +`GSLS(maxiter=10000, max_eval=10000, disp=False, sampling_radius=1e-06, sample_size_factor=1, initial_step_size=0.01, min_step_size=1e-10, step_size_multiplier=0.4, armijo_parameter=0.1, min_gradient_norm=1e-08, max_failed_rejection_sampling=50)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gsls.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -30,104 +38,316 @@ An implementation of the line search algorithm described in [https://arxiv.org/p ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.GSLS.get_support_level#qiskit.algorithms.optimizers.GSLS.get_support_level "qiskit.algorithms.optimizers.GSLS.get_support_level") | Return support level dictionary. | -| [`gradient_approximation`](qiskit.algorithms.optimizers.GSLS.gradient_approximation#qiskit.algorithms.optimizers.GSLS.gradient_approximation "qiskit.algorithms.optimizers.GSLS.gradient_approximation") | Construct gradient approximation from given sample. | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.GSLS.gradient_num_diff#qiskit.algorithms.optimizers.GSLS.gradient_num_diff "qiskit.algorithms.optimizers.GSLS.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`ls_optimize`](qiskit.algorithms.optimizers.GSLS.ls_optimize#qiskit.algorithms.optimizers.GSLS.ls_optimize "qiskit.algorithms.optimizers.GSLS.ls_optimize") | Run the line search optimization. | -| [`optimize`](qiskit.algorithms.optimizers.GSLS.optimize#qiskit.algorithms.optimizers.GSLS.optimize "qiskit.algorithms.optimizers.GSLS.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.GSLS.print_options#qiskit.algorithms.optimizers.GSLS.print_options "qiskit.algorithms.optimizers.GSLS.print_options") | Print algorithm-specific options. | -| [`sample_points`](qiskit.algorithms.optimizers.GSLS.sample_points#qiskit.algorithms.optimizers.GSLS.sample_points "qiskit.algorithms.optimizers.GSLS.sample_points") | Sample `num_points` points around `x` on the `n`-sphere of specified radius. | -| [`sample_set`](qiskit.algorithms.optimizers.GSLS.sample_set#qiskit.algorithms.optimizers.GSLS.sample_set "qiskit.algorithms.optimizers.GSLS.sample_set") | Construct sample set of given size. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.GSLS.set_max_evals_grouped#qiskit.algorithms.optimizers.GSLS.set_max_evals_grouped "qiskit.algorithms.optimizers.GSLS.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.GSLS.set_options#qiskit.algorithms.optimizers.GSLS.set_options "qiskit.algorithms.optimizers.GSLS.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.GSLS.wrap_function#qiskit.algorithms.optimizers.GSLS.wrap_function "qiskit.algorithms.optimizers.GSLS.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +**Return type** + +`Dict`\[`str`, `int`] + +**Returns** + +A dictionary containing the support levels for different options. + +### gradient\_approximation + + + +`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. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **x** (`ndarray`) – Point around which the sample set was constructed. +* **x\_value** (`float`) – Objective function value at x. +* **directions** (`ndarray`) – Directions of the sample points wrt the central point x, as a 2D array. +* **sample\_set\_x** (`ndarray`) – x-coordinates of the sample set, one point per row, as a 2D array. +* **sample\_set\_y** (`ndarray`) – Objective function values of the points in sample\_set\_x, as a 1D array. + +**Return type** + +`ndarray` + +**Returns** + +Gradient approximation at x, as a 1D array. + +### gradient\_num\_diff + + + +`static GSLS.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### ls\_optimize + + + +`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. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **obj\_fun** (`Callable`) – Objective function. +* **initial\_point** (`ndarray`) – Initial point. +* **var\_lb** (`ndarray`) – Vector of lower bounds on the decision variables. Vector elements can be -np.inf if the corresponding variable is unbounded from below. +* **var\_ub** (`ndarray`) – Vector of upper bounds on the decision variables. Vector elements can be np.inf if the corresponding variable is unbounded from below. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`, `float`] + +**Returns** + +Final iterate as a vector, corresponding objective function value, number of evaluations, and norm of the gradient estimate. + +**Raises** + +**ValueError** – If the number of dimensions mismatches the size of the initial point or the length of the lower or upper bound. + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`GSLS.print_options()` + +Print algorithm-specific options. +### sample\_points + + +`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. + +The radius of the sphere is `self._options['sampling_radius']`. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **x** (`ndarray`) – Point around which the sample set is constructed. +* **num\_points** (`int`) – Number of points in the sample set. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +**Returns** + +A tuple containing the sampling points and the directions. + +### sample\_set + + + +`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. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **x** (`ndarray`) – Point around which the sample set is constructed. +* **var\_lb** (`ndarray`) – Vector of lower bounds on the decision variables. Vector elements can be -np.inf if the corresponding variable is unbounded from below. +* **var\_ub** (`ndarray`) – Vector of lower bounds on the decision variables. Vector elements can be np.inf if the corresponding variable is unbounded from above. +* **num\_points** (`int`) – Number of points in the sample set. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +**Returns** + +Matrices of (unit-norm) sample directions and sample points, one per row. Both matrices are 2D arrays of floats. + +**Raises** + +**RuntimeError** – If not enough samples could be generated within the bounds. + +### set\_max\_evals\_grouped + + + +`GSLS.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`GSLS.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static GSLS.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 2b9667bbc95..1b9ce65140b 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.GradientDescent.md @@ -1,8 +1,16 @@ -# GradientDescent +--- +title: GradientDescent +description: API reference for qiskit.algorithms.optimizers.GradientDescent +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.GradientDescent +--- +# GradientDescent + -`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)` +`GradientDescent(maxiter=100, learning_rate=0.01, tol=1e-07, callback=None, perturbation=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/gradient_descent.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -35,100 +43,199 @@ An example where the learning rate is an iterator and we supply the analytic gra ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.GradientDescent.get_support_level#qiskit.algorithms.optimizers.GradientDescent.get_support_level "qiskit.algorithms.optimizers.GradientDescent.get_support_level") | Get the support level dictionary. | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.GradientDescent.gradient_num_diff#qiskit.algorithms.optimizers.GradientDescent.gradient_num_diff "qiskit.algorithms.optimizers.GradientDescent.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.GradientDescent.optimize#qiskit.algorithms.optimizers.GradientDescent.optimize "qiskit.algorithms.optimizers.GradientDescent.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.GradientDescent.print_options#qiskit.algorithms.optimizers.GradientDescent.print_options "qiskit.algorithms.optimizers.GradientDescent.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.GradientDescent.set_max_evals_grouped#qiskit.algorithms.optimizers.GradientDescent.set_max_evals_grouped "qiskit.algorithms.optimizers.GradientDescent.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.GradientDescent.set_options#qiskit.algorithms.optimizers.GradientDescent.set_options "qiskit.algorithms.optimizers.GradientDescent.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.GradientDescent.wrap_function#qiskit.algorithms.optimizers.GradientDescent.wrap_function "qiskit.algorithms.optimizers.GradientDescent.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +### gradient\_num\_diff + + + +`static GradientDescent.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`GradientDescent.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`GradientDescent.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`GradientDescent.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static GradientDescent.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 1df2f9290f1..499edc4598c 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.IMFIL.md @@ -1,8 +1,16 @@ -# IMFIL +--- +title: IMFIL +description: API reference for qiskit.algorithms.optimizers.IMFIL +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.IMFIL +--- +# IMFIL + -`IMFIL(maxiter=1000)` +`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` @@ -18,104 +26,185 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.IMFIL.get_support_level#qiskit.algorithms.optimizers.IMFIL.get_support_level "qiskit.algorithms.optimizers.IMFIL.get_support_level") | Returns support level dictionary. | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.IMFIL.gradient_num_diff#qiskit.algorithms.optimizers.IMFIL.gradient_num_diff "qiskit.algorithms.optimizers.IMFIL.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.IMFIL.optimize#qiskit.algorithms.optimizers.IMFIL.optimize "qiskit.algorithms.optimizers.IMFIL.optimize") | Runs the optimization. | -| [`print_options`](qiskit.algorithms.optimizers.IMFIL.print_options#qiskit.algorithms.optimizers.IMFIL.print_options "qiskit.algorithms.optimizers.IMFIL.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.IMFIL.set_max_evals_grouped#qiskit.algorithms.optimizers.IMFIL.set_max_evals_grouped "qiskit.algorithms.optimizers.IMFIL.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.IMFIL.set_options#qiskit.algorithms.optimizers.IMFIL.set_options "qiskit.algorithms.optimizers.IMFIL.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.IMFIL.wrap_function#qiskit.algorithms.optimizers.IMFIL.wrap_function "qiskit.algorithms.optimizers.IMFIL.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +### gradient\_num\_diff + + + +`static IMFIL.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +### print\_options + + + +`IMFIL.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`IMFIL.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`IMFIL.set_options(**kwargs)` +Sets or updates values in the options dictionary. +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static IMFIL.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 56128df2666..c3a40820c6b 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.ISRES.md @@ -1,8 +1,16 @@ -# ISRES +--- +title: ISRES +description: API reference for qiskit.algorithms.optimizers.ISRES +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.ISRES +--- +# ISRES + -`ISRES(max_evals=1000)` +`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` @@ -18,101 +26,211 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.algorithms.optimizers.ISRES.get_nlopt_optimizer#qiskit.algorithms.optimizers.ISRES.get_nlopt_optimizer "qiskit.algorithms.optimizers.ISRES.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.algorithms.optimizers.ISRES.get_support_level#qiskit.algorithms.optimizers.ISRES.get_support_level "qiskit.algorithms.optimizers.ISRES.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.ISRES.gradient_num_diff#qiskit.algorithms.optimizers.ISRES.gradient_num_diff "qiskit.algorithms.optimizers.ISRES.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.ISRES.optimize#qiskit.algorithms.optimizers.ISRES.optimize "qiskit.algorithms.optimizers.ISRES.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.ISRES.print_options#qiskit.algorithms.optimizers.ISRES.print_options "qiskit.algorithms.optimizers.ISRES.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.ISRES.set_max_evals_grouped#qiskit.algorithms.optimizers.ISRES.set_max_evals_grouped "qiskit.algorithms.optimizers.ISRES.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.ISRES.set_options#qiskit.algorithms.optimizers.ISRES.set_options "qiskit.algorithms.optimizers.ISRES.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.ISRES.wrap_function#qiskit.algorithms.optimizers.ISRES.wrap_function "qiskit.algorithms.optimizers.ISRES.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`ISRES.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static ISRES.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`ISRES.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`ISRES.print_options()` + +Print algorithm-specific options. +### set\_max\_evals\_grouped + + +`ISRES.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`ISRES.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static ISRES.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings + 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 75dc1935c2c..7da978ade93 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 @@ -1,8 +1,16 @@ -# L\_BFGS\_B +--- +title: L_BFGS_B +description: API reference for qiskit.algorithms.optimizers.L_BFGS_B +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.L_BFGS_B +--- +# 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)` +`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` @@ -31,100 +39,199 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.L_BFGS_B.get_support_level#qiskit.algorithms.optimizers.L_BFGS_B.get_support_level "qiskit.algorithms.optimizers.L_BFGS_B.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.L_BFGS_B.gradient_num_diff#qiskit.algorithms.optimizers.L_BFGS_B.gradient_num_diff "qiskit.algorithms.optimizers.L_BFGS_B.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.L_BFGS_B.optimize#qiskit.algorithms.optimizers.L_BFGS_B.optimize "qiskit.algorithms.optimizers.L_BFGS_B.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.L_BFGS_B.print_options#qiskit.algorithms.optimizers.L_BFGS_B.print_options "qiskit.algorithms.optimizers.L_BFGS_B.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.L_BFGS_B.set_max_evals_grouped#qiskit.algorithms.optimizers.L_BFGS_B.set_max_evals_grouped "qiskit.algorithms.optimizers.L_BFGS_B.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.L_BFGS_B.set_options#qiskit.algorithms.optimizers.L_BFGS_B.set_options "qiskit.algorithms.optimizers.L_BFGS_B.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.L_BFGS_B.wrap_function#qiskit.algorithms.optimizers.L_BFGS_B.wrap_function "qiskit.algorithms.optimizers.L_BFGS_B.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`L_BFGS_B.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static L_BFGS_B.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`L_BFGS_B.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`L_BFGS_B.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`L_BFGS_B.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`L_BFGS_B.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static L_BFGS_B.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 a5fc4a6b363..f24e582865f 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 @@ -1,8 +1,16 @@ -# NELDER\_MEAD +--- +title: NELDER_MEAD +description: API reference for qiskit.algorithms.optimizers.NELDER_MEAD +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.NELDER_MEAD +--- +# NELDER\_MEAD + -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)` +`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nelder_mead.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -27,100 +35,199 @@ Uses scipy.optimize.minimize Nelder-Mead. For further detail, please refer to Se ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.NELDER_MEAD.get_support_level#qiskit.algorithms.optimizers.NELDER_MEAD.get_support_level "qiskit.algorithms.optimizers.NELDER_MEAD.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.NELDER_MEAD.gradient_num_diff#qiskit.algorithms.optimizers.NELDER_MEAD.gradient_num_diff "qiskit.algorithms.optimizers.NELDER_MEAD.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.NELDER_MEAD.optimize#qiskit.algorithms.optimizers.NELDER_MEAD.optimize "qiskit.algorithms.optimizers.NELDER_MEAD.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.NELDER_MEAD.print_options#qiskit.algorithms.optimizers.NELDER_MEAD.print_options "qiskit.algorithms.optimizers.NELDER_MEAD.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.NELDER_MEAD.set_max_evals_grouped#qiskit.algorithms.optimizers.NELDER_MEAD.set_max_evals_grouped "qiskit.algorithms.optimizers.NELDER_MEAD.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.NELDER_MEAD.set_options#qiskit.algorithms.optimizers.NELDER_MEAD.set_options "qiskit.algorithms.optimizers.NELDER_MEAD.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.NELDER_MEAD.wrap_function#qiskit.algorithms.optimizers.NELDER_MEAD.wrap_function "qiskit.algorithms.optimizers.NELDER_MEAD.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`NELDER_MEAD.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static NELDER_MEAD.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`NELDER_MEAD.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`NELDER_MEAD.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`NELDER_MEAD.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`NELDER_MEAD.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static NELDER_MEAD.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 8b0b1e9d49e..8eff9ee8250 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.NFT.md @@ -1,8 +1,16 @@ -# NFT +--- +title: NFT +description: API reference for qiskit.algorithms.optimizers.NFT +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.NFT +--- +# NFT + -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)` +`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/nft.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -33,100 +41,199 @@ K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization fo ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.NFT.get_support_level#qiskit.algorithms.optimizers.NFT.get_support_level "qiskit.algorithms.optimizers.NFT.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.NFT.gradient_num_diff#qiskit.algorithms.optimizers.NFT.gradient_num_diff "qiskit.algorithms.optimizers.NFT.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.NFT.optimize#qiskit.algorithms.optimizers.NFT.optimize "qiskit.algorithms.optimizers.NFT.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.NFT.print_options#qiskit.algorithms.optimizers.NFT.print_options "qiskit.algorithms.optimizers.NFT.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.NFT.set_max_evals_grouped#qiskit.algorithms.optimizers.NFT.set_max_evals_grouped "qiskit.algorithms.optimizers.NFT.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.NFT.set_options#qiskit.algorithms.optimizers.NFT.set_options "qiskit.algorithms.optimizers.NFT.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.NFT.wrap_function#qiskit.algorithms.optimizers.NFT.wrap_function "qiskit.algorithms.optimizers.NFT.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`NFT.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static NFT.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`NFT.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`NFT.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`NFT.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`NFT.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static NFT.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 0f05cbe213b..f3e2efd0371 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.Optimizer.md @@ -1,8 +1,16 @@ -# Optimizer +--- +title: Optimizer +description: API reference for qiskit.algorithms.optimizers.Optimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.Optimizer +--- +# Optimizer + -`Optimizer` +`Optimizer`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `abc.ABC` @@ -12,97 +20,195 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.Optimizer.get_support_level#qiskit.algorithms.optimizers.Optimizer.get_support_level "qiskit.algorithms.optimizers.Optimizer.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.Optimizer.gradient_num_diff#qiskit.algorithms.optimizers.Optimizer.gradient_num_diff "qiskit.algorithms.optimizers.Optimizer.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.Optimizer.optimize#qiskit.algorithms.optimizers.Optimizer.optimize "qiskit.algorithms.optimizers.Optimizer.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.Optimizer.print_options#qiskit.algorithms.optimizers.Optimizer.print_options "qiskit.algorithms.optimizers.Optimizer.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.Optimizer.set_max_evals_grouped#qiskit.algorithms.optimizers.Optimizer.set_max_evals_grouped "qiskit.algorithms.optimizers.Optimizer.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.Optimizer.set_options#qiskit.algorithms.optimizers.Optimizer.set_options "qiskit.algorithms.optimizers.Optimizer.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.Optimizer.wrap_function#qiskit.algorithms.optimizers.Optimizer.wrap_function "qiskit.algorithms.optimizers.Optimizer.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`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. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`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. + +### set\_max\_evals\_grouped + + + +`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 +### set\_options + + + +`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. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`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. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings @@ -119,3 +225,4 @@ optimizer = OptimizerClass(**settings) **Return type** `Dict`\[`str`, `Any`] + 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 2eda1a865a7..948f5158c5f 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.OptimizerSupportLevel.md @@ -1,8 +1,16 @@ -# OptimizerSupportLevel +--- +title: OptimizerSupportLevel +description: API reference for qiskit.algorithms.optimizers.OptimizerSupportLevel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.OptimizerSupportLevel +--- +# OptimizerSupportLevel + -`OptimizerSupportLevel(value)` +`OptimizerSupportLevel(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/optimizer.py "view source code") Bases: `enum.IntEnum` @@ -10,26 +18,27 @@ Support Level enum for features such as bounds, gradient and initial point ## Attributes - + ### ignored `= 1` - + ### not\_supported `= 0` - + ### required `= 3` - + ### supported `= 2` + 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 7e54ebdacb8..2e38bcf0b6a 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.POWELL.md @@ -1,8 +1,16 @@ -# POWELL +--- +title: POWELL +description: API reference for qiskit.algorithms.optimizers.POWELL +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.POWELL +--- +# POWELL + -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)` +`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None, options=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/powell.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -24,100 +32,199 @@ Uses scipy.optimize.minimize Powell. For further detail, please refer to See [ht ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.POWELL.get_support_level#qiskit.algorithms.optimizers.POWELL.get_support_level "qiskit.algorithms.optimizers.POWELL.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.POWELL.gradient_num_diff#qiskit.algorithms.optimizers.POWELL.gradient_num_diff "qiskit.algorithms.optimizers.POWELL.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.POWELL.optimize#qiskit.algorithms.optimizers.POWELL.optimize "qiskit.algorithms.optimizers.POWELL.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.POWELL.print_options#qiskit.algorithms.optimizers.POWELL.print_options "qiskit.algorithms.optimizers.POWELL.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.POWELL.set_max_evals_grouped#qiskit.algorithms.optimizers.POWELL.set_max_evals_grouped "qiskit.algorithms.optimizers.POWELL.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.POWELL.set_options#qiskit.algorithms.optimizers.POWELL.set_options "qiskit.algorithms.optimizers.POWELL.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.POWELL.wrap_function#qiskit.algorithms.optimizers.POWELL.wrap_function "qiskit.algorithms.optimizers.POWELL.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`POWELL.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static POWELL.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`POWELL.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`POWELL.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`POWELL.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`POWELL.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static POWELL.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 74770e48270..98dd1037f06 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 @@ -1,14 +1,22 @@ -# P\_BFGS +--- +title: P_BFGS +description: API reference for qiskit.algorithms.optimizers.P_BFGS +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.P_BFGS +--- +# P\_BFGS + -`P_BFGS(maxfun=1000, ftol=2.220446049250313e-15, factr=None, iprint=- 1, max_processes=None, options=None, max_evals_grouped=1, **kwargs)` +`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` Parallelized Limited-memory BFGS optimizer. -P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B#qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. +P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.fmin\_l\_bfgs\_b.html](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.fmin_l_bfgs_b.html) @@ -25,100 +33,199 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.P_BFGS.get_support_level#qiskit.algorithms.optimizers.P_BFGS.get_support_level "qiskit.algorithms.optimizers.P_BFGS.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.P_BFGS.gradient_num_diff#qiskit.algorithms.optimizers.P_BFGS.gradient_num_diff "qiskit.algorithms.optimizers.P_BFGS.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.P_BFGS.optimize#qiskit.algorithms.optimizers.P_BFGS.optimize "qiskit.algorithms.optimizers.P_BFGS.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.P_BFGS.print_options#qiskit.algorithms.optimizers.P_BFGS.print_options "qiskit.algorithms.optimizers.P_BFGS.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.P_BFGS.set_max_evals_grouped#qiskit.algorithms.optimizers.P_BFGS.set_max_evals_grouped "qiskit.algorithms.optimizers.P_BFGS.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.P_BFGS.set_options#qiskit.algorithms.optimizers.P_BFGS.set_options "qiskit.algorithms.optimizers.P_BFGS.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.P_BFGS.wrap_function#qiskit.algorithms.optimizers.P_BFGS.wrap_function "qiskit.algorithms.optimizers.P_BFGS.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`P_BFGS.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static P_BFGS.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`P_BFGS.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`P_BFGS.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`P_BFGS.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static P_BFGS.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 40291f2c484..912134a5489 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.QNSPSA.md @@ -1,8 +1,16 @@ -# QNSPSA +--- +title: QNSPSA +description: API reference for qiskit.algorithms.optimizers.QNSPSA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.QNSPSA +--- +# 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)` +`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` @@ -64,100 +72,272 @@ result = qnspsa.optimize(ansatz.num_parameters, loss, initial_point=initial_poin ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`calibrate`](qiskit.algorithms.optimizers.QNSPSA.calibrate#qiskit.algorithms.optimizers.QNSPSA.calibrate "qiskit.algorithms.optimizers.QNSPSA.calibrate") | Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. | -| [`estimate_stddev`](qiskit.algorithms.optimizers.QNSPSA.estimate_stddev#qiskit.algorithms.optimizers.QNSPSA.estimate_stddev "qiskit.algorithms.optimizers.QNSPSA.estimate_stddev") | Estimate the standard deviation of the loss function. | -| [`get_fidelity`](qiskit.algorithms.optimizers.QNSPSA.get_fidelity#qiskit.algorithms.optimizers.QNSPSA.get_fidelity "qiskit.algorithms.optimizers.QNSPSA.get_fidelity") | Get a function to compute the fidelity of `circuit` with itself. | -| [`get_support_level`](qiskit.algorithms.optimizers.QNSPSA.get_support_level#qiskit.algorithms.optimizers.QNSPSA.get_support_level "qiskit.algorithms.optimizers.QNSPSA.get_support_level") | Get the support level dictionary. | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.QNSPSA.gradient_num_diff#qiskit.algorithms.optimizers.QNSPSA.gradient_num_diff "qiskit.algorithms.optimizers.QNSPSA.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.QNSPSA.optimize#qiskit.algorithms.optimizers.QNSPSA.optimize "qiskit.algorithms.optimizers.QNSPSA.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.QNSPSA.print_options#qiskit.algorithms.optimizers.QNSPSA.print_options "qiskit.algorithms.optimizers.QNSPSA.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.QNSPSA.set_max_evals_grouped#qiskit.algorithms.optimizers.QNSPSA.set_max_evals_grouped "qiskit.algorithms.optimizers.QNSPSA.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.QNSPSA.set_options#qiskit.algorithms.optimizers.QNSPSA.set_options "qiskit.algorithms.optimizers.QNSPSA.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.QNSPSA.wrap_function#qiskit.algorithms.optimizers.QNSPSA.wrap_function "qiskit.algorithms.optimizers.QNSPSA.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### calibrate -## Attributes + + +`static QNSPSA.calibrate(loss, initial_point, c=0.2, stability_constant=0, target_magnitude=None, alpha=0.602, gamma=0.101, modelspace=False)` + +Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. + +The powerseries are: + +$$ +a_k = \frac{a}{(A + k + 1)^\alpha}, c_k = \frac{c}{(k + 1)^\gamma} +$$ + +**Parameters** + +* **loss** (`Callable`\[\[`ndarray`], `float`]) – The loss function. +* **initial\_point** (`ndarray`) – The initial guess of the iteration. +* **c** (`float`) – The initial perturbation magnitude. +* **stability\_constant** (`float`) – The value of A. +* **target\_magnitude** (`Optional`\[`float`]) – The target magnitude for the first update step, defaults to $2\pi / 10$. +* **alpha** (`float`) – The exponent of the learning rate powerseries. +* **gamma** (`float`) – The exponent of the perturbation powerseries. +* **modelspace** (`bool`) – Whether the target magnitude is the difference of parameter values or function values (= model space). + +**Returns** + +**A tuple of powerseries generators, the first one for the** + +learning rate and the second one for the perturbation. + +**Return type** + +tuple(generator, generator) + +### estimate\_stddev + + + +`static QNSPSA.estimate_stddev(loss, initial_point, avg=25)` + +Estimate the standard deviation of the loss function. + +**Return type** + +`float` + +### get\_fidelity + + + +`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. + +Let `circuit` be a parameterized quantum circuit performing the operation $U(\theta)$ given a set of parameters $\theta$. Then this method returns a function to evaluate + +$$ +F(\theta, \phi) = \big|\langle 0 | U^\dagger(\theta) U(\phi) |0\rangle \big|^2. +$$ + +The output of this function can be used as input for the `fidelity` to the :class:\~\`qiskit.algorithms.optimizers.QNSPSA\` optimizer. + +**Parameters** + +* **circuit** (`QuantumCircuit`) – The circuit preparing the parameterized ansatz. +* **backend** (`Union`\[`Backend`, `QuantumInstance`, `None`]) – A backend of quantum instance to evaluate the circuits. If None, plain matrix multiplication will be used. +* **expectation** (`Optional`\[`ExpectationBase`]) – An expectation converter to specify how the expected value is computed. If a shot-based readout is used this should be set to `PauliExpectation`. + +**Return type** + +`Callable`\[\[`ndarray`, `ndarray`], `float`] + +**Returns** + +A handle to the function $F$. + +### get\_support\_level + + + +`QNSPSA.get_support_level()` + +Get the support level dictionary. + +### gradient\_num\_diff + + + +`static QNSPSA.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + +`QNSPSA.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`QNSPSA.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`QNSPSA.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`QNSPSA.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static QNSPSA.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings @@ -166,3 +346,4 @@ The optimizer settings in a dictionary format. **Return type** `Dict`\[`str`, `Any`] + 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 13a7dfdd5be..a630c804619 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SLSQP.md @@ -1,8 +1,16 @@ -# SLSQP +--- +title: SLSQP +description: API reference for qiskit.algorithms.optimizers.SLSQP +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.SLSQP +--- +# SLSQP + -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)` +`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/slsqp.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` @@ -27,100 +35,199 @@ Uses scipy.optimize.minimize SLSQP. For further detail, please refer to See [htt ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.SLSQP.get_support_level#qiskit.algorithms.optimizers.SLSQP.get_support_level "qiskit.algorithms.optimizers.SLSQP.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.SLSQP.gradient_num_diff#qiskit.algorithms.optimizers.SLSQP.gradient_num_diff "qiskit.algorithms.optimizers.SLSQP.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.SLSQP.optimize#qiskit.algorithms.optimizers.SLSQP.optimize "qiskit.algorithms.optimizers.SLSQP.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.SLSQP.print_options#qiskit.algorithms.optimizers.SLSQP.print_options "qiskit.algorithms.optimizers.SLSQP.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.SLSQP.set_max_evals_grouped#qiskit.algorithms.optimizers.SLSQP.set_max_evals_grouped "qiskit.algorithms.optimizers.SLSQP.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.SLSQP.set_options#qiskit.algorithms.optimizers.SLSQP.set_options "qiskit.algorithms.optimizers.SLSQP.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.SLSQP.wrap_function#qiskit.algorithms.optimizers.SLSQP.wrap_function "qiskit.algorithms.optimizers.SLSQP.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`SLSQP.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static SLSQP.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`SLSQP.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`SLSQP.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`SLSQP.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`SLSQP.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static SLSQP.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 1a9850e421a..3f7ed381506 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SNOBFIT.md @@ -1,8 +1,16 @@ -# SNOBFIT +--- +title: SNOBFIT +description: API reference for qiskit.algorithms.optimizers.SNOBFIT +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.SNOBFIT +--- +# SNOBFIT + -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` +`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/snobfit.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -21,104 +29,185 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant or SQSnobFit not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant or SQSnobFit not installed ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.SNOBFIT.get_support_level#qiskit.algorithms.optimizers.SNOBFIT.get_support_level "qiskit.algorithms.optimizers.SNOBFIT.get_support_level") | Returns support level dictionary. | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.SNOBFIT.gradient_num_diff#qiskit.algorithms.optimizers.SNOBFIT.gradient_num_diff "qiskit.algorithms.optimizers.SNOBFIT.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.SNOBFIT.optimize#qiskit.algorithms.optimizers.SNOBFIT.optimize "qiskit.algorithms.optimizers.SNOBFIT.optimize") | Runs the optimization. | -| [`print_options`](qiskit.algorithms.optimizers.SNOBFIT.print_options#qiskit.algorithms.optimizers.SNOBFIT.print_options "qiskit.algorithms.optimizers.SNOBFIT.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.SNOBFIT.set_max_evals_grouped#qiskit.algorithms.optimizers.SNOBFIT.set_max_evals_grouped "qiskit.algorithms.optimizers.SNOBFIT.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.SNOBFIT.set_options#qiskit.algorithms.optimizers.SNOBFIT.set_options "qiskit.algorithms.optimizers.SNOBFIT.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.SNOBFIT.wrap_function#qiskit.algorithms.optimizers.SNOBFIT.wrap_function "qiskit.algorithms.optimizers.SNOBFIT.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +### gradient\_num\_diff + + + +`static SNOBFIT.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +### print\_options + + + +`SNOBFIT.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`SNOBFIT.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`SNOBFIT.set_options(**kwargs)` +Sets or updates values in the options dictionary. +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static SNOBFIT.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 8b3c226db56..19affc73005 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SPSA.md @@ -1,8 +1,16 @@ -# SPSA +--- +title: SPSA +description: API reference for qiskit.algorithms.optimizers.SPSA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.SPSA +--- +# 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)` +`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` @@ -89,98 +97,242 @@ result = two_spsa.optimize(ansatz.num_parameters, loss, initial_point=initial_po ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`calibrate`](qiskit.algorithms.optimizers.SPSA.calibrate#qiskit.algorithms.optimizers.SPSA.calibrate "qiskit.algorithms.optimizers.SPSA.calibrate") | Calibrate SPSA parameters with a powerseries as learning rate and perturbation coeffs. | -| [`estimate_stddev`](qiskit.algorithms.optimizers.SPSA.estimate_stddev#qiskit.algorithms.optimizers.SPSA.estimate_stddev "qiskit.algorithms.optimizers.SPSA.estimate_stddev") | Estimate the standard deviation of the loss function. | -| [`get_support_level`](qiskit.algorithms.optimizers.SPSA.get_support_level#qiskit.algorithms.optimizers.SPSA.get_support_level "qiskit.algorithms.optimizers.SPSA.get_support_level") | Get the support level dictionary. | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.SPSA.gradient_num_diff#qiskit.algorithms.optimizers.SPSA.gradient_num_diff "qiskit.algorithms.optimizers.SPSA.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.SPSA.optimize#qiskit.algorithms.optimizers.SPSA.optimize "qiskit.algorithms.optimizers.SPSA.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.SPSA.print_options#qiskit.algorithms.optimizers.SPSA.print_options "qiskit.algorithms.optimizers.SPSA.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.SPSA.set_max_evals_grouped#qiskit.algorithms.optimizers.SPSA.set_max_evals_grouped "qiskit.algorithms.optimizers.SPSA.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.SPSA.set_options#qiskit.algorithms.optimizers.SPSA.set_options "qiskit.algorithms.optimizers.SPSA.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.SPSA.wrap_function#qiskit.algorithms.optimizers.SPSA.wrap_function "qiskit.algorithms.optimizers.SPSA.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### calibrate -## Attributes + + +`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. + +The powerseries are: + +$$ +a_k = \frac{a}{(A + k + 1)^\alpha}, c_k = \frac{c}{(k + 1)^\gamma} +$$ + +**Parameters** + +* **loss** (`Callable`\[\[`ndarray`], `float`]) – The loss function. +* **initial\_point** (`ndarray`) – The initial guess of the iteration. +* **c** (`float`) – The initial perturbation magnitude. +* **stability\_constant** (`float`) – The value of A. +* **target\_magnitude** (`Optional`\[`float`]) – The target magnitude for the first update step, defaults to $2\pi / 10$. +* **alpha** (`float`) – The exponent of the learning rate powerseries. +* **gamma** (`float`) – The exponent of the perturbation powerseries. +* **modelspace** (`bool`) – Whether the target magnitude is the difference of parameter values or function values (= model space). + +**Returns** + +**A tuple of powerseries generators, the first one for the** + +learning rate and the second one for the perturbation. + +**Return type** + +tuple(generator, generator) + +### estimate\_stddev + + + +`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. + +**Return type** + +`float` + +### get\_support\_level + + +`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. + +### gradient\_num\_diff + + + +`static SPSA.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`SPSA.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`SPSA.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`SPSA.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static SPSA.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings + 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 73d5112b906..72a75110049 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.SciPyOptimizer.md @@ -1,8 +1,16 @@ -# SciPyOptimizer +--- +title: SciPyOptimizer +description: API reference for qiskit.algorithms.optimizers.SciPyOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.SciPyOptimizer +--- +# SciPyOptimizer + -`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)` +`SciPyOptimizer(method, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/scipy_optimizer.py "view source code") Bases: `qiskit.algorithms.optimizers.optimizer.Optimizer` @@ -19,100 +27,199 @@ For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/ ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.SciPyOptimizer.get_support_level#qiskit.algorithms.optimizers.SciPyOptimizer.get_support_level "qiskit.algorithms.optimizers.SciPyOptimizer.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.SciPyOptimizer.gradient_num_diff#qiskit.algorithms.optimizers.SciPyOptimizer.gradient_num_diff "qiskit.algorithms.optimizers.SciPyOptimizer.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.SciPyOptimizer.optimize#qiskit.algorithms.optimizers.SciPyOptimizer.optimize "qiskit.algorithms.optimizers.SciPyOptimizer.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.SciPyOptimizer.print_options#qiskit.algorithms.optimizers.SciPyOptimizer.print_options "qiskit.algorithms.optimizers.SciPyOptimizer.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.SciPyOptimizer.set_max_evals_grouped#qiskit.algorithms.optimizers.SciPyOptimizer.set_max_evals_grouped "qiskit.algorithms.optimizers.SciPyOptimizer.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.SciPyOptimizer.set_options#qiskit.algorithms.optimizers.SciPyOptimizer.set_options "qiskit.algorithms.optimizers.SciPyOptimizer.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.SciPyOptimizer.wrap_function#qiskit.algorithms.optimizers.SciPyOptimizer.wrap_function "qiskit.algorithms.optimizers.SciPyOptimizer.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static SciPyOptimizer.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`SciPyOptimizer.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`SciPyOptimizer.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`SciPyOptimizer.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static SciPyOptimizer.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + 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 e83064f8dc4..1f76b2e70b7 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.TNC.md @@ -1,14 +1,22 @@ -# TNC +--- +title: TNC +description: API reference for qiskit.algorithms.optimizers.TNC +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.algorithms.optimizers.TNC +--- +# TNC + -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)` +`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08, options=None, max_evals_grouped=1, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/algorithms/optimizers/tnc.py "view source code") Bases: `qiskit.algorithms.optimizers.scipy_optimizer.SciPyOptimizer` Truncated Newton (TNC) optimizer. -TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.algorithms.optimizers.CG#qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. +TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. Uses scipy.optimize.minimize TNC For further detail, please refer to See [https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html) @@ -28,100 +36,199 @@ Uses scipy.optimize.minimize TNC For further detail, please refer to See [https: ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.algorithms.optimizers.TNC.get_support_level#qiskit.algorithms.optimizers.TNC.get_support_level "qiskit.algorithms.optimizers.TNC.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.algorithms.optimizers.TNC.gradient_num_diff#qiskit.algorithms.optimizers.TNC.gradient_num_diff "qiskit.algorithms.optimizers.TNC.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.algorithms.optimizers.TNC.optimize#qiskit.algorithms.optimizers.TNC.optimize "qiskit.algorithms.optimizers.TNC.optimize") | Perform optimization. | -| [`print_options`](qiskit.algorithms.optimizers.TNC.print_options#qiskit.algorithms.optimizers.TNC.print_options "qiskit.algorithms.optimizers.TNC.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.algorithms.optimizers.TNC.set_max_evals_grouped#qiskit.algorithms.optimizers.TNC.set_max_evals_grouped "qiskit.algorithms.optimizers.TNC.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.algorithms.optimizers.TNC.set_options#qiskit.algorithms.optimizers.TNC.set_options "qiskit.algorithms.optimizers.TNC.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.algorithms.optimizers.TNC.wrap_function#qiskit.algorithms.optimizers.TNC.wrap_function "qiskit.algorithms.optimizers.TNC.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`TNC.get_support_level()` + +Return support level dictionary + +### gradient\_num\_diff + + + +`static TNC.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`TNC.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`TNC.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`TNC.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`TNC.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static TNC.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting - + ### settings **Return type** `Dict`\[`str`, `Any`] + diff --git a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md index b03d4881191..189091514ea 100644 --- a/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md +++ b/docs/api/qiskit/0.32/qiskit.algorithms.optimizers.md @@ -4,7 +4,7 @@ ## Optimizers ([`qiskit.algorithms.optimizers`](#module-qiskit.algorithms.optimizers "qiskit.algorithms.optimizers")) -It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE#qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: +It contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"). Logically, these optimizers can be divided into two categories: ## [Local Optimizers](#local-optimizers) @@ -16,39 +16,39 @@ Given an optimization problem, a **global optimizer** is a function that attempt ## Optimizer Base Class -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`OptimizerSupportLevel`](qiskit.algorithms.optimizers.OptimizerSupportLevel#qiskit.algorithms.optimizers.OptimizerSupportLevel "qiskit.algorithms.optimizers.OptimizerSupportLevel") | Support Level enum for features such as bounds, gradient and initial point | -| [`Optimizer`](qiskit.algorithms.optimizers.Optimizer#qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.Optimizer") | Base class for optimization algorithm. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| [`OptimizerSupportLevel`](qiskit.algorithms.optimizers.OptimizerSupportLevel "qiskit.algorithms.optimizers.OptimizerSupportLevel") | Support Level enum for features such as bounds, gradient and initial point | +| [`Optimizer`](qiskit.algorithms.optimizers.Optimizer "qiskit.algorithms.optimizers.Optimizer") | Base class for optimization algorithm. | ## Local Optimizers -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`ADAM`](qiskit.algorithms.optimizers.ADAM#qiskit.algorithms.optimizers.ADAM "qiskit.algorithms.optimizers.ADAM") | Adam and AMSGRAD optimizers. | -| [`AQGD`](qiskit.algorithms.optimizers.AQGD#qiskit.algorithms.optimizers.AQGD "qiskit.algorithms.optimizers.AQGD") | Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. | -| [`CG`](qiskit.algorithms.optimizers.CG#qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") | Conjugate Gradient optimizer. | -| [`COBYLA`](qiskit.algorithms.optimizers.COBYLA#qiskit.algorithms.optimizers.COBYLA "qiskit.algorithms.optimizers.COBYLA") | Constrained Optimization By Linear Approximation optimizer. | -| [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B#qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") | Limited-memory BFGS Bound optimizer. | -| [`GSLS`](qiskit.algorithms.optimizers.GSLS#qiskit.algorithms.optimizers.GSLS "qiskit.algorithms.optimizers.GSLS") | Gaussian-smoothed Line Search. | -| [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent#qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") | The gradient descent minimization routine. | -| [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD#qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") | Nelder-Mead optimizer. | -| [`NFT`](qiskit.algorithms.optimizers.NFT#qiskit.algorithms.optimizers.NFT "qiskit.algorithms.optimizers.NFT") | Nakanishi-Fujii-Todo algorithm. | -| [`P_BFGS`](qiskit.algorithms.optimizers.P_BFGS#qiskit.algorithms.optimizers.P_BFGS "qiskit.algorithms.optimizers.P_BFGS") | Parallelized Limited-memory BFGS optimizer. | -| [`POWELL`](qiskit.algorithms.optimizers.POWELL#qiskit.algorithms.optimizers.POWELL "qiskit.algorithms.optimizers.POWELL") | Powell optimizer. | -| [`SLSQP`](qiskit.algorithms.optimizers.SLSQP#qiskit.algorithms.optimizers.SLSQP "qiskit.algorithms.optimizers.SLSQP") | Sequential Least SQuares Programming optimizer. | -| [`SPSA`](qiskit.algorithms.optimizers.SPSA#qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.SPSA") | Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. | -| [`QNSPSA`](qiskit.algorithms.optimizers.QNSPSA#qiskit.algorithms.optimizers.QNSPSA "qiskit.algorithms.optimizers.QNSPSA") | The Quantum Natural SPSA (QN-SPSA) optimizer. | -| [`TNC`](qiskit.algorithms.optimizers.TNC#qiskit.algorithms.optimizers.TNC "qiskit.algorithms.optimizers.TNC") | Truncated Newton (TNC) optimizer. | -| [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer#qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.SciPyOptimizer") | A general Qiskit Optimizer wrapping scipy.optimize.minimize. | +| | | +| ---------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| [`ADAM`](qiskit.algorithms.optimizers.ADAM "qiskit.algorithms.optimizers.ADAM") | Adam and AMSGRAD optimizers. | +| [`AQGD`](qiskit.algorithms.optimizers.AQGD "qiskit.algorithms.optimizers.AQGD") | Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. | +| [`CG`](qiskit.algorithms.optimizers.CG "qiskit.algorithms.optimizers.CG") | Conjugate Gradient optimizer. | +| [`COBYLA`](qiskit.algorithms.optimizers.COBYLA "qiskit.algorithms.optimizers.COBYLA") | Constrained Optimization By Linear Approximation optimizer. | +| [`L_BFGS_B`](qiskit.algorithms.optimizers.L_BFGS_B "qiskit.algorithms.optimizers.L_BFGS_B") | Limited-memory BFGS Bound optimizer. | +| [`GSLS`](qiskit.algorithms.optimizers.GSLS "qiskit.algorithms.optimizers.GSLS") | Gaussian-smoothed Line Search. | +| [`GradientDescent`](qiskit.algorithms.optimizers.GradientDescent "qiskit.algorithms.optimizers.GradientDescent") | The gradient descent minimization routine. | +| [`NELDER_MEAD`](qiskit.algorithms.optimizers.NELDER_MEAD "qiskit.algorithms.optimizers.NELDER_MEAD") | Nelder-Mead optimizer. | +| [`NFT`](qiskit.algorithms.optimizers.NFT "qiskit.algorithms.optimizers.NFT") | Nakanishi-Fujii-Todo algorithm. | +| [`P_BFGS`](qiskit.algorithms.optimizers.P_BFGS "qiskit.algorithms.optimizers.P_BFGS") | Parallelized Limited-memory BFGS optimizer. | +| [`POWELL`](qiskit.algorithms.optimizers.POWELL "qiskit.algorithms.optimizers.POWELL") | Powell optimizer. | +| [`SLSQP`](qiskit.algorithms.optimizers.SLSQP "qiskit.algorithms.optimizers.SLSQP") | Sequential Least SQuares Programming optimizer. | +| [`SPSA`](qiskit.algorithms.optimizers.SPSA "qiskit.algorithms.optimizers.SPSA") | Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. | +| [`QNSPSA`](qiskit.algorithms.optimizers.QNSPSA "qiskit.algorithms.optimizers.QNSPSA") | The Quantum Natural SPSA (QN-SPSA) optimizer. | +| [`TNC`](qiskit.algorithms.optimizers.TNC "qiskit.algorithms.optimizers.TNC") | Truncated Newton (TNC) optimizer. | +| [`SciPyOptimizer`](qiskit.algorithms.optimizers.SciPyOptimizer "qiskit.algorithms.optimizers.SciPyOptimizer") | A general Qiskit Optimizer wrapping scipy.optimize.minimize. | Qiskit also provides the following optimizers, which are built-out using the optimizers from the scikit-quant package. The scikit-quant package is not installed by default but must be explicitly installed, if desired, by the user - the optimizers therein are provided under various licenses so it has been made an optional install for the end user to choose whether to do so or not. To install the scikit-quant dependent package you can use pip install scikit-quant. -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| [`BOBYQA`](qiskit.algorithms.optimizers.BOBYQA#qiskit.algorithms.optimizers.BOBYQA "qiskit.algorithms.optimizers.BOBYQA") | Bound Optimization BY Quadratic Approximation algorithm. | -| [`IMFIL`](qiskit.algorithms.optimizers.IMFIL#qiskit.algorithms.optimizers.IMFIL "qiskit.algorithms.optimizers.IMFIL") | IMplicit FILtering algorithm. | -| [`SNOBFIT`](qiskit.algorithms.optimizers.SNOBFIT#qiskit.algorithms.optimizers.SNOBFIT "qiskit.algorithms.optimizers.SNOBFIT") | Stable Noisy Optimization by Branch and FIT algorithm. | +| | | +| ---------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| [`BOBYQA`](qiskit.algorithms.optimizers.BOBYQA "qiskit.algorithms.optimizers.BOBYQA") | Bound Optimization BY Quadratic Approximation algorithm. | +| [`IMFIL`](qiskit.algorithms.optimizers.IMFIL "qiskit.algorithms.optimizers.IMFIL") | IMplicit FILtering algorithm. | +| [`SNOBFIT`](qiskit.algorithms.optimizers.SNOBFIT "qiskit.algorithms.optimizers.SNOBFIT") | Stable Noisy Optimization by Branch and FIT algorithm. | ## Global Optimizers @@ -60,10 +60,10 @@ The global optimizers here all use NLopt for their core function and can only be The global optimizers are as follows: -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| [`CRS`](qiskit.algorithms.optimizers.CRS#qiskit.algorithms.optimizers.CRS "qiskit.algorithms.optimizers.CRS") | Controlled Random Search (CRS) with local mutation optimizer. | -| [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L#qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") | DIviding RECTangles Locally-biased optimizer. | -| [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND#qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | -| [`ESCH`](qiskit.algorithms.optimizers.ESCH#qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | -| [`ISRES`](qiskit.algorithms.optimizers.ISRES#qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | +| [`CRS`](qiskit.algorithms.optimizers.CRS "qiskit.algorithms.optimizers.CRS") | Controlled Random Search (CRS) with local mutation optimizer. | +| [`DIRECT_L`](qiskit.algorithms.optimizers.DIRECT_L "qiskit.algorithms.optimizers.DIRECT_L") | DIviding RECTangles Locally-biased optimizer. | +| [`DIRECT_L_RAND`](qiskit.algorithms.optimizers.DIRECT_L_RAND "qiskit.algorithms.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | +| [`ESCH`](qiskit.algorithms.optimizers.ESCH "qiskit.algorithms.optimizers.ESCH") | ESCH evolutionary optimizer. | +| [`ISRES`](qiskit.algorithms.optimizers.ISRES "qiskit.algorithms.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | diff --git a/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md b/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md index 6dd6370b0eb..c2c87a14da5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.AquaError.md @@ -1,9 +1,18 @@ -# qiskit.aqua.AquaError +--- +title: AquaError +description: API reference for qiskit.aqua.AquaError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.aqua.AquaError +--- +# qiskit.aqua.AquaError + -`AquaError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md b/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md index 0c5acea5549..a6654a15886 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.MissingOptionalLibraryError.md @@ -1,8 +1,16 @@ -# qiskit.aqua.MissingOptionalLibraryError +--- +title: MissingOptionalLibraryError +description: API reference for qiskit.aqua.MissingOptionalLibraryError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.aqua.MissingOptionalLibraryError +--- +# qiskit.aqua.MissingOptionalLibraryError + -`MissingOptionalLibraryError(libname, name, pip_install=None, msg=None)` +`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. @@ -14,3 +22,4 @@ Set the error message. * **name** (`str`) – Name of class, function, module that uses this library * **pip\_install** (`Optional`\[`str`]) – pip install command, if any * **msg** (`Optional`\[`str`]) – Descriptive message, if any + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md b/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md index c5403b7858d..4b2f505ac55 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.QuantumInstance.md @@ -1,8 +1,16 @@ -# QuantumInstance +--- +title: QuantumInstance +description: API reference for qiskit.aqua.QuantumInstance +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.QuantumInstance +--- +# 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)` +`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` @@ -34,121 +42,224 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu **Raises** -* [**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – the shots exceeds the maximum number of shots -* [**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – set noise model but the backend does not support that -* [**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – set backend\_options but the backend does not support that +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – the shots exceeds the maximum number of shots +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – set noise model but the backend does not support that +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – set backend\_options but the backend does not support that ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [`assemble`](qiskit.aqua.QuantumInstance.assemble#qiskit.aqua.QuantumInstance.assemble "qiskit.aqua.QuantumInstance.assemble") | assemble circuits | -| [`cals_matrix`](qiskit.aqua.QuantumInstance.cals_matrix#qiskit.aqua.QuantumInstance.cals_matrix "qiskit.aqua.QuantumInstance.cals_matrix") | Get the stored calibration matrices and its timestamp. | -| [`execute`](qiskit.aqua.QuantumInstance.execute#qiskit.aqua.QuantumInstance.execute "qiskit.aqua.QuantumInstance.execute") | A wrapper to interface with quantum backend. | -| [`maybe_refresh_cals_matrix`](qiskit.aqua.QuantumInstance.maybe_refresh_cals_matrix#qiskit.aqua.QuantumInstance.maybe_refresh_cals_matrix "qiskit.aqua.QuantumInstance.maybe_refresh_cals_matrix") | Calculate the time difference from the query of last time. | -| [`reset_execution_results`](qiskit.aqua.QuantumInstance.reset_execution_results#qiskit.aqua.QuantumInstance.reset_execution_results "qiskit.aqua.QuantumInstance.reset_execution_results") | Reset execution results | -| [`set_config`](qiskit.aqua.QuantumInstance.set_config#qiskit.aqua.QuantumInstance.set_config "qiskit.aqua.QuantumInstance.set_config") | Set configurations for the quantum instance. | -| [`transpile`](qiskit.aqua.QuantumInstance.transpile#qiskit.aqua.QuantumInstance.transpile "qiskit.aqua.QuantumInstance.transpile") | A wrapper to transpile circuits to allow algorithm access the transpiled circuits. | +### assemble -## Attributes + + +`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 + +**Return type** + +[`Qobj`](qiskit.qobj.Qobj "qiskit.qobj.Qobj") + +### cals\_matrix + + + +`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. + +**Parameters** + +**qubit\_index** (`Optional`\[`List`\[`int`]]) – the qubit index of corresponding calibration matrix. If None, return all stored calibration matrices. + +**Return type** + +`Union`\[`Tuple`\[`ndarray`, `float`], `Dict`\[`str`, `Tuple`\[`ndarray`, `float`]], `None`] + +**Returns** + +The calibration matrix and the creation timestamp if qubit\_index is not None otherwise, return all matrices and their timestamp in a dictionary. + +### execute + + + +`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. + +**Parameters** + +* **circuits** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]]) – circuits to execute +* **had\_transpiled** (`bool`) – whether or not circuits had been transpiled + +**Return type** + +`Result` + +**Returns** + +Result object + +#### TODO: Maybe we can combine the circuits for the main ones and calibration circuits before + +assembling to the qobj. + +### maybe\_refresh\_cals\_matrix + + + +`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. + +**Parameters** + +**timestamp** (`Optional`\[`float`]) – timestamp + +**Return type** + +`bool` + +**Returns** + +Whether or not refresh the cals\_matrix + +### reset\_execution\_results + + + +`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 + +**Return type** + +`None` + +### set\_config + + + +`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. + +### transpile + + + +`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 + +**Return type** +`List`\[`QuantumCircuit`] +**Returns** + +The transpiled circuits, it is always a list even though the length is one. + +## Attributes + + ### backend Return BaseBackend backend object. - + ### backend\_config Getter of backend\_config. - + ### backend\_name Return backend name. - + ### backend\_options Getter of backend\_options. - + ### cals\_matrix\_refresh\_period returns matrix refresh period - + ### circuit\_summary Getter of circuit summary. - + ### compile\_config Getter of compile\_config. - + ### is\_local Return True if backend is a local backend. - + ### is\_simulator Return True if backend is a simulator. - + ### is\_statevector Return True if backend is a statevector-type simulator. - + ### measurement\_error\_mitigation\_cls returns measurement error mitigation cls - + ### measurement\_error\_mitigation\_shots returns measurement error mitigation shots - + ### noise\_config Getter of noise\_config. - + ### qjob\_config Getter of qjob\_config. - + ### run\_config Getter of run\_config. - + ### skip\_qobj\_validation checks if skip qobj validation - + ### time\_taken @@ -157,3 +268,4 @@ Accumulated time taken for execution. **Return type** `float` + 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 764e558fd3a..6145ae1b8f2 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimation.md @@ -1,8 +1,16 @@ -# AmplitudeEstimation +--- +title: AmplitudeEstimation +description: API reference for qiskit.aqua.algorithms.AmplitudeEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.AmplitudeEstimation +--- +# 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)` +`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` @@ -44,18 +52,136 @@ Iterative Quantum Amplitude Estimation. [arXiv:1912.05559](https://arxiv.org/abs ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`confidence_interval`](qiskit.aqua.algorithms.AmplitudeEstimation.confidence_interval#qiskit.aqua.algorithms.AmplitudeEstimation.confidence_interval "qiskit.aqua.algorithms.AmplitudeEstimation.confidence_interval") | Compute the (1 - alpha) confidence interval. | -| [`construct_circuit`](qiskit.aqua.algorithms.AmplitudeEstimation.construct_circuit#qiskit.aqua.algorithms.AmplitudeEstimation.construct_circuit "qiskit.aqua.algorithms.AmplitudeEstimation.construct_circuit") | Construct the Amplitude Estimation quantum circuit. | -| [`is_good_state`](qiskit.aqua.algorithms.AmplitudeEstimation.is_good_state#qiskit.aqua.algorithms.AmplitudeEstimation.is_good_state "qiskit.aqua.algorithms.AmplitudeEstimation.is_good_state") | Determine whether a given state is a good state. | -| [`post_processing`](qiskit.aqua.algorithms.AmplitudeEstimation.post_processing#qiskit.aqua.algorithms.AmplitudeEstimation.post_processing "qiskit.aqua.algorithms.AmplitudeEstimation.post_processing") | Post processing of the raw amplitude estimation output $0 \leq a \leq 1$. | -| [`run`](qiskit.aqua.algorithms.AmplitudeEstimation.run#qiskit.aqua.algorithms.AmplitudeEstimation.run "qiskit.aqua.algorithms.AmplitudeEstimation.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.AmplitudeEstimation.set_backend#qiskit.aqua.algorithms.AmplitudeEstimation.set_backend "qiskit.aqua.algorithms.AmplitudeEstimation.set_backend") | Sets backend with configuration. | +### confidence\_interval -## Attributes + + +`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. + +**Parameters** + +* **alpha** (`float`) – Confidence level: compute the (1 - alpha) confidence interval. +* **kind** (`str`) – The method to compute the confidence interval, can be ‘fisher’, ‘observed\_fisher’ or ‘likelihood\_ratio’ (default) + +**Return type** + +`List`\[`float`] + +**Returns** + +The (1 - alpha) confidence interval of the specified kind. + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If ‘mle’ is not in self.\_ret.keys() (i.e. run was not called yet). +* **NotImplementedError** – If the confidence interval method kind is not implemented. + +### construct\_circuit + + + +`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. + +**Parameters** + +**measurement** (`bool`) – Boolean flag to indicate if measurements should be included in the circuit. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The QuantumCircuit object for the constructed circuit. + +### is\_good\_state + + + +`AmplitudeEstimation.is_good_state(measurement)` + +Determine whether a given state is a good state. + +**Parameters** + +**measurement** (`str`) – A measurement as bitstring, e.g. ‘01100’. + +**Return type** + +`bool` + +**Returns** + +True if the measurement corresponds to a good state, False otherwise. + +**Raises** + +**ValueError** – If `self.objective_qubits` is not set. +### post\_processing + + +`AmplitudeEstimation.post_processing(value)` + +Post processing of the raw amplitude estimation output $0 \leq a \leq 1$. + +**Parameters** + +**value** (`float`) – The estimation value $a$. + +**Return type** + +`float` + +**Returns** + +The value after post processing, usually mapping the interval $[0, 1]$ to the target interval. + +### run + + + +`AmplitudeEstimation.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`AmplitudeEstimation.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### a\_factory @@ -71,9 +197,9 @@ the A operator as CircuitFactory **Return type** -[CircuitFactory](qiskit.aqua.utils.CircuitFactory#qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") - +[CircuitFactory](qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") + ### backend @@ -83,7 +209,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### grover\_operator @@ -99,7 +225,7 @@ If the Grover operator is not set, we try to build it from the $\mathcal{A}$ ope The Grover operator, or None if neither the Grover operator nor the $\mathcal{A}$ operator is set. - + ### i\_objective @@ -119,7 +245,7 @@ the index of the objective qubit int - + ### objective\_qubits @@ -133,7 +259,7 @@ Get the criterion for a measurement outcome to be in a ‘good’ state. The criterion as list of qubit indices. - + ### q\_factory @@ -155,7 +281,7 @@ returns the current Q factory of the algorithm QFactory - + ### quantum\_instance @@ -165,13 +291,13 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### state\_preparation @@ -184,3 +310,4 @@ Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Returns** The $\mathcal{A}$ operator as QuantumCircuit. + 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 80cbbed1f3b..2a74e74f268 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.md @@ -1,8 +1,16 @@ -# AmplitudeEstimationAlgorithmResult +--- +title: AmplitudeEstimationAlgorithmResult +description: API reference for qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult +--- +# AmplitudeEstimationAlgorithmResult + -`AmplitudeEstimationAlgorithmResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ AmplitudeEstimationAlgorithm Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.clear#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.clear "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.combine#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.combine "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.copy#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.copy "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.from_dict#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.from_dict "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.fromkeys#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.fromkeys "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.get#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.get "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.get") | | -| [`items`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.items#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.items "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.items") | | -| [`keys`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.keys#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.keys "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.pop#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.pop "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.popitem#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.popitem "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.setdefault#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.setdefault "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.update#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.update "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.values#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.values "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult.values") | | +### clear -## Attributes + + +`AmplitudeEstimationAlgorithmResult.clear()` + +**Return type** + +`None` + +### combine + + + +`AmplitudeEstimationAlgorithmResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`AmplitudeEstimationAlgorithmResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`AmplitudeEstimationAlgorithmResult` + +### fromkeys + + + +`classmethod AmplitudeEstimationAlgorithmResult.fromkeys(iterable, value=None)` + +### get + + + +`AmplitudeEstimationAlgorithmResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`AmplitudeEstimationAlgorithmResult.items() → a set-like object providing a view on D’s items` +### keys + + +`AmplitudeEstimationAlgorithmResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`AmplitudeEstimationAlgorithmResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`AmplitudeEstimationAlgorithmResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`AmplitudeEstimationAlgorithmResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`AmplitudeEstimationAlgorithmResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`AmplitudeEstimationAlgorithmResult.values() → an object providing a view on D’s values` + +## Attributes + + ### a\_estimation @@ -38,7 +146,7 @@ return a\_estimation `float` - + ### confidence\_interval @@ -48,7 +156,7 @@ return confidence\_interval `List`\[`float`] - + ### estimation @@ -58,7 +166,7 @@ return estimation `float` - + ### num\_oracle\_queries @@ -67,3 +175,4 @@ return num\_oracle\_queries **Return type** `int` + 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 3ffae4db748..214b669ba8c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.AmplitudeEstimationResult.md @@ -1,8 +1,16 @@ -# AmplitudeEstimationResult +--- +title: AmplitudeEstimationResult +description: API reference for qiskit.aqua.algorithms.AmplitudeEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.AmplitudeEstimationResult +--- +# AmplitudeEstimationResult + -`AmplitudeEstimationResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ AmplitudeEstimation Result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.AmplitudeEstimationResult.clear#qiskit.aqua.algorithms.AmplitudeEstimationResult.clear "qiskit.aqua.algorithms.AmplitudeEstimationResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.AmplitudeEstimationResult.combine#qiskit.aqua.algorithms.AmplitudeEstimationResult.combine "qiskit.aqua.algorithms.AmplitudeEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.AmplitudeEstimationResult.copy#qiskit.aqua.algorithms.AmplitudeEstimationResult.copy "qiskit.aqua.algorithms.AmplitudeEstimationResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.AmplitudeEstimationResult.from_dict#qiskit.aqua.algorithms.AmplitudeEstimationResult.from_dict "qiskit.aqua.algorithms.AmplitudeEstimationResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.AmplitudeEstimationResult.fromkeys#qiskit.aqua.algorithms.AmplitudeEstimationResult.fromkeys "qiskit.aqua.algorithms.AmplitudeEstimationResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.AmplitudeEstimationResult.get#qiskit.aqua.algorithms.AmplitudeEstimationResult.get "qiskit.aqua.algorithms.AmplitudeEstimationResult.get") | | -| [`items`](qiskit.aqua.algorithms.AmplitudeEstimationResult.items#qiskit.aqua.algorithms.AmplitudeEstimationResult.items "qiskit.aqua.algorithms.AmplitudeEstimationResult.items") | | -| [`keys`](qiskit.aqua.algorithms.AmplitudeEstimationResult.keys#qiskit.aqua.algorithms.AmplitudeEstimationResult.keys "qiskit.aqua.algorithms.AmplitudeEstimationResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.AmplitudeEstimationResult.pop#qiskit.aqua.algorithms.AmplitudeEstimationResult.pop "qiskit.aqua.algorithms.AmplitudeEstimationResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.AmplitudeEstimationResult.popitem#qiskit.aqua.algorithms.AmplitudeEstimationResult.popitem "qiskit.aqua.algorithms.AmplitudeEstimationResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.AmplitudeEstimationResult.setdefault#qiskit.aqua.algorithms.AmplitudeEstimationResult.setdefault "qiskit.aqua.algorithms.AmplitudeEstimationResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.AmplitudeEstimationResult.update#qiskit.aqua.algorithms.AmplitudeEstimationResult.update "qiskit.aqua.algorithms.AmplitudeEstimationResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.AmplitudeEstimationResult.values#qiskit.aqua.algorithms.AmplitudeEstimationResult.values "qiskit.aqua.algorithms.AmplitudeEstimationResult.values") | | +### clear -## Attributes + + +`AmplitudeEstimationResult.clear()` + +**Return type** + +`None` + +### combine + + + +`AmplitudeEstimationResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`AmplitudeEstimationResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`AmplitudeEstimationResult` + +### fromkeys + + + +`classmethod AmplitudeEstimationResult.fromkeys(iterable, value=None)` + +### get + + + +`AmplitudeEstimationResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`AmplitudeEstimationResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`AmplitudeEstimationResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + +`AmplitudeEstimationResult.pop(key, default=None)` +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`AmplitudeEstimationResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`AmplitudeEstimationResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`AmplitudeEstimationResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`AmplitudeEstimationResult.values() → an object providing a view on D’s values` + +## Attributes + + ### a\_estimation @@ -38,7 +146,7 @@ return a\_estimation `float` - + ### a\_samples @@ -48,7 +156,7 @@ return a\_samples `List`\[`Tuple`\[`float`, `float`]] - + ### circuit\_result @@ -58,7 +166,7 @@ return circuit result `Union`\[`ndarray`, `Dict`\[`str`, `int`], `None`] - + ### confidence\_interval @@ -68,7 +176,7 @@ return confidence\_interval `List`\[`float`] - + ### estimation @@ -78,7 +186,7 @@ return estimation `float` - + ### mapped\_a\_samples @@ -88,7 +196,7 @@ return mapped\_a\_samples `List`\[`float`] - + ### mapped\_values @@ -98,7 +206,7 @@ return mapped\_values `List`\[`float`] - + ### max\_probability @@ -108,7 +216,7 @@ return max\_probability `float` - + ### ml\_value @@ -118,7 +226,7 @@ returns ml\_value `float` - + ### mle @@ -128,7 +236,7 @@ return mle `float` - + ### num\_oracle\_queries @@ -138,7 +246,7 @@ return num\_oracle\_queries `int` - + ### probabilities @@ -148,7 +256,7 @@ return probabilities `List`\[`float`] - + ### shots @@ -158,7 +266,7 @@ return shots `int` - + ### y\_measurements @@ -167,3 +275,4 @@ return y\_measurements **Return type** `List`\[`Tuple`\[`int`, `float`]] + 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 7613ca67edb..bdf6a6a2030 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.BernsteinVazirani.md @@ -1,8 +1,16 @@ -# BernsteinVazirani +--- +title: BernsteinVazirani +description: API reference for qiskit.aqua.algorithms.BernsteinVazirani +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.BernsteinVazirani +--- +# BernsteinVazirani + -`BernsteinVazirani(oracle, quantum_instance=None)` +`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` @@ -17,15 +25,66 @@ The Bernstein-Vazirani algorithm is an extension / restriction of the Deutsch-Jo ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.algorithms.BernsteinVazirani.construct_circuit#qiskit.aqua.algorithms.BernsteinVazirani.construct_circuit "qiskit.aqua.algorithms.BernsteinVazirani.construct_circuit") | Construct the quantum circuit | -| [`run`](qiskit.aqua.algorithms.BernsteinVazirani.run#qiskit.aqua.algorithms.BernsteinVazirani.run "qiskit.aqua.algorithms.BernsteinVazirani.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.BernsteinVazirani.set_backend#qiskit.aqua.algorithms.BernsteinVazirani.set_backend "qiskit.aqua.algorithms.BernsteinVazirani.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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 + +**Parameters** + +**measurement** (*bool*) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** + +the QuantumCircuit object for the constructed circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### run + + + +`BernsteinVazirani.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`BernsteinVazirani.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -35,7 +94,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -45,8 +104,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 bc0f18e88eb..3a85fe02cfa 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalAlgorithm.md @@ -1,8 +1,16 @@ -# ClassicalAlgorithm +--- +title: ClassicalAlgorithm +description: API reference for qiskit.aqua.algorithms.ClassicalAlgorithm +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.ClassicalAlgorithm +--- +# ClassicalAlgorithm + -`ClassicalAlgorithm` +`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` @@ -10,14 +18,27 @@ Base class for Classical Algorithms. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`run`](qiskit.aqua.algorithms.ClassicalAlgorithm.run#qiskit.aqua.algorithms.ClassicalAlgorithm.run "qiskit.aqua.algorithms.ClassicalAlgorithm.run") | Execute the classical algorithm. | +### run -## Attributes + + +`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. + +**Returns** +results of an algorithm. +**Return type** + +dict + +## Attributes + + ### random Return a numpy random. + 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 4670b888e04..f5ad0c57f4e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.ClassicalCPLEX.md @@ -1,8 +1,16 @@ -# ClassicalCPLEX +--- +title: ClassicalCPLEX +description: API reference for qiskit.aqua.algorithms.ClassicalCPLEX +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.ClassicalCPLEX +--- +# ClassicalCPLEX + -`ClassicalCPLEX(operator, timelimit=600, thread=1, display=2)` +`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` @@ -21,20 +29,33 @@ See these `installation instructions` if you need more information in that regar ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`run`](qiskit.aqua.algorithms.ClassicalCPLEX.run#qiskit.aqua.algorithms.ClassicalCPLEX.run "qiskit.aqua.algorithms.ClassicalCPLEX.run") | Execute the classical algorithm. | +### run -## Attributes + + +`ClassicalCPLEX.run()` + +Execute the classical algorithm. + +**Returns** +results of an algorithm. +**Return type** + +dict + +## Attributes + + ### random Return a numpy random. - + ### solution return solution + 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 5f96c5aeac4..40b26aa0800 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.DeutschJozsa.md @@ -1,8 +1,16 @@ -# DeutschJozsa +--- +title: DeutschJozsa +description: API reference for qiskit.aqua.algorithms.DeutschJozsa +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.DeutschJozsa +--- +# DeutschJozsa + -`DeutschJozsa(oracle, quantum_instance=None)` +`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` @@ -10,7 +18,7 @@ The Deutsch-Jozsa algorithm. The Deutsch-Jozsa algorithm was one of the first known quantum algorithms that showed an exponential speedup compared to a deterministic (non-probabilistic) classical algorithm, given a black box oracle function. The algorithm determines whether the given function $f:\{0,1\}^n \rightarrow \{0,1\}$ is constant or balanced. A constant function maps all inputs to 0 or 1, and a balanced function maps half of its inputs to 0 and the other half to 1. -Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle#qiskit.aqua.components.oracles.TruthTableOracle "qiskit.aqua.components.oracles.TruthTableOracle") facilitates creating a constant or balanced function but any oracle can be used as long as the boolean function implemented by the oracle indeed satisfies the constraint of being either constant or balanced. +Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle "qiskit.aqua.components.oracles.TruthTableOracle") facilitates creating a constant or balanced function but any oracle can be used as long as the boolean function implemented by the oracle indeed satisfies the constraint of being either constant or balanced. **Parameters** @@ -19,15 +27,66 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle#q ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.algorithms.DeutschJozsa.construct_circuit#qiskit.aqua.algorithms.DeutschJozsa.construct_circuit "qiskit.aqua.algorithms.DeutschJozsa.construct_circuit") | Construct the quantum circuit | -| [`run`](qiskit.aqua.algorithms.DeutschJozsa.run#qiskit.aqua.algorithms.DeutschJozsa.run "qiskit.aqua.algorithms.DeutschJozsa.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.DeutschJozsa.set_backend#qiskit.aqua.algorithms.DeutschJozsa.set_backend "qiskit.aqua.algorithms.DeutschJozsa.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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 + +**Parameters** + +**measurement** (*bool*) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** + +the QuantumCircuit object for the constructed circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### run + + + +`DeutschJozsa.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`DeutschJozsa.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -37,7 +96,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -47,8 +106,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 eedc2e58545..6005a5c125b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EOH.md @@ -1,8 +1,16 @@ -# EOH +--- +title: EOH +description: API reference for qiskit.aqua.algorithms.EOH +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.EOH +--- +# EOH + -`EOH(operator, initial_state, evo_operator, evo_time=1, num_time_slices=1, expansion_mode='trotter', expansion_order=1, quantum_instance=None)` +`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` @@ -23,15 +31,62 @@ EOH provides the lower-level building blocks for simulating universal quantum sy ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.algorithms.EOH.construct_circuit#qiskit.aqua.algorithms.EOH.construct_circuit "qiskit.aqua.algorithms.EOH.construct_circuit") | Construct the circuit. | -| [`run`](qiskit.aqua.algorithms.EOH.run#qiskit.aqua.algorithms.EOH.run "qiskit.aqua.algorithms.EOH.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.EOH.set_backend#qiskit.aqua.algorithms.EOH.set_backend "qiskit.aqua.algorithms.EOH.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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. + +**Returns** + +the circuit. + +**Return type** +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +### run + + + +`EOH.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`EOH.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -41,7 +96,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -51,8 +106,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 e6941e81f9f..36a981429d0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Eigensolver.md @@ -1,8 +1,16 @@ -# Eigensolver +--- +title: Eigensolver +description: API reference for qiskit.aqua.algorithms.Eigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.Eigensolver +--- +# Eigensolver + -`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") Bases: `abc.ABC` @@ -12,14 +20,46 @@ Algorithms that can compute eigenvalues for an operator may implement this inter ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_eigenvalues`](qiskit.aqua.algorithms.Eigensolver.compute_eigenvalues#qiskit.aqua.algorithms.Eigensolver.compute_eigenvalues "qiskit.aqua.algorithms.Eigensolver.compute_eigenvalues") | Computes eigenvalues. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.Eigensolver.supports_aux_operators#qiskit.aqua.algorithms.Eigensolver.supports_aux_operators "qiskit.aqua.algorithms.Eigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_eigenvalues -## Attributes + + +`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. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** + +`EigensolverResult` + +**Returns** + +EigensolverResult +### supports\_aux\_operators + + +`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. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -29,7 +69,7 @@ Returns the auxiliary operators. `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### operator @@ -38,3 +78,4 @@ Return the operator. **Return type** `Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`] + 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 eedd94f73db..03e2bee0c4e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.EigensolverResult.md @@ -1,8 +1,16 @@ -# EigensolverResult +--- +title: EigensolverResult +description: API reference for qiskit.aqua.algorithms.EigensolverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.EigensolverResult +--- +# EigensolverResult + -`EigensolverResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ Eigensolver Result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.EigensolverResult.clear#qiskit.aqua.algorithms.EigensolverResult.clear "qiskit.aqua.algorithms.EigensolverResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.EigensolverResult.combine#qiskit.aqua.algorithms.EigensolverResult.combine "qiskit.aqua.algorithms.EigensolverResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.EigensolverResult.copy#qiskit.aqua.algorithms.EigensolverResult.copy "qiskit.aqua.algorithms.EigensolverResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.EigensolverResult.from_dict#qiskit.aqua.algorithms.EigensolverResult.from_dict "qiskit.aqua.algorithms.EigensolverResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.EigensolverResult.fromkeys#qiskit.aqua.algorithms.EigensolverResult.fromkeys "qiskit.aqua.algorithms.EigensolverResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.EigensolverResult.get#qiskit.aqua.algorithms.EigensolverResult.get "qiskit.aqua.algorithms.EigensolverResult.get") | | -| [`items`](qiskit.aqua.algorithms.EigensolverResult.items#qiskit.aqua.algorithms.EigensolverResult.items "qiskit.aqua.algorithms.EigensolverResult.items") | | -| [`keys`](qiskit.aqua.algorithms.EigensolverResult.keys#qiskit.aqua.algorithms.EigensolverResult.keys "qiskit.aqua.algorithms.EigensolverResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.EigensolverResult.pop#qiskit.aqua.algorithms.EigensolverResult.pop "qiskit.aqua.algorithms.EigensolverResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.EigensolverResult.popitem#qiskit.aqua.algorithms.EigensolverResult.popitem "qiskit.aqua.algorithms.EigensolverResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.EigensolverResult.setdefault#qiskit.aqua.algorithms.EigensolverResult.setdefault "qiskit.aqua.algorithms.EigensolverResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.EigensolverResult.update#qiskit.aqua.algorithms.EigensolverResult.update "qiskit.aqua.algorithms.EigensolverResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.EigensolverResult.values#qiskit.aqua.algorithms.EigensolverResult.values "qiskit.aqua.algorithms.EigensolverResult.values") | | +### clear -## Attributes + + +`EigensolverResult.clear()` + +**Return type** + +`None` + +### combine + + + +`EigensolverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`EigensolverResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`EigensolverResult` + +### fromkeys + + + +`classmethod EigensolverResult.fromkeys(iterable, value=None)` + +### get + + + +`EigensolverResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`EigensolverResult.items() → a set-like object providing a view on D’s items` +### keys + + +`EigensolverResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`EigensolverResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`EigensolverResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`EigensolverResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`EigensolverResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`EigensolverResult.values() → an object providing a view on D’s values` + +## Attributes + + ### aux\_operator\_eigenvalues @@ -38,7 +146,7 @@ return aux operator eigen values `Optional`\[`ndarray`] - + ### eigenstates @@ -48,7 +156,7 @@ return eigen states `Optional`\[`ndarray`] - + ### eigenvalues @@ -57,3 +165,4 @@ returns eigen values **Return type** `Optional`\[`ndarray`] + 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 60f1ec04823..2ad6795c4a7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Grover.md @@ -1,8 +1,16 @@ -# Grover +--- +title: Grover +description: API reference for qiskit.aqua.algorithms.Grover +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.Grover +--- +# 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)` +`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` @@ -22,7 +30,7 @@ $$ i.e. it flips the phase of the state $|x\rangle$ if $x$ is a hit. The details of how $S_f$ works are unimportant to the algorithm; Grover’s search algorithm treats the oracle as a black box. -This class supports oracles in form of `QuantumCircuit` or [`Oracle`](qiskit.aqua.components.oracles.Oracle#qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle"). For example the [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle#qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle") can take as input a SAT problem in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html) and be used with Grover algorithm to find a satisfiable assignment. +This class supports oracles in form of `QuantumCircuit` or [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle"). For example the [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle") can take as input a SAT problem in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html) and be used with Grover algorithm to find a satisfiable assignment. With oracle at hand, Grover’s Search constructs the Grover operator to amplify the amplitudes of the good states: @@ -41,7 +49,7 @@ $$ \mathcal{Q} = \mathcal{A} \mathcal{S}_0 \mathcal{A}^\dagger \mathcal{S}_f. $$ -For more information, see the [`GroverOperator`](qiskit.circuit.library.GroverOperator#qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator") in the circuit library. +For more information, see the [`GroverOperator`](qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator") in the circuit library. ## References @@ -60,12 +68,12 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// **Parameters** * **oracle** (`Union`\[`Oracle`, `QuantumCircuit`, `Statevector`]) – The oracle to flip the phase of good states, $\mathcal{S}_f$. -* **good\_state** (`Union`\[`Callable`\[\[`str`], `bool`], `List`\[`int`], `List`\[`str`], `Statevector`, `None`]) – A callable to check if a given measurement corresponds to a good state. For convenience, a list of bitstrings, a list of integer or statevector can be passed instead of a function. If the input is a list of bitstrings, each bitstrings in the list represents a good state. If the input is a list of integer, each integer represent the index of the good state to be $|1\rangle$. If it is a [`Statevector`](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector"), it represents a superposition of all good states. +* **good\_state** (`Union`\[`Callable`\[\[`str`], `bool`], `List`\[`int`], `List`\[`str`], `Statevector`, `None`]) – A callable to check if a given measurement corresponds to a good state. For convenience, a list of bitstrings, a list of integer or statevector can be passed instead of a function. If the input is a list of bitstrings, each bitstrings in the list represents a good state. If the input is a list of integer, each integer represent the index of the good state to be $|1\rangle$. If it is a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector"), it represents a superposition of all good states. * **state\_preparation** (`Optional`\[`QuantumCircuit`]) – The state preparation $\mathcal{A}$. If None then Grover’s Search by default uses uniform superposition. * **iterations** (`Union`\[`int`, `List`\[`int`]]) – Specify the number of iterations/power of Grover’s operator to be checked. It the number of solutions is known, this should be an integer specifying the optimal number of iterations (see `optimal_num_iterations`). Alternatively, this can be a list of powers to check. * **sample\_from\_iterations** (`bool`) – If True, instead of taking the values in `iterations` as powers of the Grover operator, a random integer sample between 0 and smaller value than the iteration is used as a power, see \[1], Section 4. * **post\_processing** (`Optional`\[`Callable`\[\[`List`\[`int`]], `List`\[`int`]]]) – An optional post processing applied to the top measurement. Can be used e.g. to convert from the bit-representation of the measurement \[1, 0, 1] to a DIMACS CNF format \[1, -2, 3]. -* **grover\_operator** (`Optional`\[`QuantumCircuit`]) – A circuit implementing the Grover operator $\mathcal{Q}$. If None, the operator is constructed automatically using the [`GroverOperator`](qiskit.circuit.library.GroverOperator#qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator") from the circuit library. +* **grover\_operator** (`Optional`\[`QuantumCircuit`]) – A circuit implementing the Grover operator $\mathcal{Q}$. If None, the operator is constructed automatically using the [`GroverOperator`](qiskit.circuit.library.GroverOperator "qiskit.circuit.library.GroverOperator") from the circuit library. * **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – A Quantum Instance or Backend to run the circuits. * **init\_state** (`Optional`\[`InitialState`]) – DEPRECATED, use `state_preparation` instead. An optional initial quantum state. If None (default) then Grover’s Search by default uses uniform superposition to initialize its quantum state. However, an initial state may be supplied, if useful, for example, if the user has some prior knowledge regarding where the search target(s) might be located. * **incremental** (`bool`) – DEPRECATED, use `iterations` instead. Whether to use incremental search mode (True) or not (False). Supplied *num\_iterations* is ignored when True and instead the search task will be carried out in successive rounds, using circuits built with incrementally higher number of iterations for the repetition of the amplitude amplification until a target is found or the maximal number $\log N$ ($N$ being the total number of elements in the set from the oracle used) of iterations is reached. The implementation follows Section 4 of \[2]. @@ -77,7 +85,7 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// **Raises** * **TypeError** – If `init_state` is of unsupported type or is of type ```InitialState` but     the oracle is not of type ``Oracle```. -* [**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – evaluate\_classically() missing from the input oracle +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – evaluate\_classically() missing from the input oracle * **TypeError** – If `oracle` is of unsupported type. ## References @@ -88,18 +96,128 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.algorithms.Grover.construct_circuit#qiskit.aqua.algorithms.Grover.construct_circuit "qiskit.aqua.algorithms.Grover.construct_circuit") | Construct the circuit for Grover’s algorithm with `power` Grover operators. | -| [`is_good_state`](qiskit.aqua.algorithms.Grover.is_good_state#qiskit.aqua.algorithms.Grover.is_good_state "qiskit.aqua.algorithms.Grover.is_good_state") | Check whether a provided bitstring is a good state or not. | -| [`optimal_num_iterations`](qiskit.aqua.algorithms.Grover.optimal_num_iterations#qiskit.aqua.algorithms.Grover.optimal_num_iterations "qiskit.aqua.algorithms.Grover.optimal_num_iterations") | Return the optimal number of iterations, if the number of solutions is known. | -| [`post_processing`](qiskit.aqua.algorithms.Grover.post_processing#qiskit.aqua.algorithms.Grover.post_processing "qiskit.aqua.algorithms.Grover.post_processing") | Do the post-processing to the measurement result | -| [`run`](qiskit.aqua.algorithms.Grover.run#qiskit.aqua.algorithms.Grover.run "qiskit.aqua.algorithms.Grover.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.Grover.set_backend#qiskit.aqua.algorithms.Grover.set_backend "qiskit.aqua.algorithms.Grover.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **power** (`Optional`\[`int`]) – The number of times the Grover operator is repeated. If None, this argument is set to the first item in `iterations`. +* **measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** + +the QuantumCircuit object for the constructed circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### is\_good\_state + + + +`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. + +**Parameters** + +**bitstr** (`str`) – The measurement as bitstring. + +**Return type** + +`bool` + +**Returns** + +True if the measurement is a good state, False otherwise. + +### optimal\_num\_iterations + + + +`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. + +**Parameters** + +* **num\_solutions** (`int`) – The number of solutions. +* **num\_qubits** (`int`) – The number of qubits used to encode the states. + +**Return type** + +`int` + +**Returns** + +The optimal number of iterations for Grover’s algorithm to succeed. + +### post\_processing + +`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 + +**Parameters** + +**measurement** (`List`\[`int`]) – The measurement as list of int. + +**Return type** + +`List`\[`int`] + +**Returns** + +Do the post-processing based on the post\_processing argument. If the post\_processing argument is None and the Oracle class is used as its oracle, oracle.evaluate\_classically is used as the post\_processing. Otherwise, just return the input bitstr + +### run + + + +`Grover.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`Grover.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -109,7 +227,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### grover\_operator @@ -119,7 +237,7 @@ Returns grover\_operator. `QuantumCircuit` - + ### quantum\_instance @@ -129,8 +247,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 3b68c88a9cd..27e2ed48c8b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.GroverResult.md @@ -1,8 +1,16 @@ -# GroverResult +--- +title: GroverResult +description: API reference for qiskit.aqua.algorithms.GroverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.GroverResult +--- +# GroverResult + -`GroverResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ Grover Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.GroverResult.clear#qiskit.aqua.algorithms.GroverResult.clear "qiskit.aqua.algorithms.GroverResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.GroverResult.combine#qiskit.aqua.algorithms.GroverResult.combine "qiskit.aqua.algorithms.GroverResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.GroverResult.copy#qiskit.aqua.algorithms.GroverResult.copy "qiskit.aqua.algorithms.GroverResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.GroverResult.from_dict#qiskit.aqua.algorithms.GroverResult.from_dict "qiskit.aqua.algorithms.GroverResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.GroverResult.fromkeys#qiskit.aqua.algorithms.GroverResult.fromkeys "qiskit.aqua.algorithms.GroverResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.GroverResult.get#qiskit.aqua.algorithms.GroverResult.get "qiskit.aqua.algorithms.GroverResult.get") | | -| [`items`](qiskit.aqua.algorithms.GroverResult.items#qiskit.aqua.algorithms.GroverResult.items "qiskit.aqua.algorithms.GroverResult.items") | | -| [`keys`](qiskit.aqua.algorithms.GroverResult.keys#qiskit.aqua.algorithms.GroverResult.keys "qiskit.aqua.algorithms.GroverResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.GroverResult.pop#qiskit.aqua.algorithms.GroverResult.pop "qiskit.aqua.algorithms.GroverResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.GroverResult.popitem#qiskit.aqua.algorithms.GroverResult.popitem "qiskit.aqua.algorithms.GroverResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.GroverResult.setdefault#qiskit.aqua.algorithms.GroverResult.setdefault "qiskit.aqua.algorithms.GroverResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.GroverResult.update#qiskit.aqua.algorithms.GroverResult.update "qiskit.aqua.algorithms.GroverResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.GroverResult.values#qiskit.aqua.algorithms.GroverResult.values "qiskit.aqua.algorithms.GroverResult.values") | | +### clear -## Attributes + + +`GroverResult.clear()` + +**Return type** + +`None` + +### combine + + + +`GroverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`GroverResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`GroverResult` + +### fromkeys + + + +`classmethod GroverResult.fromkeys(iterable, value=None)` + +### get + + + +`GroverResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`GroverResult.items() → a set-like object providing a view on D’s items` + +### keys + +`GroverResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`GroverResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`GroverResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`GroverResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`GroverResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`GroverResult.values() → an object providing a view on D’s values` + +## Attributes + + ### assignment @@ -38,7 +146,7 @@ return assignment `List`\[`int`] - + ### circuit @@ -48,7 +156,7 @@ return circuit `Optional`\[`QuantumCircuit`] - + ### measurement @@ -58,7 +166,7 @@ returns measurement `Optional`\[`Dict`\[`str`, `int`]] - + ### oracle\_evaluation @@ -68,7 +176,7 @@ return oracle evaluation `bool` - + ### top\_measurement @@ -77,3 +185,4 @@ return top measurement **Return type** `Optional`\[`str`] + 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 32d796338bb..104509eb4dc 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHL.md @@ -1,8 +1,16 @@ -# HHL +--- +title: HHL +description: API reference for qiskit.aqua.algorithms.HHL +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.HHL +--- +# 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)` +`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` @@ -10,7 +18,7 @@ The HHL algorithm. The HHL algorithm (after the author’s surnames Harrow-Hassidim-Lloyd) is a quantum algorithm to solve systems of linear equations $A\overrightarrow{x}=\overrightarrow{b}$. Using Quantum Phase Estimation, the linear system is transformed into diagonal form in which the matrix $A$ is easily invertible. The inversion is achieved by rotating an ancillary qubit by an angle $\arcsin{ \frac{C}{\lambda_\mathrm{i}}}$ around the y-axis where $\lambda_\mathrm{i}$ are the eigenvalues of $A$. After uncomputing the register storing the eigenvalues using the inverse QPE, one measures the ancillary qubit. A measurement of 1 indicates that the matrix inversion succeeded. This leaves the system in a state proportional to the solution vector $|x\rangle$. In many cases one is not interested in the single vector elements of $|x\rangle$ but only on certain properties. These are accessible by using problem-specific operators. Another use-case is the implementation in a larger quantum program. -When using non-hermitian matrices and matrices with dimensions other than $2^{n}$ the must be converted to an hermitian matrix and next higher dimension $2^{n}$, respectively. The *truncate\_hermitian*, *truncate\_powerdim* flags and *orig\_size* are used to indicate conversion and the returned result of the HHL algorithm for expanded matrices will be truncated. The [`matrix_resize()`](qiskit.aqua.algorithms.HHL.matrix_resize#qiskit.aqua.algorithms.HHL.matrix_resize "qiskit.aqua.algorithms.HHL.matrix_resize") method is provided for convenience to do this but any method of your choice can be used. +When using non-hermitian matrices and matrices with dimensions other than $2^{n}$ the must be converted to an hermitian matrix and next higher dimension $2^{n}$, respectively. The *truncate\_hermitian*, *truncate\_powerdim* flags and *orig\_size* are used to indicate conversion and the returned result of the HHL algorithm for expanded matrices will be truncated. The [`matrix_resize()`](qiskit.aqua.algorithms.HHL#matrix_resize "qiskit.aqua.algorithms.HHL.matrix_resize") method is provided for convenience to do this but any method of your choice can be used. To further explain *truncate\_hermitian* indicates whether or not to truncate matrix and result vector to half the dimension by simply cutting off entries with other indices after the input matrix was expanded to be hermitian following @@ -49,18 +57,133 @@ See also [https://arxiv.org/abs/0811.3171](https://arxiv.org/abs/0811.3171) ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`construct_circuit`](qiskit.aqua.algorithms.HHL.construct_circuit#qiskit.aqua.algorithms.HHL.construct_circuit "qiskit.aqua.algorithms.HHL.construct_circuit") | Construct the HHL circuit. | -| [`expand_to_hermitian`](qiskit.aqua.algorithms.HHL.expand_to_hermitian#qiskit.aqua.algorithms.HHL.expand_to_hermitian "qiskit.aqua.algorithms.HHL.expand_to_hermitian") | Expand a non-hermitian matrix A to a hermitian matrix by \[\[0, A.H], \[A, 0]] and expand vector b to \[b.conj, b]. | -| [`expand_to_powerdim`](qiskit.aqua.algorithms.HHL.expand_to_powerdim#qiskit.aqua.algorithms.HHL.expand_to_powerdim "qiskit.aqua.algorithms.HHL.expand_to_powerdim") | Expand a matrix to the next-larger 2\*\*n dimensional matrix with ones on the diagonal and zeros on the off-diagonal and expand the vector with zeros accordingly. | -| [`matrix_resize`](qiskit.aqua.algorithms.HHL.matrix_resize#qiskit.aqua.algorithms.HHL.matrix_resize "qiskit.aqua.algorithms.HHL.matrix_resize") | Resizes matrix if necessary | -| [`run`](qiskit.aqua.algorithms.HHL.run#qiskit.aqua.algorithms.HHL.run "qiskit.aqua.algorithms.HHL.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.HHL.set_backend#qiskit.aqua.algorithms.HHL.set_backend "qiskit.aqua.algorithms.HHL.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +**measurement** (`bool`) – indicate whether measurement on ancillary qubit should be performed + +**Return type** + +`QuantumCircuit` + +**Returns** + +the QuantumCircuit object for the constructed circuit + +### expand\_to\_hermitian + + + +`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]. + +**Parameters** + +* **matrix** (`ndarray`) – the input matrix +* **vector** (`ndarray`) – the input vector + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +**Returns** + +the expanded matrix, the expanded vector + +### expand\_to\_powerdim + + + +`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. + +**Parameters** + +* **matrix** (`ndarray`) – the input matrix +* **vector** (`ndarray`) – the input vector + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +**Returns** + +the expanded matrix, the expanded vector + +### matrix\_resize + + +`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 + +**Parameters** + +* **matrix** (`ndarray`) – the input matrix of linear system of equations +* **vector** (`ndarray`) – the input vector of linear system of equations + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`, `bool`, `bool`] + +**Returns** + +new matrix, vector, truncate\_powerdim, truncate\_hermitian + +**Raises** + +**ValueError** – invalid input + +### run + + + +`HHL.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`HHL.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -70,7 +193,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -80,8 +203,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 b5d0bc25d33..bacb695ea73 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.HHLResult.md @@ -1,8 +1,16 @@ -# HHLResult +--- +title: HHLResult +description: API reference for qiskit.aqua.algorithms.HHLResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.HHLResult +--- +# HHLResult + -`HHLResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ HHL Result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.HHLResult.clear#qiskit.aqua.algorithms.HHLResult.clear "qiskit.aqua.algorithms.HHLResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.HHLResult.combine#qiskit.aqua.algorithms.HHLResult.combine "qiskit.aqua.algorithms.HHLResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.HHLResult.copy#qiskit.aqua.algorithms.HHLResult.copy "qiskit.aqua.algorithms.HHLResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.HHLResult.from_dict#qiskit.aqua.algorithms.HHLResult.from_dict "qiskit.aqua.algorithms.HHLResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.HHLResult.fromkeys#qiskit.aqua.algorithms.HHLResult.fromkeys "qiskit.aqua.algorithms.HHLResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.HHLResult.get#qiskit.aqua.algorithms.HHLResult.get "qiskit.aqua.algorithms.HHLResult.get") | | -| [`items`](qiskit.aqua.algorithms.HHLResult.items#qiskit.aqua.algorithms.HHLResult.items "qiskit.aqua.algorithms.HHLResult.items") | | -| [`keys`](qiskit.aqua.algorithms.HHLResult.keys#qiskit.aqua.algorithms.HHLResult.keys "qiskit.aqua.algorithms.HHLResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.HHLResult.pop#qiskit.aqua.algorithms.HHLResult.pop "qiskit.aqua.algorithms.HHLResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.HHLResult.popitem#qiskit.aqua.algorithms.HHLResult.popitem "qiskit.aqua.algorithms.HHLResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.HHLResult.setdefault#qiskit.aqua.algorithms.HHLResult.setdefault "qiskit.aqua.algorithms.HHLResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.HHLResult.update#qiskit.aqua.algorithms.HHLResult.update "qiskit.aqua.algorithms.HHLResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.HHLResult.values#qiskit.aqua.algorithms.HHLResult.values "qiskit.aqua.algorithms.HHLResult.values") | | +### clear -## Attributes + + +`HHLResult.clear()` + +**Return type** + +`None` + +### combine + + + +`HHLResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`HHLResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`HHLResult` + +### fromkeys + + + +`classmethod HHLResult.fromkeys(iterable, value=None)` + +### get + + + +`HHLResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`HHLResult.items() → a set-like object providing a view on D’s items` + +### keys + +`HHLResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`HHLResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`HHLResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`HHLResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`HHLResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`HHLResult.values() → an object providing a view on D’s values` + +## Attributes + + ### circuit\_info @@ -38,7 +146,7 @@ return circuit info `DAGCircuit` - + ### matrix @@ -48,7 +156,7 @@ return matrix `ndarray` - + ### output @@ -58,7 +166,7 @@ return output `ndarray` - + ### probability\_result @@ -68,7 +176,7 @@ return probability result `Union`\[`ndarray`, `float`] - + ### solution @@ -78,7 +186,7 @@ return solution `ndarray` - + ### vector @@ -87,3 +195,4 @@ return vector **Return type** `ndarray` + 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 3c95ffba342..2acf9246296 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IQPE.md @@ -1,14 +1,22 @@ -# IQPE +--- +title: IQPE +description: API reference for qiskit.aqua.algorithms.IQPE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.IQPE +--- +# 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)` +`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` The Iterative Quantum Phase Estimation algorithm. -IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE#qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. +IQPE, as its name suggests, iteratively computes the phase so as to require fewer qubits. It has the same set of parameters as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE"), except for the number of ancillary qubits *num\_ancillae*, being replaced by *num\_iterations* and that an Inverse Quantum Fourier Transform (IQFT) is not used for IQPE. **Reference:** @@ -29,17 +37,109 @@ qubit benchmark, [arxiv/quant-ph/0610214](https://arxiv.org/abs/quant-ph/0610214 ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | -| [`compute_minimum_eigenvalue`](qiskit.aqua.algorithms.IQPE.compute_minimum_eigenvalue#qiskit.aqua.algorithms.IQPE.compute_minimum_eigenvalue "qiskit.aqua.algorithms.IQPE.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`construct_circuit`](qiskit.aqua.algorithms.IQPE.construct_circuit#qiskit.aqua.algorithms.IQPE.construct_circuit "qiskit.aqua.algorithms.IQPE.construct_circuit") | Construct the kth iteration Quantum Phase Estimation circuit. | -| [`run`](qiskit.aqua.algorithms.IQPE.run#qiskit.aqua.algorithms.IQPE.run "qiskit.aqua.algorithms.IQPE.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.IQPE.set_backend#qiskit.aqua.algorithms.IQPE.set_backend "qiskit.aqua.algorithms.IQPE.set_backend") | Sets backend with configuration. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.IQPE.supports_aux_operators#qiskit.aqua.algorithms.IQPE.supports_aux_operators "qiskit.aqua.algorithms.IQPE.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_minimum\_eigenvalue -## Attributes + + +`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. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### construct\_circuit + + + +`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. + +For details of parameters, please see Fig. 2 in [https://arxiv.org/pdf/quant-ph/0610214.pdf](https://arxiv.org/pdf/quant-ph/0610214.pdf). + +**Parameters** + +* **k** (`Optional`\[`int`]) – the iteration idx. +* **omega** (`float`) – the feedback angle. +* **measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** + +the quantum circuit per iteration + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### run + + + +`IQPE.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`IQPE.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### supports\_aux\_operators + + + +`classmethod IQPE.supports_aux_operators()` + +Whether computing the expectation value of auxiliary operators is supported. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -49,7 +149,7 @@ Returns aux operators `Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`]]] - + ### backend @@ -59,7 +159,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### operator @@ -69,7 +169,7 @@ Returns operator `Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`] - + ### quantum\_instance @@ -79,8 +179,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 b871ed0d979..7aaf4c14e68 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimation.md @@ -1,8 +1,16 @@ -# IterativeAmplitudeEstimation +--- +title: IterativeAmplitudeEstimation +description: API reference for qiskit.aqua.algorithms.IterativeAmplitudeEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimation +--- +# 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)` +`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` @@ -42,21 +50,117 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if the method to compute the confidence intervals is not supported +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if the method to compute the confidence intervals is not supported ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.aqua.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.aqua.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit Q^k A \|0>. | -| [`is_good_state`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation.is_good_state#qiskit.aqua.algorithms.IterativeAmplitudeEstimation.is_good_state "qiskit.aqua.algorithms.IterativeAmplitudeEstimation.is_good_state") | Determine whether a given state is a good state. | -| [`post_processing`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation.post_processing#qiskit.aqua.algorithms.IterativeAmplitudeEstimation.post_processing "qiskit.aqua.algorithms.IterativeAmplitudeEstimation.post_processing") | Post processing of the raw amplitude estimation output $0 \leq a \leq 1$. | -| [`run`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation.run#qiskit.aqua.algorithms.IterativeAmplitudeEstimation.run "qiskit.aqua.algorithms.IterativeAmplitudeEstimation.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation.set_backend#qiskit.aqua.algorithms.IterativeAmplitudeEstimation.set_backend "qiskit.aqua.algorithms.IterativeAmplitudeEstimation.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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>. + +The A operator is the unitary specifying the QAE problem and Q the associated Grover operator. + +**Parameters** + +* **k** (`int`) – The power of the Q operator. +* **measurement** (`bool`) – Boolean flag to indicate if measurements should be included in the circuits. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The circuit Q^k A |0>. + +### is\_good\_state + + + +`IterativeAmplitudeEstimation.is_good_state(measurement)` + +Determine whether a given state is a good state. + +**Parameters** + +**measurement** (`str`) – A measurement as bitstring, e.g. ‘01100’. + +**Return type** + +`bool` + +**Returns** + +True if the measurement corresponds to a good state, False otherwise. + +**Raises** + +**ValueError** – If `self.objective_qubits` is not set. + +### post\_processing + + + +`IterativeAmplitudeEstimation.post_processing(value)` + +Post processing of the raw amplitude estimation output $0 \leq a \leq 1$. + +**Parameters** + +**value** (`float`) – The estimation value $a$. + +**Return type** + +`float` + +**Returns** + +The value after post processing, usually mapping the interval $[0, 1]$ to the target interval. + +### run + + + +`IterativeAmplitudeEstimation.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`IterativeAmplitudeEstimation.set_backend(backend, **kwargs)` +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + ### a\_factory @@ -72,9 +176,9 @@ the A operator as CircuitFactory **Return type** -[CircuitFactory](qiskit.aqua.utils.CircuitFactory#qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") - +[CircuitFactory](qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") + ### backend @@ -84,7 +188,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### grover\_operator @@ -100,7 +204,7 @@ If the Grover operator is not set, we try to build it from the $\mathcal{A}$ ope The Grover operator, or None if neither the Grover operator nor the $\mathcal{A}$ operator is set. - + ### i\_objective @@ -120,7 +224,7 @@ the index of the objective qubit int - + ### objective\_qubits @@ -134,7 +238,7 @@ Get the criterion for a measurement outcome to be in a ‘good’ state. The criterion as list of qubit indices. - + ### precision @@ -148,7 +252,7 @@ Returns the target precision epsilon of the algorithm. The target precision (which is half the width of the confidence interval). - + ### q\_factory @@ -170,7 +274,7 @@ returns the current Q factory of the algorithm QFactory - + ### quantum\_instance @@ -180,13 +284,13 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### state\_preparation @@ -199,3 +303,4 @@ Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Returns** The $\mathcal{A}$ operator as QuantumCircuit. + 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 7fc70818869..46017326c36 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.md @@ -1,8 +1,16 @@ -# IterativeAmplitudeEstimationResult +--- +title: IterativeAmplitudeEstimationResult +description: API reference for qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult +--- +# IterativeAmplitudeEstimationResult + -`IterativeAmplitudeEstimationResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ IterativeAmplitudeEstimation Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.clear#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.clear "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.combine#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.combine "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.copy#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.copy "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.from_dict#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.from_dict "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.fromkeys#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.fromkeys "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.get#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.get "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.get") | | -| [`items`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.items#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.items "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.items") | | -| [`keys`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.keys#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.keys "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.pop#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.pop "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.popitem#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.popitem "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.setdefault#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.setdefault "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.update#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.update "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.values#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.values "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult.values") | | +### clear -## Attributes + + +`IterativeAmplitudeEstimationResult.clear()` + +**Return type** + +`None` + +### combine + + + +`IterativeAmplitudeEstimationResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`IterativeAmplitudeEstimationResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`IterativeAmplitudeEstimationResult` + +### fromkeys + + + +`classmethod IterativeAmplitudeEstimationResult.fromkeys(iterable, value=None)` + +### get + + + +`IterativeAmplitudeEstimationResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`IterativeAmplitudeEstimationResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`IterativeAmplitudeEstimationResult.keys() → a set-like object providing a view on D’s keys` + +### pop + +`IterativeAmplitudeEstimationResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`IterativeAmplitudeEstimationResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`IterativeAmplitudeEstimationResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`IterativeAmplitudeEstimationResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`IterativeAmplitudeEstimationResult.values() → an object providing a view on D’s values` + +## Attributes + + ### a\_estimation @@ -38,7 +146,7 @@ return a\_estimation `float` - + ### a\_intervals @@ -48,7 +156,7 @@ return a\_intervals `List`\[`List`\[`float`]] - + ### actual\_epsilon @@ -58,7 +166,7 @@ return mle `float` - + ### alpha @@ -68,7 +176,7 @@ return alpha `float` - + ### confidence\_interval @@ -78,7 +186,7 @@ return confidence\_interval `List`\[`float`] - + ### estimation @@ -88,7 +196,7 @@ return estimation `float` - + ### num\_oracle\_queries @@ -98,7 +206,7 @@ return num\_oracle\_queries `int` - + ### powers @@ -108,7 +216,7 @@ return powers `List`\[`int`] - + ### ratios @@ -118,7 +226,7 @@ return ratios `List`\[`float`] - + ### theta\_intervals @@ -128,7 +236,7 @@ return theta\_intervals `List`\[`List`\[`float`]] - + ### value\_confidence\_interval @@ -137,3 +245,4 @@ return value\_confidence\_interval **Return type** `List`\[`float`] + 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 d882fdb1c95..f9932eafc75 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.LinearsolverResult.md @@ -1,8 +1,16 @@ -# LinearsolverResult +--- +title: LinearsolverResult +description: API reference for qiskit.aqua.algorithms.LinearsolverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.LinearsolverResult +--- +# LinearsolverResult + -`LinearsolverResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ Linear solver Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.LinearsolverResult.clear#qiskit.aqua.algorithms.LinearsolverResult.clear "qiskit.aqua.algorithms.LinearsolverResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.LinearsolverResult.combine#qiskit.aqua.algorithms.LinearsolverResult.combine "qiskit.aqua.algorithms.LinearsolverResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.LinearsolverResult.copy#qiskit.aqua.algorithms.LinearsolverResult.copy "qiskit.aqua.algorithms.LinearsolverResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.LinearsolverResult.from_dict#qiskit.aqua.algorithms.LinearsolverResult.from_dict "qiskit.aqua.algorithms.LinearsolverResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.LinearsolverResult.fromkeys#qiskit.aqua.algorithms.LinearsolverResult.fromkeys "qiskit.aqua.algorithms.LinearsolverResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.LinearsolverResult.get#qiskit.aqua.algorithms.LinearsolverResult.get "qiskit.aqua.algorithms.LinearsolverResult.get") | | -| [`items`](qiskit.aqua.algorithms.LinearsolverResult.items#qiskit.aqua.algorithms.LinearsolverResult.items "qiskit.aqua.algorithms.LinearsolverResult.items") | | -| [`keys`](qiskit.aqua.algorithms.LinearsolverResult.keys#qiskit.aqua.algorithms.LinearsolverResult.keys "qiskit.aqua.algorithms.LinearsolverResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.LinearsolverResult.pop#qiskit.aqua.algorithms.LinearsolverResult.pop "qiskit.aqua.algorithms.LinearsolverResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.LinearsolverResult.popitem#qiskit.aqua.algorithms.LinearsolverResult.popitem "qiskit.aqua.algorithms.LinearsolverResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.LinearsolverResult.setdefault#qiskit.aqua.algorithms.LinearsolverResult.setdefault "qiskit.aqua.algorithms.LinearsolverResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.LinearsolverResult.update#qiskit.aqua.algorithms.LinearsolverResult.update "qiskit.aqua.algorithms.LinearsolverResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.LinearsolverResult.values#qiskit.aqua.algorithms.LinearsolverResult.values "qiskit.aqua.algorithms.LinearsolverResult.values") | | +### clear -## Attributes + + +`LinearsolverResult.clear()` + +**Return type** + +`None` + +### combine + + + +`LinearsolverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`LinearsolverResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`LinearsolverResult` + +### fromkeys + + + +`classmethod LinearsolverResult.fromkeys(iterable, value=None)` + +### get + + + +`LinearsolverResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + +`LinearsolverResult.items() → a set-like object providing a view on D’s items` +### keys + + + +`LinearsolverResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`LinearsolverResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`LinearsolverResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`LinearsolverResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`LinearsolverResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`LinearsolverResult.values() → an object providing a view on D’s values` + +## Attributes + + ### solution @@ -37,3 +145,4 @@ return solution **Return type** `ndarray` + 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 b63fcd5def3..fa5ea011b08 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.md @@ -1,8 +1,16 @@ -# MaximumLikelihoodAmplitudeEstimation +--- +title: MaximumLikelihoodAmplitudeEstimation +description: API reference for qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation +--- +# 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)` +`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` @@ -35,18 +43,138 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`confidence_interval`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.confidence_interval#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.confidence_interval "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.confidence_interval") | Compute the alpha confidence interval using the method kind. | -| [`construct_circuits`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.construct_circuits#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.construct_circuits "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.construct_circuits") | Construct the Amplitude Estimation w/o QPE quantum circuits. | -| [`is_good_state`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.is_good_state#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.is_good_state "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.is_good_state") | Determine whether a given state is a good state. | -| [`post_processing`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.post_processing#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.post_processing "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.post_processing") | Post processing of the raw amplitude estimation output $0 \leq a \leq 1$. | -| [`run`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.run#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.run "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.set_backend#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.set_backend "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation.set_backend") | Sets backend with configuration. | +### confidence\_interval -## Attributes + + +`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. + +The confidence level is (1 - alpha) and supported kinds are ‘fisher’, ‘likelihood\_ratio’ and ‘observed\_fisher’ with shorthand notations ‘fi’, ‘lr’ and ‘oi’, respectively. + +**Parameters** + +* **alpha** (`float`) – The confidence level. +* **kind** (`str`) – The method to compute the confidence interval. Defaults to ‘fisher’, which computes the theoretical Fisher information. + +**Return type** + +`List`\[`float`] + +**Returns** + +The specified confidence interval. + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If run() hasn’t been called yet. +* **NotImplementedError** – If the method kind is not supported. + +### construct\_circuits + + + +`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. + +**Parameters** + +**measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuits. + +**Return type** + +`List`\[`QuantumCircuit`] + +**Returns** + +A list with the QuantumCircuit objects for the algorithm. + +### is\_good\_state + + + +`MaximumLikelihoodAmplitudeEstimation.is_good_state(measurement)` + +Determine whether a given state is a good state. + +**Parameters** + +**measurement** (`str`) – A measurement as bitstring, e.g. ‘01100’. + +**Return type** + +`bool` + +**Returns** + +True if the measurement corresponds to a good state, False otherwise. + +**Raises** + +**ValueError** – If `self.objective_qubits` is not set. +### post\_processing + + +`MaximumLikelihoodAmplitudeEstimation.post_processing(value)` + +Post processing of the raw amplitude estimation output $0 \leq a \leq 1$. + +**Parameters** + +**value** (`float`) – The estimation value $a$. + +**Return type** + +`float` + +**Returns** + +The value after post processing, usually mapping the interval $[0, 1]$ to the target interval. + +### run + + + +`MaximumLikelihoodAmplitudeEstimation.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`MaximumLikelihoodAmplitudeEstimation.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### a\_factory @@ -62,9 +190,9 @@ the A operator as CircuitFactory **Return type** -[CircuitFactory](qiskit.aqua.utils.CircuitFactory#qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") - +[CircuitFactory](qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") + ### backend @@ -74,7 +202,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### grover\_operator @@ -90,7 +218,7 @@ If the Grover operator is not set, we try to build it from the $\mathcal{A}$ ope The Grover operator, or None if neither the Grover operator nor the $\mathcal{A}$ operator is set. - + ### i\_objective @@ -110,7 +238,7 @@ the index of the objective qubit int - + ### objective\_qubits @@ -124,7 +252,7 @@ Get the criterion for a measurement outcome to be in a ‘good’ state. The criterion as list of qubit indices. - + ### q\_factory @@ -146,7 +274,7 @@ returns the current Q factory of the algorithm QFactory - + ### quantum\_instance @@ -156,13 +284,13 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### state\_preparation @@ -175,3 +303,4 @@ Get the $\mathcal{A}$ operator encoding the amplitude $a$. **Returns** The $\mathcal{A}$ operator as QuantumCircuit. + 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 9b051f4ff7d..834bf66fa9f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.md @@ -1,8 +1,16 @@ -# MaximumLikelihoodAmplitudeEstimationResult +--- +title: MaximumLikelihoodAmplitudeEstimationResult +description: API reference for qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult +--- +# MaximumLikelihoodAmplitudeEstimationResult + -`MaximumLikelihoodAmplitudeEstimationResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ MaximumLikelihoodAmplitudeEstimation Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.clear#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.clear "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.combine#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.combine "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.copy#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.copy "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.from_dict#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.from_dict "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.fromkeys#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.fromkeys "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.get#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.get "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.get") | | -| [`items`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.items#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.items "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.items") | | -| [`keys`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.keys#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.keys "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.pop#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.pop "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.popitem#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.popitem "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.setdefault#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.setdefault "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.update#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.update "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.values#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.values "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult.values") | | +### clear -## Attributes + + +`MaximumLikelihoodAmplitudeEstimationResult.clear()` + +**Return type** + +`None` + +### combine + + + +`MaximumLikelihoodAmplitudeEstimationResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`MaximumLikelihoodAmplitudeEstimationResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`MaximumLikelihoodAmplitudeEstimationResult` + +### fromkeys + + + +`classmethod MaximumLikelihoodAmplitudeEstimationResult.fromkeys(iterable, value=None)` + +### get + + + +`MaximumLikelihoodAmplitudeEstimationResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`MaximumLikelihoodAmplitudeEstimationResult.items() → a set-like object providing a view on D’s items` + +### keys + + +`MaximumLikelihoodAmplitudeEstimationResult.keys() → a set-like object providing a view on D’s keys` +### pop + + + +`MaximumLikelihoodAmplitudeEstimationResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`MaximumLikelihoodAmplitudeEstimationResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`MaximumLikelihoodAmplitudeEstimationResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`MaximumLikelihoodAmplitudeEstimationResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`MaximumLikelihoodAmplitudeEstimationResult.values() → an object providing a view on D’s values` + +## Attributes + + ### a\_estimation @@ -38,7 +146,7 @@ return a\_estimation `float` - + ### circuit\_results @@ -48,7 +156,7 @@ return circuit results `Union`\[`List`\[`ndarray`], `List`\[`Dict`\[`str`, `int`]], `None`] - + ### confidence\_interval @@ -58,7 +166,7 @@ return confidence\_interval `List`\[`float`] - + ### estimation @@ -68,7 +176,7 @@ return estimation `float` - + ### fisher\_information @@ -78,7 +186,7 @@ return fisher\_information `float` - + ### num\_oracle\_queries @@ -88,7 +196,7 @@ return num\_oracle\_queries `int` - + ### theta @@ -97,3 +205,4 @@ returns theta **Return type** `float` + 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 03b6e1fe1d9..113932d3d9f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolver.md @@ -1,8 +1,16 @@ -# MinimumEigensolver +--- +title: MinimumEigensolver +description: API reference for qiskit.aqua.algorithms.MinimumEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.MinimumEigensolver +--- +# MinimumEigensolver + -`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") Bases: `abc.ABC` @@ -12,14 +20,48 @@ Algorithms that can compute a minimum eigenvalue for an operator may implement t ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | -| [`compute_minimum_eigenvalue`](qiskit.aqua.algorithms.MinimumEigensolver.compute_minimum_eigenvalue#qiskit.aqua.algorithms.MinimumEigensolver.compute_minimum_eigenvalue "qiskit.aqua.algorithms.MinimumEigensolver.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.MinimumEigensolver.supports_aux_operators#qiskit.aqua.algorithms.MinimumEigensolver.supports_aux_operators "qiskit.aqua.algorithms.MinimumEigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_minimum\_eigenvalue -## Attributes + + +`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. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### supports\_aux\_operators + +`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. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -29,7 +71,7 @@ Returns the auxiliary operators. `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### operator @@ -38,3 +80,4 @@ Return the operator. **Return type** `Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`] + 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 541d30e3013..e69567d581a 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.MinimumEigensolverResult.md @@ -1,8 +1,16 @@ -# MinimumEigensolverResult +--- +title: MinimumEigensolverResult +description: API reference for qiskit.aqua.algorithms.MinimumEigensolverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.MinimumEigensolverResult +--- +# MinimumEigensolverResult + -`MinimumEigensolverResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ Minimum Eigensolver Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.MinimumEigensolverResult.clear#qiskit.aqua.algorithms.MinimumEigensolverResult.clear "qiskit.aqua.algorithms.MinimumEigensolverResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.MinimumEigensolverResult.combine#qiskit.aqua.algorithms.MinimumEigensolverResult.combine "qiskit.aqua.algorithms.MinimumEigensolverResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.MinimumEigensolverResult.copy#qiskit.aqua.algorithms.MinimumEigensolverResult.copy "qiskit.aqua.algorithms.MinimumEigensolverResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.MinimumEigensolverResult.from_dict#qiskit.aqua.algorithms.MinimumEigensolverResult.from_dict "qiskit.aqua.algorithms.MinimumEigensolverResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.MinimumEigensolverResult.fromkeys#qiskit.aqua.algorithms.MinimumEigensolverResult.fromkeys "qiskit.aqua.algorithms.MinimumEigensolverResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.MinimumEigensolverResult.get#qiskit.aqua.algorithms.MinimumEigensolverResult.get "qiskit.aqua.algorithms.MinimumEigensolverResult.get") | | -| [`items`](qiskit.aqua.algorithms.MinimumEigensolverResult.items#qiskit.aqua.algorithms.MinimumEigensolverResult.items "qiskit.aqua.algorithms.MinimumEigensolverResult.items") | | -| [`keys`](qiskit.aqua.algorithms.MinimumEigensolverResult.keys#qiskit.aqua.algorithms.MinimumEigensolverResult.keys "qiskit.aqua.algorithms.MinimumEigensolverResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.MinimumEigensolverResult.pop#qiskit.aqua.algorithms.MinimumEigensolverResult.pop "qiskit.aqua.algorithms.MinimumEigensolverResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.MinimumEigensolverResult.popitem#qiskit.aqua.algorithms.MinimumEigensolverResult.popitem "qiskit.aqua.algorithms.MinimumEigensolverResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.MinimumEigensolverResult.setdefault#qiskit.aqua.algorithms.MinimumEigensolverResult.setdefault "qiskit.aqua.algorithms.MinimumEigensolverResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.MinimumEigensolverResult.update#qiskit.aqua.algorithms.MinimumEigensolverResult.update "qiskit.aqua.algorithms.MinimumEigensolverResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.MinimumEigensolverResult.values#qiskit.aqua.algorithms.MinimumEigensolverResult.values "qiskit.aqua.algorithms.MinimumEigensolverResult.values") | | +### clear -## Attributes + + +`MinimumEigensolverResult.clear()` + +**Return type** + +`None` + +### combine + + + +`MinimumEigensolverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`MinimumEigensolverResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`MinimumEigensolverResult` + +### fromkeys + + + +`classmethod MinimumEigensolverResult.fromkeys(iterable, value=None)` + +### get + + + +`MinimumEigensolverResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`MinimumEigensolverResult.items() → a set-like object providing a view on D’s items` +### keys + + +`MinimumEigensolverResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`MinimumEigensolverResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`MinimumEigensolverResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`MinimumEigensolverResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`MinimumEigensolverResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`MinimumEigensolverResult.values() → an object providing a view on D’s values` + +## Attributes + + ### aux\_operator\_eigenvalues @@ -38,7 +146,7 @@ return aux operator eigen values `Optional`\[`ndarray`] - + ### eigenstate @@ -48,7 +156,7 @@ return eigen state `Optional`\[`ndarray`] - + ### eigenvalue @@ -57,3 +165,4 @@ returns eigen value **Return type** `Optional`\[`complex`] + 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 d78d0c0d9ce..abaf7014801 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyEigensolver.md @@ -1,8 +1,16 @@ -# NumPyEigensolver +--- +title: NumPyEigensolver +description: API reference for qiskit.aqua.algorithms.NumPyEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.NumPyEigensolver +--- +# NumPyEigensolver + -`NumPyEigensolver(operator=None, k=1, aux_operators=None, filter_criterion=None)` +`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` @@ -23,15 +31,62 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_eigenvalues`](qiskit.aqua.algorithms.NumPyEigensolver.compute_eigenvalues#qiskit.aqua.algorithms.NumPyEigensolver.compute_eigenvalues "qiskit.aqua.algorithms.NumPyEigensolver.compute_eigenvalues") | Computes eigenvalues. | -| [`run`](qiskit.aqua.algorithms.NumPyEigensolver.run#qiskit.aqua.algorithms.NumPyEigensolver.run "qiskit.aqua.algorithms.NumPyEigensolver.run") | Execute the classical algorithm. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.NumPyEigensolver.supports_aux_operators#qiskit.aqua.algorithms.NumPyEigensolver.supports_aux_operators "qiskit.aqua.algorithms.NumPyEigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_eigenvalues -## Attributes + + +`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. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** +`EigensolverResult` +**Returns** + +EigensolverResult + +### run + + + +`NumPyEigensolver.run()` + +Execute the classical algorithm. + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +### supports\_aux\_operators + + + +`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. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -39,7 +94,7 @@ NumPy Eigensolver computes up to the first $k$ eigenvalues of a complex-valued s `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### filter\_criterion @@ -49,7 +104,7 @@ returns the filter criterion if set `Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] - + ### k @@ -59,7 +114,7 @@ returns k (number of eigenvalues requested) `int` - + ### operator @@ -67,8 +122,9 @@ returns k (number of eigenvalues requested) `Optional`\[`OperatorBase`] - + ### random Return a numpy random. + 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 2aaea10ac4d..869a22babd1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolver.md @@ -1,8 +1,16 @@ -# NumPyLSsolver +--- +title: NumPyLSsolver +description: API reference for qiskit.aqua.algorithms.NumPyLSsolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.NumPyLSsolver +--- +# NumPyLSsolver + -`NumPyLSsolver(matrix, vector)` +`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` @@ -10,7 +18,7 @@ The Numpy LinearSystem algorithm (classical). This linear system solver computes the eigenvalues of a complex-valued square matrix $A$ of dimension $n \times n$ and the solution to the systems of linear equations defined by $A\overrightarrow{x}=\overrightarrow{b}$ with input vector $\overrightarrow{b}$. -This is a classical counterpart to the [`HHL`](qiskit.aqua.algorithms.HHL#qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL") algorithm. +This is a classical counterpart to the [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL") algorithm. **Parameters** @@ -19,14 +27,27 @@ This is a classical counterpart to the [`HHL`](qiskit.aqua.algorithms.HHL#qiskit ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`run`](qiskit.aqua.algorithms.NumPyLSsolver.run#qiskit.aqua.algorithms.NumPyLSsolver.run "qiskit.aqua.algorithms.NumPyLSsolver.run") | Execute the classical algorithm. | +### run -## Attributes + + +`NumPyLSsolver.run()` + +Execute the classical algorithm. + +**Returns** +results of an algorithm. +**Return type** + +dict + +## Attributes + + ### random Return a numpy random. + 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 ff288ad3b99..48320e33e2d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyLSsolverResult.md @@ -1,8 +1,16 @@ -# NumPyLSsolverResult +--- +title: NumPyLSsolverResult +description: API reference for qiskit.aqua.algorithms.NumPyLSsolverResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.NumPyLSsolverResult +--- +# NumPyLSsolverResult + -`NumPyLSsolverResult(a_dict=None)` +`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` @@ -10,25 +18,125 @@ Numpy LinearSystem Result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.aqua.algorithms.NumPyLSsolverResult.clear#qiskit.aqua.algorithms.NumPyLSsolverResult.clear "qiskit.aqua.algorithms.NumPyLSsolverResult.clear") | **rtype**`None` | -| [`combine`](qiskit.aqua.algorithms.NumPyLSsolverResult.combine#qiskit.aqua.algorithms.NumPyLSsolverResult.combine "qiskit.aqua.algorithms.NumPyLSsolverResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.aqua.algorithms.NumPyLSsolverResult.copy#qiskit.aqua.algorithms.NumPyLSsolverResult.copy "qiskit.aqua.algorithms.NumPyLSsolverResult.copy") | | -| [`from_dict`](qiskit.aqua.algorithms.NumPyLSsolverResult.from_dict#qiskit.aqua.algorithms.NumPyLSsolverResult.from_dict "qiskit.aqua.algorithms.NumPyLSsolverResult.from_dict") | create new object from a dictionary | -| [`fromkeys`](qiskit.aqua.algorithms.NumPyLSsolverResult.fromkeys#qiskit.aqua.algorithms.NumPyLSsolverResult.fromkeys "qiskit.aqua.algorithms.NumPyLSsolverResult.fromkeys") | | -| [`get`](qiskit.aqua.algorithms.NumPyLSsolverResult.get#qiskit.aqua.algorithms.NumPyLSsolverResult.get "qiskit.aqua.algorithms.NumPyLSsolverResult.get") | | -| [`items`](qiskit.aqua.algorithms.NumPyLSsolverResult.items#qiskit.aqua.algorithms.NumPyLSsolverResult.items "qiskit.aqua.algorithms.NumPyLSsolverResult.items") | | -| [`keys`](qiskit.aqua.algorithms.NumPyLSsolverResult.keys#qiskit.aqua.algorithms.NumPyLSsolverResult.keys "qiskit.aqua.algorithms.NumPyLSsolverResult.keys") | | -| [`pop`](qiskit.aqua.algorithms.NumPyLSsolverResult.pop#qiskit.aqua.algorithms.NumPyLSsolverResult.pop "qiskit.aqua.algorithms.NumPyLSsolverResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.aqua.algorithms.NumPyLSsolverResult.popitem#qiskit.aqua.algorithms.NumPyLSsolverResult.popitem "qiskit.aqua.algorithms.NumPyLSsolverResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.aqua.algorithms.NumPyLSsolverResult.setdefault#qiskit.aqua.algorithms.NumPyLSsolverResult.setdefault "qiskit.aqua.algorithms.NumPyLSsolverResult.setdefault") | | -| [`update`](qiskit.aqua.algorithms.NumPyLSsolverResult.update#qiskit.aqua.algorithms.NumPyLSsolverResult.update "qiskit.aqua.algorithms.NumPyLSsolverResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.aqua.algorithms.NumPyLSsolverResult.values#qiskit.aqua.algorithms.NumPyLSsolverResult.values "qiskit.aqua.algorithms.NumPyLSsolverResult.values") | | +### clear -## Attributes + + +`NumPyLSsolverResult.clear()` + +**Return type** + +`None` + +### combine + + + +`NumPyLSsolverResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`NumPyLSsolverResult.copy()` + +### from\_dict + + + +`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 + +**Return type** + +`NumPyLSsolverResult` + +### fromkeys + + + +`classmethod NumPyLSsolverResult.fromkeys(iterable, value=None)` + +### get + + + +`NumPyLSsolverResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + +`NumPyLSsolverResult.items() → a set-like object providing a view on D’s items` +### keys + + + +`NumPyLSsolverResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`NumPyLSsolverResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`NumPyLSsolverResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`NumPyLSsolverResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`NumPyLSsolverResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`NumPyLSsolverResult.values() → an object providing a view on D’s values` + +## Attributes + + ### eigvals @@ -38,7 +146,7 @@ return eigvals `ndarray` - + ### solution @@ -47,3 +155,4 @@ return solution **Return type** `ndarray` + 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 2cabab6aefa..7e31abd12a8 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.NumPyMinimumEigensolver.md @@ -1,8 +1,16 @@ -# NumPyMinimumEigensolver +--- +title: NumPyMinimumEigensolver +description: API reference for qiskit.aqua.algorithms.NumPyMinimumEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.NumPyMinimumEigensolver +--- +# NumPyMinimumEigensolver + -`NumPyMinimumEigensolver(operator=None, aux_operators=None, filter_criterion=None)` +`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` @@ -16,15 +24,64 @@ The Numpy Minimum Eigensolver algorithm. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_minimum_eigenvalue`](qiskit.aqua.algorithms.NumPyMinimumEigensolver.compute_minimum_eigenvalue#qiskit.aqua.algorithms.NumPyMinimumEigensolver.compute_minimum_eigenvalue "qiskit.aqua.algorithms.NumPyMinimumEigensolver.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`run`](qiskit.aqua.algorithms.NumPyMinimumEigensolver.run#qiskit.aqua.algorithms.NumPyMinimumEigensolver.run "qiskit.aqua.algorithms.NumPyMinimumEigensolver.run") | Execute the classical algorithm. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.NumPyMinimumEigensolver.supports_aux_operators#qiskit.aqua.algorithms.NumPyMinimumEigensolver.supports_aux_operators "qiskit.aqua.algorithms.NumPyMinimumEigensolver.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_minimum\_eigenvalue -## Attributes + + +`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. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** +`MinimumEigensolverResult` +**Returns** + +MinimumEigensolverResult + +### run + + + +`NumPyMinimumEigensolver.run()` + +Execute the classical algorithm. + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +### supports\_aux\_operators + + + +`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. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -32,7 +89,7 @@ The Numpy Minimum Eigensolver algorithm. `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### filter\_criterion @@ -42,7 +99,7 @@ returns the filter criterion if set `Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] - + ### operator @@ -50,8 +107,9 @@ returns the filter criterion if set `Optional`\[`OperatorBase`] - + ### random Return a numpy random. + 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 efd49e82b14..c76832ae833 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QAOA.md @@ -1,14 +1,22 @@ -# QAOA +--- +title: QAOA +description: API reference for qiskit.aqua.algorithms.QAOA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.QAOA +--- +# 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)` +`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` The Quantum Approximate Optimization Algorithm. -[QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. +[QAOA](https://arxiv.org/abs/1411.4028) is a well-known algorithm for finding approximate solutions to combinatorial-optimization problems. The QAOA implementation in Aqua directly extends [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") and inherits VQE’s general hybrid optimization structure. However, unlike VQE, which can be configured with arbitrary variational forms, QAOA uses its own fine-tuned variational form, which comprises $p$ parameterized global $x$ rotations and $p$ different parameterizations of the problem hamiltonian. QAOA is thus principally configured by the single integer parameter, *p*, which dictates the depth of the variational form, and thus affects the approximation quality. An optional array of $2p$ parameter values, as the *initial\_point*, may be provided as the starting **beta** and **gamma** parameters (as identically named in the original [QAOA paper](https://arxiv.org/abs/1411.4028)) for the QAOA variational form. @@ -25,7 +33,7 @@ An initial state from Aqua’s [`initial_states`](qiskit.aqua.components.initial * **mixer** (`Union`\[`QuantumCircuit`, `OperatorBase`, `LegacyBaseOperator`, `None`]) – the mixer Hamiltonian to evolve with or a custom quantum circuit. Allows support of optimizations in constrained subspaces as per [https://arxiv.org/abs/1709.03489](https://arxiv.org/abs/1709.03489) as well as warm-starting the optimization as introduced in [http://arxiv.org/abs/2009.10095](http://arxiv.org/abs/2009.10095). * **initial\_point** (`Optional`\[`ndarray`]) – An optional initial point (i.e. initial parameter values) for the optimizer. If `None` then it will simply compute a random one. * **gradient** (`Union`\[`GradientBase`, `Callable`\[\[`Union`\[`ndarray`, `List`]], `List`], `None`]) – An optional gradient operator respectively a gradient function used for optimization. -* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When None (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory#qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to True (defaults to False). +* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When None (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to True (defaults to False). * **include\_custom** (`bool`) – When expectation parameter here is None setting this to True will allow the factory to include the custom Aer pauli expectation. * **max\_evals\_grouped** (`int`) – Max number of evaluations performed simultaneously. Signals the given optimizer that more than one set of parameters can be supplied so that potentially the expectation values can be computed in parallel. Typically this is possible when a finite difference gradient is used by the optimizer such that multiple points to compute the gradient can be passed and if computed in parallel improve overall execution time. Ignored if a gradient operator or function is given. * **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. @@ -34,26 +42,233 @@ An initial state from Aqua’s [`initial_states`](qiskit.aqua.components.initial ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| [`cleanup_parameterized_circuits`](qiskit.aqua.algorithms.QAOA.cleanup_parameterized_circuits#qiskit.aqua.algorithms.QAOA.cleanup_parameterized_circuits "qiskit.aqua.algorithms.QAOA.cleanup_parameterized_circuits") | set parameterized circuits to None | -| [`compute_minimum_eigenvalue`](qiskit.aqua.algorithms.QAOA.compute_minimum_eigenvalue#qiskit.aqua.algorithms.QAOA.compute_minimum_eigenvalue "qiskit.aqua.algorithms.QAOA.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`construct_circuit`](qiskit.aqua.algorithms.QAOA.construct_circuit#qiskit.aqua.algorithms.QAOA.construct_circuit "qiskit.aqua.algorithms.QAOA.construct_circuit") | Return the circuits used to compute the expectation value. | -| [`construct_expectation`](qiskit.aqua.algorithms.QAOA.construct_expectation#qiskit.aqua.algorithms.QAOA.construct_expectation "qiskit.aqua.algorithms.QAOA.construct_expectation") | Generate the ansatz circuit and expectation value measurement, and return their runnable composition. | -| [`find_minimum`](qiskit.aqua.algorithms.QAOA.find_minimum#qiskit.aqua.algorithms.QAOA.find_minimum "qiskit.aqua.algorithms.QAOA.find_minimum") | Optimize to find the minimum cost value. | -| [`get_optimal_circuit`](qiskit.aqua.algorithms.QAOA.get_optimal_circuit#qiskit.aqua.algorithms.QAOA.get_optimal_circuit "qiskit.aqua.algorithms.QAOA.get_optimal_circuit") | Get the circuit with the optimal parameters. | -| [`get_optimal_cost`](qiskit.aqua.algorithms.QAOA.get_optimal_cost#qiskit.aqua.algorithms.QAOA.get_optimal_cost "qiskit.aqua.algorithms.QAOA.get_optimal_cost") | Get the minimal cost or energy found by the VQE. | -| [`get_optimal_vector`](qiskit.aqua.algorithms.QAOA.get_optimal_vector#qiskit.aqua.algorithms.QAOA.get_optimal_vector "qiskit.aqua.algorithms.QAOA.get_optimal_vector") | Get the simulation outcome of the optimal circuit. | -| [`get_prob_vector_for_params`](qiskit.aqua.algorithms.QAOA.get_prob_vector_for_params#qiskit.aqua.algorithms.QAOA.get_prob_vector_for_params "qiskit.aqua.algorithms.QAOA.get_prob_vector_for_params") | Helper function to get probability vectors for a set of params | -| [`get_probabilities_for_counts`](qiskit.aqua.algorithms.QAOA.get_probabilities_for_counts#qiskit.aqua.algorithms.QAOA.get_probabilities_for_counts "qiskit.aqua.algorithms.QAOA.get_probabilities_for_counts") | get probabilities for counts | -| [`print_settings`](qiskit.aqua.algorithms.QAOA.print_settings#qiskit.aqua.algorithms.QAOA.print_settings "qiskit.aqua.algorithms.QAOA.print_settings") | Preparing the setting of VQE into a string. | -| [`run`](qiskit.aqua.algorithms.QAOA.run#qiskit.aqua.algorithms.QAOA.run "qiskit.aqua.algorithms.QAOA.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.QAOA.set_backend#qiskit.aqua.algorithms.QAOA.set_backend "qiskit.aqua.algorithms.QAOA.set_backend") | Sets backend with configuration. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.QAOA.supports_aux_operators#qiskit.aqua.algorithms.QAOA.supports_aux_operators "qiskit.aqua.algorithms.QAOA.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### cleanup\_parameterized\_circuits -## Attributes + + +`QAOA.cleanup_parameterized_circuits()` + +set parameterized circuits to None + +### compute\_minimum\_eigenvalue + + + +`QAOA.compute_minimum_eigenvalue(operator=None, aux_operators=None)` + +Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### construct\_circuit + + + +`QAOA.construct_circuit(parameter)` + +Return the circuits used to compute the expectation value. + +**Parameters** + +**parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. + +**Return type** + +`List`\[`QuantumCircuit`] + +**Returns** + +A list of the circuits used to compute the expectation value. + +### construct\_expectation + + + +`QAOA.construct_expectation(parameter)` + +Generate the ansatz circuit and expectation value measurement, and return their runnable composition. + +**Parameters** + +**parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. + +**Return type** + +`OperatorBase` + +**Returns** + +The Operator equalling the measurement of the ansatz `StateFn` by the Observable’s expectation `StateFn`. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If no operator has been provided. + +### find\_minimum + + + +`QAOA.find_minimum(initial_point=None, var_form=None, cost_fn=None, optimizer=None, gradient_fn=None)` + +Optimize to find the minimum cost value. + +**Parameters** + +* **initial\_point** (`Optional`\[`ndarray`]) – If not None will be used instead of any initial point supplied via constructor. If None and None was supplied to constructor then a random point will be used if the optimizer requires an initial point. +* **var\_form** (`Union`\[`QuantumCircuit`, `VariationalForm`, `None`]) – If not None will be used instead of any variational form supplied via constructor. +* **cost\_fn** (`Optional`\[`Callable`]) – If not None will be used instead of any cost\_fn supplied via constructor. +* **optimizer** (`Optional`\[`Optimizer`]) – If not None will be used instead of any optimizer supplied via constructor. +* **gradient\_fn** (`Optional`\[`Callable`]) – Optional gradient function for optimizer + +**Returns** + +Optimized variational parameters, and corresponding minimum cost value. + +**Return type** + +dict + +**Raises** + +**ValueError** – invalid input + +### get\_optimal\_circuit + + + +`QAOA.get_optimal_circuit()` + +Get the circuit with the optimal parameters. + +**Return type** + +`QuantumCircuit` + +### get\_optimal\_cost + + + +`QAOA.get_optimal_cost()` + +Get the minimal cost or energy found by the VQE. + +**Return type** +`float` +### get\_optimal\_vector + + + +`QAOA.get_optimal_vector()` + +Get the simulation outcome of the optimal circuit. + +**Return type** + +`Union`\[`List`\[`float`], `Dict`\[`str`, `int`]] + +### get\_prob\_vector\_for\_params + + + +`QAOA.get_prob_vector_for_params(construct_circuit_fn, params_s, quantum_instance, construct_circuit_args=None)` + +Helper function to get probability vectors for a set of params + +### get\_probabilities\_for\_counts + + + +`QAOA.get_probabilities_for_counts(counts)` + +get probabilities for counts + +### print\_settings + + + +`QAOA.print_settings()` + +Preparing the setting of VQE into a string. + +**Returns** + +the formatted setting of VQE + +**Return type** + +str + +### run + + + +`QAOA.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`QAOA.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### supports\_aux\_operators + + + +`classmethod QAOA.supports_aux_operators()` + +Whether computing the expectation value of auxiliary operators is supported. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -63,7 +278,7 @@ Returns aux operators `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### backend @@ -73,7 +288,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### expectation @@ -83,7 +298,7 @@ The expectation value algorithm used to construct the expectation measurement fr `ExpectationBase` - + ### initial\_point @@ -93,7 +308,7 @@ Returns initial point `Optional`\[`ndarray`] - + ### initial\_state @@ -103,7 +318,7 @@ Returns: Returns the initial state. `Union`\[`QuantumCircuit`, `InitialState`, `None`] - + ### mixer @@ -113,7 +328,7 @@ Returns: Returns the mixer. `Union`\[`QuantumCircuit`, `OperatorBase`, `LegacyBaseOperator`] - + ### operator @@ -123,7 +338,7 @@ Returns operator `Optional`\[`OperatorBase`] - + ### optimal\_params @@ -133,7 +348,7 @@ The optimal parameters for the variational form. `List`\[`float`] - + ### optimizer @@ -143,7 +358,7 @@ Returns optimizer `Optional`\[`Optimizer`] - + ### quantum\_instance @@ -153,19 +368,19 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### setting Prepare the setting of VQE as a string. - + ### var\_form @@ -174,3 +389,4 @@ Returns variational form **Return type** `Union`\[`QuantumCircuit`, `VariationalForm`, `None`] + 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 44f3389a345..cba3dfb07e5 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QGAN.md @@ -1,8 +1,16 @@ -# QGAN +--- +title: QGAN +description: API reference for qiskit.aqua.algorithms.QGAN +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.QGAN +--- +# 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)` +`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` @@ -10,7 +18,7 @@ The Quantum Generative Adversarial Network algorithm. The qGAN \[1] is a hybrid quantum-classical algorithm used for generative modeling tasks. -This adaptive algorithm uses the interplay of a generative [`GenerativeNetwork`](qiskit.aqua.components.neural_networks.GenerativeNetwork#qiskit.aqua.components.neural_networks.GenerativeNetwork "qiskit.aqua.components.neural_networks.GenerativeNetwork") and a discriminative [`DiscriminativeNetwork`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork#qiskit.aqua.components.neural_networks.DiscriminativeNetwork "qiskit.aqua.components.neural_networks.DiscriminativeNetwork") network to learn the probability distribution underlying given training data. +This adaptive algorithm uses the interplay of a generative [`GenerativeNetwork`](qiskit.aqua.components.neural_networks.GenerativeNetwork "qiskit.aqua.components.neural_networks.GenerativeNetwork") and a discriminative [`DiscriminativeNetwork`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork "qiskit.aqua.components.neural_networks.DiscriminativeNetwork") network to learn the probability distribution underlying given training data. These networks are trained in alternating optimization steps, where the discriminator tries to differentiate between training data samples and data samples from the generator and the generator aims at generating samples which the discriminator classifies as training data samples. Eventually, the quantum generator learns the training data’s underlying probability distribution. The trained quantum generator loads a quantum state which is a model of the target distribution. @@ -36,22 +44,105 @@ These networks are trained in alternating optimization steps, where the discrimi **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ | -| [`get_rel_entr`](qiskit.aqua.algorithms.QGAN.get_rel_entr#qiskit.aqua.algorithms.QGAN.get_rel_entr "qiskit.aqua.algorithms.QGAN.get_rel_entr") | Get relative entropy between target and trained distribution | -| [`run`](qiskit.aqua.algorithms.QGAN.run#qiskit.aqua.algorithms.QGAN.run "qiskit.aqua.algorithms.QGAN.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.QGAN.set_backend#qiskit.aqua.algorithms.QGAN.set_backend "qiskit.aqua.algorithms.QGAN.set_backend") | Sets backend with configuration. | -| [`set_discriminator`](qiskit.aqua.algorithms.QGAN.set_discriminator#qiskit.aqua.algorithms.QGAN.set_discriminator "qiskit.aqua.algorithms.QGAN.set_discriminator") | Initialize discriminator. | -| [`set_generator`](qiskit.aqua.algorithms.QGAN.set_generator#qiskit.aqua.algorithms.QGAN.set_generator "qiskit.aqua.algorithms.QGAN.set_generator") | Initialize generator. | -| [`train`](qiskit.aqua.algorithms.QGAN.train#qiskit.aqua.algorithms.QGAN.train "qiskit.aqua.algorithms.QGAN.train") | Train the qGAN | +### get\_rel\_entr -## Attributes + + +`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 + +**Return type** + +`float` + +### run + +`QGAN.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`QGAN.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### set\_discriminator + + + +`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. + +**Parameters** + +**discriminator** (*Discriminator*) – discriminator + +### set\_generator + + + +`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. + +**Parameters** + +* **generator\_circuit** (`Union`\[`UnivariateVariationalDistribution`, `MultivariateVariationalDistribution`, `QuantumCircuit`, `None`]) – parameterized quantum circuit which sets the structure of the quantum generator +* **generator\_init\_params** (`Optional`\[`ndarray`]) – initial parameters for the generator circuit +* **generator\_optimizer** (`Optional`\[`Optimizer`]) – optimizer to be used for the training of the generator +* **generator\_gradient** (`Union`\[`Callable`, `Gradient`, `None`]) – A Gradient object, or a function returning partial derivatives of the loss function w\.r.t. the generator variational params. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input + +### train + + + +`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 + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Batch size bigger than the number of items in the truncated data set + +## Attributes + + ### backend @@ -61,7 +152,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### d\_loss @@ -71,13 +162,13 @@ Returns discriminator loss `List`\[`float`] - + ### discriminator Returns discriminator - + ### g\_loss @@ -87,13 +178,13 @@ Returns generator loss `List`\[`float`] - + ### generator Returns generator - + ### quantum\_instance @@ -103,13 +194,13 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### rel\_entr @@ -119,14 +210,15 @@ Returns relative entropy between target and trained distribution `List`\[`float`] - + ### seed Returns random seed - + ### tol\_rel\_ent Returns tolerance for relative entropy + 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 b1feeb9edb9..7cd80d2324f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QPE.md @@ -1,8 +1,16 @@ -# QPE +--- +title: QPE +description: API reference for qiskit.aqua.algorithms.QPE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.QPE +--- +# 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)` +`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` @@ -24,17 +32,105 @@ QPE (also sometimes abbreviated as PEA, for Phase Estimation Algorithm), has two ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_minimum_eigenvalue`](qiskit.aqua.algorithms.QPE.compute_minimum_eigenvalue#qiskit.aqua.algorithms.QPE.compute_minimum_eigenvalue "qiskit.aqua.algorithms.QPE.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`construct_circuit`](qiskit.aqua.algorithms.QPE.construct_circuit#qiskit.aqua.algorithms.QPE.construct_circuit "qiskit.aqua.algorithms.QPE.construct_circuit") | Construct circuit. | -| [`run`](qiskit.aqua.algorithms.QPE.run#qiskit.aqua.algorithms.QPE.run "qiskit.aqua.algorithms.QPE.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.QPE.set_backend#qiskit.aqua.algorithms.QPE.set_backend "qiskit.aqua.algorithms.QPE.set_backend") | Sets backend with configuration. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.QPE.supports_aux_operators#qiskit.aqua.algorithms.QPE.supports_aux_operators "qiskit.aqua.algorithms.QPE.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_minimum\_eigenvalue -## Attributes + + +`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. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### construct\_circuit + + + +`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. + +**Parameters** + +**measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** + +quantum circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### run + + + +`QPE.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`QPE.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### supports\_aux\_operators + + + +`classmethod QPE.supports_aux_operators()` + +Whether computing the expectation value of auxiliary operators is supported. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -44,7 +140,7 @@ Returns aux operators `Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`]]] - + ### backend @@ -54,7 +150,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### operator @@ -64,7 +160,7 @@ Returns operator `Optional`\[`LegacyBaseOperator`] - + ### quantum\_instance @@ -74,8 +170,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 8d2058a1034..ae23f28404b 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QSVM.md @@ -1,8 +1,16 @@ -# QSVM +--- +title: QSVM +description: API reference for qiskit.aqua.algorithms.QSVM +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.QSVM +--- +# QSVM + -`QSVM(feature_map, training_dataset=None, test_dataset=None, datapoints=None, multiclass_extension=None, lambda2=0.001, quantum_instance=None)` +`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` @@ -28,35 +36,267 @@ See also [https://arxiv.org/abs/1804.11326](https://arxiv.org/abs/1804.11326) **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Multiclass extension not supplied when number of classes > 2 +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Multiclass extension not supplied when number of classes > 2 ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.algorithms.QSVM.construct_circuit#qiskit.aqua.algorithms.QSVM.construct_circuit "qiskit.aqua.algorithms.QSVM.construct_circuit") | Generate inner product of x1 and x2 with the given feature map. | -| [`construct_kernel_matrix`](qiskit.aqua.algorithms.QSVM.construct_kernel_matrix#qiskit.aqua.algorithms.QSVM.construct_kernel_matrix "qiskit.aqua.algorithms.QSVM.construct_kernel_matrix") | Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. | -| [`get_kernel_matrix`](qiskit.aqua.algorithms.QSVM.get_kernel_matrix#qiskit.aqua.algorithms.QSVM.get_kernel_matrix "qiskit.aqua.algorithms.QSVM.get_kernel_matrix") | Construct kernel matrix, if x2\_vec is None, self-innerproduct is conducted. | -| [`load_model`](qiskit.aqua.algorithms.QSVM.load_model#qiskit.aqua.algorithms.QSVM.load_model "qiskit.aqua.algorithms.QSVM.load_model") | Load a model from a file path. | -| [`predict`](qiskit.aqua.algorithms.QSVM.predict#qiskit.aqua.algorithms.QSVM.predict "qiskit.aqua.algorithms.QSVM.predict") | Predict using the svm. | -| [`run`](qiskit.aqua.algorithms.QSVM.run#qiskit.aqua.algorithms.QSVM.run "qiskit.aqua.algorithms.QSVM.run") | Execute the algorithm with selected backend. | -| [`save_model`](qiskit.aqua.algorithms.QSVM.save_model#qiskit.aqua.algorithms.QSVM.save_model "qiskit.aqua.algorithms.QSVM.save_model") | Save the model to a file path. | -| [`set_backend`](qiskit.aqua.algorithms.QSVM.set_backend#qiskit.aqua.algorithms.QSVM.set_backend "qiskit.aqua.algorithms.QSVM.set_backend") | Sets backend with configuration. | -| [`setup_datapoint`](qiskit.aqua.algorithms.QSVM.setup_datapoint#qiskit.aqua.algorithms.QSVM.setup_datapoint "qiskit.aqua.algorithms.QSVM.setup_datapoint") | Setup data points, if the data were there, they would be overwritten. | -| [`setup_test_data`](qiskit.aqua.algorithms.QSVM.setup_test_data#qiskit.aqua.algorithms.QSVM.setup_test_data "qiskit.aqua.algorithms.QSVM.setup_test_data") | Setup test data, if the data were there, they would be overwritten. | -| [`setup_training_data`](qiskit.aqua.algorithms.QSVM.setup_training_data#qiskit.aqua.algorithms.QSVM.setup_training_data "qiskit.aqua.algorithms.QSVM.setup_training_data") | Setup training data, if the data were there, they would be overwritten. | -| [`test`](qiskit.aqua.algorithms.QSVM.test#qiskit.aqua.algorithms.QSVM.test "qiskit.aqua.algorithms.QSVM.test") | Test the svm. | -| [`train`](qiskit.aqua.algorithms.QSVM.train#qiskit.aqua.algorithms.QSVM.train "qiskit.aqua.algorithms.QSVM.train") | Train the svm. | +### construct\_circuit -## Attributes + + +`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. + +The dimension of x1 and x2 must be the same. + +**Parameters** + +* **x1** (*numpy.ndarray*) – data points, 1-D array, dimension is D +* **x2** (*numpy.ndarray*) – data points, 1-D array, dimension is D +* **measurement** (*bool*) – add measurement gates at the end + +**Returns** + +constructed circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### construct\_kernel\_matrix + + + +`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. + +#### Notes + +When using statevector\_simulator, we only build the circuits for Psi(x1)|0> rather than Psi(x2)^dagger Psi(x1)|0>, and then we perform the inner product classically. That is, for statevector\_simulator, the total number of circuits will be O(N) rather than O(N^2) for qasm\_simulator. + +**Parameters** + +* **x1\_vec** (*numpy.ndarray*) – data points, 2-D array, N1xD, where N1 is the number of data, D is the feature dimension +* **x2\_vec** (*numpy.ndarray*) – data points, 2-D array, N2xD, where N2 is the number of data, D is the feature dimension +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all settings + +**Returns** + +2-D matrix, N1xN2 + +**Return type** + +numpy.ndarray + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Quantum instance is not present. + +### get\_kernel\_matrix + + + +`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. + +#### Notes + +When using statevector\_simulator, we only build the circuits for Psi(x1)|0> rather than Psi(x2)^dagger Psi(x1)|0>, and then we perform the inner product classically. That is, for statevector\_simulator, the total number of circuits will be O(N) rather than O(N^2) for qasm\_simulator. + +**Parameters** + +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all settings +* **feature\_map** ([*FeatureMap*](qiskit.aqua.components.feature_maps.FeatureMap "qiskit.aqua.components.feature_maps.FeatureMap")) – a feature map that maps data to feature space +* **x1\_vec** (*numpy.ndarray*) – data points, 2-D array, N1xD, where N1 is the number of data, D is the feature dimension +* **x2\_vec** (*numpy.ndarray*) – data points, 2-D array, N2xD, where N2 is the number of data, D is the feature dimension +* **enforce\_psd** (*bool*) – enforces that the kernel matrix is positive semi-definite by setting negative eigenvalues to zero. This is only applied in the symmetric case, i.e., if x2\_vec == None. + +**Returns** + +2-D matrix, N1xN2 + +**Return type** + +numpy.ndarray + +### load\_model + + + +`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. + +**Parameters** + +**file\_path** (*str*) – the path of the saved model. + +### predict + + + +`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. + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, where N is the number of data, D is the feature dimension. +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all setting + +**Returns** + +predicted labels, Nx1 array + +**Return type** + +numpy.ndarray + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Quantum instance is not present. + +### run + + + +`QSVM.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs +**Returns** +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### save\_model + + + +`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. + +**Parameters** + +**file\_path** (*str*) – a path to save the model. + +### set\_backend + + + +`QSVM.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### setup\_datapoint + + + +`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. + +**Parameters** + +**datapoints** (*numpy.ndarray*) – prediction dataset. + +### setup\_test\_data + + + +`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. + +**Parameters** + +**test\_dataset** (*dict*) – test dataset. + +### setup\_training\_data + + + +`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. + +**Parameters** + +**training\_dataset** (*dict*) – training dataset. + +### test + + + +`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. + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, where N is the number of data, D is the feature dimension. +* **labels** (*numpy.ndarray*) – Nx1 array, where N is the number of data +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all setting + +**Returns** + +accuracy + +**Return type** + +float + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Quantum instance is not present. + +### train + + + +`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. + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, where N is the number of data, D is the feature dimension. +* **labels** (*numpy.ndarray*) – Nx1 array, where N is the number of data +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all setting + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Quantum instance is not present. + +## Attributes + + ### BATCH\_SIZE `= 1000` - + ### backend @@ -66,7 +306,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -76,14 +316,15 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### ret returns result + 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 08937417f39..6469b629d9f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.QuantumAlgorithm.md @@ -1,8 +1,16 @@ -# QuantumAlgorithm +--- +title: QuantumAlgorithm +description: API reference for qiskit.aqua.algorithms.QuantumAlgorithm +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.QuantumAlgorithm +--- +# QuantumAlgorithm + -`QuantumAlgorithm(quantum_instance)` +`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` @@ -12,14 +20,46 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- | -| [`run`](qiskit.aqua.algorithms.QuantumAlgorithm.run#qiskit.aqua.algorithms.QuantumAlgorithm.run "qiskit.aqua.algorithms.QuantumAlgorithm.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.QuantumAlgorithm.set_backend#qiskit.aqua.algorithms.QuantumAlgorithm.set_backend "qiskit.aqua.algorithms.QuantumAlgorithm.set_backend") | Sets backend with configuration. | +### run -## Attributes + + +`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. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided +### set\_backend + + + +`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. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -29,7 +69,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -39,8 +79,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 ec63b018fc7..906bf8324e1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Shor.md @@ -1,8 +1,16 @@ -# Shor +--- +title: Shor +description: API reference for qiskit.aqua.algorithms.Shor +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.Shor +--- +# Shor + -`Shor(N=15, a=2, quantum_instance=None)` +`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` @@ -32,16 +40,78 @@ See also [https://arxiv.org/abs/quant-ph/0205095](https://arxiv.org/abs/quant-ph ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| [`construct_circuit`](qiskit.aqua.algorithms.Shor.construct_circuit#qiskit.aqua.algorithms.Shor.construct_circuit "qiskit.aqua.algorithms.Shor.construct_circuit") | Construct circuit. | -| [`modinv`](qiskit.aqua.algorithms.Shor.modinv#qiskit.aqua.algorithms.Shor.modinv "qiskit.aqua.algorithms.Shor.modinv") | Returns the modular multiplicative inverse of a with respect to the modulus m. | -| [`run`](qiskit.aqua.algorithms.Shor.run#qiskit.aqua.algorithms.Shor.run "qiskit.aqua.algorithms.Shor.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.Shor.set_backend#qiskit.aqua.algorithms.Shor.set_backend "qiskit.aqua.algorithms.Shor.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +**measurement** (`bool`) – Boolean flag to indicate if measurement should be included in the circuit. + +**Return type** + +`QuantumCircuit` + +**Returns** +Quantum circuit. +### modinv + + + +`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. + +**Return type** + +`int` + +### run + + + +`Shor.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`Shor.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -51,7 +121,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -61,8 +131,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 fdf2dec5359..468f6eedbaf 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.Simon.md @@ -1,8 +1,16 @@ -# Simon +--- +title: Simon +description: API reference for qiskit.aqua.algorithms.Simon +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.Simon +--- +# Simon + -`Simon(oracle, quantum_instance=None)` +`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` @@ -10,7 +18,7 @@ The Simon algorithm. The Simon algorithm finds a hidden integer $s \in \{0,1\}^n$ from an oracle $f_s$ that satisfies $f_s(x) = f_s(y)$ if and only if $y=x \oplus s$ for all $x \in \{0,1\}^n$. Thus, if $s = 0\ldots 0$, i.e., the all-zero bitstring, then $f_s$ is a 1-to-1 (or, permutation) function. Otherwise, if $s \neq 0\ldots 0$, then $f_s$ is a 2-to-1 function. -Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle#qiskit.aqua.components.oracles.TruthTableOracle "qiskit.aqua.components.oracles.TruthTableOracle") may be the easiest to use to create one that can be used with the Simon algorithm. +Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle "qiskit.aqua.components.oracles.TruthTableOracle") may be the easiest to use to create one that can be used with the Simon algorithm. **Parameters** @@ -19,15 +27,66 @@ Note: the [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle#q ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.algorithms.Simon.construct_circuit#qiskit.aqua.algorithms.Simon.construct_circuit "qiskit.aqua.algorithms.Simon.construct_circuit") | Construct the quantum circuit | -| [`run`](qiskit.aqua.algorithms.Simon.run#qiskit.aqua.algorithms.Simon.run "qiskit.aqua.algorithms.Simon.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.Simon.set_backend#qiskit.aqua.algorithms.Simon.set_backend "qiskit.aqua.algorithms.Simon.set_backend") | Sets backend with configuration. | +### construct\_circuit -## Attributes + + +`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 + +**Parameters** + +**measurement** (*bool*) – Boolean flag to indicate if measurement should be included in the circuit. + +**Returns** + +the QuantumCircuit object for the constructed circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### run + + + +`Simon.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`Simon.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -37,7 +96,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### quantum\_instance @@ -47,8 +106,9 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. + 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 8b879b1fbed..114b49cd1b4 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.SklearnSVM.md @@ -1,14 +1,22 @@ -# SklearnSVM +--- +title: SklearnSVM +description: API reference for qiskit.aqua.algorithms.SklearnSVM +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.SklearnSVM +--- +# SklearnSVM + -`SklearnSVM(training_dataset, test_dataset=None, datapoints=None, gamma=None, multiclass_extension=None)` +`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` The Sklearn SVM algorithm (classical). -This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM#qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). +This scikit-learn based SVM algorithm uses a classical approach to experiment with feature map classification problems. See also the quantum classifier [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"). Internally, this algorithm will run the binary classification or multiclass classification based on how many classes the data has. If the data has more than 2 classes then a *multiclass\_extension* is required to be supplied. Aqua provides several [`multiclass_extensions`](qiskit.aqua.components.multiclass_extensions#module-qiskit.aqua.components.multiclass_extensions "qiskit.aqua.components.multiclass_extensions"). @@ -22,41 +30,127 @@ Internally, this algorithm will run the binary classification or multiclass clas **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Multiclass extension not supplied when number of classes > 2 +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Multiclass extension not supplied when number of classes > 2 ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`load_model`](qiskit.aqua.algorithms.SklearnSVM.load_model#qiskit.aqua.algorithms.SklearnSVM.load_model "qiskit.aqua.algorithms.SklearnSVM.load_model") | Load a model from a file path. | -| [`predict`](qiskit.aqua.algorithms.SklearnSVM.predict#qiskit.aqua.algorithms.SklearnSVM.predict "qiskit.aqua.algorithms.SklearnSVM.predict") | Predict using the SVM | -| [`run`](qiskit.aqua.algorithms.SklearnSVM.run#qiskit.aqua.algorithms.SklearnSVM.run "qiskit.aqua.algorithms.SklearnSVM.run") | Execute the classical algorithm. | -| [`save_model`](qiskit.aqua.algorithms.SklearnSVM.save_model#qiskit.aqua.algorithms.SklearnSVM.save_model "qiskit.aqua.algorithms.SklearnSVM.save_model") | Save the model to a file path. | -| [`test`](qiskit.aqua.algorithms.SklearnSVM.test#qiskit.aqua.algorithms.SklearnSVM.test "qiskit.aqua.algorithms.SklearnSVM.test") | Test the SVM | -| [`train`](qiskit.aqua.algorithms.SklearnSVM.train#qiskit.aqua.algorithms.SklearnSVM.train "qiskit.aqua.algorithms.SklearnSVM.train") | Train the SVM | +### load\_model -## Attributes + + +`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. + +**Parameters** + +**file\_path** (*str*) – the path of the saved model. + +### predict + + + +`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 + +**Parameters** + +**data** (*numpy.ndarray*) – NxD array, where N is the number of data, D is the feature dimension. + +**Returns** + +predicted labels, Nx1 array + +**Return type** + +numpy.ndarray + +### run + + + +`SklearnSVM.run()` + +Execute the classical algorithm. + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +### save\_model + + +`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. + +**Parameters** + +**file\_path** (*str*) – a path to save the model. + +### test + + + +`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 + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, where N is the number of data, D is the feature dimension. +* **labels** (*numpy.ndarray*) – Nx1 array, where N is the number of data + +**Returns** + +accuracy + +**Return type** + +float + +### train + + + +`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 + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, where N is the number of data, D is the feature dimension. +* **labels** (*numpy.ndarray*) – Nx1 array, where N is the number of data + +## Attributes + + ### class\_to\_label returns class to label - + ### label\_to\_class returns label to class - + ### random Return a numpy random. - + ### ret returns result + 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 f339c923b7a..17badab47c3 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQC.md @@ -1,14 +1,22 @@ -# VQC +--- +title: VQC +description: API reference for qiskit.aqua.algorithms.VQC +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.VQC +--- +# 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)` +`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` The Variational Quantum Classifier algorithm. -Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM#qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. +Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM"), the VQC algorithm also applies to classification problems. VQC uses the variational method to solve such problems in a quantum processor. Specifically, it optimizes a parameterized quantum circuit to provide a solution that cleanly separates the data. The VQC stores the parameters of var\_form and feature\_map sorted by name to map the values provided by the optimizer to the circuit. This is done to ensure reproducible results, for example such that running the optimization twice with same random seeds yields the same result. @@ -34,33 +42,246 @@ Similar to [`QSVM`](qiskit.aqua.algorithms.QSVM#qiskit.aqua.algorithms.QSVM "qis **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Missing feature map or missing training dataset. +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Missing feature map or missing training dataset. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| [`batch_data`](qiskit.aqua.algorithms.VQC.batch_data#qiskit.aqua.algorithms.VQC.batch_data "qiskit.aqua.algorithms.VQC.batch_data") | batch data | -| [`cleanup_parameterized_circuits`](qiskit.aqua.algorithms.VQC.cleanup_parameterized_circuits#qiskit.aqua.algorithms.VQC.cleanup_parameterized_circuits "qiskit.aqua.algorithms.VQC.cleanup_parameterized_circuits") | set parameterized circuits to None | -| [`construct_circuit`](qiskit.aqua.algorithms.VQC.construct_circuit#qiskit.aqua.algorithms.VQC.construct_circuit "qiskit.aqua.algorithms.VQC.construct_circuit") | Construct circuit based on data and parameters in variational form. | -| [`find_minimum`](qiskit.aqua.algorithms.VQC.find_minimum#qiskit.aqua.algorithms.VQC.find_minimum "qiskit.aqua.algorithms.VQC.find_minimum") | Optimize to find the minimum cost value. | -| [`get_optimal_circuit`](qiskit.aqua.algorithms.VQC.get_optimal_circuit#qiskit.aqua.algorithms.VQC.get_optimal_circuit "qiskit.aqua.algorithms.VQC.get_optimal_circuit") | get optimal circuit | -| [`get_optimal_cost`](qiskit.aqua.algorithms.VQC.get_optimal_cost#qiskit.aqua.algorithms.VQC.get_optimal_cost "qiskit.aqua.algorithms.VQC.get_optimal_cost") | get optimal cost | -| [`get_optimal_vector`](qiskit.aqua.algorithms.VQC.get_optimal_vector#qiskit.aqua.algorithms.VQC.get_optimal_vector "qiskit.aqua.algorithms.VQC.get_optimal_vector") | get optimal vector | -| [`get_prob_vector_for_params`](qiskit.aqua.algorithms.VQC.get_prob_vector_for_params#qiskit.aqua.algorithms.VQC.get_prob_vector_for_params "qiskit.aqua.algorithms.VQC.get_prob_vector_for_params") | Helper function to get probability vectors for a set of params | -| [`get_probabilities_for_counts`](qiskit.aqua.algorithms.VQC.get_probabilities_for_counts#qiskit.aqua.algorithms.VQC.get_probabilities_for_counts "qiskit.aqua.algorithms.VQC.get_probabilities_for_counts") | get probabilities for counts | -| [`is_gradient_really_supported`](qiskit.aqua.algorithms.VQC.is_gradient_really_supported#qiskit.aqua.algorithms.VQC.is_gradient_really_supported "qiskit.aqua.algorithms.VQC.is_gradient_really_supported") | returns is gradient really supported | -| [`load_model`](qiskit.aqua.algorithms.VQC.load_model#qiskit.aqua.algorithms.VQC.load_model "qiskit.aqua.algorithms.VQC.load_model") | load model | -| [`predict`](qiskit.aqua.algorithms.VQC.predict#qiskit.aqua.algorithms.VQC.predict "qiskit.aqua.algorithms.VQC.predict") | Predict the labels for the data. | -| [`run`](qiskit.aqua.algorithms.VQC.run#qiskit.aqua.algorithms.VQC.run "qiskit.aqua.algorithms.VQC.run") | Execute the algorithm with selected backend. | -| [`save_model`](qiskit.aqua.algorithms.VQC.save_model#qiskit.aqua.algorithms.VQC.save_model "qiskit.aqua.algorithms.VQC.save_model") | save model | -| [`set_backend`](qiskit.aqua.algorithms.VQC.set_backend#qiskit.aqua.algorithms.VQC.set_backend "qiskit.aqua.algorithms.VQC.set_backend") | Sets backend with configuration. | -| [`test`](qiskit.aqua.algorithms.VQC.test#qiskit.aqua.algorithms.VQC.test "qiskit.aqua.algorithms.VQC.test") | Predict the labels for the data, and test against with ground truth labels. | -| [`train`](qiskit.aqua.algorithms.VQC.train#qiskit.aqua.algorithms.VQC.train "qiskit.aqua.algorithms.VQC.train") | Train the models, and save results. | +### batch\_data -## Attributes + + +`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 + +### cleanup\_parameterized\_circuits + + + +`VQC.cleanup_parameterized_circuits()` + +set parameterized circuits to None + +### construct\_circuit + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – 1-D array with D dimension +* **theta** (*list\[numpy.ndarray]*) – list of 1-D array, parameters sets for variational form +* **measurement** (*bool*) – flag to add measurement + +**Returns** + +the circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If `x` and `theta` share parameters with the same name. + +### find\_minimum + + + +`VQC.find_minimum(initial_point=None, var_form=None, cost_fn=None, optimizer=None, gradient_fn=None)` + +Optimize to find the minimum cost value. + +**Parameters** + +* **initial\_point** (`Optional`\[`ndarray`]) – If not None will be used instead of any initial point supplied via constructor. If None and None was supplied to constructor then a random point will be used if the optimizer requires an initial point. +* **var\_form** (`Union`\[`QuantumCircuit`, `VariationalForm`, `None`]) – If not None will be used instead of any variational form supplied via constructor. +* **cost\_fn** (`Optional`\[`Callable`]) – If not None will be used instead of any cost\_fn supplied via constructor. +* **optimizer** (`Optional`\[`Optimizer`]) – If not None will be used instead of any optimizer supplied via constructor. +* **gradient\_fn** (`Optional`\[`Callable`]) – Optional gradient function for optimizer + +**Returns** + +Optimized variational parameters, and corresponding minimum cost value. + +**Return type** +dict +**Raises** + +**ValueError** – invalid input + +### get\_optimal\_circuit + + + +`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 + +### get\_optimal\_cost + + + +`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 + +### get\_optimal\_vector + + + +`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 + +### get\_prob\_vector\_for\_params + + + +`VQC.get_prob_vector_for_params(construct_circuit_fn, params_s, quantum_instance, construct_circuit_args=None)` + +Helper function to get probability vectors for a set of params + +### get\_probabilities\_for\_counts + + + +`VQC.get_probabilities_for_counts(counts)` + +get probabilities for counts + +### is\_gradient\_really\_supported + + + +`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 + +### load\_model + + + +`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 + +### predict + + + +`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. + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, N is number of data, D is data dimension +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all setting +* **minibatch\_size** (*int*) – the size of each minibatched accuracy evaluation +* **params** (*list*) – list of parameters to populate in the variational form + +**Returns** + +for each data point, generates the predicted probability for each class list: for each data point, generates the predicted label (that with the highest prob) + +**Return type** + +list + +### run + + + +`VQC.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### save\_model + + + +`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 + +### set\_backend + + + +`VQC.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### test + + + +`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. + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, N is number of data and D is data dimension +* **labels** (*numpy.ndarray*) – Nx1 array, N is number of data +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all setting +* **minibatch\_size** (*int*) – the size of each minibatched accuracy evaluation +* **params** (*list*) – list of parameters to populate in the variational form + +**Returns** + +classification accuracy + +**Return type** + +float + +### train + + + +`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. + +**Parameters** + +* **data** (*numpy.ndarray*) – NxD array, N is number of data and D is dimension +* **labels** (*numpy.ndarray*) – Nx1 array, N is number of data +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – quantum backend with all setting +* **minibatch\_size** (*int*) – the size of each minibatched accuracy evaluation + +## Attributes + + ### backend @@ -70,19 +291,19 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### class\_to\_label returns class to label - + ### datapoints return data points - + ### feature\_map @@ -92,7 +313,7 @@ Return the feature map. `Union`\[`FeatureMap`, `QuantumCircuit`, `None`] - + ### initial\_point @@ -102,19 +323,19 @@ Returns initial point `Optional`\[`ndarray`] - + ### label\_to\_class returns label to class - + ### optimal\_params returns optimal parameters - + ### optimizer @@ -124,7 +345,7 @@ Returns optimizer `Optional`\[`Optimizer`] - + ### quantum\_instance @@ -134,31 +355,31 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### ret returns result - + ### test\_dataset returns test dataset - + ### training\_dataset returns training dataset - + ### var\_form @@ -167,3 +388,4 @@ Returns variational form **Return type** `Union`\[`QuantumCircuit`, `VariationalForm`, `None`] + 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 0b7ad548d50..177f46fdf74 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.VQE.md @@ -1,8 +1,16 @@ -# VQE +--- +title: VQE +description: API reference for qiskit.aqua.algorithms.VQE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.algorithms.VQE +--- +# 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)` +`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` @@ -27,7 +35,7 @@ The length of the *initial\_point* list value must match the number of the param * **optimizer** (`Optional`\[`Optimizer`]) – A classical optimizer. * **initial\_point** (`Optional`\[`ndarray`]) – An optional initial point (i.e. initial parameter values) for the optimizer. If `None` then VQE will look to the variational form for a preferred point and if not will simply compute a random one. * **gradient** (`Union`\[`GradientBase`, `Callable`, `None`]) – An optional gradient function or operator for optimizer. -* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When `None` (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory#qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). +* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When `None` (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). * **include\_custom** (`bool`) – When expectation parameter here is None setting this to `True` will allow the factory to include the custom Aer pauli expectation. * **max\_evals\_grouped** (`int`) – Max number of evaluations performed simultaneously. Signals the given optimizer that more than one set of parameters can be supplied so that potentially the expectation values can be computed in parallel. Typically this is possible when a finite difference gradient is used by the optimizer such that multiple points to compute the gradient can be passed and if computed in parallel improve overall execution time. Deprecated if a gradient operator or function is given. * **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – Optional list of auxiliary operators to be evaluated with the eigenstate of the minimum eigenvalue main result and their expectation values returned. For instance in chemistry these can be dipole operators, total particle count operators so we can get values for these at the ground state. @@ -36,26 +44,233 @@ The length of the *initial\_point* list value must match the number of the param ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| [`cleanup_parameterized_circuits`](qiskit.aqua.algorithms.VQE.cleanup_parameterized_circuits#qiskit.aqua.algorithms.VQE.cleanup_parameterized_circuits "qiskit.aqua.algorithms.VQE.cleanup_parameterized_circuits") | set parameterized circuits to None | -| [`compute_minimum_eigenvalue`](qiskit.aqua.algorithms.VQE.compute_minimum_eigenvalue#qiskit.aqua.algorithms.VQE.compute_minimum_eigenvalue "qiskit.aqua.algorithms.VQE.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`construct_circuit`](qiskit.aqua.algorithms.VQE.construct_circuit#qiskit.aqua.algorithms.VQE.construct_circuit "qiskit.aqua.algorithms.VQE.construct_circuit") | Return the circuits used to compute the expectation value. | -| [`construct_expectation`](qiskit.aqua.algorithms.VQE.construct_expectation#qiskit.aqua.algorithms.VQE.construct_expectation "qiskit.aqua.algorithms.VQE.construct_expectation") | Generate the ansatz circuit and expectation value measurement, and return their runnable composition. | -| [`find_minimum`](qiskit.aqua.algorithms.VQE.find_minimum#qiskit.aqua.algorithms.VQE.find_minimum "qiskit.aqua.algorithms.VQE.find_minimum") | Optimize to find the minimum cost value. | -| [`get_optimal_circuit`](qiskit.aqua.algorithms.VQE.get_optimal_circuit#qiskit.aqua.algorithms.VQE.get_optimal_circuit "qiskit.aqua.algorithms.VQE.get_optimal_circuit") | Get the circuit with the optimal parameters. | -| [`get_optimal_cost`](qiskit.aqua.algorithms.VQE.get_optimal_cost#qiskit.aqua.algorithms.VQE.get_optimal_cost "qiskit.aqua.algorithms.VQE.get_optimal_cost") | Get the minimal cost or energy found by the VQE. | -| [`get_optimal_vector`](qiskit.aqua.algorithms.VQE.get_optimal_vector#qiskit.aqua.algorithms.VQE.get_optimal_vector "qiskit.aqua.algorithms.VQE.get_optimal_vector") | Get the simulation outcome of the optimal circuit. | -| [`get_prob_vector_for_params`](qiskit.aqua.algorithms.VQE.get_prob_vector_for_params#qiskit.aqua.algorithms.VQE.get_prob_vector_for_params "qiskit.aqua.algorithms.VQE.get_prob_vector_for_params") | Helper function to get probability vectors for a set of params | -| [`get_probabilities_for_counts`](qiskit.aqua.algorithms.VQE.get_probabilities_for_counts#qiskit.aqua.algorithms.VQE.get_probabilities_for_counts "qiskit.aqua.algorithms.VQE.get_probabilities_for_counts") | get probabilities for counts | -| [`print_settings`](qiskit.aqua.algorithms.VQE.print_settings#qiskit.aqua.algorithms.VQE.print_settings "qiskit.aqua.algorithms.VQE.print_settings") | Preparing the setting of VQE into a string. | -| [`run`](qiskit.aqua.algorithms.VQE.run#qiskit.aqua.algorithms.VQE.run "qiskit.aqua.algorithms.VQE.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.aqua.algorithms.VQE.set_backend#qiskit.aqua.algorithms.VQE.set_backend "qiskit.aqua.algorithms.VQE.set_backend") | Sets backend with configuration. | -| [`supports_aux_operators`](qiskit.aqua.algorithms.VQE.supports_aux_operators#qiskit.aqua.algorithms.VQE.supports_aux_operators "qiskit.aqua.algorithms.VQE.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### cleanup\_parameterized\_circuits -## Attributes + + +`VQE.cleanup_parameterized_circuits()` + +set parameterized circuits to None + +### compute\_minimum\_eigenvalue + + + +`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. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### construct\_circuit + + + +`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. + +**Parameters** + +**parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. + +**Return type** + +`List`\[`QuantumCircuit`] + +**Returns** + +A list of the circuits used to compute the expectation value. + +### construct\_expectation + + + +`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. + +**Parameters** + +**parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. + +**Return type** + +`OperatorBase` + +**Returns** + +The Operator equalling the measurement of the ansatz `StateFn` by the Observable’s expectation `StateFn`. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If no operator has been provided. + +### find\_minimum + + + +`VQE.find_minimum(initial_point=None, var_form=None, cost_fn=None, optimizer=None, gradient_fn=None)` + +Optimize to find the minimum cost value. + +**Parameters** + +* **initial\_point** (`Optional`\[`ndarray`]) – If not None will be used instead of any initial point supplied via constructor. If None and None was supplied to constructor then a random point will be used if the optimizer requires an initial point. +* **var\_form** (`Union`\[`QuantumCircuit`, `VariationalForm`, `None`]) – If not None will be used instead of any variational form supplied via constructor. +* **cost\_fn** (`Optional`\[`Callable`]) – If not None will be used instead of any cost\_fn supplied via constructor. +* **optimizer** (`Optional`\[`Optimizer`]) – If not None will be used instead of any optimizer supplied via constructor. +* **gradient\_fn** (`Optional`\[`Callable`]) – Optional gradient function for optimizer + +**Returns** + +Optimized variational parameters, and corresponding minimum cost value. + +**Return type** + +dict + +**Raises** + +**ValueError** – invalid input + +### get\_optimal\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +### get\_optimal\_cost + + + +`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. + +**Return type** + +`float` + +### get\_optimal\_vector + + + +`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. + +**Return type** + +`Union`\[`List`\[`float`], `Dict`\[`str`, `int`]] + +### get\_prob\_vector\_for\_params + + + +`VQE.get_prob_vector_for_params(construct_circuit_fn, params_s, quantum_instance, construct_circuit_args=None)` + +Helper function to get probability vectors for a set of params + +### get\_probabilities\_for\_counts + + + +`VQE.get_probabilities_for_counts(counts)` + +get probabilities for counts + +### print\_settings + +`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. + +**Returns** + +the formatted setting of VQE + +**Return type** + +str + +### run + + + +`VQE.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`VQE.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### supports\_aux\_operators + + + +`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. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -65,7 +280,7 @@ Returns aux operators `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### backend @@ -75,7 +290,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### expectation @@ -85,7 +300,7 @@ The expectation value algorithm used to construct the expectation measurement fr `ExpectationBase` - + ### initial\_point @@ -95,7 +310,7 @@ Returns initial point `Optional`\[`ndarray`] - + ### operator @@ -105,7 +320,7 @@ Returns operator `Optional`\[`OperatorBase`] - + ### optimal\_params @@ -115,7 +330,7 @@ The optimal parameters for the variational form. `List`\[`float`] - + ### optimizer @@ -125,7 +340,7 @@ Returns optimizer `Optional`\[`Optimizer`] - + ### quantum\_instance @@ -135,19 +350,19 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### setting Prepare the setting of VQE as a string. - + ### var\_form @@ -156,3 +371,4 @@ Returns variational form **Return type** `Union`\[`QuantumCircuit`, `VariationalForm`, `None`] + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.md b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.md index 9b591f1320d..e9cb4fc7036 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.algorithms.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.algorithms.md @@ -20,14 +20,14 @@ Aqua contains a collection of quantum algorithms, for use with quantum computers Algorithms configuration includes the use of [`components`](qiskit.aqua.components#module-qiskit.aqua.components "qiskit.aqua.components") which were designed to be swappable sub-parts of an algorithm. Any component and may be exchanged for a different implementation of the same component type in order to potentially alter the behavior and outcome of the algorithm. -Quantum algorithms are run via a [`QuantumInstance`](qiskit.aqua.QuantumInstance#qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") which must be set with the desired backend where the algorithm’s circuits will be executed and be configured with a number of compile and runtime parameters controlling circuit compilation and execution. Aqua ultimately uses [Terra](https://www.qiskit.org/terra) for the actual compilation and execution of the quantum circuits created by the algorithm and its components. +Quantum algorithms are run via a [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") which must be set with the desired backend where the algorithm’s circuits will be executed and be configured with a number of compile and runtime parameters controlling circuit compilation and execution. Aqua ultimately uses [Terra](https://www.qiskit.org/terra) for the actual compilation and execution of the quantum circuits created by the algorithm and its components. # Algorithms Base Class -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`QuantumAlgorithm`](qiskit.aqua.algorithms.QuantumAlgorithm#qiskit.aqua.algorithms.QuantumAlgorithm "qiskit.aqua.algorithms.QuantumAlgorithm") | Base class for Quantum Algorithms. | -| [`ClassicalAlgorithm`](qiskit.aqua.algorithms.ClassicalAlgorithm#qiskit.aqua.algorithms.ClassicalAlgorithm "qiskit.aqua.algorithms.ClassicalAlgorithm") | Base class for Classical Algorithms. | +| | | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------ | +| [`QuantumAlgorithm`](qiskit.aqua.algorithms.QuantumAlgorithm "qiskit.aqua.algorithms.QuantumAlgorithm") | Base class for Quantum Algorithms. | +| [`ClassicalAlgorithm`](qiskit.aqua.algorithms.ClassicalAlgorithm "qiskit.aqua.algorithms.ClassicalAlgorithm") | Base class for Classical Algorithms. | # Algorithms @@ -39,104 +39,104 @@ The classical algorithms are designed to take the same input data as the quantum ## Amplitude Amplifiers -| | | -| ------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | -| [`Grover`](qiskit.aqua.algorithms.Grover#qiskit.aqua.algorithms.Grover "qiskit.aqua.algorithms.Grover") | Grover’s Search algorithm. | -| [`GroverResult`](qiskit.aqua.algorithms.GroverResult#qiskit.aqua.algorithms.GroverResult "qiskit.aqua.algorithms.GroverResult") | Grover Result. | +| | | +| ------------------------------------------------------------------------------------------- | -------------------------- | +| [`Grover`](qiskit.aqua.algorithms.Grover "qiskit.aqua.algorithms.Grover") | Grover’s Search algorithm. | +| [`GroverResult`](qiskit.aqua.algorithms.GroverResult "qiskit.aqua.algorithms.GroverResult") | Grover Result. | ## Amplitude Estimators Algorithms that estimate a value. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`AmplitudeEstimationAlgorithmResult`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult#qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult") | AmplitudeEstimationAlgorithm Result. | -| [`AmplitudeEstimation`](qiskit.aqua.algorithms.AmplitudeEstimation#qiskit.aqua.algorithms.AmplitudeEstimation "qiskit.aqua.algorithms.AmplitudeEstimation") | The Quantum Phase Estimation-based Amplitude Estimation algorithm. | -| [`AmplitudeEstimationResult`](qiskit.aqua.algorithms.AmplitudeEstimationResult#qiskit.aqua.algorithms.AmplitudeEstimationResult "qiskit.aqua.algorithms.AmplitudeEstimationResult") | AmplitudeEstimation Result. | -| [`IterativeAmplitudeEstimation`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation#qiskit.aqua.algorithms.IterativeAmplitudeEstimation "qiskit.aqua.algorithms.IterativeAmplitudeEstimation") | The Iterative Amplitude Estimation algorithm. | -| [`IterativeAmplitudeEstimationResult`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult#qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult") | IterativeAmplitudeEstimation Result. | -| [`MaximumLikelihoodAmplitudeEstimation`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation") | The Maximum Likelihood Amplitude Estimation algorithm. | -| [`MaximumLikelihoodAmplitudeEstimationResult`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult") | MaximumLikelihoodAmplitudeEstimation Result. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| [`AmplitudeEstimationAlgorithmResult`](qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult "qiskit.aqua.algorithms.AmplitudeEstimationAlgorithmResult") | AmplitudeEstimationAlgorithm Result. | +| [`AmplitudeEstimation`](qiskit.aqua.algorithms.AmplitudeEstimation "qiskit.aqua.algorithms.AmplitudeEstimation") | The Quantum Phase Estimation-based Amplitude Estimation algorithm. | +| [`AmplitudeEstimationResult`](qiskit.aqua.algorithms.AmplitudeEstimationResult "qiskit.aqua.algorithms.AmplitudeEstimationResult") | AmplitudeEstimation Result. | +| [`IterativeAmplitudeEstimation`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation "qiskit.aqua.algorithms.IterativeAmplitudeEstimation") | The Iterative Amplitude Estimation algorithm. | +| [`IterativeAmplitudeEstimationResult`](qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult "qiskit.aqua.algorithms.IterativeAmplitudeEstimationResult") | IterativeAmplitudeEstimation Result. | +| [`MaximumLikelihoodAmplitudeEstimation`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation") | The Maximum Likelihood Amplitude Estimation algorithm. | +| [`MaximumLikelihoodAmplitudeEstimationResult`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimationResult") | MaximumLikelihoodAmplitudeEstimation Result. | ## Classifiers Algorithms for data classification. -| | | -| ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`QSVM`](qiskit.aqua.algorithms.QSVM#qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM") | Quantum SVM algorithm. | -| [`VQC`](qiskit.aqua.algorithms.VQC#qiskit.aqua.algorithms.VQC "qiskit.aqua.algorithms.VQC") | The Variational Quantum Classifier algorithm. | -| [`SklearnSVM`](qiskit.aqua.algorithms.SklearnSVM#qiskit.aqua.algorithms.SklearnSVM "qiskit.aqua.algorithms.SklearnSVM") | The Sklearn SVM algorithm (classical). | +| | | +| ------------------------------------------------------------------------------------- | --------------------------------------------- | +| [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM") | Quantum SVM algorithm. | +| [`VQC`](qiskit.aqua.algorithms.VQC "qiskit.aqua.algorithms.VQC") | The Variational Quantum Classifier algorithm. | +| [`SklearnSVM`](qiskit.aqua.algorithms.SklearnSVM "qiskit.aqua.algorithms.SklearnSVM") | The Sklearn SVM algorithm (classical). | ## Distribution Learners -| | | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`QGAN`](qiskit.aqua.algorithms.QGAN#qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") | The Quantum Generative Adversarial Network algorithm. | +| | | +| ------------------------------------------------------------------- | ----------------------------------------------------- | +| [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") | The Quantum Generative Adversarial Network algorithm. | ## Education Algorithms whose main role is educational. These are provided as Aqua algorithms so they can be run in the same framework but their existence here is principally for educational reasons. -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`BernsteinVazirani`](qiskit.aqua.algorithms.BernsteinVazirani#qiskit.aqua.algorithms.BernsteinVazirani "qiskit.aqua.algorithms.BernsteinVazirani") | The Bernstein-Vazirani algorithm. | -| [`DeutschJozsa`](qiskit.aqua.algorithms.DeutschJozsa#qiskit.aqua.algorithms.DeutschJozsa "qiskit.aqua.algorithms.DeutschJozsa") | The Deutsch-Jozsa algorithm. | -| [`EOH`](qiskit.aqua.algorithms.EOH#qiskit.aqua.algorithms.EOH "qiskit.aqua.algorithms.EOH") | The Quantum EOH (Evolution of Hamiltonian) algorithm. | -| [`Simon`](qiskit.aqua.algorithms.Simon#qiskit.aqua.algorithms.Simon "qiskit.aqua.algorithms.Simon") | The Simon algorithm. | +| | | +| ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | +| [`BernsteinVazirani`](qiskit.aqua.algorithms.BernsteinVazirani "qiskit.aqua.algorithms.BernsteinVazirani") | The Bernstein-Vazirani algorithm. | +| [`DeutschJozsa`](qiskit.aqua.algorithms.DeutschJozsa "qiskit.aqua.algorithms.DeutschJozsa") | The Deutsch-Jozsa algorithm. | +| [`EOH`](qiskit.aqua.algorithms.EOH "qiskit.aqua.algorithms.EOH") | The Quantum EOH (Evolution of Hamiltonian) algorithm. | +| [`Simon`](qiskit.aqua.algorithms.Simon "qiskit.aqua.algorithms.Simon") | The Simon algorithm. | ## Eigensolvers Algorithms to find eigenvalues of an operator. For chemistry these can be used to find excited states of a molecule and qiskit.chemistry has some algorithms that leverage chemistry specific knowledge to do this in that application domain. -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | -| [`Eigensolver`](qiskit.aqua.algorithms.Eigensolver#qiskit.aqua.algorithms.Eigensolver "qiskit.aqua.algorithms.Eigensolver") | The Eigensolver Interface. | -| [`EigensolverResult`](qiskit.aqua.algorithms.EigensolverResult#qiskit.aqua.algorithms.EigensolverResult "qiskit.aqua.algorithms.EigensolverResult") | Eigensolver Result. | +| | | +| ---------------------------------------------------------------------------------------------------------- | -------------------------- | +| [`Eigensolver`](qiskit.aqua.algorithms.Eigensolver "qiskit.aqua.algorithms.Eigensolver") | The Eigensolver Interface. | +| [`EigensolverResult`](qiskit.aqua.algorithms.EigensolverResult "qiskit.aqua.algorithms.EigensolverResult") | Eigensolver Result. | -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`NumPyEigensolver`](qiskit.aqua.algorithms.NumPyEigensolver#qiskit.aqua.algorithms.NumPyEigensolver "qiskit.aqua.algorithms.NumPyEigensolver") | The NumPy Eigensolver algorithm. | +| | | +| ------------------------------------------------------------------------------------------------------- | -------------------------------- | +| [`NumPyEigensolver`](qiskit.aqua.algorithms.NumPyEigensolver "qiskit.aqua.algorithms.NumPyEigensolver") | The NumPy Eigensolver algorithm. | ## Factorizers Algorithms to find factors of a number. -| | | -| ----------------------------------------------------------------------------------------------- | --------------------------- | -| [`Shor`](qiskit.aqua.algorithms.Shor#qiskit.aqua.algorithms.Shor "qiskit.aqua.algorithms.Shor") | Shor’s factoring algorithm. | +| | | +| ------------------------------------------------------------------- | --------------------------- | +| [`Shor`](qiskit.aqua.algorithms.Shor "qiskit.aqua.algorithms.Shor") | Shor’s factoring algorithm. | ## Linear Solvers Algorithms to find solutions for linear equations of equations. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`LinearsolverResult`](qiskit.aqua.algorithms.LinearsolverResult#qiskit.aqua.algorithms.LinearsolverResult "qiskit.aqua.algorithms.LinearsolverResult") | Linear solver Result. | -| [`HHL`](qiskit.aqua.algorithms.HHL#qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL") | The HHL algorithm. | -| [`HHLResult`](qiskit.aqua.algorithms.HHLResult#qiskit.aqua.algorithms.HHLResult "qiskit.aqua.algorithms.HHLResult") | HHL Result. | -| [`NumPyLSsolver`](qiskit.aqua.algorithms.NumPyLSsolver#qiskit.aqua.algorithms.NumPyLSsolver "qiskit.aqua.algorithms.NumPyLSsolver") | The Numpy LinearSystem algorithm (classical). | -| [`NumPyLSsolverResult`](qiskit.aqua.algorithms.NumPyLSsolverResult#qiskit.aqua.algorithms.NumPyLSsolverResult "qiskit.aqua.algorithms.NumPyLSsolverResult") | Numpy LinearSystem Result. | +| | | +| ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| [`LinearsolverResult`](qiskit.aqua.algorithms.LinearsolverResult "qiskit.aqua.algorithms.LinearsolverResult") | Linear solver Result. | +| [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL") | The HHL algorithm. | +| [`HHLResult`](qiskit.aqua.algorithms.HHLResult "qiskit.aqua.algorithms.HHLResult") | HHL Result. | +| [`NumPyLSsolver`](qiskit.aqua.algorithms.NumPyLSsolver "qiskit.aqua.algorithms.NumPyLSsolver") | The Numpy LinearSystem algorithm (classical). | +| [`NumPyLSsolverResult`](qiskit.aqua.algorithms.NumPyLSsolverResult "qiskit.aqua.algorithms.NumPyLSsolverResult") | Numpy LinearSystem Result. | ## Minimum Eigensolvers Algorithms that can find the minimum eigenvalue of an operator. -Note: The [`ClassicalCPLEX`](qiskit.aqua.algorithms.ClassicalCPLEX#qiskit.aqua.algorithms.ClassicalCPLEX "qiskit.aqua.algorithms.ClassicalCPLEX") algorithm requires [IBM ILOG CPLEX Optimization Studio](https://www.ibm.com/support/knowledgecenter/SSSA5P_12.10.0/COS_KC_home.html) and its Python API to be installed. See the following for more information: +Note: The [`ClassicalCPLEX`](qiskit.aqua.algorithms.ClassicalCPLEX "qiskit.aqua.algorithms.ClassicalCPLEX") algorithm requires [IBM ILOG CPLEX Optimization Studio](https://www.ibm.com/support/knowledgecenter/SSSA5P_12.10.0/COS_KC_home.html) and its Python API to be installed. See the following for more information: * [CPLEX Installation](qiskit.aqua.algorithms.minimum_eigen_solvers.cplex) -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`MinimumEigensolver`](qiskit.aqua.algorithms.MinimumEigensolver#qiskit.aqua.algorithms.MinimumEigensolver "qiskit.aqua.algorithms.MinimumEigensolver") | The Minimum Eigensolver Interface. | -| [`MinimumEigensolverResult`](qiskit.aqua.algorithms.MinimumEigensolverResult#qiskit.aqua.algorithms.MinimumEigensolverResult "qiskit.aqua.algorithms.MinimumEigensolverResult") | Minimum Eigensolver Result. | - -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| [`ClassicalCPLEX`](qiskit.aqua.algorithms.ClassicalCPLEX#qiskit.aqua.algorithms.ClassicalCPLEX "qiskit.aqua.algorithms.ClassicalCPLEX") | The Classical CPLEX algorithm (classical). | -| [`IQPE`](qiskit.aqua.algorithms.IQPE#qiskit.aqua.algorithms.IQPE "qiskit.aqua.algorithms.IQPE") | The Iterative Quantum Phase Estimation algorithm. | -| [`NumPyMinimumEigensolver`](qiskit.aqua.algorithms.NumPyMinimumEigensolver#qiskit.aqua.algorithms.NumPyMinimumEigensolver "qiskit.aqua.algorithms.NumPyMinimumEigensolver") | The Numpy Minimum Eigensolver algorithm. | -| [`QAOA`](qiskit.aqua.algorithms.QAOA#qiskit.aqua.algorithms.QAOA "qiskit.aqua.algorithms.QAOA") | The Quantum Approximate Optimization Algorithm. | -| [`QPE`](qiskit.aqua.algorithms.QPE#qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE") | The Quantum Phase Estimation algorithm. | -| [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") | The Variational Quantum Eigensolver algorithm. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| [`MinimumEigensolver`](qiskit.aqua.algorithms.MinimumEigensolver "qiskit.aqua.algorithms.MinimumEigensolver") | The Minimum Eigensolver Interface. | +| [`MinimumEigensolverResult`](qiskit.aqua.algorithms.MinimumEigensolverResult "qiskit.aqua.algorithms.MinimumEigensolverResult") | Minimum Eigensolver Result. | + +| | | +| ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | +| [`ClassicalCPLEX`](qiskit.aqua.algorithms.ClassicalCPLEX "qiskit.aqua.algorithms.ClassicalCPLEX") | The Classical CPLEX algorithm (classical). | +| [`IQPE`](qiskit.aqua.algorithms.IQPE "qiskit.aqua.algorithms.IQPE") | The Iterative Quantum Phase Estimation algorithm. | +| [`NumPyMinimumEigensolver`](qiskit.aqua.algorithms.NumPyMinimumEigensolver "qiskit.aqua.algorithms.NumPyMinimumEigensolver") | The Numpy Minimum Eigensolver algorithm. | +| [`QAOA`](qiskit.aqua.algorithms.QAOA "qiskit.aqua.algorithms.QAOA") | The Quantum Approximate Optimization Algorithm. | +| [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE") | The Quantum Phase Estimation algorithm. | +| [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") | The Variational Quantum Eigensolver algorithm. | 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 cc7bb9853ec..48fc6aa2731 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.CNF.md @@ -1,8 +1,16 @@ -# CNF +--- +title: CNF +description: API reference for qiskit.aqua.circuits.CNF +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.circuits.CNF +--- +# CNF + -`CNF(ast, num_vars=None)` +`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` @@ -17,49 +25,82 @@ Constructor. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`compute_num_ancillae`](qiskit.aqua.circuits.CNF.compute_num_ancillae#qiskit.aqua.circuits.CNF.compute_num_ancillae "qiskit.aqua.circuits.CNF.compute_num_ancillae") | returns the number of ancillary qubits needed | -| [`construct_circuit`](qiskit.aqua.circuits.CNF.construct_circuit#qiskit.aqua.circuits.CNF.construct_circuit "qiskit.aqua.circuits.CNF.construct_circuit") | Construct circuit. | +### compute\_num\_ancillae -## Attributes + + +`CNF.compute_num_ancillae(mct_mode='basic')` + +returns the number of ancillary qubits needed + +### construct\_circuit + + + +`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. + +**Parameters** + +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The optional circuit to extend from +* **variable\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use for problem variables +* **clause\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use for problem clauses +* **output\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use for holding the output +* **ancillary\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use as ancilla +* **mct\_mode** (*str*) – The mode to use for building Multiple-Control Toffoli + +**Returns** +quantum circuit. +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input + +## Attributes + + ### ancillary\_register returns ancillary register - + ### clause\_register returns clause register - + ### num\_clauses returns num clauses - + ### num\_variables return num variables - + ### output\_register returns output register - + ### variable\_register returns variable register + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md index 9221220c6f2..f45e1493fbd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.DNF.md @@ -1,8 +1,16 @@ -# DNF +--- +title: DNF +description: API reference for qiskit.aqua.circuits.DNF +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.circuits.DNF +--- +# DNF + -`DNF(ast, num_vars=None)` +`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` @@ -17,49 +25,82 @@ Constructor. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`compute_num_ancillae`](qiskit.aqua.circuits.DNF.compute_num_ancillae#qiskit.aqua.circuits.DNF.compute_num_ancillae "qiskit.aqua.circuits.DNF.compute_num_ancillae") | returns the number of ancillary qubits needed | -| [`construct_circuit`](qiskit.aqua.circuits.DNF.construct_circuit#qiskit.aqua.circuits.DNF.construct_circuit "qiskit.aqua.circuits.DNF.construct_circuit") | Construct circuit. | +### compute\_num\_ancillae -## Attributes + + +`DNF.compute_num_ancillae(mct_mode='basic')` + +returns the number of ancillary qubits needed + +### construct\_circuit + + + +`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. + +**Parameters** + +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The optional circuit to extend from +* **variable\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use for problem variables +* **clause\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use for problem clauses +* **output\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use for holding the output +* **ancillary\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use as ancilla +* **mct\_mode** (*str*) – The mode to use for building Multiple-Control Toffoli + +**Returns** +quantum circuit. +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input + +## Attributes + + ### ancillary\_register returns ancillary register - + ### clause\_register returns clause register - + ### num\_clauses returns num clauses - + ### num\_variables return num variables - + ### output\_register returns output register - + ### variable\_register returns variable register + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md index 70a7b1d7800..cf2e01fee26 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.ESOP.md @@ -1,8 +1,16 @@ -# ESOP +--- +title: ESOP +description: API reference for qiskit.aqua.circuits.ESOP +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.circuits.ESOP +--- +# ESOP + -`ESOP(ast, num_vars=None)` +`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` @@ -17,49 +25,84 @@ Constructor. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | -| [`compute_num_ancillae`](qiskit.aqua.circuits.ESOP.compute_num_ancillae#qiskit.aqua.circuits.ESOP.compute_num_ancillae "qiskit.aqua.circuits.ESOP.compute_num_ancillae") | returns the number of ancillary qubits needed | -| [`construct_circuit`](qiskit.aqua.circuits.ESOP.construct_circuit#qiskit.aqua.circuits.ESOP.construct_circuit "qiskit.aqua.circuits.ESOP.construct_circuit") | Construct circuit. | +### compute\_num\_ancillae -## Attributes + + +`ESOP.compute_num_ancillae(mct_mode='basic')` + +returns the number of ancillary qubits needed + +### construct\_circuit + + + +`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. + +**Parameters** + +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The optional circuit to extend from +* **variable\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum +* **to use for problem variables** (*register*) – +* **output\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum +* **to use for holding the output** (*register*) – +* **output\_idx** (*int*) – The index of the output register to write to +* **ancillary\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The optional quantum register to use as ancilla +* **mct\_mode** (*str*) – The mode to use for building Multiple-Control Toffoli + +**Returns** +quantum circuit. +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input + +## Attributes + + ### ancillary\_register returns ancillary register - + ### clause\_register returns clause register - + ### num\_clauses returns num clauses - + ### num\_variables return num variables - + ### output\_register returns output register - + ### variable\_register returns variable register + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md index 9ec4558e192..9b19c13d7f0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.PhaseEstimationCircuit.md @@ -1,8 +1,16 @@ -# PhaseEstimationCircuit +--- +title: PhaseEstimationCircuit +description: API reference for qiskit.aqua.circuits.PhaseEstimationCircuit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.circuits.PhaseEstimationCircuit +--- +# 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)` +`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` @@ -26,30 +34,57 @@ Quantum Phase Estimation Circuit. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Missing input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Missing input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- | -| [`construct_circuit`](qiskit.aqua.circuits.PhaseEstimationCircuit.construct_circuit#qiskit.aqua.circuits.PhaseEstimationCircuit.construct_circuit "qiskit.aqua.circuits.PhaseEstimationCircuit.construct_circuit") | Construct the Phase Estimation circuit | +### construct\_circuit -## Attributes + + +`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 + +**Parameters** + +* **state\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the optional register to use for the quantum state +* **ancillary\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the optional register to use for +* **ancillary measurement qubits** (*the*) – +* **auxiliary\_register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – an optional auxiliary quantum register +* **measurement** (*bool*) – Boolean flag to indicate if measurement should be included +* **the circuit.** (*in*) – + +**Returns** + +the QuantumCircuit object for the constructed circuit +**Return type** +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **RuntimeError** – Multiple identity pauli terms are present +* **ValueError** – invalid mode + +## Attributes + + ### ancillary\_register returns ancillary register - + ### auxiliary\_register returns auxiliary register - + ### state\_register returns state register + 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 704b7b998de..b93db01a246 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.StateVectorCircuit.md @@ -1,8 +1,16 @@ -# StateVectorCircuit +--- +title: StateVectorCircuit +description: API reference for qiskit.aqua.circuits.StateVectorCircuit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.circuits.StateVectorCircuit +--- +# StateVectorCircuit + -`StateVectorCircuit(state_vector)` +`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` @@ -16,10 +24,32 @@ Constructor. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------ | -| [`construct_circuit`](qiskit.aqua.circuits.StateVectorCircuit.construct_circuit#qiskit.aqua.circuits.StateVectorCircuit.construct_circuit "qiskit.aqua.circuits.StateVectorCircuit.construct_circuit") | Construct the circuit representing the desired state vector. | +### construct\_circuit + + + +`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. + +**Parameters** + +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The optional circuit to extend from. +* **register** (*Union(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *, list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*])*) – The optional qubits to construct the circuit with. + +**Returns** + +quantum circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input + 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 922aa7c40e0..f03b31602d8 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.WeightedSumOperator.md @@ -1,8 +1,16 @@ -# WeightedSumOperator +--- +title: WeightedSumOperator +description: API reference for qiskit.aqua.circuits.WeightedSumOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.circuits.WeightedSumOperator +--- +# WeightedSumOperator + -`WeightedSumOperator(num_state_qubits, weights, i_state=None, i_sum=None)` +`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` @@ -19,54 +27,172 @@ Computes the weighted sum controlled by state qubits **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.circuits.WeightedSumOperator.build#qiskit.aqua.circuits.WeightedSumOperator.build "qiskit.aqua.circuits.WeightedSumOperator.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.aqua.circuits.WeightedSumOperator.build_controlled#qiskit.aqua.circuits.WeightedSumOperator.build_controlled "qiskit.aqua.circuits.WeightedSumOperator.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.circuits.WeightedSumOperator.build_controlled_inverse#qiskit.aqua.circuits.WeightedSumOperator.build_controlled_inverse "qiskit.aqua.circuits.WeightedSumOperator.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.circuits.WeightedSumOperator.build_controlled_inverse_power#qiskit.aqua.circuits.WeightedSumOperator.build_controlled_inverse_power "qiskit.aqua.circuits.WeightedSumOperator.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.circuits.WeightedSumOperator.build_controlled_power#qiskit.aqua.circuits.WeightedSumOperator.build_controlled_power "qiskit.aqua.circuits.WeightedSumOperator.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.circuits.WeightedSumOperator.build_inverse#qiskit.aqua.circuits.WeightedSumOperator.build_inverse "qiskit.aqua.circuits.WeightedSumOperator.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.circuits.WeightedSumOperator.build_inverse_power#qiskit.aqua.circuits.WeightedSumOperator.build_inverse_power "qiskit.aqua.circuits.WeightedSumOperator.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.circuits.WeightedSumOperator.build_power#qiskit.aqua.circuits.WeightedSumOperator.build_power "qiskit.aqua.circuits.WeightedSumOperator.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.circuits.WeightedSumOperator.get_num_qubits#qiskit.aqua.circuits.WeightedSumOperator.get_num_qubits "qiskit.aqua.circuits.WeightedSumOperator.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.circuits.WeightedSumOperator.get_num_qubits_controlled#qiskit.aqua.circuits.WeightedSumOperator.get_num_qubits_controlled "qiskit.aqua.circuits.WeightedSumOperator.get_num_qubits_controlled") | returns number of qubits controlled | -| [`get_required_sum_qubits`](qiskit.aqua.circuits.WeightedSumOperator.get_required_sum_qubits#qiskit.aqua.circuits.WeightedSumOperator.get_required_sum_qubits "qiskit.aqua.circuits.WeightedSumOperator.get_required_sum_qubits") | get required sum qubits | -| [`required_ancillas`](qiskit.aqua.circuits.WeightedSumOperator.required_ancillas#qiskit.aqua.circuits.WeightedSumOperator.required_ancillas "qiskit.aqua.circuits.WeightedSumOperator.required_ancillas") | required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.circuits.WeightedSumOperator.required_ancillas_controlled#qiskit.aqua.circuits.WeightedSumOperator.required_ancillas_controlled "qiskit.aqua.circuits.WeightedSumOperator.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`WeightedSumOperator.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`WeightedSumOperator.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`WeightedSumOperator.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`WeightedSumOperator.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`WeightedSumOperator.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +### build\_inverse\_power + + + +`WeightedSumOperator.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`WeightedSumOperator.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`WeightedSumOperator.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`WeightedSumOperator.get_num_qubits_controlled()` + +returns number of qubits controlled + +### get\_required\_sum\_qubits + + + +`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 + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`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 + +## Attributes + + ### num\_carry\_qubits returns num carry qubits - + ### num\_state\_qubits returns num state qubits - + ### num\_sum\_qubits returns num sum qubits - + ### num\_target\_qubits Returns the number of target qubits - + ### weights returns weights + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.circuits.md b/docs/api/qiskit/0.32/qiskit.aqua.circuits.md index 6234d5eb5a8..df0fb960fee 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.circuits.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.circuits.md @@ -26,12 +26,12 @@ Collection of circuits and gates that may be used to build quantum algorithms an # Circuits -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`CNF`](qiskit.aqua.circuits.CNF#qiskit.aqua.circuits.CNF "qiskit.aqua.circuits.CNF") | Class for constructing circuits for Conjunctive Normal Forms | -| [`DNF`](qiskit.aqua.circuits.DNF#qiskit.aqua.circuits.DNF "qiskit.aqua.circuits.DNF") | Class for constructing circuits for Disjunctive Normal Forms | -| [`ESOP`](qiskit.aqua.circuits.ESOP#qiskit.aqua.circuits.ESOP "qiskit.aqua.circuits.ESOP") | Class for constructing circuits for Exclusive Sum of Products | -| [`PhaseEstimationCircuit`](qiskit.aqua.circuits.PhaseEstimationCircuit#qiskit.aqua.circuits.PhaseEstimationCircuit "qiskit.aqua.circuits.PhaseEstimationCircuit") | Quantum Phase Estimation Circuit. | -| [`StateVectorCircuit`](qiskit.aqua.circuits.StateVectorCircuit#qiskit.aqua.circuits.StateVectorCircuit "qiskit.aqua.circuits.StateVectorCircuit") | Arbitrary State-Vector Circuit. | -| [`WeightedSumOperator`](qiskit.aqua.circuits.WeightedSumOperator#qiskit.aqua.circuits.WeightedSumOperator "qiskit.aqua.circuits.WeightedSumOperator") | Adds q^T \* w to separate register for non-negative integer weights w. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| [`CNF`](qiskit.aqua.circuits.CNF "qiskit.aqua.circuits.CNF") | Class for constructing circuits for Conjunctive Normal Forms | +| [`DNF`](qiskit.aqua.circuits.DNF "qiskit.aqua.circuits.DNF") | Class for constructing circuits for Disjunctive Normal Forms | +| [`ESOP`](qiskit.aqua.circuits.ESOP "qiskit.aqua.circuits.ESOP") | Class for constructing circuits for Exclusive Sum of Products | +| [`PhaseEstimationCircuit`](qiskit.aqua.circuits.PhaseEstimationCircuit "qiskit.aqua.circuits.PhaseEstimationCircuit") | Quantum Phase Estimation Circuit. | +| [`StateVectorCircuit`](qiskit.aqua.circuits.StateVectorCircuit "qiskit.aqua.circuits.StateVectorCircuit") | Arbitrary State-Vector Circuit. | +| [`WeightedSumOperator`](qiskit.aqua.circuits.WeightedSumOperator "qiskit.aqua.circuits.WeightedSumOperator") | Adds q^T \* w to separate register for non-negative integer weights w. | 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 354039c615d..a33e8c8187a 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 @@ -1,8 +1,16 @@ -# Eigenvalues +--- +title: Eigenvalues +description: API reference for qiskit.aqua.components.eigs.Eigenvalues +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.eigs.Eigenvalues +--- +# Eigenvalues + -`Eigenvalues` +`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` @@ -12,9 +20,72 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`construct_circuit`](qiskit.aqua.components.eigs.Eigenvalues.construct_circuit#qiskit.aqua.components.eigs.Eigenvalues.construct_circuit "qiskit.aqua.components.eigs.Eigenvalues.construct_circuit") | Construct the eigenvalue estimation quantum circuit. | -| [`construct_inverse`](qiskit.aqua.components.eigs.Eigenvalues.construct_inverse#qiskit.aqua.components.eigs.Eigenvalues.construct_inverse "qiskit.aqua.components.eigs.Eigenvalues.construct_inverse") | Construct the inverse eigenvalue estimation quantum circuit. | -| [`get_register_sizes`](qiskit.aqua.components.eigs.Eigenvalues.get_register_sizes#qiskit.aqua.components.eigs.Eigenvalues.get_register_sizes "qiskit.aqua.components.eigs.Eigenvalues.get_register_sizes") | get register sizes | -| [`get_scaling`](qiskit.aqua.components.eigs.Eigenvalues.get_scaling#qiskit.aqua.components.eigs.Eigenvalues.get_scaling "qiskit.aqua.components.eigs.Eigenvalues.get_scaling") | get scaling | +### construct\_circuit + + + +`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. + +**Parameters** + +* **mode** (*str*) – ‘matrix’ or ‘circuit’ +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – register for circuit construction where eigenvalues will be stored. + +**Returns** + +object for the eigenvalue estimation circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**NotImplementedError** – not implemented + +### construct\_inverse + + + +`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. + +**Parameters** + +* **mode** (*str*) – construction mode, ‘matrix’ not supported +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit to invert + +**Returns** + +**object for of the inverted eigenvalue estimation** + +circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **NotImplementedError** – not implemented for matrix mode +* **ValueError** – Circuit was not constructed beforehand + +### get\_register\_sizes + + + +`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 + +### get\_scaling + + + +`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 07834df4251..2e3a140aed7 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 @@ -1,14 +1,22 @@ -# EigsQPE +--- +title: EigsQPE +description: API reference for qiskit.aqua.components.eigs.EigsQPE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.eigs.EigsQPE +--- +# 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)` +`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` Eigenvalues using Quantum Phase Estimation. -Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL#qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on the [`QFT`](qiskit.circuit.library.QFT#qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") class. +Specifically, this class is based on PhaseEstimationCircuit with no measurements and has additional handling of negative eigenvalues, e.g. for [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). It depends on the [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") class. **Parameters** @@ -24,9 +32,72 @@ Specifically, this class is based on PhaseEstimationCircuit with no measurements ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.eigs.EigsQPE.construct_circuit#qiskit.aqua.components.eigs.EigsQPE.construct_circuit "qiskit.aqua.components.eigs.EigsQPE.construct_circuit") | Construct the eigenvalues estimation using the PhaseEstimationCircuit | -| [`construct_inverse`](qiskit.aqua.components.eigs.EigsQPE.construct_inverse#qiskit.aqua.components.eigs.EigsQPE.construct_inverse "qiskit.aqua.components.eigs.EigsQPE.construct_inverse") | Construct the inverse eigenvalue estimation quantum circuit. | -| [`get_register_sizes`](qiskit.aqua.components.eigs.EigsQPE.get_register_sizes#qiskit.aqua.components.eigs.EigsQPE.get_register_sizes "qiskit.aqua.components.eigs.EigsQPE.get_register_sizes") | get register sizes | -| [`get_scaling`](qiskit.aqua.components.eigs.EigsQPE.get_scaling#qiskit.aqua.components.eigs.EigsQPE.get_scaling "qiskit.aqua.components.eigs.EigsQPE.get_scaling") | get scaling | +### construct\_circuit + + + +`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 + +**Parameters** + +* **mode** (*str*) – construction mode, ‘matrix’ not supported +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the register to use for the quantum state + +**Returns** + +object for the constructed circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ValueError** – QPE is only possible as a circuit not as a matrix + +### construct\_inverse + + + +`EigsQPE.construct_inverse(mode, circuit)` + +Construct the inverse eigenvalue estimation quantum circuit. + +**Parameters** + +* **mode** (*str*) – construction mode, ‘matrix’ not supported +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit to invert + +**Returns** + +**object for of the inverted eigenvalue estimation** + +circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **NotImplementedError** – not implemented for matrix mode +* **ValueError** – Circuit was not constructed beforehand + +### get\_register\_sizes + + + +`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 + +### get\_scaling + + + +`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.eigs.md b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.md index 5e333e991a0..08fd798b64d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.eigs.md @@ -16,17 +16,17 @@ python_api_name: qiskit.aqua.components.eigs `qiskit.aqua.components.eigs` -These are components designed to find eigenvalues. They were initially designed for use by [`HHL`](qiskit.aqua.algorithms.HHL#qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL") which remains their currently principal usage. +These are components designed to find eigenvalues. They were initially designed for use by [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL") which remains their currently principal usage. # Eigenvalues Base Class -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | -| [`Eigenvalues`](qiskit.aqua.components.eigs.Eigenvalues#qiskit.aqua.components.eigs.Eigenvalues "qiskit.aqua.components.eigs.Eigenvalues") | Base class for eigenvalue estimation. | +| | | +| -------------------------------------------------------------------------------------------------- | ------------------------------------- | +| [`Eigenvalues`](qiskit.aqua.components.eigs.Eigenvalues "qiskit.aqua.components.eigs.Eigenvalues") | Base class for eigenvalue estimation. | # Eigenvalues -| | | -| -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| [`EigsQPE`](qiskit.aqua.components.eigs.EigsQPE#qiskit.aqua.components.eigs.EigsQPE "qiskit.aqua.components.eigs.EigsQPE") | Eigenvalues using Quantum Phase Estimation. | +| | | +| -------------------------------------------------------------------------------------- | ------------------------------------------- | +| [`EigsQPE`](qiskit.aqua.components.eigs.EigsQPE "qiskit.aqua.components.eigs.EigsQPE") | Eigenvalues using Quantum Phase Estimation. | 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 40e439fa021..0cbf5d6c13b 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 @@ -1,8 +1,16 @@ -# FeatureMap +--- +title: FeatureMap +description: API reference for qiskit.aqua.components.feature_maps.FeatureMap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.feature_maps.FeatureMap +--- +# FeatureMap + -`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") Bases: `abc.ABC` @@ -12,28 +20,61 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.feature_maps.FeatureMap.construct_circuit#qiskit.aqua.components.feature_maps.FeatureMap.construct_circuit "qiskit.aqua.components.feature_maps.FeatureMap.construct_circuit") | Construct the variational form, given its parameters. | -| [`get_entangler_map`](qiskit.aqua.components.feature_maps.FeatureMap.get_entangler_map#qiskit.aqua.components.feature_maps.FeatureMap.get_entangler_map "qiskit.aqua.components.feature_maps.FeatureMap.get_entangler_map") | get entangle map | -| [`validate_entangler_map`](qiskit.aqua.components.feature_maps.FeatureMap.validate_entangler_map#qiskit.aqua.components.feature_maps.FeatureMap.validate_entangler_map "qiskit.aqua.components.feature_maps.FeatureMap.validate_entangler_map") | validate entangler map | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray\[float]*) – 1-D array, data +* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the QuantumRegister object for the circuit, if None, generate new registers with name q. +* **inverse** (*bool*) – whether or not inverse the circuit + +**Returns** + +a quantum circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### get\_entangler\_map + +`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 + +### validate\_entangler\_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") + +validate entangler map + +## Attributes + + ### feature\_dimension returns feature dimension - + ### num\_qubits returns number of qubits - + ### support\_parameterized\_circuit returns whether or not the sub-class support parameterized circuit + 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 4bc73ced8b0..409c3da2478 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 @@ -1,8 +1,16 @@ -# RawFeatureVector +--- +title: RawFeatureVector +description: API reference for qiskit.aqua.components.feature_maps.RawFeatureVector +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.feature_maps.RawFeatureVector +--- +# RawFeatureVector + -`RawFeatureVector(feature_dimension=2)` +`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` @@ -16,28 +24,66 @@ The Raw Feature Vector can be directly used as a feature map, where the raw feat ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.feature_maps.RawFeatureVector.construct_circuit#qiskit.aqua.components.feature_maps.RawFeatureVector.construct_circuit "qiskit.aqua.components.feature_maps.RawFeatureVector.construct_circuit") | Construct the second order expansion based on given data. | -| [`get_entangler_map`](qiskit.aqua.components.feature_maps.RawFeatureVector.get_entangler_map#qiskit.aqua.components.feature_maps.RawFeatureVector.get_entangler_map "qiskit.aqua.components.feature_maps.RawFeatureVector.get_entangler_map") | get entangle map | -| [`validate_entangler_map`](qiskit.aqua.components.feature_maps.RawFeatureVector.validate_entangler_map#qiskit.aqua.components.feature_maps.RawFeatureVector.validate_entangler_map "qiskit.aqua.components.feature_maps.RawFeatureVector.validate_entangler_map") | validate entangler map | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – 1-D to-be-encoded data. +* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the QuantumRegister object for the circuit, if None, generate new registers with name q. +* **inverse** (*bool*) – inverse + +**Returns** + +a quantum circuit transform data x. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** +* **TypeError** – invalid input +* **ValueError** – invalid input +### get\_entangler\_map + + + +`static RawFeatureVector.get_entangler_map(map_type, num_qubits)` + +get entangle map + +### validate\_entangler\_map + + + +`static RawFeatureVector.validate_entangler_map(entangler_map, num_qubits)` + +validate entangler map + +## Attributes + + ### feature\_dimension returns feature dimension - + ### num\_qubits returns number of qubits - + ### support\_parameterized\_circuit returns whether or not the sub-class support parameterized circuit + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.md b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.md index 09fe9b5bfff..0b1085f720e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.feature_maps.md @@ -26,13 +26,13 @@ The process of determining a subset of the initial features is called **feature # Feature Map Base Class -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | -| [`FeatureMap`](qiskit.aqua.components.feature_maps.FeatureMap#qiskit.aqua.components.feature_maps.FeatureMap "qiskit.aqua.components.feature_maps.FeatureMap") | Base class for FeatureMap. | +| | | +| --------------------------------------------------------------------------------------------------------------- | -------------------------- | +| [`FeatureMap`](qiskit.aqua.components.feature_maps.FeatureMap "qiskit.aqua.components.feature_maps.FeatureMap") | Base class for FeatureMap. | # Feature Maps -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`RawFeatureVector`](qiskit.aqua.components.feature_maps.RawFeatureVector#qiskit.aqua.components.feature_maps.RawFeatureVector "qiskit.aqua.components.feature_maps.RawFeatureVector") | Raw Feature Vector feature map. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | +| [`RawFeatureVector`](qiskit.aqua.components.feature_maps.RawFeatureVector "qiskit.aqua.components.feature_maps.RawFeatureVector") | Raw Feature Vector feature map. | 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 ed360190e4c..4517c472243 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 @@ -1,8 +1,16 @@ -# Custom +--- +title: Custom +description: API reference for qiskit.aqua.components.initial_states.Custom +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.initial_states.Custom +--- +# Custom + -`Custom(num_qubits, state='zero', state_vector=None, circuit=None)` +`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` @@ -12,7 +20,7 @@ A custom initial state can be created with this component. It allows a state to Also *state* can be used having a few pre-defined initial states for convenience: -* ‘zero’: configures the state vector with the zero probability distribution, and is effectively equivalent to the [`Zero`](qiskit.aqua.components.initial_states.Zero#qiskit.aqua.components.initial_states.Zero "qiskit.aqua.components.initial_states.Zero") initial state. +* ‘zero’: configures the state vector with the zero probability distribution, and is effectively equivalent to the [`Zero`](qiskit.aqua.components.initial_states.Zero "qiskit.aqua.components.initial_states.Zero") initial state. * ‘uniform’: This setting configures the state vector with the uniform probability distribution. All the qubits are set in superposition, each of them being initialized with a Hadamard gate, which means that a measurement will have equal probabilities to become $1$ or $0$. * ‘random’: This setting assigns the elements of the state vector according to a random probability distribution. @@ -27,16 +35,38 @@ The custom initial state will be set from the *circuit*, the *state\_vector*, or **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – invalid input ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.initial_states.Custom.construct_circuit#qiskit.aqua.components.initial_states.Custom.construct_circuit "qiskit.aqua.components.initial_states.Custom.construct_circuit") | Construct the statevector of desired initial state. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **mode** – vector or circuit. The vector mode produces the vector. While the circuit constructs the quantum circuit corresponding that vector. +* **register** – qubits for circuit construction. + +**Returns** +statevector. +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or numpy.ndarray + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – when mode is not ‘vector’ or ‘circuit’. + +## Attributes + + ### bitstr + 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 a0f590e153d..c73507555a2 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 @@ -1,8 +1,16 @@ -# InitialState +--- +title: InitialState +description: API reference for qiskit.aqua.components.initial_states.InitialState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.initial_states.InitialState +--- +# InitialState + -`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") Bases: `abc.ABC` @@ -12,12 +20,34 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.initial_states.InitialState.construct_circuit#qiskit.aqua.components.initial_states.InitialState.construct_circuit "qiskit.aqua.components.initial_states.InitialState.construct_circuit") | Construct the statevector of desired initial state. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **mode** (`str`) – vector or circuit. The vector mode produces the vector. While the circuit constructs the quantum circuit corresponding that vector. +* **register** (`Optional`\[`QuantumRegister`]) – qubits for circuit construction. + +**Returns** +statevector. +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or numpy.ndarray + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – when mode is not ‘vector’ or ‘circuit’. + +## Attributes + + ### bitstr + 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 2898792bd43..e35c15f2541 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 @@ -1,16 +1,24 @@ -# VarFormBased +--- +title: VarFormBased +description: API reference for qiskit.aqua.components.initial_states.VarFormBased +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.initial_states.VarFormBased +--- +# VarFormBased + -`VarFormBased(var_form, params)` +`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` The variational form based initial state. -This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm#qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. +This can been useful, say for example, if you have been doing experiments using a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") and have parameters for a state of interest of that form. Using this class it can then be turned into an initial state for use elsewhere. -As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutorials/blob/master/aqua/vqe2iqpe.ipynb) shows where the variational form’s state, from a [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") run, is then used as an initial state for [`IQPE`](qiskit.aqua.algorithms.IQPE#qiskit.aqua.algorithms.IQPE "qiskit.aqua.algorithms.IQPE") by using this class. +As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutorials/blob/master/aqua/vqe2iqpe.ipynb) shows where the variational form’s state, from a [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") run, is then used as an initial state for [`IQPE`](qiskit.aqua.algorithms.IQPE "qiskit.aqua.algorithms.IQPE") by using this class. **Parameters** @@ -23,6 +31,29 @@ As an example this [notebook](https://github.com/Qiskit/qiskit-community-tutoria ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.initial_states.VarFormBased.construct_circuit#qiskit.aqua.components.initial_states.VarFormBased.construct_circuit "qiskit.aqua.components.initial_states.VarFormBased.construct_circuit") | Construct the statevector of desired initial state. | +### construct\_circuit + + + +`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. + +**Parameters** + +* **mode** (*string*) – vector or circuit. The vector mode produces the vector. While the circuit constructs the quantum circuit corresponding that vector. +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – qubits for circuit construction. + +**Returns** + +statevector. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or numpy.ndarray + +**Raises** + +* **RuntimeError** – invalid input for mode +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – when mode is not ‘vector’ or ‘circuit’. + 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 d3444b93ee1..2e66ab01606 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 @@ -1,8 +1,16 @@ -# Zero +--- +title: Zero +description: API reference for qiskit.aqua.components.initial_states.Zero +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.initial_states.Zero +--- +# Zero + -`Zero(num_qubits)` +`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` @@ -16,12 +24,34 @@ This is suitable for those situations in which the all-zeros state is the desire ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.initial_states.Zero.construct_circuit#qiskit.aqua.components.initial_states.Zero.construct_circuit "qiskit.aqua.components.initial_states.Zero.construct_circuit") | Construct the statevector of desired initial state. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **mode** – vector or circuit. The vector mode produces the vector. While the circuit constructs the quantum circuit corresponding that vector. +* **register** – qubits for circuit construction. +**Returns** +statevector. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or numpy.ndarray + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – when mode is not ‘vector’ or ‘circuit’. + +## Attributes + + ### bitstr + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.md b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.md index 856d783037e..93d8d808520 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.initial_states.md @@ -16,21 +16,21 @@ python_api_name: qiskit.aqua.components.initial_states `qiskit.aqua.components.initial_states` -Initial states are a fixed quantum state. These can be used, for example, to define a starting state for [`variational_forms`](qiskit.aqua.components.variational_forms#module-qiskit.aqua.components.variational_forms "qiskit.aqua.components.variational_forms"), such as when used with [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"), or to define a starting state for the evolution in algorithms such as [`QPE`](qiskit.aqua.algorithms.QPE#qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE") and [`IQPE`](qiskit.aqua.algorithms.IQPE#qiskit.aqua.algorithms.IQPE "qiskit.aqua.algorithms.IQPE"). +Initial states are a fixed quantum state. These can be used, for example, to define a starting state for [`variational_forms`](qiskit.aqua.components.variational_forms#module-qiskit.aqua.components.variational_forms "qiskit.aqua.components.variational_forms"), such as when used with [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"), or to define a starting state for the evolution in algorithms such as [`QPE`](qiskit.aqua.algorithms.QPE "qiskit.aqua.algorithms.QPE") and [`IQPE`](qiskit.aqua.algorithms.IQPE "qiskit.aqua.algorithms.IQPE"). -If you have a specific quantum circuit you would like to use as an initial state, and do not want to make a new class derived from [`InitialState`](qiskit.aqua.components.initial_states.InitialState#qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") to use it, this can be especially so if the circuit is fixed, then see [`Custom`](qiskit.aqua.components.initial_states.Custom#qiskit.aqua.components.initial_states.Custom "qiskit.aqua.components.initial_states.Custom") which allows it to be used as an [`InitialState`](qiskit.aqua.components.initial_states.InitialState#qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") for algorithms and components that expect this as a type. +If you have a specific quantum circuit you would like to use as an initial state, and do not want to make a new class derived from [`InitialState`](qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") to use it, this can be especially so if the circuit is fixed, then see [`Custom`](qiskit.aqua.components.initial_states.Custom "qiskit.aqua.components.initial_states.Custom") which allows it to be used as an [`InitialState`](qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") for algorithms and components that expect this as a type. # Initial State Base Class -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`InitialState`](qiskit.aqua.components.initial_states.InitialState#qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") | Base class for InitialState. | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| [`InitialState`](qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState") | Base class for InitialState. | # Initial States -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`Custom`](qiskit.aqua.components.initial_states.Custom#qiskit.aqua.components.initial_states.Custom "qiskit.aqua.components.initial_states.Custom") | The custom initial state. | -| [`VarFormBased`](qiskit.aqua.components.initial_states.VarFormBased#qiskit.aqua.components.initial_states.VarFormBased "qiskit.aqua.components.initial_states.VarFormBased") | The variational form based initial state. | -| [`Zero`](qiskit.aqua.components.initial_states.Zero#qiskit.aqua.components.initial_states.Zero "qiskit.aqua.components.initial_states.Zero") | The zero (null/vacuum) state. | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| [`Custom`](qiskit.aqua.components.initial_states.Custom "qiskit.aqua.components.initial_states.Custom") | The custom initial state. | +| [`VarFormBased`](qiskit.aqua.components.initial_states.VarFormBased "qiskit.aqua.components.initial_states.VarFormBased") | The variational form based initial state. | +| [`Zero`](qiskit.aqua.components.initial_states.Zero "qiskit.aqua.components.initial_states.Zero") | The zero (null/vacuum) state. | diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.md b/docs/api/qiskit/0.32/qiskit.aqua.components.md index f781ca1f910..5a3ca5bc6a1 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.md @@ -16,11 +16,11 @@ python_api_name: qiskit.aqua.components `qiskit.aqua.components` -Components were designed to be swappable sub-parts of an algorithm. Different implementations of a component type can thereby be exchanged to potentially alter the behavior and outcome of the algorithm. For example [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") takes an [`Optimizer`](qiskit.aqua.components.optimizers.Optimizer#qiskit.aqua.components.optimizers.Optimizer "qiskit.aqua.components.optimizers.Optimizer") and a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm#qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") components. There are a selection of both different [`optimizers`](qiskit.aqua.components.optimizers#module-qiskit.aqua.components.optimizers "qiskit.aqua.components.optimizers") and [`variational_forms`](qiskit.aqua.components.variational_forms#module-qiskit.aqua.components.variational_forms "qiskit.aqua.components.variational_forms") that can be chosen from according the nature of the problem. Some optimizers use gradients, others have alternative techniques to finding a minimum. Variational forms include heuristic ansatzes such as [`EfficientSU2`](qiskit.circuit.library.EfficientSU2#qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2") and types designed for specific problems such as [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD#qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") for chemistry and ground state energy computation. +Components were designed to be swappable sub-parts of an algorithm. Different implementations of a component type can thereby be exchanged to potentially alter the behavior and outcome of the algorithm. For example [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE") takes an [`Optimizer`](qiskit.aqua.components.optimizers.Optimizer "qiskit.aqua.components.optimizers.Optimizer") and a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") components. There are a selection of both different [`optimizers`](qiskit.aqua.components.optimizers#module-qiskit.aqua.components.optimizers "qiskit.aqua.components.optimizers") and [`variational_forms`](qiskit.aqua.components.variational_forms#module-qiskit.aqua.components.variational_forms "qiskit.aqua.components.variational_forms") that can be chosen from according the nature of the problem. Some optimizers use gradients, others have alternative techniques to finding a minimum. Variational forms include heuristic ansatzes such as [`EfficientSU2`](qiskit.circuit.library.EfficientSU2 "qiskit.circuit.library.EfficientSU2") and types designed for specific problems such as [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") for chemistry and ground state energy computation. -Components may also be used in other components. For example the [`UnivariateVariationalDistribution`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution") takes a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm#qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm"). +Components may also be used in other components. For example the [`UnivariateVariationalDistribution`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution") takes a [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm"). -Each type of component has a base class that can be extended to provide a new implementation. For example the base class for [`variational_forms`](qiskit.aqua.components.variational_forms#module-qiskit.aqua.components.variational_forms "qiskit.aqua.components.variational_forms") is [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm#qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm"). For more information refer to the component type of interest below. +Each type of component has a base class that can be extended to provide a new implementation. For example the base class for [`variational_forms`](qiskit.aqua.components.variational_forms#module-qiskit.aqua.components.variational_forms "qiskit.aqua.components.variational_forms") is [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm"). For more information refer to the component type of interest below. # Submodules 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 d176a76874c..4e56d2102d5 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 @@ -1,8 +1,16 @@ -# AllPairs +--- +title: AllPairs +description: API reference for qiskit.aqua.components.multiclass_extensions.AllPairs +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.multiclass_extensions.AllPairs +--- +# AllPairs + -`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") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -12,9 +20,73 @@ In the **all-pairs** reduction, one trains $k(k−1)/2$ binary classifiers for a ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`predict`](qiskit.aqua.components.multiclass_extensions.AllPairs.predict#qiskit.aqua.components.multiclass_extensions.AllPairs.predict "qiskit.aqua.components.multiclass_extensions.AllPairs.predict") | Applying multiple estimators for prediction. | -| [`set_estimator`](qiskit.aqua.components.multiclass_extensions.AllPairs.set_estimator#qiskit.aqua.components.multiclass_extensions.AllPairs.set_estimator "qiskit.aqua.components.multiclass_extensions.AllPairs.set_estimator") | 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 | -| [`test`](qiskit.aqua.components.multiclass_extensions.AllPairs.test#qiskit.aqua.components.multiclass_extensions.AllPairs.test "qiskit.aqua.components.multiclass_extensions.AllPairs.test") | Testing multiple estimators each for distinguishing a pair of classes. | -| [`train`](qiskit.aqua.components.multiclass_extensions.AllPairs.train#qiskit.aqua.components.multiclass_extensions.AllPairs.train "qiskit.aqua.components.multiclass_extensions.AllPairs.train") | Training multiple estimators each for distinguishing a pair of classes. | +### predict + + + +`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. + +**Parameters** + +**x** (*numpy.ndarray*) – NxD array + +**Returns** + +predicted labels, Nx1 array + +**Return type** + +numpy.ndarray + +### set\_estimator + + + +`AllPairs.set_estimator(estimator_cls, params=None)` + +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 + +**Return type** + +`None` + +### test + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + +**Returns** + +accuracy + +**Return type** + +float + +### train + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + +**Raises** + +**ValueError** – can not be fit when only one class is present. + 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 f34b561798c..603a21c221f 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 @@ -1,8 +1,16 @@ -# ErrorCorrectingCode +--- +title: ErrorCorrectingCode +description: API reference for qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode +--- +# ErrorCorrectingCode + -`ErrorCorrectingCode(code_size=4)` +`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` @@ -26,9 +34,69 @@ The table above shows a 6-bit ECC for a 3-class problem. Each class is assigned ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`predict`](qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.predict#qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.predict "qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.predict") | Applying multiple estimators for prediction. | -| [`set_estimator`](qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.set_estimator#qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.set_estimator "qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.set_estimator") | 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 | -| [`test`](qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.test#qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.test "qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.test") | Testing multiple estimators each for distinguishing a pair of classes. | -| [`train`](qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.train#qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.train "qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode.train") | Training multiple estimators each for distinguishing a pair of classes. | +### predict + + + +`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. + +**Parameters** + +**x** (*numpy.ndarray*) – NxD array + +**Returns** + +predicted labels, Nx1 array + +**Return type** + +numpy.ndarray + +### set\_estimator + + + +`ErrorCorrectingCode.set_estimator(estimator_cls, params=None)` + +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 + +**Return type** + +`None` + +### test + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + +**Returns** + +accuracy + +**Return type** + +float + +### train + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + 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 d6709ab9889..4e5bfee3b20 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 @@ -1,8 +1,16 @@ -# MulticlassExtension +--- +title: MulticlassExtension +description: API reference for qiskit.aqua.components.multiclass_extensions.MulticlassExtension +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.multiclass_extensions.MulticlassExtension +--- +# MulticlassExtension + -`MulticlassExtension` +`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` @@ -12,9 +20,53 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`predict`](qiskit.aqua.components.multiclass_extensions.MulticlassExtension.predict#qiskit.aqua.components.multiclass_extensions.MulticlassExtension.predict "qiskit.aqua.components.multiclass_extensions.MulticlassExtension.predict") | Applying multiple estimators for prediction. | -| [`set_estimator`](qiskit.aqua.components.multiclass_extensions.MulticlassExtension.set_estimator#qiskit.aqua.components.multiclass_extensions.MulticlassExtension.set_estimator "qiskit.aqua.components.multiclass_extensions.MulticlassExtension.set_estimator") | 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 | -| [`test`](qiskit.aqua.components.multiclass_extensions.MulticlassExtension.test#qiskit.aqua.components.multiclass_extensions.MulticlassExtension.test "qiskit.aqua.components.multiclass_extensions.MulticlassExtension.test") | Testing multiple estimators each for distinguishing a pair of classes. | -| [`train`](qiskit.aqua.components.multiclass_extensions.MulticlassExtension.train#qiskit.aqua.components.multiclass_extensions.MulticlassExtension.train "qiskit.aqua.components.multiclass_extensions.MulticlassExtension.train") | Training multiple estimators each for distinguishing a pair of classes. | +### predict + + + +`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. + +**Parameters** + +**x** (*numpy.ndarray*) – input points + +### set\_estimator + + + +`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 + +**Return type** + +`None` + +### test + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + +### train + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + 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 a332c1a1a5c..99912cbdeaa 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 @@ -1,8 +1,16 @@ -# OneAgainstRest +--- +title: OneAgainstRest +description: API reference for qiskit.aqua.components.multiclass_extensions.OneAgainstRest +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.multiclass_extensions.OneAgainstRest +--- +# OneAgainstRest + -`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") Bases: `qiskit.aqua.components.multiclass_extensions.multiclass_extension.MulticlassExtension` @@ -12,9 +20,73 @@ For an $n$-class problem, the **one-against-rest** method constructs $n$ SVM cla ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`predict`](qiskit.aqua.components.multiclass_extensions.OneAgainstRest.predict#qiskit.aqua.components.multiclass_extensions.OneAgainstRest.predict "qiskit.aqua.components.multiclass_extensions.OneAgainstRest.predict") | Applying multiple estimators for prediction. | -| [`set_estimator`](qiskit.aqua.components.multiclass_extensions.OneAgainstRest.set_estimator#qiskit.aqua.components.multiclass_extensions.OneAgainstRest.set_estimator "qiskit.aqua.components.multiclass_extensions.OneAgainstRest.set_estimator") | 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 | -| [`test`](qiskit.aqua.components.multiclass_extensions.OneAgainstRest.test#qiskit.aqua.components.multiclass_extensions.OneAgainstRest.test "qiskit.aqua.components.multiclass_extensions.OneAgainstRest.test") | Testing multiple estimators each for distinguishing a pair of classes. | -| [`train`](qiskit.aqua.components.multiclass_extensions.OneAgainstRest.train#qiskit.aqua.components.multiclass_extensions.OneAgainstRest.train "qiskit.aqua.components.multiclass_extensions.OneAgainstRest.train") | Training multiple estimators each for distinguishing a pair of classes. | +### predict + + + +`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. + +**Parameters** + +**x** (*numpy.ndarray*) – NxD array + +**Returns** + +predicted labels, Nx1 array + +**Return type** + +numpy.ndarray + +### set\_estimator + + + +`OneAgainstRest.set_estimator(estimator_cls, params=None)` + +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 + +**Return type** + +`None` + +### test + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + +**Returns** + +accuracy + +**Return type** + +float + +### train + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – input points +* **y** (*numpy.ndarray*) – input labels + +**Raises** + +**Exception** – given all data points are assigned to the same class, the prediction would be boring + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.md b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.md index 7c34c65c6d8..bfc4e7741a9 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.multiclass_extensions.md @@ -16,21 +16,21 @@ python_api_name: qiskit.aqua.components.multiclass_extensions `qiskit.aqua.components.multiclass_extensions` -A multiclass extension allows Aqua’s binary classifier algorithms, such as [`QSVM`](qiskit.aqua.algorithms.QSVM#qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM") and [`SklearnSVM`](qiskit.aqua.algorithms.SklearnSVM#qiskit.aqua.algorithms.SklearnSVM "qiskit.aqua.algorithms.SklearnSVM") to handle more than two classes and do [multiclass classification](https://en.wikipedia.org/wiki/Multiclass_classification). +A multiclass extension allows Aqua’s binary classifier algorithms, such as [`QSVM`](qiskit.aqua.algorithms.QSVM "qiskit.aqua.algorithms.QSVM") and [`SklearnSVM`](qiskit.aqua.algorithms.SklearnSVM "qiskit.aqua.algorithms.SklearnSVM") to handle more than two classes and do [multiclass classification](https://en.wikipedia.org/wiki/Multiclass_classification). The multiclass extensions use different techniques to perform multiclass classification using the underlying binary classifier. # Multiclass Extension Base Class -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`MulticlassExtension`](qiskit.aqua.components.multiclass_extensions.MulticlassExtension#qiskit.aqua.components.multiclass_extensions.MulticlassExtension "qiskit.aqua.components.multiclass_extensions.MulticlassExtension") | Base class for multiclass extension. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------ | +| [`MulticlassExtension`](qiskit.aqua.components.multiclass_extensions.MulticlassExtension "qiskit.aqua.components.multiclass_extensions.MulticlassExtension") | Base class for multiclass extension. | # Multiclass Extensions -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| [`AllPairs`](qiskit.aqua.components.multiclass_extensions.AllPairs#qiskit.aqua.components.multiclass_extensions.AllPairs "qiskit.aqua.components.multiclass_extensions.AllPairs") | The All-Pairs multiclass extension. | -| [`OneAgainstRest`](qiskit.aqua.components.multiclass_extensions.OneAgainstRest#qiskit.aqua.components.multiclass_extensions.OneAgainstRest "qiskit.aqua.components.multiclass_extensions.OneAgainstRest") | The One Against Rest multiclass extension. | -| [`ErrorCorrectingCode`](qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode#qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode "qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode") | The Error Correcting Code multiclass extension. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | +| [`AllPairs`](qiskit.aqua.components.multiclass_extensions.AllPairs "qiskit.aqua.components.multiclass_extensions.AllPairs") | The All-Pairs multiclass extension. | +| [`OneAgainstRest`](qiskit.aqua.components.multiclass_extensions.OneAgainstRest "qiskit.aqua.components.multiclass_extensions.OneAgainstRest") | The One Against Rest multiclass extension. | +| [`ErrorCorrectingCode`](qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode "qiskit.aqua.components.multiclass_extensions.ErrorCorrectingCode") | The Error Correcting Code multiclass extension. | 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 05c3edfe48d..8598a8a962c 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 @@ -1,8 +1,16 @@ -# DiscriminativeNetwork +--- +title: DiscriminativeNetwork +description: API reference for qiskit.aqua.components.neural_networks.DiscriminativeNetwork +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.neural_networks.DiscriminativeNetwork +--- +# DiscriminativeNetwork + -`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") Bases: `abc.ABC` @@ -12,10 +20,101 @@ This method should initialize the module but raise an exception if a required co ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [`get_label`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork.get_label#qiskit.aqua.components.neural_networks.DiscriminativeNetwork.get_label "qiskit.aqua.components.neural_networks.DiscriminativeNetwork.get_label") | Apply quantum/classical neural network to the given input sample and compute the respective data label | -| [`loss`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork.loss#qiskit.aqua.components.neural_networks.DiscriminativeNetwork.loss "qiskit.aqua.components.neural_networks.DiscriminativeNetwork.loss") | Loss function used for optimization | -| [`save_model`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork.save_model#qiskit.aqua.components.neural_networks.DiscriminativeNetwork.save_model "qiskit.aqua.components.neural_networks.DiscriminativeNetwork.save_model") | Save discriminator model | -| [`set_seed`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork.set_seed#qiskit.aqua.components.neural_networks.DiscriminativeNetwork.set_seed "qiskit.aqua.components.neural_networks.DiscriminativeNetwork.set_seed") | Set seed. | -| [`train`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork.train#qiskit.aqua.components.neural_networks.DiscriminativeNetwork.train "qiskit.aqua.components.neural_networks.DiscriminativeNetwork.train") | Perform one training step w\.r.t to the discriminator’s parameters | +### get\_label + + + +`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 + +**Parameters** + +**x** (*Discriminator*) – input, i.e. data sample. + +**Raises** + +**NotImplementedError** – not implemented + +### loss + + + +`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 + +**Parameters** + +* **x** (`Iterable`) – output. +* **y** (`Iterable`) – the data point +* **weights** (`Optional`\[`ndarray`]) – Data weights. + +**Returns** + +Loss w\.r.t to the generated data points. + +**Raises** + +**NotImplementedError** – not implemented + +### save\_model + + + +`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 + +**Parameters** + +**snapshot\_dir** (`str`) – Directory to save the model + +**Raises** + +**NotImplementedError** – not implemented + +### set\_seed + + + +`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. + +**Parameters** + +**seed** (*int*) – seed + +**Raises** + +**NotImplementedError** – not implemented + +### train + + + +`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 + +**Parameters** + +* **data** (`Iterable`) – Data batch. +* **weights** (`Iterable`) – Data sample weights. +* **penalty** (`bool`) – Indicate whether or not penalty function is applied to the loss function. Ignored if no penalty function defined. +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – used to run Quantum network. Ignored for a classical network. +* **shots** (`Optional`\[`int`]) – Number of shots for hardware or qasm execution. Ignored for classical network + +**Returns** + +with discriminator loss and updated parameters. + +**Return type** + +dict + +**Raises** + +**NotImplementedError** – not implemented + 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 eb9f9e54e69..87525ae962a 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 @@ -1,8 +1,16 @@ -# GenerativeNetwork +--- +title: GenerativeNetwork +description: API reference for qiskit.aqua.components.neural_networks.GenerativeNetwork +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.neural_networks.GenerativeNetwork +--- +# GenerativeNetwork + -`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") Bases: `abc.ABC` @@ -12,17 +20,96 @@ This method should initialize the module, but raise an exception if a required c ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`get_output`](qiskit.aqua.components.neural_networks.GenerativeNetwork.get_output#qiskit.aqua.components.neural_networks.GenerativeNetwork.get_output "qiskit.aqua.components.neural_networks.GenerativeNetwork.get_output") | Apply quantum/classical neural network to given input and get the respective output | -| [`loss`](qiskit.aqua.components.neural_networks.GenerativeNetwork.loss#qiskit.aqua.components.neural_networks.GenerativeNetwork.loss "qiskit.aqua.components.neural_networks.GenerativeNetwork.loss") | Loss function used for optimization | -| [`set_discriminator`](qiskit.aqua.components.neural_networks.GenerativeNetwork.set_discriminator#qiskit.aqua.components.neural_networks.GenerativeNetwork.set_discriminator "qiskit.aqua.components.neural_networks.GenerativeNetwork.set_discriminator") | Set discriminator network. | -| [`set_seed`](qiskit.aqua.components.neural_networks.GenerativeNetwork.set_seed#qiskit.aqua.components.neural_networks.GenerativeNetwork.set_seed "qiskit.aqua.components.neural_networks.GenerativeNetwork.set_seed") | Set seed. | -| [`train`](qiskit.aqua.components.neural_networks.GenerativeNetwork.train#qiskit.aqua.components.neural_networks.GenerativeNetwork.train "qiskit.aqua.components.neural_networks.GenerativeNetwork.train") | Perform one training step w\.r.t to the generator’s parameters | +### get\_output -## Attributes + + +`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 + +**Parameters** + +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – Quantum Instance, used to run the generator circuit. +* **params** (*numpy.ndarray*) – parameters which should be used to run the generator, if None use self.\_params +* **shots** (*int*) – if not None use a number of shots that is different from the number set in quantum\_instance + +**Returns** + +Neural network output + +**Raises** + +**NotImplementedError** – not implemented + +### loss + + + +`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 + +### set\_discriminator + + + +`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. + +**Parameters** + +**discriminator** (*Discriminator*) – Discriminator used to compute the loss function. + +**Raises** + +**NotImplementedError** – not implemented +### set\_seed + + +`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. + +**Parameters** + +**seed** (*int*) – seed + +**Raises** + +**NotImplementedError** – not implemented + +### train + + + +`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 + +**Parameters** + +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – used to run generator network. Ignored for a classical network. +* **shots** (*int*) – Number of shots for hardware or qasm execution. Ignored for classical network + +**Returns** + +generator loss and updated parameters. + +**Return type** + +dict + +**Raises** + +**NotImplementedError** – not implemented + +## Attributes + + ### parameter\_values @@ -31,3 +118,4 @@ Get parameter values from the generator **Raises** **NotImplementedError** – not implemented + 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 c2206ea44f2..508e3037633 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 @@ -1,8 +1,16 @@ -# NumPyDiscriminator +--- +title: NumPyDiscriminator +description: API reference for qiskit.aqua.components.neural_networks.NumPyDiscriminator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.neural_networks.NumPyDiscriminator +--- +# NumPyDiscriminator + -`NumPyDiscriminator(n_features=1, n_out=1)` +`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` @@ -15,18 +23,102 @@ Discriminator based on NumPy ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`get_label`](qiskit.aqua.components.neural_networks.NumPyDiscriminator.get_label#qiskit.aqua.components.neural_networks.NumPyDiscriminator.get_label "qiskit.aqua.components.neural_networks.NumPyDiscriminator.get_label") | Get data sample labels, i.e. true or fake. | -| [`load_model`](qiskit.aqua.components.neural_networks.NumPyDiscriminator.load_model#qiskit.aqua.components.neural_networks.NumPyDiscriminator.load_model "qiskit.aqua.components.neural_networks.NumPyDiscriminator.load_model") | Load discriminator model | -| [`loss`](qiskit.aqua.components.neural_networks.NumPyDiscriminator.loss#qiskit.aqua.components.neural_networks.NumPyDiscriminator.loss "qiskit.aqua.components.neural_networks.NumPyDiscriminator.loss") | 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 | -| [`save_model`](qiskit.aqua.components.neural_networks.NumPyDiscriminator.save_model#qiskit.aqua.components.neural_networks.NumPyDiscriminator.save_model "qiskit.aqua.components.neural_networks.NumPyDiscriminator.save_model") | Save discriminator model | -| [`set_seed`](qiskit.aqua.components.neural_networks.NumPyDiscriminator.set_seed#qiskit.aqua.components.neural_networks.NumPyDiscriminator.set_seed "qiskit.aqua.components.neural_networks.NumPyDiscriminator.set_seed") | Set seed. | -| [`train`](qiskit.aqua.components.neural_networks.NumPyDiscriminator.train#qiskit.aqua.components.neural_networks.NumPyDiscriminator.train "qiskit.aqua.components.neural_networks.NumPyDiscriminator.train") | Perform one training step w\.r.t to the discriminator’s parameters | +### get\_label -## Attributes + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – Discriminator input, i.e. data sample. +* **detach** (*bool*) – depreciated for numpy network + +**Returns** + +Discriminator output, i.e. data label + +**Return type** + +numpy.ndarray + +### load\_model + + +`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 + +**Parameters** + +**load\_dir** (*str*) – file with stored pytorch discriminator model to be loaded + +### loss + + + +`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 + +**Returns** + +loss function + +**Return type** +float + +### save\_model + + + +`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 + +**Parameters** + +**snapshot\_dir** (*str*) – directory path for saving the model + +### set\_seed + + + +`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 + +### train + + + +`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 + +**Parameters** + +* **data** (*tuple(numpy.ndarray, numpy.ndarray)*) – real\_batch: array, Training data batch. generated\_batch: array, Generated data batch. +* **weights** (*tuple*) – real problem, generated problem +* **penalty** (*bool*) – Depreciated for classical networks. +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – Depreciated for classical networks. +* **shots** (*int*) – Number of shots for hardware or qasm execution. Ignored for classical networks. + +**Returns** + +with Discriminator loss and updated parameters. + +**Return type** + +dict + +## Attributes + + ### discriminator\_net @@ -39,3 +131,4 @@ discriminator object **Return type** DiscriminatorNet + 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 831b61c55d6..914d5fad9e0 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 @@ -1,8 +1,16 @@ -# PyTorchDiscriminator +--- +title: PyTorchDiscriminator +description: API reference for qiskit.aqua.components.neural_networks.PyTorchDiscriminator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.neural_networks.PyTorchDiscriminator +--- +# PyTorchDiscriminator + -`PyTorchDiscriminator(n_features=1, n_out=1)` +`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` @@ -15,23 +23,141 @@ Discriminator based on PyTorch **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Pytorch not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Pytorch not installed ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`get_label`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator.get_label#qiskit.aqua.components.neural_networks.PyTorchDiscriminator.get_label "qiskit.aqua.components.neural_networks.PyTorchDiscriminator.get_label") | Get data sample labels, i.e. true or fake. | -| [`gradient_penalty`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator.gradient_penalty#qiskit.aqua.components.neural_networks.PyTorchDiscriminator.gradient_penalty "qiskit.aqua.components.neural_networks.PyTorchDiscriminator.gradient_penalty") | Compute gradient penalty for discriminator optimization | -| [`load_model`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator.load_model#qiskit.aqua.components.neural_networks.PyTorchDiscriminator.load_model "qiskit.aqua.components.neural_networks.PyTorchDiscriminator.load_model") | Load discriminator model | -| [`loss`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator.loss#qiskit.aqua.components.neural_networks.PyTorchDiscriminator.loss "qiskit.aqua.components.neural_networks.PyTorchDiscriminator.loss") | Loss function | -| [`save_model`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator.save_model#qiskit.aqua.components.neural_networks.PyTorchDiscriminator.save_model "qiskit.aqua.components.neural_networks.PyTorchDiscriminator.save_model") | Save discriminator model | -| [`set_seed`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator.set_seed#qiskit.aqua.components.neural_networks.PyTorchDiscriminator.set_seed "qiskit.aqua.components.neural_networks.PyTorchDiscriminator.set_seed") | Set seed. | -| [`train`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator.train#qiskit.aqua.components.neural_networks.PyTorchDiscriminator.train "qiskit.aqua.components.neural_networks.PyTorchDiscriminator.train") | Perform one training step w\.r.t to the discriminator’s parameters | +### get\_label -## Attributes + + +`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. + +**Parameters** + +* **x** (*Union(numpy.ndarray, torch.Tensor)*) – Discriminator input, i.e. data sample. +* **detach** (*bool*) – if None detach from torch tensor variable (optional) + +**Returns** + +Discriminator output, i.e. data label + +**Return type** + +torch.Tensor + +### gradient\_penalty + + + +`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 + +**Parameters** +* **x** (*numpy.ndarray*) – Generated data sample. +* **lambda** (*float*) – Gradient penalty coefficient 1. +* **k** (*float*) – Gradient penalty coefficient 2. +* **c** (*float*) – Gradient penalty coefficient 3. + +**Returns** + +Gradient penalty. + +**Return type** + +torch.Tensor + +### load\_model + + + +`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 + +**Parameters** + +**load\_dir** (`str`) – file with stored pytorch discriminator model to be loaded + +### loss + + + +`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 + +**Parameters** +* **x** (*torch.Tensor*) – Discriminator output. +* **y** (*torch.Tensor*) – Label of the data point +* **weights** (*torch.Tensor*) – Data weights. + +**Returns** + +Loss w\.r.t to the generated data points. + +**Return type** + +torch.Tensor + +### save\_model + + + +`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 + +**Parameters** + +**snapshot\_dir** (`str`) – directory path for saving the model + +### set\_seed + + + +`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. + +**Parameters** + +**seed** (`int`) – seed + +### train + + + +`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 + +**Parameters** + +* **data** (`Iterable`) – Data batch. +* **weights** (`Iterable`) – Data sample weights. +* **penalty** (`bool`) – Indicate whether or not penalty function is applied to the loss function. Ignored if no penalty function defined. +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – used to run Quantum network. Ignored for a classical network. +* **shots** (`Optional`\[`int`]) – Number of shots for hardware or qasm execution. Ignored for classical network + +**Returns** + +**with discriminator loss and updated parameters.data, weights, penalty=True,** + +quantum\_instance=None, shots=None) -> Dict\[str, Any]: + +**Return type** + +dict + +## Attributes + + ### discriminator\_net @@ -44,3 +170,4 @@ discriminator object **Return type** object + 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 16bb20a6bc3..11da90e6808 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 @@ -1,14 +1,22 @@ -# QuantumGenerator +--- +title: QuantumGenerator +description: API reference for qiskit.aqua.components.neural_networks.QuantumGenerator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.neural_networks.QuantumGenerator +--- +# QuantumGenerator + -`QuantumGenerator(bounds, num_qubits, generator_circuit=None, init_params=None, optimizer=None, gradient_function=None, snapshot_dir=None)` +`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` Quantum Generator. -The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN#qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. +The quantum generator is a parametrized quantum circuit which can be trained with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm to generate a quantum state which approximates the probability distribution of given training data. At the beginning of the training the parameters will be set randomly, thus, the output will is random. Throughout the training the quantum generator learns to represent the target distribution. Eventually, the trained generator can be used for state preparation e.g. in QAE. **Parameters** @@ -22,22 +30,129 @@ The quantum generator is a parametrized quantum circuit which can be trained wit **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Set multivariate variational distribution to represent multivariate data +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Set multivariate variational distribution to represent multivariate data ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.neural_networks.QuantumGenerator.construct_circuit#qiskit.aqua.components.neural_networks.QuantumGenerator.construct_circuit "qiskit.aqua.components.neural_networks.QuantumGenerator.construct_circuit") | Construct generator circuit. | -| [`get_output`](qiskit.aqua.components.neural_networks.QuantumGenerator.get_output#qiskit.aqua.components.neural_networks.QuantumGenerator.get_output "qiskit.aqua.components.neural_networks.QuantumGenerator.get_output") | Get classical data samples from the generator. | -| [`loss`](qiskit.aqua.components.neural_networks.QuantumGenerator.loss#qiskit.aqua.components.neural_networks.QuantumGenerator.loss "qiskit.aqua.components.neural_networks.QuantumGenerator.loss") | Loss function for training the generator’s parameters. | -| [`set_discriminator`](qiskit.aqua.components.neural_networks.QuantumGenerator.set_discriminator#qiskit.aqua.components.neural_networks.QuantumGenerator.set_discriminator "qiskit.aqua.components.neural_networks.QuantumGenerator.set_discriminator") | Set discriminator network. | -| [`set_seed`](qiskit.aqua.components.neural_networks.QuantumGenerator.set_seed#qiskit.aqua.components.neural_networks.QuantumGenerator.set_seed "qiskit.aqua.components.neural_networks.QuantumGenerator.set_seed") | Set seed. | -| [`train`](qiskit.aqua.components.neural_networks.QuantumGenerator.train#qiskit.aqua.components.neural_networks.QuantumGenerator.train "qiskit.aqua.components.neural_networks.QuantumGenerator.train") | Perform one training step w\.r.t to the generator’s parameters | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +**params** (*list | dict*) – parameters which should be used to run the generator. + +**Returns** + +construct the quantum circuit and return as gate + +**Return type** + +[Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### get\_output + + + +`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. + +**Parameters** + +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – Quantum Instance, used to run the generator circuit. +* **params** (*numpy.ndarray*) – array or None, parameters which should be used to run the generator, if None use self.\_params +* **shots** (*int*) – if not None use a number of shots that is different from the number set in quantum\_instance + +**Returns** + +generated samples, array: sample occurrence in percentage + +**Return type** + +list + +### loss + + + +`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. + +**Parameters** + +* **x** (*numpy.ndarray*) – sample label (equivalent to discriminator output) +* **weights** (*numpy.ndarray*) – probability for measuring the sample + +**Returns** + +loss function + +**Return type** +float +### set\_discriminator + + + +`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. + +**Parameters** + +**discriminator** ([*DiscriminativeNetwork*](qiskit.aqua.components.neural_networks.DiscriminativeNetwork "qiskit.aqua.components.neural_networks.DiscriminativeNetwork")) – Discriminator used to compute the loss function. + +**Return type** + +`None` + +### set\_seed + + + +`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. + +**Parameters** + +**seed** (*int*) – seed + +**Return type** + +`None` + +### train + + + +`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 + +**Parameters** + +* **quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – used to run the generator circuit. +* **shots** (*int*) – Number of shots for hardware or qasm execution. + +**Returns** + +generator loss(float) and updated parameters (array). + +**Return type** + +dict + +## Attributes + + ### discriminator @@ -47,7 +162,7 @@ Get discriminator. `DiscriminativeNetwork` - + ### optimizer @@ -57,7 +172,7 @@ Get optimizer. `Optimizer` - + ### parameter\_values @@ -71,7 +186,7 @@ Get parameter values from the quantum generator Current parameter values - + ### seed @@ -80,3 +195,4 @@ Get seed. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.md b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.md index e4c9bc7e972..c173e4a1f16 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.neural_networks.md @@ -18,20 +18,20 @@ python_api_name: qiskit.aqua.components.neural_networks A neural network is a parametrized network which may be defined as a artificial neural network - classical neural network - or as parametrized quantum circuits - quantum neural network. Furthermore, neural networks can be defined with respect to a discriminative or generative task. -Neural Networks may be used, for example, with the [`QGAN`](qiskit.aqua.algorithms.QGAN#qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm. +Neural Networks may be used, for example, with the [`QGAN`](qiskit.aqua.algorithms.QGAN "qiskit.aqua.algorithms.QGAN") algorithm. # Neural Network Base Classes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`DiscriminativeNetwork`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork#qiskit.aqua.components.neural_networks.DiscriminativeNetwork "qiskit.aqua.components.neural_networks.DiscriminativeNetwork") | Base class for discriminative Quantum or Classical Neural Networks. | -| [`GenerativeNetwork`](qiskit.aqua.components.neural_networks.GenerativeNetwork#qiskit.aqua.components.neural_networks.GenerativeNetwork "qiskit.aqua.components.neural_networks.GenerativeNetwork") | Base class for generative Quantum and Classical Neural Networks. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | +| [`DiscriminativeNetwork`](qiskit.aqua.components.neural_networks.DiscriminativeNetwork "qiskit.aqua.components.neural_networks.DiscriminativeNetwork") | Base class for discriminative Quantum or Classical Neural Networks. | +| [`GenerativeNetwork`](qiskit.aqua.components.neural_networks.GenerativeNetwork "qiskit.aqua.components.neural_networks.GenerativeNetwork") | Base class for generative Quantum and Classical Neural Networks. | # Neural Networks -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`NumPyDiscriminator`](qiskit.aqua.components.neural_networks.NumPyDiscriminator#qiskit.aqua.components.neural_networks.NumPyDiscriminator "qiskit.aqua.components.neural_networks.NumPyDiscriminator") | Discriminator based on NumPy | -| [`PyTorchDiscriminator`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator#qiskit.aqua.components.neural_networks.PyTorchDiscriminator "qiskit.aqua.components.neural_networks.PyTorchDiscriminator") | Discriminator based on PyTorch | -| [`QuantumGenerator`](qiskit.aqua.components.neural_networks.QuantumGenerator#qiskit.aqua.components.neural_networks.QuantumGenerator "qiskit.aqua.components.neural_networks.QuantumGenerator") | Quantum Generator. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | +| [`NumPyDiscriminator`](qiskit.aqua.components.neural_networks.NumPyDiscriminator "qiskit.aqua.components.neural_networks.NumPyDiscriminator") | Discriminator based on NumPy | +| [`PyTorchDiscriminator`](qiskit.aqua.components.neural_networks.PyTorchDiscriminator "qiskit.aqua.components.neural_networks.PyTorchDiscriminator") | Discriminator based on PyTorch | +| [`QuantumGenerator`](qiskit.aqua.components.neural_networks.QuantumGenerator "qiskit.aqua.components.neural_networks.QuantumGenerator") | Quantum Generator. | 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 21b8547736f..95478f3791e 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 @@ -1,8 +1,16 @@ -# ADAM +--- +title: ADAM +description: API reference for qiskit.aqua.components.optimizers.ADAM +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.ADAM +--- +# ADAM + -`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)` +`ADAM(maxiter=10000, tol=1e-06, lr=0.001, beta_1=0.9, beta_2=0.99, noise_factor=1e-08, eps=1e-10, amsgrad=False, snapshot_dir=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") Bases: `qiskit.aqua.components.optimizers.optimizer.Optimizer` @@ -36,95 +44,253 @@ On the Convergence of Adam and Beyond. [arXiv:1904.09237](https://arxiv.org/abs/ ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.ADAM.get_support_level#qiskit.aqua.components.optimizers.ADAM.get_support_level "qiskit.aqua.components.optimizers.ADAM.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.ADAM.gradient_num_diff#qiskit.aqua.components.optimizers.ADAM.gradient_num_diff "qiskit.aqua.components.optimizers.ADAM.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`load_params`](qiskit.aqua.components.optimizers.ADAM.load_params#qiskit.aqua.components.optimizers.ADAM.load_params "qiskit.aqua.components.optimizers.ADAM.load_params") | Load iteration parameters for a file called `adam_params.csv`. | -| [`minimize`](qiskit.aqua.components.optimizers.ADAM.minimize#qiskit.aqua.components.optimizers.ADAM.minimize "qiskit.aqua.components.optimizers.ADAM.minimize") | Run the minimization. | -| [`optimize`](qiskit.aqua.components.optimizers.ADAM.optimize#qiskit.aqua.components.optimizers.ADAM.optimize "qiskit.aqua.components.optimizers.ADAM.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.ADAM.print_options#qiskit.aqua.components.optimizers.ADAM.print_options "qiskit.aqua.components.optimizers.ADAM.print_options") | Print algorithm-specific options. | -| [`save_params`](qiskit.aqua.components.optimizers.ADAM.save_params#qiskit.aqua.components.optimizers.ADAM.save_params "qiskit.aqua.components.optimizers.ADAM.save_params") | Save the current iteration parameters to a file called `adam_params.csv`. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.ADAM.set_max_evals_grouped#qiskit.aqua.components.optimizers.ADAM.set_max_evals_grouped "qiskit.aqua.components.optimizers.ADAM.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.ADAM.set_options#qiskit.aqua.components.optimizers.ADAM.set_options "qiskit.aqua.components.optimizers.ADAM.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.ADAM.wrap_function#qiskit.aqua.components.optimizers.ADAM.wrap_function "qiskit.aqua.components.optimizers.ADAM.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static ADAM.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### load\_params + + + +`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`. + +**Parameters** + +**load\_dir** (`str`) – The directory containing `adam_params.csv`. + +**Return type** + +`None` + +### minimize + + + +`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. + +**Parameters** + +* **objective\_function** (`Callable`\[\[`ndarray`], `float`]) – A function handle to the objective function. +* **initial\_point** (`ndarray`) – The initial iteration point. +* **gradient\_function** (`Callable`\[\[`ndarray`], `float`]) – A function handle to the gradient of the objective function. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +A tuple of (optimal parameters, optimal value, number of iterations). + +### 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.9/qiskit/aqua/components/optimizers/adam_amsgrad.py "view source code") + +Perform optimization. + +**Parameters** + +* **num\_vars** (`int`) – Number of parameters to be optimized. +* **objective\_function** (`Callable`\[\[`ndarray`], `float`]) – Handle to a function that computes the objective function. +* **gradient\_function** (`Optional`\[`Callable`\[\[`ndarray`], `float`]]) – Handle to a function that computes the gradient of the objective function. +* **variable\_bounds** (`Optional`\[`List`\[`Tuple`\[`float`, `float`]]]) – deprecated +* **initial\_point** (`Optional`\[`ndarray`]) – The initial point for the optimization. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +A tuple (point, value, nfev) where + +> point: is a 1D numpy.ndarray\[float] containing the solution +> +> value: is a float with the objective function value +> +> nfev: is the number of objective function calls + +### print\_options + + +`ADAM.print_options()` +Print algorithm-specific options. + +### save\_params + + + +`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`. + + + The current parameters are appended to the file, if it exists already. The file is not overwritten. + + +**Parameters** + +**snapshot\_dir** (`str`) – The directory to store the file in. + +**Return type** + +`None` + +### set\_max\_evals\_grouped + + + +`ADAM.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`ADAM.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static ADAM.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 4b8471358f8..82687ee457d 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 @@ -1,8 +1,16 @@ -# AQGD +--- +title: AQGD +description: API reference for qiskit.aqua.components.optimizers.AQGD +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.AQGD +--- +# AQGD + -`AQGD(maxiter=1000, eta=1.0, tol=1e-06, disp=False, momentum=0.25, param_tol=1e-06, averaging=10)` +`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` @@ -29,96 +37,209 @@ Performs Analytical Quantum Gradient Descent (AQGD) with Epochs. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If the length of `maxiter`, momentum\`, and `eta` is not the same. +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If the length of `maxiter`, momentum\`, and `eta` is not the same. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.AQGD.get_support_level#qiskit.aqua.components.optimizers.AQGD.get_support_level "qiskit.aqua.components.optimizers.AQGD.get_support_level") | Support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.AQGD.gradient_num_diff#qiskit.aqua.components.optimizers.AQGD.gradient_num_diff "qiskit.aqua.components.optimizers.AQGD.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.AQGD.optimize#qiskit.aqua.components.optimizers.AQGD.optimize "qiskit.aqua.components.optimizers.AQGD.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.AQGD.print_options#qiskit.aqua.components.optimizers.AQGD.print_options "qiskit.aqua.components.optimizers.AQGD.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.AQGD.set_max_evals_grouped#qiskit.aqua.components.optimizers.AQGD.set_max_evals_grouped "qiskit.aqua.components.optimizers.AQGD.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.AQGD.set_options#qiskit.aqua.components.optimizers.AQGD.set_options "qiskit.aqua.components.optimizers.AQGD.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.AQGD.wrap_function#qiskit.aqua.components.optimizers.AQGD.wrap_function "qiskit.aqua.components.optimizers.AQGD.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +**Returns** + +**gradient, bounds and initial point** + +support information that is ignored/required. + +**Return type** + +Dict\[str, int] + +### gradient\_num\_diff + + + +`static AQGD.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`AQGD.print_options()` +Print algorithm-specific options. +### set\_max\_evals\_grouped + + + +`AQGD.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`AQGD.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static AQGD.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 ce8940540f7..8a986e3c761 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 @@ -1,8 +1,16 @@ -# BOBYQA +--- +title: BOBYQA +description: API reference for qiskit.aqua.components.optimizers.BOBYQA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.BOBYQA +--- +# BOBYQA + -`BOBYQA(maxiter=1000)` +`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` @@ -18,96 +26,177 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.BOBYQA.get_support_level#qiskit.aqua.components.optimizers.BOBYQA.get_support_level "qiskit.aqua.components.optimizers.BOBYQA.get_support_level") | Returns support level dictionary. | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.BOBYQA.gradient_num_diff#qiskit.aqua.components.optimizers.BOBYQA.gradient_num_diff "qiskit.aqua.components.optimizers.BOBYQA.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.BOBYQA.optimize#qiskit.aqua.components.optimizers.BOBYQA.optimize "qiskit.aqua.components.optimizers.BOBYQA.optimize") | Runs the optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.BOBYQA.print_options#qiskit.aqua.components.optimizers.BOBYQA.print_options "qiskit.aqua.components.optimizers.BOBYQA.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.BOBYQA.set_max_evals_grouped#qiskit.aqua.components.optimizers.BOBYQA.set_max_evals_grouped "qiskit.aqua.components.optimizers.BOBYQA.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.BOBYQA.set_options#qiskit.aqua.components.optimizers.BOBYQA.set_options "qiskit.aqua.components.optimizers.BOBYQA.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.BOBYQA.wrap_function#qiskit.aqua.components.optimizers.BOBYQA.wrap_function "qiskit.aqua.components.optimizers.BOBYQA.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +### gradient\_num\_diff + + + +`static BOBYQA.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +### print\_options + + + +`BOBYQA.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`BOBYQA.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`BOBYQA.set_options(**kwargs)` +Sets or updates values in the options dictionary. +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static BOBYQA.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 ae9c8127d1c..588d71e1e95 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 @@ -1,8 +1,16 @@ -# CG +--- +title: CG +description: API reference for qiskit.aqua.components.optimizers.CG +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.CG +--- +# CG + -`CG(maxiter=20, disp=False, gtol=1e-05, tol=None, eps=1.4901161193847656e-08)` +`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` @@ -22,92 +30,191 @@ Uses scipy.optimize.minimize CG. For further detail, please refer to [https://do ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.CG.get_support_level#qiskit.aqua.components.optimizers.CG.get_support_level "qiskit.aqua.components.optimizers.CG.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.CG.gradient_num_diff#qiskit.aqua.components.optimizers.CG.gradient_num_diff "qiskit.aqua.components.optimizers.CG.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.CG.optimize#qiskit.aqua.components.optimizers.CG.optimize "qiskit.aqua.components.optimizers.CG.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.CG.print_options#qiskit.aqua.components.optimizers.CG.print_options "qiskit.aqua.components.optimizers.CG.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.CG.set_max_evals_grouped#qiskit.aqua.components.optimizers.CG.set_max_evals_grouped "qiskit.aqua.components.optimizers.CG.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.CG.set_options#qiskit.aqua.components.optimizers.CG.set_options "qiskit.aqua.components.optimizers.CG.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.CG.wrap_function#qiskit.aqua.components.optimizers.CG.wrap_function "qiskit.aqua.components.optimizers.CG.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static CG.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`CG.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`CG.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`CG.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static CG.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 c99bb424099..16da45b4d73 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 @@ -1,8 +1,16 @@ -# COBYLA +--- +title: COBYLA +description: API reference for qiskit.aqua.components.optimizers.COBYLA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.COBYLA +--- +# COBYLA + -`COBYLA(maxiter=1000, disp=False, rhobeg=1.0, tol=None)` +`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` @@ -21,92 +29,191 @@ Uses scipy.optimize.minimize COBYLA. For further detail, please refer to [https: ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.COBYLA.get_support_level#qiskit.aqua.components.optimizers.COBYLA.get_support_level "qiskit.aqua.components.optimizers.COBYLA.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.COBYLA.gradient_num_diff#qiskit.aqua.components.optimizers.COBYLA.gradient_num_diff "qiskit.aqua.components.optimizers.COBYLA.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.COBYLA.optimize#qiskit.aqua.components.optimizers.COBYLA.optimize "qiskit.aqua.components.optimizers.COBYLA.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.COBYLA.print_options#qiskit.aqua.components.optimizers.COBYLA.print_options "qiskit.aqua.components.optimizers.COBYLA.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.COBYLA.set_max_evals_grouped#qiskit.aqua.components.optimizers.COBYLA.set_max_evals_grouped "qiskit.aqua.components.optimizers.COBYLA.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.COBYLA.set_options#qiskit.aqua.components.optimizers.COBYLA.set_options "qiskit.aqua.components.optimizers.COBYLA.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.COBYLA.wrap_function#qiskit.aqua.components.optimizers.COBYLA.wrap_function "qiskit.aqua.components.optimizers.COBYLA.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static COBYLA.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`COBYLA.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`COBYLA.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`COBYLA.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static COBYLA.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 62b8ed9fcce..771ae3eec74 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 @@ -1,14 +1,22 @@ -# CRS +--- +title: CRS +description: API reference for qiskit.aqua.components.optimizers.CRS +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.CRS +--- +# CRS + -`CRS(max_evals=1000)` +`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` Controlled Random Search (CRS) with local mutation optimizer. -Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD#qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. +Controlled Random Search (CRS) with local mutation is part of the family of the CRS optimizers. The CRS optimizers start with a random population of points, and randomly evolve these points by heuristic rules. In the case of CRS with local mutation, the evolution is a randomized version of the [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") local optimizer. NLopt global optimizer, derivative-free. For further detail, please refer to [https://nlopt.readthedocs.io/en/latest/NLopt\_Algorithms/#controlled-random-search-crs-with-local-mutation](https://nlopt.readthedocs.io/en/latest/NLopt_Algorithms/#controlled-random-search-crs-with-local-mutation) @@ -18,97 +26,207 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.aqua.components.optimizers.CRS.get_nlopt_optimizer#qiskit.aqua.components.optimizers.CRS.get_nlopt_optimizer "qiskit.aqua.components.optimizers.CRS.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.aqua.components.optimizers.CRS.get_support_level#qiskit.aqua.components.optimizers.CRS.get_support_level "qiskit.aqua.components.optimizers.CRS.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.CRS.gradient_num_diff#qiskit.aqua.components.optimizers.CRS.gradient_num_diff "qiskit.aqua.components.optimizers.CRS.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.CRS.optimize#qiskit.aqua.components.optimizers.CRS.optimize "qiskit.aqua.components.optimizers.CRS.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.CRS.print_options#qiskit.aqua.components.optimizers.CRS.print_options "qiskit.aqua.components.optimizers.CRS.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.CRS.set_max_evals_grouped#qiskit.aqua.components.optimizers.CRS.set_max_evals_grouped "qiskit.aqua.components.optimizers.CRS.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.CRS.set_options#qiskit.aqua.components.optimizers.CRS.set_options "qiskit.aqua.components.optimizers.CRS.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.CRS.wrap_function#qiskit.aqua.components.optimizers.CRS.wrap_function "qiskit.aqua.components.optimizers.CRS.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`CRS.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static CRS.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`CRS.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`CRS.print_options()` +Print algorithm-specific options. +### set\_max\_evals\_grouped + + + +`CRS.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`CRS.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static CRS.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 2d391de1450..3e2c4524bea 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 @@ -1,8 +1,16 @@ -# DIRECT\_L +--- +title: DIRECT_L +description: API reference for qiskit.aqua.components.optimizers.DIRECT_L +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.DIRECT_L +--- +# DIRECT\_L + -`DIRECT_L(max_evals=1000)` +`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` @@ -18,97 +26,207 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.aqua.components.optimizers.DIRECT_L.get_nlopt_optimizer#qiskit.aqua.components.optimizers.DIRECT_L.get_nlopt_optimizer "qiskit.aqua.components.optimizers.DIRECT_L.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.aqua.components.optimizers.DIRECT_L.get_support_level#qiskit.aqua.components.optimizers.DIRECT_L.get_support_level "qiskit.aqua.components.optimizers.DIRECT_L.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.DIRECT_L.gradient_num_diff#qiskit.aqua.components.optimizers.DIRECT_L.gradient_num_diff "qiskit.aqua.components.optimizers.DIRECT_L.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.DIRECT_L.optimize#qiskit.aqua.components.optimizers.DIRECT_L.optimize "qiskit.aqua.components.optimizers.DIRECT_L.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.DIRECT_L.print_options#qiskit.aqua.components.optimizers.DIRECT_L.print_options "qiskit.aqua.components.optimizers.DIRECT_L.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.DIRECT_L.set_max_evals_grouped#qiskit.aqua.components.optimizers.DIRECT_L.set_max_evals_grouped "qiskit.aqua.components.optimizers.DIRECT_L.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.DIRECT_L.set_options#qiskit.aqua.components.optimizers.DIRECT_L.set_options "qiskit.aqua.components.optimizers.DIRECT_L.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.DIRECT_L.wrap_function#qiskit.aqua.components.optimizers.DIRECT_L.wrap_function "qiskit.aqua.components.optimizers.DIRECT_L.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`DIRECT_L.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static DIRECT_L.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`DIRECT_L.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`DIRECT_L.print_options()` +Print algorithm-specific options. +### set\_max\_evals\_grouped + + + +`DIRECT_L.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`DIRECT_L.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static DIRECT_L.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 706e9b3d3ff..ae5dfe2e7b4 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 @@ -1,14 +1,22 @@ -# DIRECT\_L\_RAND +--- +title: DIRECT_L_RAND +description: API reference for qiskit.aqua.components.optimizers.DIRECT_L_RAND +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.DIRECT_L_RAND +--- +# DIRECT\_L\_RAND + -`DIRECT_L_RAND(max_evals=1000)` +`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` DIviding RECTangles Locally-biased Randomized optimizer. -DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L#qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") +DIRECT-L RAND is the “locally biased” variant with some randomization in near-tie decisions. See also [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") NLopt global optimizer, derivative-free. For further detail, please refer to [http://nlopt.readthedocs.io/en/latest/NLopt\_Algorithms/#direct-and-direct-l](http://nlopt.readthedocs.io/en/latest/NLopt_Algorithms/#direct-and-direct-l) @@ -18,97 +26,207 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.get_nlopt_optimizer#qiskit.aqua.components.optimizers.DIRECT_L_RAND.get_nlopt_optimizer "qiskit.aqua.components.optimizers.DIRECT_L_RAND.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.get_support_level#qiskit.aqua.components.optimizers.DIRECT_L_RAND.get_support_level "qiskit.aqua.components.optimizers.DIRECT_L_RAND.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.gradient_num_diff#qiskit.aqua.components.optimizers.DIRECT_L_RAND.gradient_num_diff "qiskit.aqua.components.optimizers.DIRECT_L_RAND.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.optimize#qiskit.aqua.components.optimizers.DIRECT_L_RAND.optimize "qiskit.aqua.components.optimizers.DIRECT_L_RAND.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.print_options#qiskit.aqua.components.optimizers.DIRECT_L_RAND.print_options "qiskit.aqua.components.optimizers.DIRECT_L_RAND.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.set_max_evals_grouped#qiskit.aqua.components.optimizers.DIRECT_L_RAND.set_max_evals_grouped "qiskit.aqua.components.optimizers.DIRECT_L_RAND.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.set_options#qiskit.aqua.components.optimizers.DIRECT_L_RAND.set_options "qiskit.aqua.components.optimizers.DIRECT_L_RAND.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.DIRECT_L_RAND.wrap_function#qiskit.aqua.components.optimizers.DIRECT_L_RAND.wrap_function "qiskit.aqua.components.optimizers.DIRECT_L_RAND.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`DIRECT_L_RAND.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static DIRECT_L_RAND.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`DIRECT_L_RAND.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`DIRECT_L_RAND.print_options()` +Print algorithm-specific options. +### set\_max\_evals\_grouped + + + +`DIRECT_L_RAND.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`DIRECT_L_RAND.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static DIRECT_L_RAND.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 bf3fe0a07ac..f72728b4531 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 @@ -1,8 +1,16 @@ -# ESCH +--- +title: ESCH +description: API reference for qiskit.aqua.components.optimizers.ESCH +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.ESCH +--- +# ESCH + -`ESCH(max_evals=1000)` +`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` @@ -20,97 +28,207 @@ NLopt global optimizer, derivative-free. For further detail, please refer to **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.aqua.components.optimizers.ESCH.get_nlopt_optimizer#qiskit.aqua.components.optimizers.ESCH.get_nlopt_optimizer "qiskit.aqua.components.optimizers.ESCH.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.aqua.components.optimizers.ESCH.get_support_level#qiskit.aqua.components.optimizers.ESCH.get_support_level "qiskit.aqua.components.optimizers.ESCH.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.ESCH.gradient_num_diff#qiskit.aqua.components.optimizers.ESCH.gradient_num_diff "qiskit.aqua.components.optimizers.ESCH.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.ESCH.optimize#qiskit.aqua.components.optimizers.ESCH.optimize "qiskit.aqua.components.optimizers.ESCH.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.ESCH.print_options#qiskit.aqua.components.optimizers.ESCH.print_options "qiskit.aqua.components.optimizers.ESCH.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.ESCH.set_max_evals_grouped#qiskit.aqua.components.optimizers.ESCH.set_max_evals_grouped "qiskit.aqua.components.optimizers.ESCH.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.ESCH.set_options#qiskit.aqua.components.optimizers.ESCH.set_options "qiskit.aqua.components.optimizers.ESCH.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.ESCH.wrap_function#qiskit.aqua.components.optimizers.ESCH.wrap_function "qiskit.aqua.components.optimizers.ESCH.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`ESCH.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static ESCH.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`ESCH.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`ESCH.print_options()` +Print algorithm-specific options. +### set\_max\_evals\_grouped + + + +`ESCH.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`ESCH.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static ESCH.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 dff28da3be9..40b08824745 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 @@ -1,8 +1,16 @@ -# GSLS +--- +title: GSLS +description: API reference for qiskit.aqua.components.optimizers.GSLS +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.GSLS +--- +# 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)` +`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` @@ -27,96 +35,308 @@ An implementation of the line search algorithm described in [https://arxiv.org/p ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.GSLS.get_support_level#qiskit.aqua.components.optimizers.GSLS.get_support_level "qiskit.aqua.components.optimizers.GSLS.get_support_level") | Return support level dictionary. | -| [`gradient_approximation`](qiskit.aqua.components.optimizers.GSLS.gradient_approximation#qiskit.aqua.components.optimizers.GSLS.gradient_approximation "qiskit.aqua.components.optimizers.GSLS.gradient_approximation") | Construct gradient approximation from given sample. | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.GSLS.gradient_num_diff#qiskit.aqua.components.optimizers.GSLS.gradient_num_diff "qiskit.aqua.components.optimizers.GSLS.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`ls_optimize`](qiskit.aqua.components.optimizers.GSLS.ls_optimize#qiskit.aqua.components.optimizers.GSLS.ls_optimize "qiskit.aqua.components.optimizers.GSLS.ls_optimize") | Run the line search optimization. | -| [`optimize`](qiskit.aqua.components.optimizers.GSLS.optimize#qiskit.aqua.components.optimizers.GSLS.optimize "qiskit.aqua.components.optimizers.GSLS.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.GSLS.print_options#qiskit.aqua.components.optimizers.GSLS.print_options "qiskit.aqua.components.optimizers.GSLS.print_options") | Print algorithm-specific options. | -| [`sample_points`](qiskit.aqua.components.optimizers.GSLS.sample_points#qiskit.aqua.components.optimizers.GSLS.sample_points "qiskit.aqua.components.optimizers.GSLS.sample_points") | Sample `num_points` points around `x` on the `n`-sphere of specified radius. | -| [`sample_set`](qiskit.aqua.components.optimizers.GSLS.sample_set#qiskit.aqua.components.optimizers.GSLS.sample_set "qiskit.aqua.components.optimizers.GSLS.sample_set") | Construct sample set of given size. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.GSLS.set_max_evals_grouped#qiskit.aqua.components.optimizers.GSLS.set_max_evals_grouped "qiskit.aqua.components.optimizers.GSLS.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.GSLS.set_options#qiskit.aqua.components.optimizers.GSLS.set_options "qiskit.aqua.components.optimizers.GSLS.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.GSLS.wrap_function#qiskit.aqua.components.optimizers.GSLS.wrap_function "qiskit.aqua.components.optimizers.GSLS.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +**Return type** + +`Dict`\[`str`, `int`] + +**Returns** + +A dictionary containing the support levels for different options. + +### gradient\_approximation + + + +`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. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **x** (`ndarray`) – Point around which the sample set was constructed. +* **x\_value** (`float`) – Objective function value at x. +* **directions** (`ndarray`) – Directions of the sample points wrt the central point x, as a 2D array. +* **sample\_set\_x** (`ndarray`) – x-coordinates of the sample set, one point per row, as a 2D array. +* **sample\_set\_y** (`ndarray`) – Objective function values of the points in sample\_set\_x, as a 1D array. + +**Return type** + +`ndarray` + +**Returns** + +Gradient approximation at x, as a 1D array. + +### gradient\_num\_diff + + + +`static GSLS.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### ls\_optimize + + + +`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. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **obj\_fun** (`Callable`) – Objective function. +* **initial\_point** (`ndarray`) – Initial point. +* **var\_lb** (`ndarray`) – Vector of lower bounds on the decision variables. Vector elements can be -np.inf if the corresponding variable is unbounded from below. +* **var\_ub** (`ndarray`) – Vector of upper bounds on the decision variables. Vector elements can be np.inf if the corresponding variable is unbounded from below. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`, `float`] + +**Returns** + +Final iterate as a vector, corresponding objective function value, number of evaluations, and norm of the gradient estimate. + +**Raises** + +**ValueError** – If the number of dimensions mismatches the size of the initial point or the length of the lower or upper bound. + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Return type** + +`Tuple`\[`ndarray`, `float`, `int`] + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`GSLS.print_options()` + +Print algorithm-specific options. +### sample\_points + + +`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. + +The radius of the sphere is `self._options['sampling_radius']`. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **x** (`ndarray`) – Point around which the sample set is constructed. +* **num\_points** (`int`) – Number of points in the sample set. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +**Returns** + +A tuple containing the sampling points and the directions. + +### sample\_set + + + +`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. + +**Parameters** + +* **n** (`int`) – Dimension of the problem. +* **x** (`ndarray`) – Point around which the sample set is constructed. +* **var\_lb** (`ndarray`) – Vector of lower bounds on the decision variables. Vector elements can be -np.inf if the corresponding variable is unbounded from below. +* **var\_ub** (`ndarray`) – Vector of lower bounds on the decision variables. Vector elements can be np.inf if the corresponding variable is unbounded from above. +* **num\_points** (`int`) – Number of points in the sample set. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +**Returns** + +Matrices of (unit-norm) sample directions and sample points, one per row. Both matrices are 2D arrays of floats. + +**Raises** + +**RuntimeError** – If not enough samples could be generated within the bounds. + +### set\_max\_evals\_grouped + + + +`GSLS.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`GSLS.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static GSLS.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 acd42d34690..503b45666d6 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 @@ -1,8 +1,16 @@ -# IMFIL +--- +title: IMFIL +description: API reference for qiskit.aqua.components.optimizers.IMFIL +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.IMFIL +--- +# IMFIL + -`IMFIL(maxiter=1000)` +`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` @@ -18,96 +26,177 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant not installed ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.IMFIL.get_support_level#qiskit.aqua.components.optimizers.IMFIL.get_support_level "qiskit.aqua.components.optimizers.IMFIL.get_support_level") | Returns support level dictionary. | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.IMFIL.gradient_num_diff#qiskit.aqua.components.optimizers.IMFIL.gradient_num_diff "qiskit.aqua.components.optimizers.IMFIL.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.IMFIL.optimize#qiskit.aqua.components.optimizers.IMFIL.optimize "qiskit.aqua.components.optimizers.IMFIL.optimize") | Runs the optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.IMFIL.print_options#qiskit.aqua.components.optimizers.IMFIL.print_options "qiskit.aqua.components.optimizers.IMFIL.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.IMFIL.set_max_evals_grouped#qiskit.aqua.components.optimizers.IMFIL.set_max_evals_grouped "qiskit.aqua.components.optimizers.IMFIL.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.IMFIL.set_options#qiskit.aqua.components.optimizers.IMFIL.set_options "qiskit.aqua.components.optimizers.IMFIL.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.IMFIL.wrap_function#qiskit.aqua.components.optimizers.IMFIL.wrap_function "qiskit.aqua.components.optimizers.IMFIL.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +### gradient\_num\_diff + + + +`static IMFIL.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +### print\_options + + + +`IMFIL.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`IMFIL.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`IMFIL.set_options(**kwargs)` +Sets or updates values in the options dictionary. +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static IMFIL.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 ba5c7169fcd..2307be651a4 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 @@ -1,8 +1,16 @@ -# ISRES +--- +title: ISRES +description: API reference for qiskit.aqua.components.optimizers.ISRES +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.ISRES +--- +# ISRES + -`ISRES(max_evals=1000)` +`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` @@ -18,97 +26,207 @@ NLopt global optimizer, derivative-free. For further detail, please refer to [ht **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – NLopt library not installed. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_nlopt_optimizer`](qiskit.aqua.components.optimizers.ISRES.get_nlopt_optimizer#qiskit.aqua.components.optimizers.ISRES.get_nlopt_optimizer "qiskit.aqua.components.optimizers.ISRES.get_nlopt_optimizer") | Return NLopt optimizer type | -| [`get_support_level`](qiskit.aqua.components.optimizers.ISRES.get_support_level#qiskit.aqua.components.optimizers.ISRES.get_support_level "qiskit.aqua.components.optimizers.ISRES.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.ISRES.gradient_num_diff#qiskit.aqua.components.optimizers.ISRES.gradient_num_diff "qiskit.aqua.components.optimizers.ISRES.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.ISRES.optimize#qiskit.aqua.components.optimizers.ISRES.optimize "qiskit.aqua.components.optimizers.ISRES.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.ISRES.print_options#qiskit.aqua.components.optimizers.ISRES.print_options "qiskit.aqua.components.optimizers.ISRES.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.ISRES.set_max_evals_grouped#qiskit.aqua.components.optimizers.ISRES.set_max_evals_grouped "qiskit.aqua.components.optimizers.ISRES.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.ISRES.set_options#qiskit.aqua.components.optimizers.ISRES.set_options "qiskit.aqua.components.optimizers.ISRES.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.ISRES.wrap_function#qiskit.aqua.components.optimizers.ISRES.wrap_function "qiskit.aqua.components.optimizers.ISRES.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_nlopt\_optimizer -## Attributes + + +`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 + +**Return type** + +`NLoptOptimizerType` + +### get\_support\_level + + + +`ISRES.get_support_level()` + +return support level dictionary + +### gradient\_num\_diff + + + +`static ISRES.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`ISRES.optimize(num_vars, objective_function, gradient_function=None, variable_bounds=None, initial_point=None)` + +Perform optimization. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`ISRES.print_options()` +Print algorithm-specific options. +### set\_max\_evals\_grouped + + + +`ISRES.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`ISRES.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static ISRES.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 c8cda21f3bc..47d39c3177a 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 @@ -1,8 +1,16 @@ -# L\_BFGS\_B +--- +title: L_BFGS_B +description: API reference for qiskit.aqua.components.optimizers.L_BFGS_B +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.L_BFGS_B +--- +# L\_BFGS\_B + -`L_BFGS_B(maxfun=1000, maxiter=15000, factr=10, iprint=- 1, epsilon=1e-08)` +`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` @@ -26,92 +34,191 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.L_BFGS_B.get_support_level#qiskit.aqua.components.optimizers.L_BFGS_B.get_support_level "qiskit.aqua.components.optimizers.L_BFGS_B.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.L_BFGS_B.gradient_num_diff#qiskit.aqua.components.optimizers.L_BFGS_B.gradient_num_diff "qiskit.aqua.components.optimizers.L_BFGS_B.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.L_BFGS_B.optimize#qiskit.aqua.components.optimizers.L_BFGS_B.optimize "qiskit.aqua.components.optimizers.L_BFGS_B.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.L_BFGS_B.print_options#qiskit.aqua.components.optimizers.L_BFGS_B.print_options "qiskit.aqua.components.optimizers.L_BFGS_B.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.L_BFGS_B.set_max_evals_grouped#qiskit.aqua.components.optimizers.L_BFGS_B.set_max_evals_grouped "qiskit.aqua.components.optimizers.L_BFGS_B.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.L_BFGS_B.set_options#qiskit.aqua.components.optimizers.L_BFGS_B.set_options "qiskit.aqua.components.optimizers.L_BFGS_B.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.L_BFGS_B.wrap_function#qiskit.aqua.components.optimizers.L_BFGS_B.wrap_function "qiskit.aqua.components.optimizers.L_BFGS_B.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static L_BFGS_B.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`L_BFGS_B.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`L_BFGS_B.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`L_BFGS_B.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static L_BFGS_B.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 e6cd7a60d03..b0a6d556988 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 @@ -1,8 +1,16 @@ -# NELDER\_MEAD +--- +title: NELDER_MEAD +description: API reference for qiskit.aqua.components.optimizers.NELDER_MEAD +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.NELDER_MEAD +--- +# NELDER\_MEAD + -`NELDER_MEAD(maxiter=None, maxfev=1000, disp=False, xatol=0.0001, tol=None, adaptive=False)` +`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` @@ -25,92 +33,191 @@ Uses scipy.optimize.minimize Nelder-Mead. For further detail, please refer to Se ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.NELDER_MEAD.get_support_level#qiskit.aqua.components.optimizers.NELDER_MEAD.get_support_level "qiskit.aqua.components.optimizers.NELDER_MEAD.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.NELDER_MEAD.gradient_num_diff#qiskit.aqua.components.optimizers.NELDER_MEAD.gradient_num_diff "qiskit.aqua.components.optimizers.NELDER_MEAD.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.NELDER_MEAD.optimize#qiskit.aqua.components.optimizers.NELDER_MEAD.optimize "qiskit.aqua.components.optimizers.NELDER_MEAD.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.NELDER_MEAD.print_options#qiskit.aqua.components.optimizers.NELDER_MEAD.print_options "qiskit.aqua.components.optimizers.NELDER_MEAD.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.NELDER_MEAD.set_max_evals_grouped#qiskit.aqua.components.optimizers.NELDER_MEAD.set_max_evals_grouped "qiskit.aqua.components.optimizers.NELDER_MEAD.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.NELDER_MEAD.set_options#qiskit.aqua.components.optimizers.NELDER_MEAD.set_options "qiskit.aqua.components.optimizers.NELDER_MEAD.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.NELDER_MEAD.wrap_function#qiskit.aqua.components.optimizers.NELDER_MEAD.wrap_function "qiskit.aqua.components.optimizers.NELDER_MEAD.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static NELDER_MEAD.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`NELDER_MEAD.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`NELDER_MEAD.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`NELDER_MEAD.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static NELDER_MEAD.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 76fef852f99..789847cf9a5 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 @@ -1,8 +1,16 @@ -# NFT +--- +title: NFT +description: API reference for qiskit.aqua.components.optimizers.NFT +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.NFT +--- +# NFT + -`NFT(maxiter=None, maxfev=1024, disp=False, reset_interval=32)` +`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` @@ -31,92 +39,191 @@ K. M. Nakanishi, K. Fujii, and S. Todo. 2019. Sequential minimal optimization fo ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.NFT.get_support_level#qiskit.aqua.components.optimizers.NFT.get_support_level "qiskit.aqua.components.optimizers.NFT.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.NFT.gradient_num_diff#qiskit.aqua.components.optimizers.NFT.gradient_num_diff "qiskit.aqua.components.optimizers.NFT.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.NFT.optimize#qiskit.aqua.components.optimizers.NFT.optimize "qiskit.aqua.components.optimizers.NFT.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.NFT.print_options#qiskit.aqua.components.optimizers.NFT.print_options "qiskit.aqua.components.optimizers.NFT.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.NFT.set_max_evals_grouped#qiskit.aqua.components.optimizers.NFT.set_max_evals_grouped "qiskit.aqua.components.optimizers.NFT.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.NFT.set_options#qiskit.aqua.components.optimizers.NFT.set_options "qiskit.aqua.components.optimizers.NFT.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.NFT.wrap_function#qiskit.aqua.components.optimizers.NFT.wrap_function "qiskit.aqua.components.optimizers.NFT.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static NFT.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`NFT.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`NFT.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`NFT.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static NFT.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 e38d765a691..80e98a1d35c 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 @@ -1,8 +1,16 @@ -# Optimizer +--- +title: Optimizer +description: API reference for qiskit.aqua.components.optimizers.Optimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.Optimizer +--- +# Optimizer + -`Optimizer` +`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` @@ -12,92 +20,191 @@ Initialize the optimization algorithm, setting the support level for \_gradient\ ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.Optimizer.get_support_level#qiskit.aqua.components.optimizers.Optimizer.get_support_level "qiskit.aqua.components.optimizers.Optimizer.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.Optimizer.gradient_num_diff#qiskit.aqua.components.optimizers.Optimizer.gradient_num_diff "qiskit.aqua.components.optimizers.Optimizer.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.Optimizer.optimize#qiskit.aqua.components.optimizers.Optimizer.optimize "qiskit.aqua.components.optimizers.Optimizer.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.Optimizer.print_options#qiskit.aqua.components.optimizers.Optimizer.print_options "qiskit.aqua.components.optimizers.Optimizer.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.Optimizer.set_max_evals_grouped#qiskit.aqua.components.optimizers.Optimizer.set_max_evals_grouped "qiskit.aqua.components.optimizers.Optimizer.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.Optimizer.set_options#qiskit.aqua.components.optimizers.Optimizer.set_options "qiskit.aqua.components.optimizers.Optimizer.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.Optimizer.wrap_function#qiskit.aqua.components.optimizers.Optimizer.wrap_function "qiskit.aqua.components.optimizers.Optimizer.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`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. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`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. + +### set\_max\_evals\_grouped + + + +`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 +### set\_options + + + +`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. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`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. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 2eda1a865a7..63d60f8c139 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 @@ -1,8 +1,16 @@ -# OptimizerSupportLevel +--- +title: OptimizerSupportLevel +description: API reference for qiskit.aqua.components.optimizers.OptimizerSupportLevel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.OptimizerSupportLevel +--- +# OptimizerSupportLevel + -`OptimizerSupportLevel(value)` +`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` @@ -10,26 +18,27 @@ Support Level enum for features such as bounds, gradient and initial point ## Attributes - + ### ignored `= 1` - + ### not\_supported `= 0` - + ### required `= 3` - + ### supported `= 2` + 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 07ad5ec21d1..74d8f777c17 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 @@ -1,8 +1,16 @@ -# POWELL +--- +title: POWELL +description: API reference for qiskit.aqua.components.optimizers.POWELL +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.POWELL +--- +# POWELL + -`POWELL(maxiter=None, maxfev=1000, disp=False, xtol=0.0001, tol=None)` +`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` @@ -22,92 +30,191 @@ Uses scipy.optimize.minimize Powell. For further detail, please refer to See [ht ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.POWELL.get_support_level#qiskit.aqua.components.optimizers.POWELL.get_support_level "qiskit.aqua.components.optimizers.POWELL.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.POWELL.gradient_num_diff#qiskit.aqua.components.optimizers.POWELL.gradient_num_diff "qiskit.aqua.components.optimizers.POWELL.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.POWELL.optimize#qiskit.aqua.components.optimizers.POWELL.optimize "qiskit.aqua.components.optimizers.POWELL.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.POWELL.print_options#qiskit.aqua.components.optimizers.POWELL.print_options "qiskit.aqua.components.optimizers.POWELL.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.POWELL.set_max_evals_grouped#qiskit.aqua.components.optimizers.POWELL.set_max_evals_grouped "qiskit.aqua.components.optimizers.POWELL.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.POWELL.set_options#qiskit.aqua.components.optimizers.POWELL.set_options "qiskit.aqua.components.optimizers.POWELL.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.POWELL.wrap_function#qiskit.aqua.components.optimizers.POWELL.wrap_function "qiskit.aqua.components.optimizers.POWELL.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static POWELL.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`POWELL.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`POWELL.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`POWELL.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static POWELL.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 b81d12f6b3f..9f7e665caea 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 @@ -1,14 +1,22 @@ -# P\_BFGS +--- +title: P_BFGS +description: API reference for qiskit.aqua.components.optimizers.P_BFGS +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.P_BFGS +--- +# P\_BFGS + -`P_BFGS(maxfun=1000, factr=10, iprint=- 1, max_processes=None)` +`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` Parallelized Limited-memory BFGS optimizer. -P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B#qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. +P-BFGS is a parallelized version of [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") with which it shares the same parameters. P-BFGS can be useful when the target hardware is a quantum simulator running on a classical machine. This allows the multiple processes to use simulation to potentially reach a minimum faster. The parallelization may also help the optimizer avoid getting stuck at local optima. Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.fmin\_l\_bfgs\_b.html](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.fmin_l_bfgs_b.html) @@ -21,92 +29,191 @@ Uses scipy.optimize.fmin\_l\_bfgs\_b. For further detail, please refer to [https ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.P_BFGS.get_support_level#qiskit.aqua.components.optimizers.P_BFGS.get_support_level "qiskit.aqua.components.optimizers.P_BFGS.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.P_BFGS.gradient_num_diff#qiskit.aqua.components.optimizers.P_BFGS.gradient_num_diff "qiskit.aqua.components.optimizers.P_BFGS.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.P_BFGS.optimize#qiskit.aqua.components.optimizers.P_BFGS.optimize "qiskit.aqua.components.optimizers.P_BFGS.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.P_BFGS.print_options#qiskit.aqua.components.optimizers.P_BFGS.print_options "qiskit.aqua.components.optimizers.P_BFGS.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.P_BFGS.set_max_evals_grouped#qiskit.aqua.components.optimizers.P_BFGS.set_max_evals_grouped "qiskit.aqua.components.optimizers.P_BFGS.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.P_BFGS.set_options#qiskit.aqua.components.optimizers.P_BFGS.set_options "qiskit.aqua.components.optimizers.P_BFGS.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.P_BFGS.wrap_function#qiskit.aqua.components.optimizers.P_BFGS.wrap_function "qiskit.aqua.components.optimizers.P_BFGS.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static P_BFGS.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`P_BFGS.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`P_BFGS.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`P_BFGS.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static P_BFGS.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 72cc473c77e..d4cf3418d3a 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 @@ -1,8 +1,16 @@ -# SLSQP +--- +title: SLSQP +description: API reference for qiskit.aqua.components.optimizers.SLSQP +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.SLSQP +--- +# SLSQP + -`SLSQP(maxiter=100, disp=False, ftol=1e-06, tol=None, eps=1.4901161193847656e-08)` +`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` @@ -24,92 +32,191 @@ Uses scipy.optimize.minimize SLSQP. For further detail, please refer to See [htt ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.SLSQP.get_support_level#qiskit.aqua.components.optimizers.SLSQP.get_support_level "qiskit.aqua.components.optimizers.SLSQP.get_support_level") | Return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.SLSQP.gradient_num_diff#qiskit.aqua.components.optimizers.SLSQP.gradient_num_diff "qiskit.aqua.components.optimizers.SLSQP.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.SLSQP.optimize#qiskit.aqua.components.optimizers.SLSQP.optimize "qiskit.aqua.components.optimizers.SLSQP.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.SLSQP.print_options#qiskit.aqua.components.optimizers.SLSQP.print_options "qiskit.aqua.components.optimizers.SLSQP.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.SLSQP.set_max_evals_grouped#qiskit.aqua.components.optimizers.SLSQP.set_max_evals_grouped "qiskit.aqua.components.optimizers.SLSQP.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.SLSQP.set_options#qiskit.aqua.components.optimizers.SLSQP.set_options "qiskit.aqua.components.optimizers.SLSQP.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.SLSQP.wrap_function#qiskit.aqua.components.optimizers.SLSQP.wrap_function "qiskit.aqua.components.optimizers.SLSQP.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static SLSQP.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`SLSQP.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`SLSQP.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`SLSQP.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static SLSQP.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 764df46ce1c..c12fdcc6f6e 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 @@ -1,8 +1,16 @@ -# SNOBFIT +--- +title: SNOBFIT +description: API reference for qiskit.aqua.components.optimizers.SNOBFIT +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.SNOBFIT +--- +# SNOBFIT + -`SNOBFIT(maxiter=1000, maxfail=10, maxmp=None, verbose=False)` +`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` @@ -21,96 +29,177 @@ Uses skquant.opt installed with pip install scikit-quant. For further detail, pl **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant or SQSnobFit not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – scikit-quant or SQSnobFit not installed ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.SNOBFIT.get_support_level#qiskit.aqua.components.optimizers.SNOBFIT.get_support_level "qiskit.aqua.components.optimizers.SNOBFIT.get_support_level") | Returns support level dictionary. | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.SNOBFIT.gradient_num_diff#qiskit.aqua.components.optimizers.SNOBFIT.gradient_num_diff "qiskit.aqua.components.optimizers.SNOBFIT.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.SNOBFIT.optimize#qiskit.aqua.components.optimizers.SNOBFIT.optimize "qiskit.aqua.components.optimizers.SNOBFIT.optimize") | Runs the optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.SNOBFIT.print_options#qiskit.aqua.components.optimizers.SNOBFIT.print_options "qiskit.aqua.components.optimizers.SNOBFIT.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.SNOBFIT.set_max_evals_grouped#qiskit.aqua.components.optimizers.SNOBFIT.set_max_evals_grouped "qiskit.aqua.components.optimizers.SNOBFIT.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.SNOBFIT.set_options#qiskit.aqua.components.optimizers.SNOBFIT.set_options "qiskit.aqua.components.optimizers.SNOBFIT.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.SNOBFIT.wrap_function#qiskit.aqua.components.optimizers.SNOBFIT.wrap_function "qiskit.aqua.components.optimizers.SNOBFIT.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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. + +### gradient\_num\_diff + + + +`static SNOBFIT.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +### print\_options + + + +`SNOBFIT.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`SNOBFIT.set_max_evals_grouped(limit)` + +Set max evals grouped + +### set\_options + + + +`SNOBFIT.set_options(**kwargs)` +Sets or updates values in the options dictionary. +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static SNOBFIT.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 681c0de69e0..9ea7dcf9cbe 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 @@ -1,8 +1,16 @@ -# SPSA +--- +title: SPSA +description: API reference for qiskit.aqua.components.optimizers.SPSA +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.SPSA +--- +# 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)` +`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` @@ -39,92 +47,191 @@ For further details, please refer to [https://arxiv.org/pdf/1704.05018v2.pdf#sec ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.SPSA.get_support_level#qiskit.aqua.components.optimizers.SPSA.get_support_level "qiskit.aqua.components.optimizers.SPSA.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.SPSA.gradient_num_diff#qiskit.aqua.components.optimizers.SPSA.gradient_num_diff "qiskit.aqua.components.optimizers.SPSA.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.SPSA.optimize#qiskit.aqua.components.optimizers.SPSA.optimize "qiskit.aqua.components.optimizers.SPSA.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.SPSA.print_options#qiskit.aqua.components.optimizers.SPSA.print_options "qiskit.aqua.components.optimizers.SPSA.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.SPSA.set_max_evals_grouped#qiskit.aqua.components.optimizers.SPSA.set_max_evals_grouped "qiskit.aqua.components.optimizers.SPSA.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.SPSA.set_options#qiskit.aqua.components.optimizers.SPSA.set_options "qiskit.aqua.components.optimizers.SPSA.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.SPSA.wrap_function#qiskit.aqua.components.optimizers.SPSA.wrap_function "qiskit.aqua.components.optimizers.SPSA.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static SPSA.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`SPSA.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`SPSA.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`SPSA.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static SPSA.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + 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 3912aa2782f..86a951cf3ff 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 @@ -1,14 +1,22 @@ -# TNC +--- +title: TNC +description: API reference for qiskit.aqua.components.optimizers.TNC +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.optimizers.TNC +--- +# TNC + -`TNC(maxiter=100, disp=False, accuracy=0, ftol=- 1, xtol=- 1, gtol=- 1, tol=None, eps=1e-08)` +`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` Truncated Newton (TNC) optimizer. -TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG#qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. +TNC uses a truncated Newton algorithm to minimize a function with variables subject to bounds. This algorithm uses gradient information; it is also called Newton Conjugate-Gradient. It differs from the [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") method as it wraps a C implementation and allows each variable to be given upper and lower bounds. Uses scipy.optimize.minimize TNC For further detail, please refer to See [https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html) @@ -25,92 +33,191 @@ Uses scipy.optimize.minimize TNC For further detail, please refer to See [https: ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`get_support_level`](qiskit.aqua.components.optimizers.TNC.get_support_level#qiskit.aqua.components.optimizers.TNC.get_support_level "qiskit.aqua.components.optimizers.TNC.get_support_level") | return support level dictionary | -| [`gradient_num_diff`](qiskit.aqua.components.optimizers.TNC.gradient_num_diff#qiskit.aqua.components.optimizers.TNC.gradient_num_diff "qiskit.aqua.components.optimizers.TNC.gradient_num_diff") | We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. | -| [`optimize`](qiskit.aqua.components.optimizers.TNC.optimize#qiskit.aqua.components.optimizers.TNC.optimize "qiskit.aqua.components.optimizers.TNC.optimize") | Perform optimization. | -| [`print_options`](qiskit.aqua.components.optimizers.TNC.print_options#qiskit.aqua.components.optimizers.TNC.print_options "qiskit.aqua.components.optimizers.TNC.print_options") | Print algorithm-specific options. | -| [`set_max_evals_grouped`](qiskit.aqua.components.optimizers.TNC.set_max_evals_grouped#qiskit.aqua.components.optimizers.TNC.set_max_evals_grouped "qiskit.aqua.components.optimizers.TNC.set_max_evals_grouped") | Set max evals grouped | -| [`set_options`](qiskit.aqua.components.optimizers.TNC.set_options#qiskit.aqua.components.optimizers.TNC.set_options "qiskit.aqua.components.optimizers.TNC.set_options") | Sets or updates values in the options dictionary. | -| [`wrap_function`](qiskit.aqua.components.optimizers.TNC.wrap_function#qiskit.aqua.components.optimizers.TNC.wrap_function "qiskit.aqua.components.optimizers.TNC.wrap_function") | Wrap the function to implicitly inject the args at the call of the function. | +### get\_support\_level -## Attributes + + +`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 + +### gradient\_num\_diff + + + +`static TNC.gradient_num_diff(x_center, f, epsilon, max_evals_grouped=1)` + +We compute the gradient with the numeric differentiation in the parallel way, around the point x\_center. + +**Parameters** + +* **x\_center** (*ndarray*) – point around which we compute the gradient +* **f** (*func*) – the function of which the gradient is to be computed. +* **epsilon** (*float*) – the epsilon used in the numeric differentiation. +* **max\_evals\_grouped** (*int*) – max evals grouped + +**Returns** + +the gradient computed + +**Return type** + +grad + +### optimize + + + +`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. + +**Parameters** + +* **num\_vars** (*int*) – Number of parameters to be optimized. +* **objective\_function** (*callable*) – A function that computes the objective function. +* **gradient\_function** (*callable*) – A function that computes the gradient of the objective function, or None if not available. +* **variable\_bounds** (*list\[(float, float)]*) – List of variable bounds, given as pairs (lower, upper). None means unbounded. +* **initial\_point** (*numpy.ndarray\[float]*) – Initial point. + +**Returns** + +**point, value, nfev** + +point: is a 1D numpy.ndarray\[float] containing the solution value: is a float with the objective function value nfev: number of objective function calls made if available or None + +**Raises** + +**ValueError** – invalid input + +### print\_options + + + +`TNC.print_options()` + +Print algorithm-specific options. + +### set\_max\_evals\_grouped + + + +`TNC.set_max_evals_grouped(limit)` +Set max evals grouped +### set\_options + + + +`TNC.set_options(**kwargs)` + +Sets or updates values in the options dictionary. + +The options dictionary may be used internally by a given optimizer to pass additional optional values for the underlying optimizer/optimization function used. The options dictionary may be initially populated with a set of key/values when the given optimizer is constructed. + +**Parameters** + +**kwargs** (*dict*) – options, given as name=value. + +### wrap\_function + + + +`static TNC.wrap_function(function, args)` + +Wrap the function to implicitly inject the args at the call of the function. + +**Parameters** + +* **function** (*func*) – the target function +* **args** (*tuple*) – the args to be injected + +**Returns** + +wrapper + +**Return type** + +function\_wrapper + +## Attributes + + ### bounds\_support\_level Returns bounds support level - + ### gradient\_support\_level Returns gradient support level - + ### initial\_point\_support\_level Returns initial point support level - + ### is\_bounds\_ignored Returns is bounds ignored - + ### is\_bounds\_required Returns is bounds required - + ### is\_bounds\_supported Returns is bounds supported - + ### is\_gradient\_ignored Returns is gradient ignored - + ### is\_gradient\_required Returns is gradient required - + ### is\_gradient\_supported Returns is gradient supported - + ### is\_initial\_point\_ignored Returns is initial point ignored - + ### is\_initial\_point\_required Returns is initial point required - + ### is\_initial\_point\_supported Returns is initial point supported - + ### setting Return setting + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.md b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.md index fbf02529023..534a28f9ad6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.optimizers.md @@ -16,7 +16,7 @@ python_api_name: qiskit.aqua.components.optimizers `qiskit.aqua.components.optimizers` -Aqua contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"). Logically, these optimizers can be divided into two categories: +Aqua contains a variety of classical optimizers for use by quantum variational algorithms, such as [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"). Logically, these optimizers can be divided into two categories: **[Local Optimizers](#local-optimizers)** @@ -28,36 +28,36 @@ Given an optimization problem, a **global optimizer** is a function that attempt # Optimizer Base Class -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`OptimizerSupportLevel`](qiskit.aqua.components.optimizers.OptimizerSupportLevel#qiskit.aqua.components.optimizers.OptimizerSupportLevel "qiskit.aqua.components.optimizers.OptimizerSupportLevel") | Support Level enum for features such as bounds, gradient and initial point | -| [`Optimizer`](qiskit.aqua.components.optimizers.Optimizer#qiskit.aqua.components.optimizers.Optimizer "qiskit.aqua.components.optimizers.Optimizer") | Base class for optimization algorithm. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | +| [`OptimizerSupportLevel`](qiskit.aqua.components.optimizers.OptimizerSupportLevel "qiskit.aqua.components.optimizers.OptimizerSupportLevel") | Support Level enum for features such as bounds, gradient and initial point | +| [`Optimizer`](qiskit.aqua.components.optimizers.Optimizer "qiskit.aqua.components.optimizers.Optimizer") | Base class for optimization algorithm. | # Local Optimizers -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- | -| [`ADAM`](qiskit.aqua.components.optimizers.ADAM#qiskit.aqua.components.optimizers.ADAM "qiskit.aqua.components.optimizers.ADAM") | Adam and AMSGRAD optimizers. | -| [`AQGD`](qiskit.aqua.components.optimizers.AQGD#qiskit.aqua.components.optimizers.AQGD "qiskit.aqua.components.optimizers.AQGD") | Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. | -| [`CG`](qiskit.aqua.components.optimizers.CG#qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") | Conjugate Gradient optimizer. | -| [`COBYLA`](qiskit.aqua.components.optimizers.COBYLA#qiskit.aqua.components.optimizers.COBYLA "qiskit.aqua.components.optimizers.COBYLA") | Constrained Optimization By Linear Approximation optimizer. | -| [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B#qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") | Limited-memory BFGS Bound optimizer. | -| [`GSLS`](qiskit.aqua.components.optimizers.GSLS#qiskit.aqua.components.optimizers.GSLS "qiskit.aqua.components.optimizers.GSLS") | Gaussian-smoothed Line Search. | -| [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD#qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") | Nelder-Mead optimizer. | -| [`NFT`](qiskit.aqua.components.optimizers.NFT#qiskit.aqua.components.optimizers.NFT "qiskit.aqua.components.optimizers.NFT") | Nakanishi-Fujii-Todo algorithm. | -| [`P_BFGS`](qiskit.aqua.components.optimizers.P_BFGS#qiskit.aqua.components.optimizers.P_BFGS "qiskit.aqua.components.optimizers.P_BFGS") | Parallelized Limited-memory BFGS optimizer. | -| [`POWELL`](qiskit.aqua.components.optimizers.POWELL#qiskit.aqua.components.optimizers.POWELL "qiskit.aqua.components.optimizers.POWELL") | Powell optimizer. | -| [`SLSQP`](qiskit.aqua.components.optimizers.SLSQP#qiskit.aqua.components.optimizers.SLSQP "qiskit.aqua.components.optimizers.SLSQP") | Sequential Least SQuares Programming optimizer. | -| [`SPSA`](qiskit.aqua.components.optimizers.SPSA#qiskit.aqua.components.optimizers.SPSA "qiskit.aqua.components.optimizers.SPSA") | Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. | -| [`TNC`](qiskit.aqua.components.optimizers.TNC#qiskit.aqua.components.optimizers.TNC "qiskit.aqua.components.optimizers.TNC") | Truncated Newton (TNC) optimizer. | +| | | +| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | +| [`ADAM`](qiskit.aqua.components.optimizers.ADAM "qiskit.aqua.components.optimizers.ADAM") | Adam and AMSGRAD optimizers. | +| [`AQGD`](qiskit.aqua.components.optimizers.AQGD "qiskit.aqua.components.optimizers.AQGD") | Analytic Quantum Gradient Descent (AQGD) with Epochs optimizer. | +| [`CG`](qiskit.aqua.components.optimizers.CG "qiskit.aqua.components.optimizers.CG") | Conjugate Gradient optimizer. | +| [`COBYLA`](qiskit.aqua.components.optimizers.COBYLA "qiskit.aqua.components.optimizers.COBYLA") | Constrained Optimization By Linear Approximation optimizer. | +| [`L_BFGS_B`](qiskit.aqua.components.optimizers.L_BFGS_B "qiskit.aqua.components.optimizers.L_BFGS_B") | Limited-memory BFGS Bound optimizer. | +| [`GSLS`](qiskit.aqua.components.optimizers.GSLS "qiskit.aqua.components.optimizers.GSLS") | Gaussian-smoothed Line Search. | +| [`NELDER_MEAD`](qiskit.aqua.components.optimizers.NELDER_MEAD "qiskit.aqua.components.optimizers.NELDER_MEAD") | Nelder-Mead optimizer. | +| [`NFT`](qiskit.aqua.components.optimizers.NFT "qiskit.aqua.components.optimizers.NFT") | Nakanishi-Fujii-Todo algorithm. | +| [`P_BFGS`](qiskit.aqua.components.optimizers.P_BFGS "qiskit.aqua.components.optimizers.P_BFGS") | Parallelized Limited-memory BFGS optimizer. | +| [`POWELL`](qiskit.aqua.components.optimizers.POWELL "qiskit.aqua.components.optimizers.POWELL") | Powell optimizer. | +| [`SLSQP`](qiskit.aqua.components.optimizers.SLSQP "qiskit.aqua.components.optimizers.SLSQP") | Sequential Least SQuares Programming optimizer. | +| [`SPSA`](qiskit.aqua.components.optimizers.SPSA "qiskit.aqua.components.optimizers.SPSA") | Simultaneous Perturbation Stochastic Approximation (SPSA) optimizer. | +| [`TNC`](qiskit.aqua.components.optimizers.TNC "qiskit.aqua.components.optimizers.TNC") | Truncated Newton (TNC) optimizer. | Qiskit Aqua also provides the following optimizers, which are built-out using the optimizers from the scikit-quant package. The scikit-quant package is not installed by default but must be explicitly installed, if desired, by the user - the optimizers therein are provided under various licenses so it has been made an optional install for the end user to choose whether to do so or not. To install the scikit-quant dependent package you can use pip install ‘qiskit-aqua\[skquant]’. -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| [`BOBYQA`](qiskit.aqua.components.optimizers.BOBYQA#qiskit.aqua.components.optimizers.BOBYQA "qiskit.aqua.components.optimizers.BOBYQA") | Bound Optimization BY Quadratic Approximation algorithm. | -| [`IMFIL`](qiskit.aqua.components.optimizers.IMFIL#qiskit.aqua.components.optimizers.IMFIL "qiskit.aqua.components.optimizers.IMFIL") | IMplicit FILtering algorithm. | -| [`SNOBFIT`](qiskit.aqua.components.optimizers.SNOBFIT#qiskit.aqua.components.optimizers.SNOBFIT "qiskit.aqua.components.optimizers.SNOBFIT") | Stable Noisy Optimization by Branch and FIT algorithm. | +| | | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| [`BOBYQA`](qiskit.aqua.components.optimizers.BOBYQA "qiskit.aqua.components.optimizers.BOBYQA") | Bound Optimization BY Quadratic Approximation algorithm. | +| [`IMFIL`](qiskit.aqua.components.optimizers.IMFIL "qiskit.aqua.components.optimizers.IMFIL") | IMplicit FILtering algorithm. | +| [`SNOBFIT`](qiskit.aqua.components.optimizers.SNOBFIT "qiskit.aqua.components.optimizers.SNOBFIT") | Stable Noisy Optimization by Branch and FIT algorithm. | # Global Optimizers @@ -67,11 +67,11 @@ The global optimizers here all use NLopt for their core function and can only be The global optimizers are as follows: -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| [`CRS`](qiskit.aqua.components.optimizers.CRS#qiskit.aqua.components.optimizers.CRS "qiskit.aqua.components.optimizers.CRS") | Controlled Random Search (CRS) with local mutation optimizer. | -| [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L#qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") | DIviding RECTangles Locally-biased optimizer. | -| [`DIRECT_L_RAND`](qiskit.aqua.components.optimizers.DIRECT_L_RAND#qiskit.aqua.components.optimizers.DIRECT_L_RAND "qiskit.aqua.components.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | -| [`ESCH`](qiskit.aqua.components.optimizers.ESCH#qiskit.aqua.components.optimizers.ESCH "qiskit.aqua.components.optimizers.ESCH") | ESCH evolutionary optimizer. | -| [`ISRES`](qiskit.aqua.components.optimizers.ISRES#qiskit.aqua.components.optimizers.ISRES "qiskit.aqua.components.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | +| [`CRS`](qiskit.aqua.components.optimizers.CRS "qiskit.aqua.components.optimizers.CRS") | Controlled Random Search (CRS) with local mutation optimizer. | +| [`DIRECT_L`](qiskit.aqua.components.optimizers.DIRECT_L "qiskit.aqua.components.optimizers.DIRECT_L") | DIviding RECTangles Locally-biased optimizer. | +| [`DIRECT_L_RAND`](qiskit.aqua.components.optimizers.DIRECT_L_RAND "qiskit.aqua.components.optimizers.DIRECT_L_RAND") | DIviding RECTangles Locally-biased Randomized optimizer. | +| [`ESCH`](qiskit.aqua.components.optimizers.ESCH "qiskit.aqua.components.optimizers.ESCH") | ESCH evolutionary optimizer. | +| [`ISRES`](qiskit.aqua.components.optimizers.ISRES "qiskit.aqua.components.optimizers.ISRES") | Improved Stochastic Ranking Evolution Strategy optimizer. | 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 d73cf7bf43a..95a27575e64 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 @@ -1,14 +1,22 @@ -# CustomCircuitOracle +--- +title: CustomCircuitOracle +description: API reference for qiskit.aqua.components.oracles.CustomCircuitOracle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.oracles.CustomCircuitOracle +--- +# CustomCircuitOracle + -`CustomCircuitOracle(variable_register, output_register, circuit, ancillary_register=None, evaluate_classically_callback=None)` +`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` The Custom Circuit-based Quantum Oracle. -A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle#qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. +A helper class to, in essence, ‘wrap’ a user-supplied quantum circuit such that it becomes of type [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") and hence can be used by algorithms taking an oracle as input. This class is provided for easy creation of oracles using custom circuits. It is geared towards programmatically experimenting with oracles, where a user directly provides a QuantumCircuit object, corresponding to the intended oracle function, together with the various QuantumRegister objects involved. @@ -17,7 +25,7 @@ This class is provided for easy creation of oracles using custom circuits. It is The input bitstring is a string of 1’s and 0’s corresponding to the input variable(s). The return should be a (bool, List\[int]) tuple where the bool corresponds to the return value of the *binary* function encoded by the oracle, and the List\[int] should just be a different representation of the input variable assignment, which should be equivalent to the bitstring or a quantum measurement. - Examples of existing implementations, for reference, can be found in other oracles such as [`TruthTableOracle.evaluate_classically()`](qiskit.aqua.components.oracles.TruthTableOracle.evaluate_classically#qiskit.aqua.components.oracles.TruthTableOracle.evaluate_classically "qiskit.aqua.components.oracles.TruthTableOracle.evaluate_classically") and [`LogicalExpressionOracle.evaluate_classically()`](qiskit.aqua.components.oracles.LogicalExpressionOracle.evaluate_classically#qiskit.aqua.components.oracles.LogicalExpressionOracle.evaluate_classically "qiskit.aqua.components.oracles.LogicalExpressionOracle.evaluate_classically"). + Examples of existing implementations, for reference, can be found in other oracles such as [`TruthTableOracle.evaluate_classically()`](qiskit.aqua.components.oracles.TruthTableOracle#evaluate_classically "qiskit.aqua.components.oracles.TruthTableOracle.evaluate_classically") and [`LogicalExpressionOracle.evaluate_classically()`](qiskit.aqua.components.oracles.LogicalExpressionOracle#evaluate_classically "qiskit.aqua.components.oracles.LogicalExpressionOracle.evaluate_classically"). **Parameters** @@ -26,32 +34,45 @@ This class is provided for easy creation of oracles using custom circuits. It is * **output\_register** (`QuantumRegister`) – The register holding output qubit(s) for the oracle function * **circuit** (`QuantumCircuit`) – The quantum circuit corresponding to the intended oracle function * **ancillary\_register** (`Optional`\[`QuantumRegister`]) – The register holding ancillary qubit(s) -* **evaluate\_classically\_callback** (`Optional`\[`Callable`\[\[`str`], `Tuple`\[`bool`, `List`\[`int`]]]]) – The classical callback function for evaluating the oracle, for example, to use with [`Grover`](qiskit.aqua.algorithms.Grover#qiskit.aqua.algorithms.Grover "qiskit.aqua.algorithms.Grover")’s search +* **evaluate\_classically\_callback** (`Optional`\[`Callable`\[\[`str`], `Tuple`\[`bool`, `List`\[`int`]]]]) – The classical callback function for evaluating the oracle, for example, to use with [`Grover`](qiskit.aqua.algorithms.Grover "qiskit.aqua.algorithms.Grover")’s search **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid input ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`construct_circuit`](qiskit.aqua.components.oracles.CustomCircuitOracle.construct_circuit#qiskit.aqua.components.oracles.CustomCircuitOracle.construct_circuit "qiskit.aqua.components.oracles.CustomCircuitOracle.construct_circuit") | Construct the oracle circuit. | +### construct\_circuit -## Attributes + +`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. -### ancillary\_register +**Returns** +A quantum circuit for the oracle. +**Return type** -### circuit +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +## Attributes + -### output\_register +### ancillary\_register + + +### circuit + + +### output\_register + + ### variable\_register + 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 ed17a9b8ea0..af31497f164 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 @@ -1,8 +1,16 @@ -# LogicalExpressionOracle +--- +title: LogicalExpressionOracle +description: API reference for qiskit.aqua.components.oracles.LogicalExpressionOracle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.oracles.LogicalExpressionOracle +--- +# LogicalExpressionOracle + -`LogicalExpressionOracle(expression, optimization=False, mct_mode='basic')` +`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` @@ -42,35 +50,47 @@ By default, the Logical Expression oracle will not try to apply any optimization **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid input ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -| [`construct_circuit`](qiskit.aqua.components.oracles.LogicalExpressionOracle.construct_circuit#qiskit.aqua.components.oracles.LogicalExpressionOracle.construct_circuit "qiskit.aqua.components.oracles.LogicalExpressionOracle.construct_circuit") | construct circuit | -| [`evaluate_classically`](qiskit.aqua.components.oracles.LogicalExpressionOracle.evaluate_classically#qiskit.aqua.components.oracles.LogicalExpressionOracle.evaluate_classically "qiskit.aqua.components.oracles.LogicalExpressionOracle.evaluate_classically") | evaluate classically | +### construct\_circuit -## Attributes + + +`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 + +### evaluate\_classically + + +`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 + +## Attributes + + ### ancillary\_register returns ancillary register - + ### circuit - + ### output\_register returns output register - + ### variable\_register returns variable register + 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 e0f7ceb443a..bc8909a4dd2 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 @@ -1,8 +1,16 @@ -# Oracle +--- +title: Oracle +description: API reference for qiskit.aqua.components.oracles.Oracle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.oracles.Oracle +--- +# Oracle + -`Oracle(*args, **kwargs)` +`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` @@ -17,30 +25,39 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | -| [`construct_circuit`](qiskit.aqua.components.oracles.Oracle.construct_circuit#qiskit.aqua.components.oracles.Oracle.construct_circuit "qiskit.aqua.components.oracles.Oracle.construct_circuit") | Construct the oracle circuit. | +### construct\_circuit -## Attributes + + +`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. + +**Returns** +A quantum circuit for the oracle. +## Attributes + + ### ancillary\_register returns ancillary register - + ### circuit - + ### output\_register returns output register - + ### variable\_register returns variable register + 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 5d062d36986..83f64fb7476 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 @@ -1,14 +1,22 @@ -# TruthTableOracle +--- +title: TruthTableOracle +description: API reference for qiskit.aqua.components.oracles.TruthTableOracle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.oracles.TruthTableOracle +--- +# TruthTableOracle + -`TruthTableOracle(bitmaps, optimization=False, mct_mode='basic')` +`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` The Truth Table-based Quantum Oracle. -Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle#qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: +Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle")) another common way of specifying boolean functions is using truth tables, which is basically an exhaustive mapping from input binary bit-strings of length $n$ to corresponding output bit-strings of length $m$. For example, the following is a simple truth table that corresponds to the XOR of two variables: | Inputs | | Output | | ------ | - | ------- | @@ -20,7 +28,7 @@ Besides logical expressions, (see [`LogicalExpressionOracle`](qiskit.aqua.compon In this case $n=2$, and $m=1$. Often, for brevity, the input bit-strings are omitted because they can be easily derived for any given $n$. So to completely specify a truth table, we only need a Length-2 n bit-string for each of the $m$ outputs. In the above example, a single bit-string ‘0110’ would suffice. Besides ‘0’ and ‘1’, one can also use ‘x’ in the output string to indicate ‘do-not-care’ entries. For example, ‘101x’ specifies a truth table (again $n=2$ and $m=1$) for which the output upon input ‘11’ doesn’t matter. The truth table oracle takes either a single string or a list of equal-length strings for truth table specifications. -Regarding circuit optimization and mct usages, the truth table oracle is similar to the [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle#qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle"). One difference is that, unlike the logical expression oracle which builds circuits out of CNF or DNF, the truth table oracle uses Exclusive Sum of Products (ESOP), which is similar to DNF, with the only difference being the outermost operation being XOR as opposed to a disjunction. Because of this difference, an implicant-based method is used here for circuit optimization: First, the [Quine-McCluskey algorithm](https://en.wikipedia.org/wiki/Quine-McCluskey_algorithm) is used to find all prime implicants of the input truth table; then an [Exact Cover](https://en.wikipedia.org/wiki/Knuth%27s_Algorithm_X) is found among all prime implicants and truth table onset row entries. The exact cover is then used to build the corresponding oracle circuit. +Regarding circuit optimization and mct usages, the truth table oracle is similar to the [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle"). One difference is that, unlike the logical expression oracle which builds circuits out of CNF or DNF, the truth table oracle uses Exclusive Sum of Products (ESOP), which is similar to DNF, with the only difference being the outermost operation being XOR as opposed to a disjunction. Because of this difference, an implicant-based method is used here for circuit optimization: First, the [Quine-McCluskey algorithm](https://en.wikipedia.org/wiki/Quine-McCluskey_algorithm) is used to find all prime implicants of the input truth table; then an [Exact Cover](https://en.wikipedia.org/wiki/Knuth%27s_Algorithm_X) is found among all prime implicants and truth table onset row entries. The exact cover is then used to build the corresponding oracle circuit. **Parameters** @@ -30,35 +38,47 @@ Regarding circuit optimization and mct usages, the truth table oracle is similar **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid input +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ | -| [`construct_circuit`](qiskit.aqua.components.oracles.TruthTableOracle.construct_circuit#qiskit.aqua.components.oracles.TruthTableOracle.construct_circuit "qiskit.aqua.components.oracles.TruthTableOracle.construct_circuit") | construct circuit | -| [`evaluate_classically`](qiskit.aqua.components.oracles.TruthTableOracle.evaluate_classically#qiskit.aqua.components.oracles.TruthTableOracle.evaluate_classically "qiskit.aqua.components.oracles.TruthTableOracle.evaluate_classically") | evaluate classical | +### construct\_circuit -## Attributes + + +`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 + +### evaluate\_classically + + +`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 + +## Attributes + + ### ancillary\_register returns ancillary register - + ### circuit - + ### output\_register returns output register - + ### variable\_register returns variable register + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.md b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.md index 5dd2cabd8d3..ac4bc30a4a0 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.oracles.md @@ -18,19 +18,19 @@ python_api_name: qiskit.aqua.components.oracles An oracle is a black box operation used as input to another algorithm. They tend to encode a function $f:\{0,1\}^n \rightarrow \{0,1\}^m$ where the goal of the algorithm is to determine some property of $f$. -Oracles are used by [`Grover`](qiskit.aqua.algorithms.Grover#qiskit.aqua.algorithms.Grover "qiskit.aqua.algorithms.Grover") and [`DeutschJozsa`](qiskit.aqua.algorithms.DeutschJozsa#qiskit.aqua.algorithms.DeutschJozsa "qiskit.aqua.algorithms.DeutschJozsa") algorithms for example. +Oracles are used by [`Grover`](qiskit.aqua.algorithms.Grover "qiskit.aqua.algorithms.Grover") and [`DeutschJozsa`](qiskit.aqua.algorithms.DeutschJozsa "qiskit.aqua.algorithms.DeutschJozsa") algorithms for example. # Oracle Base Class -| | | -| ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -| [`Oracle`](qiskit.aqua.components.oracles.Oracle#qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") | Base class for oracles. | +| | | +| ----------------------------------------------------------------------------------------- | ----------------------- | +| [`Oracle`](qiskit.aqua.components.oracles.Oracle "qiskit.aqua.components.oracles.Oracle") | Base class for oracles. | # Oracles -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle#qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle") | The Logical Expression Quantum Oracle. | -| [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle#qiskit.aqua.components.oracles.TruthTableOracle "qiskit.aqua.components.oracles.TruthTableOracle") | The Truth Table-based Quantum Oracle. | -| [`CustomCircuitOracle`](qiskit.aqua.components.oracles.CustomCircuitOracle#qiskit.aqua.components.oracles.CustomCircuitOracle "qiskit.aqua.components.oracles.CustomCircuitOracle") | The Custom Circuit-based Quantum Oracle. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| [`LogicalExpressionOracle`](qiskit.aqua.components.oracles.LogicalExpressionOracle "qiskit.aqua.components.oracles.LogicalExpressionOracle") | The Logical Expression Quantum Oracle. | +| [`TruthTableOracle`](qiskit.aqua.components.oracles.TruthTableOracle "qiskit.aqua.components.oracles.TruthTableOracle") | The Truth Table-based Quantum Oracle. | +| [`CustomCircuitOracle`](qiskit.aqua.components.oracles.CustomCircuitOracle "qiskit.aqua.components.oracles.CustomCircuitOracle") | The Custom Circuit-based Quantum Oracle. | 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 de92ac97645..ba457478c4f 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 @@ -1,8 +1,16 @@ -# LongDivision +--- +title: LongDivision +description: API reference for qiskit.aqua.components.reciprocals.LongDivision +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.reciprocals.LongDivision +--- +# LongDivision + -`LongDivision(scale=0, precision=None, negative_evals=False, evo_time=None, lambda_min=None)` +`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` @@ -24,7 +32,46 @@ It finds the reciprocal with long division method and rotates the ancillary qubi ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.reciprocals.LongDivision.construct_circuit#qiskit.aqua.components.reciprocals.LongDivision.construct_circuit "qiskit.aqua.components.reciprocals.LongDivision.construct_circuit") | Construct the Long Division Rotation circuit. | -| [`sv_to_resvec`](qiskit.aqua.components.reciprocals.LongDivision.sv_to_resvec#qiskit.aqua.components.reciprocals.LongDivision.sv_to_resvec "qiskit.aqua.components.reciprocals.LongDivision.sv_to_resvec") | Convert statevector to result vector. | +### construct\_circuit + + + +`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. + +**Parameters** + +* **mode** (*str*) – construction mode, ‘matrix’ not supported +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – input register, typically output register of Eigenvalues +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Quantum Circuit or None + +**Returns** + +containing the Long Division Rotation circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**NotImplementedError** – mode not supported + +### sv\_to\_resvec + + + +`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. + +**Parameters** + +* **statevector** (*list*) – The statevector from simulation. +* **num\_q** (*int*) – Number of qubits of result register. + +**Returns** + +The 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 e7c7c61ef80..d8db023f7f4 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 @@ -1,8 +1,16 @@ -# LookupRotation +--- +title: LookupRotation +description: API reference for qiskit.aqua.components.reciprocals.LookupRotation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.reciprocals.LookupRotation +--- +# LookupRotation + -`LookupRotation(pat_length=None, subpat_length=None, scale=0, negative_evals=False, evo_time=None, lambda_min=None)` +`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` @@ -23,7 +31,45 @@ A calculation of reciprocals of eigenvalues is performed and controlled rotation ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.reciprocals.LookupRotation.construct_circuit#qiskit.aqua.components.reciprocals.LookupRotation.construct_circuit "qiskit.aqua.components.reciprocals.LookupRotation.construct_circuit") | Construct the Lookup Rotation circuit. | -| [`sv_to_resvec`](qiskit.aqua.components.reciprocals.LookupRotation.sv_to_resvec#qiskit.aqua.components.reciprocals.LookupRotation.sv_to_resvec "qiskit.aqua.components.reciprocals.LookupRotation.sv_to_resvec") | Convert statevector to result vector. | +### construct\_circuit + + + +`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. + +**Parameters** + +* **mode** (*str*) – construction mode, ‘matrix’ not supported +* **inreg** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – input register, typically output register of Eigenvalues + +**Returns** + +containing the Lookup Rotation circuit. + +**Return type** + +QuantumCircuit + +**Raises:** + +NotImplementedError: mode not supported + +### sv\_to\_resvec + + + +`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. + +**Parameters** + +* **statevector** (*list*) – The statevector from simulation. +* **num\_q** (*int*) – Number of qubits of result register. + +**Returns** + +The 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 7d91d589060..fe08d1e0579 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 @@ -1,8 +1,16 @@ -# Reciprocal +--- +title: Reciprocal +description: API reference for qiskit.aqua.components.reciprocals.Reciprocal +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.reciprocals.Reciprocal +--- +# Reciprocal + -`Reciprocal` +`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` @@ -12,7 +20,38 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.reciprocals.Reciprocal.construct_circuit#qiskit.aqua.components.reciprocals.Reciprocal.construct_circuit "qiskit.aqua.components.reciprocals.Reciprocal.construct_circuit") | Construct the initial state circuit. | -| [`sv_to_resvec`](qiskit.aqua.components.reciprocals.Reciprocal.sv_to_resvec#qiskit.aqua.components.reciprocals.Reciprocal.sv_to_resvec "qiskit.aqua.components.reciprocals.Reciprocal.sv_to_resvec") | Convert statevector to result vector. | +### construct\_circuit + + + +`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. + +**Parameters** + +* **mode** (*str*) – ‘matrix’ or ‘circuit’ +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – register for circuit construction. +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – circuit for construction. + +**Returns** + +The reciprocal circuit. + +### sv\_to\_resvec + + + +`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. + +**Parameters** + +* **statevector** (*list*) – The statevector from simulation. +* **num\_q** (*int*) – Number of qubits of result register. + +**Returns** + +The result vector. + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.md b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.md index ef72785fb33..704a0309747 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.reciprocals.md @@ -16,18 +16,18 @@ python_api_name: qiskit.aqua.components.reciprocals `qiskit.aqua.components.reciprocals` -Reciprocals are components to invert a fixed-point number prepared in a quantum register. They were designed to be used in the context of a larger algorithm such as [`HHL`](qiskit.aqua.algorithms.HHL#qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). +Reciprocals are components to invert a fixed-point number prepared in a quantum register. They were designed to be used in the context of a larger algorithm such as [`HHL`](qiskit.aqua.algorithms.HHL "qiskit.aqua.algorithms.HHL"). # Reciprocal Base Class -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`Reciprocal`](qiskit.aqua.components.reciprocals.Reciprocal#qiskit.aqua.components.reciprocals.Reciprocal "qiskit.aqua.components.reciprocals.Reciprocal") | Base class for reciprocal calculation. | +| | | +| ------------------------------------------------------------------------------------------------------------- | -------------------------------------- | +| [`Reciprocal`](qiskit.aqua.components.reciprocals.Reciprocal "qiskit.aqua.components.reciprocals.Reciprocal") | Base class for reciprocal calculation. | # Reciprocals -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| [`LookupRotation`](qiskit.aqua.components.reciprocals.LookupRotation#qiskit.aqua.components.reciprocals.LookupRotation "qiskit.aqua.components.reciprocals.LookupRotation") | The Lookup Rotation for Reciprocals. | -| [`LongDivision`](qiskit.aqua.components.reciprocals.LongDivision#qiskit.aqua.components.reciprocals.LongDivision "qiskit.aqua.components.reciprocals.LongDivision") | The Long Division Rotation for Reciprocals. | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| [`LookupRotation`](qiskit.aqua.components.reciprocals.LookupRotation "qiskit.aqua.components.reciprocals.LookupRotation") | The Lookup Rotation for Reciprocals. | +| [`LongDivision`](qiskit.aqua.components.reciprocals.LongDivision "qiskit.aqua.components.reciprocals.LongDivision") | The Long Division Rotation for Reciprocals. | 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 404ce9ec273..545dc579533 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 @@ -1,8 +1,16 @@ -# BernoulliDistribution +--- +title: BernoulliDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.BernoulliDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.BernoulliDistribution +--- +# BernoulliDistribution + -`BernoulliDistribution(p, low=0, high=1)` +`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` @@ -18,60 +26,184 @@ Distribution with only two values (low, high) and the corresponding probabilitie ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`build`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_power#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_power "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.pdf_to_probabilities") | Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.BernoulliDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.BernoulliDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`BernoulliDistribution.build(qc, q, q_ancillas=None, params=None)` + +### build\_controlled + + + +`BernoulliDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`BernoulliDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`BernoulliDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`BernoulliDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`BernoulliDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`BernoulliDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + +`BernoulliDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`BernoulliDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`BernoulliDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static BernoulliDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it + +**Parameters** + +* **pdf** (*function*) – probability density function +* **low** (*float*) – lower bound of equidistant grid +* **high** (*float*) – upper bound of equidistant grid +* **num\_values** (*int*) – number of grid points + +**Returns** + +array of probabilities + +**Return type** + +list + +### required\_ancillas + + + +`BernoulliDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`BernoulliDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### high returns high - + ### low returns low - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### p - + ### probabilities returns probabilities - + ### values returns values + 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 a8c9a626ba2..91cc535509c 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 @@ -1,8 +1,16 @@ -# GaussianConditionalIndependenceModel +--- +title: GaussianConditionalIndependenceModel +description: API reference for qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel +--- +# GaussianConditionalIndependenceModel + -`GaussianConditionalIndependenceModel(n_normal, normal_max_value, p_zeros, rhos, i_normal=None, i_ps=None)` +`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` @@ -23,74 +31,183 @@ Dependency between individual risk variables and latent variable is approximated ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_power#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_power "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_inverse#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_inverse "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_inverse_power#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_inverse_power "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_power#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_power "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.get_num_qubits#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.get_num_qubits "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.pdf_to_probabilities") | pdf to probabilities | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.required_ancillas#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.required_ancillas "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + + + +`GaussianConditionalIndependenceModel.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`GaussianConditionalIndependenceModel.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`GaussianConditionalIndependenceModel.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`GaussianConditionalIndependenceModel.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`GaussianConditionalIndependenceModel.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`GaussianConditionalIndependenceModel.build_inverse_power(qc, q, power, q_ancillas=None)` +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible +### build\_power + + + +`GaussianConditionalIndependenceModel.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`GaussianConditionalIndependenceModel.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`GaussianConditionalIndependenceModel.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static GaussianConditionalIndependenceModel.pdf_to_probabilities(pdf, low, high, num_values)` + +pdf to probabilities + +### required\_ancillas + + + +`GaussianConditionalIndependenceModel.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`GaussianConditionalIndependenceModel.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### dimension returns dimensions - + ### high returns high - + ### low returns low - + ### num\_qubits returns num qubits - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### probabilities\_vector returns probabilities vector - + ### values returns values + 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 fb5659f7dcc..c8f212d4df1 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 @@ -1,8 +1,16 @@ -# LogNormalDistribution +--- +title: LogNormalDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.LogNormalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.LogNormalDistribution +--- +# LogNormalDistribution + -`LogNormalDistribution(num_target_qubits, mu=0, sigma=1, low=0, high=1)` +`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` @@ -20,56 +28,180 @@ Log-normal distribution, truncated to lower and upper bound and discretized on a ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`build`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_power#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_power "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.pdf_to_probabilities") | Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.LogNormalDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.LogNormalDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`LogNormalDistribution.build(qc, q, q_ancillas=None, params=None)` + +### build\_controlled + + + +`LogNormalDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`LogNormalDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`LogNormalDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`LogNormalDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`LogNormalDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`LogNormalDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + +`LogNormalDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`LogNormalDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`LogNormalDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static LogNormalDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it + +**Parameters** + +* **pdf** (*function*) – probability density function +* **low** (*float*) – lower bound of equidistant grid +* **high** (*float*) – upper bound of equidistant grid +* **num\_values** (*int*) – number of grid points + +**Returns** + +array of probabilities + +**Return type** + +list + +### required\_ancillas + + + +`LogNormalDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`LogNormalDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### high returns high - + ### low returns low - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### values returns values + 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 a23f0ff2376..6b9bc9c32d7 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 @@ -1,8 +1,16 @@ -# MultivariateDistribution +--- +title: MultivariateDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.MultivariateDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateDistribution +--- +# MultivariateDistribution + -`MultivariateDistribution(num_qubits, probabilities=None, low=None, high=None)` +`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` @@ -17,74 +25,183 @@ This module contains the definition of a base class for multivariate distributio ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_power#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_power "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.pdf_to_probabilities") | pdf to probabilities | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.MultivariateDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.MultivariateDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + + + +`MultivariateDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`MultivariateDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`MultivariateDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`MultivariateDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`MultivariateDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`MultivariateDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible +### build\_power + + + +`MultivariateDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`MultivariateDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`MultivariateDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`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 + +### required\_ancillas + + + +`MultivariateDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`MultivariateDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### dimension returns dimensions - + ### high returns high - + ### low returns low - + ### num\_qubits returns num qubits - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### probabilities\_vector returns probabilities vector - + ### values returns values + 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 aaa5ab53c3a..b0da929a0d1 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 @@ -1,8 +1,16 @@ -# MultivariateLogNormalDistribution +--- +title: MultivariateLogNormalDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution +--- +# MultivariateLogNormalDistribution + -`MultivariateLogNormalDistribution(num_qubits, low=None, high=None, mu=None, cov=None)` +`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` @@ -18,74 +26,183 @@ The Multivariate Log-Normal Distribution. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_power#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_power "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.pdf_to_probabilities") | pdf to probabilities | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`MultivariateLogNormalDistribution.build(qc, q, q_ancillas=None, params=None)` + +### build\_controlled + + + +`MultivariateLogNormalDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`MultivariateLogNormalDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`MultivariateLogNormalDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`MultivariateLogNormalDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`MultivariateLogNormalDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`MultivariateLogNormalDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible +### build\_power + + + +`MultivariateLogNormalDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`MultivariateLogNormalDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`MultivariateLogNormalDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static MultivariateLogNormalDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +pdf to probabilities + +### required\_ancillas + + + +`MultivariateLogNormalDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`MultivariateLogNormalDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### dimension returns dimensions - + ### high returns high - + ### low returns low - + ### num\_qubits returns num qubits - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### probabilities\_vector returns probabilities vector - + ### values returns values + 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 43389b86643..56b5c191c73 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 @@ -1,8 +1,16 @@ -# MultivariateNormalDistribution +--- +title: MultivariateNormalDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution +--- +# MultivariateNormalDistribution + -`MultivariateNormalDistribution(num_qubits, low=None, high=None, mu=None, sigma=None)` +`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` @@ -20,74 +28,183 @@ Provides a discretized and truncated normal distribution loaded into a quantum s ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_power#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_power "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.pdf_to_probabilities") | pdf to probabilities | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`MultivariateNormalDistribution.build(qc, q, q_ancillas=None, params=None)` + +### build\_controlled + + + +`MultivariateNormalDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`MultivariateNormalDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`MultivariateNormalDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`MultivariateNormalDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`MultivariateNormalDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`MultivariateNormalDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible +### build\_power + + + +`MultivariateNormalDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`MultivariateNormalDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`MultivariateNormalDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static MultivariateNormalDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +pdf to probabilities + +### required\_ancillas + + + +`MultivariateNormalDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`MultivariateNormalDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### dimension returns dimensions - + ### high returns high - + ### low returns low - + ### num\_qubits returns num qubits - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### probabilities\_vector returns probabilities vector - + ### values returns values + 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 caa9d9e96b2..e9517faa06b 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 @@ -1,8 +1,16 @@ -# MultivariateUniformDistribution +--- +title: MultivariateUniformDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution +--- +# MultivariateUniformDistribution + -`MultivariateUniformDistribution(num_qubits, low=None, high=None)` +`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` @@ -18,74 +26,183 @@ Although this just results in a Hadamard gate on all involved qubits, the lower ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_power#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_power "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.pdf_to_probabilities") | pdf to probabilities | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + + + +`MultivariateUniformDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`MultivariateUniformDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`MultivariateUniformDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`MultivariateUniformDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`MultivariateUniformDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`MultivariateUniformDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible +### build\_power + + + +`MultivariateUniformDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`MultivariateUniformDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`MultivariateUniformDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static MultivariateUniformDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +pdf to probabilities + +### required\_ancillas + + + +`MultivariateUniformDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`MultivariateUniformDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### dimension returns dimensions - + ### high returns high - + ### low returns low - + ### num\_qubits returns num qubits - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### probabilities\_vector returns probabilities vector - + ### values returns values + 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 163cda1f6e5..82225843582 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 @@ -1,8 +1,16 @@ -# MultivariateVariationalDistribution +--- +title: MultivariateVariationalDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution +--- +# MultivariateVariationalDistribution + -`MultivariateVariationalDistribution(num_qubits, var_form, params, low=None, high=None)` +`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` @@ -18,75 +26,195 @@ The Multivariate Variational Distribution. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_power#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_power "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.pdf_to_probabilities") | pdf to probabilities | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.required_ancillas_controlled") | returns required ancillas controlled | -| [`set_probabilities`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.set_probabilities#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.set_probabilities "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution.set_probabilities") | Set Probabilities | +### build -## Attributes + + +`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 + + + +`MultivariateVariationalDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`MultivariateVariationalDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`MultivariateVariationalDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`MultivariateVariationalDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`MultivariateVariationalDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`MultivariateVariationalDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + +`MultivariateVariationalDistribution.build_power(qc, q, power, q_ancillas=None)` +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`MultivariateVariationalDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`MultivariateVariationalDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static MultivariateVariationalDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +pdf to probabilities + +### required\_ancillas + + + +`MultivariateVariationalDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`MultivariateVariationalDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +### set\_probabilities + + + +`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 + +**Parameters** + +**quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – Quantum Instance + +## Attributes + + ### dimension returns dimensions - + ### high returns high - + ### low returns low - + ### num\_qubits returns num qubits - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### probabilities\_vector returns probabilities vector - + ### values returns values + 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 faaca50f816..574d76b9062 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 @@ -1,8 +1,16 @@ -# NormalDistribution +--- +title: NormalDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.NormalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.NormalDistribution +--- +# NormalDistribution + -`NormalDistribution(num_target_qubits, mu=0, sigma=1, low=- 1, high=1)` +`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` @@ -20,56 +28,180 @@ Normal distribution, truncated to lower and upper bound and discretized on a gri ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`build`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build#qiskit.aqua.components.uncertainty_models.NormalDistribution.build "qiskit.aqua.components.uncertainty_models.NormalDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.NormalDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.NormalDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.NormalDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.NormalDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.NormalDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.NormalDistribution.build_power#qiskit.aqua.components.uncertainty_models.NormalDistribution.build_power "qiskit.aqua.components.uncertainty_models.NormalDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.NormalDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.NormalDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.NormalDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.NormalDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.NormalDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.NormalDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.NormalDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.NormalDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.NormalDistribution.pdf_to_probabilities") | Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.NormalDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.NormalDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.NormalDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.NormalDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.NormalDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.NormalDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`NormalDistribution.build(qc, q, q_ancillas=None, params=None)` + +### build\_controlled + + + +`NormalDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`NormalDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`NormalDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`NormalDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`NormalDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`NormalDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + +`NormalDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`NormalDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`NormalDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static NormalDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it + +**Parameters** + +* **pdf** (*function*) – probability density function +* **low** (*float*) – lower bound of equidistant grid +* **high** (*float*) – upper bound of equidistant grid +* **num\_values** (*int*) – number of grid points + +**Returns** + +array of probabilities + +**Return type** + +list + +### required\_ancillas + + + +`NormalDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`NormalDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### high returns high - + ### low returns low - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### values returns values + 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 cafa5aa80d1..3d78ef0f430 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 @@ -1,8 +1,16 @@ -# UncertaintyModel +--- +title: UncertaintyModel +description: API reference for qiskit.aqua.components.uncertainty_models.UncertaintyModel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.UncertaintyModel +--- +# UncertaintyModel + -`UncertaintyModel(num_target_qubits)` +`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` @@ -10,25 +18,136 @@ The abstract Uncertainty Model ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_power#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_power "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_inverse#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_inverse "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_inverse_power#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_inverse_power "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_power#qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_power "qiskit.aqua.components.uncertainty_models.UncertaintyModel.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.get_num_qubits#qiskit.aqua.components.uncertainty_models.UncertaintyModel.get_num_qubits "qiskit.aqua.components.uncertainty_models.UncertaintyModel.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.UncertaintyModel.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.UncertaintyModel.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.required_ancillas#qiskit.aqua.components.uncertainty_models.UncertaintyModel.required_ancillas "qiskit.aqua.components.uncertainty_models.UncertaintyModel.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.UncertaintyModel.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.UncertaintyModel.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.UncertaintyModel.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`UncertaintyModel.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`UncertaintyModel.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`UncertaintyModel.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`UncertaintyModel.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`UncertaintyModel.build_inverse(qc, q, q_ancillas=None)` +Adds inverse of corresponding sub-circuit to given circuit +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`UncertaintyModel.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`UncertaintyModel.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`UncertaintyModel.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`UncertaintyModel.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`UncertaintyModel.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`UncertaintyModel.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + 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 eeda3fb18a8..7cca0f927c4 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 @@ -1,8 +1,16 @@ -# UniformDistribution +--- +title: UniformDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.UniformDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.UniformDistribution +--- +# UniformDistribution + -`UniformDistribution(num_target_qubits, low=0, high=1)` +`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` @@ -18,56 +26,180 @@ Uniform distribution is defined by the number of qubits that should be used to r ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`build`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build#qiskit.aqua.components.uncertainty_models.UniformDistribution.build "qiskit.aqua.components.uncertainty_models.UniformDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.UniformDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.UniformDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.UniformDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.UniformDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.UniformDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.UniformDistribution.build_power#qiskit.aqua.components.uncertainty_models.UniformDistribution.build_power "qiskit.aqua.components.uncertainty_models.UniformDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.UniformDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.UniformDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.UniformDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.UniformDistribution.pdf_to_probabilities") | Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.UniformDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + + + +`UniformDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`UniformDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`UniformDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`UniformDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`UniformDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`UniformDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + +`UniformDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`UniformDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`UniformDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static UniformDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it + +**Parameters** + +* **pdf** (*function*) – probability density function +* **low** (*float*) – lower bound of equidistant grid +* **high** (*float*) – upper bound of equidistant grid +* **num\_values** (*int*) – number of grid points + +**Returns** + +array of probabilities + +**Return type** + +list + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`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 + +## Attributes + + ### high returns high - + ### low returns low - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### values returns values + 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 9af798a689f..a7f59c743ae 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 @@ -1,8 +1,16 @@ -# UnivariateDistribution +--- +title: UnivariateDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.UnivariateDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateDistribution +--- +# UnivariateDistribution + -`UnivariateDistribution(num_target_qubits, probabilities=None, low=0, high=1)` +`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` @@ -17,60 +25,184 @@ This module contains the definition of a base class for univariate distributions **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – num qubits and length of probabilities vector do not match +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – num qubits and length of probabilities vector do not match ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`build`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_power#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_power "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.pdf_to_probabilities") | Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.UnivariateDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.UnivariateDistribution.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + + + +`UnivariateDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`UnivariateDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`UnivariateDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`UnivariateDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`UnivariateDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`UnivariateDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + +`UnivariateDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`UnivariateDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`UnivariateDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`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 + +**Parameters** + +* **pdf** (*function*) – probability density function +* **low** (*float*) – lower bound of equidistant grid +* **high** (*float*) – upper bound of equidistant grid +* **num\_values** (*int*) – number of grid points + +**Returns** + +array of probabilities + +**Return type** + +list + +### required\_ancillas + + + +`UnivariateDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`UnivariateDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +## Attributes + + ### high returns high - + ### low returns low - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### values returns values + 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 cd527da9224..040089b5059 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 @@ -1,8 +1,16 @@ -# UnivariateVariationalDistribution +--- +title: UnivariateVariationalDistribution +description: API reference for qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution +--- +# UnivariateVariationalDistribution + -`UnivariateVariationalDistribution(num_qubits, var_form, params, low=0, high=1)` +`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` @@ -18,57 +26,192 @@ The Univariate Variational Distribution. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`build`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_inverse#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_inverse "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_power#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_power "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_inverse#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_inverse "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_inverse_power#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_inverse_power "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_power#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_power "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.get_num_qubits#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.get_num_qubits "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.get_num_qubits_controlled") | returns number of qubits controlled | -| [`pdf_to_probabilities`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.pdf_to_probabilities#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.pdf_to_probabilities "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.pdf_to_probabilities") | Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.required_ancillas#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.required_ancillas "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.required_ancillas_controlled#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.required_ancillas_controlled "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.required_ancillas_controlled") | returns required ancillas controlled | -| [`set_probabilities`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.set_probabilities#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.set_probabilities "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution.set_probabilities") | Set Probabilities | +### build -## Attributes + + +`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 + + + +`UnivariateVariationalDistribution.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`UnivariateVariationalDistribution.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`UnivariateVariationalDistribution.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`UnivariateVariationalDistribution.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`UnivariateVariationalDistribution.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`UnivariateVariationalDistribution.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`UnivariateVariationalDistribution.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible +### get\_num\_qubits + + +`UnivariateVariationalDistribution.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`UnivariateVariationalDistribution.get_num_qubits_controlled()` + +returns number of qubits controlled + +### pdf\_to\_probabilities + + + +`static UnivariateVariationalDistribution.pdf_to_probabilities(pdf, low, high, num_values)` + +Takes a probability density function (pdf), and returns a truncated and discretized array of probabilities corresponding to it + +**Parameters** + +* **pdf** (*function*) – probability density function +* **low** (*float*) – lower bound of equidistant grid +* **high** (*float*) – upper bound of equidistant grid +* **num\_values** (*int*) – number of grid points + +**Returns** + +array of probabilities + +**Return type** + +list + +### required\_ancillas + + + +`UnivariateVariationalDistribution.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`UnivariateVariationalDistribution.required_ancillas_controlled()` + +returns required ancillas controlled + +### set\_probabilities + + + +`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 + +**Parameters** + +**quantum\_instance** ([*QuantumInstance*](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance")) – Quantum instance + +## Attributes + + ### high returns high - + ### low returns low - + ### num\_target\_qubits Returns the number of target qubits - + ### num\_values returns number of values - + ### probabilities returns probabilities - + ### values returns values + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.md index 3a3bf1a9cf5..0f59c815da7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_models.md @@ -20,31 +20,31 @@ An uncertainty model is an implementation that provides a way to construct a qua # Uncertainty Model Base Classes -[`UncertaintyModel`](qiskit.aqua.components.uncertainty_models.UncertaintyModel#qiskit.aqua.components.uncertainty_models.UncertaintyModel "qiskit.aqua.components.uncertainty_models.UncertaintyModel") is the base class from which further base classes for univariate and multivariate distributions are derived +[`UncertaintyModel`](qiskit.aqua.components.uncertainty_models.UncertaintyModel "qiskit.aqua.components.uncertainty_models.UncertaintyModel") is the base class from which further base classes for univariate and multivariate distributions are derived -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`UncertaintyModel`](qiskit.aqua.components.uncertainty_models.UncertaintyModel#qiskit.aqua.components.uncertainty_models.UncertaintyModel "qiskit.aqua.components.uncertainty_models.UncertaintyModel") | The abstract Uncertainty Model | -| [`UnivariateDistribution`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution#qiskit.aqua.components.uncertainty_models.UnivariateDistribution "qiskit.aqua.components.uncertainty_models.UnivariateDistribution") | This module contains the definition of a base class for univariate distributions. | -| [`MultivariateDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution#qiskit.aqua.components.uncertainty_models.MultivariateDistribution "qiskit.aqua.components.uncertainty_models.MultivariateDistribution") | This module contains the definition of a base class for multivariate distributions. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| [`UncertaintyModel`](qiskit.aqua.components.uncertainty_models.UncertaintyModel "qiskit.aqua.components.uncertainty_models.UncertaintyModel") | The abstract Uncertainty Model | +| [`UnivariateDistribution`](qiskit.aqua.components.uncertainty_models.UnivariateDistribution "qiskit.aqua.components.uncertainty_models.UnivariateDistribution") | This module contains the definition of a base class for univariate distributions. | +| [`MultivariateDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateDistribution "qiskit.aqua.components.uncertainty_models.MultivariateDistribution") | This module contains the definition of a base class for multivariate distributions. | # Univariate Distributions -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`NormalDistribution`](qiskit.aqua.components.uncertainty_models.NormalDistribution#qiskit.aqua.components.uncertainty_models.NormalDistribution "qiskit.aqua.components.uncertainty_models.NormalDistribution") | The Univariate Normal Distribution. | -| [`LogNormalDistribution`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution#qiskit.aqua.components.uncertainty_models.LogNormalDistribution "qiskit.aqua.components.uncertainty_models.LogNormalDistribution") | The Univariate Log-Normal Distribution. | -| [`BernoulliDistribution`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution#qiskit.aqua.components.uncertainty_models.BernoulliDistribution "qiskit.aqua.components.uncertainty_models.BernoulliDistribution") | The Univariate Bernoulli Distribution. | -| [`UniformDistribution`](qiskit.aqua.components.uncertainty_models.UniformDistribution#qiskit.aqua.components.uncertainty_models.UniformDistribution "qiskit.aqua.components.uncertainty_models.UniformDistribution") | The Univariate Uniform Distribution. | -| [`UnivariateVariationalDistribution`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution#qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution") | The Univariate Variational Distribution. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | +| [`NormalDistribution`](qiskit.aqua.components.uncertainty_models.NormalDistribution "qiskit.aqua.components.uncertainty_models.NormalDistribution") | The Univariate Normal Distribution. | +| [`LogNormalDistribution`](qiskit.aqua.components.uncertainty_models.LogNormalDistribution "qiskit.aqua.components.uncertainty_models.LogNormalDistribution") | The Univariate Log-Normal Distribution. | +| [`BernoulliDistribution`](qiskit.aqua.components.uncertainty_models.BernoulliDistribution "qiskit.aqua.components.uncertainty_models.BernoulliDistribution") | The Univariate Bernoulli Distribution. | +| [`UniformDistribution`](qiskit.aqua.components.uncertainty_models.UniformDistribution "qiskit.aqua.components.uncertainty_models.UniformDistribution") | The Univariate Uniform Distribution. | +| [`UnivariateVariationalDistribution`](qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution "qiskit.aqua.components.uncertainty_models.UnivariateVariationalDistribution") | The Univariate Variational Distribution. | # Multivariate Distributions -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`MultivariateNormalDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution#qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution") | The Multivariate Normal Distribution. | -| [`MultivariateLogNormalDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution#qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution") | The Multivariate Log-Normal Distribution. | -| [`MultivariateUniformDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution#qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution") | The Multivariate Uniform Distribution. | -| [`MultivariateVariationalDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution#qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution") | The Multivariate Variational Distribution. | -| [`GaussianConditionalIndependenceModel`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel#qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel") | The Gaussian Conditional Independence Model for Credit Risk. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [`MultivariateNormalDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution "qiskit.aqua.components.uncertainty_models.MultivariateNormalDistribution") | The Multivariate Normal Distribution. | +| [`MultivariateLogNormalDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution "qiskit.aqua.components.uncertainty_models.MultivariateLogNormalDistribution") | The Multivariate Log-Normal Distribution. | +| [`MultivariateUniformDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution "qiskit.aqua.components.uncertainty_models.MultivariateUniformDistribution") | The Multivariate Uniform Distribution. | +| [`MultivariateVariationalDistribution`](qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution "qiskit.aqua.components.uncertainty_models.MultivariateVariationalDistribution") | The Multivariate Variational Distribution. | +| [`GaussianConditionalIndependenceModel`](qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel "qiskit.aqua.components.uncertainty_models.GaussianConditionalIndependenceModel") | The Gaussian Conditional Independence Model for Credit Risk. | 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 0d22ce21ad8..7601ab629f2 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 @@ -1,8 +1,16 @@ -# MultivariateProblem +--- +title: MultivariateProblem +description: API reference for qiskit.aqua.components.uncertainty_problems.MultivariateProblem +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_problems.MultivariateProblem +--- +# MultivariateProblem + -`MultivariateProblem(uncertainty_model, aggregation_function, univariate_objective, conditions=None)` +`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` @@ -19,26 +27,144 @@ Constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_inverse#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_inverse "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_power#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_power "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_inverse#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_inverse "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_inverse_power#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_inverse_power "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_power#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_power "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.get_num_qubits#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.get_num_qubits "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.required_ancillas#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.required_ancillas "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.required_ancillas_controlled#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.required_ancillas_controlled "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.required_ancillas_controlled") | returns required ancillas controlled | -| [`value_to_estimation`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem.value_to_estimation#qiskit.aqua.components.uncertainty_problems.MultivariateProblem.value_to_estimation "qiskit.aqua.components.uncertainty_problems.MultivariateProblem.value_to_estimation") | value to estimate | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`MultivariateProblem.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + +`MultivariateProblem.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`MultivariateProblem.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`MultivariateProblem.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`MultivariateProblem.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`MultivariateProblem.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`MultivariateProblem.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`MultivariateProblem.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`MultivariateProblem.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`MultivariateProblem.required_ancillas_controlled()` + +returns required ancillas controlled + +### value\_to\_estimation + + + +`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 + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + 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 71fc1c4d787..250bbe128ad 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 @@ -1,8 +1,16 @@ -# UncertaintyProblem +--- +title: UncertaintyProblem +description: API reference for qiskit.aqua.components.uncertainty_problems.UncertaintyProblem +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_problems.UncertaintyProblem +--- +# UncertaintyProblem + -`UncertaintyProblem(num_qubits)` +`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` @@ -10,26 +18,144 @@ The abstract Uncertainty Problem component. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_inverse#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_inverse "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_power#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_power "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_inverse#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_inverse "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_inverse_power#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_inverse_power "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_power#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_power "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.get_num_qubits#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.get_num_qubits "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.required_ancillas#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.required_ancillas "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.required_ancillas_controlled#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.required_ancillas_controlled "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.required_ancillas_controlled") | returns required ancillas controlled | -| [`value_to_estimation`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.value_to_estimation#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.value_to_estimation "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem.value_to_estimation") | value to estimate | +### build -## Attributes + + +`abstract UncertaintyProblem.build(qc, q, q_ancillas=None, params=None)` + +Adds corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`UncertaintyProblem.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`UncertaintyProblem.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`UncertaintyProblem.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`UncertaintyProblem.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`UncertaintyProblem.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +### build\_inverse\_power + + + +`UncertaintyProblem.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`UncertaintyProblem.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`UncertaintyProblem.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`UncertaintyProblem.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`UncertaintyProblem.required_ancillas()` + +returns required ancillas + +### required\_ancillas\_controlled + + + +`UncertaintyProblem.required_ancillas_controlled()` + +returns required ancillas controlled + +### value\_to\_estimation + + + +`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 + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + 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 003d25e958d..63199cf7444 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 @@ -1,8 +1,16 @@ -# UnivariatePiecewiseLinearObjective +--- +title: UnivariatePiecewiseLinearObjective +description: API reference for qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective +--- +# UnivariatePiecewiseLinearObjective + -`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)` +`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` @@ -30,26 +38,135 @@ $$ ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build") | | -| [`build_controlled`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_inverse#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_inverse "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_power#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_power "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_inverse#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_inverse "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_inverse_power#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_inverse_power "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_power#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_power "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.get_num_qubits#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.get_num_qubits "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.required_ancillas#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.required_ancillas "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.required_ancillas") | requires ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.required_ancillas_controlled#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.required_ancillas_controlled "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.required_ancillas_controlled") | returns required ancillas controlled | -| [`value_to_estimation`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.value_to_estimation#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.value_to_estimation "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective.value_to_estimation") | value to estimation | +### build -## Attributes + + +`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 + + + +`UnivariatePiecewiseLinearObjective.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`UnivariatePiecewiseLinearObjective.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`UnivariatePiecewiseLinearObjective.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`UnivariatePiecewiseLinearObjective.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`UnivariatePiecewiseLinearObjective.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +### build\_inverse\_power + + + +`UnivariatePiecewiseLinearObjective.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`UnivariatePiecewiseLinearObjective.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`UnivariatePiecewiseLinearObjective.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`UnivariatePiecewiseLinearObjective.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`UnivariatePiecewiseLinearObjective.required_ancillas_controlled()` + +returns required ancillas controlled + +### value\_to\_estimation + + + +`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 + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + 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 dd222467ff3..795745b2220 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 @@ -1,8 +1,16 @@ -# UnivariateProblem +--- +title: UnivariateProblem +description: API reference for qiskit.aqua.components.uncertainty_problems.UnivariateProblem +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.uncertainty_problems.UnivariateProblem +--- +# UnivariateProblem + -`UnivariateProblem(uncertainty_model, univariate_objective, i_state=None, i_objective=None)` +`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` @@ -19,26 +27,144 @@ Constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_inverse#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_inverse "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_inverse_power#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_inverse_power "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_power#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_power "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_inverse#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_inverse "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_inverse_power#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_inverse_power "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_power#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_power "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.get_num_qubits#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.get_num_qubits "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.get_num_qubits_controlled#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.get_num_qubits_controlled "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.required_ancillas#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.required_ancillas "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.required_ancillas_controlled#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.required_ancillas_controlled "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.required_ancillas_controlled") | returns required ancillas controlled | -| [`value_to_estimation`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem.value_to_estimation#qiskit.aqua.components.uncertainty_problems.UnivariateProblem.value_to_estimation "qiskit.aqua.components.uncertainty_problems.UnivariateProblem.value_to_estimation") | value to estimate | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`UnivariateProblem.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + +`UnivariateProblem.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`UnivariateProblem.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`UnivariateProblem.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`UnivariateProblem.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`UnivariateProblem.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`UnivariateProblem.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`UnivariateProblem.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`UnivariateProblem.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`UnivariateProblem.required_ancillas_controlled()` + +returns required ancillas controlled + +### value\_to\_estimation + + + +`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 + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.md b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.md index 4c47a9fbb91..3cb558139fd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.uncertainty_problems.md @@ -18,7 +18,7 @@ python_api_name: qiskit.aqua.components.uncertainty_problems Uncertainty is present in most realistic applications, and often it is necessary to evaluate the behavior of a system under uncertain data. For instance, in finance, it is of interest to evaluate expected value or risk metrics of financial products that depend on underlying stock prices, economic factors, or changing interest rates. Classically, such problems are often evaluated using Monte Carlo simulation. However, Monte Carlo simulation does not converge very fast, which implies that large numbers of samples are required to achieve estimators of reasonable accuracy and confidence. In quantum computing, *amplitude estimation* can be used instead, which can lead to a quadratic speed-up. Thus, millions of classical samples could be replaced by a few thousand quantum samples. -*Amplitude estimation* is a derivative of *quantum phase estimation* applied to a particular operator $A$. $A$ is assumed to operate on (n+1) qubits (+ possible ancillas) where the n qubits represent the uncertainty (see [`uncertainty_models`](qiskit.aqua.components.uncertainty_models#module-qiskit.aqua.components.uncertainty_models "qiskit.aqua.components.uncertainty_models")) and the last qubit is used to represent the (normalized) objective value as its amplitude. In other words, $A$ is constructed such that the probability of measuring a ‘1’ in the objective qubit is equal to the value of interest. Aqua has several amplitude estimation algorithms: [`AmplitudeEstimation`](qiskit.aqua.algorithms.AmplitudeEstimation#qiskit.aqua.algorithms.AmplitudeEstimation "qiskit.aqua.algorithms.AmplitudeEstimation"), [`IterativeAmplitudeEstimation`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation#qiskit.aqua.algorithms.IterativeAmplitudeEstimation "qiskit.aqua.algorithms.IterativeAmplitudeEstimation") and [`MaximumLikelihoodAmplitudeEstimation`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation#qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation"). +*Amplitude estimation* is a derivative of *quantum phase estimation* applied to a particular operator $A$. $A$ is assumed to operate on (n+1) qubits (+ possible ancillas) where the n qubits represent the uncertainty (see [`uncertainty_models`](qiskit.aqua.components.uncertainty_models#module-qiskit.aqua.components.uncertainty_models "qiskit.aqua.components.uncertainty_models")) and the last qubit is used to represent the (normalized) objective value as its amplitude. In other words, $A$ is constructed such that the probability of measuring a ‘1’ in the objective qubit is equal to the value of interest. Aqua has several amplitude estimation algorithms: [`AmplitudeEstimation`](qiskit.aqua.algorithms.AmplitudeEstimation "qiskit.aqua.algorithms.AmplitudeEstimation"), [`IterativeAmplitudeEstimation`](qiskit.aqua.algorithms.IterativeAmplitudeEstimation "qiskit.aqua.algorithms.IterativeAmplitudeEstimation") and [`MaximumLikelihoodAmplitudeEstimation`](qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation "qiskit.aqua.algorithms.MaximumLikelihoodAmplitudeEstimation"). Since the value of interest has to be normalized to lie in \[0, 1], an uncertainty problem also provides a function: @@ -31,17 +31,17 @@ which is used to map the result of *amplitude estimation* to the range of intere # Uncertainty Problem Base Classes -[`UncertaintyProblem`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem") is the base class from which further base classes for univariate and multivariate problems are derived +[`UncertaintyProblem`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem") is the base class from which further base classes for univariate and multivariate problems are derived -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| [`UncertaintyProblem`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem") | The abstract Uncertainty Problem component. | -| [`UnivariateProblem`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem#qiskit.aqua.components.uncertainty_problems.UnivariateProblem "qiskit.aqua.components.uncertainty_problems.UnivariateProblem") | Univariate uncertainty problem. | -| [`MultivariateProblem`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem#qiskit.aqua.components.uncertainty_problems.MultivariateProblem "qiskit.aqua.components.uncertainty_problems.MultivariateProblem") | Multivariate Uncertainty Problem. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| [`UncertaintyProblem`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem") | The abstract Uncertainty Problem component. | +| [`UnivariateProblem`](qiskit.aqua.components.uncertainty_problems.UnivariateProblem "qiskit.aqua.components.uncertainty_problems.UnivariateProblem") | Univariate uncertainty problem. | +| [`MultivariateProblem`](qiskit.aqua.components.uncertainty_problems.MultivariateProblem "qiskit.aqua.components.uncertainty_problems.MultivariateProblem") | Multivariate Uncertainty Problem. | # Univariate Problems -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| [`UnivariatePiecewiseLinearObjective`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective#qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective") | Univariate Piecewise Linear Objective Function. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| [`UnivariatePiecewiseLinearObjective`](qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective "qiskit.aqua.components.uncertainty_problems.UnivariatePiecewiseLinearObjective") | Univariate Piecewise Linear Objective Function. | 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 1ddf584ef6b..56c44d14c26 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 @@ -1,8 +1,16 @@ -# VariationalForm +--- +title: VariationalForm +description: API reference for qiskit.aqua.components.variational_forms.VariationalForm +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.components.variational_forms.VariationalForm +--- +# VariationalForm + -`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") Bases: `abc.ABC` @@ -12,15 +20,46 @@ This method should initialize the module and use an exception if a component of ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`construct_circuit`](qiskit.aqua.components.variational_forms.VariationalForm.construct_circuit#qiskit.aqua.components.variational_forms.VariationalForm.construct_circuit "qiskit.aqua.components.variational_forms.VariationalForm.construct_circuit") | Construct the variational form, given its parameters. | -| [`get_entangler_map`](qiskit.aqua.components.variational_forms.VariationalForm.get_entangler_map#qiskit.aqua.components.variational_forms.VariationalForm.get_entangler_map "qiskit.aqua.components.variational_forms.VariationalForm.get_entangler_map") | returns entangler map | -| [`validate_entangler_map`](qiskit.aqua.components.variational_forms.VariationalForm.validate_entangler_map#qiskit.aqua.components.variational_forms.VariationalForm.validate_entangler_map "qiskit.aqua.components.variational_forms.VariationalForm.validate_entangler_map") | validate entangler map | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **parameters** (`Union`\[`List`\[`float`], `ndarray`]) – circuit parameters. +* **q** (`Optional`\[`QuantumRegister`]) – Quantum Register for the circuit. + +**Returns** + +A quantum circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### get\_entangler\_map + +`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 + +### validate\_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") + +validate entangler map + +## Attributes + + ### num\_parameters @@ -34,7 +73,7 @@ An integer indicating the number of parameters. int - + ### num\_qubits @@ -48,7 +87,7 @@ An integer indicating the number of qubits. int - + ### parameter\_bounds @@ -62,7 +101,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo list - + ### preferred\_init\_points @@ -70,11 +109,11 @@ Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state - + ### setting - + ### support\_parameterized\_circuit @@ -87,3 +126,4 @@ indicate the sub-class support parameterized circuit **Return type** boolean + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.md b/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.md index aaeb8a514bb..94b01021664 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.components.variational_forms.md @@ -18,11 +18,11 @@ python_api_name: qiskit.aqua.components.variational_forms In quantum mechanics, the *variational method* is one way of finding approximations to the lowest energy eigenstate, or *ground state*, and some excited states. This allows calculating approximate wave functions, such as molecular orbitals. The basis for this method is the *variational principle*. -The variational method consists of choosing a *trial wave function*, or *variational form*, that depends on one or more parameters, and finding the values of these parameters for which the expectation value of the energy is the lowest possible. The wave function obtained by fixing the parameters to such values is then an approximation to the ground state wave function, and the expectation value of the energy in that state is an upper bound to the ground state energy. Quantum variational algorithms, such as [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"), apply the variational method. As such, they require a variational form. +The variational method consists of choosing a *trial wave function*, or *variational form*, that depends on one or more parameters, and finding the values of these parameters for which the expectation value of the energy is the lowest possible. The wave function obtained by fixing the parameters to such values is then an approximation to the ground state wave function, and the expectation value of the energy in that state is an upper bound to the ground state energy. Quantum variational algorithms, such as [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"), apply the variational method. As such, they require a variational form. # Variational Form Base Class -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm#qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") | Base class for VariationalForms. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | +| [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm") | Base class for VariationalForms. | 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 6c26c557445..78d926e0bb7 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.OperatorBase.md @@ -1,8 +1,16 @@ -# OperatorBase +--- +title: OperatorBase +description: API reference for qiskit.aqua.operators.OperatorBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.OperatorBase +--- +# OperatorBase + -`OperatorBase` +`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` @@ -12,41 +20,349 @@ Operators can be used to construct complicated functions and computation, and se ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.OperatorBase.add#qiskit.aqua.operators.OperatorBase.add "qiskit.aqua.operators.OperatorBase.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.OperatorBase.adjoint#qiskit.aqua.operators.OperatorBase.adjoint "qiskit.aqua.operators.OperatorBase.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.OperatorBase.assign_parameters#qiskit.aqua.operators.OperatorBase.assign_parameters "qiskit.aqua.operators.OperatorBase.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.OperatorBase.bind_parameters#qiskit.aqua.operators.OperatorBase.bind_parameters "qiskit.aqua.operators.OperatorBase.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.OperatorBase.compose#qiskit.aqua.operators.OperatorBase.compose "qiskit.aqua.operators.OperatorBase.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.OperatorBase.equals#qiskit.aqua.operators.OperatorBase.equals "qiskit.aqua.operators.OperatorBase.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.OperatorBase.eval#qiskit.aqua.operators.OperatorBase.eval "qiskit.aqua.operators.OperatorBase.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`mul`](qiskit.aqua.operators.OperatorBase.mul#qiskit.aqua.operators.OperatorBase.mul "qiskit.aqua.operators.OperatorBase.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.OperatorBase.neg#qiskit.aqua.operators.OperatorBase.neg "qiskit.aqua.operators.OperatorBase.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.OperatorBase.permute#qiskit.aqua.operators.OperatorBase.permute "qiskit.aqua.operators.OperatorBase.permute") | Permutes the qubits of the operator. | -| [`power`](qiskit.aqua.operators.OperatorBase.power#qiskit.aqua.operators.OperatorBase.power "qiskit.aqua.operators.OperatorBase.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.OperatorBase.primitive_strings#qiskit.aqua.operators.OperatorBase.primitive_strings "qiskit.aqua.operators.OperatorBase.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.OperatorBase.reduce#qiskit.aqua.operators.OperatorBase.reduce "qiskit.aqua.operators.OperatorBase.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.OperatorBase.tensor#qiskit.aqua.operators.OperatorBase.tensor "qiskit.aqua.operators.OperatorBase.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.OperatorBase.tensorpower#qiskit.aqua.operators.OperatorBase.tensorpower "qiskit.aqua.operators.OperatorBase.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_legacy_op`](qiskit.aqua.operators.OperatorBase.to_legacy_op#qiskit.aqua.operators.OperatorBase.to_legacy_op "qiskit.aqua.operators.OperatorBase.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.OperatorBase.to_matrix#qiskit.aqua.operators.OperatorBase.to_matrix "qiskit.aqua.operators.OperatorBase.to_matrix") | Return NumPy representation of the Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`Number`, `ParameterExpression`, `List`\[`Union`\[`Number`, `ParameterExpression`]]]]) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`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). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`, `list`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`Number`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`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 `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new OperatorBase containing the permuted operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. + +### power + + + +`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 `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_legacy\_op + + + +`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. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### num\_qubits @@ -60,8 +376,9 @@ The number of qubits over which the Operator is defined. If `op.num_qubits == 5` The number of qubits accepted by the Operator’s underlying function. - + ### parameters Return a set of Parameter objects contained in the Operator. + 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 36a2544234b..b6368fa370e 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 @@ -1,8 +1,16 @@ -# AbelianGrouper +--- +title: AbelianGrouper +description: API reference for qiskit.aqua.operators.converters.AbelianGrouper +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.converters.AbelianGrouper +--- +# AbelianGrouper + -`AbelianGrouper(traverse=True)` +`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` @@ -16,7 +24,49 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.converters.AbelianGrouper.convert#qiskit.aqua.operators.converters.AbelianGrouper.convert "qiskit.aqua.operators.converters.AbelianGrouper.convert") | 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. | -| [`group_subops`](qiskit.aqua.operators.converters.AbelianGrouper.group_subops#qiskit.aqua.operators.converters.AbelianGrouper.group_subops "qiskit.aqua.operators.converters.AbelianGrouper.group_subops") | Given a ListOp, attempt to group into Abelian ListOps of the same type. | +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to attempt to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator. + +### group\_subops + + + +`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. + +**Parameters** + +* **list\_op** (`ListOp`) – The Operator to group into Abelian groups +* **fast** (`Optional`\[`bool`]) – Ignored - parameter will be removed in future release +* **use\_nx** (`Optional`\[`bool`]) – Ignored - parameter will be removed in future release + +**Return type** + +`ListOp` + +**Returns** + +The grouped Operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If any of list\_op’s sub-ops is not `PauliOp`. + 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 fd11b31a49f..e9783f821f1 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 @@ -1,8 +1,16 @@ -# CircuitSampler +--- +title: CircuitSampler +description: API reference for qiskit.aqua.operators.converters.CircuitSampler +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.converters.CircuitSampler +--- +# CircuitSampler + -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False)` +`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` @@ -23,15 +31,75 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.converters.CircuitSampler.convert#qiskit.aqua.operators.converters.CircuitSampler.convert "qiskit.aqua.operators.converters.CircuitSampler.convert") | Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. | -| [`sample_circuits`](qiskit.aqua.operators.converters.CircuitSampler.sample_circuits#qiskit.aqua.operators.converters.CircuitSampler.sample_circuits "qiskit.aqua.operators.converters.CircuitSampler.sample_circuits") | Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. | -| [`set_backend`](qiskit.aqua.operators.converters.CircuitSampler.set_backend#qiskit.aqua.operators.converters.CircuitSampler.set_backend "qiskit.aqua.operators.converters.CircuitSampler.set_backend") | Sets backend with configuration. | +### convert -## Attributes + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – The Operator to convert +* **params** (`Optional`\[`Dict`\[`Parameter`, `Union`\[`float`, `List`\[`float`], `List`\[`List`\[`float`]]]]]) – A dictionary mapping parameters to either single binding values or lists of binding values. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator with CircuitStateFns replaced by DictStateFns or VectorStateFns. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if extracted circuits are empty. + +### sample\_circuits + + + +`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. + +**Parameters** +* **circuit\_sfns** (`Optional`\[`List`\[`CircuitStateFn`]]) – The list of CircuitStateFns to sample. +* **param\_bindings** (`Optional`\[`List`\[`Dict`\[`Parameter`, `float`]]]) – The parameterizations to bind to each CircuitStateFn. +**Return type** + +`Dict`\[`int`, `Union`\[`StateFn`, `List`\[`StateFn`]]] + +**Returns** + +The dictionary mapping ids of the CircuitStateFns to their replacement StateFns. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if extracted circuits are empty. + +### set\_backend + + + +`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. + +**Raises** + +**ValueError** – statevector or param\_qobj are True when not supported by backend. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -45,7 +113,7 @@ Returns the backend. The backend used by the CircuitSampler - + ### quantum\_instance @@ -58,3 +126,4 @@ Returns the quantum instance. **Returns** The QuantumInstance used by the CircuitSampler + 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 cb3f8bed651..2107b6a1d2d 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 @@ -1,8 +1,16 @@ -# ConverterBase +--- +title: ConverterBase +description: API reference for qiskit.aqua.operators.converters.ConverterBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.converters.ConverterBase +--- +# ConverterBase + -`ConverterBase` +`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` @@ -10,6 +18,23 @@ Converters take an Operator and return a new Operator, generally isomorphic in s ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.converters.ConverterBase.convert#qiskit.aqua.operators.converters.ConverterBase.convert "qiskit.aqua.operators.converters.ConverterBase.convert") | Accept the Operator and return the converted Operator | +### convert + + + +`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 + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +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 824a1547997..87540049609 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 @@ -1,8 +1,16 @@ -# DictToCircuitSum +--- +title: DictToCircuitSum +description: API reference for qiskit.aqua.operators.converters.DictToCircuitSum +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.converters.DictToCircuitSum +--- +# DictToCircuitSum + -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` +`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` @@ -16,6 +24,23 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.converters.DictToCircuitSum.convert#qiskit.aqua.operators.converters.DictToCircuitSum.convert "qiskit.aqua.operators.converters.DictToCircuitSum.convert") | Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. | +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator. + 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 718af18a30c..fbc3778b8d2 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 @@ -1,8 +1,16 @@ -# PauliBasisChange +--- +title: PauliBasisChange +description: API reference for qiskit.aqua.operators.converters.PauliBasisChange +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.converters.PauliBasisChange +--- +# PauliBasisChange + -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` +`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` @@ -27,22 +35,228 @@ This class uses the typical basis change method found in most Quantum Computing ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`construct_cnot_chain`](qiskit.aqua.operators.converters.PauliBasisChange.construct_cnot_chain#qiskit.aqua.operators.converters.PauliBasisChange.construct_cnot_chain "qiskit.aqua.operators.converters.PauliBasisChange.construct_cnot_chain") | 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). | -| [`convert`](qiskit.aqua.operators.converters.PauliBasisChange.convert#qiskit.aqua.operators.converters.PauliBasisChange.convert "qiskit.aqua.operators.converters.PauliBasisChange.convert") | 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`. | -| [`get_cob_circuit`](qiskit.aqua.operators.converters.PauliBasisChange.get_cob_circuit#qiskit.aqua.operators.converters.PauliBasisChange.get_cob_circuit "qiskit.aqua.operators.converters.PauliBasisChange.get_cob_circuit") | Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. | -| [`get_diagonal_pauli_op`](qiskit.aqua.operators.converters.PauliBasisChange.get_diagonal_pauli_op#qiskit.aqua.operators.converters.PauliBasisChange.get_diagonal_pauli_op "qiskit.aqua.operators.converters.PauliBasisChange.get_diagonal_pauli_op") | Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. | -| [`get_diagonalizing_clifford`](qiskit.aqua.operators.converters.PauliBasisChange.get_diagonalizing_clifford#qiskit.aqua.operators.converters.PauliBasisChange.get_diagonalizing_clifford "qiskit.aqua.operators.converters.PauliBasisChange.get_diagonalizing_clifford") | Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of \|0⟩ and \|1⟩ tensor products. | -| [`get_tpb_pauli`](qiskit.aqua.operators.converters.PauliBasisChange.get_tpb_pauli#qiskit.aqua.operators.converters.PauliBasisChange.get_tpb_pauli "qiskit.aqua.operators.converters.PauliBasisChange.get_tpb_pauli") | 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`. | -| [`measurement_replacement_fn`](qiskit.aqua.operators.converters.PauliBasisChange.measurement_replacement_fn#qiskit.aqua.operators.converters.PauliBasisChange.measurement_replacement_fn "qiskit.aqua.operators.converters.PauliBasisChange.measurement_replacement_fn") | A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. | -| [`operator_replacement_fn`](qiskit.aqua.operators.converters.PauliBasisChange.operator_replacement_fn#qiskit.aqua.operators.converters.PauliBasisChange.operator_replacement_fn "qiskit.aqua.operators.converters.PauliBasisChange.operator_replacement_fn") | A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. | -| [`pad_paulis_to_equal_length`](qiskit.aqua.operators.converters.PauliBasisChange.pad_paulis_to_equal_length#qiskit.aqua.operators.converters.PauliBasisChange.pad_paulis_to_equal_length "qiskit.aqua.operators.converters.PauliBasisChange.pad_paulis_to_equal_length") | 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. | -| [`statefn_replacement_fn`](qiskit.aqua.operators.converters.PauliBasisChange.statefn_replacement_fn#qiskit.aqua.operators.converters.PauliBasisChange.statefn_replacement_fn "qiskit.aqua.operators.converters.PauliBasisChange.statefn_replacement_fn") | A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. | +### construct\_cnot\_chain -## Attributes + + +`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. + +**Parameters** + +* **diag\_pauli\_op1** (`PauliOp`) – The origin `PauliOp`. +* **diag\_pauli\_op2** (`PauliOp`) – The destination `PauliOp`. + +**Return type** + +`PrimitiveOp` + +**Returns** + +The `PrimitiveOp` performs the mapping. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator. + +### get\_cob\_circuit + + + +`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 + +1. converting any |i+⟩ or |i+⟩ eigenvector bits in the origin to |+⟩ and |-⟩ with S†s, then +2. converting any |+⟩ or |+⟩ eigenvector bits in the converted origin to |0⟩ and |1⟩ with Hs, then +3. writing the parity of the significant (Z-measured, rather than I) bits in the origin to a single “origin anchor bit,” using cnots, which will hold the parity of these bits, +4. swapping the parity of the pauli anchor bit into a destination anchor bit using a swap gate (only if they are different, if there are any bits which are significant in both origin and dest, we set both anchors to one of these bits to avoid a swap). +5. writing the parity of the destination anchor bit into the other significant bits of the destination, +6. converting the |0⟩ and |1⟩ significant eigenvector bits to |+⟩ and |-⟩ eigenvector bits in the destination where the destination demands it (e.g. pauli.x == true for a bit), using Hs 8) converting the |+⟩ and |-⟩ significant eigenvector bits to |i+⟩ and |i-⟩ eigenvector bits in the destination where the destination demands it (e.g. pauli.x == true and pauli.z == true for a bit), using Ss + +**Parameters** + +**origin** (`Union`\[`Pauli`, `PauliOp`]) – The `Pauli` or `PauliOp` to map. + +**Return type** + +`Tuple`\[`PrimitiveOp`, `PauliOp`] + +**Returns** + +A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` which equals the destination basis. + +**Raises** + +* **TypeError** – Attempting to convert from non-Pauli origin. +* **ValueError** – Attempting to change a non-identity Pauli to an identity Pauli, or vice versa. + +### get\_diagonal\_pauli\_op + + + +`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. + +**Parameters** + +**pauli\_op** (`PauliOp`) – The `PauliOp` whose diagonal to compute. + +**Return type** + +`PauliOp` + +**Returns** + +The diagonal `PauliOp`. + +### get\_diagonalizing\_clifford + + + +`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. + +Note, underlying Pauli bits are in Qiskit endianness, so we need to reverse before we begin composing with Operator flow. + +**Parameters** + +**pauli** (`Union`\[`Pauli`, `PauliOp`]) – the `Pauli` or `PauliOp` to whose diagonalizing circuit to compute. + +**Return type** + +`OperatorBase` + +**Returns** +The diagonalizing `CircuitOp`. +### get\_tpb\_pauli + + + +`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. + +**Parameters** + +**list\_op** (`ListOp`) – the `ListOp` whose TBP Pauli to return. + +**Return type** + +`Pauli` + +**Returns** + +The TBP Pauli. + +### measurement\_replacement\_fn + + + +`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`. + +**Parameters** + +* **cob\_instr\_op** (`CircuitOp`) – The basis-change `CircuitOp`. +* **dest\_pauli\_op** (`PauliOp`) – The destination `PauliOp`. + +**Return type** + +`OperatorBase` + +**Returns** + +The `~StateFn @ CircuitOp` composition equivalent to a measurement by the original `PauliOp`. + +### operator\_replacement\_fn + + + +`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`. + +**Parameters** + +* **cob\_instr\_op** (`CircuitOp`) – The basis-change `CircuitOp`. +* **dest\_pauli\_op** (`PauliOp`) – The destination `PauliOp`. + +**Return type** + +`OperatorBase` + +**Returns** + +The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `PauliOp`. + +### pad\_paulis\_to\_equal\_length + + + +`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. + +**Parameters** + +* **pauli\_op1** (`PauliOp`) – A pauli\_op to possibly pad. +* **pauli\_op2** (`PauliOp`) – A pauli\_op to possibly pad. + +**Return type** + +`Tuple`\[`PauliOp`, `PauliOp`] + +**Returns** + +A tuple containing the padded PauliOps. + +### statefn\_replacement\_fn + + + +`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`. + +**Parameters** + +* **cob\_instr\_op** (`CircuitOp`) – The basis-change `CircuitOp`. +* **dest\_pauli\_op** (`PauliOp`) – The destination `PauliOp`. + +**Return type** + +`OperatorBase` + +**Returns** + +The `~CircuitOp @ StateFn` composition equivalent to a state function defined by the original `PauliOp`. + +## Attributes + + ### destination @@ -51,3 +265,4 @@ The destination `PauliOp`, or `None` if using the default destination, the diago **Return type** `Optional`\[`PauliOp`] + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.md index d5eadefff78..1bc88a68323 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.converters.md @@ -16,7 +16,7 @@ python_api_name: qiskit.aqua.operators.converters `qiskit.aqua.operators.converters` -Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp#qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp#qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp") of [`PauliOp`](qiskit.aqua.operators.primitive_ops.PauliOp#qiskit.aqua.operators.primitive_ops.PauliOp "qiskit.aqua.operators.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.aqua.operators.expectations.MatrixExpectation#qiskit.aqua.operators.expectations.MatrixExpectation "qiskit.aqua.operators.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.aqua.operators.evolutions.MatrixEvolution#qiskit.aqua.operators.evolutions.MatrixEvolution "qiskit.aqua.operators.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.aqua.operators.primitive_ops.PauliOp#qiskit.aqua.operators.primitive_ops.PauliOp "qiskit.aqua.operators.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.aqua.operators.primitive_ops.MatrixOp#qiskit.aqua.operators.primitive_ops.MatrixOp "qiskit.aqua.operators.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). +Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp") of [`PauliOp`](qiskit.aqua.operators.primitive_ops.PauliOp "qiskit.aqua.operators.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.aqua.operators.expectations.MatrixExpectation "qiskit.aqua.operators.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.aqua.operators.evolutions.MatrixEvolution "qiskit.aqua.operators.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.aqua.operators.primitive_ops.PauliOp "qiskit.aqua.operators.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.aqua.operators.primitive_ops.MatrixOp "qiskit.aqua.operators.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). Not all converters are in this module, as [`expectations`](qiskit.aqua.operators.expectations#module-qiskit.aqua.operators.expectations "qiskit.aqua.operators.expectations") and [`evolutions`](qiskit.aqua.operators.evolutions#module-qiskit.aqua.operators.evolutions "qiskit.aqua.operators.evolutions") are also converters. @@ -24,20 +24,20 @@ Converters are objects which manipulate Operators, usually traversing an Operato # Converter Base Class -The converter base class simply enforces the presence of a [`convert()`](qiskit.aqua.operators.converters.ConverterBase.convert#qiskit.aqua.operators.converters.ConverterBase.convert "qiskit.aqua.operators.converters.ConverterBase.convert") method. +The converter base class simply enforces the presence of a [`convert()`](qiskit.aqua.operators.converters.ConverterBase#convert "qiskit.aqua.operators.converters.ConverterBase.convert") method. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| [`ConverterBase`](qiskit.aqua.operators.converters.ConverterBase#qiskit.aqua.operators.converters.ConverterBase "qiskit.aqua.operators.converters.ConverterBase") | Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | +| [`ConverterBase`](qiskit.aqua.operators.converters.ConverterBase "qiskit.aqua.operators.converters.ConverterBase") | Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. | # Converters In addition to the base class, directory holds a few miscellaneous converters which are used frequently around the Operator flow. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`CircuitSampler`](qiskit.aqua.operators.converters.CircuitSampler#qiskit.aqua.operators.converters.CircuitSampler "qiskit.aqua.operators.converters.CircuitSampler") | The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. | -| [`AbelianGrouper`](qiskit.aqua.operators.converters.AbelianGrouper#qiskit.aqua.operators.converters.AbelianGrouper "qiskit.aqua.operators.converters.AbelianGrouper") | The AbelianGrouper converts SummedOps into a sum of Abelian sums. | -| [`DictToCircuitSum`](qiskit.aqua.operators.converters.DictToCircuitSum#qiskit.aqua.operators.converters.DictToCircuitSum "qiskit.aqua.operators.converters.DictToCircuitSum") | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | -| [`PauliBasisChange`](qiskit.aqua.operators.converters.PauliBasisChange#qiskit.aqua.operators.converters.PauliBasisChange "qiskit.aqua.operators.converters.PauliBasisChange") | Converter for changing Paulis into other bases. | +| | | +| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`CircuitSampler`](qiskit.aqua.operators.converters.CircuitSampler "qiskit.aqua.operators.converters.CircuitSampler") | The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. | +| [`AbelianGrouper`](qiskit.aqua.operators.converters.AbelianGrouper "qiskit.aqua.operators.converters.AbelianGrouper") | The AbelianGrouper converts SummedOps into a sum of Abelian sums. | +| [`DictToCircuitSum`](qiskit.aqua.operators.converters.DictToCircuitSum "qiskit.aqua.operators.converters.DictToCircuitSum") | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | +| [`PauliBasisChange`](qiskit.aqua.operators.converters.PauliBasisChange "qiskit.aqua.operators.converters.PauliBasisChange") | Converter for changing Paulis into other bases. | 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 fcf5af99c40..217601fddc1 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 @@ -1,8 +1,16 @@ -# EvolutionBase +--- +title: EvolutionBase +description: API reference for qiskit.aqua.operators.evolutions.EvolutionBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.EvolutionBase +--- +# EvolutionBase + -`EvolutionBase` +`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` @@ -10,6 +18,23 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.evolutions.EvolutionBase.convert#qiskit.aqua.operators.evolutions.EvolutionBase.convert "qiskit.aqua.operators.evolutions.EvolutionBase.convert") | Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. | +### convert + + + +`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`. + +> #### Args: +> +> operator: The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator, with `EvolutionOps` replaced by `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 7b472ff1a16..54f196a9083 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 @@ -1,8 +1,16 @@ -# EvolutionFactory +--- +title: EvolutionFactory +description: API reference for qiskit.aqua.operators.evolutions.EvolutionFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.EvolutionFactory +--- +# EvolutionFactory + -`EvolutionFactory` +`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` @@ -10,6 +18,27 @@ A factory class for convenient automatic selection of an Evolution algorithm bas ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- | -| [`build`](qiskit.aqua.operators.evolutions.EvolutionFactory.build#qiskit.aqua.operators.evolutions.EvolutionFactory.build "qiskit.aqua.operators.evolutions.EvolutionFactory.build") | A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. | +### build + + + +`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. + +**Parameters** + +**operator** (`Optional`\[`OperatorBase`]) – the Operator being evolved + +**Returns** + +the `EvolutionBase` best suited to evolve operator. + +**Return type** + +[EvolutionBase](qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") + +**Raises** + +**ValueError** – If operator is not of a composition for which we know the best Evolution method. + 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 8d0fc542935..9fb3de17e9c 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 @@ -1,8 +1,16 @@ -# EvolvedOp +--- +title: EvolvedOp +description: API reference for qiskit.aqua.operators.evolutions.EvolvedOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.EvolvedOp +--- +# EvolvedOp + -`EvolvedOp(primitive, coeff=1.0)` +`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` @@ -15,48 +23,437 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.evolutions.EvolvedOp.add#qiskit.aqua.operators.evolutions.EvolvedOp.add "qiskit.aqua.operators.evolutions.EvolvedOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.evolutions.EvolvedOp.adjoint#qiskit.aqua.operators.evolutions.EvolvedOp.adjoint "qiskit.aqua.operators.evolutions.EvolvedOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.evolutions.EvolvedOp.assign_parameters#qiskit.aqua.operators.evolutions.EvolvedOp.assign_parameters "qiskit.aqua.operators.evolutions.EvolvedOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.evolutions.EvolvedOp.bind_parameters#qiskit.aqua.operators.evolutions.EvolvedOp.bind_parameters "qiskit.aqua.operators.evolutions.EvolvedOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.evolutions.EvolvedOp.compose#qiskit.aqua.operators.evolutions.EvolvedOp.compose "qiskit.aqua.operators.evolutions.EvolvedOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.evolutions.EvolvedOp.equals#qiskit.aqua.operators.evolutions.EvolvedOp.equals "qiskit.aqua.operators.evolutions.EvolvedOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.evolutions.EvolvedOp.eval#qiskit.aqua.operators.evolutions.EvolvedOp.eval "qiskit.aqua.operators.evolutions.EvolvedOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.evolutions.EvolvedOp.exp_i#qiskit.aqua.operators.evolutions.EvolvedOp.exp_i "qiskit.aqua.operators.evolutions.EvolvedOp.exp_i") | Return Operator exponentiation, equaling e^(-i \* op) | -| [`log_i`](qiskit.aqua.operators.evolutions.EvolvedOp.log_i#qiskit.aqua.operators.evolutions.EvolvedOp.log_i "qiskit.aqua.operators.evolutions.EvolvedOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.evolutions.EvolvedOp.mul#qiskit.aqua.operators.evolutions.EvolvedOp.mul "qiskit.aqua.operators.evolutions.EvolvedOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.evolutions.EvolvedOp.neg#qiskit.aqua.operators.evolutions.EvolvedOp.neg "qiskit.aqua.operators.evolutions.EvolvedOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.evolutions.EvolvedOp.permute#qiskit.aqua.operators.evolutions.EvolvedOp.permute "qiskit.aqua.operators.evolutions.EvolvedOp.permute") | Permutes the qubits of the operator. | -| [`power`](qiskit.aqua.operators.evolutions.EvolvedOp.power#qiskit.aqua.operators.evolutions.EvolvedOp.power "qiskit.aqua.operators.evolutions.EvolvedOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.evolutions.EvolvedOp.primitive_strings#qiskit.aqua.operators.evolutions.EvolvedOp.primitive_strings "qiskit.aqua.operators.evolutions.EvolvedOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.evolutions.EvolvedOp.reduce#qiskit.aqua.operators.evolutions.EvolvedOp.reduce "qiskit.aqua.operators.evolutions.EvolvedOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.evolutions.EvolvedOp.tensor#qiskit.aqua.operators.evolutions.EvolvedOp.tensor "qiskit.aqua.operators.evolutions.EvolvedOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.evolutions.EvolvedOp.tensorpower#qiskit.aqua.operators.evolutions.EvolvedOp.tensorpower "qiskit.aqua.operators.evolutions.EvolvedOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.evolutions.EvolvedOp.to_circuit#qiskit.aqua.operators.evolutions.EvolvedOp.to_circuit "qiskit.aqua.operators.evolutions.EvolvedOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_circuit_op`](qiskit.aqua.operators.evolutions.EvolvedOp.to_circuit_op#qiskit.aqua.operators.evolutions.EvolvedOp.to_circuit_op "qiskit.aqua.operators.evolutions.EvolvedOp.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_instruction`](qiskit.aqua.operators.evolutions.EvolvedOp.to_instruction#qiskit.aqua.operators.evolutions.EvolvedOp.to_instruction "qiskit.aqua.operators.evolutions.EvolvedOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_legacy_op`](qiskit.aqua.operators.evolutions.EvolvedOp.to_legacy_op#qiskit.aqua.operators.evolutions.EvolvedOp.to_legacy_op "qiskit.aqua.operators.evolutions.EvolvedOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.evolutions.EvolvedOp.to_matrix#qiskit.aqua.operators.evolutions.EvolvedOp.to_matrix "qiskit.aqua.operators.evolutions.EvolvedOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.evolutions.EvolvedOp.to_matrix_op#qiskit.aqua.operators.evolutions.EvolvedOp.to_matrix_op "qiskit.aqua.operators.evolutions.EvolvedOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | -| [`to_pauli_op`](qiskit.aqua.operators.evolutions.EvolvedOp.to_pauli_op#qiskit.aqua.operators.evolutions.EvolvedOp.to_pauli_op "qiskit.aqua.operators.evolutions.EvolvedOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`EvolvedOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`EvolvedOp.exp_i()` + +Return Operator exponentiation, equaling e^(-i \* op) + +**Return type** + +`OperatorBase` + +### log\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### mul + + + +`EvolvedOp.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`EvolvedOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new OperatorBase containing the permuted operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. + +### power + + + +`EvolvedOp.power(exponent)` + +Return Operator composed with self multiple times, overloaded by `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`EvolvedOp.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`EvolvedOp.to_circuit()` + +Returns a `QuantumCircuit` equivalent to this Operator. + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`EvolvedOp.to_circuit_op()` + +Returns a `CircuitOp` equivalent to this Operator. + +**Return type** + +`OperatorBase` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_legacy\_op + + + +`EvolvedOp.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`Union`\[`ndarray`, `List`\[`ndarray`]] + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`EvolvedOp.to_pauli_op(massive=False)` + +Returns a sum of `PauliOp` s equivalent to this Operator. + +**Return type** + +`OperatorBase` + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -70,7 +467,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### num\_qubits @@ -78,11 +475,11 @@ The coefficient. `int` - + ### parameters - + ### primitive @@ -95,3 +492,4 @@ The primitive defining the underlying function of the Operator. **Returns** The primitive object. + 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 e959b7c79e3..67bc05bd33f 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 @@ -1,8 +1,16 @@ -# MatrixEvolution +--- +title: MatrixEvolution +description: API reference for qiskit.aqua.operators.evolutions.MatrixEvolution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.MatrixEvolution +--- +# MatrixEvolution + -`MatrixEvolution` +`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` @@ -10,6 +18,23 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.evolutions.MatrixEvolution.convert#qiskit.aqua.operators.evolutions.MatrixEvolution.convert "qiskit.aqua.operators.evolutions.MatrixEvolution.convert") | Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. | +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 7fdd9275ec7..8e276a706ab 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 @@ -1,8 +1,16 @@ -# PauliTrotterEvolution +--- +title: PauliTrotterEvolution +description: API reference for qiskit.aqua.operators.evolutions.PauliTrotterEvolution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.PauliTrotterEvolution +--- +# PauliTrotterEvolution + -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` +`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` @@ -22,15 +30,61 @@ More specifically, we compute basis change circuits for each Pauli into a single ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.evolutions.PauliTrotterEvolution.convert#qiskit.aqua.operators.evolutions.PauliTrotterEvolution.convert "qiskit.aqua.operators.evolutions.PauliTrotterEvolution.convert") | Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing trotterized evolutions equalling the exponentiation of -i \* operator. | -| [`evolution_for_abelian_paulisum`](qiskit.aqua.operators.evolutions.PauliTrotterEvolution.evolution_for_abelian_paulisum#qiskit.aqua.operators.evolutions.PauliTrotterEvolution.evolution_for_abelian_paulisum "qiskit.aqua.operators.evolutions.PauliTrotterEvolution.evolution_for_abelian_paulisum") | Evolution for abelian pauli sum | -| [`evolution_for_pauli`](qiskit.aqua.operators.evolutions.PauliTrotterEvolution.evolution_for_pauli#qiskit.aqua.operators.evolutions.PauliTrotterEvolution.evolution_for_pauli "qiskit.aqua.operators.evolutions.PauliTrotterEvolution.evolution_for_pauli") | Compute evolution Operator for a single Pauli using a `PauliBasisChange`. | +### convert -## Attributes + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + +### evolution\_for\_abelian\_paulisum + + + +`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 +**Return type** + +`PrimitiveOp` + +### evolution\_for\_pauli + + + +`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`. + +**Parameters** + +**pauli\_op** (`PauliOp`) – The `PauliOp` to evolve. + +**Return type** + +`PrimitiveOp` + +**Returns** + +A `PrimitiveOp`, either the evolution `CircuitOp` or a `PauliOp` equal to the identity if pauli\_op is the identity. + +## Attributes + + ### trotter @@ -39,3 +93,4 @@ TrotterizationBase used to evolve SummedOps. **Return type** `TrotterizationBase` + 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 d6cf05f6976..a3c8f15543f 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 @@ -1,8 +1,16 @@ -# QDrift +--- +title: QDrift +description: API reference for qiskit.aqua.operators.evolutions.QDrift +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.QDrift +--- +# QDrift + -`QDrift(reps=1)` +`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` @@ -14,13 +22,33 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.evolutions.QDrift.convert#qiskit.aqua.operators.evolutions.QDrift.convert "qiskit.aqua.operators.evolutions.QDrift.convert") | Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. | +### convert -## Attributes + + +`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\`\`. +**Parameters** + +**operator** (`OperatorBase`) – The `SummedOp` to evolve. + +**Return type** +`OperatorBase` + +**Returns** + +The Operator approximating op\_sum’s evolution. + +**Raises** + +**TypeError** – A non-SummedOps Operator is passed into `convert`. + +## Attributes + + ### reps @@ -29,3 +57,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 be8907a1c94..2b2083745e9 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 @@ -1,8 +1,16 @@ -# Suzuki +--- +title: Suzuki +description: API reference for qiskit.aqua.operators.evolutions.Suzuki +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.Suzuki +--- +# Suzuki + -`Suzuki(reps=1, order=2)` +`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` @@ -17,13 +25,33 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.evolutions.Suzuki.convert#qiskit.aqua.operators.evolutions.Suzuki.convert "qiskit.aqua.operators.evolutions.Suzuki.convert") | Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. | +### convert -## Attributes + + +`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\`\`. + +**Parameters** + +**operator** (`OperatorBase`) – The `SummedOp` to evolve. + +**Return type** + +`OperatorBase` + +**Returns** +The Operator approximating op\_sum’s evolution. +**Raises** + +**TypeError** – A non-SummedOps Operator is passed into `convert`. + +## Attributes + + ### order @@ -33,7 +61,7 @@ returns order `int` - + ### reps @@ -42,3 +70,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 ee72cff733c..6ac9cd1ce64 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 @@ -1,8 +1,16 @@ -# Trotter +--- +title: Trotter +description: API reference for qiskit.aqua.operators.evolutions.Trotter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.Trotter +--- +# Trotter + -`Trotter(reps=1)` +`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` @@ -14,13 +22,33 @@ Simple Trotter expansion, composing the evolution circuits of each Operator in t ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.evolutions.Trotter.convert#qiskit.aqua.operators.evolutions.Trotter.convert "qiskit.aqua.operators.evolutions.Trotter.convert") | Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. | +### convert -## Attributes + + +`Trotter.convert(operator)` + +Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. + +**Parameters** + +**operator** (`OperatorBase`) – The `SummedOp` to evolve. + +**Return type** + +`OperatorBase` + +**Returns** +The Operator approximating op\_sum’s evolution. +**Raises** + +**TypeError** – A non-SummedOps Operator is passed into `convert`. + +## Attributes + + ### order @@ -30,7 +58,7 @@ returns order `int` - + ### reps @@ -39,3 +67,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 32f99db3f16..aca978cce4a 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 @@ -1,8 +1,16 @@ -# TrotterizationBase +--- +title: TrotterizationBase +description: API reference for qiskit.aqua.operators.evolutions.TrotterizationBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.TrotterizationBase +--- +# TrotterizationBase + -`TrotterizationBase(reps=1)` +`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` @@ -10,13 +18,33 @@ A base for Trotterization methods, algorithms for approximating exponentiations ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.evolutions.TrotterizationBase.convert#qiskit.aqua.operators.evolutions.TrotterizationBase.convert "qiskit.aqua.operators.evolutions.TrotterizationBase.convert") | Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. | +### convert -## Attributes + + +`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\`\`. + +**Parameters** + +**operator** (`OperatorBase`) – The `SummedOp` to evolve. + +**Return type** + +`OperatorBase` + +**Returns** + +The Operator approximating op\_sum’s evolution. +**Raises** +**TypeError** – A non-SummedOps Operator is passed into `convert`. + +## Attributes + + ### reps @@ -25,3 +53,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 a507f79c447..a211e007991 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 @@ -1,8 +1,16 @@ -# TrotterizationFactory +--- +title: TrotterizationFactory +description: API reference for qiskit.aqua.operators.evolutions.TrotterizationFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.evolutions.TrotterizationFactory +--- +# TrotterizationFactory + -`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") Bases: `object` @@ -10,6 +18,28 @@ A factory for conveniently creating TrotterizationBase instances. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`build`](qiskit.aqua.operators.evolutions.TrotterizationFactory.build#qiskit.aqua.operators.evolutions.TrotterizationFactory.build "qiskit.aqua.operators.evolutions.TrotterizationFactory.build") | A factory for conveniently creating TrotterizationBase instances. | +### build + + + +`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. + +**Parameters** + +* **mode** (`str`) – One of ‘trotter’, ‘suzuki’, ‘qdrift’ +* **reps** (`int`) – The number of times to repeat the Trotterization circuit. + +**Return type** + +`TrotterizationBase` + +**Returns** + +The desired TrotterizationBase instance. + +**Raises** + +**ValueError** – A string not in \[‘trotter’, ‘suzuki’, ‘qdrift’] is given for mode. + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.md index d51547f34d5..cc3de6bf07f 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.evolutions.md @@ -16,38 +16,38 @@ python_api_name: qiskit.aqua.operators.evolutions `qiskit.aqua.operators.evolutions` -Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp#qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp#qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. +Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. -The [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp#qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") is simply a placeholder signifying that the Operator inside it should be converted to its exponential by the Evolution converter. All Operators (not [`state_fns`](qiskit.aqua.operators.state_fns#module-qiskit.aqua.operators.state_fns "qiskit.aqua.operators.state_fns")) have `.exp_i()` methods which either return the exponential of the Operator directly, or an [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp#qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") containing the Operator. +The [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") is simply a placeholder signifying that the Operator inside it should be converted to its exponential by the Evolution converter. All Operators (not [`state_fns`](qiskit.aqua.operators.state_fns#module-qiskit.aqua.operators.state_fns "qiskit.aqua.operators.state_fns")) have `.exp_i()` methods which either return the exponential of the Operator directly, or an [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") containing the Operator. - Evolutions work with parameterized Operator coefficients, so `my_expectation.convert((t * H).exp_i())`, where t is a scalar or Terra Parameter and H is an Operator, will produce a [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp#qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") equivalent to e^iHt. + Evolutions work with parameterized Operator coefficients, so `my_expectation.convert((t * H).exp_i())`, where t is a scalar or Terra Parameter and H is an Operator, will produce a [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") equivalent to e^iHt. # Evolution Base Class -The EvolutionBase class gives an interface for algorithms to ask for Evolutions as execution settings. For example, if an algorithm contains an Operator evolution step within it, such as [`QAOA`](qiskit.aqua.algorithms.QAOA#qiskit.aqua.algorithms.QAOA "qiskit.aqua.algorithms.QAOA"), the algorithm can give the opportunity for the user to pass an EvolutionBase of their choice to be used in that evolution step. +The EvolutionBase class gives an interface for algorithms to ask for Evolutions as execution settings. For example, if an algorithm contains an Operator evolution step within it, such as [`QAOA`](qiskit.aqua.algorithms.QAOA "qiskit.aqua.algorithms.QAOA"), the algorithm can give the opportunity for the user to pass an EvolutionBase of their choice to be used in that evolution step. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`EvolutionBase`](qiskit.aqua.operators.evolutions.EvolutionBase#qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") | A base for Evolution converters. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | -------------------------------- | +| [`EvolutionBase`](qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") | A base for Evolution converters. | # Evolutions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`EvolutionFactory`](qiskit.aqua.operators.evolutions.EvolutionFactory#qiskit.aqua.operators.evolutions.EvolutionFactory "qiskit.aqua.operators.evolutions.EvolutionFactory") | A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. | -| [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp#qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") | Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. | -| [`MatrixEvolution`](qiskit.aqua.operators.evolutions.MatrixEvolution#qiskit.aqua.operators.evolutions.MatrixEvolution "qiskit.aqua.operators.evolutions.MatrixEvolution") | Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. | -| [`PauliTrotterEvolution`](qiskit.aqua.operators.evolutions.PauliTrotterEvolution#qiskit.aqua.operators.evolutions.PauliTrotterEvolution "qiskit.aqua.operators.evolutions.PauliTrotterEvolution") | An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`EvolutionFactory`](qiskit.aqua.operators.evolutions.EvolutionFactory "qiskit.aqua.operators.evolutions.EvolutionFactory") | A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. | +| [`EvolvedOp`](qiskit.aqua.operators.evolutions.EvolvedOp "qiskit.aqua.operators.evolutions.EvolvedOp") | Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. | +| [`MatrixEvolution`](qiskit.aqua.operators.evolutions.MatrixEvolution "qiskit.aqua.operators.evolutions.MatrixEvolution") | Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. | +| [`PauliTrotterEvolution`](qiskit.aqua.operators.evolutions.PauliTrotterEvolution "qiskit.aqua.operators.evolutions.PauliTrotterEvolution") | An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and trotterizing. | # Trotterizations -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`TrotterizationBase`](qiskit.aqua.operators.evolutions.TrotterizationBase#qiskit.aqua.operators.evolutions.TrotterizationBase "qiskit.aqua.operators.evolutions.TrotterizationBase") | A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. | -| [`TrotterizationFactory`](qiskit.aqua.operators.evolutions.TrotterizationFactory#qiskit.aqua.operators.evolutions.TrotterizationFactory "qiskit.aqua.operators.evolutions.TrotterizationFactory") | A factory for conveniently creating TrotterizationBase instances. | -| [`Trotter`](qiskit.aqua.operators.evolutions.Trotter#qiskit.aqua.operators.evolutions.Trotter "qiskit.aqua.operators.evolutions.Trotter") | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | -| [`Suzuki`](qiskit.aqua.operators.evolutions.Suzuki#qiskit.aqua.operators.evolutions.Suzuki "qiskit.aqua.operators.evolutions.Suzuki") | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | -| [`QDrift`](qiskit.aqua.operators.evolutions.QDrift#qiskit.aqua.operators.evolutions.QDrift "qiskit.aqua.operators.evolutions.QDrift") | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`TrotterizationBase`](qiskit.aqua.operators.evolutions.TrotterizationBase "qiskit.aqua.operators.evolutions.TrotterizationBase") | A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. | +| [`TrotterizationFactory`](qiskit.aqua.operators.evolutions.TrotterizationFactory "qiskit.aqua.operators.evolutions.TrotterizationFactory") | A factory for conveniently creating TrotterizationBase instances. | +| [`Trotter`](qiskit.aqua.operators.evolutions.Trotter "qiskit.aqua.operators.evolutions.Trotter") | Simple Trotter expansion, composing the evolution circuits of each Operator in the sum together `reps` times and dividing the evolution time of each by `reps`. | +| [`Suzuki`](qiskit.aqua.operators.evolutions.Suzuki "qiskit.aqua.operators.evolutions.Suzuki") | Suzuki Trotter expansion, composing the evolution circuits of each Operator in the sum together by a recursive “bookends” strategy, repeating the whole composed circuit `reps` times. | +| [`QDrift`](qiskit.aqua.operators.evolutions.QDrift "qiskit.aqua.operators.evolutions.QDrift") | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | 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 a15db8809d1..4a47649405a 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 @@ -1,8 +1,16 @@ -# AerPauliExpectation +--- +title: AerPauliExpectation +description: API reference for qiskit.aqua.operators.expectations.AerPauliExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.expectations.AerPauliExpectation +--- +# AerPauliExpectation + -`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") Bases: `qiskit.aqua.operators.expectations.expectation_base.ExpectationBase` @@ -10,7 +18,43 @@ An Expectation converter for using Aer’s operator snapshot to take expectation ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.aqua.operators.expectations.AerPauliExpectation.compute_variance#qiskit.aqua.operators.expectations.AerPauliExpectation.compute_variance "qiskit.aqua.operators.expectations.AerPauliExpectation.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.aqua.operators.expectations.AerPauliExpectation.convert#qiskit.aqua.operators.expectations.AerPauliExpectation.convert "qiskit.aqua.operators.expectations.AerPauliExpectation.convert") | Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator after sampling. + +**Return type** + +`Union`\[`list`, `float`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation, equal to 0. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 57b6a29a23a..d5ac04bfab9 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 @@ -1,8 +1,16 @@ -# CVaRExpectation +--- +title: CVaRExpectation +description: API reference for qiskit.aqua.operators.expectations.CVaRExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.expectations.CVaRExpectation +--- +# CVaRExpectation + -`CVaRExpectation(alpha, expectation=None)` +`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` @@ -33,7 +41,45 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.aqua.operators.expectations.CVaRExpectation.compute_variance#qiskit.aqua.operators.expectations.CVaRExpectation.compute_variance "qiskit.aqua.operators.expectations.CVaRExpectation.compute_variance") | Returns the variance of the CVaR calculation | -| [`convert`](qiskit.aqua.operators.expectations.CVaRExpectation.convert#qiskit.aqua.operators.expectations.CVaRExpectation.convert "qiskit.aqua.operators.expectations.CVaRExpectation.convert") | Return an expression that computes the CVaR expectation upon calling `eval`. | +### compute\_variance + + + +`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 + +**Parameters** + +**exp\_op** (`OperatorBase`) – The operator whose evaluation yields an expectation of some StateFn against a diagonal observable. + +**Return type** + +`Union`\[`list`, `float`] + +**Returns** + +**The variance of the CVaR estimate corresponding to the converted** + +exp\_op. + +**Raises** + +**ValueError** – If the exp\_op does not correspond to an expectation value. + +### convert + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 aa1e1c003bc..d4ebaffdd5d 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 @@ -1,8 +1,16 @@ -# ExpectationBase +--- +title: ExpectationBase +description: API reference for qiskit.aqua.operators.expectations.ExpectationBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.expectations.ExpectationBase +--- +# ExpectationBase + -`ExpectationBase` +`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` @@ -10,7 +18,43 @@ A base for Expectation value converters. Expectations are converters which enabl ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.aqua.operators.expectations.ExpectationBase.compute_variance#qiskit.aqua.operators.expectations.ExpectationBase.compute_variance "qiskit.aqua.operators.expectations.ExpectationBase.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.aqua.operators.expectations.ExpectationBase.convert#qiskit.aqua.operators.expectations.ExpectationBase.convert "qiskit.aqua.operators.expectations.ExpectationBase.convert") | Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator after sampling. + +**Return type** + +`Union`\[`list`, `float`, `complex`, `ndarray`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 a92c6bb203c..899b706f36e 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 @@ -1,8 +1,16 @@ -# ExpectationFactory +--- +title: ExpectationFactory +description: API reference for qiskit.aqua.operators.expectations.ExpectationFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.expectations.ExpectationFactory +--- +# ExpectationFactory + -`ExpectationFactory` +`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` @@ -10,6 +18,29 @@ A factory class for convenient automatic selection of an Expectation based on th ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`build`](qiskit.aqua.operators.expectations.ExpectationFactory.build#qiskit.aqua.operators.expectations.ExpectationFactory.build "qiskit.aqua.operators.expectations.ExpectationFactory.build") | A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. | +### build + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – The Operator whose expectation value will be taken. +* **backend** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – The backend which will be used to sample the expectation value. +* **include\_custom** (`bool`) – Whether the factory will include the (Aer) specific custom expectations if their behavior against the backend might not be as expected. For instance when using Aer qasm\_simulator with paulis the Aer snapshot can be used but the outcome lacks shot noise and hence does not intuitively behave overall as people might expect when choosing a qasm\_simulator. It is however fast as long as the more state vector like behavior is acceptable. + +**Return type** + +`ExpectationBase` + +**Returns** + +The expectation algorithm which best fits the Operator and backend. + +**Raises** + +**ValueError** – If operator is not of a composition for which we know the best Expectation method. + 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 0c6da64d446..1ed2fe426da 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 @@ -1,8 +1,16 @@ -# MatrixExpectation +--- +title: MatrixExpectation +description: API reference for qiskit.aqua.operators.expectations.MatrixExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.expectations.MatrixExpectation +--- +# MatrixExpectation + -`MatrixExpectation` +`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` @@ -10,7 +18,43 @@ An Expectation converter which converts Operator measurements to be matrix-based ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.aqua.operators.expectations.MatrixExpectation.compute_variance#qiskit.aqua.operators.expectations.MatrixExpectation.compute_variance "qiskit.aqua.operators.expectations.MatrixExpectation.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.aqua.operators.expectations.MatrixExpectation.convert#qiskit.aqua.operators.expectations.MatrixExpectation.convert "qiskit.aqua.operators.expectations.MatrixExpectation.convert") | Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator. + +**Return type** + +`Union`\[`list`, `float`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation, equal to 0. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 ed97443b8de..115a7fef8a6 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 @@ -1,8 +1,16 @@ -# PauliExpectation +--- +title: PauliExpectation +description: API reference for qiskit.aqua.operators.expectations.PauliExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.expectations.PauliExpectation +--- +# PauliExpectation + -`PauliExpectation(group_paulis=True)` +`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` @@ -14,7 +22,43 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`compute_variance`](qiskit.aqua.operators.expectations.PauliExpectation.compute_variance#qiskit.aqua.operators.expectations.PauliExpectation.compute_variance "qiskit.aqua.operators.expectations.PauliExpectation.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.aqua.operators.expectations.PauliExpectation.convert#qiskit.aqua.operators.expectations.PauliExpectation.convert "qiskit.aqua.operators.expectations.PauliExpectation.convert") | 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. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator after sampling. + +**Return type** + +`Union`\[`list`, `float`, `ndarray`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.md index 4348dc4d012..e49482942fd 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.expectations.md @@ -16,23 +16,23 @@ python_api_name: qiskit.aqua.operators.expectations `qiskit.aqua.operators.expectations` -Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn#qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.aqua.operators.expectations.PauliExpectation#qiskit.aqua.operators.expectations.PauliExpectation "qiskit.aqua.operators.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.aqua.operators.converters.CircuitSampler#qiskit.aqua.operators.converters.CircuitSampler "qiskit.aqua.operators.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. +Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.aqua.operators.expectations.PauliExpectation "qiskit.aqua.operators.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.aqua.operators.converters.CircuitSampler "qiskit.aqua.operators.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. # Expectation Base Class -The ExpectationBase class gives an interface for algorithms to ask for Expectations as execution settings. For example, if an algorithm contains an expectation value step within it, such as [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"), the algorithm can give the opportunity for the user to pass an ExpectationBase of their choice to be used in that expectation value step. +The ExpectationBase class gives an interface for algorithms to ask for Expectations as execution settings. For example, if an algorithm contains an expectation value step within it, such as [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"), the algorithm can give the opportunity for the user to pass an ExpectationBase of their choice to be used in that expectation value step. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`ExpectationBase`](qiskit.aqua.operators.expectations.ExpectationBase#qiskit.aqua.operators.expectations.ExpectationBase "qiskit.aqua.operators.expectations.ExpectationBase") | A base for Expectation value converters. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| [`ExpectationBase`](qiskit.aqua.operators.expectations.ExpectationBase "qiskit.aqua.operators.expectations.ExpectationBase") | A base for Expectation value converters. | # Expectations -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory#qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") | A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. | -| [`AerPauliExpectation`](qiskit.aqua.operators.expectations.AerPauliExpectation#qiskit.aqua.operators.expectations.AerPauliExpectation "qiskit.aqua.operators.expectations.AerPauliExpectation") | An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. | -| [`MatrixExpectation`](qiskit.aqua.operators.expectations.MatrixExpectation#qiskit.aqua.operators.expectations.MatrixExpectation "qiskit.aqua.operators.expectations.MatrixExpectation") | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | -| [`PauliExpectation`](qiskit.aqua.operators.expectations.PauliExpectation#qiskit.aqua.operators.expectations.PauliExpectation "qiskit.aqua.operators.expectations.PauliExpectation") | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | -| [`CVaRExpectation`](qiskit.aqua.operators.expectations.CVaRExpectation#qiskit.aqua.operators.expectations.CVaRExpectation "qiskit.aqua.operators.expectations.CVaRExpectation") | Compute the Conditional Value at Risk (CVaR) expectation value. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") | A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. | +| [`AerPauliExpectation`](qiskit.aqua.operators.expectations.AerPauliExpectation "qiskit.aqua.operators.expectations.AerPauliExpectation") | An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. | +| [`MatrixExpectation`](qiskit.aqua.operators.expectations.MatrixExpectation "qiskit.aqua.operators.expectations.MatrixExpectation") | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | +| [`PauliExpectation`](qiskit.aqua.operators.expectations.PauliExpectation "qiskit.aqua.operators.expectations.PauliExpectation") | An Expectation converter for Pauli-basis observables by changing Pauli measurements to a diagonal (\{Z, I}^n) basis and appending circuit post-rotations to the measured state function. | +| [`CVaRExpectation`](qiskit.aqua.operators.expectations.CVaRExpectation "qiskit.aqua.operators.expectations.CVaRExpectation") | Compute the Conditional Value at Risk (CVaR) expectation value. | 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 10b2e203d37..a902b5ae962 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 @@ -1,8 +1,16 @@ -# CircuitGradient +--- +title: CircuitGradient +description: API reference for qiskit.aqua.operators.gradients.CircuitGradient +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.CircuitGradient +--- +# CircuitGradient + -`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") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -16,6 +24,26 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.CircuitGradient.convert#qiskit.aqua.operators.gradients.CircuitGradient.convert "qiskit.aqua.operators.gradients.CircuitGradient.convert") | **type operator**`OperatorBase` | +### convert + + + +`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** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient of +* **params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters we are taking the gradient wrt: ω If a ParameterExpression, ParameterVector or List\[ParameterExpression] is given, then the 1st order derivative of the operator is calculated. If a Tuple\[ParameterExpression, ParameterExpression] or List\[Tuple\[ParameterExpression, ParameterExpression]] is given, then the 2nd order derivative of the operator is calculated. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the Gradient. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + 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 823cfce0fe1..2c755ac3ec0 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 @@ -1,8 +1,16 @@ -# CircuitQFI +--- +title: CircuitQFI +description: API reference for qiskit.aqua.operators.gradients.CircuitQFI +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.CircuitQFI +--- +# CircuitQFI + -`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") Bases: `qiskit.aqua.operators.converters.converter_base.ConverterBase` @@ -16,6 +24,26 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.CircuitQFI.convert#qiskit.aqua.operators.gradients.CircuitQFI.convert "qiskit.aqua.operators.gradients.CircuitQFI.convert") | **type operator**`OperatorBase` | +### convert + + + +`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** + +* **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters $\omega$ with respect to which we are computing the QFI. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the QFI metric tensor. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + 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 154f782ee7e..b8978323d97 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 @@ -1,8 +1,16 @@ -# DerivativeBase +--- +title: DerivativeBase +description: API reference for qiskit.aqua.operators.gradients.DerivativeBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.DerivativeBase +--- +# DerivativeBase + -`DerivativeBase` +`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` @@ -16,8 +24,70 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.DerivativeBase.convert#qiskit.aqua.operators.gradients.DerivativeBase.convert "qiskit.aqua.operators.gradients.DerivativeBase.convert") | **type operator**`OperatorBase` | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.DerivativeBase.gradient_wrapper#qiskit.aqua.operators.gradients.DerivativeBase.gradient_wrapper "qiskit.aqua.operators.gradients.DerivativeBase.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.DerivativeBase.parameter_expression_grad#qiskit.aqua.operators.gradients.DerivativeBase.parameter_expression_grad "qiskit.aqua.operators.gradients.DerivativeBase.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert + + + +`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** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient, Hessian or QFI with respect to. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the gradient, Hessian or QFI. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + +### gradient\_wrapper + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. + +**Returns** + +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) + +### parameter\_expression\_grad + + + +`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. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + 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 3358a9819b9..9a3aef0c97e 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 @@ -1,8 +1,16 @@ -# Gradient +--- +title: Gradient +description: API reference for qiskit.aqua.operators.gradients.Gradient +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.Gradient +--- +# Gradient + -`Gradient(grad_method='param_shift', **kwargs)` +`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` @@ -19,16 +27,105 @@ Convert an operator expression to the first-order gradient. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.Gradient.convert#qiskit.aqua.operators.gradients.Gradient.convert "qiskit.aqua.operators.gradients.Gradient.convert") | **type operator**`OperatorBase` | -| [`get_gradient`](qiskit.aqua.operators.gradients.Gradient.get_gradient#qiskit.aqua.operators.gradients.Gradient.get_gradient "qiskit.aqua.operators.gradients.Gradient.get_gradient") | Get the gradient for the given operator w\.r.t. | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.Gradient.gradient_wrapper#qiskit.aqua.operators.gradients.Gradient.gradient_wrapper "qiskit.aqua.operators.gradients.Gradient.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.Gradient.parameter_expression_grad#qiskit.aqua.operators.gradients.Gradient.parameter_expression_grad "qiskit.aqua.operators.gradients.Gradient.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert -## Attributes + + +`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** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient of. +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – params: The parameters we are taking the gradient with respect to. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the Gradient. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + +### get\_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") + +Get the gradient for the given operator w\.r.t. the given parameters + +**Parameters** + +* **operator** (`OperatorBase`) – Operator w\.r.t. which we take the gradient. +* **params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – Parameters w\.r.t. which we compute the gradient. + +**Return type** + +`OperatorBase` + +**Returns** + +Operator which represents the gradient w\.r.t. the given params. + +**Raises** + +* **ValueError** – If `params` contains a parameter not present in `operator`. +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If the coefficient of the operator could not be reduced to 1. +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If the differentiation of a combo\_fn requires JAX but the package is not installed. +* **TypeError** – If the operator does not include a StateFn given by a quantum circuit +* **Exception** – Unintended code is reached + +### gradient\_wrapper + + + +`Gradient.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` + +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. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. + +**Returns** + +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) +### parameter\_expression\_grad + + +`static Gradient.parameter_expression_grad(param_expr, param)` + +Get the derivative of a parameter expression w\.r.t. the given parameter. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +## Attributes + + ### grad\_method @@ -41,3 +138,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 c81a7dad783..55ab93c2325 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 @@ -1,8 +1,16 @@ -# GradientBase +--- +title: GradientBase +description: API reference for qiskit.aqua.operators.gradients.GradientBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.GradientBase +--- +# GradientBase + -`GradientBase(grad_method='param_shift', **kwargs)` +`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` @@ -21,15 +29,76 @@ Convert an operator expression to the first-order gradient. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.GradientBase.convert#qiskit.aqua.operators.gradients.GradientBase.convert "qiskit.aqua.operators.gradients.GradientBase.convert") | **type operator**`OperatorBase` | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.GradientBase.gradient_wrapper#qiskit.aqua.operators.gradients.GradientBase.gradient_wrapper "qiskit.aqua.operators.gradients.GradientBase.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.GradientBase.parameter_expression_grad#qiskit.aqua.operators.gradients.GradientBase.parameter_expression_grad "qiskit.aqua.operators.gradients.GradientBase.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert -## Attributes + + +`abstract GradientBase.convert(operator, params=None)` + +**Parameters** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient, Hessian or QFI with respect to. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the gradient, Hessian or QFI. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + +### gradient\_wrapper + + + +`GradientBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` + +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. + +**Parameters** +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. +**Returns** + +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) + +### parameter\_expression\_grad + + + +`static GradientBase.parameter_expression_grad(param_expr, param)` + +Get the derivative of a parameter expression w\.r.t. the given parameter. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +## Attributes + + ### grad\_method @@ -42,3 +111,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 e806881560b..31aa592b695 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 @@ -1,8 +1,16 @@ -# Hessian +--- +title: Hessian +description: API reference for qiskit.aqua.operators.gradients.Hessian +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.Hessian +--- +# Hessian + -`Hessian(hess_method='param_shift', **kwargs)` +`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` @@ -19,16 +27,105 @@ Compute the Hessian of an expected value. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.Hessian.convert#qiskit.aqua.operators.gradients.Hessian.convert "qiskit.aqua.operators.gradients.Hessian.convert") | **type operator**`OperatorBase` | -| [`get_hessian`](qiskit.aqua.operators.gradients.Hessian.get_hessian#qiskit.aqua.operators.gradients.Hessian.get_hessian "qiskit.aqua.operators.gradients.Hessian.get_hessian") | Get the Hessian for the given operator w\.r.t. | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.Hessian.gradient_wrapper#qiskit.aqua.operators.gradients.Hessian.gradient_wrapper "qiskit.aqua.operators.gradients.Hessian.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.Hessian.parameter_expression_grad#qiskit.aqua.operators.gradients.Hessian.parameter_expression_grad "qiskit.aqua.operators.gradients.Hessian.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert -## Attributes + + +`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** + +* **operator** (`OperatorBase`) – The operator for which we compute the Hessian +* **params** (`Union`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `List`\[`ParameterExpression`], `ParameterVector`, `None`]) – The parameters we are computing the Hessian with respect to Either give directly the tuples/list of tuples for which the second order derivative is to be computed or give a list of parameters to build the full Hessian for those parameters. + +**Returns** + +An operator whose evaluation yields the Hessian + +**Return type** + +[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") + +**Raises** + +**ValueError** – If params is not set. + +### get\_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") + +Get the Hessian for the given operator w\.r.t. the given parameters + +**Parameters** + +* **operator** (`OperatorBase`) – Operator w\.r.t. which we take the Hessian. +* **params** (`Union`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – Parameters w\.r.t. which we compute the Hessian. + +**Return type** + +`OperatorBase` + +**Returns** + +Operator which represents the gradient w\.r.t. the given params. + +**Raises** + +* **ValueError** – If `params` contains a parameter not present in `operator`. +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If the coefficient of the operator could not be reduced to 1. AquaError: If the differentiation of a combo\_fn requires JAX but the package is not installed. +* **TypeError** – If the operator does not include a StateFn given by a quantum circuit +* **TypeError** – If the parameters were given in an unsupported format. +* **Exception** – Unintended code is reached + +### gradient\_wrapper + + + +`Hessian.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` + +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. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. + +**Returns** + +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) +### parameter\_expression\_grad + + +`static Hessian.parameter_expression_grad(param_expr, param)` + +Get the derivative of a parameter expression w\.r.t. the given parameter. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +## Attributes + + ### hess\_method @@ -41,3 +138,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 99932dd56eb..b1f14fb3936 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 @@ -1,8 +1,16 @@ -# HessianBase +--- +title: HessianBase +description: API reference for qiskit.aqua.operators.gradients.HessianBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.HessianBase +--- +# HessianBase + -`HessianBase(hess_method='param_shift', **kwargs)` +`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` @@ -19,15 +27,76 @@ Base class for the Hessian of an expected value. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.HessianBase.convert#qiskit.aqua.operators.gradients.HessianBase.convert "qiskit.aqua.operators.gradients.HessianBase.convert") | **type operator**`OperatorBase` | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.HessianBase.gradient_wrapper#qiskit.aqua.operators.gradients.HessianBase.gradient_wrapper "qiskit.aqua.operators.gradients.HessianBase.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.HessianBase.parameter_expression_grad#qiskit.aqua.operators.gradients.HessianBase.parameter_expression_grad "qiskit.aqua.operators.gradients.HessianBase.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert -## Attributes + + +`abstract HessianBase.convert(operator, params=None)` + +**Parameters** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient, Hessian or QFI with respect to. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the gradient, Hessian or QFI. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + +### gradient\_wrapper + + + +`HessianBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` + +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. + +**Parameters** +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. +**Returns** + +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) + +### parameter\_expression\_grad + + + +`static HessianBase.parameter_expression_grad(param_expr, param)` + +Get the derivative of a parameter expression w\.r.t. the given parameter. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +## Attributes + + ### hess\_method @@ -40,3 +109,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 b4315edb210..6d7b8d64b4a 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 @@ -1,8 +1,16 @@ -# NaturalGradient +--- +title: NaturalGradient +description: API reference for qiskit.aqua.operators.gradients.NaturalGradient +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.NaturalGradient +--- +# NaturalGradient + -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit-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` @@ -27,15 +35,77 @@ where R(x) represents the penalization term. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.NaturalGradient.convert#qiskit.aqua.operators.gradients.NaturalGradient.convert "qiskit.aqua.operators.gradients.NaturalGradient.convert") | **type operator**`OperatorBase` | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.NaturalGradient.gradient_wrapper#qiskit.aqua.operators.gradients.NaturalGradient.gradient_wrapper "qiskit.aqua.operators.gradients.NaturalGradient.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.NaturalGradient.parameter_expression_grad#qiskit.aqua.operators.gradients.NaturalGradient.parameter_expression_grad "qiskit.aqua.operators.gradients.NaturalGradient.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert -## Attributes + + +`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** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient of. +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient with respect to. + +**Return type** + +`OperatorBase` + +**Returns** +An operator whose evaluation yields the NaturalGradient. + +**Raises** + +* **TypeError** – If `operator` does not represent an expectation value or the quantum state is not `CircuitStateFn`. +* **ValueError** – If `params` contains a parameter not present in `operator`. + +### gradient\_wrapper + + + +`NaturalGradient.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` + +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. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. + +**Returns** +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) + +### parameter\_expression\_grad + + + +`static NaturalGradient.parameter_expression_grad(param_expr, param)` + +Get the derivative of a parameter expression w\.r.t. the given parameter. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +## Attributes + + ### grad\_method @@ -49,7 +119,7 @@ Returns `CircuitGradient`. `CircuitGradient`. - + ### qfi\_method @@ -61,7 +131,7 @@ Returns: `CircuitQFI` `CircuitQFI` - + ### regularization @@ -72,3 +142,4 @@ Returns: the regularization option. **Return type** `Optional`\[`str`] + 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 e1338ec2565..e11efc85ae5 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 @@ -1,8 +1,16 @@ -# QFI +--- +title: QFI +description: API reference for qiskit.aqua.operators.gradients.QFI +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.QFI +--- +# QFI + -`QFI(qfi_method='lin_comb_full')` +`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` @@ -17,7 +25,7 @@ $$ **Parameters** -**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.aqua.operators.gradients.CircuitQFI#qiskit.aqua.operators.gradients.CircuitQFI "qiskit.aqua.operators.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. +**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.aqua.operators.gradients.CircuitQFI "qiskit.aqua.operators.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. **Raises** @@ -25,15 +33,72 @@ $$ ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.QFI.convert#qiskit.aqua.operators.gradients.QFI.convert "qiskit.aqua.operators.gradients.QFI.convert") | **type operator**`CircuitStateFn` | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.QFI.gradient_wrapper#qiskit.aqua.operators.gradients.QFI.gradient_wrapper "qiskit.aqua.operators.gradients.QFI.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.QFI.parameter_expression_grad#qiskit.aqua.operators.gradients.QFI.parameter_expression_grad "qiskit.aqua.operators.gradients.QFI.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert -## Attributes + + +`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** +* **operator** (`CircuitStateFn`) – The operator corresponding to the quantum state |ψ(ω)〉for which we compute the QFI +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are computing the QFI wrt: ω + +**Return type** + +`ListOp` + +**Returns** + +ListOp\[ListOp] where the operator at position k,l corresponds to QFI\_kl + +### gradient\_wrapper + + + +`QFI.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` + +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. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. + +**Returns** +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) + +### parameter\_expression\_grad + + + +`static QFI.parameter_expression_grad(param_expr, param)` + +Get the derivative of a parameter expression w\.r.t. the given parameter. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +## Attributes + + ### qfi\_method @@ -46,3 +111,4 @@ Returns `CircuitQFI`. **Returns** `CircuitQFI`. + 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 cc383166c06..1231b401a6e 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 @@ -1,8 +1,16 @@ -# QFIBase +--- +title: QFIBase +description: API reference for qiskit.aqua.operators.gradients.QFIBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.gradients.QFIBase +--- +# QFIBase + -`QFIBase(qfi_method='lin_comb_full')` +`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` @@ -16,7 +24,7 @@ The QFI is: **Parameters** -**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.aqua.operators.gradients.CircuitQFI#qiskit.aqua.operators.gradients.CircuitQFI "qiskit.aqua.operators.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. +**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.aqua.operators.gradients.CircuitQFI "qiskit.aqua.operators.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. **Raises** @@ -24,15 +32,76 @@ The QFI is: ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.aqua.operators.gradients.QFIBase.convert#qiskit.aqua.operators.gradients.QFIBase.convert "qiskit.aqua.operators.gradients.QFIBase.convert") | **type operator**`OperatorBase` | -| [`gradient_wrapper`](qiskit.aqua.operators.gradients.QFIBase.gradient_wrapper#qiskit.aqua.operators.gradients.QFIBase.gradient_wrapper "qiskit.aqua.operators.gradients.QFIBase.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.aqua.operators.gradients.QFIBase.parameter_expression_grad#qiskit.aqua.operators.gradients.QFIBase.parameter_expression_grad "qiskit.aqua.operators.gradients.QFIBase.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert -## Attributes + + +`abstract QFIBase.convert(operator, params=None)` + +**Parameters** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient, Hessian or QFI with respect to. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the gradient, Hessian or QFI. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + +### gradient\_wrapper + + + +`QFIBase.gradient_wrapper(operator, bind_params, grad_params=None, backend=None)` + +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. + +**Parameters** +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. +**Returns** + +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +**Return type** + +callable(param\_values) + +### parameter\_expression\_grad + + + +`static QFIBase.parameter_expression_grad(param_expr, param)` + +Get the derivative of a parameter expression w\.r.t. the given parameter. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +## Attributes + + ### qfi\_method @@ -45,3 +114,4 @@ Returns `CircuitQFI`. **Returns** `CircuitQFI`. + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.md index 102c306a73b..71c872e414c 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.gradients.md @@ -99,26 +99,26 @@ The derivative classes come with a gradient\_wrapper() function which returns th # Base Classes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | -| [`DerivativeBase`](qiskit.aqua.operators.gradients.DerivativeBase#qiskit.aqua.operators.gradients.DerivativeBase "qiskit.aqua.operators.gradients.DerivativeBase") | Base class for differentiating opflow objects. | -| [`GradientBase`](qiskit.aqua.operators.gradients.GradientBase#qiskit.aqua.operators.gradients.GradientBase "qiskit.aqua.operators.gradients.GradientBase") | Base class for first-order operator gradient. | -| [`HessianBase`](qiskit.aqua.operators.gradients.HessianBase#qiskit.aqua.operators.gradients.HessianBase "qiskit.aqua.operators.gradients.HessianBase") | Base class for the Hessian of an expected value. | -| [`QFIBase`](qiskit.aqua.operators.gradients.QFIBase#qiskit.aqua.operators.gradients.QFIBase "qiskit.aqua.operators.gradients.QFIBase") | Base class for Quantum Fisher Information (QFI). | +| | | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | +| [`DerivativeBase`](qiskit.aqua.operators.gradients.DerivativeBase "qiskit.aqua.operators.gradients.DerivativeBase") | Base class for differentiating opflow objects. | +| [`GradientBase`](qiskit.aqua.operators.gradients.GradientBase "qiskit.aqua.operators.gradients.GradientBase") | Base class for first-order operator gradient. | +| [`HessianBase`](qiskit.aqua.operators.gradients.HessianBase "qiskit.aqua.operators.gradients.HessianBase") | Base class for the Hessian of an expected value. | +| [`QFIBase`](qiskit.aqua.operators.gradients.QFIBase "qiskit.aqua.operators.gradients.QFIBase") | Base class for Quantum Fisher Information (QFI). | # Converters -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| [`CircuitGradient`](qiskit.aqua.operators.gradients.CircuitGradient#qiskit.aqua.operators.gradients.CircuitGradient "qiskit.aqua.operators.gradients.CircuitGradient") | Circuit to gradient operator converter. | -| [`CircuitQFI`](qiskit.aqua.operators.gradients.CircuitQFI#qiskit.aqua.operators.gradients.CircuitQFI "qiskit.aqua.operators.gradients.CircuitQFI") | Circuit to Quantum Fisher Information operator converter. | +| | | +| ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| [`CircuitGradient`](qiskit.aqua.operators.gradients.CircuitGradient "qiskit.aqua.operators.gradients.CircuitGradient") | Circuit to gradient operator converter. | +| [`CircuitQFI`](qiskit.aqua.operators.gradients.CircuitQFI "qiskit.aqua.operators.gradients.CircuitQFI") | Circuit to Quantum Fisher Information operator converter. | # Derivatives -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`Gradient`](qiskit.aqua.operators.gradients.Gradient#qiskit.aqua.operators.gradients.Gradient "qiskit.aqua.operators.gradients.Gradient") | Convert an operator expression to the first-order gradient. | -| [`Hessian`](qiskit.aqua.operators.gradients.Hessian#qiskit.aqua.operators.gradients.Hessian "qiskit.aqua.operators.gradients.Hessian") | Compute the Hessian of an expected value. | -| [`NaturalGradient`](qiskit.aqua.operators.gradients.NaturalGradient#qiskit.aqua.operators.gradients.NaturalGradient "qiskit.aqua.operators.gradients.NaturalGradient") | Convert an operator expression to the first-order gradient. | -| [`QFI`](qiskit.aqua.operators.gradients.QFI#qiskit.aqua.operators.gradients.QFI "qiskit.aqua.operators.gradients.QFI") | Compute the Quantum Fisher Information (QFI). | +| | | +| ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| [`Gradient`](qiskit.aqua.operators.gradients.Gradient "qiskit.aqua.operators.gradients.Gradient") | Convert an operator expression to the first-order gradient. | +| [`Hessian`](qiskit.aqua.operators.gradients.Hessian "qiskit.aqua.operators.gradients.Hessian") | Compute the Hessian of an expected value. | +| [`NaturalGradient`](qiskit.aqua.operators.gradients.NaturalGradient "qiskit.aqua.operators.gradients.NaturalGradient") | Convert an operator expression to the first-order gradient. | +| [`QFI`](qiskit.aqua.operators.gradients.QFI "qiskit.aqua.operators.gradients.QFI") | Compute the Quantum Fisher Information (QFI). | 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 57c45504a0e..0a325af00ff 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 @@ -1,8 +1,16 @@ -# LegacyBaseOperator +--- +title: LegacyBaseOperator +description: API reference for qiskit.aqua.operators.legacy.LegacyBaseOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.legacy.LegacyBaseOperator +--- +# LegacyBaseOperator + -`LegacyBaseOperator(basis=None, z2_symmetries=None, name=None)` +`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` @@ -12,38 +20,83 @@ Constructor. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`chop`](qiskit.aqua.operators.legacy.LegacyBaseOperator.chop#qiskit.aqua.operators.legacy.LegacyBaseOperator.chop "qiskit.aqua.operators.legacy.LegacyBaseOperator.chop") | | -| [`construct_evaluation_circuit`](qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit#qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") | Build circuits to compute the expectation w\.r.t the wavefunction. | -| [`evaluate_with_result`](qiskit.aqua.operators.legacy.LegacyBaseOperator.evaluate_with_result#qiskit.aqua.operators.legacy.LegacyBaseOperator.evaluate_with_result "qiskit.aqua.operators.legacy.LegacyBaseOperator.evaluate_with_result") | Consume the result from the quantum computer to build the expectation, will be only used along with the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit#qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.LegacyBaseOperator.construct_evaluation_circuit") method. | -| [`evolve`](qiskit.aqua.operators.legacy.LegacyBaseOperator.evolve#qiskit.aqua.operators.legacy.LegacyBaseOperator.evolve "qiskit.aqua.operators.legacy.LegacyBaseOperator.evolve") | Time evolution, exp^(-jt H). | -| [`is_empty`](qiskit.aqua.operators.legacy.LegacyBaseOperator.is_empty#qiskit.aqua.operators.legacy.LegacyBaseOperator.is_empty "qiskit.aqua.operators.legacy.LegacyBaseOperator.is_empty") | Check Operator is empty or not | -| [`print_details`](qiskit.aqua.operators.legacy.LegacyBaseOperator.print_details#qiskit.aqua.operators.legacy.LegacyBaseOperator.print_details "qiskit.aqua.operators.legacy.LegacyBaseOperator.print_details") | print details | -| [`to_opflow`](qiskit.aqua.operators.legacy.LegacyBaseOperator.to_opflow#qiskit.aqua.operators.legacy.LegacyBaseOperator.to_opflow "qiskit.aqua.operators.legacy.LegacyBaseOperator.to_opflow") | Convert to new Operator format. | +### chop -## Attributes + + +`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") + +Build circuits to compute the expectation w\.r.t the wavefunction. + +### evaluate\_with\_result + + + +`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. + +### evolve + + + +`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). + +### is\_empty + +`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 + +### print\_details + + + +`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 + +### to\_opflow + + + +`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. + +## Attributes + + ### basis returns basis - + ### name returns name - + ### num\_qubits Returns number of qubits for operator - + ### z2\_symmetries returns z2 symmetries + 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 c1a1aa810da..d24a16a9769 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 @@ -1,8 +1,16 @@ -# MatrixOperator +--- +title: MatrixOperator +description: API reference for qiskit.aqua.operators.legacy.MatrixOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.legacy.MatrixOperator +--- +# MatrixOperator + -`MatrixOperator(matrix, basis=None, z2_symmetries=None, atol=1e-12, name=None)` +`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` @@ -16,65 +24,233 @@ Operators relevant for quantum applications * **matrix** (*numpy.ndarray or scipy.sparse.csr\_matrix*) – a 2-D sparse matrix represents operator (using CSR format internally) * **basis** (*list\[tuple(object, \[int])], optional*) – the grouping basis, each element is a tuple composed of the basis and the indices to paulis which are belonged to that group. e.g., if tpb basis is used, the object will be a pauli. by default, the group is equal to non-grouping, each pauli is its own basis. -* **z2\_symmetries** ([*Z2Symmetries*](qiskit.aqua.operators.legacy.Z2Symmetries#qiskit.aqua.operators.legacy.Z2Symmetries "qiskit.aqua.operators.legacy.Z2Symmetries")) – represent the Z2 symmetries +* **z2\_symmetries** ([*Z2Symmetries*](qiskit.aqua.operators.legacy.Z2Symmetries "qiskit.aqua.operators.legacy.Z2Symmetries")) – represent the Z2 symmetries * **atol** (*float*) – atol * **name** (*str*) – name ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.legacy.MatrixOperator.add#qiskit.aqua.operators.legacy.MatrixOperator.add "qiskit.aqua.operators.legacy.MatrixOperator.add") | | -| [`chop`](qiskit.aqua.operators.legacy.MatrixOperator.chop#qiskit.aqua.operators.legacy.MatrixOperator.chop "qiskit.aqua.operators.legacy.MatrixOperator.chop") | Eliminate the real and imagine part of coeff in each pauli by threshold. | -| [`construct_evaluation_circuit`](qiskit.aqua.operators.legacy.MatrixOperator.construct_evaluation_circuit#qiskit.aqua.operators.legacy.MatrixOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.MatrixOperator.construct_evaluation_circuit") | Construct the circuits for evaluation. | -| [`copy`](qiskit.aqua.operators.legacy.MatrixOperator.copy#qiskit.aqua.operators.legacy.MatrixOperator.copy "qiskit.aqua.operators.legacy.MatrixOperator.copy") | Get a copy of self. | -| [`evaluate_with_result`](qiskit.aqua.operators.legacy.MatrixOperator.evaluate_with_result#qiskit.aqua.operators.legacy.MatrixOperator.evaluate_with_result "qiskit.aqua.operators.legacy.MatrixOperator.evaluate_with_result") | Use the executed result with operator to get the evaluated value. | -| [`evaluate_with_statevector`](qiskit.aqua.operators.legacy.MatrixOperator.evaluate_with_statevector#qiskit.aqua.operators.legacy.MatrixOperator.evaluate_with_statevector "qiskit.aqua.operators.legacy.MatrixOperator.evaluate_with_statevector") | **param quantum\_state**quantum state | -| [`evolve`](qiskit.aqua.operators.legacy.MatrixOperator.evolve#qiskit.aqua.operators.legacy.MatrixOperator.evolve "qiskit.aqua.operators.legacy.MatrixOperator.evolve") | Carry out the eoh evolution for the operator under supplied specifications. | -| [`is_empty`](qiskit.aqua.operators.legacy.MatrixOperator.is_empty#qiskit.aqua.operators.legacy.MatrixOperator.is_empty "qiskit.aqua.operators.legacy.MatrixOperator.is_empty") | Check Operator is empty or not. | -| [`print_details`](qiskit.aqua.operators.legacy.MatrixOperator.print_details#qiskit.aqua.operators.legacy.MatrixOperator.print_details "qiskit.aqua.operators.legacy.MatrixOperator.print_details") | **returns**a formatted operator. | -| [`sub`](qiskit.aqua.operators.legacy.MatrixOperator.sub#qiskit.aqua.operators.legacy.MatrixOperator.sub "qiskit.aqua.operators.legacy.MatrixOperator.sub") | | -| [`to_opflow`](qiskit.aqua.operators.legacy.MatrixOperator.to_opflow#qiskit.aqua.operators.legacy.MatrixOperator.to_opflow "qiskit.aqua.operators.legacy.MatrixOperator.to_opflow") | to op flow | +### add -## Attributes + + +`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") + +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. + +**Parameters** + +* **threshold** (*float*) – threshold chops the paulis +* **copy** (*bool*) – copy or self + +**Returns** + +self or copy + +**Return type** + +[MatrixOperator](qiskit.aqua.operators.legacy.MatrixOperator "qiskit.aqua.operators.legacy.MatrixOperator") + +### construct\_evaluation\_circuit + + + +`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. + +**Parameters** + +* **wave\_function** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit. +* **statevector\_mode** (*bool*) – mode +* **use\_simulator\_snapshot\_mode** (*bool*) – uses simulator operator mode +* **circuit\_name\_prefix** (*str, optional*) – a prefix of circuit name + +**Returns** + +**the circuits for computing the expectation of the operator over** + +the wavefunction evaluation. + +**Return type** + +list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")] + +### copy + + + +`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. + +### evaluate\_with\_result + + + +`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. + +**Parameters** + +* **result** (*qiskit.Result*) – the result from the backend +* **statevector\_mode** (*bool*) – mode +* **use\_simulator\_snapshot\_mode** (*bool*) – uses simulator operator mode +* **circuit\_name\_prefix** (*str, optional*) – a prefix of circuit name + +**Returns** + +the mean value float: the standard deviation + +**Return type** + +float + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty + +### evaluate\_with\_statevector + + + +`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** + +**quantum\_state** (*numpy.ndarray*) – quantum state + +**Returns** + +the mean value float: the standard deviation + +**Return type** + +float + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty + +### evolve + + +`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. + +**Parameters** + +* **state\_in** (*Union(list,numpy.array)*) – A vector representing the initial state for the evolution +* **evo\_time** (*Union(complex, float)*) – The evolution time +* **num\_time\_slices** (*int*) – The number of time slices for the expansion +* **expansion\_mode** (*str*) – The mode under which the expansion is to be done. Currently support ‘trotter’, which follows the expansion as discussed in [http://science.sciencemag.org/content/273/5278/1073](http://science.sciencemag.org/content/273/5278/1073), and ‘suzuki’, which corresponds to the discussion in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf) +* **expansion\_order** (*int*) – The order for suzuki expansion + +**Returns** +Return the matrix vector multiplication result. + +**Return type** + +numpy.array + +**Raises** + +* **ValueError** – Invalid arguments +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty + +### is\_empty + + + +`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. + +**Returns** + +is empty? + +**Return type** + +bool + +### print\_details + + + +`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** + +a formatted operator. + +**Return type** + +str + +### sub + + + +`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") + +to op flow + +## Attributes + + ### atol return atol - + ### basis returns basis - + ### dense\_matrix Getter of matrix in dense matrix form. - + ### dia\_matrix diagonal matrix - + ### matrix Getter of matrix. - + ### name returns name - + ### num\_qubits @@ -88,8 +264,9 @@ number of qubits int - + ### z2\_symmetries returns z2 symmetries + 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 36507279ea3..58edb0b9a98 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 @@ -1,8 +1,16 @@ -# PauliGraph +--- +title: PauliGraph +description: API reference for qiskit.aqua.operators.legacy.PauliGraph +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.legacy.PauliGraph +--- +# PauliGraph + -`PauliGraph(paulis, mode='largest-degree')` +`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` @@ -10,8 +18,9 @@ Pauli Graph. ## Attributes - + ### grouped\_paulis Getter of grouped Pauli list. + 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 66bc618564a..65630538d2f 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 @@ -1,8 +1,16 @@ -# TPBGroupedWeightedPauliOperator +--- +title: TPBGroupedWeightedPauliOperator +description: API reference for qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator +--- +# TPBGroupedWeightedPauliOperator + -`TPBGroupedWeightedPauliOperator(paulis, basis, z2_symmetries=None, atol=1e-12, name=None, grouping_func=None, kwargs=None)` +`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` @@ -10,9 +18,9 @@ TPB Grouped Weighted Pauli Operator **Parameters** -* **paulis** (*list\[\[complex,* [*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]]*) – the list of weighted Paulis, where a weighted pauli is composed of a length-2 list and the first item is the weight and the second item is the Pauli object. +* **paulis** (*list\[\[complex,* [*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]]*) – the list of weighted Paulis, where a weighted pauli is composed of a length-2 list and the first item is the weight and the second item is the Pauli object. * **basis** (*list\[tuple(object, \[int])], optional*) – the grouping basis, each element is a tuple composed of the basis and the indices to paulis which are belonged to that group. e.g., if tpb basis is used, the object will be a pauli. By default, the group is equal to non-grouping, each pauli is its own basis. -* **z2\_symmetries** ([*Z2Symmetries*](qiskit.aqua.operators.legacy.Z2Symmetries#qiskit.aqua.operators.legacy.Z2Symmetries "qiskit.aqua.operators.legacy.Z2Symmetries")) – recording the z2 symmetries info +* **z2\_symmetries** ([*Z2Symmetries*](qiskit.aqua.operators.legacy.Z2Symmetries "qiskit.aqua.operators.legacy.Z2Symmetries")) – recording the z2 symmetries info * **atol** (*float, optional*) – the threshold used in truncating paulis * **name** (*str, optional*) – the name of operator. * **grouping\_func** (*Callable, optional*) – Function to group paulis @@ -20,74 +28,583 @@ TPB Grouped Weighted Pauli Operator ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.add#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.add "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.add") | Perform self + other. | -| [`anticommute_with`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.anticommute_with#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.anticommute_with "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.anticommute_with") | Anti commutes with | -| [`chop`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.chop#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.chop "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.chop") | Eliminate the real and imagine part of weight in each pauli by threshold. | -| [`commute_with`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.commute_with#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.commute_with "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.commute_with") | Commutes with | -| [`construct_evaluation_circuit`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.construct_evaluation_circuit#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.construct_evaluation_circuit") | Construct the circuits for evaluation, which calculating the expectation \. | -| [`copy`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.copy#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.copy "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.copy") | Get a copy of self | -| [`evaluate_with_result`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluate_with_result#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluate_with_result "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluate_with_result") | This method can be only used with the circuits generated by the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.construct_evaluation_circuit#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.construct_evaluation_circuit") method with the same circuit\_name\_prefix name since the circuit names are tied to some meanings. | -| [`evaluate_with_statevector`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluate_with_statevector#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluate_with_statevector "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluate_with_statevector") | **param quantum\_state**a quantum state. | -| [`evaluation_instruction`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluation_instruction#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluation_instruction "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evaluation_instruction") | **param statevector\_mode**will it be run on statevector simulator or not | -| [`evolve`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evolve#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evolve "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evolve") | Carry out the eoh evolution for the operator under supplied specifications. | -| [`evolve_instruction`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evolve_instruction#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evolve_instruction "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.evolve_instruction") | Carry out the eoh evolution for the operator under supplied specifications. | -| [`from_dict`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_dict#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_dict "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_dict") | Load paulis from a dictionary to construct an Operator. | -| [`from_file`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_file#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_file "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_file") | Load paulis in a file to construct an Operator. | -| [`from_list`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_list#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_list "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.from_list") | Create a WeightedPauliOperator via a pair of list. | -| [`is_empty`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.is_empty#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.is_empty "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.is_empty") | Check Operator is empty or not. | -| [`multiply`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.multiply#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.multiply "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.multiply") | Perform self \* other. | -| [`print_details`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.print_details#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.print_details "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.print_details") | Print out the operator in details. | -| [`reorder_paulis`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.reorder_paulis#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.reorder_paulis "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.reorder_paulis") | Reorder the paulis based on the basis and return the reordered paulis. | -| [`rounding`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.rounding#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.rounding "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.rounding") | Rounding the weight. | -| [`simplify`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.simplify#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.simplify "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.simplify") | Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. | -| [`sorted_grouping`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.sorted_grouping#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.sorted_grouping "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.sorted_grouping") | Largest-Degree First Coloring for grouping paulis. | -| [`sub`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.sub#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.sub "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.sub") | Perform self - other. | -| [`to_dict`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_dict#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_dict "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_dict") | Save operator to a dict in pauli representation. | -| [`to_file`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_file#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_file "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_file") | Save operator to a file in pauli representation. | -| [`to_opflow`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_opflow#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_opflow "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.to_opflow") | to op flow | -| [`unsorted_grouping`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.unsorted_grouping#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.unsorted_grouping "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.unsorted_grouping") | Greedy and unsorted grouping paulis. | +### add -## Attributes + + +`TPBGroupedWeightedPauliOperator.add(other, copy=False)` + +Perform self + other. + +**Parameters** + +* **other** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – to-be-combined operator +* **copy** (*bool*) – working on a copy or self, if False, the results are written back to self. + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### anticommute\_with + + + +`TPBGroupedWeightedPauliOperator.anticommute_with(other)` + +Anti commutes with + +### chop + + + +`TPBGroupedWeightedPauliOperator.chop(threshold=None, copy=False)` + +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. + + + If weight is real-only, the imaginary part is skipped. + + +**Parameters** + +* **threshold** (*float*) – the threshold is used to remove the paulis +* **copy** (*bool*) – chop on a copy or self + +**Returns** + +**if copy is True, the original operator is unchanged; otherwise,** + +the operator is mutated. + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### commute\_with + + + +`TPBGroupedWeightedPauliOperator.commute_with(other)` + +Commutes with + +### construct\_evaluation\_circuit + + + +`TPBGroupedWeightedPauliOperator.construct_evaluation_circuit(wave_function, statevector_mode, qr=None, cr=None, use_simulator_snapshot_mode=False, circuit_name_prefix='')` + +Construct the circuits for evaluation, which calculating the expectation \. + +At statevector mode: to simplify the computation, we do not build the whole circuit for \, instead of that we construct an individual circuit \ + +**Parameters** + +* **wave\_function** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit. +* **statevector\_mode** (*bool*) – indicate which type of simulator are going to use. +* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*, optional*) – the quantum register associated with the input\_circuit +* **cr** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*, optional*) – the classical register associated with the input\_circuit +* **use\_simulator\_snapshot\_mode** (*bool, optional*) – if aer\_provider is used, we can do faster evaluation for pauli mode on statevector simulation +* **circuit\_name\_prefix** (*str, optional*) – a prefix of circuit name + +**Returns** + +**a list of quantum circuits and each circuit with a unique name:** + +circuit\_name\_prefix + Pauli string + +**Return type** + +list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")] + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if quantum register is not provided explicitly and cannot find quantum register with q as the name +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – The provided qr is not in the wave\_function + +### copy + + + +`TPBGroupedWeightedPauliOperator.copy()` + +Get a copy of self + +### evaluate\_with\_result + + + +`TPBGroupedWeightedPauliOperator.evaluate_with_result(result, statevector_mode, use_simulator_snapshot_mode=False, circuit_name_prefix='')` + +This method can be only used with the circuits generated by the [`construct_evaluation_circuit()`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator#construct_evaluation_circuit "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator.construct_evaluation_circuit") method with the same circuit\_name\_prefix name since the circuit names are tied to some meanings. + +Calculate the evaluated value with the measurement results. + +**Parameters** + +* **result** (*qiskit.Result*) – the result from the backend. +* **statevector\_mode** (*bool*) – indicate which type of simulator are used. +* **use\_simulator\_snapshot\_mode** (*bool*) – if aer\_provider is used, we can do faster evaluation for pauli mode on statevector simulation +* **circuit\_name\_prefix** (*str*) – a prefix of circuit name + +**Returns** + +the mean value float: the standard deviation + +**Return type** + +float + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty + +### evaluate\_with\_statevector + + + +`TPBGroupedWeightedPauliOperator.evaluate_with_statevector(quantum_state)` + +**Parameters** + +**quantum\_state** (*numpy.ndarray*) – a quantum state. +**Returns** + +the mean value float: the standard deviation + +**Return type** + +float + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty + +### evaluation\_instruction + + + +`TPBGroupedWeightedPauliOperator.evaluation_instruction(statevector_mode, use_simulator_snapshot_mode=False)` + +**Parameters** + +* **statevector\_mode** (*bool*) – will it be run on statevector simulator or not +* **use\_simulator\_snapshot\_mode** (*bool*) – will it use qiskit aer simulator operator mode + +**Returns** + +Pauli-instruction pair. + +**Return type** + +dict + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – qiskit-aer not installed + +### evolve + + + +`TPBGroupedWeightedPauliOperator.evolve(state_in=None, evo_time=0, num_time_slices=1, quantum_registers=None, expansion_mode='trotter', expansion_order=1)` + +Carry out the eoh evolution for the operator under supplied specifications. + +**Parameters** + +* **state\_in** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – a circuit describes the input state +* **evo\_time** (*Union(complex, float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*)*) – The evolution time +* **num\_time\_slices** (*int*) – The number of time slices for the expansion +* **quantum\_registers** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The QuantumRegister to build the QuantumCircuit off of +* **expansion\_mode** (*str*) – The mode under which the expansion is to be done. Currently support ‘trotter’, which follows the expansion as discussed in [http://science.sciencemag.org/content/273/5278/1073](http://science.sciencemag.org/content/273/5278/1073), and ‘suzuki’, which corresponds to the discussion in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf) +* **expansion\_order** (*int*) – The order for suzuki expansion + +**Returns** + +The constructed circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – quantum\_registers must be in the provided state\_in circuit +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if operator is empty + +### evolve\_instruction + + + +`TPBGroupedWeightedPauliOperator.evolve_instruction(evo_time=0, num_time_slices=1, expansion_mode='trotter', expansion_order=1)` + +Carry out the eoh evolution for the operator under supplied specifications. + +**Parameters** + +* **evo\_time** (*Union(complex, float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*)*) – The evolution time +* **num\_time\_slices** (*int*) – The number of time slices for the expansion +* **expansion\_mode** (*str*) – The mode under which the expansion is to be done. Currently support ‘trotter’, which follows the expansion as discussed in [http://science.sciencemag.org/content/273/5278/1073](http://science.sciencemag.org/content/273/5278/1073), and ‘suzuki’, which corresponds to the discussion in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf) +* **expansion\_order** (*int*) – The order for suzuki expansion + +**Returns** + +The constructed QuantumCircuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **ValueError** – Number of time slices should be a non-negative integer +* **NotImplementedError** – expansion mode not supported +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if operator is empty + +### from\_dict + + + +`classmethod TPBGroupedWeightedPauliOperator.from_dict(dictionary, before_04=False)` + +Load paulis from a dictionary to construct an Operator. The dictionary must comprise the key ‘paulis’ having a value which is an array of pauli dicts. Each dict in this array must be represented by label and coeff (real and imag) such as in the following example: + +```python +{'paulis': + [ + {'label': 'IIII', + 'coeff': {'real': -0.33562957575267038, 'imag': 0.0}}, + {'label': 'ZIII', + 'coeff': {'real': 0.28220597164664896, 'imag': 0.0}}, + ... + ] + } +``` + +**Parameters** + +* **dictionary** (*dict*) – dictionary, which contains a list of Paulis and coefficients. +* **before\_04** (*bool*) – support the format before Aqua 0.4. + +**Returns** + +the operator created from the input dictionary. + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid dictionary + +### from\_file + + + +`classmethod TPBGroupedWeightedPauliOperator.from_file(file_name, before_04=False)` + +Load paulis in a file to construct an Operator. + +**Parameters** + +* **file\_name** (*str*) – path to the file, which contains a list of Paulis and coefficients. +* **before\_04** (*bool*) – support the format before Aqua 0.4. + +**Returns** + +the loaded operator. + +**Return type** +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### from\_list + + + +`classmethod TPBGroupedWeightedPauliOperator.from_list(paulis, weights=None, name=None)` + +Create a WeightedPauliOperator via a pair of list. + +**Parameters** + +* **paulis** (*list\[*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – the list of Paulis +* **weights** (*list\[complex], optional*) – the list of weights, if it is None, all weights are 1. +* **name** (*str, optional*) – name of the operator. + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +**Raises** + +**ValueError** – The length of weights and paulis must be the same + +### is\_empty + + + +`TPBGroupedWeightedPauliOperator.is_empty()` + +Check Operator is empty or not. + +**Returns** + +True if empty, False otherwise + +**Return type** + +bool + +### multiply + + + +`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. + +Note: Grouping of the new operator, will be as per self’s grouping. + +**Parameters** + +**other** ([*TPBGroupedWeightedPauliOperator*](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator")) – an operator + +**Returns** + +the multiplied operator + +**Return type** + +[TPBGroupedWeightedPauliOperator](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator") + +### print\_details + + + +`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. + +**Returns** + +a formatted string describes the operator. + +**Return type** + +str + +### reorder\_paulis + + + +`TPBGroupedWeightedPauliOperator.reorder_paulis()` + +Reorder the paulis based on the basis and return the reordered paulis. + +**Return type** + +`List`\[`List`\[`Union`\[`complex`, `Pauli`]]] + +**Returns** + +the ordered paulis based on the basis. + +### rounding + + + +`TPBGroupedWeightedPauliOperator.rounding(decimals, copy=False)` + +Rounding the weight. + +**Parameters** + +* **decimals** (*int*) – rounding the weight to the decimals. +* **copy** (*bool*) – chop on a copy or self + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### simplify + + + +`TPBGroupedWeightedPauliOperator.simplify(copy=False)` + +Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. + + + This behavior of this method is slightly changed, it will remove the paulis whose weights are zero. + + +**Parameters** + +**copy** (*bool*) – simplify on a copy or self + +**Returns** + +the simplified operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### sorted\_grouping + + + +`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. + +**Parameters** + +* **weighted\_pauli\_operator** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – the to-be-grouped weighted pauli operator. +* **method** (*str*) – only largest-degree is available now. + +**Returns** + +operator + +**Return type** + +[TPBGroupedWeightedPauliOperator](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator") + +### sub + + + +`TPBGroupedWeightedPauliOperator.sub(other, copy=False)` + +Perform self - other. + +**Parameters** + +* **other** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – to-be-combined operator +* **copy** (*bool*) – working on a copy or self, if False, the results are written back to self. + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### to\_dict + + + +`TPBGroupedWeightedPauliOperator.to_dict()` + +Save operator to a dict in pauli representation. + +**Returns** + +a dictionary contains an operator with pauli representation. + +**Return type** + +dict + +### to\_file + + + +`TPBGroupedWeightedPauliOperator.to_file(file_name)` + +Save operator to a file in pauli representation. + +**Parameters** + +**file\_name** (*str*) – path to the file + +### to\_opflow + + + +`TPBGroupedWeightedPauliOperator.to_opflow(reverse_endianness=False)` + +to op flow + +### unsorted\_grouping + + + +`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. + +**Parameters** + +**weighted\_pauli\_operator** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – the to-be-grouped weighted pauli operator. + +**Returns** + +operator + +**Return type** + +[TPBGroupedWeightedPauliOperator](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator") + +## Attributes + + ### atol get atol - + ### basis returns basis - + ### grouping\_func returns grouping function - + ### kwargs returns kwargs - + ### name returns name - + ### num\_groups returns number of groups - + ### num\_qubits @@ -101,14 +618,15 @@ number of qubits int - + ### paulis get paulis - + ### z2\_symmetries returns z2 symmetries + 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 464c25a1e9e..4130ae96338 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 @@ -1,8 +1,16 @@ -# WeightedPauliOperator +--- +title: WeightedPauliOperator +description: API reference for qiskit.aqua.operators.legacy.WeightedPauliOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.legacy.WeightedPauliOperator +--- +# WeightedPauliOperator + -`WeightedPauliOperator(paulis, basis=None, z2_symmetries=None, atol=1e-12, name=None)` +`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` @@ -18,54 +26,522 @@ Weighted Pauli Operator ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.legacy.WeightedPauliOperator.add#qiskit.aqua.operators.legacy.WeightedPauliOperator.add "qiskit.aqua.operators.legacy.WeightedPauliOperator.add") | Perform self + other. | -| [`anticommute_with`](qiskit.aqua.operators.legacy.WeightedPauliOperator.anticommute_with#qiskit.aqua.operators.legacy.WeightedPauliOperator.anticommute_with "qiskit.aqua.operators.legacy.WeightedPauliOperator.anticommute_with") | Anti commutes with | -| [`chop`](qiskit.aqua.operators.legacy.WeightedPauliOperator.chop#qiskit.aqua.operators.legacy.WeightedPauliOperator.chop "qiskit.aqua.operators.legacy.WeightedPauliOperator.chop") | Eliminate the real and imagine part of weight in each pauli by threshold. | -| [`commute_with`](qiskit.aqua.operators.legacy.WeightedPauliOperator.commute_with#qiskit.aqua.operators.legacy.WeightedPauliOperator.commute_with "qiskit.aqua.operators.legacy.WeightedPauliOperator.commute_with") | Commutes with | -| [`construct_evaluation_circuit`](qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit#qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit "qiskit.aqua.operators.legacy.WeightedPauliOperator.construct_evaluation_circuit") | Construct the circuits for evaluation, which calculating the expectation \. | -| [`copy`](qiskit.aqua.operators.legacy.WeightedPauliOperator.copy#qiskit.aqua.operators.legacy.WeightedPauliOperator.copy "qiskit.aqua.operators.legacy.WeightedPauliOperator.copy") | Get a copy of self | -| [`evaluate_with_result`](qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluate_with_result#qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluate_with_result "qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluate_with_result") | 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 "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. | -| [`evaluate_with_statevector`](qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluate_with_statevector#qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluate_with_statevector "qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluate_with_statevector") | **param quantum\_state**a quantum state. | -| [`evaluation_instruction`](qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluation_instruction#qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluation_instruction "qiskit.aqua.operators.legacy.WeightedPauliOperator.evaluation_instruction") | **param statevector\_mode**will it be run on statevector simulator or not | -| [`evolve`](qiskit.aqua.operators.legacy.WeightedPauliOperator.evolve#qiskit.aqua.operators.legacy.WeightedPauliOperator.evolve "qiskit.aqua.operators.legacy.WeightedPauliOperator.evolve") | Carry out the eoh evolution for the operator under supplied specifications. | -| [`evolve_instruction`](qiskit.aqua.operators.legacy.WeightedPauliOperator.evolve_instruction#qiskit.aqua.operators.legacy.WeightedPauliOperator.evolve_instruction "qiskit.aqua.operators.legacy.WeightedPauliOperator.evolve_instruction") | Carry out the eoh evolution for the operator under supplied specifications. | -| [`from_dict`](qiskit.aqua.operators.legacy.WeightedPauliOperator.from_dict#qiskit.aqua.operators.legacy.WeightedPauliOperator.from_dict "qiskit.aqua.operators.legacy.WeightedPauliOperator.from_dict") | Load paulis from a dictionary to construct an Operator. | -| [`from_file`](qiskit.aqua.operators.legacy.WeightedPauliOperator.from_file#qiskit.aqua.operators.legacy.WeightedPauliOperator.from_file "qiskit.aqua.operators.legacy.WeightedPauliOperator.from_file") | Load paulis in a file to construct an Operator. | -| [`from_list`](qiskit.aqua.operators.legacy.WeightedPauliOperator.from_list#qiskit.aqua.operators.legacy.WeightedPauliOperator.from_list "qiskit.aqua.operators.legacy.WeightedPauliOperator.from_list") | Create a WeightedPauliOperator via a pair of list. | -| [`is_empty`](qiskit.aqua.operators.legacy.WeightedPauliOperator.is_empty#qiskit.aqua.operators.legacy.WeightedPauliOperator.is_empty "qiskit.aqua.operators.legacy.WeightedPauliOperator.is_empty") | Check Operator is empty or not. | -| [`multiply`](qiskit.aqua.operators.legacy.WeightedPauliOperator.multiply#qiskit.aqua.operators.legacy.WeightedPauliOperator.multiply "qiskit.aqua.operators.legacy.WeightedPauliOperator.multiply") | Perform self \* other, and the phases are tracked. | -| [`print_details`](qiskit.aqua.operators.legacy.WeightedPauliOperator.print_details#qiskit.aqua.operators.legacy.WeightedPauliOperator.print_details "qiskit.aqua.operators.legacy.WeightedPauliOperator.print_details") | Print out the operator in details. | -| [`reorder_paulis`](qiskit.aqua.operators.legacy.WeightedPauliOperator.reorder_paulis#qiskit.aqua.operators.legacy.WeightedPauliOperator.reorder_paulis "qiskit.aqua.operators.legacy.WeightedPauliOperator.reorder_paulis") | Reorder the paulis based on the basis and return the reordered paulis. | -| [`rounding`](qiskit.aqua.operators.legacy.WeightedPauliOperator.rounding#qiskit.aqua.operators.legacy.WeightedPauliOperator.rounding "qiskit.aqua.operators.legacy.WeightedPauliOperator.rounding") | Rounding the weight. | -| [`simplify`](qiskit.aqua.operators.legacy.WeightedPauliOperator.simplify#qiskit.aqua.operators.legacy.WeightedPauliOperator.simplify "qiskit.aqua.operators.legacy.WeightedPauliOperator.simplify") | Merge the paulis whose bases are identical and the pauli with zero coefficient would be removed. | -| [`sub`](qiskit.aqua.operators.legacy.WeightedPauliOperator.sub#qiskit.aqua.operators.legacy.WeightedPauliOperator.sub "qiskit.aqua.operators.legacy.WeightedPauliOperator.sub") | Perform self - other. | -| [`to_dict`](qiskit.aqua.operators.legacy.WeightedPauliOperator.to_dict#qiskit.aqua.operators.legacy.WeightedPauliOperator.to_dict "qiskit.aqua.operators.legacy.WeightedPauliOperator.to_dict") | Save operator to a dict in pauli representation. | -| [`to_file`](qiskit.aqua.operators.legacy.WeightedPauliOperator.to_file#qiskit.aqua.operators.legacy.WeightedPauliOperator.to_file "qiskit.aqua.operators.legacy.WeightedPauliOperator.to_file") | Save operator to a file in pauli representation. | -| [`to_opflow`](qiskit.aqua.operators.legacy.WeightedPauliOperator.to_opflow#qiskit.aqua.operators.legacy.WeightedPauliOperator.to_opflow "qiskit.aqua.operators.legacy.WeightedPauliOperator.to_opflow") | to op flow | +### add -## Attributes + + +`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. + +**Parameters** + +* **other** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – to-be-combined operator +* **copy** (*bool*) – working on a copy or self, if False, the results are written back to self. + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### anticommute\_with + + + +`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 + +### chop + + + +`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. + + + If weight is real-only, the imaginary part is skipped. + + +**Parameters** + +* **threshold** (*float*) – the threshold is used to remove the paulis +* **copy** (*bool*) – chop on a copy or self + +**Returns** + +**if copy is True, the original operator is unchanged; otherwise,** + +the operator is mutated. + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### commute\_with + + + +`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 + +### construct\_evaluation\_circuit + + + +`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 \. + +At statevector mode: to simplify the computation, we do not build the whole circuit for \, instead of that we construct an individual circuit \ + +**Parameters** + +* **wave\_function** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit. +* **statevector\_mode** (*bool*) – indicate which type of simulator are going to use. +* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*, optional*) – the quantum register associated with the input\_circuit +* **cr** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")*, optional*) – the classical register associated with the input\_circuit +* **use\_simulator\_snapshot\_mode** (*bool, optional*) – if aer\_provider is used, we can do faster evaluation for pauli mode on statevector simulation +* **circuit\_name\_prefix** (*str, optional*) – a prefix of circuit name + +**Returns** + +**a list of quantum circuits and each circuit with a unique name:** + +circuit\_name\_prefix + Pauli string + +**Return type** + +list\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")] + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if quantum register is not provided explicitly and cannot find quantum register with q as the name +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – The provided qr is not in the wave\_function + +### copy + + + +`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 + +### evaluate\_with\_result + + + +`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. + +Calculate the evaluated value with the measurement results. + +**Parameters** + +* **result** (*qiskit.Result*) – the result from the backend. +* **statevector\_mode** (*bool*) – indicate which type of simulator are used. +* **use\_simulator\_snapshot\_mode** (*bool*) – if aer\_provider is used, we can do faster evaluation for pauli mode on statevector simulation +* **circuit\_name\_prefix** (*str*) – a prefix of circuit name + +**Returns** + +the mean value float: the standard deviation + +**Return type** + +float +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty + +### evaluate\_with\_statevector + + + +`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** + +**quantum\_state** (*numpy.ndarray*) – a quantum state. + +**Returns** + +the mean value float: the standard deviation + +**Return type** + +float + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty + +### evaluation\_instruction + + + +`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** + +* **statevector\_mode** (*bool*) – will it be run on statevector simulator or not +* **use\_simulator\_snapshot\_mode** (*bool*) – will it use qiskit aer simulator operator mode + +**Returns** + +Pauli-instruction pair. + +**Return type** + +dict + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if Operator is empty +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – qiskit-aer not installed + +### evolve + + + +`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. + +**Parameters** + +* **state\_in** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – a circuit describes the input state +* **evo\_time** (*Union(complex, float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*)*) – The evolution time +* **num\_time\_slices** (*int*) – The number of time slices for the expansion +* **quantum\_registers** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – The QuantumRegister to build the QuantumCircuit off of +* **expansion\_mode** (*str*) – The mode under which the expansion is to be done. Currently support ‘trotter’, which follows the expansion as discussed in [http://science.sciencemag.org/content/273/5278/1073](http://science.sciencemag.org/content/273/5278/1073), and ‘suzuki’, which corresponds to the discussion in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf) +* **expansion\_order** (*int*) – The order for suzuki expansion + +**Returns** + +The constructed circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – quantum\_registers must be in the provided state\_in circuit +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if operator is empty + +### evolve\_instruction + + + +`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. + +**Parameters** + +* **evo\_time** (*Union(complex, float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*)*) – The evolution time +* **num\_time\_slices** (*int*) – The number of time slices for the expansion +* **expansion\_mode** (*str*) – The mode under which the expansion is to be done. Currently support ‘trotter’, which follows the expansion as discussed in [http://science.sciencemag.org/content/273/5278/1073](http://science.sciencemag.org/content/273/5278/1073), and ‘suzuki’, which corresponds to the discussion in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/quant-ph/0508139.pdf) +* **expansion\_order** (*int*) – The order for suzuki expansion + +**Returns** + +The constructed QuantumCircuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **ValueError** – Number of time slices should be a non-negative integer +* **NotImplementedError** – expansion mode not supported +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if operator is empty + +### from\_dict + + + +`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: + +```python +{'paulis': + [ + {'label': 'IIII', + 'coeff': {'real': -0.33562957575267038, 'imag': 0.0}}, + {'label': 'ZIII', + 'coeff': {'real': 0.28220597164664896, 'imag': 0.0}}, + ... + ] + } +``` + +**Parameters** + +* **dictionary** (*dict*) – dictionary, which contains a list of Paulis and coefficients. +* **before\_04** (*bool*) – support the format before Aqua 0.4. + +**Returns** + +the operator created from the input dictionary. + +**Return type** +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid dictionary + +### from\_file + + + +`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. + +**Parameters** + +* **file\_name** (*str*) – path to the file, which contains a list of Paulis and coefficients. +* **before\_04** (*bool*) – support the format before Aqua 0.4. + +**Returns** + +the loaded operator. + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### from\_list + + + +`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. + +**Parameters** + +* **paulis** (*list\[*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – the list of Paulis +* **weights** (*list\[complex], optional*) – the list of weights, if it is None, all weights are 1. +* **name** (*str, optional*) – name of the operator. + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +**Raises** + +**ValueError** – The length of weights and paulis must be the same + +### is\_empty + + + +`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. + +**Returns** + +True if empty, False otherwise + +**Return type** + +bool + +### multiply + + + +`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. + +**Parameters** + +**other** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – an operator + +**Returns** + +the multiplied operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### print\_details + + + +`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. + +**Returns** + +a formatted string describes the operator. + +**Return type** + +str + +### reorder\_paulis + + + +`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. + +**Return type** + +`List`\[`List`\[`Union`\[`complex`, `Pauli`]]] + +**Returns** + +the ordered paulis based on the basis. + +### rounding + + + +`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. + +**Parameters** + +* **decimals** (*int*) – rounding the weight to the decimals. +* **copy** (*bool*) – chop on a copy or self + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### simplify + + + +`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. + + + This behavior of this method is slightly changed, it will remove the paulis whose weights are zero. + + +**Parameters** + +**copy** (*bool*) – simplify on a copy or self + +**Returns** + +the simplified operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### sub + + + +`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. + +**Parameters** + +* **other** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – to-be-combined operator +* **copy** (*bool*) – working on a copy or self, if False, the results are written back to self. + +**Returns** + +operator + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +### to\_dict + + + +`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. + +**Returns** + +a dictionary contains an operator with pauli representation. + +**Return type** + +dict + +### to\_file + + + +`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. + +**Parameters** + +**file\_name** (*str*) – path to the file + +### to\_opflow + + + +`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 + +## Attributes + + ### atol get atol - + ### basis returns basis - + ### name returns name - + ### num\_qubits @@ -79,14 +555,15 @@ number of qubits int - + ### paulis get paulis - + ### z2\_symmetries returns z2 symmetries + 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 02629da9014..07bd6621292 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 @@ -1,8 +1,16 @@ -# Z2Symmetries +--- +title: Z2Symmetries +description: API reference for qiskit.aqua.operators.legacy.Z2Symmetries +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.legacy.Z2Symmetries +--- +# Z2Symmetries + -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` +`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` @@ -10,29 +18,142 @@ Z2 Symmetries **Parameters** -* **symmetries** (*list\[*[*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – the list of Pauli objects representing the Z\_2 symmetries -* **sq\_paulis** (*list\[*[*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – the list of single - qubit Pauli objects to construct the Clifford operators +* **symmetries** (*list\[*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – the list of Pauli objects representing the Z\_2 symmetries +* **sq\_paulis** (*list\[*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]*) – the list of single - qubit Pauli objects to construct the Clifford operators * **sq\_list** (*list\[int]*) – the list of support of the single-qubit Pauli objects used to build the Clifford operators * **tapering\_values** (*list\[int], optional*) – values determines the sector. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid paulis +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Invalid paulis ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| [`consistent_tapering`](qiskit.aqua.operators.legacy.Z2Symmetries.consistent_tapering#qiskit.aqua.operators.legacy.Z2Symmetries.consistent_tapering "qiskit.aqua.operators.legacy.Z2Symmetries.consistent_tapering") | Tapering the operator with the same manner of how this tapered operator is created. | -| [`copy`](qiskit.aqua.operators.legacy.Z2Symmetries.copy#qiskit.aqua.operators.legacy.Z2Symmetries.copy "qiskit.aqua.operators.legacy.Z2Symmetries.copy") | Get a copy of self. | -| [`find_Z2_symmetries`](qiskit.aqua.operators.legacy.Z2Symmetries.find_Z2_symmetries#qiskit.aqua.operators.legacy.Z2Symmetries.find_Z2_symmetries "qiskit.aqua.operators.legacy.Z2Symmetries.find_Z2_symmetries") | Finds Z2 Pauli-type symmetries of an Operator. | -| [`is_empty`](qiskit.aqua.operators.legacy.Z2Symmetries.is_empty#qiskit.aqua.operators.legacy.Z2Symmetries.is_empty "qiskit.aqua.operators.legacy.Z2Symmetries.is_empty") | Check the z2\_symmetries is empty or not. | -| [`taper`](qiskit.aqua.operators.legacy.Z2Symmetries.taper#qiskit.aqua.operators.legacy.Z2Symmetries.taper "qiskit.aqua.operators.legacy.Z2Symmetries.taper") | Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. | -| [`two_qubit_reduction`](qiskit.aqua.operators.legacy.Z2Symmetries.two_qubit_reduction#qiskit.aqua.operators.legacy.Z2Symmetries.two_qubit_reduction "qiskit.aqua.operators.legacy.Z2Symmetries.two_qubit_reduction") | Eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions | +### consistent\_tapering -## Attributes + + +`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. + +**Parameters** + +**operator** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – the to-be-tapered operator + +**Returns** + +the tapered operator + +**Return type** + +TaperedWeightedPauliOperator + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – The given operator does not commute with the symmetry + +### copy + + + +`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. + +**Return type** + +`Z2Symmetries` + +**Returns** + +copy + +### find\_Z2\_symmetries + + + +`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. + +**Return type** + +`Z2Symmetries` + +**Returns** + +a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. + +### is\_empty + + + +`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. + +**Returns** + +empty + +**Return type** + +bool + +### taper + + + +`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. + +**Parameters** + +* **operator** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – the to-be-tapered operator. +* **tapering\_values** (*list\[int], optional*) – if None, returns operators at each sector; otherwise, returns the operator located in that sector. + +**Returns** + +**If** + +tapering\_values is None: \[:class\`WeightedPauliOperator\`]; otherwise, [`WeightedPauliOperator`](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +**Return type** + +list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")] or [WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +**Raises** +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – Z2 symmetries, single qubit pauli and single qubit list cannot be empty +### two\_qubit\_reduction + + + +`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 + +Chemistry specific method: It can be used to taper two qubits in parity and binary-tree mapped fermionic Hamiltonians when the spin orbitals are ordered in two spin sectors, (block spin order) according to the number of particles in the system. + +**Parameters** + +* **operator** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – the operator +* **num\_particles** (*Union(list, int)*) – number of particles, if it is a list, the first number is alpha and the second number if beta. + +**Returns** + +a new operator whose qubit number is reduced by 2. + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +## Attributes + + ### cliffords @@ -44,28 +165,29 @@ a list of unitaries used to diagonalize the Hamiltonian. **Return type** -list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")] - +list\[[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")] + ### sq\_list returns sq list - + ### sq\_paulis returns sq paulis - + ### symmetries return symmetries - + ### tapering\_values returns tapering values + 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 a23657fdf70..54ed6048178 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 @@ -1,15 +1,23 @@ -# qiskit.aqua.operators.legacy.check\_commutativity +--- +title: check_commutativity +description: API reference for qiskit.aqua.operators.legacy.check_commutativity +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.check_commutativity +--- +# qiskit.aqua.operators.legacy.check\_commutativity + -`check_commutativity(op_1, op_2, anti=False)` +`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. **Parameters** -* **op\_1** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator -* **op\_2** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator +* **op\_1** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator +* **op\_2** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator * **anti** (*bool*) – if True, check anti-commutativity, otherwise check commutativity. **Returns** @@ -19,3 +27,4 @@ whether or not two operators are commuted or anti-commuted. **Return type** bool + 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 03140fa9e4b..00bc003bb8b 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.operators.legacy.commutator +--- +title: commutator +description: API reference for qiskit.aqua.operators.legacy.commutator +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.commutator +--- +# qiskit.aqua.operators.legacy.commutator + -`commutator(op_a, op_b, op_c=None, sign=False, threshold=1e-12)` +`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. @@ -18,9 +26,9 @@ result = 0.5 \* (2\*A\*B\*C + 2\*C\*B\*A - B\*A\*C - C\*A\*B - A\*C\*B - B\*C\*A **Parameters** -* **op\_a** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator a -* **op\_b** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator b -* **op\_c** (*Optional(*[*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")*)*) – operator c +* **op\_a** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator a +* **op\_b** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – operator b +* **op\_c** (*Optional(*[*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")*)*) – operator c * **sign** (*bool*) – False anti-commutes, True commutes * **threshold** (*float*) – the truncation threshold @@ -30,8 +38,9 @@ the commutator **Return type** -[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") For the final chop, the original codes only contain the paulis with real coefficient. + 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 1f61e261bce..a48f905b210 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 @@ -1,16 +1,24 @@ -# qiskit.aqua.operators.legacy.covariance +--- +title: covariance +description: API reference for qiskit.aqua.operators.legacy.covariance +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.covariance +--- +# qiskit.aqua.operators.legacy.covariance + -`covariance(data, pauli_1, pauli_2, avg_1, avg_2)` +`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. **Parameters** * **data** (*dict*) – a dictionary of the form data = \{‘00000’: 10} (\{str:int}) -* **pauli\_1** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli class member -* **pauli\_2** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli class member +* **pauli\_1** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli class member +* **pauli\_2** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli class member * **avg\_1** (*float*) – expectation value of pauli\_1 on data * **avg\_2** (*float*) – expectation value of pauli\_2 on data @@ -21,3 +29,4 @@ the element of the covariance matrix between two Paulis **Return type** float + 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 1139b9a2bbb..595de8a5493 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 @@ -1,15 +1,23 @@ -# qiskit.aqua.operators.legacy.evolution\_instruction +--- +title: evolution_instruction +description: API reference for qiskit.aqua.operators.legacy.evolution_instruction +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.evolution_instruction +--- +# 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)` +`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. **Parameters** -* **pauli\_list** (*list(\[\[complex,* [*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]])*) – The list of pauli terms corresponding to a single time slice to be evolved -* **evo\_time** (*Union(complex, float,* [*Parameter*](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*)*) – The evolution time +* **pauli\_list** (*list(\[\[complex,* [*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]])*) – The list of pauli terms corresponding to a single time slice to be evolved +* **evo\_time** (*Union(complex, float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*,* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*)*) – The evolution time * **num\_time\_slices** (*int*) – The number of time slices for the expansion * **controlled** (*bool, optional*) – Controlled circuit or not * **power** (*int, optional*) – The power to which the unitary operator is to be raised @@ -23,9 +31,10 @@ The Instruction corresponding to specified evolution. **Return type** -[Instruction](qiskit.circuit.Instruction#qiskit.circuit.Instruction "qiskit.circuit.Instruction") +[Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") **Raises** -* [**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – power must be an integer and greater or equal to 1 +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – power must be an integer and greater or equal to 1 * **ValueError** – Unrecognized pauli + 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 09fe544d514..322f1a31046 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.operators.legacy.kernel\_F2 +--- +title: kernel_F2 +description: API reference for qiskit.aqua.operators.legacy.kernel_F2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.kernel_F2 +--- +# qiskit.aqua.operators.legacy.kernel\_F2 + -`kernel_F2(matrix_in)` +`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 @@ -17,3 +25,4 @@ the list of kernel vectors **Return type** list\[numpy.ndarray] + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.md index 4ec5e07aaf9..82c86a3ea7e 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.legacy.md @@ -24,26 +24,26 @@ These are the Operators provided by Aqua up until the 0.6 release. These are bei # Legacy Operators -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`LegacyBaseOperator`](qiskit.aqua.operators.legacy.LegacyBaseOperator#qiskit.aqua.operators.legacy.LegacyBaseOperator "qiskit.aqua.operators.legacy.LegacyBaseOperator") | Operators relevant for quantum applications. | -| [`WeightedPauliOperator`](qiskit.aqua.operators.legacy.WeightedPauliOperator#qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") | Weighted Pauli Operator | -| [`TPBGroupedWeightedPauliOperator`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator#qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator") | TPB Grouped Weighted Pauli Operator | -| [`MatrixOperator`](qiskit.aqua.operators.legacy.MatrixOperator#qiskit.aqua.operators.legacy.MatrixOperator "qiskit.aqua.operators.legacy.MatrixOperator") | Operators relevant for quantum applications | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | +| [`LegacyBaseOperator`](qiskit.aqua.operators.legacy.LegacyBaseOperator "qiskit.aqua.operators.legacy.LegacyBaseOperator") | Operators relevant for quantum applications. | +| [`WeightedPauliOperator`](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") | Weighted Pauli Operator | +| [`TPBGroupedWeightedPauliOperator`](qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator "qiskit.aqua.operators.legacy.TPBGroupedWeightedPauliOperator") | TPB Grouped Weighted Pauli Operator | +| [`MatrixOperator`](qiskit.aqua.operators.legacy.MatrixOperator "qiskit.aqua.operators.legacy.MatrixOperator") | Operators relevant for quantum applications | # Legacy Operator support -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`evolution_instruction`](qiskit.aqua.operators.legacy.evolution_instruction#qiskit.aqua.operators.legacy.evolution_instruction "qiskit.aqua.operators.legacy.evolution_instruction") | Construct the evolution circuit according to the supplied specification. | -| [`suzuki_expansion_slice_pauli_list`](qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list#qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list "qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list") | 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). | -| [`pauli_measurement`](qiskit.aqua.operators.legacy.pauli_measurement#qiskit.aqua.operators.legacy.pauli_measurement "qiskit.aqua.operators.legacy.pauli_measurement") | Add the proper post-rotation gate on the circuit. | -| [`measure_pauli_z`](qiskit.aqua.operators.legacy.measure_pauli_z#qiskit.aqua.operators.legacy.measure_pauli_z "qiskit.aqua.operators.legacy.measure_pauli_z") | Appropriate post-rotations on the state are assumed. | -| [`covariance`](qiskit.aqua.operators.legacy.covariance#qiskit.aqua.operators.legacy.covariance "qiskit.aqua.operators.legacy.covariance") | Compute the covariance matrix element between two Paulis, given the measurement outcome. | -| [`row_echelon_F2`](qiskit.aqua.operators.legacy.row_echelon_F2#qiskit.aqua.operators.legacy.row_echelon_F2 "qiskit.aqua.operators.legacy.row_echelon_F2") | Computes the row Echelon form of a binary matrix on the binary finite field | -| [`kernel_F2`](qiskit.aqua.operators.legacy.kernel_F2#qiskit.aqua.operators.legacy.kernel_F2 "qiskit.aqua.operators.legacy.kernel_F2") | Computes the kernel of a binary matrix on the binary finite field | -| [`commutator`](qiskit.aqua.operators.legacy.commutator#qiskit.aqua.operators.legacy.commutator "qiskit.aqua.operators.legacy.commutator") | Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. | -| [`check_commutativity`](qiskit.aqua.operators.legacy.check_commutativity#qiskit.aqua.operators.legacy.check_commutativity "qiskit.aqua.operators.legacy.check_commutativity") | Check the (anti-)commutativity between two operators. | -| [`PauliGraph`](qiskit.aqua.operators.legacy.PauliGraph#qiskit.aqua.operators.legacy.PauliGraph "qiskit.aqua.operators.legacy.PauliGraph") | Pauli Graph. | -| [`Z2Symmetries`](qiskit.aqua.operators.legacy.Z2Symmetries#qiskit.aqua.operators.legacy.Z2Symmetries "qiskit.aqua.operators.legacy.Z2Symmetries") | Z2 Symmetries | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`evolution_instruction`](qiskit.aqua.operators.legacy.evolution_instruction "qiskit.aqua.operators.legacy.evolution_instruction") | Construct the evolution circuit according to the supplied specification. | +| [`suzuki_expansion_slice_pauli_list`](qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list "qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list") | 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). | +| [`pauli_measurement`](qiskit.aqua.operators.legacy.pauli_measurement "qiskit.aqua.operators.legacy.pauli_measurement") | Add the proper post-rotation gate on the circuit. | +| [`measure_pauli_z`](qiskit.aqua.operators.legacy.measure_pauli_z "qiskit.aqua.operators.legacy.measure_pauli_z") | Appropriate post-rotations on the state are assumed. | +| [`covariance`](qiskit.aqua.operators.legacy.covariance "qiskit.aqua.operators.legacy.covariance") | Compute the covariance matrix element between two Paulis, given the measurement outcome. | +| [`row_echelon_F2`](qiskit.aqua.operators.legacy.row_echelon_F2 "qiskit.aqua.operators.legacy.row_echelon_F2") | Computes the row Echelon form of a binary matrix on the binary finite field | +| [`kernel_F2`](qiskit.aqua.operators.legacy.kernel_F2 "qiskit.aqua.operators.legacy.kernel_F2") | Computes the kernel of a binary matrix on the binary finite field | +| [`commutator`](qiskit.aqua.operators.legacy.commutator "qiskit.aqua.operators.legacy.commutator") | Compute commutator of op\_a and op\_b or the symmetric double commutator of op\_a, op\_b and op\_c. | +| [`check_commutativity`](qiskit.aqua.operators.legacy.check_commutativity "qiskit.aqua.operators.legacy.check_commutativity") | Check the (anti-)commutativity between two operators. | +| [`PauliGraph`](qiskit.aqua.operators.legacy.PauliGraph "qiskit.aqua.operators.legacy.PauliGraph") | Pauli Graph. | +| [`Z2Symmetries`](qiskit.aqua.operators.legacy.Z2Symmetries "qiskit.aqua.operators.legacy.Z2Symmetries") | Z2 Symmetries | 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 0293556cad8..7893e39abcf 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 @@ -1,15 +1,23 @@ -# qiskit.aqua.operators.legacy.measure\_pauli\_z +--- +title: measure_pauli_z +description: API reference for qiskit.aqua.operators.legacy.measure_pauli_z +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.measure_pauli_z +--- +# qiskit.aqua.operators.legacy.measure\_pauli\_z + -`measure_pauli_z(data, pauli)` +`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. **Parameters** * **data** (*dict*) – a dictionary of the form data = \{‘00000’: 10} (\{str: int}) -* **pauli** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli object +* **pauli** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli object **Returns** @@ -18,3 +26,4 @@ Expected value of paulis given data **Return type** float + 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 e7d231b91dc..8a362afd9e7 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 @@ -1,17 +1,25 @@ -# qiskit.aqua.operators.legacy.pauli\_measurement +--- +title: pauli_measurement +description: API reference for qiskit.aqua.operators.legacy.pauli_measurement +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.pauli_measurement +--- +# qiskit.aqua.operators.legacy.pauli\_measurement + -`pauli_measurement(circuit, pauli, qr, cr, barrier=False)` +`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. **Parameters** -* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the circuit to be modified. -* **pauli** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – the pauli will be added. -* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the quantum register associated with the circuit. -* **cr** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")) – the classical register associated with the circuit. +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the circuit to be modified. +* **pauli** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – the pauli will be added. +* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – the quantum register associated with the circuit. +* **cr** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")) – the classical register associated with the circuit. * **barrier** (*bool, optional*) – whether or not add barrier before measurement. **Returns** @@ -20,4 +28,5 @@ the original circuit object with post-rotation gate **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 b56921551ec..00fcd91dd4a 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.operators.legacy.row\_echelon\_F2 +--- +title: row_echelon_F2 +description: API reference for qiskit.aqua.operators.legacy.row_echelon_F2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.row_echelon_F2 +--- +# qiskit.aqua.operators.legacy.row\_echelon\_F2 + -`row_echelon_F2(matrix_in)` +`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 @@ -17,3 +25,4 @@ matrix\_in in Echelon row form **Return type** numpy.ndarray + 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 18a6395a299..3e3ccffc3b4 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 @@ -1,14 +1,22 @@ -# qiskit.aqua.operators.legacy.suzuki\_expansion\_slice\_pauli\_list +--- +title: suzuki_expansion_slice_pauli_list +description: API reference for qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.operators.legacy.suzuki_expansion_slice_pauli_list +--- +# qiskit.aqua.operators.legacy.suzuki\_expansion\_slice\_pauli\_list + -`suzuki_expansion_slice_pauli_list(pauli_list, lam_coef, expansion_order)` +`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). **Parameters** -* **pauli\_list** (*list\[list\[complex,* [*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]]*) – The slice’s weighted Pauli list for the suzuki expansion +* **pauli\_list** (*list\[list\[complex,* [*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*]]*) – The slice’s weighted Pauli list for the suzuki expansion * **lam\_coef** (*float*) – The parameter lambda as defined in said paper, adjusted for the evolution time and the number of time slices * **expansion\_order** (*int*) – The order for suzuki expansion @@ -19,3 +27,4 @@ slice pauli list **Return type** list + 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 051dd394bb5..2a15f7437f5 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 @@ -1,8 +1,16 @@ -# ComposedOp +--- +title: ComposedOp +description: API reference for qiskit.aqua.operators.list_ops.ComposedOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.list_ops.ComposedOp +--- +# ComposedOp + -`ComposedOp(oplist, coeff=1.0, abelian=False)` +`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` @@ -16,50 +24,492 @@ A class for lazily representing compositions of Operators. Often Operators canno ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.list_ops.ComposedOp.add#qiskit.aqua.operators.list_ops.ComposedOp.add "qiskit.aqua.operators.list_ops.ComposedOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.list_ops.ComposedOp.adjoint#qiskit.aqua.operators.list_ops.ComposedOp.adjoint "qiskit.aqua.operators.list_ops.ComposedOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.list_ops.ComposedOp.assign_parameters#qiskit.aqua.operators.list_ops.ComposedOp.assign_parameters "qiskit.aqua.operators.list_ops.ComposedOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.list_ops.ComposedOp.bind_parameters#qiskit.aqua.operators.list_ops.ComposedOp.bind_parameters "qiskit.aqua.operators.list_ops.ComposedOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.list_ops.ComposedOp.compose#qiskit.aqua.operators.list_ops.ComposedOp.compose "qiskit.aqua.operators.list_ops.ComposedOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.list_ops.ComposedOp.equals#qiskit.aqua.operators.list_ops.ComposedOp.equals "qiskit.aqua.operators.list_ops.ComposedOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.list_ops.ComposedOp.eval#qiskit.aqua.operators.list_ops.ComposedOp.eval "qiskit.aqua.operators.list_ops.ComposedOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.list_ops.ComposedOp.exp_i#qiskit.aqua.operators.list_ops.ComposedOp.exp_i "qiskit.aqua.operators.list_ops.ComposedOp.exp_i") | Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). | -| [`log_i`](qiskit.aqua.operators.list_ops.ComposedOp.log_i#qiskit.aqua.operators.list_ops.ComposedOp.log_i "qiskit.aqua.operators.list_ops.ComposedOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.list_ops.ComposedOp.mul#qiskit.aqua.operators.list_ops.ComposedOp.mul "qiskit.aqua.operators.list_ops.ComposedOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.list_ops.ComposedOp.neg#qiskit.aqua.operators.list_ops.ComposedOp.neg "qiskit.aqua.operators.list_ops.ComposedOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`non_distributive_reduce`](qiskit.aqua.operators.list_ops.ComposedOp.non_distributive_reduce#qiskit.aqua.operators.list_ops.ComposedOp.non_distributive_reduce "qiskit.aqua.operators.list_ops.ComposedOp.non_distributive_reduce") | Reduce without attempting to expand all distributive compositions. | -| [`permute`](qiskit.aqua.operators.list_ops.ComposedOp.permute#qiskit.aqua.operators.list_ops.ComposedOp.permute "qiskit.aqua.operators.list_ops.ComposedOp.permute") | Permute the qubits of the operator. | -| [`power`](qiskit.aqua.operators.list_ops.ComposedOp.power#qiskit.aqua.operators.list_ops.ComposedOp.power "qiskit.aqua.operators.list_ops.ComposedOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.list_ops.ComposedOp.primitive_strings#qiskit.aqua.operators.list_ops.ComposedOp.primitive_strings "qiskit.aqua.operators.list_ops.ComposedOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.list_ops.ComposedOp.reduce#qiskit.aqua.operators.list_ops.ComposedOp.reduce "qiskit.aqua.operators.list_ops.ComposedOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.list_ops.ComposedOp.tensor#qiskit.aqua.operators.list_ops.ComposedOp.tensor "qiskit.aqua.operators.list_ops.ComposedOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.list_ops.ComposedOp.tensorpower#qiskit.aqua.operators.list_ops.ComposedOp.tensorpower "qiskit.aqua.operators.list_ops.ComposedOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.list_ops.ComposedOp.to_circuit#qiskit.aqua.operators.list_ops.ComposedOp.to_circuit "qiskit.aqua.operators.list_ops.ComposedOp.to_circuit") | Returns the quantum circuit, representing the composed operator. | -| [`to_circuit_op`](qiskit.aqua.operators.list_ops.ComposedOp.to_circuit_op#qiskit.aqua.operators.list_ops.ComposedOp.to_circuit_op "qiskit.aqua.operators.list_ops.ComposedOp.to_circuit_op") | Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. | -| [`to_legacy_op`](qiskit.aqua.operators.list_ops.ComposedOp.to_legacy_op#qiskit.aqua.operators.list_ops.ComposedOp.to_legacy_op "qiskit.aqua.operators.list_ops.ComposedOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.list_ops.ComposedOp.to_matrix#qiskit.aqua.operators.list_ops.ComposedOp.to_matrix "qiskit.aqua.operators.list_ops.ComposedOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.list_ops.ComposedOp.to_matrix_op#qiskit.aqua.operators.list_ops.ComposedOp.to_matrix_op "qiskit.aqua.operators.list_ops.ComposedOp.to_matrix_op") | Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. | -| [`to_pauli_op`](qiskit.aqua.operators.list_ops.ComposedOp.to_pauli_op#qiskit.aqua.operators.list_ops.ComposedOp.to_pauli_op "qiskit.aqua.operators.list_ops.ComposedOp.to_pauli_op") | Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. | -| [`to_spmatrix`](qiskit.aqua.operators.list_ops.ComposedOp.to_spmatrix#qiskit.aqua.operators.list_ops.ComposedOp.to_spmatrix "qiskit.aqua.operators.list_ops.ComposedOp.to_spmatrix") | Returns SciPy sparse matrix representation of the Operator. | -| [`traverse`](qiskit.aqua.operators.list_ops.ComposedOp.traverse#qiskit.aqua.operators.list_ops.ComposedOp.traverse "qiskit.aqua.operators.list_ops.ComposedOp.traverse") | Apply the convert\_fn to each node in the oplist. | +### add -## Attributes + + +`ComposedOp.add(other)` + +Return Operator addition of self and other, overloaded by `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`ComposedOp.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`ComposedOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`ComposedOp.equals(other)` + +Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +ListOp’s eval recursively evaluates each Operator in `oplist`, and combines the results using the recombination function `combo_fn`. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the `oplist` Operators’ evaluation function, combined with the `combo_fn`. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +**Raises** + +* **NotImplementedError** – Raised if called for a subclass which is not distributive. +* **TypeError** – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported. +* **NotImplementedError** – Attempting to call ListOp’s eval from a non-distributive subclass. + +### exp\_i + + + +`ComposedOp.exp_i()` + +Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). + +**Return type** + +`OperatorBase` + +### log\_i + + + +`ComposedOp.log_i(massive=False)` + +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. + +**Return type** + +`OperatorBase` + +### mul + + + +`ComposedOp.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`ComposedOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### non\_distributive\_reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced Operator. + +### permute + + + +`ComposedOp.permute(permutation)` + +Permute the qubits of the operator. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`ListOp` + +**Returns** + +A new ListOp representing the permuted operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. +### power + + +`ComposedOp.power(exponent)` + +Return Operator composed with self multiple times, overloaded by `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`ComposedOp.primitive_strings()` + +Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`ComposedOp.tensor(other)` + +Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`ComposedOp.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The circuit representation of the composed operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – for operators where a single underlying circuit can not be obtained. + +### to\_circuit\_op + + + +`ComposedOp.to_circuit_op()` + +Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. + +**Return type** + +`OperatorBase` + +### to\_legacy\_op + + + +`ComposedOp.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`ComposedOp.to_matrix(massive=False)` + +Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`ComposedOp.to_matrix_op(massive=False)` + +Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`ComposedOp.to_pauli_op(massive=False)` + +Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. + +**Return type** + +`OperatorBase` + +### to\_spmatrix + + + +`ComposedOp.to_spmatrix()` + +Returns SciPy sparse matrix representation of the Operator. + +**Return type** + +`Union`\[`spmatrix`, `List`\[`spmatrix`]] + +**Returns** + +CSR sparse matrix representation of the Operator, or List thereof. + +### traverse + + + +`ComposedOp.traverse(convert_fn, coeff=None)` + +Apply the convert\_fn to each node in the oplist. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted ListOp. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### abelian @@ -73,7 +523,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -87,7 +537,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -101,7 +551,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -109,7 +559,7 @@ The combination function. `bool` - + ### grad\_combo\_fn @@ -119,7 +569,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### num\_qubits @@ -127,7 +577,7 @@ The gradient of `combo_fn`. `int` - + ### oplist @@ -141,6 +591,7 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters + 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 92c9f5304b4..234d33c0976 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 @@ -1,8 +1,16 @@ -# ListOp +--- +title: ListOp +description: API reference for qiskit.aqua.operators.list_ops.ListOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.list_ops.ListOp +--- +# ListOp + -`ListOp(oplist, combo_fn=>, coeff=1.0, abelian=False, grad_combo_fn=None)` +`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` @@ -25,48 +33,456 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.list_ops.ListOp.add#qiskit.aqua.operators.list_ops.ListOp.add "qiskit.aqua.operators.list_ops.ListOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.list_ops.ListOp.adjoint#qiskit.aqua.operators.list_ops.ListOp.adjoint "qiskit.aqua.operators.list_ops.ListOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.list_ops.ListOp.assign_parameters#qiskit.aqua.operators.list_ops.ListOp.assign_parameters "qiskit.aqua.operators.list_ops.ListOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.list_ops.ListOp.bind_parameters#qiskit.aqua.operators.list_ops.ListOp.bind_parameters "qiskit.aqua.operators.list_ops.ListOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.list_ops.ListOp.compose#qiskit.aqua.operators.list_ops.ListOp.compose "qiskit.aqua.operators.list_ops.ListOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.list_ops.ListOp.equals#qiskit.aqua.operators.list_ops.ListOp.equals "qiskit.aqua.operators.list_ops.ListOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.list_ops.ListOp.eval#qiskit.aqua.operators.list_ops.ListOp.eval "qiskit.aqua.operators.list_ops.ListOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.list_ops.ListOp.exp_i#qiskit.aqua.operators.list_ops.ListOp.exp_i "qiskit.aqua.operators.list_ops.ListOp.exp_i") | Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). | -| [`log_i`](qiskit.aqua.operators.list_ops.ListOp.log_i#qiskit.aqua.operators.list_ops.ListOp.log_i "qiskit.aqua.operators.list_ops.ListOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.list_ops.ListOp.mul#qiskit.aqua.operators.list_ops.ListOp.mul "qiskit.aqua.operators.list_ops.ListOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.list_ops.ListOp.neg#qiskit.aqua.operators.list_ops.ListOp.neg "qiskit.aqua.operators.list_ops.ListOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.list_ops.ListOp.permute#qiskit.aqua.operators.list_ops.ListOp.permute "qiskit.aqua.operators.list_ops.ListOp.permute") | Permute the qubits of the operator. | -| [`power`](qiskit.aqua.operators.list_ops.ListOp.power#qiskit.aqua.operators.list_ops.ListOp.power "qiskit.aqua.operators.list_ops.ListOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.list_ops.ListOp.primitive_strings#qiskit.aqua.operators.list_ops.ListOp.primitive_strings "qiskit.aqua.operators.list_ops.ListOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.list_ops.ListOp.reduce#qiskit.aqua.operators.list_ops.ListOp.reduce "qiskit.aqua.operators.list_ops.ListOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.list_ops.ListOp.tensor#qiskit.aqua.operators.list_ops.ListOp.tensor "qiskit.aqua.operators.list_ops.ListOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.list_ops.ListOp.tensorpower#qiskit.aqua.operators.list_ops.ListOp.tensorpower "qiskit.aqua.operators.list_ops.ListOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit_op`](qiskit.aqua.operators.list_ops.ListOp.to_circuit_op#qiskit.aqua.operators.list_ops.ListOp.to_circuit_op "qiskit.aqua.operators.list_ops.ListOp.to_circuit_op") | Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. | -| [`to_legacy_op`](qiskit.aqua.operators.list_ops.ListOp.to_legacy_op#qiskit.aqua.operators.list_ops.ListOp.to_legacy_op "qiskit.aqua.operators.list_ops.ListOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.list_ops.ListOp.to_matrix#qiskit.aqua.operators.list_ops.ListOp.to_matrix "qiskit.aqua.operators.list_ops.ListOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.list_ops.ListOp.to_matrix_op#qiskit.aqua.operators.list_ops.ListOp.to_matrix_op "qiskit.aqua.operators.list_ops.ListOp.to_matrix_op") | Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. | -| [`to_pauli_op`](qiskit.aqua.operators.list_ops.ListOp.to_pauli_op#qiskit.aqua.operators.list_ops.ListOp.to_pauli_op "qiskit.aqua.operators.list_ops.ListOp.to_pauli_op") | Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. | -| [`to_spmatrix`](qiskit.aqua.operators.list_ops.ListOp.to_spmatrix#qiskit.aqua.operators.list_ops.ListOp.to_spmatrix "qiskit.aqua.operators.list_ops.ListOp.to_spmatrix") | Returns SciPy sparse matrix representation of the Operator. | -| [`traverse`](qiskit.aqua.operators.list_ops.ListOp.traverse#qiskit.aqua.operators.list_ops.ListOp.traverse "qiskit.aqua.operators.list_ops.ListOp.traverse") | Apply the convert\_fn to each node in the oplist. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`ListOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +ListOp’s eval recursively evaluates each Operator in `oplist`, and combines the results using the recombination function `combo_fn`. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`, `list`] + +**Returns** + +The output of the `oplist` Operators’ evaluation function, combined with the `combo_fn`. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +**Raises** + +* **NotImplementedError** – Raised if called for a subclass which is not distributive. +* **TypeError** – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported. +* **NotImplementedError** – Attempting to call ListOp’s eval from a non-distributive subclass. + +### exp\_i + + + +`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). + +**Return type** + +`OperatorBase` + +### log\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`ListOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`ListOp` + +**Returns** + +A new ListOp representing the permuted operator. + +**Raises** +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. +### power + + + +`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 `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +### to\_legacy\_op + + + +`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. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +### to\_spmatrix + + + +`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. + +**Return type** + +`Union`\[`spmatrix`, `List`\[`spmatrix`]] + +**Returns** + +CSR sparse matrix representation of the Operator, or List thereof. + +### traverse + + + +`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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted ListOp. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### abelian @@ -80,7 +496,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -94,7 +510,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -108,7 +524,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -122,7 +538,7 @@ Indicates whether the ListOp or subclass is distributive under composition. List A bool indicating whether the ListOp is distributive under composition. - + ### grad\_combo\_fn @@ -132,7 +548,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### num\_qubits @@ -140,7 +556,7 @@ The gradient of `combo_fn`. `int` - + ### oplist @@ -154,6 +570,7 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters + 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 f2468c4908c..4a449b13b9c 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 @@ -1,8 +1,16 @@ -# SummedOp +--- +title: SummedOp +description: API reference for qiskit.aqua.operators.list_ops.SummedOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.list_ops.SummedOp +--- +# SummedOp + -`SummedOp(oplist, coeff=1.0, abelian=False)` +`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` @@ -16,51 +24,523 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.list_ops.SummedOp.add#qiskit.aqua.operators.list_ops.SummedOp.add "qiskit.aqua.operators.list_ops.SummedOp.add") | Return Operator addition of `self` and `other`, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.list_ops.SummedOp.adjoint#qiskit.aqua.operators.list_ops.SummedOp.adjoint "qiskit.aqua.operators.list_ops.SummedOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.list_ops.SummedOp.assign_parameters#qiskit.aqua.operators.list_ops.SummedOp.assign_parameters "qiskit.aqua.operators.list_ops.SummedOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.list_ops.SummedOp.bind_parameters#qiskit.aqua.operators.list_ops.SummedOp.bind_parameters "qiskit.aqua.operators.list_ops.SummedOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`collapse_summands`](qiskit.aqua.operators.list_ops.SummedOp.collapse_summands#qiskit.aqua.operators.list_ops.SummedOp.collapse_summands "qiskit.aqua.operators.list_ops.SummedOp.collapse_summands") | Return Operator by simplifying duplicate operators. | -| [`compose`](qiskit.aqua.operators.list_ops.SummedOp.compose#qiskit.aqua.operators.list_ops.SummedOp.compose "qiskit.aqua.operators.list_ops.SummedOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.list_ops.SummedOp.equals#qiskit.aqua.operators.list_ops.SummedOp.equals "qiskit.aqua.operators.list_ops.SummedOp.equals") | Check if other is equal to self. | -| [`eval`](qiskit.aqua.operators.list_ops.SummedOp.eval#qiskit.aqua.operators.list_ops.SummedOp.eval "qiskit.aqua.operators.list_ops.SummedOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.list_ops.SummedOp.exp_i#qiskit.aqua.operators.list_ops.SummedOp.exp_i "qiskit.aqua.operators.list_ops.SummedOp.exp_i") | Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). | -| [`log_i`](qiskit.aqua.operators.list_ops.SummedOp.log_i#qiskit.aqua.operators.list_ops.SummedOp.log_i "qiskit.aqua.operators.list_ops.SummedOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.list_ops.SummedOp.mul#qiskit.aqua.operators.list_ops.SummedOp.mul "qiskit.aqua.operators.list_ops.SummedOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.list_ops.SummedOp.neg#qiskit.aqua.operators.list_ops.SummedOp.neg "qiskit.aqua.operators.list_ops.SummedOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.list_ops.SummedOp.permute#qiskit.aqua.operators.list_ops.SummedOp.permute "qiskit.aqua.operators.list_ops.SummedOp.permute") | Permute the qubits of the operator. | -| [`power`](qiskit.aqua.operators.list_ops.SummedOp.power#qiskit.aqua.operators.list_ops.SummedOp.power "qiskit.aqua.operators.list_ops.SummedOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.list_ops.SummedOp.primitive_strings#qiskit.aqua.operators.list_ops.SummedOp.primitive_strings "qiskit.aqua.operators.list_ops.SummedOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`print_details`](qiskit.aqua.operators.list_ops.SummedOp.print_details#qiskit.aqua.operators.list_ops.SummedOp.print_details "qiskit.aqua.operators.list_ops.SummedOp.print_details") | Print out the operator in details. | -| [`reduce`](qiskit.aqua.operators.list_ops.SummedOp.reduce#qiskit.aqua.operators.list_ops.SummedOp.reduce "qiskit.aqua.operators.list_ops.SummedOp.reduce") | Try collapsing list or trees of sums. | -| [`tensor`](qiskit.aqua.operators.list_ops.SummedOp.tensor#qiskit.aqua.operators.list_ops.SummedOp.tensor "qiskit.aqua.operators.list_ops.SummedOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.list_ops.SummedOp.tensorpower#qiskit.aqua.operators.list_ops.SummedOp.tensorpower "qiskit.aqua.operators.list_ops.SummedOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.list_ops.SummedOp.to_circuit#qiskit.aqua.operators.list_ops.SummedOp.to_circuit "qiskit.aqua.operators.list_ops.SummedOp.to_circuit") | Returns the quantum circuit, representing the SummedOp. | -| [`to_circuit_op`](qiskit.aqua.operators.list_ops.SummedOp.to_circuit_op#qiskit.aqua.operators.list_ops.SummedOp.to_circuit_op "qiskit.aqua.operators.list_ops.SummedOp.to_circuit_op") | Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. | -| [`to_legacy_op`](qiskit.aqua.operators.list_ops.SummedOp.to_legacy_op#qiskit.aqua.operators.list_ops.SummedOp.to_legacy_op "qiskit.aqua.operators.list_ops.SummedOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.list_ops.SummedOp.to_matrix#qiskit.aqua.operators.list_ops.SummedOp.to_matrix "qiskit.aqua.operators.list_ops.SummedOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.list_ops.SummedOp.to_matrix_op#qiskit.aqua.operators.list_ops.SummedOp.to_matrix_op "qiskit.aqua.operators.list_ops.SummedOp.to_matrix_op") | Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. | -| [`to_pauli_op`](qiskit.aqua.operators.list_ops.SummedOp.to_pauli_op#qiskit.aqua.operators.list_ops.SummedOp.to_pauli_op "qiskit.aqua.operators.list_ops.SummedOp.to_pauli_op") | Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. | -| [`to_spmatrix`](qiskit.aqua.operators.list_ops.SummedOp.to_spmatrix#qiskit.aqua.operators.list_ops.SummedOp.to_spmatrix "qiskit.aqua.operators.list_ops.SummedOp.to_spmatrix") | Returns SciPy sparse matrix representation of the Operator. | -| [`traverse`](qiskit.aqua.operators.list_ops.SummedOp.traverse#qiskit.aqua.operators.list_ops.SummedOp.traverse "qiskit.aqua.operators.list_ops.SummedOp.traverse") | Apply the convert\_fn to each node in the oplist. | +### add -## Attributes + + +`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 `+`. + + + This appends `other` to `self.oplist` without checking `other` is already included or not. If you want to simplify them, please use `simplify()`. + + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +A `SummedOp` equivalent to the sum of self and other. + +### adjoint + + + +`SummedOp.adjoint()` + +Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`SummedOp.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`SummedOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### collapse\_summands + + + +`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. + +E.g., `SummedOp([2 * X ^ Y, X ^ Y]).collapse_summands() -> SummedOp([3 * X ^ Y])`. + +**Return type** + +`SummedOp` + +**Returns** + +A simplified `SummedOp` equivalent to self. + +### compose + + + +`SummedOp.compose(other, permutation=None, front=False)` + +Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + + + This is not a mathematical check for equality. If `self` and `other` implement the same operation but differ in the representation (e.g. different type of summands) `equals` will evaluate to `False`. + + +**Parameters** + +**other** (`OperatorBase`) – The other operator to check for equality. + +**Return type** + +`bool` + +**Returns** + +True, if other and self are equal, otherwise False. + +#### Examples + +```python +>>> from qiskit.aqua.operators import X, Z +>>> 2 * X == X + X +True +>>> X + Z == Z + X +True +``` + +### eval + + + +`SummedOp.eval(front=None)` + +Evaluate the Operator’s underlying function, either on a binary string or another Operator. A square binary Operator can be defined as a function taking a binary function to another binary function. This method returns the value of that function for a given StateFn or binary string. For example, `op.eval('0110').eval('1110')` can be seen as querying the Operator’s matrix representation by row 6 and column 14, and will return the complex value at those “indices.” Similarly for a StateFn, `op.eval('1011')` will return the complex value at row 11 of the vector representation of the StateFn, as all StateFns are defined to be evaluated from Zero implicitly (i.e. it is as if `.eval('0000')` is already called implicitly to always “indexing” from column 0). + +ListOp’s eval recursively evaluates each Operator in `oplist`, and combines the results using the recombination function `combo_fn`. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`, `list`] + +**Returns** + +The output of the `oplist` Operators’ evaluation function, combined with the `combo_fn`. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +**Raises** + +* **NotImplementedError** – Raised if called for a subclass which is not distributive. +* **TypeError** – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported. +* **NotImplementedError** – Attempting to call ListOp’s eval from a non-distributive subclass. + +### exp\_i + + + +`SummedOp.exp_i()` + +Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). + +**Return type** + +`OperatorBase` + +### log\_i + + + +`SummedOp.log_i(massive=False)` + +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. + +**Return type** + +`OperatorBase` + +### mul + + + +`SummedOp.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`SummedOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`SummedOp.permute(permutation)` + +Permute the qubits of the operator. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`ListOp` + +**Returns** + +A new ListOp representing the permuted operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. +### power + + +`SummedOp.power(exponent)` + +Return Operator composed with self multiple times, overloaded by `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`SummedOp.primitive_strings()` + +Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### print\_details + + + +`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 + +### reduce + + + +`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. + +Tries to sum up duplicate operators and reduces the operators in the sum. + +**Return type** + +`OperatorBase` + +**Returns** + +A collapsed version of self, if possible. + +### tensor + + + +`SummedOp.tensor(other)` + +Return tensor product between self and other, overloaded by `^`. Note: You must be conscious of Qiskit’s big-endian bit printing convention. Meaning, X.tensor(Y) produces an X on qubit 0 and an Y on qubit 1, or X⨂Y, but would produce a QuantumCircuit which looks like + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`SummedOp.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The circuit representation of the summed operator. + +**Raises** + +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if SummedOp can not be converted to MatrixOp (e.g. SummedOp is composed of +* **parametrized PrimitiveOps**\*\*)\*\*\*\*\*\* – + +### to\_circuit\_op + + + +`SummedOp.to_circuit_op()` + +Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. + +**Return type** + +`OperatorBase` + +### to\_legacy\_op + + + +`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. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`SummedOp.to_matrix(massive=False)` + +Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`SummedOp.to_pauli_op(massive=False)` + +Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. + +**Return type** + +`OperatorBase` + +### to\_spmatrix + + + +`SummedOp.to_spmatrix()` + +Returns SciPy sparse matrix representation of the Operator. + +**Return type** + +`Union`\[`spmatrix`, `List`\[`spmatrix`]] + +**Returns** + +CSR sparse matrix representation of the Operator, or List thereof. + +### traverse + + + +`SummedOp.traverse(convert_fn, coeff=None)` + +Apply the convert\_fn to each node in the oplist. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted ListOp. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### abelian @@ -74,7 +554,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -88,7 +568,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -102,7 +582,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -110,7 +590,7 @@ The combination function. `bool` - + ### grad\_combo\_fn @@ -120,7 +600,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### num\_qubits @@ -128,7 +608,7 @@ The gradient of `combo_fn`. `int` - + ### oplist @@ -142,6 +622,7 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters + 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 c946199679a..50a67ce9a69 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 @@ -1,8 +1,16 @@ -# TensoredOp +--- +title: TensoredOp +description: API reference for qiskit.aqua.operators.list_ops.TensoredOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.list_ops.TensoredOp +--- +# TensoredOp + -`TensoredOp(oplist, coeff=1.0, abelian=False)` +`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` @@ -16,49 +24,476 @@ A class for lazily representing tensor products of Operators. Often Operators ca ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.list_ops.TensoredOp.add#qiskit.aqua.operators.list_ops.TensoredOp.add "qiskit.aqua.operators.list_ops.TensoredOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.list_ops.TensoredOp.adjoint#qiskit.aqua.operators.list_ops.TensoredOp.adjoint "qiskit.aqua.operators.list_ops.TensoredOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.list_ops.TensoredOp.assign_parameters#qiskit.aqua.operators.list_ops.TensoredOp.assign_parameters "qiskit.aqua.operators.list_ops.TensoredOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.list_ops.TensoredOp.bind_parameters#qiskit.aqua.operators.list_ops.TensoredOp.bind_parameters "qiskit.aqua.operators.list_ops.TensoredOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.list_ops.TensoredOp.compose#qiskit.aqua.operators.list_ops.TensoredOp.compose "qiskit.aqua.operators.list_ops.TensoredOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.list_ops.TensoredOp.equals#qiskit.aqua.operators.list_ops.TensoredOp.equals "qiskit.aqua.operators.list_ops.TensoredOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.list_ops.TensoredOp.eval#qiskit.aqua.operators.list_ops.TensoredOp.eval "qiskit.aqua.operators.list_ops.TensoredOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.list_ops.TensoredOp.exp_i#qiskit.aqua.operators.list_ops.TensoredOp.exp_i "qiskit.aqua.operators.list_ops.TensoredOp.exp_i") | Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). | -| [`log_i`](qiskit.aqua.operators.list_ops.TensoredOp.log_i#qiskit.aqua.operators.list_ops.TensoredOp.log_i "qiskit.aqua.operators.list_ops.TensoredOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.list_ops.TensoredOp.mul#qiskit.aqua.operators.list_ops.TensoredOp.mul "qiskit.aqua.operators.list_ops.TensoredOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.list_ops.TensoredOp.neg#qiskit.aqua.operators.list_ops.TensoredOp.neg "qiskit.aqua.operators.list_ops.TensoredOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.list_ops.TensoredOp.permute#qiskit.aqua.operators.list_ops.TensoredOp.permute "qiskit.aqua.operators.list_ops.TensoredOp.permute") | Permute the qubits of the operator. | -| [`power`](qiskit.aqua.operators.list_ops.TensoredOp.power#qiskit.aqua.operators.list_ops.TensoredOp.power "qiskit.aqua.operators.list_ops.TensoredOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.list_ops.TensoredOp.primitive_strings#qiskit.aqua.operators.list_ops.TensoredOp.primitive_strings "qiskit.aqua.operators.list_ops.TensoredOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.list_ops.TensoredOp.reduce#qiskit.aqua.operators.list_ops.TensoredOp.reduce "qiskit.aqua.operators.list_ops.TensoredOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.list_ops.TensoredOp.tensor#qiskit.aqua.operators.list_ops.TensoredOp.tensor "qiskit.aqua.operators.list_ops.TensoredOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.list_ops.TensoredOp.tensorpower#qiskit.aqua.operators.list_ops.TensoredOp.tensorpower "qiskit.aqua.operators.list_ops.TensoredOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.list_ops.TensoredOp.to_circuit#qiskit.aqua.operators.list_ops.TensoredOp.to_circuit "qiskit.aqua.operators.list_ops.TensoredOp.to_circuit") | Returns the quantum circuit, representing the tensored operator. | -| [`to_circuit_op`](qiskit.aqua.operators.list_ops.TensoredOp.to_circuit_op#qiskit.aqua.operators.list_ops.TensoredOp.to_circuit_op "qiskit.aqua.operators.list_ops.TensoredOp.to_circuit_op") | Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. | -| [`to_legacy_op`](qiskit.aqua.operators.list_ops.TensoredOp.to_legacy_op#qiskit.aqua.operators.list_ops.TensoredOp.to_legacy_op "qiskit.aqua.operators.list_ops.TensoredOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.list_ops.TensoredOp.to_matrix#qiskit.aqua.operators.list_ops.TensoredOp.to_matrix "qiskit.aqua.operators.list_ops.TensoredOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.list_ops.TensoredOp.to_matrix_op#qiskit.aqua.operators.list_ops.TensoredOp.to_matrix_op "qiskit.aqua.operators.list_ops.TensoredOp.to_matrix_op") | Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. | -| [`to_pauli_op`](qiskit.aqua.operators.list_ops.TensoredOp.to_pauli_op#qiskit.aqua.operators.list_ops.TensoredOp.to_pauli_op "qiskit.aqua.operators.list_ops.TensoredOp.to_pauli_op") | Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. | -| [`to_spmatrix`](qiskit.aqua.operators.list_ops.TensoredOp.to_spmatrix#qiskit.aqua.operators.list_ops.TensoredOp.to_spmatrix "qiskit.aqua.operators.list_ops.TensoredOp.to_spmatrix") | Returns SciPy sparse matrix representation of the Operator. | -| [`traverse`](qiskit.aqua.operators.list_ops.TensoredOp.traverse#qiskit.aqua.operators.list_ops.TensoredOp.traverse "qiskit.aqua.operators.list_ops.TensoredOp.traverse") | Apply the convert\_fn to each node in the oplist. | +### add -## Attributes + + +`TensoredOp.add(other)` + +Return Operator addition of self and other, overloaded by `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`TensoredOp.adjoint()` + +Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. For StateFns, this also turns the StateFn into a measurement. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`TensoredOp.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`TensoredOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`TensoredOp.compose(other, permutation=None, front=False)` + +Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`TensoredOp.equals(other)` + +Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. +### eval + + + +`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). + +ListOp’s eval recursively evaluates each Operator in `oplist`, and combines the results using the recombination function `combo_fn`. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the `oplist` Operators’ evaluation function, combined with the `combo_fn`. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +**Raises** + +* **NotImplementedError** – Raised if called for a subclass which is not distributive. +* **TypeError** – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported. +* **NotImplementedError** – Attempting to call ListOp’s eval from a non-distributive subclass. + +### exp\_i + + + +`TensoredOp.exp_i()` + +Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). + +**Return type** + +`OperatorBase` + +### log\_i + + + +`TensoredOp.log_i(massive=False)` + +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. + +**Return type** + +`OperatorBase` + +### mul + + + +`TensoredOp.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`TensoredOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`TensoredOp.permute(permutation)` + +Permute the qubits of the operator. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`ListOp` + +**Returns** + +A new ListOp representing the permuted operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. + +### power + + + +`TensoredOp.power(exponent)` + +Return Operator composed with self multiple times, overloaded by `**`. + +**Parameters** +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`TensoredOp.primitive_strings()` + +Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`TensoredOp.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The circuit representation of the tensored operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – for operators where a single underlying circuit can not be produced. + +### to\_circuit\_op + + + +`TensoredOp.to_circuit_op()` + +Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. + +**Return type** + +`OperatorBase` + +### to\_legacy\_op + + + +`TensoredOp.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`TensoredOp.to_matrix(massive=False)` + +Return NumPy representation of the Operator. Represents the evaluation of the Operator’s underlying function on every combination of basis binary strings. Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`TensoredOp.to_matrix_op(massive=False)` + +Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`TensoredOp.to_pauli_op(massive=False)` + +Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. + +**Return type** + +`OperatorBase` + +### to\_spmatrix + + + +`TensoredOp.to_spmatrix()` + +Returns SciPy sparse matrix representation of the Operator. + +**Return type** + +`Union`\[`spmatrix`, `List`\[`spmatrix`]] + +**Returns** + +CSR sparse matrix representation of the Operator, or List thereof. + +### traverse + + + +`TensoredOp.traverse(convert_fn, coeff=None)` + +Apply the convert\_fn to each node in the oplist. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted ListOp. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### abelian @@ -72,7 +507,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -86,7 +521,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -100,7 +535,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -108,7 +543,7 @@ The combination function. `bool` - + ### grad\_combo\_fn @@ -118,7 +553,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### num\_qubits @@ -126,7 +561,7 @@ The gradient of `combo_fn`. `int` - + ### oplist @@ -140,6 +575,7 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.md index fe6c2394020..1d139e4432d 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.list_ops.md @@ -16,9 +16,9 @@ python_api_name: qiskit.aqua.operators.list_ops `qiskit.aqua.operators.list_ops` -List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.aqua.operators.list_ops.ListOp#qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp#qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp#qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.aqua.operators.list_ops.ListOp.to_matrix#qiskit.aqua.operators.list_ops.ListOp.to_matrix "qiskit.aqua.operators.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.aqua.operators.list_ops.ListOp#qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. +List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.aqua.operators.list_ops.ListOp#to_matrix "qiskit.aqua.operators.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp"). In this way, the [`list_ops`](#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements in Aqua. -The base [`ListOp`](qiskit.aqua.operators.list_ops.ListOp#qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") class is particularly interesting, as its `combo_fn` is “the identity list Operation”. Meaning, if we understand the `combo_fn` as a function from a list of complex values to some output, one such function is returning the list as-is. This is powerful for constructing compact hierarchical Operators which return many measurements in multiple dimensional lists. For example, if we want to estimate the gradient of some Observable measurement with respect to some parameters in the State function, we can construct separate evaluation Operators for each parameter’s gradient which we must keep track of ourselves in a list, or we can construct a single [`ListOp`](qiskit.aqua.operators.list_ops.ListOp#qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") containing the evaluation Operators for each parameter, so the [`eval()`](qiskit.aqua.operators.list_ops.ListOp.eval#qiskit.aqua.operators.list_ops.ListOp.eval "qiskit.aqua.operators.list_ops.ListOp.eval") function returns the full gradient vector. Another excellent example of this power is constructing a Quantum kernel matrix: +The base [`ListOp`](qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") class is particularly interesting, as its `combo_fn` is “the identity list Operation”. Meaning, if we understand the `combo_fn` as a function from a list of complex values to some output, one such function is returning the list as-is. This is powerful for constructing compact hierarchical Operators which return many measurements in multiple dimensional lists. For example, if we want to estimate the gradient of some Observable measurement with respect to some parameters in the State function, we can construct separate evaluation Operators for each parameter’s gradient which we must keep track of ourselves in a list, or we can construct a single [`ListOp`](qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") containing the evaluation Operators for each parameter, so the [`eval()`](qiskit.aqua.operators.list_ops.ListOp#eval "qiskit.aqua.operators.list_ops.ListOp.eval") function returns the full gradient vector. Another excellent example of this power is constructing a Quantum kernel matrix: ```python data_sfn_list_op = ListOp(data_circuit_state_fns) @@ -27,9 +27,9 @@ qkernel_sampled = CircuitSampler(backend).convert(qkernel_op_circuits) qkernel_sampled.eval() ``` -This will return the two dimensional Quantum kernel matrix, where each element is the inner product of some pair of the data State functions, or in other terms, a measurement of one data [`CircuitStateFn`](qiskit.aqua.operators.state_fns.CircuitStateFn#qiskit.aqua.operators.state_fns.CircuitStateFn "qiskit.aqua.operators.state_fns.CircuitStateFn") by another. +This will return the two dimensional Quantum kernel matrix, where each element is the inner product of some pair of the data State functions, or in other terms, a measurement of one data [`CircuitStateFn`](qiskit.aqua.operators.state_fns.CircuitStateFn "qiskit.aqua.operators.state_fns.CircuitStateFn") by another. -You’ll encounter the [`ListOp`](qiskit.aqua.operators.list_ops.ListOp#qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") subclasses ([`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp#qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp"), [`ComposedOp`](qiskit.aqua.operators.list_ops.ComposedOp#qiskit.aqua.operators.list_ops.ComposedOp "qiskit.aqua.operators.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.aqua.operators.list_ops.TensoredOp#qiskit.aqua.operators.list_ops.TensoredOp "qiskit.aqua.operators.list_ops.TensoredOp")) more often as lazy results of Operator construction operations than as something you need to explicitly construct. Any time we don’t know how to efficiently add, compose, or tensor two [`primitive_ops`](qiskit.aqua.operators.primitive_ops#module-qiskit.aqua.operators.primitive_ops "qiskit.aqua.operators.primitive_ops") or [`state_fns`](qiskit.aqua.operators.state_fns#module-qiskit.aqua.operators.state_fns "qiskit.aqua.operators.state_fns") together, they’re returned in a [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp#qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp"), [`ComposedOp`](qiskit.aqua.operators.list_ops.ComposedOp#qiskit.aqua.operators.list_ops.ComposedOp "qiskit.aqua.operators.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.aqua.operators.list_ops.TensoredOp#qiskit.aqua.operators.list_ops.TensoredOp "qiskit.aqua.operators.list_ops.TensoredOp"), respectively, so we can still work with their combined function and perhaps convert them into an efficiently combine-able format later. +You’ll encounter the [`ListOp`](qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") subclasses ([`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp"), [`ComposedOp`](qiskit.aqua.operators.list_ops.ComposedOp "qiskit.aqua.operators.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.aqua.operators.list_ops.TensoredOp "qiskit.aqua.operators.list_ops.TensoredOp")) more often as lazy results of Operator construction operations than as something you need to explicitly construct. Any time we don’t know how to efficiently add, compose, or tensor two [`primitive_ops`](qiskit.aqua.operators.primitive_ops#module-qiskit.aqua.operators.primitive_ops "qiskit.aqua.operators.primitive_ops") or [`state_fns`](qiskit.aqua.operators.state_fns#module-qiskit.aqua.operators.state_fns "qiskit.aqua.operators.state_fns") together, they’re returned in a [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp"), [`ComposedOp`](qiskit.aqua.operators.list_ops.ComposedOp "qiskit.aqua.operators.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.aqua.operators.list_ops.TensoredOp "qiskit.aqua.operators.list_ops.TensoredOp"), respectively, so we can still work with their combined function and perhaps convert them into an efficiently combine-able format later. Combination functions do not always behave predictably, and you must understand the conversions you’re making when you working with [`list_ops`](#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops"). Most notably - sampling a sum of two circuits on Quantum hardware does not incorporate interference between the wavefunctions! In this case, we’re sending our State functions through a depolarizing channel before adding them, rather than adding them directly before the measurement. @@ -37,10 +37,10 @@ You’ll encounter the [`ListOp`](qiskit.aqua.operators.list_ops.ListOp#qiskit.a # List Operators -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| [`ListOp`](qiskit.aqua.operators.list_ops.ListOp#qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") | A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. | -| [`ComposedOp`](qiskit.aqua.operators.list_ops.ComposedOp#qiskit.aqua.operators.list_ops.ComposedOp "qiskit.aqua.operators.list_ops.ComposedOp") | A class for lazily representing compositions of Operators. | -| [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp#qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp") | A class for lazily representing sums of Operators. | -| [`TensoredOp`](qiskit.aqua.operators.list_ops.TensoredOp#qiskit.aqua.operators.list_ops.TensoredOp "qiskit.aqua.operators.list_ops.TensoredOp") | A class for lazily representing tensor products of Operators. | +| | | +| ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | +| [`ListOp`](qiskit.aqua.operators.list_ops.ListOp "qiskit.aqua.operators.list_ops.ListOp") | A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. | +| [`ComposedOp`](qiskit.aqua.operators.list_ops.ComposedOp "qiskit.aqua.operators.list_ops.ComposedOp") | A class for lazily representing compositions of Operators. | +| [`SummedOp`](qiskit.aqua.operators.list_ops.SummedOp "qiskit.aqua.operators.list_ops.SummedOp") | A class for lazily representing sums of Operators. | +| [`TensoredOp`](qiskit.aqua.operators.list_ops.TensoredOp "qiskit.aqua.operators.list_ops.TensoredOp") | A class for lazily representing tensor products of Operators. | diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.md index 20d32be9fd0..a700c7618c6 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.md @@ -38,9 +38,9 @@ Below, you’ll find a base class for all Operators, some convenience immutable The OperatorBase serves as the base class for all Operators, State functions and measurements, and enforces the presence and consistency of methods to manipulate these objects conveniently. -| | | -| ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`OperatorBase`](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") | A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. | +| | | +| ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| [`OperatorBase`](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") | A base class for all Operators: PrimitiveOps, StateFns, ListOps, etc. | # Operator Globals @@ -73,7 +73,7 @@ The Operators submodules include the PrimitiveOp, ListOp, and StateFn class grou ## Converters -The Converter submodules include objects which manipulate Operators, usually recursing over an Operator structure and changing certain Operators’ representation. For example, the [`PauliExpectation`](qiskit.aqua.operators.expectations.PauliExpectation#qiskit.aqua.operators.expectations.PauliExpectation "qiskit.aqua.operators.expectations.PauliExpectation") traverses an Operator structure, and replaces all of the [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn#qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") measurements containing non-diagonal Pauli terms into diagonalizing circuits following by [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn#qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") measurement containing only diagonal Paulis. +The Converter submodules include objects which manipulate Operators, usually recursing over an Operator structure and changing certain Operators’ representation. For example, the [`PauliExpectation`](qiskit.aqua.operators.expectations.PauliExpectation "qiskit.aqua.operators.expectations.PauliExpectation") traverses an Operator structure, and replaces all of the [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") measurements containing non-diagonal Pauli terms into diagonalizing circuits following by [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") measurement containing only diagonal Paulis. | | | | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | 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 59fd0b38855..0845d8186f3 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 @@ -1,8 +1,16 @@ -# CircuitOp +--- +title: CircuitOp +description: API reference for qiskit.aqua.operators.primitive_ops.CircuitOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.primitive_ops.CircuitOp +--- +# CircuitOp + -`CircuitOp(primitive, coeff=1.0)` +`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` @@ -20,48 +28,433 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.primitive_ops.CircuitOp.add#qiskit.aqua.operators.primitive_ops.CircuitOp.add "qiskit.aqua.operators.primitive_ops.CircuitOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.primitive_ops.CircuitOp.adjoint#qiskit.aqua.operators.primitive_ops.CircuitOp.adjoint "qiskit.aqua.operators.primitive_ops.CircuitOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.primitive_ops.CircuitOp.assign_parameters#qiskit.aqua.operators.primitive_ops.CircuitOp.assign_parameters "qiskit.aqua.operators.primitive_ops.CircuitOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.primitive_ops.CircuitOp.bind_parameters#qiskit.aqua.operators.primitive_ops.CircuitOp.bind_parameters "qiskit.aqua.operators.primitive_ops.CircuitOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.primitive_ops.CircuitOp.compose#qiskit.aqua.operators.primitive_ops.CircuitOp.compose "qiskit.aqua.operators.primitive_ops.CircuitOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.primitive_ops.CircuitOp.equals#qiskit.aqua.operators.primitive_ops.CircuitOp.equals "qiskit.aqua.operators.primitive_ops.CircuitOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.primitive_ops.CircuitOp.eval#qiskit.aqua.operators.primitive_ops.CircuitOp.eval "qiskit.aqua.operators.primitive_ops.CircuitOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.primitive_ops.CircuitOp.exp_i#qiskit.aqua.operators.primitive_ops.CircuitOp.exp_i "qiskit.aqua.operators.primitive_ops.CircuitOp.exp_i") | Return Operator exponentiation, equaling e^(-i \* op) | -| [`log_i`](qiskit.aqua.operators.primitive_ops.CircuitOp.log_i#qiskit.aqua.operators.primitive_ops.CircuitOp.log_i "qiskit.aqua.operators.primitive_ops.CircuitOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.primitive_ops.CircuitOp.mul#qiskit.aqua.operators.primitive_ops.CircuitOp.mul "qiskit.aqua.operators.primitive_ops.CircuitOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.primitive_ops.CircuitOp.neg#qiskit.aqua.operators.primitive_ops.CircuitOp.neg "qiskit.aqua.operators.primitive_ops.CircuitOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.primitive_ops.CircuitOp.permute#qiskit.aqua.operators.primitive_ops.CircuitOp.permute "qiskit.aqua.operators.primitive_ops.CircuitOp.permute") | Permute the qubits of the circuit. | -| [`power`](qiskit.aqua.operators.primitive_ops.CircuitOp.power#qiskit.aqua.operators.primitive_ops.CircuitOp.power "qiskit.aqua.operators.primitive_ops.CircuitOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.primitive_ops.CircuitOp.primitive_strings#qiskit.aqua.operators.primitive_ops.CircuitOp.primitive_strings "qiskit.aqua.operators.primitive_ops.CircuitOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.primitive_ops.CircuitOp.reduce#qiskit.aqua.operators.primitive_ops.CircuitOp.reduce "qiskit.aqua.operators.primitive_ops.CircuitOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.primitive_ops.CircuitOp.tensor#qiskit.aqua.operators.primitive_ops.CircuitOp.tensor "qiskit.aqua.operators.primitive_ops.CircuitOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.primitive_ops.CircuitOp.tensorpower#qiskit.aqua.operators.primitive_ops.CircuitOp.tensorpower "qiskit.aqua.operators.primitive_ops.CircuitOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.primitive_ops.CircuitOp.to_circuit#qiskit.aqua.operators.primitive_ops.CircuitOp.to_circuit "qiskit.aqua.operators.primitive_ops.CircuitOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_circuit_op`](qiskit.aqua.operators.primitive_ops.CircuitOp.to_circuit_op#qiskit.aqua.operators.primitive_ops.CircuitOp.to_circuit_op "qiskit.aqua.operators.primitive_ops.CircuitOp.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_instruction`](qiskit.aqua.operators.primitive_ops.CircuitOp.to_instruction#qiskit.aqua.operators.primitive_ops.CircuitOp.to_instruction "qiskit.aqua.operators.primitive_ops.CircuitOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_legacy_op`](qiskit.aqua.operators.primitive_ops.CircuitOp.to_legacy_op#qiskit.aqua.operators.primitive_ops.CircuitOp.to_legacy_op "qiskit.aqua.operators.primitive_ops.CircuitOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.primitive_ops.CircuitOp.to_matrix#qiskit.aqua.operators.primitive_ops.CircuitOp.to_matrix "qiskit.aqua.operators.primitive_ops.CircuitOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.primitive_ops.CircuitOp.to_matrix_op#qiskit.aqua.operators.primitive_ops.CircuitOp.to_matrix_op "qiskit.aqua.operators.primitive_ops.CircuitOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | -| [`to_pauli_op`](qiskit.aqua.operators.primitive_ops.CircuitOp.to_pauli_op#qiskit.aqua.operators.primitive_ops.CircuitOp.to_pauli_op "qiskit.aqua.operators.primitive_ops.CircuitOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`CircuitOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`CircuitOp.exp_i()` + +Return Operator exponentiation, equaling e^(-i \* op) + +**Return type** + +`OperatorBase` + +### log\_i + + + +`CircuitOp.log_i(massive=False)` + +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. + +**Return type** + +`OperatorBase` + +### mul + + + +`CircuitOp.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`CircuitOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`CircuitOp` + +**Returns** + +A new CircuitOp containing the permuted circuit. + +### power + + + +`CircuitOp.power(exponent)` + +Return Operator composed with self multiple times, overloaded by `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`CircuitOp.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. +### to\_circuit + + +`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. + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_legacy\_op + + + +`CircuitOp.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`CircuitOp.to_matrix_op(massive=False)` + +Returns a `MatrixOp` equivalent to this Operator. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`CircuitOp.to_pauli_op(massive=False)` + +Returns a sum of `PauliOp` s equivalent to this Operator. + +**Return type** + +`OperatorBase` + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -75,7 +468,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### num\_qubits @@ -83,11 +476,11 @@ The coefficient. `int` - + ### parameters - + ### primitive @@ -100,3 +493,4 @@ The primitive defining the underlying function of the Operator. **Returns** The primitive object. + 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 f62cc9ea38f..c06b5d15c6f 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 @@ -1,8 +1,16 @@ -# MatrixOp +--- +title: MatrixOp +description: API reference for qiskit.aqua.operators.primitive_ops.MatrixOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.primitive_ops.MatrixOp +--- +# MatrixOp + -`MatrixOp(primitive, coeff=1.0)` +`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` @@ -20,48 +28,437 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.primitive_ops.MatrixOp.add#qiskit.aqua.operators.primitive_ops.MatrixOp.add "qiskit.aqua.operators.primitive_ops.MatrixOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.primitive_ops.MatrixOp.adjoint#qiskit.aqua.operators.primitive_ops.MatrixOp.adjoint "qiskit.aqua.operators.primitive_ops.MatrixOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.primitive_ops.MatrixOp.assign_parameters#qiskit.aqua.operators.primitive_ops.MatrixOp.assign_parameters "qiskit.aqua.operators.primitive_ops.MatrixOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.primitive_ops.MatrixOp.bind_parameters#qiskit.aqua.operators.primitive_ops.MatrixOp.bind_parameters "qiskit.aqua.operators.primitive_ops.MatrixOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.primitive_ops.MatrixOp.compose#qiskit.aqua.operators.primitive_ops.MatrixOp.compose "qiskit.aqua.operators.primitive_ops.MatrixOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.primitive_ops.MatrixOp.equals#qiskit.aqua.operators.primitive_ops.MatrixOp.equals "qiskit.aqua.operators.primitive_ops.MatrixOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.primitive_ops.MatrixOp.eval#qiskit.aqua.operators.primitive_ops.MatrixOp.eval "qiskit.aqua.operators.primitive_ops.MatrixOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.primitive_ops.MatrixOp.exp_i#qiskit.aqua.operators.primitive_ops.MatrixOp.exp_i "qiskit.aqua.operators.primitive_ops.MatrixOp.exp_i") | Return a `CircuitOp` equivalent to e^-iH for this operator H | -| [`log_i`](qiskit.aqua.operators.primitive_ops.MatrixOp.log_i#qiskit.aqua.operators.primitive_ops.MatrixOp.log_i "qiskit.aqua.operators.primitive_ops.MatrixOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.primitive_ops.MatrixOp.mul#qiskit.aqua.operators.primitive_ops.MatrixOp.mul "qiskit.aqua.operators.primitive_ops.MatrixOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.primitive_ops.MatrixOp.neg#qiskit.aqua.operators.primitive_ops.MatrixOp.neg "qiskit.aqua.operators.primitive_ops.MatrixOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.primitive_ops.MatrixOp.permute#qiskit.aqua.operators.primitive_ops.MatrixOp.permute "qiskit.aqua.operators.primitive_ops.MatrixOp.permute") | Creates a new MatrixOp that acts on the permuted qubits. | -| [`power`](qiskit.aqua.operators.primitive_ops.MatrixOp.power#qiskit.aqua.operators.primitive_ops.MatrixOp.power "qiskit.aqua.operators.primitive_ops.MatrixOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.primitive_ops.MatrixOp.primitive_strings#qiskit.aqua.operators.primitive_ops.MatrixOp.primitive_strings "qiskit.aqua.operators.primitive_ops.MatrixOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.primitive_ops.MatrixOp.reduce#qiskit.aqua.operators.primitive_ops.MatrixOp.reduce "qiskit.aqua.operators.primitive_ops.MatrixOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.primitive_ops.MatrixOp.tensor#qiskit.aqua.operators.primitive_ops.MatrixOp.tensor "qiskit.aqua.operators.primitive_ops.MatrixOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.primitive_ops.MatrixOp.tensorpower#qiskit.aqua.operators.primitive_ops.MatrixOp.tensorpower "qiskit.aqua.operators.primitive_ops.MatrixOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.primitive_ops.MatrixOp.to_circuit#qiskit.aqua.operators.primitive_ops.MatrixOp.to_circuit "qiskit.aqua.operators.primitive_ops.MatrixOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_circuit_op`](qiskit.aqua.operators.primitive_ops.MatrixOp.to_circuit_op#qiskit.aqua.operators.primitive_ops.MatrixOp.to_circuit_op "qiskit.aqua.operators.primitive_ops.MatrixOp.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_instruction`](qiskit.aqua.operators.primitive_ops.MatrixOp.to_instruction#qiskit.aqua.operators.primitive_ops.MatrixOp.to_instruction "qiskit.aqua.operators.primitive_ops.MatrixOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_legacy_op`](qiskit.aqua.operators.primitive_ops.MatrixOp.to_legacy_op#qiskit.aqua.operators.primitive_ops.MatrixOp.to_legacy_op "qiskit.aqua.operators.primitive_ops.MatrixOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.primitive_ops.MatrixOp.to_matrix#qiskit.aqua.operators.primitive_ops.MatrixOp.to_matrix "qiskit.aqua.operators.primitive_ops.MatrixOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.primitive_ops.MatrixOp.to_matrix_op#qiskit.aqua.operators.primitive_ops.MatrixOp.to_matrix_op "qiskit.aqua.operators.primitive_ops.MatrixOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | -| [`to_pauli_op`](qiskit.aqua.operators.primitive_ops.MatrixOp.to_pauli_op#qiskit.aqua.operators.primitive_ops.MatrixOp.to_pauli_op "qiskit.aqua.operators.primitive_ops.MatrixOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`MatrixOp.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`MatrixOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`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 + +**Return type** + +`OperatorBase` + +### log\_i + + + +`MatrixOp.log_i(massive=False)` + +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. + +**Return type** + +`OperatorBase` + +### mul + + +`MatrixOp.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`MatrixOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`Optional`\[`List`\[`int`]]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`MatrixOp` + +**Returns** + +A new MatrixOp representing the permuted operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. + +### power + + + +`MatrixOp.power(exponent)` + +Return Operator composed with self multiple times, overloaded by `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`MatrixOp.reduce()` + +Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`MatrixOp.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`MatrixOp.to_circuit()` + +Returns a `QuantumCircuit` equivalent to this Operator. + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`MatrixOp.to_circuit_op()` + +Returns a `CircuitOp` equivalent to this Operator. + +**Return type** + +`OperatorBase` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_legacy\_op + + + +`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. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`MatrixOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`MatrixOp.to_pauli_op(massive=False)` + +Returns a sum of `PauliOp` s equivalent to this Operator. + +**Return type** + +`OperatorBase` + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -75,7 +472,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### num\_qubits @@ -83,11 +480,11 @@ The coefficient. `int` - + ### parameters - + ### primitive @@ -100,3 +497,4 @@ The primitive defining the underlying function of the Operator. **Returns** The primitive object. + 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 1f4a638912d..0e779e37344 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 @@ -1,8 +1,16 @@ -# PauliOp +--- +title: PauliOp +description: API reference for qiskit.aqua.operators.primitive_ops.PauliOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.primitive_ops.PauliOp +--- +# PauliOp + -`PauliOp(primitive, coeff=1.0)` +`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` @@ -19,50 +27,477 @@ Class for Operators backed by Terra’s `Pauli` module. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.primitive_ops.PauliOp.add#qiskit.aqua.operators.primitive_ops.PauliOp.add "qiskit.aqua.operators.primitive_ops.PauliOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.primitive_ops.PauliOp.adjoint#qiskit.aqua.operators.primitive_ops.PauliOp.adjoint "qiskit.aqua.operators.primitive_ops.PauliOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.primitive_ops.PauliOp.assign_parameters#qiskit.aqua.operators.primitive_ops.PauliOp.assign_parameters "qiskit.aqua.operators.primitive_ops.PauliOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.primitive_ops.PauliOp.bind_parameters#qiskit.aqua.operators.primitive_ops.PauliOp.bind_parameters "qiskit.aqua.operators.primitive_ops.PauliOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`commutes`](qiskit.aqua.operators.primitive_ops.PauliOp.commutes#qiskit.aqua.operators.primitive_ops.PauliOp.commutes "qiskit.aqua.operators.primitive_ops.PauliOp.commutes") | Returns whether self commutes with other\_op. | -| [`compose`](qiskit.aqua.operators.primitive_ops.PauliOp.compose#qiskit.aqua.operators.primitive_ops.PauliOp.compose "qiskit.aqua.operators.primitive_ops.PauliOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.primitive_ops.PauliOp.equals#qiskit.aqua.operators.primitive_ops.PauliOp.equals "qiskit.aqua.operators.primitive_ops.PauliOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.primitive_ops.PauliOp.eval#qiskit.aqua.operators.primitive_ops.PauliOp.eval "qiskit.aqua.operators.primitive_ops.PauliOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.primitive_ops.PauliOp.exp_i#qiskit.aqua.operators.primitive_ops.PauliOp.exp_i "qiskit.aqua.operators.primitive_ops.PauliOp.exp_i") | Return a `CircuitOp` equivalent to e^-iH for this operator H. | -| [`log_i`](qiskit.aqua.operators.primitive_ops.PauliOp.log_i#qiskit.aqua.operators.primitive_ops.PauliOp.log_i "qiskit.aqua.operators.primitive_ops.PauliOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.primitive_ops.PauliOp.mul#qiskit.aqua.operators.primitive_ops.PauliOp.mul "qiskit.aqua.operators.primitive_ops.PauliOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.primitive_ops.PauliOp.neg#qiskit.aqua.operators.primitive_ops.PauliOp.neg "qiskit.aqua.operators.primitive_ops.PauliOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.primitive_ops.PauliOp.permute#qiskit.aqua.operators.primitive_ops.PauliOp.permute "qiskit.aqua.operators.primitive_ops.PauliOp.permute") | Permutes the sequence of Pauli matrices. | -| [`power`](qiskit.aqua.operators.primitive_ops.PauliOp.power#qiskit.aqua.operators.primitive_ops.PauliOp.power "qiskit.aqua.operators.primitive_ops.PauliOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.primitive_ops.PauliOp.primitive_strings#qiskit.aqua.operators.primitive_ops.PauliOp.primitive_strings "qiskit.aqua.operators.primitive_ops.PauliOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.primitive_ops.PauliOp.reduce#qiskit.aqua.operators.primitive_ops.PauliOp.reduce "qiskit.aqua.operators.primitive_ops.PauliOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.primitive_ops.PauliOp.tensor#qiskit.aqua.operators.primitive_ops.PauliOp.tensor "qiskit.aqua.operators.primitive_ops.PauliOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.primitive_ops.PauliOp.tensorpower#qiskit.aqua.operators.primitive_ops.PauliOp.tensorpower "qiskit.aqua.operators.primitive_ops.PauliOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.primitive_ops.PauliOp.to_circuit#qiskit.aqua.operators.primitive_ops.PauliOp.to_circuit "qiskit.aqua.operators.primitive_ops.PauliOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_circuit_op`](qiskit.aqua.operators.primitive_ops.PauliOp.to_circuit_op#qiskit.aqua.operators.primitive_ops.PauliOp.to_circuit_op "qiskit.aqua.operators.primitive_ops.PauliOp.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_instruction`](qiskit.aqua.operators.primitive_ops.PauliOp.to_instruction#qiskit.aqua.operators.primitive_ops.PauliOp.to_instruction "qiskit.aqua.operators.primitive_ops.PauliOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_legacy_op`](qiskit.aqua.operators.primitive_ops.PauliOp.to_legacy_op#qiskit.aqua.operators.primitive_ops.PauliOp.to_legacy_op "qiskit.aqua.operators.primitive_ops.PauliOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.primitive_ops.PauliOp.to_matrix#qiskit.aqua.operators.primitive_ops.PauliOp.to_matrix "qiskit.aqua.operators.primitive_ops.PauliOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.primitive_ops.PauliOp.to_matrix_op#qiskit.aqua.operators.primitive_ops.PauliOp.to_matrix_op "qiskit.aqua.operators.primitive_ops.PauliOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | -| [`to_pauli_op`](qiskit.aqua.operators.primitive_ops.PauliOp.to_pauli_op#qiskit.aqua.operators.primitive_ops.PauliOp.to_pauli_op "qiskit.aqua.operators.primitive_ops.PauliOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | -| [`to_spmatrix`](qiskit.aqua.operators.primitive_ops.PauliOp.to_spmatrix#qiskit.aqua.operators.primitive_ops.PauliOp.to_spmatrix "qiskit.aqua.operators.primitive_ops.PauliOp.to_spmatrix") | Returns SciPy sparse matrix representation of the Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`PauliOp.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`PauliOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### commutes + + + +`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. + +**Parameters** + +**other\_op** (`OperatorBase`) – An `OperatorBase` with which to evaluate whether self commutes. + +**Return type** + +`bool` + +**Returns** + +A bool equaling whether self commutes with other\_op + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### log\_i + + + +`PauliOp.log_i(massive=False)` + +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. + +**Return type** + +`OperatorBase` + +### mul + + + +`PauliOp.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`PauliOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each Pauli should be permuted. The Pauli at index j of the primitive should be permuted to position permutation\[j]. + +**Return type** + +`PauliOp` + +**Returns** + +A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and indices=\[1,2,4], it returns (X ^ I ^ Y ^ Z ^ I). + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. + +### power + + + +`PauliOp.power(exponent)` + +Return Operator composed with self multiple times, overloaded by `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`PauliOp.reduce()` + +Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`PauliOp.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`PauliOp.to_circuit_op()` + +Returns a `CircuitOp` equivalent to this Operator. + +**Return type** + +`OperatorBase` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_legacy\_op + + + +`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. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`WeightedPauliOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`PauliOp.to_matrix_op(massive=False)` + +Returns a `MatrixOp` equivalent to this Operator. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_spmatrix + + + +`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. + +**Return type** + +`spmatrix` + +**Returns** + +CSR sparse matrix representation of the Operator. + +**Raises** + +**ValueError** – invalid parameters. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -76,7 +511,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### num\_qubits @@ -84,11 +519,11 @@ The coefficient. `int` - + ### parameters - + ### primitive @@ -101,3 +536,4 @@ The primitive defining the underlying function of the Operator. **Returns** The primitive object. + 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 f74f00b63b8..06bb537c7b0 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 @@ -1,8 +1,16 @@ -# PrimitiveOp +--- +title: PrimitiveOp +description: API reference for qiskit.aqua.operators.primitive_ops.PrimitiveOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.primitive_ops.PrimitiveOp +--- +# PrimitiveOp + -`PrimitiveOp(primitive=None, coeff=1.0)` +`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` @@ -17,48 +25,437 @@ Note that all mathematical methods are not in-place, meaning that they return a ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.add#qiskit.aqua.operators.primitive_ops.PrimitiveOp.add "qiskit.aqua.operators.primitive_ops.PrimitiveOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.adjoint#qiskit.aqua.operators.primitive_ops.PrimitiveOp.adjoint "qiskit.aqua.operators.primitive_ops.PrimitiveOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.assign_parameters#qiskit.aqua.operators.primitive_ops.PrimitiveOp.assign_parameters "qiskit.aqua.operators.primitive_ops.PrimitiveOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.bind_parameters#qiskit.aqua.operators.primitive_ops.PrimitiveOp.bind_parameters "qiskit.aqua.operators.primitive_ops.PrimitiveOp.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.compose#qiskit.aqua.operators.primitive_ops.PrimitiveOp.compose "qiskit.aqua.operators.primitive_ops.PrimitiveOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.equals#qiskit.aqua.operators.primitive_ops.PrimitiveOp.equals "qiskit.aqua.operators.primitive_ops.PrimitiveOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.eval#qiskit.aqua.operators.primitive_ops.PrimitiveOp.eval "qiskit.aqua.operators.primitive_ops.PrimitiveOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.exp_i#qiskit.aqua.operators.primitive_ops.PrimitiveOp.exp_i "qiskit.aqua.operators.primitive_ops.PrimitiveOp.exp_i") | Return Operator exponentiation, equaling e^(-i \* op) | -| [`log_i`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.log_i#qiskit.aqua.operators.primitive_ops.PrimitiveOp.log_i "qiskit.aqua.operators.primitive_ops.PrimitiveOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.mul#qiskit.aqua.operators.primitive_ops.PrimitiveOp.mul "qiskit.aqua.operators.primitive_ops.PrimitiveOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.neg#qiskit.aqua.operators.primitive_ops.PrimitiveOp.neg "qiskit.aqua.operators.primitive_ops.PrimitiveOp.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.permute#qiskit.aqua.operators.primitive_ops.PrimitiveOp.permute "qiskit.aqua.operators.primitive_ops.PrimitiveOp.permute") | Permutes the qubits of the operator. | -| [`power`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.power#qiskit.aqua.operators.primitive_ops.PrimitiveOp.power "qiskit.aqua.operators.primitive_ops.PrimitiveOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.primitive_strings#qiskit.aqua.operators.primitive_ops.PrimitiveOp.primitive_strings "qiskit.aqua.operators.primitive_ops.PrimitiveOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.reduce#qiskit.aqua.operators.primitive_ops.PrimitiveOp.reduce "qiskit.aqua.operators.primitive_ops.PrimitiveOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.tensor#qiskit.aqua.operators.primitive_ops.PrimitiveOp.tensor "qiskit.aqua.operators.primitive_ops.PrimitiveOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.tensorpower#qiskit.aqua.operators.primitive_ops.PrimitiveOp.tensorpower "qiskit.aqua.operators.primitive_ops.PrimitiveOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_circuit#qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_circuit "qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_circuit_op`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_circuit_op#qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_circuit_op "qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_instruction`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_instruction#qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_instruction "qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_legacy_op`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_legacy_op#qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_legacy_op "qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_matrix#qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_matrix "qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_matrix_op#qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_matrix_op "qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | -| [`to_pauli_op`](qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_pauli_op#qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_pauli_op "qiskit.aqua.operators.primitive_ops.PrimitiveOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`PrimitiveOp.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`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) + +**Return type** + +`OperatorBase` + +### log\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`PrimitiveOp.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new OperatorBase containing the permuted operator. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if indices do not define a new index for each qubit. + +### power + + + +`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 `**`. + +**Parameters** + +**exponent** (`int`) – The int number of times to compose self with itself. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to self composed with itself exponent times. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_legacy\_op + + + +`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. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`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. + +**Return type** + +`OperatorBase` + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -72,7 +469,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### num\_qubits @@ -80,11 +477,11 @@ The coefficient. `int` - + ### parameters - + ### primitive @@ -97,3 +494,4 @@ The primitive defining the underlying function of the Operator. **Returns** The primitive object. + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.md index afe9c877d7a..3f6bf05e201 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.primitive_ops.md @@ -26,10 +26,10 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa # Primitive Operators -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | -| [`PrimitiveOp`](qiskit.aqua.operators.primitive_ops.PrimitiveOp#qiskit.aqua.operators.primitive_ops.PrimitiveOp "qiskit.aqua.operators.primitive_ops.PrimitiveOp") | A class for representing basic Operators, backed by Operator primitives from Terra. | -| [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp#qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") | Class for Operators backed by Terra’s `QuantumCircuit` module. | -| [`MatrixOp`](qiskit.aqua.operators.primitive_ops.MatrixOp#qiskit.aqua.operators.primitive_ops.MatrixOp "qiskit.aqua.operators.primitive_ops.MatrixOp") | Class for Operators represented by matrices, backed by Terra’s `Operator` module. | -| [`PauliOp`](qiskit.aqua.operators.primitive_ops.PauliOp#qiskit.aqua.operators.primitive_ops.PauliOp "qiskit.aqua.operators.primitive_ops.PauliOp") | Class for Operators backed by Terra’s `Pauli` module. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | +| [`PrimitiveOp`](qiskit.aqua.operators.primitive_ops.PrimitiveOp "qiskit.aqua.operators.primitive_ops.PrimitiveOp") | A class for representing basic Operators, backed by Operator primitives from Terra. | +| [`CircuitOp`](qiskit.aqua.operators.primitive_ops.CircuitOp "qiskit.aqua.operators.primitive_ops.CircuitOp") | Class for Operators backed by Terra’s `QuantumCircuit` module. | +| [`MatrixOp`](qiskit.aqua.operators.primitive_ops.MatrixOp "qiskit.aqua.operators.primitive_ops.MatrixOp") | Class for Operators represented by matrices, backed by Terra’s `Operator` module. | +| [`PauliOp`](qiskit.aqua.operators.primitive_ops.PauliOp "qiskit.aqua.operators.primitive_ops.PauliOp") | Class for Operators backed by Terra’s `Pauli` module. | 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 48f103a0234..8fb7e91a1a3 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 @@ -1,8 +1,16 @@ -# CVaRMeasurement +--- +title: CVaRMeasurement +description: API reference for qiskit.aqua.operators.state_fns.CVaRMeasurement +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.state_fns.CVaRMeasurement +--- +# CVaRMeasurement + -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` +`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` @@ -22,53 +30,509 @@ Used in `CVaRExpectation`, see there for more details. * **ValueError** – TODO remove that this raises an error * **ValueError** – If alpha is not in \[0, 1]. -* [**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If the primitive is not diagonal. +* [**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If the primitive is not diagonal. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.state_fns.CVaRMeasurement.add#qiskit.aqua.operators.state_fns.CVaRMeasurement.add "qiskit.aqua.operators.state_fns.CVaRMeasurement.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.state_fns.CVaRMeasurement.adjoint#qiskit.aqua.operators.state_fns.CVaRMeasurement.adjoint "qiskit.aqua.operators.state_fns.CVaRMeasurement.adjoint") | The adjoint of a CVaRMeasurement is not defined. | -| [`assign_parameters`](qiskit.aqua.operators.state_fns.CVaRMeasurement.assign_parameters#qiskit.aqua.operators.state_fns.CVaRMeasurement.assign_parameters "qiskit.aqua.operators.state_fns.CVaRMeasurement.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.state_fns.CVaRMeasurement.bind_parameters#qiskit.aqua.operators.state_fns.CVaRMeasurement.bind_parameters "qiskit.aqua.operators.state_fns.CVaRMeasurement.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.state_fns.CVaRMeasurement.compose#qiskit.aqua.operators.state_fns.CVaRMeasurement.compose "qiskit.aqua.operators.state_fns.CVaRMeasurement.compose") | 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. | -| [`compute_cvar`](qiskit.aqua.operators.state_fns.CVaRMeasurement.compute_cvar#qiskit.aqua.operators.state_fns.CVaRMeasurement.compute_cvar "qiskit.aqua.operators.state_fns.CVaRMeasurement.compute_cvar") | 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. | -| [`equals`](qiskit.aqua.operators.state_fns.CVaRMeasurement.equals#qiskit.aqua.operators.state_fns.CVaRMeasurement.equals "qiskit.aqua.operators.state_fns.CVaRMeasurement.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.state_fns.CVaRMeasurement.eval#qiskit.aqua.operators.state_fns.CVaRMeasurement.eval "qiskit.aqua.operators.state_fns.CVaRMeasurement.eval") | 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.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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +Does not return anything, raises an error. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – The adjoint of a CVaRMeasurement is not defined. + +### assign\_parameters + + + +`CVaRMeasurement.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`CVaRMeasurement.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`CVaRMeasurement.compose(other, permutation=None, front=False)` + +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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### compute\_cvar + + + +`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. + +Consider the outcome with index j, such that only some of the samples with measurement outcome j will be used in computing CVaR. The CVaR calculation can then be separated into two parts. First we sum each of the energies for outcomes i \< j, weighted by the probability of observing that outcome (i.e the normalized counts). Second, we add the energy for outcome j, weighted by the difference (α - sum\_i\ + +`CVaRMeasurement.equals(other)` + +Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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") + +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] + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – A StateFn or primitive which specifies the results of evaluating a quantum state. + +**Return type** +`Union`\[`float`, `complex`] +**Returns** + +**The Var\[CVaR] of the diagonal observable specified by self.primitive** + +and the sampled quantum state described by the inputs (energies, probabilities). For index j (described above), the CVaR is computed as H\_j^2 + 1/α\*(sum\_i\ + +`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). + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – A StateFn or a primitive which defines a StateFn. This input holds the results of a sampled/simulated circuit. + +**Return type** + +`Tuple`\[`list`, `list`] + +**Returns** + +**Two lists of equal length. energies contains the energy of each** + +unique measurement outcome computed against the diagonal observable stored in self.primitive. probabilities contains the corresponding sampling probability for each measurement outcome in energies. + +**Raises** + +**ValueError** – front isn’t a DictStateFn or VectorStateFn + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`CVaRMeasurement.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`CVaRMeasurement.permute(permutation)` + +Permute the qubits of the state function. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`OperatorStateFn` + +**Returns** + +A new StateFn containing the permuted primitive. + +### power + + + +`CVaRMeasurement.power(exponent)` + +Compose with Self Multiple Times, undefined for StateFns. + +**Parameters** + +**exponent** (`int`) – The number of times to compose self with self. + +**Raises** + +**ValueError** – This function is not defined for StateFns. + +**Return type** + +`OperatorBase` + +### primitive\_strings + + + +`CVaRMeasurement.primitive_strings()` + +Return a set of strings describing the primitives contained in the Operator. For example, `{'QuantumCircuit', 'Pauli'}`. For hierarchical Operators, such as `ListOps`, this can help illuminate the primitives represented in the various recursive levels, and therefore which conversions can be applied. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`CVaRMeasurement.reduce()` + +Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`dict` + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`CVaRMeasurement.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Return type** + +`ndarray` + +### to\_legacy\_op + + + +`CVaRMeasurement.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### traverse + + + +`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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### alpha @@ -84,7 +548,7 @@ fraction of observed samples to include when computing the objective value. alph The parameter alpha which was given at initialization - + ### coeff @@ -94,7 +558,7 @@ A coefficient by which the state function is multiplied. `Union`\[`int`, `float`, `complex`, `ParameterExpression`] - + ### is\_measurement @@ -104,7 +568,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -112,12 +576,13 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive The primitive which defines the behavior of the underlying State function. + 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 29eb1708a99..a6291c4b3ea 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 @@ -1,8 +1,16 @@ -# CircuitStateFn +--- +title: CircuitStateFn +description: API reference for qiskit.aqua.operators.state_fns.CircuitStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.state_fns.CircuitStateFn +--- +# CircuitStateFn + -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False)` +`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` @@ -20,50 +28,484 @@ A class for state functions and measurements which are defined by the action of ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.state_fns.CircuitStateFn.add#qiskit.aqua.operators.state_fns.CircuitStateFn.add "qiskit.aqua.operators.state_fns.CircuitStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.state_fns.CircuitStateFn.adjoint#qiskit.aqua.operators.state_fns.CircuitStateFn.adjoint "qiskit.aqua.operators.state_fns.CircuitStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.state_fns.CircuitStateFn.assign_parameters#qiskit.aqua.operators.state_fns.CircuitStateFn.assign_parameters "qiskit.aqua.operators.state_fns.CircuitStateFn.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.state_fns.CircuitStateFn.bind_parameters#qiskit.aqua.operators.state_fns.CircuitStateFn.bind_parameters "qiskit.aqua.operators.state_fns.CircuitStateFn.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.state_fns.CircuitStateFn.compose#qiskit.aqua.operators.state_fns.CircuitStateFn.compose "qiskit.aqua.operators.state_fns.CircuitStateFn.compose") | 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. | -| [`equals`](qiskit.aqua.operators.state_fns.CircuitStateFn.equals#qiskit.aqua.operators.state_fns.CircuitStateFn.equals "qiskit.aqua.operators.state_fns.CircuitStateFn.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.state_fns.CircuitStateFn.eval#qiskit.aqua.operators.state_fns.CircuitStateFn.eval "qiskit.aqua.operators.state_fns.CircuitStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`from_dict`](qiskit.aqua.operators.state_fns.CircuitStateFn.from_dict#qiskit.aqua.operators.state_fns.CircuitStateFn.from_dict "qiskit.aqua.operators.state_fns.CircuitStateFn.from_dict") | Construct the CircuitStateFn from a dict mapping strings to probability densities. | -| [`from_vector`](qiskit.aqua.operators.state_fns.CircuitStateFn.from_vector#qiskit.aqua.operators.state_fns.CircuitStateFn.from_vector "qiskit.aqua.operators.state_fns.CircuitStateFn.from_vector") | Construct the CircuitStateFn from a vector representing the statevector. | -| [`mul`](qiskit.aqua.operators.state_fns.CircuitStateFn.mul#qiskit.aqua.operators.state_fns.CircuitStateFn.mul "qiskit.aqua.operators.state_fns.CircuitStateFn.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.state_fns.CircuitStateFn.neg#qiskit.aqua.operators.state_fns.CircuitStateFn.neg "qiskit.aqua.operators.state_fns.CircuitStateFn.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.state_fns.CircuitStateFn.permute#qiskit.aqua.operators.state_fns.CircuitStateFn.permute "qiskit.aqua.operators.state_fns.CircuitStateFn.permute") | Permute the qubits of the circuit. | -| [`power`](qiskit.aqua.operators.state_fns.CircuitStateFn.power#qiskit.aqua.operators.state_fns.CircuitStateFn.power "qiskit.aqua.operators.state_fns.CircuitStateFn.power") | Compose with Self Multiple Times, undefined for StateFns. | -| [`primitive_strings`](qiskit.aqua.operators.state_fns.CircuitStateFn.primitive_strings#qiskit.aqua.operators.state_fns.CircuitStateFn.primitive_strings "qiskit.aqua.operators.state_fns.CircuitStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.state_fns.CircuitStateFn.reduce#qiskit.aqua.operators.state_fns.CircuitStateFn.reduce "qiskit.aqua.operators.state_fns.CircuitStateFn.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`sample`](qiskit.aqua.operators.state_fns.CircuitStateFn.sample#qiskit.aqua.operators.state_fns.CircuitStateFn.sample "qiskit.aqua.operators.state_fns.CircuitStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.aqua.operators.state_fns.CircuitStateFn.tensor#qiskit.aqua.operators.state_fns.CircuitStateFn.tensor "qiskit.aqua.operators.state_fns.CircuitStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.state_fns.CircuitStateFn.tensorpower#qiskit.aqua.operators.state_fns.CircuitStateFn.tensorpower "qiskit.aqua.operators.state_fns.CircuitStateFn.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.aqua.operators.state_fns.CircuitStateFn.to_circuit#qiskit.aqua.operators.state_fns.CircuitStateFn.to_circuit "qiskit.aqua.operators.state_fns.CircuitStateFn.to_circuit") | Return QuantumCircuit representing StateFn | -| [`to_circuit_op`](qiskit.aqua.operators.state_fns.CircuitStateFn.to_circuit_op#qiskit.aqua.operators.state_fns.CircuitStateFn.to_circuit_op "qiskit.aqua.operators.state_fns.CircuitStateFn.to_circuit_op") | Return `StateFnCircuit` corresponding to this StateFn. | -| [`to_density_matrix`](qiskit.aqua.operators.state_fns.CircuitStateFn.to_density_matrix#qiskit.aqua.operators.state_fns.CircuitStateFn.to_density_matrix "qiskit.aqua.operators.state_fns.CircuitStateFn.to_density_matrix") | 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. | -| [`to_instruction`](qiskit.aqua.operators.state_fns.CircuitStateFn.to_instruction#qiskit.aqua.operators.state_fns.CircuitStateFn.to_instruction "qiskit.aqua.operators.state_fns.CircuitStateFn.to_instruction") | Return Instruction corresponding to primitive. | -| [`to_legacy_op`](qiskit.aqua.operators.state_fns.CircuitStateFn.to_legacy_op#qiskit.aqua.operators.state_fns.CircuitStateFn.to_legacy_op "qiskit.aqua.operators.state_fns.CircuitStateFn.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.state_fns.CircuitStateFn.to_matrix#qiskit.aqua.operators.state_fns.CircuitStateFn.to_matrix "qiskit.aqua.operators.state_fns.CircuitStateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.state_fns.CircuitStateFn.to_matrix_op#qiskit.aqua.operators.state_fns.CircuitStateFn.to_matrix_op "qiskit.aqua.operators.state_fns.CircuitStateFn.to_matrix_op") | Return a `VectorStateFn` for this `StateFn`. | -| [`traverse`](qiskit.aqua.operators.state_fns.CircuitStateFn.traverse#qiskit.aqua.operators.state_fns.CircuitStateFn.traverse "qiskit.aqua.operators.state_fns.CircuitStateFn.traverse") | Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`CircuitStateFn.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### equals + + + +`CircuitStateFn.equals(other)` + +Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### from\_dict + + + +`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. + +**Parameters** + +**density\_dict** (`dict`) – The dict representing the desired state. + +**Return type** + +`CircuitStateFn` + +**Returns** + +The CircuitStateFn created from the dict. + +### from\_vector + + + +`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. + +**Parameters** + +**statevector** (`ndarray`) – The statevector representing the desired state. + +**Return type** + +`CircuitStateFn` + +**Returns** + +The CircuitStateFn created from the vector. + +### mul + + + +`CircuitStateFn.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`CircuitStateFn.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`CircuitStateFn` + +**Returns** + +A new CircuitStateFn containing the permuted circuit. + +### power + + +`CircuitStateFn.power(exponent)` +Compose with Self Multiple Times, undefined for StateFns. + +**Parameters** + +**exponent** (`int`) – The number of times to compose self with self. + +**Raises** + +**ValueError** – This function is not defined for StateFns. + +**Return type** + +`OperatorBase` + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Return type** + +`dict` + +### tensor + + + +`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: + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`CircuitStateFn.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`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 + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Return type** + +`ndarray` + +### to\_instruction + + + +`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. + +### to\_legacy\_op + + + +`CircuitStateFn.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`CircuitStateFn.to_matrix_op(massive=False)` + +Return a `VectorStateFn` for this `StateFn`. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`OperatorBase` + +**Returns** + +A VectorStateFn equivalent to self. + +### traverse + + + +`CircuitStateFn.traverse(convert_fn, coeff=None)` + +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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -73,7 +515,7 @@ A coefficient by which the state function is multiplied. `Union`\[`int`, `float`, `complex`, `ParameterExpression`] - + ### is\_measurement @@ -83,7 +525,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -91,12 +533,13 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive The primitive which defines the behavior of the underlying State function. + 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 247bb951a31..c7f657ffc46 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 @@ -1,8 +1,16 @@ -# DictStateFn +--- +title: DictStateFn +description: API reference for qiskit.aqua.operators.state_fns.DictStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.state_fns.DictStateFn +--- +# DictStateFn + -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False)` +`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` @@ -20,47 +28,466 @@ A class for state functions and measurements which are defined by a lookup table ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.state_fns.DictStateFn.add#qiskit.aqua.operators.state_fns.DictStateFn.add "qiskit.aqua.operators.state_fns.DictStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.state_fns.DictStateFn.adjoint#qiskit.aqua.operators.state_fns.DictStateFn.adjoint "qiskit.aqua.operators.state_fns.DictStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.state_fns.DictStateFn.assign_parameters#qiskit.aqua.operators.state_fns.DictStateFn.assign_parameters "qiskit.aqua.operators.state_fns.DictStateFn.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.state_fns.DictStateFn.bind_parameters#qiskit.aqua.operators.state_fns.DictStateFn.bind_parameters "qiskit.aqua.operators.state_fns.DictStateFn.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.state_fns.DictStateFn.compose#qiskit.aqua.operators.state_fns.DictStateFn.compose "qiskit.aqua.operators.state_fns.DictStateFn.compose") | 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. | -| [`equals`](qiskit.aqua.operators.state_fns.DictStateFn.equals#qiskit.aqua.operators.state_fns.DictStateFn.equals "qiskit.aqua.operators.state_fns.DictStateFn.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.state_fns.DictStateFn.eval#qiskit.aqua.operators.state_fns.DictStateFn.eval "qiskit.aqua.operators.state_fns.DictStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`mul`](qiskit.aqua.operators.state_fns.DictStateFn.mul#qiskit.aqua.operators.state_fns.DictStateFn.mul "qiskit.aqua.operators.state_fns.DictStateFn.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.state_fns.DictStateFn.neg#qiskit.aqua.operators.state_fns.DictStateFn.neg "qiskit.aqua.operators.state_fns.DictStateFn.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.state_fns.DictStateFn.permute#qiskit.aqua.operators.state_fns.DictStateFn.permute "qiskit.aqua.operators.state_fns.DictStateFn.permute") | Permute the qubits of the state function. | -| [`power`](qiskit.aqua.operators.state_fns.DictStateFn.power#qiskit.aqua.operators.state_fns.DictStateFn.power "qiskit.aqua.operators.state_fns.DictStateFn.power") | Compose with Self Multiple Times, undefined for StateFns. | -| [`primitive_strings`](qiskit.aqua.operators.state_fns.DictStateFn.primitive_strings#qiskit.aqua.operators.state_fns.DictStateFn.primitive_strings "qiskit.aqua.operators.state_fns.DictStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.state_fns.DictStateFn.reduce#qiskit.aqua.operators.state_fns.DictStateFn.reduce "qiskit.aqua.operators.state_fns.DictStateFn.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`sample`](qiskit.aqua.operators.state_fns.DictStateFn.sample#qiskit.aqua.operators.state_fns.DictStateFn.sample "qiskit.aqua.operators.state_fns.DictStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.aqua.operators.state_fns.DictStateFn.tensor#qiskit.aqua.operators.state_fns.DictStateFn.tensor "qiskit.aqua.operators.state_fns.DictStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.state_fns.DictStateFn.tensorpower#qiskit.aqua.operators.state_fns.DictStateFn.tensorpower "qiskit.aqua.operators.state_fns.DictStateFn.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit_op`](qiskit.aqua.operators.state_fns.DictStateFn.to_circuit_op#qiskit.aqua.operators.state_fns.DictStateFn.to_circuit_op "qiskit.aqua.operators.state_fns.DictStateFn.to_circuit_op") | Return `StateFnCircuit` corresponding to this StateFn. | -| [`to_density_matrix`](qiskit.aqua.operators.state_fns.DictStateFn.to_density_matrix#qiskit.aqua.operators.state_fns.DictStateFn.to_density_matrix "qiskit.aqua.operators.state_fns.DictStateFn.to_density_matrix") | Return matrix representing product of StateFn evaluated on pairs of basis states. | -| [`to_legacy_op`](qiskit.aqua.operators.state_fns.DictStateFn.to_legacy_op#qiskit.aqua.operators.state_fns.DictStateFn.to_legacy_op "qiskit.aqua.operators.state_fns.DictStateFn.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.state_fns.DictStateFn.to_matrix#qiskit.aqua.operators.state_fns.DictStateFn.to_matrix "qiskit.aqua.operators.state_fns.DictStateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.state_fns.DictStateFn.to_matrix_op#qiskit.aqua.operators.state_fns.DictStateFn.to_matrix_op "qiskit.aqua.operators.state_fns.DictStateFn.to_matrix_op") | Return a `VectorStateFn` for this `StateFn`. | -| [`to_spmatrix`](qiskit.aqua.operators.state_fns.DictStateFn.to_spmatrix#qiskit.aqua.operators.state_fns.DictStateFn.to_spmatrix "qiskit.aqua.operators.state_fns.DictStateFn.to_spmatrix") | Same as to\_matrix, but returns csr sparse matrix. | -| [`traverse`](qiskit.aqua.operators.state_fns.DictStateFn.traverse#qiskit.aqua.operators.state_fns.DictStateFn.traverse "qiskit.aqua.operators.state_fns.DictStateFn.traverse") | Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`DictStateFn.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`DictStateFn.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`DictStateFn.compose(other, permutation=None, front=False)` + +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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### equals + + + +`DictStateFn.equals(other)` + +Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### mul + + + +`DictStateFn.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`DictStateFn.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`DictStateFn` + +**Returns** + +A new StateFn containing the permuted primitive. + +### power + + + +`DictStateFn.power(exponent)` + +Compose with Self Multiple Times, undefined for StateFns. + +**Parameters** + +**exponent** (`int`) – The number of times to compose self with self. + +**Raises** + +**ValueError** – This function is not defined for StateFns. + +**Return type** + +`OperatorBase` + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** +A set of strings describing the primitives contained within the Operator. +### reduce + + + +`DictStateFn.reduce()` + +Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`dict` + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`DictStateFn.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy array representing the density matrix of the State function. + +**Raises** + +**ValueError** – If massive is set to False, and exponentially large computation is needed. + +### to\_legacy\_op + + + +`DictStateFn.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`DictStateFn.to_matrix_op(massive=False)` + +Return a `VectorStateFn` for this `StateFn`. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`OperatorBase` + +**Returns** + +A VectorStateFn equivalent to self. + +### to\_spmatrix + + + +`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. + +**Return type** + +`spmatrix` + +**Returns** + +CSR sparse matrix representation of the State function. + +**Raises** + +**ValueError** – invalid parameters. + +### traverse + + + +`DictStateFn.traverse(convert_fn, coeff=None)` + +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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -70,7 +497,7 @@ A coefficient by which the state function is multiplied. `Union`\[`int`, `float`, `complex`, `ParameterExpression`] - + ### is\_measurement @@ -80,7 +507,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -88,12 +515,13 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive The primitive which defines the behavior of the underlying State function. + 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 5a1d1810884..d00c5e512aa 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 @@ -1,8 +1,16 @@ -# OperatorStateFn +--- +title: OperatorStateFn +description: API reference for qiskit.aqua.operators.state_fns.OperatorStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.state_fns.OperatorStateFn +--- +# OperatorStateFn + -`OperatorStateFn(primitive=None, coeff=1.0, is_measurement=False)` +`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` @@ -16,46 +24,436 @@ A class for state functions and measurements which are defined by a density Oper ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.state_fns.OperatorStateFn.add#qiskit.aqua.operators.state_fns.OperatorStateFn.add "qiskit.aqua.operators.state_fns.OperatorStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.state_fns.OperatorStateFn.adjoint#qiskit.aqua.operators.state_fns.OperatorStateFn.adjoint "qiskit.aqua.operators.state_fns.OperatorStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.state_fns.OperatorStateFn.assign_parameters#qiskit.aqua.operators.state_fns.OperatorStateFn.assign_parameters "qiskit.aqua.operators.state_fns.OperatorStateFn.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.state_fns.OperatorStateFn.bind_parameters#qiskit.aqua.operators.state_fns.OperatorStateFn.bind_parameters "qiskit.aqua.operators.state_fns.OperatorStateFn.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.state_fns.OperatorStateFn.compose#qiskit.aqua.operators.state_fns.OperatorStateFn.compose "qiskit.aqua.operators.state_fns.OperatorStateFn.compose") | 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. | -| [`equals`](qiskit.aqua.operators.state_fns.OperatorStateFn.equals#qiskit.aqua.operators.state_fns.OperatorStateFn.equals "qiskit.aqua.operators.state_fns.OperatorStateFn.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.state_fns.OperatorStateFn.eval#qiskit.aqua.operators.state_fns.OperatorStateFn.eval "qiskit.aqua.operators.state_fns.OperatorStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`mul`](qiskit.aqua.operators.state_fns.OperatorStateFn.mul#qiskit.aqua.operators.state_fns.OperatorStateFn.mul "qiskit.aqua.operators.state_fns.OperatorStateFn.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.state_fns.OperatorStateFn.neg#qiskit.aqua.operators.state_fns.OperatorStateFn.neg "qiskit.aqua.operators.state_fns.OperatorStateFn.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.state_fns.OperatorStateFn.permute#qiskit.aqua.operators.state_fns.OperatorStateFn.permute "qiskit.aqua.operators.state_fns.OperatorStateFn.permute") | Permute the qubits of the state function. | -| [`power`](qiskit.aqua.operators.state_fns.OperatorStateFn.power#qiskit.aqua.operators.state_fns.OperatorStateFn.power "qiskit.aqua.operators.state_fns.OperatorStateFn.power") | Compose with Self Multiple Times, undefined for StateFns. | -| [`primitive_strings`](qiskit.aqua.operators.state_fns.OperatorStateFn.primitive_strings#qiskit.aqua.operators.state_fns.OperatorStateFn.primitive_strings "qiskit.aqua.operators.state_fns.OperatorStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.state_fns.OperatorStateFn.reduce#qiskit.aqua.operators.state_fns.OperatorStateFn.reduce "qiskit.aqua.operators.state_fns.OperatorStateFn.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`sample`](qiskit.aqua.operators.state_fns.OperatorStateFn.sample#qiskit.aqua.operators.state_fns.OperatorStateFn.sample "qiskit.aqua.operators.state_fns.OperatorStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.aqua.operators.state_fns.OperatorStateFn.tensor#qiskit.aqua.operators.state_fns.OperatorStateFn.tensor "qiskit.aqua.operators.state_fns.OperatorStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.state_fns.OperatorStateFn.tensorpower#qiskit.aqua.operators.state_fns.OperatorStateFn.tensorpower "qiskit.aqua.operators.state_fns.OperatorStateFn.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit_op`](qiskit.aqua.operators.state_fns.OperatorStateFn.to_circuit_op#qiskit.aqua.operators.state_fns.OperatorStateFn.to_circuit_op "qiskit.aqua.operators.state_fns.OperatorStateFn.to_circuit_op") | Return `StateFnCircuit` corresponding to this StateFn. | -| [`to_density_matrix`](qiskit.aqua.operators.state_fns.OperatorStateFn.to_density_matrix#qiskit.aqua.operators.state_fns.OperatorStateFn.to_density_matrix "qiskit.aqua.operators.state_fns.OperatorStateFn.to_density_matrix") | 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. | -| [`to_legacy_op`](qiskit.aqua.operators.state_fns.OperatorStateFn.to_legacy_op#qiskit.aqua.operators.state_fns.OperatorStateFn.to_legacy_op "qiskit.aqua.operators.state_fns.OperatorStateFn.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.state_fns.OperatorStateFn.to_matrix#qiskit.aqua.operators.state_fns.OperatorStateFn.to_matrix "qiskit.aqua.operators.state_fns.OperatorStateFn.to_matrix") | 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. | -| [`to_matrix_op`](qiskit.aqua.operators.state_fns.OperatorStateFn.to_matrix_op#qiskit.aqua.operators.state_fns.OperatorStateFn.to_matrix_op "qiskit.aqua.operators.state_fns.OperatorStateFn.to_matrix_op") | Return a MatrixOp for this operator. | -| [`traverse`](qiskit.aqua.operators.state_fns.OperatorStateFn.traverse#qiskit.aqua.operators.state_fns.OperatorStateFn.traverse "qiskit.aqua.operators.state_fns.OperatorStateFn.traverse") | Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`OperatorStateFn.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`OperatorStateFn.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`OperatorStateFn.compose(other, permutation=None, front=False)` + +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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### equals + + + +`OperatorStateFn.equals(other)` + +Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### mul + + + +`OperatorStateFn.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`OperatorStateFn.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`OperatorStateFn` + +**Returns** + +A new StateFn containing the permuted primitive. + +### power + + + +`OperatorStateFn.power(exponent)` + +Compose with Self Multiple Times, undefined for StateFns. + +**Parameters** + +**exponent** (`int`) – The number of times to compose self with self. + +**Raises** + +**ValueError** – This function is not defined for StateFns. + +**Return type** +`OperatorBase` +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`OperatorStateFn.reduce()` + +Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`dict` + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`OperatorStateFn.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Return type** + +`ndarray` + +### to\_legacy\_op + + + +`OperatorStateFn.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +Return numpy vector of state vector, warn if more than 16 qubits to force the user to set massive=True if they want such a large vector. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Returns** + +Vector of state vector + +**Return type** + +np.ndarray + +**Raises** + +**ValueError** – Invalid parameters. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### traverse + + + +`OperatorStateFn.traverse(convert_fn, coeff=None)` + +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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -65,7 +463,7 @@ A coefficient by which the state function is multiplied. `Union`\[`int`, `float`, `complex`, `ParameterExpression`] - + ### is\_measurement @@ -75,7 +473,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -83,12 +481,13 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive The primitive which defines the behavior of the underlying State function. + 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 2c9dbb74150..511b06e8ac4 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 @@ -1,8 +1,16 @@ -# StateFn +--- +title: StateFn +description: API reference for qiskit.aqua.operators.state_fns.StateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.state_fns.StateFn +--- +# StateFn + -`StateFn(primitive=None, coeff=1.0, is_measurement=False)` +`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` @@ -22,45 +30,434 @@ NOTE: State functions here are not restricted to wave functions, as there is no ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.state_fns.StateFn.add#qiskit.aqua.operators.state_fns.StateFn.add "qiskit.aqua.operators.state_fns.StateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.state_fns.StateFn.adjoint#qiskit.aqua.operators.state_fns.StateFn.adjoint "qiskit.aqua.operators.state_fns.StateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.state_fns.StateFn.assign_parameters#qiskit.aqua.operators.state_fns.StateFn.assign_parameters "qiskit.aqua.operators.state_fns.StateFn.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.state_fns.StateFn.bind_parameters#qiskit.aqua.operators.state_fns.StateFn.bind_parameters "qiskit.aqua.operators.state_fns.StateFn.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.state_fns.StateFn.compose#qiskit.aqua.operators.state_fns.StateFn.compose "qiskit.aqua.operators.state_fns.StateFn.compose") | 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. | -| [`equals`](qiskit.aqua.operators.state_fns.StateFn.equals#qiskit.aqua.operators.state_fns.StateFn.equals "qiskit.aqua.operators.state_fns.StateFn.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.state_fns.StateFn.eval#qiskit.aqua.operators.state_fns.StateFn.eval "qiskit.aqua.operators.state_fns.StateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`mul`](qiskit.aqua.operators.state_fns.StateFn.mul#qiskit.aqua.operators.state_fns.StateFn.mul "qiskit.aqua.operators.state_fns.StateFn.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.state_fns.StateFn.neg#qiskit.aqua.operators.state_fns.StateFn.neg "qiskit.aqua.operators.state_fns.StateFn.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.state_fns.StateFn.permute#qiskit.aqua.operators.state_fns.StateFn.permute "qiskit.aqua.operators.state_fns.StateFn.permute") | Permute the qubits of the state function. | -| [`power`](qiskit.aqua.operators.state_fns.StateFn.power#qiskit.aqua.operators.state_fns.StateFn.power "qiskit.aqua.operators.state_fns.StateFn.power") | Compose with Self Multiple Times, undefined for StateFns. | -| [`primitive_strings`](qiskit.aqua.operators.state_fns.StateFn.primitive_strings#qiskit.aqua.operators.state_fns.StateFn.primitive_strings "qiskit.aqua.operators.state_fns.StateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.state_fns.StateFn.reduce#qiskit.aqua.operators.state_fns.StateFn.reduce "qiskit.aqua.operators.state_fns.StateFn.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`sample`](qiskit.aqua.operators.state_fns.StateFn.sample#qiskit.aqua.operators.state_fns.StateFn.sample "qiskit.aqua.operators.state_fns.StateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.aqua.operators.state_fns.StateFn.tensor#qiskit.aqua.operators.state_fns.StateFn.tensor "qiskit.aqua.operators.state_fns.StateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.state_fns.StateFn.tensorpower#qiskit.aqua.operators.state_fns.StateFn.tensorpower "qiskit.aqua.operators.state_fns.StateFn.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_density_matrix`](qiskit.aqua.operators.state_fns.StateFn.to_density_matrix#qiskit.aqua.operators.state_fns.StateFn.to_density_matrix "qiskit.aqua.operators.state_fns.StateFn.to_density_matrix") | Return matrix representing product of StateFn evaluated on pairs of basis states. | -| [`to_legacy_op`](qiskit.aqua.operators.state_fns.StateFn.to_legacy_op#qiskit.aqua.operators.state_fns.StateFn.to_legacy_op "qiskit.aqua.operators.state_fns.StateFn.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.state_fns.StateFn.to_matrix#qiskit.aqua.operators.state_fns.StateFn.to_matrix "qiskit.aqua.operators.state_fns.StateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.state_fns.StateFn.to_matrix_op#qiskit.aqua.operators.state_fns.StateFn.to_matrix_op "qiskit.aqua.operators.state_fns.StateFn.to_matrix_op") | Return a `VectorStateFn` for this `StateFn`. | -| [`traverse`](qiskit.aqua.operators.state_fns.StateFn.traverse#qiskit.aqua.operators.state_fns.StateFn.traverse "qiskit.aqua.operators.state_fns.StateFn.traverse") | Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`StateFn.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`StateFn.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new StateFn containing the permuted primitive. + +### power + + + +`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. + +**Parameters** + +**exponent** (`int`) – The number of times to compose self with self. + +**Raises** + +**ValueError** – This function is not defined for StateFns. + +**Return type** +`OperatorBase` +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`Dict`\[`str`, `Union`\[`int`, `float`]] + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_density\_matrix + + + +`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. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy array representing the density matrix of the State function. + +**Raises** + +**ValueError** – If massive is set to False, and exponentially large computation is needed. + +### to\_legacy\_op + + + +`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. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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`. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`OperatorBase` + +**Returns** + +A VectorStateFn equivalent to self. + +### traverse + + + +`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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -70,7 +467,7 @@ A coefficient by which the state function is multiplied. `Union`\[`int`, `float`, `complex`, `ParameterExpression`] - + ### is\_measurement @@ -80,7 +477,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -88,12 +485,13 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive The primitive which defines the behavior of the underlying State function. + 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 f3bb0db625a..1557aa5d657 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 @@ -1,8 +1,16 @@ -# VectorStateFn +--- +title: VectorStateFn +description: API reference for qiskit.aqua.operators.state_fns.VectorStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.operators.state_fns.VectorStateFn +--- +# VectorStateFn + -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` +`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` @@ -16,47 +24,462 @@ A class for state functions and measurements which are defined in vector represe ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.aqua.operators.state_fns.VectorStateFn.add#qiskit.aqua.operators.state_fns.VectorStateFn.add "qiskit.aqua.operators.state_fns.VectorStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.aqua.operators.state_fns.VectorStateFn.adjoint#qiskit.aqua.operators.state_fns.VectorStateFn.adjoint "qiskit.aqua.operators.state_fns.VectorStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.aqua.operators.state_fns.VectorStateFn.assign_parameters#qiskit.aqua.operators.state_fns.VectorStateFn.assign_parameters "qiskit.aqua.operators.state_fns.VectorStateFn.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.aqua.operators.state_fns.VectorStateFn.bind_parameters#qiskit.aqua.operators.state_fns.VectorStateFn.bind_parameters "qiskit.aqua.operators.state_fns.VectorStateFn.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.aqua.operators.state_fns.VectorStateFn.compose#qiskit.aqua.operators.state_fns.VectorStateFn.compose "qiskit.aqua.operators.state_fns.VectorStateFn.compose") | 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. | -| [`equals`](qiskit.aqua.operators.state_fns.VectorStateFn.equals#qiskit.aqua.operators.state_fns.VectorStateFn.equals "qiskit.aqua.operators.state_fns.VectorStateFn.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.aqua.operators.state_fns.VectorStateFn.eval#qiskit.aqua.operators.state_fns.VectorStateFn.eval "qiskit.aqua.operators.state_fns.VectorStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`mul`](qiskit.aqua.operators.state_fns.VectorStateFn.mul#qiskit.aqua.operators.state_fns.VectorStateFn.mul "qiskit.aqua.operators.state_fns.VectorStateFn.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.aqua.operators.state_fns.VectorStateFn.neg#qiskit.aqua.operators.state_fns.VectorStateFn.neg "qiskit.aqua.operators.state_fns.VectorStateFn.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.aqua.operators.state_fns.VectorStateFn.permute#qiskit.aqua.operators.state_fns.VectorStateFn.permute "qiskit.aqua.operators.state_fns.VectorStateFn.permute") | Permute the qubits of the state function. | -| [`power`](qiskit.aqua.operators.state_fns.VectorStateFn.power#qiskit.aqua.operators.state_fns.VectorStateFn.power "qiskit.aqua.operators.state_fns.VectorStateFn.power") | Compose with Self Multiple Times, undefined for StateFns. | -| [`primitive_strings`](qiskit.aqua.operators.state_fns.VectorStateFn.primitive_strings#qiskit.aqua.operators.state_fns.VectorStateFn.primitive_strings "qiskit.aqua.operators.state_fns.VectorStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.aqua.operators.state_fns.VectorStateFn.reduce#qiskit.aqua.operators.state_fns.VectorStateFn.reduce "qiskit.aqua.operators.state_fns.VectorStateFn.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`sample`](qiskit.aqua.operators.state_fns.VectorStateFn.sample#qiskit.aqua.operators.state_fns.VectorStateFn.sample "qiskit.aqua.operators.state_fns.VectorStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.aqua.operators.state_fns.VectorStateFn.tensor#qiskit.aqua.operators.state_fns.VectorStateFn.tensor "qiskit.aqua.operators.state_fns.VectorStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.aqua.operators.state_fns.VectorStateFn.tensorpower#qiskit.aqua.operators.state_fns.VectorStateFn.tensorpower "qiskit.aqua.operators.state_fns.VectorStateFn.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit_op`](qiskit.aqua.operators.state_fns.VectorStateFn.to_circuit_op#qiskit.aqua.operators.state_fns.VectorStateFn.to_circuit_op "qiskit.aqua.operators.state_fns.VectorStateFn.to_circuit_op") | Return `StateFnCircuit` corresponding to this StateFn. | -| [`to_density_matrix`](qiskit.aqua.operators.state_fns.VectorStateFn.to_density_matrix#qiskit.aqua.operators.state_fns.VectorStateFn.to_density_matrix "qiskit.aqua.operators.state_fns.VectorStateFn.to_density_matrix") | Return matrix representing product of StateFn evaluated on pairs of basis states. | -| [`to_dict_fn`](qiskit.aqua.operators.state_fns.VectorStateFn.to_dict_fn#qiskit.aqua.operators.state_fns.VectorStateFn.to_dict_fn "qiskit.aqua.operators.state_fns.VectorStateFn.to_dict_fn") | Creates the equivalent state function of type DictStateFn. | -| [`to_legacy_op`](qiskit.aqua.operators.state_fns.VectorStateFn.to_legacy_op#qiskit.aqua.operators.state_fns.VectorStateFn.to_legacy_op "qiskit.aqua.operators.state_fns.VectorStateFn.to_legacy_op") | Attempt to return the Legacy Operator representation of the Operator. | -| [`to_matrix`](qiskit.aqua.operators.state_fns.VectorStateFn.to_matrix#qiskit.aqua.operators.state_fns.VectorStateFn.to_matrix "qiskit.aqua.operators.state_fns.VectorStateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.aqua.operators.state_fns.VectorStateFn.to_matrix_op#qiskit.aqua.operators.state_fns.VectorStateFn.to_matrix_op "qiskit.aqua.operators.state_fns.VectorStateFn.to_matrix_op") | Return a `VectorStateFn` for this `StateFn`. | -| [`traverse`](qiskit.aqua.operators.state_fns.VectorStateFn.traverse#qiskit.aqua.operators.state_fns.VectorStateFn.traverse "qiskit.aqua.operators.state_fns.VectorStateFn.traverse") | Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`VectorStateFn.assign_parameters(param_dict)` + +Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. This method differs from Terra’s `assign_parameters` in that it also supports lists of values to assign for a give `Parameter`, in which case self will be copied for each parameterization in the binding list(s), and all the copies will be returned in an `OpList`. If lists of parameterizations are used, every `Parameter` in the param\_dict must have the same length list of parameterizations. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`VectorStateFn.bind_parameters(param_dict)` + +Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). + +**Return type** + +`OperatorBase` + +### compose + + + +`VectorStateFn.compose(other, permutation=None, front=False)` + +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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### equals + + + +`VectorStateFn.equals(other)` + +Evaluate Equality between Operators, overloaded by `==`. Only returns True if self and other are of the same representation (e.g. a DictStateFn and CircuitStateFn will never be equal, even if their vector representations are equal), their underlying primitives are equal (this means for ListOps, OperatorStateFns, or EvolvedOps the equality is evaluated recursively downwards), and their coefficients are equal. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `float`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### mul + + + +`VectorStateFn.mul(scalar)` + +Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). + +**Parameters** + +**scalar** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + + +`VectorStateFn.neg()` + +Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`VectorStateFn` + +**Returns** + +A new StateFn containing the permuted primitive. + +### power + + + +`VectorStateFn.power(exponent)` + +Compose with Self Multiple Times, undefined for StateFns. + +**Parameters** + +**exponent** (`int`) – The number of times to compose self with self. + +**Raises** + +**ValueError** – This function is not defined for StateFns. + +**Return type** + +`OperatorBase` + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] +**Returns** +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`VectorStateFn.reduce()` + +Try collapsing the Operator structure, usually after some type of conversion, e.g. trying to add Operators in a SummedOp or delete needless IGates in a CircuitOp. If no reduction is available, just returns self. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`dict` + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`VectorStateFn.tensorpower(other)` + +Return tensor product with self multiple times, overloaded by `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy array representing the density matrix of the State function. + +**Raises** + +**ValueError** – If massive is set to False, and exponentially large computation is needed. + +### to\_dict\_fn + + + +`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. + +**Return type** + +`StateFn` + +**Returns** + +A new DictStateFn equivalent to `self`. + +### to\_legacy\_op + + + +`VectorStateFn.to_legacy_op(massive=False)` + +Attempt to return the Legacy Operator representation of the Operator. If self is a `SummedOp` of `PauliOps`, will attempt to convert to `WeightedPauliOperator`, and otherwise will simply convert to `MatrixOp` and then to `MatrixOperator`. The Legacy Operators cannot represent `StateFns` or proper `ListOps` (meaning not one of the `ListOp` subclasses), so an error will be thrown if this method is called on such an Operator. Also, Legacy Operators cannot represent unbound Parameter coeffs, so an error will be thrown if any are present in self. + +Warn if more than 16 qubits to force having to set `massive=True` if such a large vector is desired. + +**Return type** + +`LegacyBaseOperator` + +**Returns** + +The `LegacyBaseOperator` representing this Operator. + +**Raises** + +**TypeError** – self is an Operator which cannot be represented by a `LegacyBaseOperator`, such as `StateFn`, proper (non-subclass) `ListOp`, or an Operator with an unbound coeff Parameter. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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`. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`OperatorBase` + +**Returns** + +A VectorStateFn equivalent to self. + +### traverse + + + +`VectorStateFn.traverse(convert_fn, coeff=None)` + +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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`int`, `float`, `complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### ENABLE\_DEPRECATION `= True` - + ### INDENTATION `= ' '` - + ### coeff @@ -66,7 +489,7 @@ A coefficient by which the state function is multiplied. `Union`\[`int`, `float`, `complex`, `ParameterExpression`] - + ### is\_measurement @@ -76,7 +499,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -84,12 +507,13 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive The primitive which defines the behavior of the underlying State function. + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.md b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.md index 8a3a9595120..539aab176fb 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.operators.state_fns.md @@ -30,12 +30,12 @@ Measurements are defined to be functionals over StateFns, taking them to real va # State Functions -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`StateFn`](qiskit.aqua.operators.state_fns.StateFn#qiskit.aqua.operators.state_fns.StateFn "qiskit.aqua.operators.state_fns.StateFn") | A class for representing state functions and measurements. | -| [`CircuitStateFn`](qiskit.aqua.operators.state_fns.CircuitStateFn#qiskit.aqua.operators.state_fns.CircuitStateFn "qiskit.aqua.operators.state_fns.CircuitStateFn") | A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from \|0⟩, and stored using Terra’s `QuantumCircuit` class. | -| [`DictStateFn`](qiskit.aqua.operators.state_fns.DictStateFn#qiskit.aqua.operators.state_fns.DictStateFn "qiskit.aqua.operators.state_fns.DictStateFn") | A class for state functions and measurements which are defined by a lookup table, stored in a dict. | -| [`VectorStateFn`](qiskit.aqua.operators.state_fns.VectorStateFn#qiskit.aqua.operators.state_fns.VectorStateFn "qiskit.aqua.operators.state_fns.VectorStateFn") | A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. | -| [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn#qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | -| [`CVaRMeasurement`](qiskit.aqua.operators.state_fns.CVaRMeasurement#qiskit.aqua.operators.state_fns.CVaRMeasurement "qiskit.aqua.operators.state_fns.CVaRMeasurement") | A specialized measurement class to compute CVaR expectation values. | +| | | +| ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`StateFn`](qiskit.aqua.operators.state_fns.StateFn "qiskit.aqua.operators.state_fns.StateFn") | A class for representing state functions and measurements. | +| [`CircuitStateFn`](qiskit.aqua.operators.state_fns.CircuitStateFn "qiskit.aqua.operators.state_fns.CircuitStateFn") | A class for state functions and measurements which are defined by the action of a QuantumCircuit starting from \|0⟩, and stored using Terra’s `QuantumCircuit` class. | +| [`DictStateFn`](qiskit.aqua.operators.state_fns.DictStateFn "qiskit.aqua.operators.state_fns.DictStateFn") | A class for state functions and measurements which are defined by a lookup table, stored in a dict. | +| [`VectorStateFn`](qiskit.aqua.operators.state_fns.VectorStateFn "qiskit.aqua.operators.state_fns.VectorStateFn") | A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. | +| [`OperatorStateFn`](qiskit.aqua.operators.state_fns.OperatorStateFn "qiskit.aqua.operators.state_fns.OperatorStateFn") | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | +| [`CVaRMeasurement`](qiskit.aqua.operators.state_fns.CVaRMeasurement "qiskit.aqua.operators.state_fns.CVaRMeasurement") | A specialized measurement class to compute CVaR expectation values. | 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 60ac0262462..17e5fc4f133 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.CircuitFactory.md @@ -1,8 +1,16 @@ -# CircuitFactory +--- +title: CircuitFactory +description: API reference for qiskit.aqua.utils.CircuitFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.aqua.utils.CircuitFactory +--- +# CircuitFactory + -`CircuitFactory(num_target_qubits)` +`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` @@ -10,25 +18,136 @@ Base class for CircuitFactories ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.aqua.utils.CircuitFactory.build#qiskit.aqua.utils.CircuitFactory.build "qiskit.aqua.utils.CircuitFactory.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.aqua.utils.CircuitFactory.build_controlled#qiskit.aqua.utils.CircuitFactory.build_controlled "qiskit.aqua.utils.CircuitFactory.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.aqua.utils.CircuitFactory.build_controlled_inverse#qiskit.aqua.utils.CircuitFactory.build_controlled_inverse "qiskit.aqua.utils.CircuitFactory.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.aqua.utils.CircuitFactory.build_controlled_inverse_power#qiskit.aqua.utils.CircuitFactory.build_controlled_inverse_power "qiskit.aqua.utils.CircuitFactory.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.aqua.utils.CircuitFactory.build_controlled_power#qiskit.aqua.utils.CircuitFactory.build_controlled_power "qiskit.aqua.utils.CircuitFactory.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.aqua.utils.CircuitFactory.build_inverse#qiskit.aqua.utils.CircuitFactory.build_inverse "qiskit.aqua.utils.CircuitFactory.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.aqua.utils.CircuitFactory.build_inverse_power#qiskit.aqua.utils.CircuitFactory.build_inverse_power "qiskit.aqua.utils.CircuitFactory.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.aqua.utils.CircuitFactory.build_power#qiskit.aqua.utils.CircuitFactory.build_power "qiskit.aqua.utils.CircuitFactory.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.aqua.utils.CircuitFactory.get_num_qubits#qiskit.aqua.utils.CircuitFactory.get_num_qubits "qiskit.aqua.utils.CircuitFactory.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.aqua.utils.CircuitFactory.get_num_qubits_controlled#qiskit.aqua.utils.CircuitFactory.get_num_qubits_controlled "qiskit.aqua.utils.CircuitFactory.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.aqua.utils.CircuitFactory.required_ancillas#qiskit.aqua.utils.CircuitFactory.required_ancillas "qiskit.aqua.utils.CircuitFactory.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.aqua.utils.CircuitFactory.required_ancillas_controlled#qiskit.aqua.utils.CircuitFactory.required_ancillas_controlled "qiskit.aqua.utils.CircuitFactory.required_ancillas_controlled") | returns required ancillas controlled | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`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 + +### build\_controlled\_power + + + +`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 + +### build\_inverse + + + +`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 +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`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 + +### build\_power + + + +`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 + +### get\_num\_qubits + + + +`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 + +### get\_num\_qubits\_controlled + + + +`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 + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`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 + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + 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 19d031c83d7..2153d532f1b 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 @@ -1,7 +1,16 @@ -# qiskit.aqua.utils.decimal\_to\_binary +--- +title: decimal_to_binary +description: API reference for qiskit.aqua.utils.decimal_to_binary +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.decimal_to_binary +--- +# qiskit.aqua.utils.decimal\_to\_binary + -`decimal_to_binary(decimal_val, max_num_digits=20, fractional_part_only=False)` +`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 6c16167d92e..98dce40194a 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.get\_entangler\_map +--- +title: get_entangler_map +description: API reference for qiskit.aqua.utils.get_entangler_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.get_entangler_map +--- +# qiskit.aqua.utils.get\_entangler\_map + -`get_entangler_map(map_type, num_qubits, offset=0)` +`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit-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. @@ -23,3 +31,4 @@ list **Raises** **ValueError** – if map\_type is not valid. + 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 375aeaf708a..1e3d8b3fd86 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.get\_feature\_dimension +--- +title: get_feature_dimension +description: API reference for qiskit.aqua.utils.get_feature_dimension +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.get_feature_dimension +--- +# qiskit.aqua.utils.get\_feature\_dimension + -`get_feature_dimension(dataset)` +`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 @@ -21,3 +29,4 @@ int **Raises** **TypeError** – invalid data set + 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 a586262e3ba..8a64ebf33d8 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.get\_num\_classes +--- +title: get_num_classes +description: API reference for qiskit.aqua.utils.get_num_classes +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.get_num_classes +--- +# qiskit.aqua.utils.get\_num\_classes + -`get_num_classes(dataset)` +`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 @@ -17,3 +25,4 @@ number of classes **Return type** int + 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 912e43aaba9..1a2fcb6ba63 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.get\_subsystem\_density\_matrix +--- +title: get_subsystem_density_matrix +description: API reference for qiskit.aqua.utils.get_subsystem_density_matrix +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.get_subsystem_density_matrix +--- +# qiskit.aqua.utils.get\_subsystem\_density\_matrix + -`get_subsystem_density_matrix(statevector, trace_systems)` +`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. @@ -18,3 +26,4 @@ The reduced density matrix for the desired subsystem **Return type** numpy.ndarray + 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 6c539be260c..9ed8f0a7209 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.get\_subsystems\_counts +--- +title: get_subsystems_counts +description: API reference for qiskit.aqua.utils.get_subsystems_counts +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.get_subsystems_counts +--- +# qiskit.aqua.utils.get\_subsystems\_counts + -`get_subsystems_counts(complete_system_counts, post_select_index=None, post_select_flag=None)` +`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. @@ -25,3 +33,4 @@ each of the subsystems measured. **Return type** list + 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 db8031b3906..12bd62f9b51 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 @@ -1,7 +1,16 @@ -# qiskit.aqua.utils.has\_aer +--- +title: has_aer +description: API reference for qiskit.aqua.utils.has_aer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.has_aer +--- +# qiskit.aqua.utils.has\_aer + -`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") 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 4e0ca751faa..142d0c3a78d 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 @@ -1,7 +1,16 @@ -# qiskit.aqua.utils.has\_ibmq +--- +title: has_ibmq +description: API reference for qiskit.aqua.utils.has_ibmq +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.has_ibmq +--- +# qiskit.aqua.utils.has\_ibmq + -`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") 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 02b937f3693..9fbb70342c8 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.map\_label\_to\_class\_name +--- +title: map_label_to_class_name +description: API reference for qiskit.aqua.utils.map_label_to_class_name +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.map_label_to_class_name +--- +# qiskit.aqua.utils.map\_label\_to\_class\_name + -`map_label_to_class_name(predicted_labels, label_to_class)` +`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) @@ -18,3 +26,4 @@ predicted class names of each datum **Return type** str + diff --git a/docs/api/qiskit/0.32/qiskit.aqua.utils.md b/docs/api/qiskit/0.32/qiskit.aqua.utils.md index 30a6963e136..61ac4e99f98 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.md @@ -20,28 +20,28 @@ Various utility functionality… # Utilities -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | -| [`tensorproduct`](qiskit.aqua.utils.tensorproduct#qiskit.aqua.utils.tensorproduct "qiskit.aqua.utils.tensorproduct") | Calculate tensor product. | -| [`random_unitary`](qiskit.aqua.utils.random_unitary#qiskit.aqua.utils.random_unitary "qiskit.aqua.utils.random_unitary") | Generate a random unitary matrix with size NxN. | -| [`random_h2_body`](qiskit.aqua.utils.random_h2_body#qiskit.aqua.utils.random_h2_body "qiskit.aqua.utils.random_h2_body") | Generate a random two body integrals. | -| [`random_h1_body`](qiskit.aqua.utils.random_h1_body#qiskit.aqua.utils.random_h1_body "qiskit.aqua.utils.random_h1_body") | Generate a random one body integrals. | -| [`random_hermitian`](qiskit.aqua.utils.random_hermitian#qiskit.aqua.utils.random_hermitian "qiskit.aqua.utils.random_hermitian") | Generate random hermitian (sparse) matrix with given properties. | -| [`random_non_hermitian`](qiskit.aqua.utils.random_non_hermitian#qiskit.aqua.utils.random_non_hermitian "qiskit.aqua.utils.random_non_hermitian") | Generate random (sparse) matrix with given properties (singular values). | -| [`decimal_to_binary`](qiskit.aqua.utils.decimal_to_binary#qiskit.aqua.utils.decimal_to_binary "qiskit.aqua.utils.decimal_to_binary") | decimal to binary | -| [`summarize_circuits`](qiskit.aqua.utils.summarize_circuits#qiskit.aqua.utils.summarize_circuits "qiskit.aqua.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_subsystem_density_matrix`](qiskit.aqua.utils.get_subsystem_density_matrix#qiskit.aqua.utils.get_subsystem_density_matrix "qiskit.aqua.utils.get_subsystem_density_matrix") | Compute the reduced density matrix of a quantum subsystem. | -| [`get_subsystems_counts`](qiskit.aqua.utils.get_subsystems_counts#qiskit.aqua.utils.get_subsystems_counts "qiskit.aqua.utils.get_subsystems_counts") | Extract all subsystems’ counts from the single complete system count dictionary. | -| [`get_entangler_map`](qiskit.aqua.utils.get_entangler_map#qiskit.aqua.utils.get_entangler_map "qiskit.aqua.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.aqua.utils.validate_entangler_map#qiskit.aqua.utils.validate_entangler_map "qiskit.aqua.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`get_feature_dimension`](qiskit.aqua.utils.get_feature_dimension#qiskit.aqua.utils.get_feature_dimension "qiskit.aqua.utils.get_feature_dimension") | Check feature dimension of a given dataset | -| [`get_num_classes`](qiskit.aqua.utils.get_num_classes#qiskit.aqua.utils.get_num_classes "qiskit.aqua.utils.get_num_classes") | Check number of classes in a given dataset | -| [`split_dataset_to_data_and_labels`](qiskit.aqua.utils.split_dataset_to_data_and_labels#qiskit.aqua.utils.split_dataset_to_data_and_labels "qiskit.aqua.utils.split_dataset_to_data_and_labels") | Split dataset to data and labels numpy array | -| [`map_label_to_class_name`](qiskit.aqua.utils.map_label_to_class_name#qiskit.aqua.utils.map_label_to_class_name "qiskit.aqua.utils.map_label_to_class_name") | Helper converts labels (numeric) to class name (string) | -| [`reduce_dim_to_via_pca`](qiskit.aqua.utils.reduce_dim_to_via_pca#qiskit.aqua.utils.reduce_dim_to_via_pca "qiskit.aqua.utils.reduce_dim_to_via_pca") | Reduce the data dimension via pca | -| [`optimize_svm`](qiskit.aqua.utils.optimize_svm#qiskit.aqua.utils.optimize_svm "qiskit.aqua.utils.optimize_svm") | Solving quadratic programming problem for SVM; thus, some constraints are fixed. | -| [`CircuitFactory`](qiskit.aqua.utils.CircuitFactory#qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") | Base class for CircuitFactories | -| [`has_ibmq`](qiskit.aqua.utils.has_ibmq#qiskit.aqua.utils.has_ibmq "qiskit.aqua.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.aqua.utils.has_aer#qiskit.aqua.utils.has_aer "qiskit.aqua.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.aqua.utils.name_args#qiskit.aqua.utils.name_args "qiskit.aqua.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | +| [`tensorproduct`](qiskit.aqua.utils.tensorproduct "qiskit.aqua.utils.tensorproduct") | Calculate tensor product. | +| [`random_unitary`](qiskit.aqua.utils.random_unitary "qiskit.aqua.utils.random_unitary") | Generate a random unitary matrix with size NxN. | +| [`random_h2_body`](qiskit.aqua.utils.random_h2_body "qiskit.aqua.utils.random_h2_body") | Generate a random two body integrals. | +| [`random_h1_body`](qiskit.aqua.utils.random_h1_body "qiskit.aqua.utils.random_h1_body") | Generate a random one body integrals. | +| [`random_hermitian`](qiskit.aqua.utils.random_hermitian "qiskit.aqua.utils.random_hermitian") | Generate random hermitian (sparse) matrix with given properties. | +| [`random_non_hermitian`](qiskit.aqua.utils.random_non_hermitian "qiskit.aqua.utils.random_non_hermitian") | Generate random (sparse) matrix with given properties (singular values). | +| [`decimal_to_binary`](qiskit.aqua.utils.decimal_to_binary "qiskit.aqua.utils.decimal_to_binary") | decimal to binary | +| [`summarize_circuits`](qiskit.aqua.utils.summarize_circuits "qiskit.aqua.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_subsystem_density_matrix`](qiskit.aqua.utils.get_subsystem_density_matrix "qiskit.aqua.utils.get_subsystem_density_matrix") | Compute the reduced density matrix of a quantum subsystem. | +| [`get_subsystems_counts`](qiskit.aqua.utils.get_subsystems_counts "qiskit.aqua.utils.get_subsystems_counts") | Extract all subsystems’ counts from the single complete system count dictionary. | +| [`get_entangler_map`](qiskit.aqua.utils.get_entangler_map "qiskit.aqua.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.aqua.utils.validate_entangler_map "qiskit.aqua.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`get_feature_dimension`](qiskit.aqua.utils.get_feature_dimension "qiskit.aqua.utils.get_feature_dimension") | Check feature dimension of a given dataset | +| [`get_num_classes`](qiskit.aqua.utils.get_num_classes "qiskit.aqua.utils.get_num_classes") | Check number of classes in a given dataset | +| [`split_dataset_to_data_and_labels`](qiskit.aqua.utils.split_dataset_to_data_and_labels "qiskit.aqua.utils.split_dataset_to_data_and_labels") | Split dataset to data and labels numpy array | +| [`map_label_to_class_name`](qiskit.aqua.utils.map_label_to_class_name "qiskit.aqua.utils.map_label_to_class_name") | Helper converts labels (numeric) to class name (string) | +| [`reduce_dim_to_via_pca`](qiskit.aqua.utils.reduce_dim_to_via_pca "qiskit.aqua.utils.reduce_dim_to_via_pca") | Reduce the data dimension via pca | +| [`optimize_svm`](qiskit.aqua.utils.optimize_svm "qiskit.aqua.utils.optimize_svm") | Solving quadratic programming problem for SVM; thus, some constraints are fixed. | +| [`CircuitFactory`](qiskit.aqua.utils.CircuitFactory "qiskit.aqua.utils.CircuitFactory") | Base class for CircuitFactories | +| [`has_ibmq`](qiskit.aqua.utils.has_ibmq "qiskit.aqua.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.aqua.utils.has_aer "qiskit.aqua.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.aqua.utils.name_args "qiskit.aqua.utils.name_args") | Decorator to convert unnamed arguments to named ones. | 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 17ffc20f0d7..f026fafa149 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.name\_args +--- +title: name_args +description: API reference for qiskit.aqua.utils.name_args +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.name_args +--- +# qiskit.aqua.utils.name\_args + -`name_args(mapping, skip=0)` +`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. @@ -27,3 +35,4 @@ def new_f(a: TypeA, d: TypeD, b: TypeB=None, c: TypeC=None): if c is not None: # raise warning, this is deprecated! ``` + 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 274d0841088..6672791b2d2 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.optimize\_svm +--- +title: optimize_svm +description: API reference for qiskit.aqua.utils.optimize_svm +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.optimize_svm +--- +# qiskit.aqua.utils.optimize\_svm + -`optimize_svm(kernel_matrix, y, scaling=None, maxiter=500, show_progress=False, max_iters=None, lambda2=0.001)` +`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. @@ -26,4 +34,5 @@ np.ndarray **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If cvxpy is not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If cvxpy is not installed + 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 b10058d785f..0f5da87a287 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.random\_h1\_body +--- +title: random_h1_body +description: API reference for qiskit.aqua.utils.random_h1_body +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.random_h1_body +--- +# qiskit.aqua.utils.random\_h1\_body + -`random_h1_body(N)` +`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. @@ -21,3 +29,4 @@ np.ndarray **Raises** **ValueError** – invalid number of spin orbitals + 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 86f3c5dc96f..dce1537f2c9 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.random\_h2\_body +--- +title: random_h2_body +description: API reference for qiskit.aqua.utils.random_h2_body +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.random_h2_body +--- +# qiskit.aqua.utils.random\_h2\_body + -`random_h2_body(N, M)` +`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. @@ -22,3 +30,4 @@ np.ndarray **Raises** **ValueError** – invalid spin orbitals + 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 f942cea7b24..fb1930ce65b 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.random\_hermitian +--- +title: random_hermitian +description: API reference for qiskit.aqua.utils.random_hermitian +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.random_hermitian +--- +# qiskit.aqua.utils.random\_hermitian + -`random_hermitian(N, eigs=None, K=None, eigrange=None, sparsity=None, trunc=None)` +`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. @@ -26,3 +34,4 @@ np.ndarray **Raises** **ValueError** – invalid matrix + 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 6827de0601b..36ac0dd21c4 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.random\_non\_hermitian +--- +title: random_non_hermitian +description: API reference for qiskit.aqua.utils.random_non_hermitian +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.random_non_hermitian +--- +# qiskit.aqua.utils.random\_non\_hermitian + -`random_non_hermitian(N, M=None, sings=None, K=None, srange=None, sparsity=None, trunc=None)` +`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. @@ -27,3 +35,4 @@ np.ndarray **Raises:** ValueError: invalid matrix + 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 b9a10546bfb..88c40f6fc97 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.random\_unitary +--- +title: random_unitary +description: API reference for qiskit.aqua.utils.random_unitary +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.random_unitary +--- +# qiskit.aqua.utils.random\_unitary + -`random_unitary(N)` +`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. @@ -17,3 +25,4 @@ a 2-D matrix with complex data type. **Return type** np.ndarray + 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 05907b6c9fc..7291b17bff7 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.reduce\_dim\_to\_via\_pca +--- +title: reduce_dim_to_via_pca +description: API reference for qiskit.aqua.utils.reduce_dim_to_via_pca +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.reduce_dim_to_via_pca +--- +# qiskit.aqua.utils.reduce\_dim\_to\_via\_pca + -`reduce_dim_to_via_pca(x, dim)` +`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 @@ -18,3 +26,4 @@ NxD’ array **Return type** numpy.ndarray + 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 eaa2d38a62d..8b82cf9d567 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.split\_dataset\_to\_data\_and\_labels +--- +title: split_dataset_to_data_and_labels +description: API reference for qiskit.aqua.utils.split_dataset_to_data_and_labels +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.split_dataset_to_data_and_labels +--- +# qiskit.aqua.utils.split\_dataset\_to\_data\_and\_labels + -`split_dataset_to_data_and_labels(dataset, class_names=None)` +`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 @@ -24,3 +32,4 @@ Union(tuple(list, dict), list) **Raises** **KeyError** – data set invalid + 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 74b74abb3c6..9964a8c031c 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.summarize\_circuits +--- +title: summarize_circuits +description: API reference for qiskit.aqua.utils.summarize_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.summarize_circuits +--- +# qiskit.aqua.utils.summarize\_circuits + -`summarize_circuits(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 based on QuantumCircuit, and five metrics are summarized. @@ -16,7 +24,7 @@ The average statistic of the first four is provided if multiple circuits are pro **Parameters** -**circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or \[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – the to-be-summarized circuits +**circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or \[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – the to-be-summarized circuits **Returns** @@ -25,3 +33,4 @@ a formatted string records the summary **Return type** str + 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 7277110571a..505368993db 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.utils.tensorproduct.md +++ b/docs/api/qiskit/0.32/qiskit.aqua.utils.tensorproduct.md @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.tensorproduct +--- +title: tensorproduct +description: API reference for qiskit.aqua.utils.tensorproduct +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.tensorproduct +--- +# qiskit.aqua.utils.tensorproduct + -`tensorproduct(*args)` +`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. @@ -19,3 +27,4 @@ the tensor product **Return type** np.ndarray + 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 f6ca702e8a8..1a43fd00aed 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 @@ -1,8 +1,16 @@ -# qiskit.aqua.utils.validate\_entangler\_map +--- +title: validate_entangler_map +description: API reference for qiskit.aqua.utils.validate_entangler_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.aqua.utils.validate_entangler_map +--- +# qiskit.aqua.utils.validate\_entangler\_map + -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit-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. @@ -25,3 +33,4 @@ list * **TypeError** – entangler map is not list type or list of list * **ValueError** – the index of entangler map is out of range * **ValueError** – the qubits are cross-entangled. + diff --git a/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md b/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md index 51cc00c21c8..f08a8c2467f 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.RunConfig.md @@ -1,14 +1,22 @@ -# RunConfig +--- +title: RunConfig +description: API reference for qiskit.assembler.RunConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.assembler.RunConfig +--- +# RunConfig + -`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)` +`RunConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/run_config.py "view source code") Bases: `types.SimpleNamespace` Class for Run Configuration. - + ### shots @@ -18,7 +26,7 @@ the number of shots int - + ### max\_credits @@ -28,7 +36,7 @@ the max\_credits to use on the IBM Q public devices int - + ### seed\_simulator @@ -38,7 +46,7 @@ the seed to use in the simulator int - + ### memory @@ -48,7 +56,7 @@ whether to request memory from backend (per-shot readouts) bool - + ### parameter\_binds @@ -71,7 +79,39 @@ Initialize a RunConfig object ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [`from_dict`](qiskit.assembler.RunConfig.from_dict#qiskit.assembler.RunConfig.from_dict "qiskit.assembler.RunConfig.from_dict") | Create a new RunConfig object from a dictionary. | -| [`to_dict`](qiskit.assembler.RunConfig.to_dict#qiskit.assembler.RunConfig.to_dict "qiskit.assembler.RunConfig.to_dict") | Return a dictionary format representation of the RunConfig | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the RunConfig to create. It will be in the same format as output by [`to_dict()`](qiskit.assembler.RunConfig#to_dict "qiskit.assembler.RunConfig.to_dict"). + +**Returns** + +The RunConfig from the input dictionary. + +**Return type** + +[RunConfig](qiskit.assembler.RunConfig "qiskit.assembler.RunConfig") + +### to\_dict + + + +`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 + +**Returns** + +The dictionary form of the RunConfig. + +**Return type** + +dict + 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 700f5e31619..0b7badfe8e7 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.assemble_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.assemble_circuits.md @@ -1,8 +1,16 @@ -# qiskit.assembler.assemble\_circuits +--- +title: assemble_circuits +description: API reference for qiskit.assembler.assemble_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.assembler.assemble_circuits +--- +# qiskit.assembler.assemble\_circuits + -`assemble_circuits(circuits, run_config, qobj_id, qobj_header)` +`assemble_circuits(circuits, run_config, qobj_id, qobj_header)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_circuits.py "view source code") Assembles a list of circuits into a qobj that can be run on the backend. @@ -20,3 +28,4 @@ Assembles a list of circuits into a qobj that can be run on the backend. **Returns** The qobj to be run on the backends + 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 bada4e91e84..174896e6b6b 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.assemble_schedules.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.assemble_schedules.md @@ -1,8 +1,16 @@ -# qiskit.assembler.assemble\_schedules +--- +title: assemble_schedules +description: API reference for qiskit.assembler.assemble_schedules +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.assembler.assemble_schedules +--- +# qiskit.assembler.assemble\_schedules + -`assemble_schedules(schedules, qobj_id, qobj_header, run_config)` +`assemble_schedules(schedules, qobj_id, qobj_header, run_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/assembler/assemble_schedules.py "view source code") Assembles a list of schedules into a qobj that can be run on the backend. @@ -24,3 +32,4 @@ The Qobj to be run on the backends. **Raises** **QiskitError** – when frequency settings are not supplied. + diff --git a/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md b/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md index f3dec72a841..acbe0abbd5d 100644 --- a/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md +++ b/docs/api/qiskit/0.32/qiskit.assembler.disassemble.md @@ -1,14 +1,22 @@ -# qiskit.assembler.disassemble +--- +title: disassemble +description: API reference for qiskit.assembler.disassemble +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.assembler.disassemble +--- +# qiskit.assembler.disassemble + -`disassemble(qobj)` +`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. **Parameters** -**qobj** ([*Qobj*](qiskit.qobj.Qobj#qiskit.qobj.Qobj "qiskit.qobj.Qobj")) – The input qobj object to disassemble +**qobj** ([*Qobj*](qiskit.qobj.Qobj "qiskit.qobj.Qobj")) – The input qobj object to disassemble **Returns** @@ -21,3 +29,4 @@ The disassembled program which consists of: **Return type** Union\[CircuitModule, PulseModule] + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md b/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md index 9e999d9ce27..d2285896e8f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.BosonicOperator.md @@ -1,8 +1,16 @@ -# BosonicOperator +--- +title: BosonicOperator +description: API reference for qiskit.chemistry.BosonicOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.BosonicOperator +--- +# BosonicOperator + -`BosonicOperator(h, basis)` +`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` @@ -23,8 +31,70 @@ The Bosonic operator in this class is written in the n-mode second quantization ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`direct_mapping_filtering_criterion`](qiskit.chemistry.BosonicOperator.direct_mapping_filtering_criterion#qiskit.chemistry.BosonicOperator.direct_mapping_filtering_criterion "qiskit.chemistry.BosonicOperator.direct_mapping_filtering_criterion") | Filters out the states of irrelevant symmetries | -| [`mapping`](qiskit.chemistry.BosonicOperator.mapping#qiskit.chemistry.BosonicOperator.mapping "qiskit.chemistry.BosonicOperator.mapping") | Maps a bosonic operator into a qubit operator. | -| [`number_occupied_modals_per_mode`](qiskit.chemistry.BosonicOperator.number_occupied_modals_per_mode#qiskit.chemistry.BosonicOperator.number_occupied_modals_per_mode "qiskit.chemistry.BosonicOperator.number_occupied_modals_per_mode") | A bosonic operator which can be used to evaluate the number of occupied modals in a given mode | +### direct\_mapping\_filtering\_criterion + + + +`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 + +**Parameters** + +* **state** (`Union`\[`List`, `ndarray`]) – the statevector +* **value** (`float`) – the energy +* **aux\_values** (`Optional`\[`List`\[`float`]]) – the auxiliary energies + +**Return type** + +`bool` + +**Returns** + +True if the state is has one and only one modal occupied per mode meaning that the direct mapping symmetries are respected and False otherwise + +### mapping + + + +`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. + +**Parameters** + +* **qubit\_mapping** (`str`) – a string giving the type of mapping (only the ‘direct’ mapping is implemented at this point) +* **threshold** (`float`) – threshold to chop the low contribution paulis + +**Return type** + +`WeightedPauliOperator` + +**Returns** + +A qubit operator + +**Raises** + +**ValueError** – If requested mapping is not supported + +### number\_occupied\_modals\_per\_mode + + + +`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 + +**Parameters** + +**mode** (`int`) – the index of the mode + +**Returns** + +the corresponding bosonic operator + +**Return type** + +[BosonicOperator](qiskit.chemistry.BosonicOperator "qiskit.chemistry.BosonicOperator") + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md b/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md index 08a47240d11..8852f24734c 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.FermionicOperator.md @@ -1,8 +1,16 @@ -# FermionicOperator +--- +title: FermionicOperator +description: API reference for qiskit.chemistry.FermionicOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.FermionicOperator +--- +# FermionicOperator + -`FermionicOperator(h1, h2=None, ph_trans_shift=None)` +`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` @@ -28,7 +36,7 @@ There is another popular notation, the ‘*physicist*’ notation If you are using the ‘*physicist*’ notation, you need to convert it to the ‘*chemist*’ notation. E.g. h2=numpy.einsum(‘ikmj->ijkm’, h2) -The [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") class has [`one_body_integrals`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule.one_body_integrals "qiskit.chemistry.QMolecule.one_body_integrals") and [`two_body_integrals`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule.two_body_integrals "qiskit.chemistry.QMolecule.two_body_integrals") properties that can be directly supplied to the h1 and h2 parameters here respectively. +The [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") class has [`one_body_integrals`](qiskit.chemistry.QMolecule#one_body_integrals "qiskit.chemistry.QMolecule.one_body_integrals") and [`two_body_integrals`](qiskit.chemistry.QMolecule#two_body_integrals "qiskit.chemistry.QMolecule.two_body_integrals") properties that can be directly supplied to the h1 and h2 parameters here respectively. **Parameters** @@ -38,33 +46,172 @@ The [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`fermion_mode_elimination`](qiskit.chemistry.FermionicOperator.fermion_mode_elimination#qiskit.chemistry.FermionicOperator.fermion_mode_elimination "qiskit.chemistry.FermionicOperator.fermion_mode_elimination") | Eliminate modes. | -| [`fermion_mode_freezing`](qiskit.chemistry.FermionicOperator.fermion_mode_freezing#qiskit.chemistry.FermionicOperator.fermion_mode_freezing "qiskit.chemistry.FermionicOperator.fermion_mode_freezing") | Freezing modes and extracting its energy. | -| [`mapping`](qiskit.chemistry.FermionicOperator.mapping#qiskit.chemistry.FermionicOperator.mapping "qiskit.chemistry.FermionicOperator.mapping") | Map fermionic operator to qubit operator. | -| [`particle_hole_transformation`](qiskit.chemistry.FermionicOperator.particle_hole_transformation#qiskit.chemistry.FermionicOperator.particle_hole_transformation "qiskit.chemistry.FermionicOperator.particle_hole_transformation") | 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. | -| [`total_angular_momentum`](qiskit.chemistry.FermionicOperator.total_angular_momentum#qiskit.chemistry.FermionicOperator.total_angular_momentum "qiskit.chemistry.FermionicOperator.total_angular_momentum") | Total angular momentum. | -| [`total_magnetization`](qiskit.chemistry.FermionicOperator.total_magnetization#qiskit.chemistry.FermionicOperator.total_magnetization "qiskit.chemistry.FermionicOperator.total_magnetization") | A data\_preprocess\_helper fermionic operator which can be used to evaluate the magnetization of the given eigenstate. | -| [`total_particle_number`](qiskit.chemistry.FermionicOperator.total_particle_number#qiskit.chemistry.FermionicOperator.total_particle_number "qiskit.chemistry.FermionicOperator.total_particle_number") | A data\_preprocess\_helper fermionic operator which can be used to evaluate the number of particle of the given eigenstate. | -| [`transform`](qiskit.chemistry.FermionicOperator.transform#qiskit.chemistry.FermionicOperator.transform "qiskit.chemistry.FermionicOperator.transform") | Transform the one and two body term based on unitary\_matrix. | +### fermion\_mode\_elimination -## Attributes + + +`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. + +Generate a new fermionic operator with the modes in fermion\_mode\_array deleted + +**Parameters** + +**fermion\_mode\_array** (*list*) – orbital index for elimination + +**Returns** + +Fermionic Hamiltonian + +**Return type** + +[FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") + +### fermion\_mode\_freezing + + + +`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. + +Generate a fermionic operator with the modes in fermion\_mode\_array deleted and provide the shifted energy after freezing. + +**Parameters** + +**fermion\_mode\_array** (*list*) – orbital index for freezing +**Returns** +Fermionic Hamiltonian and energy of frozen modes + +**Return type** + +tuple([FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator"), float) + +### mapping + + + +`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. + +Using multiprocess to speedup the mapping, the improvement can be observed when h2 is a non-sparse matrix. + +**Parameters** + +* **map\_type** (*str*) – case-insensitive mapping type. “jordan\_wigner”, “parity”, “bravyi\_kitaev”, “bksf” +* **threshold** (*float*) – threshold for Pauli simplification + +**Returns** + +create an Operator object in Paulis form. + +**Return type** + +[WeightedPauliOperator](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator") + +**Raises** + +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – if the map\_type can not be recognized. + +### particle\_hole\_transformation + + + +`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)). + +**Parameters** + +**num\_particles** (*list, int*) – number of particles, if it is a list, the first number is alpha and the second number is beta. + +**Returns** + +new\_fer\_op, energy\_shift + +**Return type** + +tuple + +### total\_angular\_momentum + + + +`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. + +A data\_preprocess\_helper fermionic operator which can be used to evaluate the total angular momentum of the given eigenstate. + +**Returns** + +Fermionic Hamiltonian + +**Return type** + +[FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") + +### total\_magnetization + + + +`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. + +**Returns** + +Fermionic Hamiltonian + +**Return type** + +[FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") + +### total\_particle\_number + + + +`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. + +**Returns** + +Fermionic Hamiltonian + +**Return type** + +[FermionicOperator](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") + +### transform + + + +`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. + +## Attributes + + ### h1 Getter of one body integral tensor. - + ### h2 Getter of two body integral tensor. - + ### modes Getter of modes. + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md b/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md index af8ae87df3d..7767ac98360 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.MP2Info.md @@ -1,8 +1,16 @@ -# MP2Info +--- +title: MP2Info +description: API reference for qiskit.chemistry.MP2Info +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.MP2Info +--- +# MP2Info + -`MP2Info(qmolecule, threshold=1e-12)` +`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` @@ -24,19 +32,63 @@ A utility class for MP2 info **Parameters** -* **qmolecule** ([*QMolecule*](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule")) – QMolecule from chemistry driver +* **qmolecule** ([*QMolecule*](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule")) – QMolecule from chemistry driver * **threshold** (*float*) – Computed coefficients and energy deltas will be set to zero if their value is below this threshold ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| [`mp2_get_term_info`](qiskit.chemistry.MP2Info.mp2_get_term_info#qiskit.chemistry.MP2Info.mp2_get_term_info "qiskit.chemistry.MP2Info.mp2_get_term_info") | With a reduced active space the set of used excitations can be less than allowing all available excitations. | -| [`mp2_terms`](qiskit.chemistry.MP2Info.mp2_terms#qiskit.chemistry.MP2Info.mp2_terms "qiskit.chemistry.MP2Info.mp2_terms") | Gets the set of MP2 terms for the molecule taking into account index adjustments due to frozen core and/or other orbital reduction | +### mp2\_get\_term\_info -## Attributes + + +`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. + +**Parameters** + +* **excitation\_list** (*list*) – A list of excitations for which to get the coeff and e\_delta +* **freeze\_core** (*bool*) – Whether core orbitals are frozen or not +* **orbital\_reduction** (*list*) – An optional list of ints indicating removed orbitals + +**Returns** + +List of coefficients and list of energy deltas + +**Return type** + +Tuple(list, list) + +**Raises** + +**ValueError** – Excitation not present in mp2 terms + +### mp2\_terms + +`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 + +**Parameters** + +* **freeze\_core** (*bool*) – Whether core orbitals are frozen or not +* **orbital\_reduction** (*list*) – An optional list of ints indicating removed orbitals + +**Returns** + +**A dictionary of excitations where the key is a string in the form** + +from\_to\_from\_to e.g. 0\_4\_6\_10 and the value is a tuple of (coeff, e\_delta) + +**Return type** + +dict + +## Attributes + + ### mp2\_delta @@ -50,7 +102,7 @@ The MP2 delta energy float - + ### mp2\_energy @@ -63,3 +115,4 @@ The MP2 energy **Return type** float + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md b/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md index a61979b2cf2..e979a66297d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.QMolecule.md @@ -1,8 +1,16 @@ -# QMolecule +--- +title: QMolecule +description: API reference for qiskit.chemistry.QMolecule +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.QMolecule +--- +# QMolecule + -`QMolecule(filename=None)` +`QMolecule(filename=None)`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") Bases: `object` @@ -10,47 +18,180 @@ Molecule data class containing driver result. When one of the chemistry [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers") is run and instance of this class is returned. This contains various properties that are made available in a consistent manner across the various drivers. -Note that values here, for the same input molecule to each driver, may be vary across the drivers underlying code implementation. Also some drivers may not provide certain fields such as dipole integrals in the case of [`PyQuanteDriver`](qiskit.chemistry.drivers.PyQuanteDriver#qiskit.chemistry.drivers.PyQuanteDriver "qiskit.chemistry.drivers.PyQuanteDriver"). +Note that values here, for the same input molecule to each driver, may be vary across the drivers underlying code implementation. Also some drivers may not provide certain fields such as dipole integrals in the case of [`PyQuanteDriver`](qiskit.chemistry.drivers.PyQuanteDriver "qiskit.chemistry.drivers.PyQuanteDriver"). This class provides methods to save it and load it again from an HDF5 file ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`Z`](qiskit.chemistry.QMolecule.Z#qiskit.chemistry.QMolecule.Z "qiskit.chemistry.QMolecule.Z") | | -| [`has_dipole_integrals`](qiskit.chemistry.QMolecule.has_dipole_integrals#qiskit.chemistry.QMolecule.has_dipole_integrals "qiskit.chemistry.QMolecule.has_dipole_integrals") | Check if dipole integrals are present. | -| [`load`](qiskit.chemistry.QMolecule.load#qiskit.chemistry.QMolecule.load "qiskit.chemistry.QMolecule.load") | loads info saved. | -| [`log`](qiskit.chemistry.QMolecule.log#qiskit.chemistry.QMolecule.log "qiskit.chemistry.QMolecule.log") | log properties | -| [`onee_to_spin`](qiskit.chemistry.QMolecule.onee_to_spin#qiskit.chemistry.QMolecule.onee_to_spin "qiskit.chemistry.QMolecule.onee_to_spin") | Convert one-body MO integrals to spin orbital basis | -| [`oneeints2mo`](qiskit.chemistry.QMolecule.oneeints2mo#qiskit.chemistry.QMolecule.oneeints2mo "qiskit.chemistry.QMolecule.oneeints2mo") | Converts one-body integrals from AO to MO basis | -| [`remove_file`](qiskit.chemistry.QMolecule.remove_file#qiskit.chemistry.QMolecule.remove_file "qiskit.chemistry.QMolecule.remove_file") | remove file | -| [`save`](qiskit.chemistry.QMolecule.save#qiskit.chemistry.QMolecule.save "qiskit.chemistry.QMolecule.save") | Saves the info from the driver. | -| [`twoe_to_spin`](qiskit.chemistry.QMolecule.twoe_to_spin#qiskit.chemistry.QMolecule.twoe_to_spin "qiskit.chemistry.QMolecule.twoe_to_spin") | Convert two-body MO integrals to spin orbital basis | -| [`twoeints2mo`](qiskit.chemistry.QMolecule.twoeints2mo#qiskit.chemistry.QMolecule.twoeints2mo "qiskit.chemistry.QMolecule.twoeints2mo") | Converts two-body integrals from AO to MO basis | -| [`twoeints2mo_general`](qiskit.chemistry.QMolecule.twoeints2mo_general#qiskit.chemistry.QMolecule.twoeints2mo_general "qiskit.chemistry.QMolecule.twoeints2mo_general") | | +### Z -## Attributes + + +`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") + +Check if dipole integrals are present. + +### load + + + +`QMolecule.load()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") + +loads info saved. + +### log + + + +`QMolecule.log()`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/qmolecule.py "view source code") + +log properties + +### onee\_to\_spin + + + +`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 + +Takes one body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to one body terms 2nd quantized Hamiltonian. + +**Parameters** + +* **mohij** (*numpy.ndarray*) – One body orbitals in molecular basis (Alpha) +* **mohij\_b** (*numpy.ndarray*) – One body orbitals in molecular basis (Beta) +* **threshold** (*float*) – Threshold value for assignments + +**Returns** + +One body integrals in spin orbitals + +**Return type** + +numpy.ndarray + +### oneeints2mo + + + +`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 + +Returns one electron integrals in AO basis converted to given MO basis + +**Parameters** + +* **ints** (*numpy.ndarray*) – N^2 one electron integrals in AO basis +* **moc** (*numpy.ndarray*) – Molecular orbital coefficients + +**Returns** + +integrals in MO basis + +**Return type** + +numpy.ndarray + +### remove\_file + + + +`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 +### save + + +`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. + +### twoe\_to\_spin + + + +`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 + +Takes two body integrals in molecular orbital basis and returns integrals in spin orbitals ready for use as coefficients to two body terms in 2nd quantized Hamiltonian. + +**Parameters** + +* **mohijkl** (*numpy.ndarray*) – Two body orbitals in molecular basis (AlphaAlpha) +* **mohijkl\_bb** (*numpy.ndarray*) – Two body orbitals in molecular basis (BetaBeta) +* **mohijkl\_ba** (*numpy.ndarray*) – Two body orbitals in molecular basis (BetaAlpha) +* **threshold** (*float*) – Threshold value for assignments + +**Returns** + +Two body integrals in spin orbitals + +**Return type** + +numpy.ndarray + +### twoeints2mo + + + +`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 + +Returns two electron integrals in AO basis converted to given MO basis + +**Parameters** + +* **ints** (*numpy.ndarray*) – N^2 two electron integrals in AO basis +* **moc** (*numpy.ndarray*) – Molecular orbital coefficients + +**Returns** + +integrals in MO basis + +**Return type** + +numpy.ndarray + +### twoeints2mo\_general + + + +`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 + + ### BOHR `= 0.52917721092` - + ### DEBYE `= 0.393430307` - + ### QMOLECULE\_VERSION `= 2` - + ### core\_orbitals @@ -60,44 +201,45 @@ Returns: A list of core orbital indices. `List`\[`int`] - + ### filename returns temp file path - + ### one\_body\_integrals Returns one body electron integrals. - + ### symbols `= ['_', 'H', 'He', 'Li', 'Be', 'B', 'C', 'N', 'O', 'F', 'Ne', 'Na', 'Mg', 'Al', 'Si', 'P', 'S', 'Cl', 'Ar', 'K', 'Ca', 'Sc', 'Ti', 'V', 'Cr', 'Mn', 'Fe', 'Co', 'Ni', 'Cu', 'Zn', 'Ga', 'Ge', 'As', 'Se', 'Br', 'Kr', 'Rb', 'Sr', 'Y', 'Zr', 'Nb', 'Mo', 'Tc', 'Ru', 'Rh', 'Pd', 'Ag', 'Cd', 'In', 'Sn', 'Sb', 'Te', 'I', 'Xe', 'Cs', 'Ba', 'La', 'Ce', 'Pr', 'Nd', 'Pm', 'Sm', 'Eu', 'Gd', 'Tb', 'Dy', 'Ho', 'Er', 'Tm', 'Yb', 'Lu', 'Hf', 'Ta', 'W', 'Re', 'Os', 'Ir', 'Pt', 'Au', 'Hg', 'Tl', 'Pb', 'Bi', 'Po', 'At', 'Rn', 'Fr', 'Ra', 'Ac', 'Th', 'Pa', 'U', 'Np', 'Pu', 'Am', 'Cm', 'Bk', 'Cf', 'Es', 'Fm', 'Md', 'No', 'Lr', 'Rf', 'Db', 'Sg', 'Bh', 'Hs', 'Mt', 'Ds', 'Rg', 'Cn', 'Nh', 'Fl', 'Mc', 'Lv', 'Ts', 'Og']` - + ### two\_body\_integrals Returns two body electron integrals. - + ### x\_dipole\_integrals returns x\_dipole\_integrals - + ### y\_dipole\_integrals returns y\_dipole\_integrals - + ### z\_dipole\_integrals returns z\_dipole\_integrals + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md b/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md index bba41022a60..44ca4ce3362 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.QiskitChemistryError.md @@ -1,9 +1,18 @@ -# qiskit.chemistry.QiskitChemistryError +--- +title: QiskitChemistryError +description: API reference for qiskit.chemistry.QiskitChemistryError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.chemistry.QiskitChemistryError +--- +# qiskit.chemistry.QiskitChemistryError + -`QiskitChemistryError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md b/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md index b739e1d72ea..acff494f47e 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.WatsonHamiltonian.md @@ -1,8 +1,16 @@ -# WatsonHamiltonian +--- +title: WatsonHamiltonian +description: API reference for qiskit.chemistry.WatsonHamiltonian +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.WatsonHamiltonian +--- +# WatsonHamiltonian + -`WatsonHamiltonian(data, num_modes)` +`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` @@ -15,7 +23,7 @@ Watson Hamiltonian class containing the results of a driver’s anharmonic calcu ## Attributes - + ### data @@ -25,7 +33,7 @@ Returns the matrix elements of the Hamiltonian `List`\[`List`\[`Union`\[`int`, `float`]]] - + ### num\_modes @@ -34,3 +42,4 @@ Returns the number of modes **Return type** `int` + 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 8e160f4eba4..4a12aea1ebf 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.AdaptVQE.md @@ -1,8 +1,16 @@ -# AdaptVQE +--- +title: AdaptVQE +description: API reference for qiskit.chemistry.algorithms.AdaptVQE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.AdaptVQE +--- +# AdaptVQE + -`AdaptVQE(transformation, solver, threshold=1e-05, delta=1, max_iterations=None)` +`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` @@ -18,15 +26,67 @@ A ground state calculation employing the AdaptVQE algorithm. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`evaluate_operators`](qiskit.chemistry.algorithms.AdaptVQE.evaluate_operators#qiskit.chemistry.algorithms.AdaptVQE.evaluate_operators "qiskit.chemistry.algorithms.AdaptVQE.evaluate_operators") | Evaluates additional operators at the given state. | -| [`returns_groundstate`](qiskit.chemistry.algorithms.AdaptVQE.returns_groundstate#qiskit.chemistry.algorithms.AdaptVQE.returns_groundstate "qiskit.chemistry.algorithms.AdaptVQE.returns_groundstate") | Whether the eigensolver returns the ground state or only ground state energy. | -| [`solve`](qiskit.chemistry.algorithms.AdaptVQE.solve#qiskit.chemistry.algorithms.AdaptVQE.solve "qiskit.chemistry.algorithms.AdaptVQE.solve") | Computes the ground state. | +### evaluate\_operators -## Attributes + + +`AdaptVQE.evaluate_operators(state, operators)` + +Evaluates additional operators at the given state. + +**Parameters** + +* **state** (`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]) – any kind of input that can be used to specify a state. See also `StateFn` for more details. +* **operators** (`Union`\[`WeightedPauliOperator`, `OperatorBase`, `list`, `dict`]) – either a single, list or dictionary of `WeightedPauliOperator``s or any kind of operator implementing the ``OperatorBase`. + +**Return type** + +`Union`\[`float`, `None`, `List`\[`Optional`\[`float`]], `Dict`\[`str`, `List`\[`Optional`\[`float`]]]] + +**Returns** + +The expectation value of the given operator(s). The return type will be identical to the format of the provided operators. + +### returns\_groundstate + + + +`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. + +**Return type** +`bool` +### solve + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – a chemistry driver. +* **aux\_operators** (`Union`\[`List`\[`FermionicOperator`], `List`\[`BosonicOperator`], `None`]) – Additional auxiliary `FermionicOperator` instances to evaluate at the ground state. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if a solver other than VQE or a variational form other than UCCSD is provided or if the algorithm finishes due to an unforeseen reason. + +**Return type** + +`Union`\[`ElectronicStructureResult`, `VibronicStructureResult`] + +**Returns** + +An AdaptVQEResult which is an ElectronicStructureResult but also includes runtime information about the AdaptVQE algorithm like the number of iterations, finishing criterion, and the final maximum gradient. + +## Attributes + + ### solver @@ -36,7 +96,7 @@ Returns the minimum eigensolver or factory. `Union`\[`MinimumEigensolver`, `MinimumEigensolverFactory`] - + ### transformation @@ -45,3 +105,4 @@ Returns the transformation used to obtain a qubit operator from the molecule. **Return type** `Transformation` + 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 0201f24c91d..7f9d388d608 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.BOPESSampler.md @@ -1,8 +1,16 @@ -# BOPESSampler +--- +title: BOPESSampler +description: API reference for qiskit.chemistry.algorithms.BOPESSampler +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.BOPESSampler +--- +# BOPESSampler + -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` +`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` @@ -18,10 +26,32 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If `num_boostrap` is an integer smaller than 2, or if `num_boostrap` is larger than 2 and the extrapolator is not an instance of `WindowExtrapolator`. +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If `num_boostrap` is an integer smaller than 2, or if `num_boostrap` is larger than 2 and the extrapolator is not an instance of `WindowExtrapolator`. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`sample`](qiskit.chemistry.algorithms.BOPESSampler.sample#qiskit.chemistry.algorithms.BOPESSampler.sample "qiskit.chemistry.algorithms.BOPESSampler.sample") | Run the sampler at the given points, potentially with repetitions. | +### sample + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – BaseDriver specific for the problem. The driver should be based on a Molecule object that has perturbations to be varied. +* **points** (`List`\[`float`]) – The points along the degrees of freedom to evaluate. + +**Return type** + +`BOPESSamplerResult` + +**Returns** + +BOPES Sampler Result + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if the driver does not have a molecule specified. + 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 92d007f9a1a..254c2c52a7a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.EigensolverFactory.md @@ -1,8 +1,16 @@ -# EigensolverFactory +--- +title: EigensolverFactory +description: API reference for qiskit.chemistry.algorithms.EigensolverFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.EigensolverFactory +--- +# EigensolverFactory + -`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") Bases: `abc.ABC` @@ -10,6 +18,23 @@ A factory to construct a eigensolver based on a qubit operator transformation. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`get_solver`](qiskit.chemistry.algorithms.EigensolverFactory.get_solver#qiskit.chemistry.algorithms.EigensolverFactory.get_solver "qiskit.chemistry.algorithms.EigensolverFactory.get_solver") | Returns a eigensolver, based on the qubit operator transformation. | +### get\_solver + + + +`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. + +**Parameters** + +**transformation** (`Transformation`) – The qubit operator transformation. + +**Return type** + +`Eigensolver` + +**Returns** + +An eigensolver suitable to compute the excited states of the molecule transformed by `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 6fc0f0e688b..7dad604602c 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesEigensolver.md @@ -1,8 +1,16 @@ -# ExcitedStatesEigensolver +--- +title: ExcitedStatesEigensolver +description: API reference for qiskit.chemistry.algorithms.ExcitedStatesEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.ExcitedStatesEigensolver +--- +# ExcitedStatesEigensolver + -`ExcitedStatesEigensolver(transformation, solver)` +`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` @@ -15,13 +23,34 @@ The calculation of excited states via an Eigensolver algorithm ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| [`solve`](qiskit.chemistry.algorithms.ExcitedStatesEigensolver.solve#qiskit.chemistry.algorithms.ExcitedStatesEigensolver.solve "qiskit.chemistry.algorithms.ExcitedStatesEigensolver.solve") | Compute Ground and Excited States properties. | +### solve -## Attributes + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – a chemistry driver object which defines the chemical problem that is to be solved by this calculation. +* **aux\_operators** (`Optional`\[`List`\[`Any`]]) – Additional auxiliary operators to evaluate. Must be of type `FermionicOperator` if the qubit transformation is fermionic and of type `BosonicOperator` it is bosonic. + +**Raises** +**NotImplementedError** – If an operator in `aux_operators` is not of type `FermionicOperator`. +**Return type** + +`Union`\[`ElectronicStructureResult`, `VibronicStructureResult`] + +**Returns** + +An eigenstate result. Depending on the transformation this can be an electronic structure or bosonic result. + +## Attributes + + ### solver @@ -31,7 +60,7 @@ Returns the minimum eigensolver or factory. `Union`\[`Eigensolver`, `EigensolverFactory`] - + ### transformation @@ -40,3 +69,4 @@ Returns the transformation used to obtain a qubit operator from the molecule. **Return type** `Transformation` + 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 8036f39d8fd..e91e7836bc5 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.ExcitedStatesSolver.md @@ -1,8 +1,16 @@ -# ExcitedStatesSolver +--- +title: ExcitedStatesSolver +description: API reference for qiskit.chemistry.algorithms.ExcitedStatesSolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.ExcitedStatesSolver +--- +# ExcitedStatesSolver + -`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") Bases: `abc.ABC` @@ -10,6 +18,24 @@ The excited states calculation interface ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| [`solve`](qiskit.chemistry.algorithms.ExcitedStatesSolver.solve#qiskit.chemistry.algorithms.ExcitedStatesSolver.solve "qiskit.chemistry.algorithms.ExcitedStatesSolver.solve") | Compute the excited states energies of the molecule that was supplied via the driver. | +### solve + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – a chemistry driver object which defines the chemical problem that is to be solved by this calculation. +* **aux\_operators** (`Union`\[`List`\[`FermionicOperator`], `List`\[`BosonicOperator`], `None`]) – Additional auxiliary operators to evaluate. Must be of type `FermionicOperator` if the qubit transformation is fermionic and of type `BosonicOperator` it is bosonic. + +**Return type** + +`Union`\[`ElectronicStructureResult`, `VibronicStructureResult`] + +**Returns** + +an eigenstate result + 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 e8b24886e88..02f4dbe380a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateEigensolver.md @@ -1,8 +1,16 @@ -# GroundStateEigensolver +--- +title: GroundStateEigensolver +description: API reference for qiskit.chemistry.algorithms.GroundStateEigensolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.GroundStateEigensolver +--- +# GroundStateEigensolver + -`GroundStateEigensolver(transformation, solver)` +`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` @@ -15,15 +23,67 @@ Ground state computation using a minimum eigensolver. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`evaluate_operators`](qiskit.chemistry.algorithms.GroundStateEigensolver.evaluate_operators#qiskit.chemistry.algorithms.GroundStateEigensolver.evaluate_operators "qiskit.chemistry.algorithms.GroundStateEigensolver.evaluate_operators") | Evaluates additional operators at the given state. | -| [`returns_groundstate`](qiskit.chemistry.algorithms.GroundStateEigensolver.returns_groundstate#qiskit.chemistry.algorithms.GroundStateEigensolver.returns_groundstate "qiskit.chemistry.algorithms.GroundStateEigensolver.returns_groundstate") | Whether the eigensolver returns the ground state or only ground state energy. | -| [`solve`](qiskit.chemistry.algorithms.GroundStateEigensolver.solve#qiskit.chemistry.algorithms.GroundStateEigensolver.solve "qiskit.chemistry.algorithms.GroundStateEigensolver.solve") | Compute Ground State properties. | +### evaluate\_operators -## Attributes + + +`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. + +**Parameters** + +* **state** (`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]) – any kind of input that can be used to specify a state. See also `StateFn` for more details. +* **operators** (`Union`\[`WeightedPauliOperator`, `OperatorBase`, `list`, `dict`]) – either a single, list or dictionary of `WeightedPauliOperator``s or any kind of operator implementing the ``OperatorBase`. + +**Return type** + +`Union`\[`float`, `None`, `List`\[`Optional`\[`float`]], `Dict`\[`str`, `List`\[`Optional`\[`float`]]]] + +**Returns** + +The expectation value of the given operator(s). The return type will be identical to the format of the provided operators. + +### returns\_groundstate + + + +`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. + +**Return type** +`bool` +### solve + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – a chemistry driver object which defines the chemical problem that is to be solved by this calculation. +* **aux\_operators** (`Union`\[`List`\[`FermionicOperator`], `List`\[`BosonicOperator`], `None`]) – Additional auxiliary operators to evaluate at the ground state. Depending on whether a fermionic or bosonic system is solved, the type of the operators must be `FermionicOperator` or `BosonicOperator`, respectively. + +**Raises** + +**NotImplementedError** – If an operator in `aux_operators` is not of type `FermionicOperator`. + +**Return type** + +`Union`\[`ElectronicStructureResult`, `VibronicStructureResult`] + +**Returns** + +An eigenstate result. Depending on the transformation this can be an electronic structure or bosonic result. + +## Attributes + + ### solver @@ -33,7 +93,7 @@ Returns the minimum eigensolver or factory. `Union`\[`MinimumEigensolver`, `MinimumEigensolverFactory`] - + ### transformation @@ -42,3 +102,4 @@ Returns the transformation used to obtain a qubit operator from the molecule. **Return type** `Transformation` + 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 7b55b9ad20e..101256b9a3a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.GroundStateSolver.md @@ -1,8 +1,16 @@ -# GroundStateSolver +--- +title: GroundStateSolver +description: API reference for qiskit.chemistry.algorithms.GroundStateSolver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.GroundStateSolver +--- +# GroundStateSolver + -`GroundStateSolver(transformation)` +`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` @@ -14,15 +22,67 @@ The ground state calculation interface ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| [`evaluate_operators`](qiskit.chemistry.algorithms.GroundStateSolver.evaluate_operators#qiskit.chemistry.algorithms.GroundStateSolver.evaluate_operators "qiskit.chemistry.algorithms.GroundStateSolver.evaluate_operators") | Evaluates additional operators at the given state. | -| [`returns_groundstate`](qiskit.chemistry.algorithms.GroundStateSolver.returns_groundstate#qiskit.chemistry.algorithms.GroundStateSolver.returns_groundstate "qiskit.chemistry.algorithms.GroundStateSolver.returns_groundstate") | Whether this class returns only the ground state energy or also the ground state itself. | -| [`solve`](qiskit.chemistry.algorithms.GroundStateSolver.solve#qiskit.chemistry.algorithms.GroundStateSolver.solve "qiskit.chemistry.algorithms.GroundStateSolver.solve") | Compute the ground state energy of the molecule that was supplied via the driver. | +### evaluate\_operators -## Attributes + + +`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. + +**Parameters** + +* **state** (`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]) – any kind of input that can be used to specify a state. See also `StateFn` for more details. +* **operators** (`Union`\[`WeightedPauliOperator`, `OperatorBase`, `list`, `dict`]) – either a single, list or dictionary of `WeightedPauliOperator``s or any kind of operator implementing the ``OperatorBase`. + +**Return type** + +`Union`\[`float`, `List`\[`float`], `Dict`\[`str`, `List`\[`float`]]] + +**Returns** + +The expectation value of the given operator(s). The return type will be identical to the format of the provided operators. + +### returns\_groundstate + + + +`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. + +**Return type** + +`bool` + +**Returns** + +True, if this class also returns the ground state in the results object. False otherwise. + +### solve + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – a chemistry driver object which defines the chemical problem that is to be solved by this calculation. +* **aux\_operators** (`Union`\[`List`\[`FermionicOperator`], `List`\[`BosonicOperator`], `None`]) – Additional auxiliary operators to evaluate. Must be of type `FermionicOperator` if the qubit transformation is fermionic and of type `BosonicOperator` it is bosonic. + +**Return type** + +`Union`\[`ElectronicStructureResult`, `VibronicStructureResult`] +**Returns** +An eigenstate result. + +## Attributes + + ### transformation @@ -31,3 +91,4 @@ Returns the transformation used to obtain a qubit operator from the molecule. **Return type** `Transformation` + 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 24060b04e48..db1be79349d 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.MinimumEigensolverFactory.md @@ -1,8 +1,16 @@ -# MinimumEigensolverFactory +--- +title: MinimumEigensolverFactory +description: API reference for qiskit.chemistry.algorithms.MinimumEigensolverFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.MinimumEigensolverFactory +--- +# MinimumEigensolverFactory + -`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") Bases: `abc.ABC` @@ -10,7 +18,35 @@ A factory to construct a minimum eigensolver based on a qubit operator transform ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| [`get_solver`](qiskit.chemistry.algorithms.MinimumEigensolverFactory.get_solver#qiskit.chemistry.algorithms.MinimumEigensolverFactory.get_solver "qiskit.chemistry.algorithms.MinimumEigensolverFactory.get_solver") | Returns a minimum eigensolver, based on the qubit operator transformation. | -| [`supports_aux_operators`](qiskit.chemistry.algorithms.MinimumEigensolverFactory.supports_aux_operators#qiskit.chemistry.algorithms.MinimumEigensolverFactory.supports_aux_operators "qiskit.chemistry.algorithms.MinimumEigensolverFactory.supports_aux_operators") | Returns whether the eigensolver generated by this factory supports auxiliary operators. | +### get\_solver + + + +`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. + +**Parameters** + +**transformation** (`Transformation`) – The qubit operator transformation. + +**Return type** + +`MinimumEigensolver` + +**Returns** + +A minimum eigensolver suitable to compute the ground state of the molecule transformed by `transformation`. + +### supports\_aux\_operators + + + +`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. + +**Return type** + +`bool` + 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 be5c3b58921..e915859b2a4 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyEigensolverFactory.md @@ -1,8 +1,16 @@ -# NumPyEigensolverFactory +--- +title: NumPyEigensolverFactory +description: API reference for qiskit.chemistry.algorithms.NumPyEigensolverFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.NumPyEigensolverFactory +--- +# NumPyEigensolverFactory + -`NumPyEigensolverFactory(filter_criterion=None, k=100, use_default_filter_criterion=False)` +`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` @@ -17,13 +25,29 @@ A factory to construct a NumPyEigensolver. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`get_solver`](qiskit.chemistry.algorithms.NumPyEigensolverFactory.get_solver#qiskit.chemistry.algorithms.NumPyEigensolverFactory.get_solver "qiskit.chemistry.algorithms.NumPyEigensolverFactory.get_solver") | Returns a NumPyEigensolver with the desired filter | +### get\_solver -## Attributes + + +`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 +**Parameters** + +**transformation** (`Transformation`) – a fermionic/bosonic qubit operator transformation. + +**Return type** +`Eigensolver` + +**Returns** + +A NumPyEigensolver suitable to compute the ground state of the molecule transformed by `transformation`. + +## Attributes + + ### filter\_criterion @@ -33,7 +57,7 @@ returns filter criterion `Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`] - + ### k @@ -43,7 +67,7 @@ returns k (number of eigenvalues requested) `int` - + ### use\_default\_filter\_criterion @@ -52,3 +76,4 @@ returns whether to use the default filter criterion **Return type** `bool` + 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 5cfd5800cdb..f9cc83c2cc8 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.md @@ -1,8 +1,16 @@ -# NumPyMinimumEigensolverFactory +--- +title: NumPyMinimumEigensolverFactory +description: API reference for qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory +--- +# NumPyMinimumEigensolverFactory + -`NumPyMinimumEigensolverFactory(filter_criterion=None, use_default_filter_criterion=False)` +`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` @@ -15,14 +23,37 @@ A factory to construct a NumPyMinimumEigensolver. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -| [`get_solver`](qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.get_solver#qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.get_solver "qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.get_solver") | Returns a NumPyMinimumEigensolver which possibly uses the default filter criterion provided by the `transformation`. | -| [`supports_aux_operators`](qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.supports_aux_operators#qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.supports_aux_operators "qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory.supports_aux_operators") | Returns whether the eigensolver generated by this factory supports auxiliary operators. | +### get\_solver -## Attributes + + +`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`. + +**Parameters** + +**transformation** (`Transformation`) – a fermionic/bosonic qubit operator transformation. + +**Return type** +`MinimumEigensolver` +**Returns** + +A NumPyMinimumEigensolver suitable to compute the ground state of the molecule transformed by `transformation`. + +### supports\_aux\_operators + + + +`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. + +## Attributes + + ### filter\_criterion @@ -32,7 +63,7 @@ returns filter criterion `Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`] - + ### use\_default\_filter\_criterion @@ -41,3 +72,4 @@ returns whether to use the default filter criterion **Return type** `bool` + 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 f335cf233dd..0a0362652d0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.OrbitalOptimizationVQE.md @@ -1,8 +1,16 @@ -# OrbitalOptimizationVQE +--- +title: OrbitalOptimizationVQE +description: API reference for qiskit.chemistry.algorithms.OrbitalOptimizationVQE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.OrbitalOptimizationVQE +--- +# OrbitalOptimizationVQE + -`OrbitalOptimizationVQE(transformation, solver, initial_point=None, orbital_rotation=None, bounds=None, iterative_oo=True, iterative_oo_iterations=2)` +`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` @@ -20,19 +28,71 @@ A ground state calculation employing the OOVQE algorithm. The Variational Quantu **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if the number of orbital optimization iterations is less or equal to zero. +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if the number of orbital optimization iterations is less or equal to zero. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`evaluate_operators`](qiskit.chemistry.algorithms.OrbitalOptimizationVQE.evaluate_operators#qiskit.chemistry.algorithms.OrbitalOptimizationVQE.evaluate_operators "qiskit.chemistry.algorithms.OrbitalOptimizationVQE.evaluate_operators") | Evaluates additional operators at the given state. | -| [`returns_groundstate`](qiskit.chemistry.algorithms.OrbitalOptimizationVQE.returns_groundstate#qiskit.chemistry.algorithms.OrbitalOptimizationVQE.returns_groundstate "qiskit.chemistry.algorithms.OrbitalOptimizationVQE.returns_groundstate") | Whether the eigensolver returns the ground state or only ground state energy. | -| [`solve`](qiskit.chemistry.algorithms.OrbitalOptimizationVQE.solve#qiskit.chemistry.algorithms.OrbitalOptimizationVQE.solve "qiskit.chemistry.algorithms.OrbitalOptimizationVQE.solve") | Compute Ground State properties. | +### evaluate\_operators -## Attributes + + +`OrbitalOptimizationVQE.evaluate_operators(state, operators)` + +Evaluates additional operators at the given state. + +**Parameters** + +* **state** (`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]) – any kind of input that can be used to specify a state. See also `StateFn` for more details. +* **operators** (`Union`\[`WeightedPauliOperator`, `OperatorBase`, `list`, `dict`]) – either a single, list or dictionary of `WeightedPauliOperator``s or any kind of operator implementing the ``OperatorBase`. + +**Return type** + +`Union`\[`float`, `None`, `List`\[`Optional`\[`float`]], `Dict`\[`str`, `List`\[`Optional`\[`float`]]]] + +**Returns** + +The expectation value of the given operator(s). The return type will be identical to the format of the provided operators. + +### returns\_groundstate + + + +`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. + +**Return type** +`bool` +### solve + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – a chemistry driver object which defines the chemical problem that is to be solved by this calculation. +* **aux\_operators** (`Union`\[`List`\[`FermionicOperator`], `List`\[`BosonicOperator`], `None`]) – Additional auxiliary operators to evaluate at the ground state. Depending on whether a fermionic or bosonic system is solved, the type of the operators must be `FermionicOperator` or `BosonicOperator`, respectively. + +**Raises** + +**NotImplementedError** – If an operator in `aux_operators` is not of type `FermionicOperator`. + +**Return type** + +`ElectronicStructureResult` + +**Returns** + +An eigenstate result. Depending on the transformation this can be an electronic structure or bosonic result. + +## Attributes + + ### solver @@ -42,7 +102,7 @@ Returns the minimum eigensolver or factory. `Union`\[`MinimumEigensolver`, `MinimumEigensolverFactory`] - + ### transformation @@ -51,3 +111,4 @@ Returns the transformation used to obtain a qubit operator from the molecule. **Return type** `Transformation` + 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 28d670b7cb1..73920f5628b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEOM.md @@ -1,8 +1,16 @@ -# QEOM +--- +title: QEOM +description: API reference for qiskit.chemistry.algorithms.QEOM +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.QEOM +--- +# QEOM + -`QEOM(ground_state_solver, excitations='sd')` +`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` @@ -15,13 +23,32 @@ The calculation of excited states via the qEOM algorithm ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`solve`](qiskit.chemistry.algorithms.QEOM.solve#qiskit.chemistry.algorithms.QEOM.solve "qiskit.chemistry.algorithms.QEOM.solve") | Run the excited-states calculation. | +### solve -## Attributes + + +`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. + +Construct and solves the EOM pseudo-eigenvalue problem to obtain the excitation energies and the excitation operators expansion coefficients. + +**Parameters** +* **driver** (`BaseDriver`) – a chemistry driver object which defines the chemical problem that is to be solved by this calculation. +* **aux\_operators** (`Union`\[`List`\[`FermionicOperator`], `List`\[`BosonicOperator`], `None`]) – Additional auxiliary operators to evaluate. Must be of type `FermionicOperator` if the qubit transformation is fermionic and of type `BosonicOperator` it is bosonic. +**Return type** + +`Union`\[`ElectronicStructureResult`, `VibronicStructureResult`] + +**Returns** + +The excited states result. In case of a fermionic problem a `ElectronicStructureResult` is returned and in the bosonic case a `VibronicStructureResult`. + +## Attributes + + ### excitations @@ -30,3 +57,4 @@ Returns the excitations to be included in the eom pseudo-eigenvalue problem. **Return type** `Union`\[`str`, `List`\[`List`\[`int`]]] + 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 63fcc090cd2..a80b38b913e 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomEE.md @@ -1,8 +1,16 @@ -# QEomEE +--- +title: QEomEE +description: API reference for qiskit.chemistry.algorithms.QEomEE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.QEomEE +--- +# 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)` +`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` @@ -30,15 +38,64 @@ QEomEE algorithm (classical) ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_minimum_eigenvalue`](qiskit.chemistry.algorithms.QEomEE.compute_minimum_eigenvalue#qiskit.chemistry.algorithms.QEomEE.compute_minimum_eigenvalue "qiskit.chemistry.algorithms.QEomEE.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`run`](qiskit.chemistry.algorithms.QEomEE.run#qiskit.chemistry.algorithms.QEomEE.run "qiskit.chemistry.algorithms.QEomEE.run") | Execute the classical algorithm. | -| [`supports_aux_operators`](qiskit.chemistry.algorithms.QEomEE.supports_aux_operators#qiskit.chemistry.algorithms.QEomEE.supports_aux_operators "qiskit.chemistry.algorithms.QEomEE.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### compute\_minimum\_eigenvalue -## Attributes + + +`QEomEE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` + +Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** +`MinimumEigensolverResult` +**Returns** + +MinimumEigensolverResult + +### run + + + +`QEomEE.run()` + +Execute the classical algorithm. + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +### supports\_aux\_operators + + + +`classmethod QEomEE.supports_aux_operators()` + +Whether computing the expectation value of auxiliary operators is supported. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -46,7 +103,7 @@ QEomEE algorithm (classical) `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### filter\_criterion @@ -56,7 +113,7 @@ returns the filter criterion if set `Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] - + ### operator @@ -64,8 +121,9 @@ returns the filter criterion if set `Optional`\[`OperatorBase`] - + ### random Return a numpy random. + 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 a25022f21c3..3bdfaeaae9a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.QEomVQE.md @@ -1,8 +1,16 @@ -# QEomVQE +--- +title: QEomVQE +description: API reference for qiskit.chemistry.algorithms.QEomVQE +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.QEomVQE +--- +# 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)` +`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` @@ -36,26 +44,233 @@ QEomVQE algorithm ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| [`cleanup_parameterized_circuits`](qiskit.chemistry.algorithms.QEomVQE.cleanup_parameterized_circuits#qiskit.chemistry.algorithms.QEomVQE.cleanup_parameterized_circuits "qiskit.chemistry.algorithms.QEomVQE.cleanup_parameterized_circuits") | set parameterized circuits to None | -| [`compute_minimum_eigenvalue`](qiskit.chemistry.algorithms.QEomVQE.compute_minimum_eigenvalue#qiskit.chemistry.algorithms.QEomVQE.compute_minimum_eigenvalue "qiskit.chemistry.algorithms.QEomVQE.compute_minimum_eigenvalue") | Computes minimum eigenvalue. | -| [`construct_circuit`](qiskit.chemistry.algorithms.QEomVQE.construct_circuit#qiskit.chemistry.algorithms.QEomVQE.construct_circuit "qiskit.chemistry.algorithms.QEomVQE.construct_circuit") | Return the circuits used to compute the expectation value. | -| [`construct_expectation`](qiskit.chemistry.algorithms.QEomVQE.construct_expectation#qiskit.chemistry.algorithms.QEomVQE.construct_expectation "qiskit.chemistry.algorithms.QEomVQE.construct_expectation") | Generate the ansatz circuit and expectation value measurement, and return their runnable composition. | -| [`find_minimum`](qiskit.chemistry.algorithms.QEomVQE.find_minimum#qiskit.chemistry.algorithms.QEomVQE.find_minimum "qiskit.chemistry.algorithms.QEomVQE.find_minimum") | Optimize to find the minimum cost value. | -| [`get_optimal_circuit`](qiskit.chemistry.algorithms.QEomVQE.get_optimal_circuit#qiskit.chemistry.algorithms.QEomVQE.get_optimal_circuit "qiskit.chemistry.algorithms.QEomVQE.get_optimal_circuit") | Get the circuit with the optimal parameters. | -| [`get_optimal_cost`](qiskit.chemistry.algorithms.QEomVQE.get_optimal_cost#qiskit.chemistry.algorithms.QEomVQE.get_optimal_cost "qiskit.chemistry.algorithms.QEomVQE.get_optimal_cost") | Get the minimal cost or energy found by the VQE. | -| [`get_optimal_vector`](qiskit.chemistry.algorithms.QEomVQE.get_optimal_vector#qiskit.chemistry.algorithms.QEomVQE.get_optimal_vector "qiskit.chemistry.algorithms.QEomVQE.get_optimal_vector") | Get the simulation outcome of the optimal circuit. | -| [`get_prob_vector_for_params`](qiskit.chemistry.algorithms.QEomVQE.get_prob_vector_for_params#qiskit.chemistry.algorithms.QEomVQE.get_prob_vector_for_params "qiskit.chemistry.algorithms.QEomVQE.get_prob_vector_for_params") | Helper function to get probability vectors for a set of params | -| [`get_probabilities_for_counts`](qiskit.chemistry.algorithms.QEomVQE.get_probabilities_for_counts#qiskit.chemistry.algorithms.QEomVQE.get_probabilities_for_counts "qiskit.chemistry.algorithms.QEomVQE.get_probabilities_for_counts") | get probabilities for counts | -| [`print_settings`](qiskit.chemistry.algorithms.QEomVQE.print_settings#qiskit.chemistry.algorithms.QEomVQE.print_settings "qiskit.chemistry.algorithms.QEomVQE.print_settings") | Preparing the setting of VQE into a string. | -| [`run`](qiskit.chemistry.algorithms.QEomVQE.run#qiskit.chemistry.algorithms.QEomVQE.run "qiskit.chemistry.algorithms.QEomVQE.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.chemistry.algorithms.QEomVQE.set_backend#qiskit.chemistry.algorithms.QEomVQE.set_backend "qiskit.chemistry.algorithms.QEomVQE.set_backend") | Sets backend with configuration. | -| [`supports_aux_operators`](qiskit.chemistry.algorithms.QEomVQE.supports_aux_operators#qiskit.chemistry.algorithms.QEomVQE.supports_aux_operators "qiskit.chemistry.algorithms.QEomVQE.supports_aux_operators") | Whether computing the expectation value of auxiliary operators is supported. | +### cleanup\_parameterized\_circuits -## Attributes + + +`QEomVQE.cleanup_parameterized_circuits()` + +set parameterized circuits to None + +### compute\_minimum\_eigenvalue + + + +`QEomVQE.compute_minimum_eigenvalue(operator=None, aux_operators=None)` + +Computes minimum eigenvalue. Operator and aux\_operators can be supplied here and if not None will override any already set into algorithm so it can be reused with different operators. While an operator is required by algorithms, aux\_operators are optional. To ‘remove’ a previous aux\_operators array use an empty list here. + +**Parameters** + +* **operator** (`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]) – If not None replaces operator in algorithm +* **aux\_operators** (`Optional`\[`List`\[`Union`\[`OperatorBase`, `LegacyBaseOperator`, `None`]]]) – If not None replaces aux\_operators in algorithm + +**Return type** + +`MinimumEigensolverResult` + +**Returns** + +MinimumEigensolverResult + +### construct\_circuit + + + +`QEomVQE.construct_circuit(parameter)` + +Return the circuits used to compute the expectation value. + +**Parameters** + +**parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. + +**Return type** + +`List`\[`QuantumCircuit`] + +**Returns** + +A list of the circuits used to compute the expectation value. + +### construct\_expectation + + + +`QEomVQE.construct_expectation(parameter)` + +Generate the ansatz circuit and expectation value measurement, and return their runnable composition. + +**Parameters** + +**parameter** (`Union`\[`List`\[`float`], `List`\[`Parameter`], `ndarray`]) – Parameters for the ansatz circuit. +**Return type** + +`OperatorBase` + +**Returns** + +The Operator equalling the measurement of the ansatz `StateFn` by the Observable’s expectation `StateFn`. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If no operator has been provided. + +### find\_minimum + + + +`QEomVQE.find_minimum(initial_point=None, var_form=None, cost_fn=None, optimizer=None, gradient_fn=None)` + +Optimize to find the minimum cost value. + +**Parameters** + +* **initial\_point** (`Optional`\[`ndarray`]) – If not None will be used instead of any initial point supplied via constructor. If None and None was supplied to constructor then a random point will be used if the optimizer requires an initial point. +* **var\_form** (`Union`\[`QuantumCircuit`, `VariationalForm`, `None`]) – If not None will be used instead of any variational form supplied via constructor. +* **cost\_fn** (`Optional`\[`Callable`]) – If not None will be used instead of any cost\_fn supplied via constructor. +* **optimizer** (`Optional`\[`Optimizer`]) – If not None will be used instead of any optimizer supplied via constructor. +* **gradient\_fn** (`Optional`\[`Callable`]) – Optional gradient function for optimizer + +**Returns** + +Optimized variational parameters, and corresponding minimum cost value. + +**Return type** + +dict + +**Raises** + +**ValueError** – invalid input + +### get\_optimal\_circuit + + + +`QEomVQE.get_optimal_circuit()` + +Get the circuit with the optimal parameters. + +**Return type** + +`QuantumCircuit` + +### get\_optimal\_cost + + + +`QEomVQE.get_optimal_cost()` + +Get the minimal cost or energy found by the VQE. + +**Return type** +`float` + +### get\_optimal\_vector + + + +`QEomVQE.get_optimal_vector()` + +Get the simulation outcome of the optimal circuit. + +**Return type** + +`Union`\[`List`\[`float`], `Dict`\[`str`, `int`]] + +### get\_prob\_vector\_for\_params + + + +`QEomVQE.get_prob_vector_for_params(construct_circuit_fn, params_s, quantum_instance, construct_circuit_args=None)` + +Helper function to get probability vectors for a set of params + +### get\_probabilities\_for\_counts + + + +`QEomVQE.get_probabilities_for_counts(counts)` + +get probabilities for counts + +### print\_settings + + + +`QEomVQE.print_settings()` + +Preparing the setting of VQE into a string. + +**Returns** + +the formatted setting of VQE + +**Return type** + +str + +### run + + + +`QEomVQE.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`QEomVQE.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +### supports\_aux\_operators + + + +`classmethod QEomVQE.supports_aux_operators()` + +Whether computing the expectation value of auxiliary operators is supported. + +If the minimum eigensolver computes an eigenstate of the main operator then it can compute the expectation value of the aux\_operators for that state. Otherwise they will be ignored. + +**Return type** + +`bool` + +**Returns** + +True if aux\_operator expectations can be evaluated, False otherwise + +## Attributes + + ### aux\_operators @@ -65,7 +280,7 @@ Returns aux operators `Optional`\[`List`\[`Optional`\[`OperatorBase`]]] - + ### backend @@ -75,7 +290,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### expectation @@ -85,7 +300,7 @@ The expectation value algorithm used to construct the expectation measurement fr `ExpectationBase` - + ### initial\_point @@ -95,7 +310,7 @@ Returns initial point `Optional`\[`ndarray`] - + ### operator @@ -105,7 +320,7 @@ Returns operator `Optional`\[`OperatorBase`] - + ### optimal\_params @@ -115,7 +330,7 @@ The optimal parameters for the variational form. `List`\[`float`] - + ### optimizer @@ -125,7 +340,7 @@ Returns optimizer `Optional`\[`Optimizer`] - + ### quantum\_instance @@ -135,19 +350,19 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### setting Prepare the setting of VQE as a string. - + ### var\_form @@ -156,3 +371,4 @@ Returns variational form **Return type** `Union`\[`QuantumCircuit`, `VariationalForm`, `None`] + 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 1eff021fa82..25460147fc0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEAdapt.md @@ -1,8 +1,16 @@ -# VQEAdapt +--- +title: VQEAdapt +description: API reference for qiskit.chemistry.algorithms.VQEAdapt +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.VQEAdapt +--- +# 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)` +`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` @@ -31,21 +39,122 @@ See [https://arxiv.org/abs/1812.11173](https://arxiv.org/abs/1812.11173) ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | -| [`cleanup_parameterized_circuits`](qiskit.chemistry.algorithms.VQEAdapt.cleanup_parameterized_circuits#qiskit.chemistry.algorithms.VQEAdapt.cleanup_parameterized_circuits "qiskit.chemistry.algorithms.VQEAdapt.cleanup_parameterized_circuits") | set parameterized circuits to None | -| [`find_minimum`](qiskit.chemistry.algorithms.VQEAdapt.find_minimum#qiskit.chemistry.algorithms.VQEAdapt.find_minimum "qiskit.chemistry.algorithms.VQEAdapt.find_minimum") | Optimize to find the minimum cost value. | -| [`get_optimal_circuit`](qiskit.chemistry.algorithms.VQEAdapt.get_optimal_circuit#qiskit.chemistry.algorithms.VQEAdapt.get_optimal_circuit "qiskit.chemistry.algorithms.VQEAdapt.get_optimal_circuit") | get optimal circuit | -| [`get_optimal_cost`](qiskit.chemistry.algorithms.VQEAdapt.get_optimal_cost#qiskit.chemistry.algorithms.VQEAdapt.get_optimal_cost "qiskit.chemistry.algorithms.VQEAdapt.get_optimal_cost") | get optimal cost | -| [`get_optimal_vector`](qiskit.chemistry.algorithms.VQEAdapt.get_optimal_vector#qiskit.chemistry.algorithms.VQEAdapt.get_optimal_vector "qiskit.chemistry.algorithms.VQEAdapt.get_optimal_vector") | get optimal vector | -| [`get_prob_vector_for_params`](qiskit.chemistry.algorithms.VQEAdapt.get_prob_vector_for_params#qiskit.chemistry.algorithms.VQEAdapt.get_prob_vector_for_params "qiskit.chemistry.algorithms.VQEAdapt.get_prob_vector_for_params") | Helper function to get probability vectors for a set of params | -| [`get_probabilities_for_counts`](qiskit.chemistry.algorithms.VQEAdapt.get_probabilities_for_counts#qiskit.chemistry.algorithms.VQEAdapt.get_probabilities_for_counts "qiskit.chemistry.algorithms.VQEAdapt.get_probabilities_for_counts") | get probabilities for counts | -| [`run`](qiskit.chemistry.algorithms.VQEAdapt.run#qiskit.chemistry.algorithms.VQEAdapt.run "qiskit.chemistry.algorithms.VQEAdapt.run") | Execute the algorithm with selected backend. | -| [`set_backend`](qiskit.chemistry.algorithms.VQEAdapt.set_backend#qiskit.chemistry.algorithms.VQEAdapt.set_backend "qiskit.chemistry.algorithms.VQEAdapt.set_backend") | Sets backend with configuration. | +### cleanup\_parameterized\_circuits -## Attributes + + +`VQEAdapt.cleanup_parameterized_circuits()` + +set parameterized circuits to None + +### find\_minimum + + + +`VQEAdapt.find_minimum(initial_point=None, var_form=None, cost_fn=None, optimizer=None, gradient_fn=None)` + +Optimize to find the minimum cost value. + +**Parameters** + +* **initial\_point** (`Optional`\[`ndarray`]) – If not None will be used instead of any initial point supplied via constructor. If None and None was supplied to constructor then a random point will be used if the optimizer requires an initial point. +* **var\_form** (`Union`\[`QuantumCircuit`, `VariationalForm`, `None`]) – If not None will be used instead of any variational form supplied via constructor. +* **cost\_fn** (`Optional`\[`Callable`]) – If not None will be used instead of any cost\_fn supplied via constructor. +* **optimizer** (`Optional`\[`Optimizer`]) – If not None will be used instead of any optimizer supplied via constructor. +* **gradient\_fn** (`Optional`\[`Callable`]) – Optional gradient function for optimizer + +**Returns** + +Optimized variational parameters, and corresponding minimum cost value. + +**Return type** + +dict + +**Raises** + +**ValueError** – invalid input + +### get\_optimal\_circuit + + + +`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 + +### get\_optimal\_cost + + + +`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 + +### get\_optimal\_vector + + + +`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 + +### get\_prob\_vector\_for\_params + + + +`VQEAdapt.get_prob_vector_for_params(construct_circuit_fn, params_s, quantum_instance, construct_circuit_args=None)` +Helper function to get probability vectors for a set of params +### get\_probabilities\_for\_counts + + + +`VQEAdapt.get_probabilities_for_counts(counts)` + +get probabilities for counts + +### run + + + +`VQEAdapt.run(quantum_instance=None, **kwargs)` + +Execute the algorithm with selected backend. + +**Parameters** + +* **quantum\_instance** (`Union`\[`QuantumInstance`, `Backend`, `BaseBackend`, `None`]) – the experimental setting. +* **kwargs** (*dict*) – kwargs + +**Returns** + +results of an algorithm. + +**Return type** + +dict + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If a quantum instance or backend has not been provided + +### set\_backend + + + +`VQEAdapt.set_backend(backend, **kwargs)` + +Sets backend with configuration. + +**Return type** + +`None` + +## Attributes + + ### backend @@ -55,7 +164,7 @@ Returns backend. `Union`\[`Backend`, `BaseBackend`] - + ### initial\_point @@ -65,11 +174,11 @@ Returns initial point `Optional`\[`ndarray`] - + ### optimal\_params - + ### optimizer @@ -79,7 +188,7 @@ Returns optimizer `Optional`\[`Optimizer`] - + ### quantum\_instance @@ -89,13 +198,13 @@ Returns quantum instance. `Optional`\[`QuantumInstance`] - + ### random Return a numpy random. - + ### var\_form @@ -104,3 +213,4 @@ Returns variational form **Return type** `Union`\[`QuantumCircuit`, `VariationalForm`, `None`] + 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 4445a25b8e1..8d20352d9dc 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUCCSDFactory.md @@ -1,8 +1,16 @@ -# VQEUCCSDFactory +--- +title: VQEUCCSDFactory +description: API reference for qiskit.chemistry.algorithms.VQEUCCSDFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.VQEUCCSDFactory +--- +# 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)` +`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` @@ -14,7 +22,7 @@ A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. * **optimizer** (`Optional`\[`Optimizer`]) – A classical optimizer. * **initial\_point** (`Optional`\[`ndarray`]) – An optional initial point (i.e. initial parameter values) for the optimizer. If `None` then VQE will look to the variational form for a preferred point and if not will simply compute a random one. * **gradient** (`Union`\[`GradientBase`, `Callable`, `None`]) – An optional gradient function or operator for optimizer. -* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When `None` (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory#qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). +* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When `None` (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). * **include\_custom** (`bool`) – When expectation parameter here is None setting this to `True` will allow the factory to include the custom Aer pauli expectation. * **method\_singles** (`str`) – specify the single excitation considered. ‘alpha’, ‘beta’, ‘both’ only alpha or beta spin-orbital single excitations or both (all of them). * **method\_doubles** (`str`) – specify the single excitation considered. ‘ucc’ (conventional ucc), succ (singlet ucc), succ\_full (singlet ucc full), pucc (pair ucc). @@ -23,14 +31,41 @@ A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| [`get_solver`](qiskit.chemistry.algorithms.VQEUCCSDFactory.get_solver#qiskit.chemistry.algorithms.VQEUCCSDFactory.get_solver "qiskit.chemistry.algorithms.VQEUCCSDFactory.get_solver") | Returns a VQE with a UCCSD wavefunction ansatz, based on `transformation`. | -| [`supports_aux_operators`](qiskit.chemistry.algorithms.VQEUCCSDFactory.supports_aux_operators#qiskit.chemistry.algorithms.VQEUCCSDFactory.supports_aux_operators "qiskit.chemistry.algorithms.VQEUCCSDFactory.supports_aux_operators") | Returns whether the eigensolver generated by this factory supports auxiliary operators. | +### get\_solver -## Attributes + + +`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`. + +**Parameters** + +**transformation** (`Transformation`) – a fermionic qubit operator transformation. + +**Return type** + +`MinimumEigensolver` + +**Returns** + +A VQE suitable to compute the ground state of the molecule transformed by `transformation`. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – in case a Transformation of wrong type is given. +### supports\_aux\_operators + + +`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. + +## Attributes + + ### excitation\_type @@ -40,7 +75,7 @@ Getter of the `excitation_type` setting for the `excitation_type` setting. `str` - + ### expectation @@ -50,7 +85,7 @@ Getter of the expectation. `ExpectationBase` - + ### gradient @@ -60,7 +95,7 @@ Getter of the gradient function `Union`\[`GradientBase`, `Callable`, `None`] - + ### include\_custom @@ -70,7 +105,7 @@ Getter of the `include_custom` setting for the `expectation` setting. `bool` - + ### initial\_point @@ -80,7 +115,7 @@ Getter of the initial point. `ndarray` - + ### method\_doubles @@ -90,7 +125,7 @@ Getter of the `method_doubles` setting for the `method_doubles` setting. `str` - + ### method\_singles @@ -100,7 +135,7 @@ Getter of the `method_singles` setting for the `method_singles` setting. `str` - + ### optimizer @@ -110,7 +145,7 @@ Getter of the optimizer. `Optimizer` - + ### quantum\_instance @@ -120,7 +155,7 @@ Getter of the quantum instance. `QuantumInstance` - + ### same\_spin\_doubles @@ -129,3 +164,4 @@ Getter of the `same_spin_doubles` setting for the `same_spin_doubles` setting. **Return type** `bool` + 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 d544d41a307..db186bdd442 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.VQEUVCCSDFactory.md @@ -1,8 +1,16 @@ -# VQEUVCCSDFactory +--- +title: VQEUVCCSDFactory +description: API reference for qiskit.chemistry.algorithms.VQEUVCCSDFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.VQEUVCCSDFactory +--- +# VQEUVCCSDFactory + -`VQEUVCCSDFactory(quantum_instance, optimizer=None, initial_point=None, gradient=None, expectation=None, include_custom=False)` +`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` @@ -14,19 +22,42 @@ A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction * **optimizer** (`Optional`\[`Optimizer`]) – A classical optimizer. * **initial\_point** (`Optional`\[`ndarray`]) – An optional initial point (i.e. initial parameter values) for the optimizer. If `None` then VQE will look to the variational form for a preferred point and if not will simply compute a random one. * **gradient** (`Union`\[`GradientBase`, `Callable`, `None`]) – An optional gradient function or operator for optimizer. -* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When `None` (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory#qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). +* **expectation** (`Optional`\[`ExpectationBase`]) – The Expectation converter for taking the average value of the Observable over the var\_form state function. When `None` (the default) an [`ExpectationFactory`](qiskit.aqua.operators.expectations.ExpectationFactory "qiskit.aqua.operators.expectations.ExpectationFactory") is used to select an appropriate expectation based on the operator and backend. When using Aer qasm\_simulator backend, with paulis, it is however much faster to leverage custom Aer function for the computation but, although VQE performs much faster with it, the outcome is ideal, with no shot noise, like using a state vector simulator. If you are just looking for the quickest performance when choosing Aer qasm\_simulator and the lack of shot noise is not an issue then set include\_custom parameter here to `True` (defaults to `False`). * **include\_custom** (`bool`) – When expectation parameter here is None setting this to `True` will allow the factory to include the custom Aer pauli expectation. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| [`get_solver`](qiskit.chemistry.algorithms.VQEUVCCSDFactory.get_solver#qiskit.chemistry.algorithms.VQEUVCCSDFactory.get_solver "qiskit.chemistry.algorithms.VQEUVCCSDFactory.get_solver") | Returns a VQE with a UVCCSD wavefunction ansatz, based on `transformation`. | -| [`supports_aux_operators`](qiskit.chemistry.algorithms.VQEUVCCSDFactory.supports_aux_operators#qiskit.chemistry.algorithms.VQEUVCCSDFactory.supports_aux_operators "qiskit.chemistry.algorithms.VQEUVCCSDFactory.supports_aux_operators") | Returns whether the eigensolver generated by this factory supports auxiliary operators. | +### get\_solver -## Attributes + + +`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`. + +**Parameters** + +**transformation** (`BosonicTransformation`) – a bosonic qubit operator transformation. + +**Return type** + +`MinimumEigensolver` + +**Returns** +A VQE suitable to compute the ground state of the molecule transformed by `transformation`. +### supports\_aux\_operators + + + +`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. + +## Attributes + + ### expectation @@ -36,7 +67,7 @@ Getter of the expectation. `ExpectationBase` - + ### gradient @@ -46,7 +77,7 @@ Getter of the gradient function `Union`\[`GradientBase`, `Callable`, `None`] - + ### include\_custom @@ -56,7 +87,7 @@ Getter of the `include_custom` setting for the `expectation` setting. `bool` - + ### initial\_point @@ -66,7 +97,7 @@ Getter of the initial point. `ndarray` - + ### optimizer @@ -76,7 +107,7 @@ Getter of the optimizer. `Optimizer` - + ### quantum\_instance @@ -85,3 +116,4 @@ Getter of the quantum instance. **Return type** `QuantumInstance` + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.md index b3f9fa6edd0..cadbcb54e0c 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.md @@ -20,7 +20,7 @@ These are chemistry specific algorithms for Aqua. As they rely on chemistry spec # Chemistry Algorithms -These are algorithms configured and/or functioning using chemistry specific knowledge. See also the Aqua [`algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms") for other algorithms in these categories which may also be used for chemistry problems such as [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"). +These are algorithms configured and/or functioning using chemistry specific knowledge. See also the Aqua [`algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms") for other algorithms in these categories which may also be used for chemistry problems such as [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"). ## Eigensolvers @@ -28,10 +28,10 @@ Algorithms that can find the eigenvalues of an operator, i.e. excited states for **DEPRECATED** See the Excited States Solvers section below -| | | -| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`QEomVQE`](qiskit.chemistry.algorithms.QEomVQE#qiskit.chemistry.algorithms.QEomVQE "qiskit.chemistry.algorithms.QEomVQE") | QEomVQE algorithm | -| [`QEomEE`](qiskit.chemistry.algorithms.QEomEE#qiskit.chemistry.algorithms.QEomEE "qiskit.chemistry.algorithms.QEomEE") | QEomEE algorithm (classical) | +| | | +| -------------------------------------------------------------------------------------- | ---------------------------- | +| [`QEomVQE`](qiskit.chemistry.algorithms.QEomVQE "qiskit.chemistry.algorithms.QEomVQE") | QEomVQE algorithm | +| [`QEomEE`](qiskit.chemistry.algorithms.QEomEE "qiskit.chemistry.algorithms.QEomEE") | QEomEE algorithm (classical) | ## Excited State Solvers @@ -39,23 +39,23 @@ Algorithms that can find the eigenvalues of an operator, i.e. excited states for The interface for such solvers, -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`ExcitedStatesSolver`](qiskit.chemistry.algorithms.ExcitedStatesSolver#qiskit.chemistry.algorithms.ExcitedStatesSolver "qiskit.chemistry.algorithms.ExcitedStatesSolver") | The excited states calculation interface | +| | | +| -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| [`ExcitedStatesSolver`](qiskit.chemistry.algorithms.ExcitedStatesSolver "qiskit.chemistry.algorithms.ExcitedStatesSolver") | The excited states calculation interface | the solvers themselves -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | -| [`ExcitedStatesEigensolver`](qiskit.chemistry.algorithms.ExcitedStatesEigensolver#qiskit.chemistry.algorithms.ExcitedStatesEigensolver "qiskit.chemistry.algorithms.ExcitedStatesEigensolver") | The calculation of excited states via an Eigensolver algorithm | -| [`QEOM`](qiskit.chemistry.algorithms.QEOM#qiskit.chemistry.algorithms.QEOM "qiskit.chemistry.algorithms.QEOM") | The calculation of excited states via the qEOM algorithm | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| [`ExcitedStatesEigensolver`](qiskit.chemistry.algorithms.ExcitedStatesEigensolver "qiskit.chemistry.algorithms.ExcitedStatesEigensolver") | The calculation of excited states via an Eigensolver algorithm | +| [`QEOM`](qiskit.chemistry.algorithms.QEOM "qiskit.chemistry.algorithms.QEOM") | The calculation of excited states via the qEOM algorithm | and factories to provision Quantum and/or Classical algorithms upon which the above solvers may depend -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ | -| [`EigensolverFactory`](qiskit.chemistry.algorithms.EigensolverFactory#qiskit.chemistry.algorithms.EigensolverFactory "qiskit.chemistry.algorithms.EigensolverFactory") | A factory to construct a eigensolver based on a qubit operator transformation. | -| [`NumPyEigensolverFactory`](qiskit.chemistry.algorithms.NumPyEigensolverFactory#qiskit.chemistry.algorithms.NumPyEigensolverFactory "qiskit.chemistry.algorithms.NumPyEigensolverFactory") | A factory to construct a NumPyEigensolver. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | +| [`EigensolverFactory`](qiskit.chemistry.algorithms.EigensolverFactory "qiskit.chemistry.algorithms.EigensolverFactory") | A factory to construct a eigensolver based on a qubit operator transformation. | +| [`NumPyEigensolverFactory`](qiskit.chemistry.algorithms.NumPyEigensolverFactory "qiskit.chemistry.algorithms.NumPyEigensolverFactory") | A factory to construct a NumPyEigensolver. | ## Ground State Solvers @@ -63,26 +63,26 @@ Algorithms that can find the minimum eigenvalue of an operator, i.e. ground stat The interface for such solvers, -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------- | -| [`GroundStateSolver`](qiskit.chemistry.algorithms.GroundStateSolver#qiskit.chemistry.algorithms.GroundStateSolver "qiskit.chemistry.algorithms.GroundStateSolver") | The ground state calculation interface | +| | | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | +| [`GroundStateSolver`](qiskit.chemistry.algorithms.GroundStateSolver "qiskit.chemistry.algorithms.GroundStateSolver") | The ground state calculation interface | the solvers themselves -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`AdaptVQE`](qiskit.chemistry.algorithms.AdaptVQE#qiskit.chemistry.algorithms.AdaptVQE "qiskit.chemistry.algorithms.AdaptVQE") | A ground state calculation employing the AdaptVQE algorithm. | -| [`GroundStateEigensolver`](qiskit.chemistry.algorithms.GroundStateEigensolver#qiskit.chemistry.algorithms.GroundStateEigensolver "qiskit.chemistry.algorithms.GroundStateEigensolver") | Ground state computation using a minimum eigensolver. | -| [`OrbitalOptimizationVQE`](qiskit.chemistry.algorithms.OrbitalOptimizationVQE#qiskit.chemistry.algorithms.OrbitalOptimizationVQE "qiskit.chemistry.algorithms.OrbitalOptimizationVQE") | A ground state calculation employing the OOVQE algorithm. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [`AdaptVQE`](qiskit.chemistry.algorithms.AdaptVQE "qiskit.chemistry.algorithms.AdaptVQE") | A ground state calculation employing the AdaptVQE algorithm. | +| [`GroundStateEigensolver`](qiskit.chemistry.algorithms.GroundStateEigensolver "qiskit.chemistry.algorithms.GroundStateEigensolver") | Ground state computation using a minimum eigensolver. | +| [`OrbitalOptimizationVQE`](qiskit.chemistry.algorithms.OrbitalOptimizationVQE "qiskit.chemistry.algorithms.OrbitalOptimizationVQE") | A ground state calculation employing the OOVQE algorithm. | and factories to provision Quantum and/or Classical algorithms upon which the above solvers may depend -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| [`MinimumEigensolverFactory`](qiskit.chemistry.algorithms.MinimumEigensolverFactory#qiskit.chemistry.algorithms.MinimumEigensolverFactory "qiskit.chemistry.algorithms.MinimumEigensolverFactory") | A factory to construct a minimum eigensolver based on a qubit operator transformation. | -| [`NumPyMinimumEigensolverFactory`](qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory#qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory "qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory") | A factory to construct a NumPyMinimumEigensolver. | -| [`VQEUCCSDFactory`](qiskit.chemistry.algorithms.VQEUCCSDFactory#qiskit.chemistry.algorithms.VQEUCCSDFactory "qiskit.chemistry.algorithms.VQEUCCSDFactory") | A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. | -| [`VQEUVCCSDFactory`](qiskit.chemistry.algorithms.VQEUVCCSDFactory#qiskit.chemistry.algorithms.VQEUVCCSDFactory "qiskit.chemistry.algorithms.VQEUVCCSDFactory") | A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| [`MinimumEigensolverFactory`](qiskit.chemistry.algorithms.MinimumEigensolverFactory "qiskit.chemistry.algorithms.MinimumEigensolverFactory") | A factory to construct a minimum eigensolver based on a qubit operator transformation. | +| [`NumPyMinimumEigensolverFactory`](qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory "qiskit.chemistry.algorithms.NumPyMinimumEigensolverFactory") | A factory to construct a NumPyMinimumEigensolver. | +| [`VQEUCCSDFactory`](qiskit.chemistry.algorithms.VQEUCCSDFactory "qiskit.chemistry.algorithms.VQEUCCSDFactory") | A factory to construct a VQE minimum eigensolver with UCCSD ansatz wavefunction. | +| [`VQEUVCCSDFactory`](qiskit.chemistry.algorithms.VQEUVCCSDFactory "qiskit.chemistry.algorithms.VQEUVCCSDFactory") | A factory to construct a VQE minimum eigensolver with UVCCSD ansatz wavefunction. | ## Minimum Eigensolvers @@ -90,17 +90,17 @@ Algorithms that can find the minimum eigenvalue of an operator, i.e. ground stat **DEPRECATED** See the Ground State Solvers section above -| | | -| ------------------------------------------------------------------------------------------------------------------------------ | ----------- | -| [`VQEAdapt`](qiskit.chemistry.algorithms.VQEAdapt#qiskit.chemistry.algorithms.VQEAdapt "qiskit.chemistry.algorithms.VQEAdapt") | DEPRECATED. | +| | | +| ----------------------------------------------------------------------------------------- | ----------- | +| [`VQEAdapt`](qiskit.chemistry.algorithms.VQEAdapt "qiskit.chemistry.algorithms.VQEAdapt") | DEPRECATED. | ## Potential Energy Surface Samplers Algorithms that can compute potential energy surfaces. -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`BOPESSampler`](qiskit.chemistry.algorithms.BOPESSampler#qiskit.chemistry.algorithms.BOPESSampler "qiskit.chemistry.algorithms.BOPESSampler") | Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). | +| | | +| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [`BOPESSampler`](qiskit.chemistry.algorithms.BOPESSampler "qiskit.chemistry.algorithms.BOPESSampler") | Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). | The samplers include extrapolators to facilitate convergence across a set of points and support of various potentials. More detail may be found in the sub-module linked below 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 45d33e99a9c..9c6a5773253 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 @@ -1,8 +1,16 @@ -# BOPESSampler +--- +title: BOPESSampler +description: API reference for qiskit.chemistry.algorithms.pes_samplers.BOPESSampler +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.BOPESSampler +--- +# BOPESSampler + -`BOPESSampler(gss, tolerance=0.001, bootstrap=True, num_bootstrap=None, extrapolator=None)` +`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` @@ -18,10 +26,32 @@ Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If `num_boostrap` is an integer smaller than 2, or if `num_boostrap` is larger than 2 and the extrapolator is not an instance of `WindowExtrapolator`. +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – If `num_boostrap` is an integer smaller than 2, or if `num_boostrap` is larger than 2 and the extrapolator is not an instance of `WindowExtrapolator`. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`sample`](qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.sample#qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.sample "qiskit.chemistry.algorithms.pes_samplers.BOPESSampler.sample") | Run the sampler at the given points, potentially with repetitions. | +### sample + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – BaseDriver specific for the problem. The driver should be based on a Molecule object that has perturbations to be varied. +* **points** (`List`\[`float`]) – The points along the degrees of freedom to evaluate. + +**Return type** + +`BOPESSamplerResult` + +**Returns** + +BOPES Sampler Result + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if the driver does not have a molecule specified. + 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 d1ddc045101..6e977f009de 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 @@ -1,8 +1,16 @@ -# DifferentialExtrapolator +--- +title: DifferentialExtrapolator +description: API reference for qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator +--- +# DifferentialExtrapolator + -`DifferentialExtrapolator(degree=1, model=None)` +`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` @@ -17,7 +25,50 @@ Constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | -| [`extrapolate`](qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.extrapolate#qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.extrapolate "qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.extrapolate") | Extrapolate at specified point of interest given a set of variational parameters. | -| [`factory`](qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.factory#qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.factory "qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator.factory") | Factory method for constructing extrapolators. | +### extrapolate + + + +`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. + +**Parameters** + +* **points** (`List`\[`float`]) – List of point(s) to be used for extrapolation. Can represent some degree of freedom, ex, interatomic distance. +* **param\_dict** (`Optional`\[`Dict`\[`float`, `List`\[`float`]]]) – Dictionary of variational parameters. Each key is the point +* **the value is a list of the variational parameters.** (*and*) – + +**Return type** + +`Dict`\[`float`, `List`\[`float`]] + +**Returns** + +Dictionary of variational parameters for extrapolated point(s). + +### factory + + + +`static DifferentialExtrapolator.factory(mode, **kwargs)` + +Factory method for constructing extrapolators. + +**Parameters** + +* **mode** (`str`) – Extrapolator to instantiate. Can be one of: - ‘window’ - ‘poly’ - ‘diff\_model’ - ‘pca’ - ‘l1’ +* **kwargs** – arguments to be passed to the constructor of an extrapolator + +**Return type** + +`Extrapolator` + +**Returns** + +A newly created extrapolator instance. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if specified mode is unknown. + 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 02d5b47384f..8d04afed4fd 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 @@ -1,8 +1,16 @@ -# EnergySurface1DSpline +--- +title: EnergySurface1DSpline +description: API reference for qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline +--- +# EnergySurface1DSpline + -`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") Bases: `qiskit.chemistry.algorithms.pes_samplers.potentials.potential_base.EnergySurfaceBase` @@ -14,10 +22,92 @@ This allows for fitting BOPES sampler results or potential energy surfaces. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | -| [`eval`](qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.eval#qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.eval "qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.eval") | After fitting the data to the fit function, predict the energy at a point x. | -| [`fit`](qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.fit#qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.fit "qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.fit") | Fits surface to data. | -| [`get_equilibrium_geometry`](qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_equilibrium_geometry#qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_equilibrium_geometry "qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_equilibrium_geometry") | Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. | -| [`get_minimal_energy`](qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_minimal_energy#qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_minimal_energy "qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_minimal_energy") | Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. | -| [`get_trust_region`](qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_trust_region#qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_trust_region "qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline.get_trust_region") | Get the trust region. | +### eval + + + +`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. + +**Parameters** + +**x** (`float`) – Value to be evaluated + +**Return type** + +`float` + +**Returns** + +Value of surface fit in point x. + +### fit + + + +`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. + +**Parameters** + +* **xdata** (`List`\[`float`]) – x data to be fitted +* **ydata** (`List`\[`float`]) – y data to be fitted +* **initial\_vals** (`Optional`\[`List`\[`float`]]) – Initial values for fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) +* **bounds\_list** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – Bounds for the fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) + +**Return type** + +`None` + +### get\_equilibrium\_geometry + + + +`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 + +**Return type** + +`float` + +**Returns** + +equilibrium geometry + +### get\_minimal\_energy + + + +`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 + +**Return type** + +`float` + +**Returns** + +minimum energy + +### get\_trust\_region + + + +`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. + +Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). + +**Return type** + +`Tuple`\[`float`, `float`] + +**Returns** + +The trust region between bounds. + 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 ab261f13832..589d66f534e 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 @@ -1,8 +1,16 @@ -# EnergySurfaceBase +--- +title: EnergySurfaceBase +description: API reference for qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase +--- +# EnergySurfaceBase + -`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") Bases: `abc.ABC` @@ -10,10 +18,104 @@ Class to hold a potential energy surface ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`eval`](qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.eval#qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.eval "qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.eval") | After fitting the data to the fit function, predict the energy at a point x. | -| [`fit`](qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.fit#qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.fit "qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.fit") | Fits surface to data | -| [`get_equilibrium_geometry`](qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_equilibrium_geometry#qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_equilibrium_geometry "qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_equilibrium_geometry") | Get the equilibrium energy. | -| [`get_minimal_energy`](qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_minimal_energy#qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_minimal_energy "qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_minimal_energy") | Get the minimal energy. | -| [`get_trust_region`](qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_trust_region#qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_trust_region "qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase.get_trust_region") | Get the trust region. | +### eval + + + +`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. + +**Parameters** + +**x** (`float`) – value to evaluate surface in + +**Return type** + +`float` + +**Returns** + +value of surface in point x + +### fit + + + +`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 + +**Parameters** + +* **xdata** (`List`\[`float`]) – x data to be fitted +* **ydata** (`List`\[`float`]) – y data to be fitted +* **initial\_vals** (`Optional`\[`List`\[`float`]]) – Initial values for fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) +* **bounds\_list** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – Bounds for the fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) + +**Return type** + +`None` + +### get\_equilibrium\_geometry + + + +`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. + +Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. + +**Parameters** + +**scaling** (`float`) – scaling factor + +**Return type** + +`float` + +**Returns** + +equilibrium geometry + +### get\_minimal\_energy + + + +`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. + +Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. + +**Parameters** + +**scaling** (`float`) – scaling factor + +**Return type** + +`float` + +**Returns** + +minimum energy + +### get\_trust\_region + + + +`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. + +Returns the bounds of the region (in space) where the energy surface implementation can be trusted. When doing spline interpolation, for example, that would be the region where data is interpolated (vs. extrapolated) from the arguments of fit(). + +**Return type** + +`Tuple`\[`float`, `float`] + +**Returns** + +the trust region between bounds + 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 cba9c53988c..12098ea57e2 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 @@ -1,8 +1,16 @@ -# Extrapolator +--- +title: Extrapolator +description: API reference for qiskit.chemistry.algorithms.pes_samplers.Extrapolator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.Extrapolator +--- +# Extrapolator + -`Extrapolator` +`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` @@ -14,7 +22,49 @@ There are two types of Extrapolators: external/wrapper and internal. The externa ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | -| [`extrapolate`](qiskit.chemistry.algorithms.pes_samplers.Extrapolator.extrapolate#qiskit.chemistry.algorithms.pes_samplers.Extrapolator.extrapolate "qiskit.chemistry.algorithms.pes_samplers.Extrapolator.extrapolate") | Abstract method to extrapolate point(s) of interest. | -| [`factory`](qiskit.chemistry.algorithms.pes_samplers.Extrapolator.factory#qiskit.chemistry.algorithms.pes_samplers.Extrapolator.factory "qiskit.chemistry.algorithms.pes_samplers.Extrapolator.factory") | Factory method for constructing extrapolators. | +### extrapolate + + + +`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. + +**Parameters** + +* **points** (`List`\[`float`]) – List of point(s) to be used for extrapolation. Can represent some degree of freedom, ex, interatomic distance. +* **param\_dict** (`Dict`\[`float`, `List`\[`float`]]) – Dictionary of variational parameters. Each key is the point and the value is a list of the variational parameters. + +**Return type** + +`Dict`\[`float`, `List`\[`float`]] + +**Returns** + +Dictionary of variational parameters for extrapolated point(s). + +### factory + + + +`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. + +**Parameters** + +* **mode** (`str`) – Extrapolator to instantiate. Can be one of: - ‘window’ - ‘poly’ - ‘diff\_model’ - ‘pca’ - ‘l1’ +* **kwargs** – arguments to be passed to the constructor of an extrapolator + +**Return type** + +`Extrapolator` + +**Returns** + +A newly created extrapolator instance. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if specified mode is unknown. + 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 dae59e9c75b..7916ddc3e05 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 @@ -1,8 +1,16 @@ -# HarmonicPotential +--- +title: HarmonicPotential +description: API reference for qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential +--- +# HarmonicPotential + -`HarmonicPotential(molecule)` +`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` @@ -20,19 +28,264 @@ Input units are Angstroms (distance between the two atoms), and output units are ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| [`dissociation_energy`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.dissociation_energy#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.dissociation_energy "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.dissociation_energy") | Returns the estimated dissociation energy for the current fit. | -| [`eval`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.eval#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.eval "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.eval") | After fitting the data to the fit function, predict the energy at a point x. | -| [`fit`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fit#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fit "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fit") | Fits a potential to computed molecular energies. | -| [`fit_function`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fit_function#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fit_function "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fit_function") | Functional form of the potential. | -| [`fundamental_frequency`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fundamental_frequency#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fundamental_frequency "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.fundamental_frequency") | Returns the fundamental frequency for the current fit (in s^-1). | -| [`get_equilibrium_geometry`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_equilibrium_geometry#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_equilibrium_geometry "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_equilibrium_geometry") | Returns the interatomic distance corresponding to minimal energy. | -| [`get_maximum_trusted_level`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_maximum_trusted_level#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_maximum_trusted_level "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_maximum_trusted_level") | Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. | -| [`get_minimal_energy`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_minimal_energy#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_minimal_energy "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_minimal_energy") | Returns the smallest molecular energy for the current fit. | -| [`get_num_modes`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_num_modes#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_num_modes "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_num_modes") | This (1D) potential represents a single vibrational mode | -| [`get_trust_region`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_trust_region#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_trust_region "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.get_trust_region") | The potential will usually be well-defined (even if not useful) for arbitrary x so we return a fairly large interval here. | -| [`process_fit_data`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.process_fit_data#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.process_fit_data "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.process_fit_data") | Mostly for internal use. Preprocesses the data passed to fit\_to\_data() | -| [`update_molecule`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.update_molecule#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.update_molecule "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.update_molecule") | Updates the underlying molecule. | -| [`vibrational_energy_level`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.vibrational_energy_level#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.vibrational_energy_level "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.vibrational_energy_level") | Returns the n-th vibrational energy level for the current fit (in Hartrees). | -| [`wave_number`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.wave_number#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.wave_number "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential.wave_number") | Returns the wave number for the current fit (in cm^-1). | +### dissociation\_energy + + + +`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. + +**Parameters** + +**scaling** (`float`) – Scaling to change units. (Default is 1.0 for Hartrees) + +**Return type** + +`float` + +**Returns** + +estimated dissociation energy + +### eval + + + +`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. + +**Parameters** + +**x** (`float`) – value to evaluate surface in + +**Return type** + +`float` + +**Returns** + +value of potential in point x + +### fit + + + +`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. + +**Parameters** + +* **xdata** (`List`\[`float`]) – interatomic distance points (Angstroms) +* **ydata** (`List`\[`float`]) – molecular energies (Hartrees) +* **initial\_vals** (`Optional`\[`List`\[`float`]]) – Initial values for fit parameters. None for default. Order of parameters is k, r\_0 and m\_shift (see fit\_function implementation) +* **bounds\_list** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – Bounds for the fit parameters. None for default. Order of parameters is k, r\_0 and m\_shift (see fit\_function implementation) + +**Return type** + +`None` + +### fit\_function + + + +`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. + +**Parameters** + +* **x** (`float`) – x parameter of harmonic potential functional form +* **k** (`float`) – k parameter of harmonic potential functional form +* **r\_0** (`float`) – r\_0 parameter of harmonic potential functional form +* **m\_shift** (`float`) – m parameter of harmonic potential functional form + +**Return type** + +`float` + +**Returns** + +harmonic potential functional form + +### fundamental\_frequency + + + +`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). + +**Return type** + +`float` + +**Returns** + +fundamental frequency for the current fit + +### get\_equilibrium\_geometry + + + +`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. + +**Parameters** + +**scaling** (`float`) – Scaling to change units. (Default is 1.0 for Angstroms) + +**Return type** + +`float` + +**Returns** + +geometry corresponding to minimal energy + +### get\_maximum\_trusted\_level + + + +`HarmonicPotential.get_maximum_trusted_level(n=0)` + +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). + +**Parameters** + +**n** (`int`) – vibronic mode + +**Return type** + +`float` + +**Returns** + +maximum\_trusted\_level setted + +### get\_minimal\_energy + + + +`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. + +**Parameters** + +**scaling** (`float`) – Scaling to change units. (Default is 1.0 for Hartrees) + +**Return type** + +`float` + +**Returns** + +smallest molecular energy for the current fit + +### get\_num\_modes + + + +`HarmonicPotential.get_num_modes()` + +This (1D) potential represents a single vibrational mode + +**Return type** + +`int` + +### get\_trust\_region + + + +`HarmonicPotential.get_trust_region()` + +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. + +**Return type** + +`Tuple`\[`float`, `float`] + +### process\_fit\_data + + + +`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() + +so that only the points around the minimum are fit (which gives more accurate vibrational modes). + +**Parameters** + +* **xdata** (`List`\[`float`]) – xdata to be considered +* **ydata** (`List`\[`float`]) – ydata to be considered + +**Return type** + +`Tuple`\[`list`, `list`] + +**Returns** + +the processed data that fit better to a harmonic potential + +### update\_molecule + + + +`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. + +**Parameters** + +**molecule** (`Molecule`) – chemistry molecule + +**Raises** + +**ValueError** – Only implemented for diatomic molecules + +**Return type** + +`Molecule` + +### vibrational\_energy\_level + + + +`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). + +**Parameters** + +**n** (`int`) – vibrational mode + +**Return type** + +`float` + +**Returns** + +vibrational energy level for the current fit + +### wave\_number + + + +`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). + +**Return type** + +`int` + +**Returns** + +wave number for the current fit + 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 ae80d2eeb49..39f5a6ac5fd 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 @@ -1,8 +1,16 @@ -# MorsePotential +--- +title: MorsePotential +description: API reference for qiskit.chemistry.algorithms.pes_samplers.MorsePotential +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.MorsePotential +--- +# MorsePotential + -`MorsePotential(molecule)` +`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` @@ -10,7 +18,7 @@ Implements a 1D Morse potential. Input units are Angstroms (distance between the two atoms), and output units are Hartrees (molecular energy). -Initializes the potential to the zero-function. [`fit()`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit") should be used afterwards to fit the potential to computed molecular energies. +Initializes the potential to the zero-function. [`fit()`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential#fit "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit") should be used afterwards to fit the potential to computed molecular energies. **Parameters** @@ -22,18 +30,242 @@ Initializes the potential to the zero-function. [`fit()`](qiskit.chemistry.algor ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| [`dissociation_energy`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.dissociation_energy#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.dissociation_energy "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.dissociation_energy") | Returns the calculated dissociation energy for the current fit. | -| [`eval`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.eval#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.eval "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.eval") | After fitting the data to the fit function, predict the energy at a point x. | -| [`fit`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit") | Fits a potential to computed molecular energies. | -| [`fit_function`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit_function#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit_function "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fit_function") | Functional form of the potential. | -| [`fundamental_frequency`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fundamental_frequency#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fundamental_frequency "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.fundamental_frequency") | Returns the fundamental frequency for the current fit (in s^-1). | -| [`get_equilibrium_geometry`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_equilibrium_geometry#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_equilibrium_geometry "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_equilibrium_geometry") | Returns the interatomic distance corresponding to minimal energy. | -| [`get_maximum_trusted_level`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_maximum_trusted_level#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_maximum_trusted_level "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_maximum_trusted_level") | Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. | -| [`get_minimal_energy`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_minimal_energy#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_minimal_energy "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_minimal_energy") | Returns the smallest molecular energy for the current fit. | -| [`get_num_modes`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_num_modes#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_num_modes "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_num_modes") | This (1D) potential represents a single vibrational mode | -| [`get_trust_region`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_trust_region#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_trust_region "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.get_trust_region") | The potential will usually be well-defined (even if not useful) for arbitrary x so we return a fairly large interval here. | -| [`update_molecule`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.update_molecule#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.update_molecule "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.update_molecule") | Updates the underlying molecule. | -| [`vibrational_energy_level`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.vibrational_energy_level#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.vibrational_energy_level "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.vibrational_energy_level") | Returns the n-th vibrational energy level for the current fit (in Hartrees). | -| [`wave_number`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential.wave_number#qiskit.chemistry.algorithms.pes_samplers.MorsePotential.wave_number "qiskit.chemistry.algorithms.pes_samplers.MorsePotential.wave_number") | Returns the wave number for the current fit (in cm^-1). | +### dissociation\_energy + + + +`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. + +**Parameters** + +**scaling** (`float`) – Scaling to change units. (Default is 1.0 for Hartrees) + +**Return type** + +`float` + +**Returns** + +calculated dissociation energy for the current fit + +### eval + + + +`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. + +**Parameters** + +**x** (`float`) – value to evaluate surface in + +**Return type** + +`float` + +**Returns** + +value of surface in point x + +### fit + + + +`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. + +**Parameters** + +* **xdata** (`List`\[`float`]) – interatomic distance points (Angstroms) +* **ydata** (`List`\[`float`]) – molecular energies (Hartrees) +* **initial\_vals** (`Optional`\[`List`\[`float`]]) – Initial values for fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) +* **bounds\_list** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – Bounds for the fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) + +**Return type** + +`None` + +### fit\_function + + + +`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. + +**Parameters** + +* **x** (`float`) – x parameter of morse potential +* **d\_e** (`float`) – d\_e parameter of morse potential +* **alpha** (`float`) – alpha parameter of morse potential +* **r\_0** (`float`) – r\_0 parameter of morse potential +* **m\_shift** (`float`) – m\_shift parameter of morse potential + +**Return type** + +`float` + +**Returns** + +potential functional form + +### fundamental\_frequency + + + +`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). + +**Return type** + +`float` + +**Returns** + +fundamental frequency for the current fit + +### get\_equilibrium\_geometry + + + +`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. + +**Parameters** + +**scaling** (`float`) – Scaling to change units. (Default is 1.0 for Angstroms) + +**Return type** + +`float` + +**Returns** + +interatomic distance corresponding to minimal energy + +### get\_maximum\_trusted\_level + + + +`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. + +**Parameters** + +**n** (`int`) – vibronic mode + +**Return type** + +`float` + +**Returns** + +maximum\_trusted\_level estimated + +### get\_minimal\_energy + + + +`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. + +**Parameters** + +**scaling** (`float`) – Scaling to change units. (Default is 1.0 for Hartrees) + +**Return type** + +`float` + +**Returns** + +smallest molecular energy for the current fit + +### get\_num\_modes + + + +`MorsePotential.get_num_modes()` + +This (1D) potential represents a single vibrational mode + +**Return type** + +`int` + +### get\_trust\_region + + + +`MorsePotential.get_trust_region()` + +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. + +**Return type** + +`Tuple`\[`float`, `float`] + +### update\_molecule + + + +`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. + +**Parameters** + +**molecule** (`Molecule`) – chemistry molecule + +**Raises** + +**ValueError** – Only implemented for diatomic molecules + +**Return type** + +`None` + +### vibrational\_energy\_level + + + +`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). + +**Parameters** + +**n** (`int`) – vibrational mode + +**Return type** + +`float` + +**Returns** + +vibrational energy level for the current fit + +### wave\_number + + + +`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). + +**Return type** + +`float` + +**Returns** + +wave number for the current fit + 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 d6ce389af74..b9c05c60048 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 @@ -1,8 +1,16 @@ -# PCAExtrapolator +--- +title: PCAExtrapolator +description: API reference for qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator +--- +# PCAExtrapolator + -`PCAExtrapolator(extrapolator=None, kernel=None, window=2)` +`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` @@ -18,11 +26,54 @@ Constructor. **Raises** -[**AquaError**](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if kernel is not defined in sklearn module. +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if kernel is not defined in sklearn module. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| [`extrapolate`](qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.extrapolate#qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.extrapolate "qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.extrapolate") | Extrapolate at specified point of interest given a set of variational parameters. | -| [`factory`](qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.factory#qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.factory "qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator.factory") | Factory method for constructing extrapolators. | +### extrapolate + + + +`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. + +**Parameters** + +* **points** (`List`\[`float`]) – List of point(s) to be used for extrapolation. Can represent some degree of freedom, ex, interatomic distance. +* **param\_dict** (`Optional`\[`Dict`\[`float`, `List`\[`float`]]]) – Dictionary of variational parameters. Each key is the point +* **the value is a list of the variational parameters.** (*and*) – + +**Return type** + +`Dict`\[`float`, `List`\[`float`]] + +**Returns** + +Dictionary of variational parameters for extrapolated point(s). + +### factory + + + +`static PCAExtrapolator.factory(mode, **kwargs)` + +Factory method for constructing extrapolators. + +**Parameters** + +* **mode** (`str`) – Extrapolator to instantiate. Can be one of: - ‘window’ - ‘poly’ - ‘diff\_model’ - ‘pca’ - ‘l1’ +* **kwargs** – arguments to be passed to the constructor of an extrapolator + +**Return type** + +`Extrapolator` + +**Returns** + +A newly created extrapolator instance. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if specified mode is unknown. + 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 70e48e36d3f..67bf8bd84fa 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 @@ -1,8 +1,16 @@ -# PolynomialExtrapolator +--- +title: PolynomialExtrapolator +description: API reference for qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator +--- +# PolynomialExtrapolator + -`PolynomialExtrapolator(degree=1)` +`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` @@ -18,7 +26,49 @@ Constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | -| [`extrapolate`](qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.extrapolate#qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.extrapolate "qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.extrapolate") | Extrapolate at specified point of interest given a set of variational parameters. | -| [`factory`](qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.factory#qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.factory "qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator.factory") | Factory method for constructing extrapolators. | +### extrapolate + + + +`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. + +**Parameters** + +* **points** (`List`\[`float`]) – List of point(s) to be used for extrapolation. Can represent some degree of freedom, ex, interatomic distance. +* **param\_dict** (`Optional`\[`Dict`\[`float`, `List`\[`float`]]]) – Dictionary of variational parameters. Each key is the point and the value is a list of the variational parameters. + +**Return type** + +`Dict`\[`float`, `List`\[`float`]] + +**Returns** + +Dictionary of variational parameters for extrapolated point(s). + +### factory + + + +`static PolynomialExtrapolator.factory(mode, **kwargs)` + +Factory method for constructing extrapolators. + +**Parameters** + +* **mode** (`str`) – Extrapolator to instantiate. Can be one of: - ‘window’ - ‘poly’ - ‘diff\_model’ - ‘pca’ - ‘l1’ +* **kwargs** – arguments to be passed to the constructor of an extrapolator + +**Return type** + +`Extrapolator` + +**Returns** + +A newly created extrapolator instance. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if specified mode is unknown. + 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 d8810627717..27e02c06513 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 @@ -1,8 +1,16 @@ -# PotentialBase +--- +title: PotentialBase +description: API reference for qiskit.chemistry.algorithms.pes_samplers.PotentialBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.PotentialBase +--- +# PotentialBase + -`PotentialBase(molecule)` +`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` @@ -10,15 +18,182 @@ Class to hold prescribed 1D potentials (e.g. Morse/Harmonic) over a degree of fr ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| [`dissociation_energy`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.dissociation_energy#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.dissociation_energy "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.dissociation_energy") | Returns the dissociation energy (scaled by ‘scaling’) | -| [`eval`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.eval#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.eval "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.eval") | After fitting the data to the fit function, predict the energy at a point x. | -| [`fit`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.fit#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.fit "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.fit") | Fits surface to data | -| [`get_equilibrium_geometry`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_equilibrium_geometry#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_equilibrium_geometry "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_equilibrium_geometry") | Get the equilibrium energy. | -| [`get_maximum_trusted_level`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_maximum_trusted_level#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_maximum_trusted_level "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_maximum_trusted_level") | Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. | -| [`get_minimal_energy`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_minimal_energy#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_minimal_energy "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_minimal_energy") | Get the minimal energy. | -| [`get_num_modes`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_num_modes#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_num_modes "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_num_modes") | This (1D) potential represents a single vibrational mode | -| [`get_trust_region`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_trust_region#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_trust_region "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.get_trust_region") | The potential will usually be well-defined (even if not useful) for arbitrary x so we return a fairly large interval here. | -| [`update_molecule`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.update_molecule#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.update_molecule "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.update_molecule") | Wipe state if molecule changes, and check validity of molecule for potential. | -| [`vibrational_energy_level`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase.vibrational_energy_level#qiskit.chemistry.algorithms.pes_samplers.PotentialBase.vibrational_energy_level "qiskit.chemistry.algorithms.pes_samplers.PotentialBase.vibrational_energy_level") | Returns the n-th vibrational energy level for a given mode. | +### dissociation\_energy + + + +`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’) + +**Return type** + +`float` + +### eval + + + +`abstract PotentialBase.eval(x)` + +After fitting the data to the fit function, predict the energy at a point x. + +**Parameters** + +**x** (`float`) – value to evaluate surface in + +**Return type** + +`float` + +**Returns** + +value of surface in point x + +### fit + + + +`abstract PotentialBase.fit(xdata, ydata, initial_vals=None, bounds_list=None)` + +Fits surface to data + +**Parameters** + +* **xdata** (`List`\[`float`]) – x data to be fitted +* **ydata** (`List`\[`float`]) – y data to be fitted +* **initial\_vals** (`Optional`\[`List`\[`float`]]) – Initial values for fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) +* **bounds\_list** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – Bounds for the fit parameters. None for default. Order of parameters is d\_e, alpha, r\_0 and m\_shift (see fit\_function implementation) + +**Return type** + +`None` + +### get\_equilibrium\_geometry + + + +`abstract PotentialBase.get_equilibrium_geometry(scaling=1.0)` + +Get the equilibrium energy. + +Returns the geometry for the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are Angstroms. Scale by 1E-10 to get meters. + +**Parameters** + +**scaling** (`float`) – scaling factor + +**Return type** + +`float` + +**Returns** + +equilibrium geometry + +### get\_maximum\_trusted\_level + + + +`PotentialBase.get_maximum_trusted_level(n=0)` + +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). + +**Parameters** + +**n** (`int`) – vibronic mode + +**Return type** + +`float` + +**Returns** + +maximum\_trusted\_level setted + +### get\_minimal\_energy + + + +`abstract PotentialBase.get_minimal_energy(scaling=1.0)` + +Get the minimal energy. + +Returns the value of the minimal energy (scaled by ‘scaling’) Default units (scaling=1.0) are J/mol. Scale appropriately for Hartrees. + +**Parameters** + +**scaling** (`float`) – scaling factor + +**Return type** + +`float` + +**Returns** + +minimum energy + +### get\_num\_modes + + + +`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 + +**Return type** + +`int` + +### get\_trust\_region + + + +`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. + +**Return type** + +`Tuple`\[`float`, `float`] + +### update\_molecule + + + +`PotentialBase.update_molecule(molecule)` + +Wipe state if molecule changes, and check validity of molecule for potential. + +**Parameters** + +**molecule** (`Molecule`) – chemistry molecule + +**Return type** + +`Molecule` + +**Returns** + +molecule used + +### vibrational\_energy\_level + + + +`abstract PotentialBase.vibrational_energy_level(n)` + +Returns the n-th vibrational energy level for a given mode. + +**Parameters** + +**n** (`int`) – number of vibrational mode + +**Return type** + +`float` + +**Returns** + +n-th vibrational energy level for a given mode + 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 331ab2093b7..2f59b46bb2c 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 @@ -1,8 +1,16 @@ -# SieveExtrapolator +--- +title: SieveExtrapolator +description: API reference for qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator +--- +# SieveExtrapolator + -`SieveExtrapolator(extrapolator=None, window=2, filter_before=True, filter_after=True)` +`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` @@ -19,7 +27,49 @@ Constructor. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| [`extrapolate`](qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.extrapolate#qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.extrapolate "qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.extrapolate") | Extrapolate at specified point of interest given a set of variational parameters. | -| [`factory`](qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.factory#qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.factory "qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator.factory") | Factory method for constructing extrapolators. | +### extrapolate + + + +`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. + +**Parameters** + +* **points** (`List`\[`float`]) – List of point(s) to be used for extrapolation. Can represent some degree of freedom, ex, interatomic distance. +* **param\_dict** (`Optional`\[`Dict`\[`float`, `List`\[`float`]]]) – Dictionary of variational parameters. Each key is the point and the value is a list of the variational parameters. + +**Return type** + +`Dict`\[`float`, `List`\[`float`]] + +**Returns** + +Dictionary of variational parameters for extrapolated point(s). + +### factory + + + +`static SieveExtrapolator.factory(mode, **kwargs)` + +Factory method for constructing extrapolators. + +**Parameters** + +* **mode** (`str`) – Extrapolator to instantiate. Can be one of: - ‘window’ - ‘poly’ - ‘diff\_model’ - ‘pca’ - ‘l1’ +* **kwargs** – arguments to be passed to the constructor of an extrapolator + +**Return type** + +`Extrapolator` + +**Returns** + +A newly created extrapolator instance. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if specified mode is unknown. + 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 10533d3c0dd..6a795448f01 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 @@ -1,8 +1,16 @@ -# VibronicStructureBase +--- +title: VibronicStructureBase +description: API reference for qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase +--- +# VibronicStructureBase + -`VibronicStructureBase(molecule)` +`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` @@ -10,9 +18,79 @@ Class to hold a molecular vibronic structure providing access to vibrational mod ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -| [`get_maximum_trusted_level`](qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.get_maximum_trusted_level#qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.get_maximum_trusted_level "qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.get_maximum_trusted_level") | Returns the maximum energy level for which the particular implementation still provides a good approximation of reality. | -| [`get_num_modes`](qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.get_num_modes#qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.get_num_modes "qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.get_num_modes") | Returns the number of vibrational modes for the molecule. | -| [`update_molecule`](qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.update_molecule#qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.update_molecule "qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.update_molecule") | Wipe state if molecule changes, and check validity of molecule for potential. | -| [`vibrational_energy_level`](qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.vibrational_energy_level#qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.vibrational_energy_level "qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase.vibrational_energy_level") | Returns the n-th vibrational energy level for a given mode. | +### get\_maximum\_trusted\_level + + + +`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). + +**Parameters** + +**n** (`int`) – vibronic mode + +**Return type** + +`float` + +**Returns** + +maximum\_trusted\_level setted + +### get\_num\_modes + + + +`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. + +**Return type** + +`float` + +**Returns** + +the number of vibrational modes + +### update\_molecule + + + +`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. + +**Parameters** + +**molecule** (`Molecule`) – chemistry molecule + +**Return type** + +`Molecule` + +**Returns** + +molecule used + +### vibrational\_energy\_level + + + +`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. + +**Parameters** + +**n** (`int`) – number of vibrational mode + +**Return type** + +`float` + +**Returns** + +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 1bcc8cb6b6e..681fb8420fb 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 @@ -1,8 +1,16 @@ -# WindowExtrapolator +--- +title: WindowExtrapolator +description: API reference for qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator +--- +# WindowExtrapolator + -`WindowExtrapolator(extrapolator=None, window=2)` +`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` @@ -17,14 +25,55 @@ Constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------- | -| [`extrapolate`](qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.extrapolate#qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.extrapolate "qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.extrapolate") | Extrapolate at specified point of interest given a set of variational parameters. | -| [`factory`](qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.factory#qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.factory "qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator.factory") | Factory method for constructing extrapolators. | +### extrapolate -## Attributes + + +`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. +**Parameters** + +* **points** (`List`\[`float`]) – List of point(s) to be used for extrapolation. Can represent some degree of freedom, ex, interatomic distance. +* **param\_dict** (`Optional`\[`Dict`\[`float`, `List`\[`float`]]]) – Dictionary of variational parameters. Each key is the point and the value is a list of the variational parameters. + +**Return type** +`Dict`\[`float`, `List`\[`float`]] + +**Returns** + +Dictionary of variational parameters for extrapolated point(s). + +### factory + + + +`static WindowExtrapolator.factory(mode, **kwargs)` + +Factory method for constructing extrapolators. + +**Parameters** + +* **mode** (`str`) – Extrapolator to instantiate. Can be one of: - ‘window’ - ‘poly’ - ‘diff\_model’ - ‘pca’ - ‘l1’ +* **kwargs** – arguments to be passed to the constructor of an extrapolator + +**Return type** + +`Extrapolator` + +**Returns** + +A newly created extrapolator instance. + +**Raises** + +[**AquaError**](qiskit.aqua.AquaError "qiskit.aqua.AquaError") – if specified mode is unknown. + +## Attributes + + ### extrapolator @@ -38,7 +87,7 @@ Returns the internal extrapolator. The internal extrapolator. - + ### window @@ -51,3 +100,4 @@ Returns the size of the window. **Returns** The size of the window. + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.md b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.md index 9784c575c8c..8c06ef67a96 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.algorithms.pes_samplers.md @@ -20,29 +20,29 @@ Potential energy surface samplers. Algorithms that can compute potential energy surfaces. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`BOPESSampler`](qiskit.chemistry.algorithms.pes_samplers.BOPESSampler#qiskit.chemistry.algorithms.pes_samplers.BOPESSampler "qiskit.chemistry.algorithms.pes_samplers.BOPESSampler") | Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | +| [`BOPESSampler`](qiskit.chemistry.algorithms.pes_samplers.BOPESSampler "qiskit.chemistry.algorithms.pes_samplers.BOPESSampler") | Class to evaluate the Born-Oppenheimer Potential Energy Surface (BOPES). | When used with variational solvers, such as VQE, when computing a set of points there is support for extrapolation from prior solution(s) to bootstrap the algorithm with a better starting point to facilitate convergence. Extrapolators are: -> | | | -> | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -> | [`Extrapolator`](qiskit.chemistry.algorithms.pes_samplers.Extrapolator#qiskit.chemistry.algorithms.pes_samplers.Extrapolator "qiskit.chemistry.algorithms.pes_samplers.Extrapolator") | This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. | -> | [`DifferentialExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator#qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator "qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator") | An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. | -> | [`PCAExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator#qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator "qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator") | A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. | -> | [`PolynomialExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator#qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator "qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator") | An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. | -> | [`SieveExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator#qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator "qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator") | A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. | -> | [`WindowExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator#qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator "qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator") | An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. | +> | | | +> | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +> | [`Extrapolator`](qiskit.chemistry.algorithms.pes_samplers.Extrapolator "qiskit.chemistry.algorithms.pes_samplers.Extrapolator") | This class is based on performing extrapolation of parameters of a wavefunction for a variational algorithm defined in the variational forms as part of the Qiskit Aqua module. | +> | [`DifferentialExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator "qiskit.chemistry.algorithms.pes_samplers.DifferentialExtrapolator") | An extrapolator based on treating each param set as a point in space, and fitting a Hamiltonian which evolves each point to the next. | +> | [`PCAExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator "qiskit.chemistry.algorithms.pes_samplers.PCAExtrapolator") | A wrapper extrapolator which reduces the points’ dimensionality with PCA, performs extrapolation in the transformed pca space, and inverse transforms the results before returning. | +> | [`PolynomialExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator "qiskit.chemistry.algorithms.pes_samplers.PolynomialExtrapolator") | An extrapolator based on fitting each parameter to a polynomial function of a user-specified degree. | +> | [`SieveExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator "qiskit.chemistry.algorithms.pes_samplers.SieveExtrapolator") | A wrapper extrapolator which clusters the parameter values - either before extrapolation, after, or both - into two large and small clusters, and sets the small clusters’ parameters to zero. | +> | [`WindowExtrapolator`](qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator "qiskit.chemistry.algorithms.pes_samplers.WindowExtrapolator") | An extrapolator which wraps another extrapolator, limiting the internal extrapolator’s ground truth parameter set to a fixed window size. | There is also a set of support function for potentials: -> | | | -> | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -> | [`EnergySurface1DSpline`](qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline#qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline "qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline") | A simple cubic spline interpolation for the potential energy surface. | -> | [`HarmonicPotential`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential#qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential") | Implements a 1D Harmonic potential. | -> | [`MorsePotential`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential#qiskit.chemistry.algorithms.pes_samplers.MorsePotential "qiskit.chemistry.algorithms.pes_samplers.MorsePotential") | Implements a 1D Morse potential. | -> | [`EnergySurfaceBase`](qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase#qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase "qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase") | Class to hold a potential energy surface | -> | [`PotentialBase`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase#qiskit.chemistry.algorithms.pes_samplers.PotentialBase "qiskit.chemistry.algorithms.pes_samplers.PotentialBase") | Class to hold prescribed 1D potentials (e.g. | -> | [`VibronicStructureBase`](qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase#qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase "qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase") | Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. | +> | | | +> | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +> | [`EnergySurface1DSpline`](qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline "qiskit.chemistry.algorithms.pes_samplers.EnergySurface1DSpline") | A simple cubic spline interpolation for the potential energy surface. | +> | [`HarmonicPotential`](qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential "qiskit.chemistry.algorithms.pes_samplers.HarmonicPotential") | Implements a 1D Harmonic potential. | +> | [`MorsePotential`](qiskit.chemistry.algorithms.pes_samplers.MorsePotential "qiskit.chemistry.algorithms.pes_samplers.MorsePotential") | Implements a 1D Morse potential. | +> | [`EnergySurfaceBase`](qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase "qiskit.chemistry.algorithms.pes_samplers.EnergySurfaceBase") | Class to hold a potential energy surface | +> | [`PotentialBase`](qiskit.chemistry.algorithms.pes_samplers.PotentialBase "qiskit.chemistry.algorithms.pes_samplers.PotentialBase") | Class to hold prescribed 1D potentials (e.g. | +> | [`VibronicStructureBase`](qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase "qiskit.chemistry.algorithms.pes_samplers.VibronicStructureBase") | Class to hold a molecular vibronic structure providing access to vibrational modes and energy levels. | 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 0d7716daf11..3d7e0169b30 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.applications.MolecularGroundStateEnergy.md @@ -1,8 +1,16 @@ -# MolecularGroundStateEnergy +--- +title: MolecularGroundStateEnergy +description: API reference for qiskit.chemistry.applications.MolecularGroundStateEnergy +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.applications.MolecularGroundStateEnergy +--- +# MolecularGroundStateEnergy + -`MolecularGroundStateEnergy(driver, solver=None, transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` +`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` @@ -11,24 +19,59 @@ Molecular ground state energy chemistry application **Parameters** * **driver** (`FermionicDriver`) – Chemistry driver -* **solver** (`Optional`\[`MinimumEigensolver`]) – An Aqua MinimumEigensolver. This can be provided on the constructor or via the solver property, or via the callback on [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") +* **solver** (`Optional`\[`MinimumEigensolver`]) – An Aqua MinimumEigensolver. This can be provided on the constructor or via the solver property, or via the callback on [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") * **transformation** (`TransformationType`) – full or particle\_hole * **qubit\_mapping** (`QubitMappingType`) – jordan\_wigner, parity or bravyi\_kitaev * **two\_qubit\_reduction** (`bool`) – Whether two qubit reduction should be used, when parity mapping only * **freeze\_core** (`bool`) – Whether to freeze core orbitals when possible * **orbital\_reduction** (`Optional`\[`List`\[`int`]]) – Orbital list to be frozen or removed -* **z2symmetry\_reduction** (`Union`\[`str`, `List`\[`int`], `None`]) – If z2 symmetry reduction should be applied to the qubit operators that are computed. Setting ‘auto’ will use an automatic computation of the correct sector. If from other experiments, with the z2symmetry logic, the sector is known, then the tapering values of that sector can be provided (a list of int of values -1, and 1). The default is None meaning no symmetry reduction is done. See also [`Hamiltonian`](qiskit.chemistry.core.Hamiltonian#qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian") which has the core processing behind this class. +* **z2symmetry\_reduction** (`Union`\[`str`, `List`\[`int`], `None`]) – If z2 symmetry reduction should be applied to the qubit operators that are computed. Setting ‘auto’ will use an automatic computation of the correct sector. If from other experiments, with the z2symmetry logic, the sector is known, then the tapering values of that sector can be provided (a list of int of values -1, and 1). The default is None meaning no symmetry reduction is done. See also [`Hamiltonian`](qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian") which has the core processing behind this class. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`compute_energy`](qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") | Compute the ground state energy of the molecule that was supplied via the driver | -| [`get_default_solver`](qiskit.chemistry.applications.MolecularGroundStateEnergy.get_default_solver#qiskit.chemistry.applications.MolecularGroundStateEnergy.get_default_solver "qiskit.chemistry.applications.MolecularGroundStateEnergy.get_default_solver") | Get the default solver callback that can be used with [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "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 | +### compute\_energy -## Attributes + + +`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 + +**Parameters** + +**callback** (`Optional`\[`Callable`\[\[`List`, `int`, `str`, `bool`, `Z2Symmetries`], `MinimumEigensolver`]]) – If not None will be called with the following values num\_particles, num\_orbitals, qubit\_mapping, two\_qubit\_reduction, z2\_symmetries in that order. This information can then be used to setup chemistry specific component(s) that are needed by the chosen MinimumEigensolver. The MinimumEigensolver can then be built and returned from this callback for use as the solver here. + +**Return type** + +`MolecularGroundStateResult` + +**Returns** + +A molecular ground state result + +**Raises** +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – If no MinimumEigensolver was given and no callback is being used that could supply one instead. +### get\_default\_solver + + + +`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 + +**Return type** + +`Optional`\[`Callable`\[\[`List`, `int`, `str`, `bool`, `Z2Symmetries`], `MinimumEigensolver`]] + +**Returns** + +Default solver callback + +## Attributes + + ### driver @@ -38,7 +81,7 @@ Returns chemistry driver `FermionicDriver` - + ### solver @@ -47,3 +90,4 @@ Returns minimum eigen solver **Return type** `MinimumEigensolver` + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.applications.md b/docs/api/qiskit/0.32/qiskit.chemistry.applications.md index a72eeee6263..685b790e4a7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.applications.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.applications.md @@ -22,7 +22,7 @@ These are chemistry applications leveraging quantum algorithms from Aqua. **DEPRECATED** See Ground state solvers in [`qiskit.chemistry.algorithms`](qiskit.chemistry.algorithms#module-qiskit.chemistry.algorithms "qiskit.chemistry.algorithms") which replace this. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | -| [`MolecularGroundStateEnergy`](qiskit.chemistry.applications.MolecularGroundStateEnergy#qiskit.chemistry.applications.MolecularGroundStateEnergy "qiskit.chemistry.applications.MolecularGroundStateEnergy") | Molecular ground state energy chemistry application | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| [`MolecularGroundStateEnergy`](qiskit.chemistry.applications.MolecularGroundStateEnergy "qiskit.chemistry.applications.MolecularGroundStateEnergy") | Molecular ground state energy chemistry application | 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 6ab12f0c5ab..efe575f1e23 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 @@ -1,8 +1,16 @@ -# BosonicBasis +--- +title: BosonicBasis +description: API reference for qiskit.chemistry.components.bosonic_bases.BosonicBasis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.components.bosonic_bases.BosonicBasis +--- +# BosonicBasis + -`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") Bases: `object` @@ -10,6 +18,27 @@ Basis to express a second quantization Bosonic Hamiltonian. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.chemistry.components.bosonic_bases.BosonicBasis.convert#qiskit.chemistry.components.bosonic_bases.BosonicBasis.convert "qiskit.chemistry.components.bosonic_bases.BosonicBasis.convert") | This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. | +### convert + + + +`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. + +**Parameters** + +**threshold** (`float`) – the matrix elements of value below this threshold are discarded + +**Return type** + +`List`\[`List`\[`Tuple`\[`List`\[`List`\[`int`]], `float`]]] + +**Returns** + +List of modes for input to creation of a bosonic hamiltonian in the harmonic basis + +**Raises** + +**ValueError** – If problem with order value from computed modes + 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 54fc46d13d5..582658bb8c3 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 @@ -1,8 +1,16 @@ -# HarmonicBasis +--- +title: HarmonicBasis +description: API reference for qiskit.chemistry.components.bosonic_bases.HarmonicBasis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.components.bosonic_bases.HarmonicBasis +--- +# HarmonicBasis + -`HarmonicBasis(watson_hamiltonian, basis, truncation_order=3)` +`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` @@ -22,6 +30,27 @@ This class uses the Hermite polynomials (eigenstates of the harmonic oscillator) ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.chemistry.components.bosonic_bases.HarmonicBasis.convert#qiskit.chemistry.components.bosonic_bases.HarmonicBasis.convert "qiskit.chemistry.components.bosonic_bases.HarmonicBasis.convert") | This prepares an array object representing a bosonic hamiltonian expressed in the harmonic basis. | +### convert + + + +`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. + +**Parameters** + +**threshold** (`float`) – the matrix elements of value below this threshold are discarded + +**Return type** + +`List`\[`List`\[`Tuple`\[`List`\[`List`\[`int`]], `float`]]] + +**Returns** + +List of modes for input to creation of a bosonic hamiltonian in the harmonic basis + +**Raises** + +**ValueError** – If problem with order value from computed modes + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.md index 207723de876..8394e2d2ea3 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.bosonic_bases.md @@ -20,8 +20,8 @@ Basis for bosonic operations. # Bosonic Basis -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`BosonicBasis`](qiskit.chemistry.components.bosonic_bases.BosonicBasis#qiskit.chemistry.components.bosonic_bases.BosonicBasis "qiskit.chemistry.components.bosonic_bases.BosonicBasis") | Basis to express a second quantization Bosonic Hamiltonian. | -| [`HarmonicBasis`](qiskit.chemistry.components.bosonic_bases.HarmonicBasis#qiskit.chemistry.components.bosonic_bases.HarmonicBasis "qiskit.chemistry.components.bosonic_bases.HarmonicBasis") | Basis in which the Watson Hamiltonian is expressed. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | +| [`BosonicBasis`](qiskit.chemistry.components.bosonic_bases.BosonicBasis "qiskit.chemistry.components.bosonic_bases.BosonicBasis") | Basis to express a second quantization Bosonic Hamiltonian. | +| [`HarmonicBasis`](qiskit.chemistry.components.bosonic_bases.HarmonicBasis "qiskit.chemistry.components.bosonic_bases.HarmonicBasis") | Basis in which the Watson Hamiltonian is expressed. | 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 d38eedff7b8..2ffac17ec3c 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 @@ -1,8 +1,16 @@ -# HartreeFock +--- +title: HartreeFock +description: API reference for qiskit.chemistry.components.initial_states.HartreeFock +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.components.initial_states.HartreeFock +--- +# HartreeFock + -`HartreeFock(num_orbitals, num_particles, qubit_mapping='parity', two_qubit_reduction=True, sq_list=None)` +`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` @@ -23,14 +31,36 @@ A Hartree-Fock initial state. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`construct_circuit`](qiskit.chemistry.components.initial_states.HartreeFock.construct_circuit#qiskit.chemistry.components.initial_states.HartreeFock.construct_circuit "qiskit.chemistry.components.initial_states.HartreeFock.construct_circuit") | Construct the statevector of desired initial state. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **mode** (*string*) – vector or circuit. The vector mode produces the vector. While the circuit constructs the quantum circuit corresponding that vector. +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – register for circuit construction. + +**Returns** +statevector. +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or numpy.ndarray + +**Raises** + +**ValueError** – when mode is not ‘vector’ or ‘circuit’. + +## Attributes + + ### bitstr Getter of the bit string represented the statevector. + 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 7a600565148..2e0c0af3104 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 @@ -1,8 +1,16 @@ -# VSCF +--- +title: VSCF +description: API reference for qiskit.chemistry.components.initial_states.VSCF +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.components.initial_states.VSCF +--- +# VSCF + -`VSCF(basis)` +`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` @@ -16,14 +24,36 @@ Creates an occupation number vector as defined in Ollitrault Pauline J., Chemica ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------- | -| [`construct_circuit`](qiskit.chemistry.components.initial_states.VSCF.construct_circuit#qiskit.chemistry.components.initial_states.VSCF.construct_circuit "qiskit.chemistry.components.initial_states.VSCF.construct_circuit") | Construct the statevector of desired initial state. | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **mode** (*string*) – vector or circuit. The vector mode produces the vector. While the circuit constructs the quantum circuit corresponding that vector. +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – register for circuit construction. +**Returns** +statevector. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or numpy.ndarray + +**Raises** + +**ValueError** – when mode is not ‘vector’ or ‘circuit’. + +## Attributes + + ### bitstr Getter of the bit string represented the statevector. + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.md index 20e13b56eed..8a9c0dbda67 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.initial_states.md @@ -16,12 +16,12 @@ python_api_name: qiskit.chemistry.components.initial_states `qiskit.chemistry.components.initial_states` -These are chemistry specific Aqua Initial States where they inherit from Aqua [`InitialState`](qiskit.aqua.components.initial_states.InitialState#qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState"). As they rely on chemistry specific knowledge and/or functions they live here rather than in Aqua. +These are chemistry specific Aqua Initial States where they inherit from Aqua [`InitialState`](qiskit.aqua.components.initial_states.InitialState "qiskit.aqua.components.initial_states.InitialState"). As they rely on chemistry specific knowledge and/or functions they live here rather than in Aqua. # Initial States -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`HartreeFock`](qiskit.chemistry.components.initial_states.HartreeFock#qiskit.chemistry.components.initial_states.HartreeFock "qiskit.chemistry.components.initial_states.HartreeFock") | A Hartree-Fock initial state. | -| [`VSCF`](qiskit.chemistry.components.initial_states.VSCF#qiskit.chemistry.components.initial_states.VSCF "qiskit.chemistry.components.initial_states.VSCF") | Initial state for vibrational modes. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | +| [`HartreeFock`](qiskit.chemistry.components.initial_states.HartreeFock "qiskit.chemistry.components.initial_states.HartreeFock") | A Hartree-Fock initial state. | +| [`VSCF`](qiskit.chemistry.components.initial_states.VSCF "qiskit.chemistry.components.initial_states.VSCF") | Initial state for vibrational modes. | 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 b215df78a31..357ad749e4b 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 @@ -1,8 +1,16 @@ -# CHC +--- +title: CHC +description: API reference for qiskit.chemistry.components.variational_forms.CHC +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.components.variational_forms.CHC +--- +# CHC + -`CHC(num_qubits=None, reps=1, ladder=False, excitations=None, entanglement='full', initial_state=None)` +`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` @@ -25,15 +33,52 @@ The trial wavefunction is as defined in Ollitrault Pauline J., Chemical science ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`construct_circuit`](qiskit.chemistry.components.variational_forms.CHC.construct_circuit#qiskit.chemistry.components.variational_forms.CHC.construct_circuit "qiskit.chemistry.components.variational_forms.CHC.construct_circuit") | Construct the variational form, given its parameters. | -| [`get_entangler_map`](qiskit.chemistry.components.variational_forms.CHC.get_entangler_map#qiskit.chemistry.components.variational_forms.CHC.get_entangler_map "qiskit.chemistry.components.variational_forms.CHC.get_entangler_map") | returns entangler map | -| [`validate_entangler_map`](qiskit.chemistry.components.variational_forms.CHC.validate_entangler_map#qiskit.chemistry.components.variational_forms.CHC.validate_entangler_map "qiskit.chemistry.components.variational_forms.CHC.validate_entangler_map") | validate entangler map | +### construct\_circuit -## Attributes + + +`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. + +**Parameters** + +* **parameters** (`Union`\[`ndarray`, `List`\[`Parameter`], `ParameterVector`]) – circuit parameters +* **q** (`Optional`\[`QuantumRegister`]) – Quantum Register for the circuit. + +**Returns** + +a quantum circuit with given parameters + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **ValueError** – the number of parameters is incorrect. +* **ValueError** – if num\_qubits has not been set and is still None +* **ValueError** – only supports single and double excitations at the moment. +### get\_entangler\_map + + +`static CHC.get_entangler_map(map_type, num_qubits, offset=0)` + +returns entangler map + +### validate\_entangler\_map + + + +`static CHC.validate_entangler_map(entangler_map, num_qubits)` + +validate entangler map + +## Attributes + + ### num\_parameters @@ -47,7 +92,7 @@ An integer indicating the number of parameters. int - + ### num\_qubits @@ -61,7 +106,7 @@ An integer indicating the number of qubits. int - + ### parameter\_bounds @@ -75,7 +120,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo list - + ### preferred\_init\_points @@ -83,11 +128,11 @@ Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state - + ### setting - + ### support\_parameterized\_circuit @@ -100,3 +145,4 @@ indicate the sub-class support parameterized circuit **Return type** boolean + 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 d128659ea9b..e709b18e9e7 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 @@ -1,8 +1,16 @@ -# UCCSD +--- +title: UCCSD +description: API reference for qiskit.chemistry.components.variational_forms.UCCSD +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.components.variational_forms.UCCSD +--- +# 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)` +`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` @@ -54,30 +62,226 @@ Constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`compute_excitation_lists`](qiskit.chemistry.components.variational_forms.UCCSD.compute_excitation_lists#qiskit.chemistry.components.variational_forms.UCCSD.compute_excitation_lists "qiskit.chemistry.components.variational_forms.UCCSD.compute_excitation_lists") | Computes single and double excitation lists. | -| [`compute_excitation_lists_singlet`](qiskit.chemistry.components.variational_forms.UCCSD.compute_excitation_lists_singlet#qiskit.chemistry.components.variational_forms.UCCSD.compute_excitation_lists_singlet "qiskit.chemistry.components.variational_forms.UCCSD.compute_excitation_lists_singlet") | Outputs the list of lists of grouped excitation. | -| [`construct_circuit`](qiskit.chemistry.components.variational_forms.UCCSD.construct_circuit#qiskit.chemistry.components.variational_forms.UCCSD.construct_circuit "qiskit.chemistry.components.variational_forms.UCCSD.construct_circuit") | Construct the variational form, given its parameters. | -| [`get_entangler_map`](qiskit.chemistry.components.variational_forms.UCCSD.get_entangler_map#qiskit.chemistry.components.variational_forms.UCCSD.get_entangler_map "qiskit.chemistry.components.variational_forms.UCCSD.get_entangler_map") | returns entangler map | -| [`group_excitations`](qiskit.chemistry.components.variational_forms.UCCSD.group_excitations#qiskit.chemistry.components.variational_forms.UCCSD.group_excitations "qiskit.chemistry.components.variational_forms.UCCSD.group_excitations") | Groups the excitations and gives out the remaining ones in the list\_de\_temp list because those excitations are controlled by the same parameter in full singlet UCCSD unlike in usual UCCSD where every excitation has its own parameter. | -| [`group_excitations_if_same_ao`](qiskit.chemistry.components.variational_forms.UCCSD.group_excitations_if_same_ao#qiskit.chemistry.components.variational_forms.UCCSD.group_excitations_if_same_ao "qiskit.chemistry.components.variational_forms.UCCSD.group_excitations_if_same_ao") | Define that, given list of double excitations list\_de and number of spin-orbitals num\_orbitals, which excitations involve the same spatial orbitals for full singlet UCCSD. | -| [`manage_hopping_operators`](qiskit.chemistry.components.variational_forms.UCCSD.manage_hopping_operators#qiskit.chemistry.components.variational_forms.UCCSD.manage_hopping_operators "qiskit.chemistry.components.variational_forms.UCCSD.manage_hopping_operators") | Triggers the adaptive behavior of this UCCSD instance. | -| [`order_labels_for_hopping_ops`](qiskit.chemistry.components.variational_forms.UCCSD.order_labels_for_hopping_ops#qiskit.chemistry.components.variational_forms.UCCSD.order_labels_for_hopping_ops "qiskit.chemistry.components.variational_forms.UCCSD.order_labels_for_hopping_ops") | Orders the hopping operators according to the grouped excitations for the full singlet UCCSD. | -| [`pop_hopping_operator`](qiskit.chemistry.components.variational_forms.UCCSD.pop_hopping_operator#qiskit.chemistry.components.variational_forms.UCCSD.pop_hopping_operator "qiskit.chemistry.components.variational_forms.UCCSD.pop_hopping_operator") | Pops the hopping operator that was added last. | -| [`push_hopping_operator`](qiskit.chemistry.components.variational_forms.UCCSD.push_hopping_operator#qiskit.chemistry.components.variational_forms.UCCSD.push_hopping_operator "qiskit.chemistry.components.variational_forms.UCCSD.push_hopping_operator") | Pushes a new hopping operator. | -| [`same_ao_double_excitation_block_spin`](qiskit.chemistry.components.variational_forms.UCCSD.same_ao_double_excitation_block_spin#qiskit.chemistry.components.variational_forms.UCCSD.same_ao_double_excitation_block_spin "qiskit.chemistry.components.variational_forms.UCCSD.same_ao_double_excitation_block_spin") | Regroups the excitations that involve same spatial orbitals for example, with labeling. | -| [`validate_entangler_map`](qiskit.chemistry.components.variational_forms.UCCSD.validate_entangler_map#qiskit.chemistry.components.variational_forms.UCCSD.validate_entangler_map "qiskit.chemistry.components.variational_forms.UCCSD.validate_entangler_map") | validate entangler map | +### compute\_excitation\_lists -## Attributes + + +`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. + +**Parameters** + +* **num\_particles** (*Union(list, int)*) – number of particles, if it is a tuple, the first number is alpha and the second number if beta. +* **num\_orbitals** (*int*) – Total number of spin orbitals +* **active\_occ\_list** (*list*) – List of occupied orbitals to include, indices are 0 to n where n is max(num\_alpha, num\_beta) +* **active\_unocc\_list** (*list*) – List of unoccupied orbitals to include, indices are 0 to m where m is num\_orbitals // 2 - min(num\_alpha, num\_beta) +* **same\_spin\_doubles** (*bool*) – True to include alpha,alpha and beta,beta double excitations as well as alpha,beta pairings. False includes only alpha,beta +* **excitation\_type** (*str*) – choose ‘sd’, ‘s’, ‘d’ to compute q-UCCSD, q-UCCS, q-UCCD excitation lists +* **method\_singles** (*str*) – specify type of single excitations, ‘alpha’, ‘beta’, ‘both’ only alpha or beta spin-orbital single excitations or both (all single excitations) +* **method\_doubles** (*str*) – choose method for double excitations ‘ucc’ (conventional ucc), ‘succ’ (singlet ucc), ‘succ\_full’ (singlet ucc full), ‘pucc’ (pair ucc) + +**Returns** + +Single excitation list list: Double excitation list + +**Return type** + +list + +**Raises** + +* **ValueError** – invalid setting of number of particles +* **ValueError** – invalid setting of number of orbitals + +### compute\_excitation\_lists\_singlet + + + +`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. + +**Parameters** + +* **double\_exc** (*list*) – exc.group. \[\[0,1,2,3], \[…]] +* **num\_orbitals** (*int*) – number of molecular orbitals + +**Returns** + +de\_groups grouped excitations + +**Return type** + +list + +### construct\_circuit + + + +`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. + +**Parameters** + +* **parameters** (*Union(numpy.ndarray, list\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*],* [*ParameterVector*](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector")*)*) – circuit parameters +* **q** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*, optional*) – Quantum Register for the circuit. + +**Returns** + +a quantum circuit with given parameters + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ValueError** – the number of parameters is incorrect. + +### get\_entangler\_map + + + +`static UCCSD.get_entangler_map(map_type, num_qubits, offset=0)` + +returns entangler map + +### group\_excitations + + + +`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. + +**Parameters** + +* **list\_de** (*list*) – list of the double excitations grouped +* **num\_orbitals** (*int*) – number of spin-orbitals (qubits) + +**Returns** + +list\_same\_ao\_group, list\_de\_temp, the grouped double\_exc (that involve same spatial orbitals) + +**Return type** + +tuple + +### group\_excitations\_if\_same\_ao + + + +`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. + +**Parameters** + +* **list\_de** (*list*) – list of double exc +* **num\_orbitals** (*int*) – number of spin-orbitals + +**Returns** + +grouped list of excitations + +**Return type** + +list + +### manage\_hopping\_operators + + + +`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. + +### order\_labels\_for\_hopping\_ops + + + +`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. + +**Parameters** + +* **double\_exc** (*list*) – list of double excitations +* **gde** (*list of lists*) – list of grouped excitations for full singlet UCCSD + +**Returns** + +ordered\_labels to order hopping ops + +**Return type** + +list + +### pop\_hopping\_operator + + + +`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. + +### push\_hopping\_operator + + + +`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. +**Parameters** + +**excitation** ([*WeightedPauliOperator*](qiskit.aqua.operators.legacy.WeightedPauliOperator "qiskit.aqua.operators.legacy.WeightedPauliOperator")) – the new hopping operator to be added + +### same\_ao\_double\_excitation\_block\_spin + + + +`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. + +2— —5 1— —4 0-o- -o-3 + +excitations \[0,1,3,5] and \[0,2,3,4] are controlled by the same parameter in the full singlet UCCSD unlike in usual UCCSD where every excitation is controlled by independent parameter. + +**Parameters** + +* **de\_1** (*list*) – double exc in block spin \[ from to from to ] +* **de\_2** (*list*) – double exc in block spin \[ from to from to ] +* **num\_orbitals** (*int*) – number of molecular orbitals + +**Returns** + +says if given excitation involves same spatial orbitals 1 = yes, 0 = no. + +**Return type** + +int + +### validate\_entangler\_map + + + +`static UCCSD.validate_entangler_map(entangler_map, num_qubits)` + +validate entangler map + +## Attributes + + ### double\_excitations Getter of double excitation list :returns: double excitation list :rtype: list\[list\[int]] - + ### excitation\_pool @@ -87,7 +291,7 @@ Returns the full list of available excitations (called the pool). `List`\[`WeightedPauliOperator`] - + ### num\_parameters @@ -101,7 +305,7 @@ An integer indicating the number of parameters. int - + ### num\_qubits @@ -115,7 +319,7 @@ An integer indicating the number of qubits. int - + ### parameter\_bounds @@ -129,23 +333,23 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo list - + ### preferred\_init\_points Getter of preferred initial points based on the given initial state. - + ### setting - + ### single\_excitations Getter of single excitation list :returns: single excitation list :rtype: list\[list\[int]] - + ### support\_parameterized\_circuit @@ -158,3 +362,4 @@ indicate the sub-class support parameterized circuit **Return type** boolean + 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 fe4deb241ac..bee952ab726 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 @@ -1,8 +1,16 @@ -# UVCC +--- +title: UVCC +description: API reference for qiskit.chemistry.components.variational_forms.UVCC +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.components.variational_forms.UVCC +--- +# UVCC + -`UVCC(num_qubits, basis, degrees, reps=1, excitations=None, initial_state=None, qubit_mapping='direct', num_time_slices=1, shallow_circuit_concat=True)` +`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` @@ -22,17 +30,94 @@ This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Doub ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`compute_excitation_lists`](qiskit.chemistry.components.variational_forms.UVCC.compute_excitation_lists#qiskit.chemistry.components.variational_forms.UVCC.compute_excitation_lists "qiskit.chemistry.components.variational_forms.UVCC.compute_excitation_lists") | Compute the list with all possible excitation for given orders | -| [`construct_circuit`](qiskit.chemistry.components.variational_forms.UVCC.construct_circuit#qiskit.chemistry.components.variational_forms.UVCC.construct_circuit "qiskit.chemistry.components.variational_forms.UVCC.construct_circuit") | Construct the variational form, given its parameters. | -| [`excitations_in_qubit_format`](qiskit.chemistry.components.variational_forms.UVCC.excitations_in_qubit_format#qiskit.chemistry.components.variational_forms.UVCC.excitations_in_qubit_format "qiskit.chemistry.components.variational_forms.UVCC.excitations_in_qubit_format") | Gives the list of excitation indexes in terms of qubit indexes rather | -| [`get_entangler_map`](qiskit.chemistry.components.variational_forms.UVCC.get_entangler_map#qiskit.chemistry.components.variational_forms.UVCC.get_entangler_map "qiskit.chemistry.components.variational_forms.UVCC.get_entangler_map") | returns entangler map | -| [`validate_entangler_map`](qiskit.chemistry.components.variational_forms.UVCC.validate_entangler_map#qiskit.chemistry.components.variational_forms.UVCC.validate_entangler_map "qiskit.chemistry.components.variational_forms.UVCC.validate_entangler_map") | validate entangler map | +### compute\_excitation\_lists -## Attributes + + +`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 + +**Parameters** + +* **basis** (`List`\[`int`]) – Is a list defining the number of modals per mode. E.g. for a 3 modes system with 4 modals per mode basis = \[4,4,4] +* **degrees** (`List`\[`int`]) – degree of excitation to be included (for single and double excitations degrees=\[0,1]) + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +List of excitation indexes in terms of modes and modals + +**Raises** + +**ValueError** – If excitation degree is greater than size of basis + +### construct\_circuit + + + +`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. + +**Parameters** + +* **parameters** (`Union`\[`ndarray`, `List`\[`Parameter`], `ParameterVector`]) – circuit parameters +* **q** (`Optional`\[`QuantumRegister`]) – Quantum Register for the circuit. + +**Return type** + +`QuantumCircuit` + +**Returns** +Quantum Circuit a quantum circuit with given parameters +**Raises** + +* **ValueError** – the number of parameters is incorrect. +* **ValueError** – if num\_qubits has not been set and is still None + +### excitations\_in\_qubit\_format + + + +`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 + +than in modes and modals + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +List of excitation indexes + +### get\_entangler\_map + + + +`static UVCC.get_entangler_map(map_type, num_qubits, offset=0)` + +returns entangler map + +### validate\_entangler\_map + + + +`static UVCC.validate_entangler_map(entangler_map, num_qubits)` + +validate entangler map + +## Attributes + + ### num\_parameters @@ -46,7 +131,7 @@ An integer indicating the number of parameters. int - + ### num\_qubits @@ -60,7 +145,7 @@ An integer indicating the number of qubits. int - + ### parameter\_bounds @@ -74,7 +159,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo list - + ### preferred\_init\_points @@ -82,11 +167,11 @@ Return preferred init points. If an initial state is provided then the variational form may provide back this set of parameters which when used on the variational form should result in the overall state being that defined by the initial state - + ### setting - + ### support\_parameterized\_circuit @@ -99,3 +184,4 @@ indicate the sub-class support parameterized circuit **Return type** boolean + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.md b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.md index 908423a1dac..9708e3a10a6 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.components.variational_forms.md @@ -16,13 +16,13 @@ python_api_name: qiskit.chemistry.components.variational_forms `qiskit.chemistry.components.variational_forms` -These are chemistry specific Aqua Variational Forms where they inherit from Aqua [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm#qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm"). As they rely on chemistry specific knowledge and/or functions they live here rather than in Aqua. +These are chemistry specific Aqua Variational Forms where they inherit from Aqua [`VariationalForm`](qiskit.aqua.components.variational_forms.VariationalForm "qiskit.aqua.components.variational_forms.VariationalForm"). As they rely on chemistry specific knowledge and/or functions they live here rather than in Aqua. # Variational Forms -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -| [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD#qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") | This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. | -| [`UVCC`](qiskit.chemistry.components.variational_forms.UVCC#qiskit.chemistry.components.variational_forms.UVCC "qiskit.chemistry.components.variational_forms.UVCC") | This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. | -| [`CHC`](qiskit.chemistry.components.variational_forms.CHC#qiskit.chemistry.components.variational_forms.CHC "qiskit.chemistry.components.variational_forms.CHC") | This trial wavefunction is the Compact Heuristic for Chemistry. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") | This trial wavefunction is a Unitary Coupled-Cluster Single and Double excitations variational form. | +| [`UVCC`](qiskit.chemistry.components.variational_forms.UVCC "qiskit.chemistry.components.variational_forms.UVCC") | This trial wavefunction is a Unitary Vibrational Coupled-Cluster Single and Double excitations variational form. | +| [`CHC`](qiskit.chemistry.components.variational_forms.CHC "qiskit.chemistry.components.variational_forms.CHC") | This trial wavefunction is the Compact Heuristic for Chemistry. | 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 7a4e7f06b9d..878f1ea509f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.ChemistryOperator.md @@ -1,8 +1,16 @@ -# ChemistryOperator +--- +title: ChemistryOperator +description: API reference for qiskit.chemistry.core.ChemistryOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.core.ChemistryOperator +--- +# ChemistryOperator + -`ChemistryOperator` +`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` @@ -10,39 +18,75 @@ Base class for ChemistryOperator. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| [`process_algorithm_result`](qiskit.chemistry.core.ChemistryOperator.process_algorithm_result#qiskit.chemistry.core.ChemistryOperator.process_algorithm_result "qiskit.chemistry.core.ChemistryOperator.process_algorithm_result") | Takes the algorithm result and processes it as required, e.g. | -| [`run`](qiskit.chemistry.core.ChemistryOperator.run#qiskit.chemistry.core.ChemistryOperator.run "qiskit.chemistry.core.ChemistryOperator.run") | Convert the qmolecule, according to the ChemistryOperator, into an Operator that can be given to a QuantumAlgorithm | +### process\_algorithm\_result -## Attributes + + +`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. + +**Parameters** + +**algo\_result** (`Union`\[`dict`, `MinimumEigensolverResult`, `EigensolverResult`]) – Result from algorithm + +**Return type** + +`Union`\[`Tuple`\[`List`\[`str`], `dict`], `MolecularGroundStateResult`, `MolecularExcitedStatesResult`] + +**Returns** + +Final chemistry result computed from the algorithm result + +### run + + + +`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 +**Parameters** + +**qmolecule** ([*QMolecule*](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule")) – from a chemistry driver + +**Returns** + +(qubit\_op, aux\_ops) + +**Return type** + +Tuple + +## Attributes + + ### INFO\_NUM\_ORBITALS `= 'num_orbitals'` - + ### INFO\_NUM\_PARTICLES `= 'num_particles'` - + ### INFO\_TWO\_QUBIT\_REDUCTION `= 'two_qubit_reduction'` - + ### INFO\_Z2SYMMETRIES `= 'z2symmetries'` - + ### molecule\_info returns molecule info + 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 760ecc1b5f6..c03444567c8 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.Hamiltonian.md @@ -1,8 +1,16 @@ -# Hamiltonian +--- +title: Hamiltonian +description: API reference for qiskit.chemistry.core.Hamiltonian +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.core.Hamiltonian +--- +# Hamiltonian + -`Hamiltonian(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` +`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` @@ -19,43 +27,71 @@ A molecular Hamiltonian operator, representing the energy of the electrons and n **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid symmetry reduction +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid symmetry reduction ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| [`process_algorithm_result`](qiskit.chemistry.core.Hamiltonian.process_algorithm_result#qiskit.chemistry.core.Hamiltonian.process_algorithm_result "qiskit.chemistry.core.Hamiltonian.process_algorithm_result") | Takes the algorithm result and processes it as required, e.g. | -| [`run`](qiskit.chemistry.core.Hamiltonian.run#qiskit.chemistry.core.Hamiltonian.run "qiskit.chemistry.core.Hamiltonian.run") | run method | +### process\_algorithm\_result -## Attributes + + +`Hamiltonian.process_algorithm_result(algo_result)` + +Takes the algorithm result and processes it as required, e.g. by combination of any parts that were classically computed, for the final result. + +**Parameters** + +**algo\_result** (`Union`\[`dict`, `MinimumEigensolverResult`, `EigensolverResult`]) – Result from algorithm + +**Return type** + +`Union`\[`Tuple`\[`List`\[`str`], `dict`], `MolecularGroundStateResult`, `MolecularExcitedStatesResult`] + +**Returns** + +Final chemistry result computed from the algorithm result +### run + + +`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 + +**Return type** + +`Tuple`\[`WeightedPauliOperator`, `List`\[`WeightedPauliOperator`]] + +## Attributes + + ### INFO\_NUM\_ORBITALS `= 'num_orbitals'` - + ### INFO\_NUM\_PARTICLES `= 'num_particles'` - + ### INFO\_TWO\_QUBIT\_REDUCTION `= 'two_qubit_reduction'` - + ### INFO\_Z2SYMMETRIES `= 'z2symmetries'` - + ### molecule\_info returns molecule info + 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 fc5a902d571..32e2f1c0875 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularChemistryResult.md @@ -1,8 +1,16 @@ -# MolecularChemistryResult +--- +title: MolecularChemistryResult +description: API reference for qiskit.chemistry.core.MolecularChemistryResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.core.MolecularChemistryResult +--- +# MolecularChemistryResult + -`MolecularChemistryResult(a_dict=None)` +`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` @@ -12,24 +20,113 @@ Energies are in Hartree and dipole moments in A.U unless otherwise stated. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.chemistry.core.MolecularChemistryResult.clear#qiskit.chemistry.core.MolecularChemistryResult.clear "qiskit.chemistry.core.MolecularChemistryResult.clear") | **rtype**`None` | -| [`combine`](qiskit.chemistry.core.MolecularChemistryResult.combine#qiskit.chemistry.core.MolecularChemistryResult.combine "qiskit.chemistry.core.MolecularChemistryResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.chemistry.core.MolecularChemistryResult.copy#qiskit.chemistry.core.MolecularChemistryResult.copy "qiskit.chemistry.core.MolecularChemistryResult.copy") | | -| [`fromkeys`](qiskit.chemistry.core.MolecularChemistryResult.fromkeys#qiskit.chemistry.core.MolecularChemistryResult.fromkeys "qiskit.chemistry.core.MolecularChemistryResult.fromkeys") | | -| [`get`](qiskit.chemistry.core.MolecularChemistryResult.get#qiskit.chemistry.core.MolecularChemistryResult.get "qiskit.chemistry.core.MolecularChemistryResult.get") | | -| [`items`](qiskit.chemistry.core.MolecularChemistryResult.items#qiskit.chemistry.core.MolecularChemistryResult.items "qiskit.chemistry.core.MolecularChemistryResult.items") | | -| [`keys`](qiskit.chemistry.core.MolecularChemistryResult.keys#qiskit.chemistry.core.MolecularChemistryResult.keys "qiskit.chemistry.core.MolecularChemistryResult.keys") | | -| [`pop`](qiskit.chemistry.core.MolecularChemistryResult.pop#qiskit.chemistry.core.MolecularChemistryResult.pop "qiskit.chemistry.core.MolecularChemistryResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.chemistry.core.MolecularChemistryResult.popitem#qiskit.chemistry.core.MolecularChemistryResult.popitem "qiskit.chemistry.core.MolecularChemistryResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.chemistry.core.MolecularChemistryResult.setdefault#qiskit.chemistry.core.MolecularChemistryResult.setdefault "qiskit.chemistry.core.MolecularChemistryResult.setdefault") | | -| [`update`](qiskit.chemistry.core.MolecularChemistryResult.update#qiskit.chemistry.core.MolecularChemistryResult.update "qiskit.chemistry.core.MolecularChemistryResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.chemistry.core.MolecularChemistryResult.values#qiskit.chemistry.core.MolecularChemistryResult.values "qiskit.chemistry.core.MolecularChemistryResult.values") | | +### clear -## Attributes + + +`MolecularChemistryResult.clear()` + +**Return type** + +`None` + +### combine + + + +`MolecularChemistryResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`MolecularChemistryResult.copy()` + +### fromkeys + + + +`classmethod MolecularChemistryResult.fromkeys(iterable, value=None)` + +### get + + + +`MolecularChemistryResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`MolecularChemistryResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`MolecularChemistryResult.keys() → a set-like object providing a view on D’s keys` + +### pop + +`MolecularChemistryResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`MolecularChemistryResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`MolecularChemistryResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`MolecularChemistryResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`MolecularChemistryResult.values() → an object providing a view on D’s values` + +## Attributes + + ### algorithm\_result @@ -39,7 +136,7 @@ Returns raw algorithm result `AlgorithmResult` - + ### hartree\_fock\_energy @@ -49,7 +146,7 @@ Returns Hartree-Fock energy `float` - + ### nuclear\_dipole\_moment @@ -59,7 +156,7 @@ Returns nuclear dipole moment X,Y,Z components in A.U when available from driver `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### nuclear\_repulsion\_energy @@ -68,3 +165,4 @@ Returns nuclear repulsion energy when available from driver **Return type** `Optional`\[`float`] + 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 ff982bc4367..fd533f4dcab 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularExcitedStatesResult.md @@ -1,8 +1,16 @@ -# MolecularExcitedStatesResult +--- +title: MolecularExcitedStatesResult +description: API reference for qiskit.chemistry.core.MolecularExcitedStatesResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.core.MolecularExcitedStatesResult +--- +# MolecularExcitedStatesResult + -`MolecularExcitedStatesResult(a_dict=None)` +`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` @@ -12,24 +20,113 @@ Energies are in Hartree and dipole moments in A.U unless otherwise stated. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.chemistry.core.MolecularExcitedStatesResult.clear#qiskit.chemistry.core.MolecularExcitedStatesResult.clear "qiskit.chemistry.core.MolecularExcitedStatesResult.clear") | **rtype**`None` | -| [`combine`](qiskit.chemistry.core.MolecularExcitedStatesResult.combine#qiskit.chemistry.core.MolecularExcitedStatesResult.combine "qiskit.chemistry.core.MolecularExcitedStatesResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.chemistry.core.MolecularExcitedStatesResult.copy#qiskit.chemistry.core.MolecularExcitedStatesResult.copy "qiskit.chemistry.core.MolecularExcitedStatesResult.copy") | | -| [`fromkeys`](qiskit.chemistry.core.MolecularExcitedStatesResult.fromkeys#qiskit.chemistry.core.MolecularExcitedStatesResult.fromkeys "qiskit.chemistry.core.MolecularExcitedStatesResult.fromkeys") | | -| [`get`](qiskit.chemistry.core.MolecularExcitedStatesResult.get#qiskit.chemistry.core.MolecularExcitedStatesResult.get "qiskit.chemistry.core.MolecularExcitedStatesResult.get") | | -| [`items`](qiskit.chemistry.core.MolecularExcitedStatesResult.items#qiskit.chemistry.core.MolecularExcitedStatesResult.items "qiskit.chemistry.core.MolecularExcitedStatesResult.items") | | -| [`keys`](qiskit.chemistry.core.MolecularExcitedStatesResult.keys#qiskit.chemistry.core.MolecularExcitedStatesResult.keys "qiskit.chemistry.core.MolecularExcitedStatesResult.keys") | | -| [`pop`](qiskit.chemistry.core.MolecularExcitedStatesResult.pop#qiskit.chemistry.core.MolecularExcitedStatesResult.pop "qiskit.chemistry.core.MolecularExcitedStatesResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.chemistry.core.MolecularExcitedStatesResult.popitem#qiskit.chemistry.core.MolecularExcitedStatesResult.popitem "qiskit.chemistry.core.MolecularExcitedStatesResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.chemistry.core.MolecularExcitedStatesResult.setdefault#qiskit.chemistry.core.MolecularExcitedStatesResult.setdefault "qiskit.chemistry.core.MolecularExcitedStatesResult.setdefault") | | -| [`update`](qiskit.chemistry.core.MolecularExcitedStatesResult.update#qiskit.chemistry.core.MolecularExcitedStatesResult.update "qiskit.chemistry.core.MolecularExcitedStatesResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.chemistry.core.MolecularExcitedStatesResult.values#qiskit.chemistry.core.MolecularExcitedStatesResult.values "qiskit.chemistry.core.MolecularExcitedStatesResult.values") | | +### clear -## Attributes + + +`MolecularExcitedStatesResult.clear()` + +**Return type** + +`None` + +### combine + + + +`MolecularExcitedStatesResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`MolecularExcitedStatesResult.copy()` + +### fromkeys + + + +`classmethod MolecularExcitedStatesResult.fromkeys(iterable, value=None)` + +### get + + + +`MolecularExcitedStatesResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`MolecularExcitedStatesResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`MolecularExcitedStatesResult.keys() → a set-like object providing a view on D’s keys` + +### pop + +`MolecularExcitedStatesResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`MolecularExcitedStatesResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`MolecularExcitedStatesResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`MolecularExcitedStatesResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`MolecularExcitedStatesResult.values() → an object providing a view on D’s values` + +## Attributes + + ### algorithm\_result @@ -39,7 +136,7 @@ Returns raw algorithm result `AlgorithmResult` - + ### energies @@ -49,7 +146,7 @@ Returns ground state energy `Tuple` - + ### hartree\_fock\_energy @@ -59,7 +156,7 @@ Returns Hartree-Fock energy `float` - + ### nuclear\_dipole\_moment @@ -69,7 +166,7 @@ Returns nuclear dipole moment X,Y,Z components in A.U when available from driver `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### nuclear\_repulsion\_energy @@ -78,3 +175,4 @@ Returns nuclear repulsion energy when available from driver **Return type** `Optional`\[`float`] + 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 751a69d7bae..1302c42392b 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.MolecularGroundStateResult.md @@ -1,8 +1,16 @@ -# MolecularGroundStateResult +--- +title: MolecularGroundStateResult +description: API reference for qiskit.chemistry.core.MolecularGroundStateResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.core.MolecularGroundStateResult +--- +# MolecularGroundStateResult + -`MolecularGroundStateResult(a_dict=None)` +`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` @@ -12,26 +20,133 @@ Energies are in Hartree and dipole moments in A.U unless otherwise stated. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.chemistry.core.MolecularGroundStateResult.clear#qiskit.chemistry.core.MolecularGroundStateResult.clear "qiskit.chemistry.core.MolecularGroundStateResult.clear") | **rtype**`None` | -| [`combine`](qiskit.chemistry.core.MolecularGroundStateResult.combine#qiskit.chemistry.core.MolecularGroundStateResult.combine "qiskit.chemistry.core.MolecularGroundStateResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.chemistry.core.MolecularGroundStateResult.copy#qiskit.chemistry.core.MolecularGroundStateResult.copy "qiskit.chemistry.core.MolecularGroundStateResult.copy") | | -| [`fromkeys`](qiskit.chemistry.core.MolecularGroundStateResult.fromkeys#qiskit.chemistry.core.MolecularGroundStateResult.fromkeys "qiskit.chemistry.core.MolecularGroundStateResult.fromkeys") | | -| [`get`](qiskit.chemistry.core.MolecularGroundStateResult.get#qiskit.chemistry.core.MolecularGroundStateResult.get "qiskit.chemistry.core.MolecularGroundStateResult.get") | | -| [`has_dipole`](qiskit.chemistry.core.MolecularGroundStateResult.has_dipole#qiskit.chemistry.core.MolecularGroundStateResult.has_dipole "qiskit.chemistry.core.MolecularGroundStateResult.has_dipole") | Returns whether dipole moment is present in result or not | -| [`has_observables`](qiskit.chemistry.core.MolecularGroundStateResult.has_observables#qiskit.chemistry.core.MolecularGroundStateResult.has_observables "qiskit.chemistry.core.MolecularGroundStateResult.has_observables") | Returns whether result has aux op observables such as spin, num particles | -| [`items`](qiskit.chemistry.core.MolecularGroundStateResult.items#qiskit.chemistry.core.MolecularGroundStateResult.items "qiskit.chemistry.core.MolecularGroundStateResult.items") | | -| [`keys`](qiskit.chemistry.core.MolecularGroundStateResult.keys#qiskit.chemistry.core.MolecularGroundStateResult.keys "qiskit.chemistry.core.MolecularGroundStateResult.keys") | | -| [`pop`](qiskit.chemistry.core.MolecularGroundStateResult.pop#qiskit.chemistry.core.MolecularGroundStateResult.pop "qiskit.chemistry.core.MolecularGroundStateResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.chemistry.core.MolecularGroundStateResult.popitem#qiskit.chemistry.core.MolecularGroundStateResult.popitem "qiskit.chemistry.core.MolecularGroundStateResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.chemistry.core.MolecularGroundStateResult.setdefault#qiskit.chemistry.core.MolecularGroundStateResult.setdefault "qiskit.chemistry.core.MolecularGroundStateResult.setdefault") | | -| [`update`](qiskit.chemistry.core.MolecularGroundStateResult.update#qiskit.chemistry.core.MolecularGroundStateResult.update "qiskit.chemistry.core.MolecularGroundStateResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.chemistry.core.MolecularGroundStateResult.values#qiskit.chemistry.core.MolecularGroundStateResult.values "qiskit.chemistry.core.MolecularGroundStateResult.values") | | +### clear -## Attributes + + +`MolecularGroundStateResult.clear()` + +**Return type** + +`None` + +### combine + + + +`MolecularGroundStateResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`MolecularGroundStateResult.copy()` + +### fromkeys + + + +`classmethod MolecularGroundStateResult.fromkeys(iterable, value=None)` + +### get + + + +`MolecularGroundStateResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### has\_dipole + + + +`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 + +**Return type** + +`bool` + +### has\_observables + + + +`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 + +### items + + + +`MolecularGroundStateResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`MolecularGroundStateResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`MolecularGroundStateResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. +**Return type** + +`object` + +### popitem + + + +`MolecularGroundStateResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`MolecularGroundStateResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`MolecularGroundStateResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`MolecularGroundStateResult.values() → an object providing a view on D’s values` + +## Attributes + ### algorithm\_result @@ -41,7 +156,7 @@ Returns raw algorithm result `AlgorithmResult` - + ### computed\_dipole\_moment @@ -51,7 +166,7 @@ Returns computed electronic part of dipole moment `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### computed\_electronic\_energy @@ -61,7 +176,7 @@ Returns computed electronic part of ground state energy `float` - + ### dipole\_moment @@ -71,7 +186,7 @@ Returns dipole moment `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### dipole\_moment\_in\_debye @@ -81,7 +196,7 @@ Returns dipole moment in Debye `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### electronic\_dipole\_moment @@ -91,7 +206,7 @@ Returns electronic dipole moment `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### electronic\_energy @@ -101,7 +216,7 @@ Returns electronic part of ground state energy `float` - + ### energy @@ -111,7 +226,7 @@ Returns ground state energy if nuclear\_repulsion\_energy is available from driv `Optional`\[`float`] - + ### formatted @@ -121,7 +236,7 @@ Formatted result as a list of strings `List`\[`str`] - + ### frozen\_extracted\_dipole\_moment @@ -131,7 +246,7 @@ Returns frozen extracted part of dipole moment `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### frozen\_extracted\_energy @@ -141,7 +256,7 @@ Returns frozen extracted part of ground state energy `float` - + ### hartree\_fock\_energy @@ -151,7 +266,7 @@ Returns Hartree-Fock energy `float` - + ### magnetization @@ -161,7 +276,7 @@ Returns measured magnetization `Optional`\[`float`] - + ### nuclear\_dipole\_moment @@ -171,7 +286,7 @@ Returns nuclear dipole moment X,Y,Z components in A.U when available from driver `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### nuclear\_repulsion\_energy @@ -181,7 +296,7 @@ Returns nuclear repulsion energy when available from driver `Optional`\[`float`] - + ### num\_particles @@ -191,7 +306,7 @@ Returns measured number of particles `Optional`\[`float`] - + ### ph\_extracted\_dipole\_moment @@ -201,7 +316,7 @@ Returns particle hole extracted part of dipole moment `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### ph\_extracted\_energy @@ -211,7 +326,7 @@ Returns particle hole extracted part of ground state energy `float` - + ### reverse\_dipole\_sign @@ -221,7 +336,7 @@ Returns if electronic dipole moment sign should be reversed when adding to nucle `bool` - + ### spin @@ -231,7 +346,7 @@ Returns computed spin `Optional`\[`float`] - + ### total\_angular\_momentum @@ -241,7 +356,7 @@ Returns total angular momentum (S^2) `Optional`\[`float`] - + ### total\_dipole\_moment @@ -251,7 +366,7 @@ Returns total dipole of moment `Optional`\[`float`] - + ### total\_dipole\_moment\_in\_debye @@ -260,3 +375,4 @@ Returns total dipole of moment in Debye **Return type** `Optional`\[`float`] + 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 a6853aa3d59..bfb15314061 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.QubitMappingType.md @@ -1,8 +1,16 @@ -# QubitMappingType +--- +title: QubitMappingType +description: API reference for qiskit.chemistry.core.QubitMappingType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.core.QubitMappingType +--- +# QubitMappingType + -`QubitMappingType(value)` +`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` @@ -10,20 +18,21 @@ QubitMappingType enum ## Attributes - + ### BRAVYI\_KITAEV `= 'bravyi_kitaev'` - + ### JORDAN\_WIGNER `= 'jordan_wigner'` - + ### PARITY `= 'parity'` + 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 7a2a2287de4..d5c63c9d4f0 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.TransformationType.md @@ -1,8 +1,16 @@ -# TransformationType +--- +title: TransformationType +description: API reference for qiskit.chemistry.core.TransformationType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.core.TransformationType +--- +# TransformationType + -`TransformationType(value)` +`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` @@ -10,14 +18,15 @@ Transformation Type enum ## Attributes - + ### FULL `= 'full'` - + ### PARTICLE\_HOLE `= 'particle_hole'` + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.core.md b/docs/api/qiskit/0.32/qiskit.chemistry.core.md index 8df2e3e9630..0178581afd9 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.core.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.core.md @@ -18,24 +18,24 @@ python_api_name: qiskit.chemistry.core **DEPRECATED** See [`qiskit.chemistry.transformations`](qiskit.chemistry.transformations#module-qiskit.chemistry.transformations "qiskit.chemistry.transformations") which replace this. -The core was designed to be an extensible system that took a [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") and created output which was ready to be input directly to an Aqua algorithm in the form of a qubit operator and list of auxiliary operators such as dipole moments, spin, number of particles etc. +The core was designed to be an extensible system that took a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") and created output which was ready to be input directly to an Aqua algorithm in the form of a qubit operator and list of auxiliary operators such as dipole moments, spin, number of particles etc. -The one implementation here, [`Hamiltonian`](qiskit.chemistry.core.Hamiltonian#qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian"), in essence wraps the [`FermionicOperator`](qiskit.chemistry.FermionicOperator#qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") to provide easier, convenient access to common capabilities such that the [`FermionicOperator`](qiskit.chemistry.FermionicOperator#qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") class need not be used directly. +The one implementation here, [`Hamiltonian`](qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian"), in essence wraps the [`FermionicOperator`](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") to provide easier, convenient access to common capabilities such that the [`FermionicOperator`](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") class need not be used directly. # Core Base Class -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`ChemistryOperator`](qiskit.chemistry.core.ChemistryOperator#qiskit.chemistry.core.ChemistryOperator "qiskit.chemistry.core.ChemistryOperator") | Base class for ChemistryOperator. | -| [`MolecularChemistryResult`](qiskit.chemistry.core.MolecularChemistryResult#qiskit.chemistry.core.MolecularChemistryResult "qiskit.chemistry.core.MolecularChemistryResult") | Molecular chemistry Result | -| [`MolecularGroundStateResult`](qiskit.chemistry.core.MolecularGroundStateResult#qiskit.chemistry.core.MolecularGroundStateResult "qiskit.chemistry.core.MolecularGroundStateResult") | Molecular Ground State Energy Result. | -| [`MolecularExcitedStatesResult`](qiskit.chemistry.core.MolecularExcitedStatesResult#qiskit.chemistry.core.MolecularExcitedStatesResult "qiskit.chemistry.core.MolecularExcitedStatesResult") | Molecular Excited States Result | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| [`ChemistryOperator`](qiskit.chemistry.core.ChemistryOperator "qiskit.chemistry.core.ChemistryOperator") | Base class for ChemistryOperator. | +| [`MolecularChemistryResult`](qiskit.chemistry.core.MolecularChemistryResult "qiskit.chemistry.core.MolecularChemistryResult") | Molecular chemistry Result | +| [`MolecularGroundStateResult`](qiskit.chemistry.core.MolecularGroundStateResult "qiskit.chemistry.core.MolecularGroundStateResult") | Molecular Ground State Energy Result. | +| [`MolecularExcitedStatesResult`](qiskit.chemistry.core.MolecularExcitedStatesResult "qiskit.chemistry.core.MolecularExcitedStatesResult") | Molecular Excited States Result | # Core -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| [`Hamiltonian`](qiskit.chemistry.core.Hamiltonian#qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian") | A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. | -| [`TransformationType`](qiskit.chemistry.core.TransformationType#qiskit.chemistry.core.TransformationType "qiskit.chemistry.core.TransformationType") | Transformation Type enum | -| [`QubitMappingType`](qiskit.chemistry.core.QubitMappingType#qiskit.chemistry.core.QubitMappingType "qiskit.chemistry.core.QubitMappingType") | QubitMappingType enum | +| | | +| ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | +| [`Hamiltonian`](qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian") | A molecular Hamiltonian operator, representing the energy of the electrons and nuclei in a molecule. | +| [`TransformationType`](qiskit.chemistry.core.TransformationType "qiskit.chemistry.core.TransformationType") | Transformation Type enum | +| [`QubitMappingType`](qiskit.chemistry.core.QubitMappingType "qiskit.chemistry.core.QubitMappingType") | QubitMappingType 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 228daa113de..39426cd2514 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BaseDriver.md @@ -1,8 +1,16 @@ -# BaseDriver +--- +title: BaseDriver +description: API reference for qiskit.chemistry.drivers.BaseDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.BaseDriver +--- +# BaseDriver + -`BaseDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` +`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` @@ -17,11 +25,11 @@ Base class for Qiskit’s chemistry drivers. **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Molecule passed but driver doesn’t support it. +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Molecule passed but driver doesn’t support it. ## Attributes - + ### basis @@ -31,7 +39,7 @@ return basis `str` - + ### hf\_method @@ -41,7 +49,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -51,7 +59,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -64,3 +72,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 7d285a273b6..b5df8909308 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BasisType.md @@ -1,8 +1,16 @@ -# BasisType +--- +title: BasisType +description: API reference for qiskit.chemistry.drivers.BasisType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.BasisType +--- +# BasisType + -`BasisType(value)` +`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` @@ -10,20 +18,21 @@ Basis Type ## Attributes - + ### B631G `= '6-31g'` - + ### B631GSS `= '6-31g**'` - + ### BSTO3G `= 'sto3g'` + 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 6129755ebf9..4da4e20d1af 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.BosonicDriver.md @@ -1,8 +1,16 @@ -# BosonicDriver +--- +title: BosonicDriver +description: API reference for qiskit.chemistry.drivers.BosonicDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.BosonicDriver +--- +# BosonicDriver + -`BosonicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` +`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` @@ -17,17 +25,29 @@ Base class for Qiskit’s chemistry bosonic drivers. **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Molecule passed but driver doesn’t support it. +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Molecule passed but driver doesn’t support it. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`run`](qiskit.chemistry.drivers.BosonicDriver.run#qiskit.chemistry.drivers.BosonicDriver.run "qiskit.chemistry.drivers.BosonicDriver.run") | Runs driver to produce a WatsonHamiltonian output. | +### run -## Attributes + + +`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. + +**Return type** + +`WatsonHamiltonian` +**Returns** + +A WatsonHamiltonian comprising the bosonic data. + +## Attributes + ### basis @@ -37,7 +57,7 @@ return basis `str` - + ### hf\_method @@ -47,7 +67,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -57,7 +77,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -70,3 +90,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 19df2244865..ee721bfa7a6 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FCIDumpDriver.md @@ -1,8 +1,16 @@ -# FCIDumpDriver +--- +title: FCIDumpDriver +description: API reference for qiskit.chemistry.drivers.FCIDumpDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.FCIDumpDriver +--- +# FCIDumpDriver + -`FCIDumpDriver(fcidump_input, atoms=None)` +`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` @@ -23,18 +31,48 @@ A determinant based full configuration interaction program, Computer Physics Com **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – If `fcidump_input` is not a string or if `atoms` is not a list of valid atomic symbols as specified in `QMolecule`. +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – If `fcidump_input` is not a string or if `atoms` is not a list of valid atomic symbols as specified in `QMolecule`. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| [`dump`](qiskit.chemistry.drivers.FCIDumpDriver.dump#qiskit.chemistry.drivers.FCIDumpDriver.dump "qiskit.chemistry.drivers.FCIDumpDriver.dump") | Convenience method to produce an FCIDump output file. | -| [`run`](qiskit.chemistry.drivers.FCIDumpDriver.run#qiskit.chemistry.drivers.FCIDumpDriver.run "qiskit.chemistry.drivers.FCIDumpDriver.run") | Constructs a QMolecule instance out of a FCIDump file. | +### dump -## Attributes + + +`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. + +**Parameters** + +* **outpath** (`str`) – Path to the output file. +* **q\_mol** (`QMolecule`) – QMolecule data to be dumped. It is assumed that the nuclear\_repulsion\_energy in this QMolecule instance contains the inactive core energy. +* **orbsym** (`Optional`\[`List`\[`str`]]) – A list of spatial symmetries of the orbitals. +* **isym** (`int`) – The spatial symmetry of the wave function. + +**Return type** + +`None` + +### run + + +`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. + +**Return type** + +`QMolecule` + +**Returns** + +A QMolecule instance populated with a minimal set of required data. + +## Attributes + + ### basis @@ -44,7 +82,7 @@ return basis `str` - + ### hf\_method @@ -54,7 +92,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -64,7 +102,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -77,3 +115,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 41b596f0ec9..174374675eb 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.FermionicDriver.md @@ -1,8 +1,16 @@ -# FermionicDriver +--- +title: FermionicDriver +description: API reference for qiskit.chemistry.drivers.FermionicDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.FermionicDriver +--- +# FermionicDriver + -`FermionicDriver(molecule=None, basis='sto3g', hf_method='rhf', supports_molecule=False)` +`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` @@ -17,17 +25,29 @@ Base class for Qiskit’s chemistry fermionic drivers. **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Molecule passed but driver doesn’t support it. +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Molecule passed but driver doesn’t support it. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`run`](qiskit.chemistry.drivers.FermionicDriver.run#qiskit.chemistry.drivers.FermionicDriver.run "qiskit.chemistry.drivers.FermionicDriver.run") | Runs driver to produce a QMolecule output. | +### run -## Attributes + + +`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. + +**Return type** + +`QMolecule` +**Returns** + +A QMolecule containing the molecular data. + +## Attributes + ### basis @@ -37,7 +57,7 @@ return basis `str` - + ### hf\_method @@ -47,7 +67,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -57,7 +77,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -70,3 +90,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 1ae2ceacccb..fe1cff4b4bf 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianDriver.md @@ -1,8 +1,16 @@ -# GaussianDriver +--- +title: GaussianDriver +description: API reference for qiskit.chemistry.drivers.GaussianDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.GaussianDriver +--- +# 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=)` +`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` @@ -21,17 +29,29 @@ This driver uses the Gaussian open-source Gaussian 16 interfacing code in order **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`run`](qiskit.chemistry.drivers.GaussianDriver.run#qiskit.chemistry.drivers.GaussianDriver.run "qiskit.chemistry.drivers.GaussianDriver.run") | Runs driver to produce a QMolecule output. | +### run -## Attributes + + +`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. + +**Return type** + +`QMolecule` +**Returns** + +A QMolecule containing the molecular data. + +## Attributes + ### basis @@ -41,7 +61,7 @@ return basis `str` - + ### hf\_method @@ -51,7 +71,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -61,7 +81,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -74,3 +94,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 2b9fbf7c2fc..5b04ce5ae68 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianForcesDriver.md @@ -1,8 +1,16 @@ -# GaussianForcesDriver +--- +title: GaussianForcesDriver +description: API reference for qiskit.chemistry.drivers.GaussianForcesDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.GaussianForcesDriver +--- +# 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)` +`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` @@ -18,17 +26,29 @@ Gaussian™ 16 forces driver. **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – If jcf or molecule given and Gaussian™ 16 executable cannot be located. +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – If jcf or molecule given and Gaussian™ 16 executable cannot be located. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`run`](qiskit.chemistry.drivers.GaussianForcesDriver.run#qiskit.chemistry.drivers.GaussianForcesDriver.run "qiskit.chemistry.drivers.GaussianForcesDriver.run") | Runs driver to produce a WatsonHamiltonian output. | +### run -## Attributes + + +`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. + +**Return type** + +`WatsonHamiltonian` +**Returns** + +A WatsonHamiltonian comprising the bosonic data. + +## Attributes + ### basis @@ -38,7 +58,7 @@ return basis `str` - + ### hf\_method @@ -48,7 +68,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -58,7 +78,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -71,3 +91,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 41769f138b0..5fc824ad1b9 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogDriver.md @@ -1,18 +1,26 @@ -# GaussianLogDriver +--- +title: GaussianLogDriver +description: API reference for qiskit.chemistry.drivers.GaussianLogDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.GaussianLogDriver +--- +# GaussianLogDriver + -`GaussianLogDriver(jcf)` +`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` Gaussian™ 16 log driver. -Qiskit chemistry driver using the Gaussian™ 16 program that provides the log back, via [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult#qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult"), for access to the log and data recorded there. +Qiskit chemistry driver using the Gaussian™ 16 program that provides the log back, via [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult"), for access to the log and data recorded there. See [http://gaussian.com/gaussian16/](http://gaussian.com/gaussian16/) -This driver does not use Gaussian 16 interfacing code, as certain data such as forces properties are not present in the MatrixElement file. The log is returned as a [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult#qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult") allowing it to be parsed for whatever data may be of interest. This result class also contains ready access to certain data within the log. +This driver does not use Gaussian 16 interfacing code, as certain data such as forces properties are not present in the MatrixElement file. The log is returned as a [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult") allowing it to be parsed for whatever data may be of interest. This result class also contains ready access to certain data within the log. **Parameters** @@ -20,17 +28,33 @@ This driver does not use Gaussian 16 interfacing code, as certain data such as f **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`run`](qiskit.chemistry.drivers.GaussianLogDriver.run#qiskit.chemistry.drivers.GaussianLogDriver.run "qiskit.chemistry.drivers.GaussianLogDriver.run") | Runs the driver to produce a result given the supplied job control file. | +### run -## Attributes + + +`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. +**Return type** + +`GaussianLogResult` +**Returns** + +A log file result. + +**Raises** + +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Missing output log + +## Attributes + + ### basis @@ -40,7 +64,7 @@ return basis `str` - + ### hf\_method @@ -50,7 +74,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -60,7 +84,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -73,3 +97,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 36d6a9f3363..40d7a5481cd 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.GaussianLogResult.md @@ -1,8 +1,16 @@ -# GaussianLogResult +--- +title: GaussianLogResult +description: API reference for qiskit.chemistry.drivers.GaussianLogResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.GaussianLogResult +--- +# GaussianLogResult + -`GaussianLogResult(log)` +`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` @@ -20,13 +28,29 @@ This result allows access to selected data from the log file that is not availab ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| [`get_watson_hamiltonian`](qiskit.chemistry.drivers.GaussianLogResult.get_watson_hamiltonian#qiskit.chemistry.drivers.GaussianLogResult.get_watson_hamiltonian "qiskit.chemistry.drivers.GaussianLogResult.get_watson_hamiltonian") | Get the force constants as a WatsonHamiltonian | +### get\_watson\_hamiltonian -## Attributes + + +`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 + +**Parameters** + +**normalize** (`bool`) – Whether to normalize the factors or not + +**Return type** +`WatsonHamiltonian` +**Returns** + +A WatsonHamiltonian + +## Attributes + + ### a\_to\_h\_numbering @@ -40,7 +64,7 @@ A to H numbering mapping. Dictionary mapping string A numbering such as ‘1’, ‘3a’ etc from forces modes to H integer numbering - + ### cubic\_force\_constants @@ -54,7 +78,7 @@ Cubic force constants. (3 indices, 3 values) A list of tuples each with 3 index values and 3 constant values. An empty list is returned if no such data is present in the log. - + ### log @@ -64,7 +88,7 @@ The complete Gaussian log in the form of a list of strings. `List`\[`str`] - + ### quadratic\_force\_constants @@ -78,7 +102,7 @@ Quadratic force constants. (2 indices, 3 values) A list of tuples each with 2 index values and 3 constant values. An empty list is returned if no such data is present in the log. - + ### quartic\_force\_constants @@ -91,3 +115,4 @@ Quartic force constants. (4 indices, 3 values) **Returns** A list of tuples each with 4 index values and 3 constant values. An empty list is returned if no such data is present in the log. + 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 f867abd5f77..9582539afdb 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HDF5Driver.md @@ -1,14 +1,22 @@ -# HDF5Driver +--- +title: HDF5Driver +description: API reference for qiskit.chemistry.drivers.HDF5Driver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.HDF5Driver +--- +# HDF5Driver + -`HDF5Driver(hdf5_input='molecule.hdf5')` +`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` Qiskit chemistry driver reading an HDF5 file. -The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance. +The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") instance. **Parameters** @@ -16,13 +24,29 @@ The HDF5 file is as saved from a [`QMolecule`](qiskit.chemistry.QMolecule#qiskit ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`run`](qiskit.chemistry.drivers.HDF5Driver.run#qiskit.chemistry.drivers.HDF5Driver.run "qiskit.chemistry.drivers.HDF5Driver.run") | Runs driver to produce a QMolecule output. | +### run -## Attributes + + +`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. + +**Return type** + +`QMolecule` + +**Returns** +A QMolecule containing the molecular data. +**Raises** + +**LookupError** – file not found. + +## Attributes + + ### basis @@ -32,7 +56,7 @@ return basis `str` - + ### hf\_method @@ -42,7 +66,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -52,7 +76,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -66,8 +90,9 @@ True for derived classes that support Molecule. True if Molecule is supported. - + ### work\_path Returns work path. + 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 3b882c85761..6289aa7eb45 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.HFMethodType.md @@ -1,8 +1,16 @@ -# HFMethodType +--- +title: HFMethodType +description: API reference for qiskit.chemistry.drivers.HFMethodType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.HFMethodType +--- +# HFMethodType + -`HFMethodType(value)` +`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` @@ -10,20 +18,21 @@ HFMethodType Enum ## Attributes - + ### RHF `= 'rhf'` - + ### ROHF `= 'rohf'` - + ### UHF `= 'uhf'` + 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 12b817a72b0..410096c76a9 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.InitialGuess.md @@ -1,8 +1,16 @@ -# InitialGuess +--- +title: InitialGuess +description: API reference for qiskit.chemistry.drivers.InitialGuess +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.InitialGuess +--- +# InitialGuess + -`InitialGuess(value)` +`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` @@ -10,20 +18,21 @@ Initial Guess Enum ## Attributes - + ### ATOM `= 'atom'` - + ### HCORE `= '1e'` - + ### MINAO `= 'minao'` + 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 05bae556406..ec18e83e10f 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.Molecule.md @@ -1,8 +1,16 @@ -# Molecule +--- +title: Molecule +description: API reference for qiskit.chemistry.drivers.Molecule +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.Molecule +--- +# Molecule + -`Molecule(geometry, multiplicity=1, charge=0, degrees_of_freedom=None, masses=None)` +`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` @@ -24,18 +32,129 @@ This module implements an interface for a driver-independent, i.e. generic molec ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`absolute_angle`](qiskit.chemistry.drivers.Molecule.absolute_angle#qiskit.chemistry.drivers.Molecule.absolute_angle "qiskit.chemistry.drivers.Molecule.absolute_angle") | **type angle**`float` | -| [`absolute_bending`](qiskit.chemistry.drivers.Molecule.absolute_bending#qiskit.chemistry.drivers.Molecule.absolute_bending "qiskit.chemistry.drivers.Molecule.absolute_bending") | **type bend**`float` | -| [`absolute_distance`](qiskit.chemistry.drivers.Molecule.absolute_distance#qiskit.chemistry.drivers.Molecule.absolute_distance "qiskit.chemistry.drivers.Molecule.absolute_distance") | **type distance**`float` | -| [`absolute_stretching`](qiskit.chemistry.drivers.Molecule.absolute_stretching#qiskit.chemistry.drivers.Molecule.absolute_stretching "qiskit.chemistry.drivers.Molecule.absolute_stretching") | **type perturbation**`float` | -| [`relative_bending`](qiskit.chemistry.drivers.Molecule.relative_bending#qiskit.chemistry.drivers.Molecule.relative_bending "qiskit.chemistry.drivers.Molecule.relative_bending") | **type bend**`float` | -| [`relative_stretching`](qiskit.chemistry.drivers.Molecule.relative_stretching#qiskit.chemistry.drivers.Molecule.relative_stretching "qiskit.chemistry.drivers.Molecule.relative_stretching") | **type perturbation**`float` | +### absolute\_angle -## Attributes + + +`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** + +* **angle** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* +* **geometry** (`List`\[`Tuple`\[`str`, `List`\[`float`]]]) – The initial geometry to perturb. +* **atom\_trio** (`Tuple`\[`int`, `int`, `int`]) – A tuple with three integers, indexing which atoms from the starting geometry should be bent apart. **Atom1 is bent \*away\* from Atom3 by an angle whose vertex is Atom2 and equal to \*\*angle**, while Atom2 and Atom3 remain stationary.\*\* + +**Return type** + +`List`\[`Tuple`\[`str`, `List`\[`float`]]] + +**Returns** + +end geometry + +### absolute\_bending + + + +`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** + +* **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* +* **geometry** (`List`\[`Tuple`\[`str`, `List`\[`float`]]]) – The initial geometry to perturb. +* **atom\_trio** (`Tuple`\[`int`, `int`, `int`]) – A tuple with three integers, indexing which atoms from the starting geometry should be bent apart. **Atom1 is bent \*away\* from Atom3 by an angle whose vertex is Atom2 and equal to the initial angle \*\*plus** bend, while Atom2 and Atom3 remain stationary.\*\* + +**Return type** + +`List`\[`Tuple`\[`str`, `List`\[`float`]]] + +**Returns** + +end geometry + +### absolute\_distance + + + +`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** + +* **distance** (`float`) – The (new) distance between the two atoms. +* **geometry** (`List`\[`Tuple`\[`str`, `List`\[`float`]]]) – The initial geometry to perturb. +* **atom\_pair** (`Tuple`\[`int`, `int`]) – A tuple with two integers, indexing which atoms from the starting geometry should be moved apart. **Atom1 is moved away (at the given distance) from Atom2, while Atom2 remains stationary.** + +**Return type** + +`List`\[`Tuple`\[`str`, `List`\[`float`]]] + +**Returns** + +end geometry + +### absolute\_stretching + + + +`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** + +* **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch + old distance) +* **geometry** (`List`\[`Tuple`\[`str`, `List`\[`float`]]]) – The initial geometry to perturb. +* **atom\_pair** (`Tuple`\[`int`, `int`]) – A tuple with two integers, indexing which atoms from the starting geometry should be stretched apart. **Atom1 is stretched away from Atom2, while Atom2 remains stationary.** + +**Return type** + +`List`\[`Tuple`\[`str`, `List`\[`float`]]] + +**Returns** + +end geometry + +### relative\_bending + + + +`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** + +* **bend** (`float`) – The magnitude of the perturbation in **radians**. **Positive bend is always in the direction toward Atom3.** the direction of increasing the starting angle.\*\* +* **geometry** (`List`\[`Tuple`\[`str`, `List`\[`float`]]]) – The initial geometry to perturb. +* **atom\_trio** (`Tuple`\[`int`, `int`, `int`]) – A tuple with three integers, indexing which atoms from the starting geometry should be bent apart. **Atom1 is bent \*away\* from Atom3 by an angle whose vertex is Atom2 and equal to the initial angle \*\*times** bend, while Atom2 and Atom3 remain stationary.\*\* + +**Return type** + +`List`\[`Tuple`\[`str`, `List`\[`float`]]] + +**Returns** + +end geometry +### relative\_stretching + + + +`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** + +* **perturbation** (`float`) – The magnitude of the stretch. (New distance = stretch \* old distance) +* **geometry** (`List`\[`Tuple`\[`str`, `List`\[`float`]]]) – The initial geometry to perturb. +* **atom\_pair** (`Tuple`\[`int`, `int`]) – A tuple with two integers, indexing which atoms from the starting geometry should be stretched apart. **Atom1 is stretched away from Atom2, while Atom2 remains stationary.** + +**Return type** + +`List`\[`Tuple`\[`str`, `List`\[`float`]]] + +**Returns** + +end geometry + +## Attributes + + ### charge @@ -45,7 +164,7 @@ Get charge `int` - + ### geometry @@ -55,7 +174,7 @@ Get geometry accounting for any perturbations `List`\[`Tuple`\[`str`, `List`\[`float`]]] - + ### masses @@ -65,7 +184,7 @@ Get masses `Optional`\[`List`\[`float`]] - + ### multiplicity @@ -75,7 +194,7 @@ Get multiplicity `int` - + ### perturbations @@ -85,8 +204,9 @@ Get perturbations `Optional`\[`List`\[`float`]] - + ### units The geometry coordinate units + 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 bf08670104e..d0a06fbbb14 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PSI4Driver.md @@ -1,8 +1,16 @@ -# PSI4Driver +--- +title: PSI4Driver +description: API reference for qiskit.chemistry.drivers.PSI4Driver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.PSI4Driver +--- +# 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=)` +`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` @@ -19,17 +27,29 @@ See [http://www.psicode.org/](http://www.psicode.org/) **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`run`](qiskit.chemistry.drivers.PSI4Driver.run#qiskit.chemistry.drivers.PSI4Driver.run "qiskit.chemistry.drivers.PSI4Driver.run") | Runs driver to produce a QMolecule output. | +### run -## Attributes + + +`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. + +**Return type** + +`QMolecule` +**Returns** + +A QMolecule containing the molecular data. + +## Attributes + ### basis @@ -39,7 +59,7 @@ return basis `str` - + ### hf\_method @@ -49,7 +69,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -59,7 +79,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -72,3 +92,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 483f13afa61..16d9f65e178 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PyQuanteDriver.md @@ -1,8 +1,16 @@ -# PyQuanteDriver +--- +title: PyQuanteDriver +description: API reference for qiskit.chemistry.drivers.PyQuanteDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.PyQuanteDriver +--- +# 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)` +`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` @@ -24,17 +32,29 @@ See [https://github.com/rpmuller/pyquante2](https://github.com/rpmuller/pyquante **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`run`](qiskit.chemistry.drivers.PyQuanteDriver.run#qiskit.chemistry.drivers.PyQuanteDriver.run "qiskit.chemistry.drivers.PyQuanteDriver.run") | Runs driver to produce a QMolecule output. | +### run -## Attributes + + +`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. + +**Return type** + +`QMolecule` +**Returns** + +A QMolecule containing the molecular data. + +## Attributes + ### basis @@ -44,7 +64,7 @@ return basis `str` - + ### hf\_method @@ -54,7 +74,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -64,7 +84,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -77,3 +97,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 2ba5c7c3e8f..f4c64cdc041 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.PySCFDriver.md @@ -1,8 +1,16 @@ -# PySCFDriver +--- +title: PySCFDriver +description: API reference for qiskit.chemistry.drivers.PySCFDriver +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.PySCFDriver +--- +# 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)` +`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` @@ -26,17 +34,29 @@ See [https://sunqm.github.io/pyscf/](https://sunqm.github.io/pyscf/) **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid Input ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`run`](qiskit.chemistry.drivers.PySCFDriver.run#qiskit.chemistry.drivers.PySCFDriver.run "qiskit.chemistry.drivers.PySCFDriver.run") | Runs driver to produce a QMolecule output. | +### run -## Attributes + + +`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. + +**Return type** + +`QMolecule` +**Returns** + +A QMolecule containing the molecular data. + +## Attributes + ### basis @@ -46,7 +66,7 @@ return basis `str` - + ### hf\_method @@ -56,7 +76,7 @@ return Hartree-Fock method `str` - + ### molecule @@ -66,7 +86,7 @@ return molecule `Optional`\[`Molecule`] - + ### supports\_molecule @@ -79,3 +99,4 @@ True for derived classes that support Molecule. **Returns** True if Molecule is supported. + 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 fa1c3f033b4..469b40c1e2a 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.UnitsType.md @@ -1,8 +1,16 @@ -# UnitsType +--- +title: UnitsType +description: API reference for qiskit.chemistry.drivers.UnitsType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.drivers.UnitsType +--- +# UnitsType + -`UnitsType(value)` +`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` @@ -10,14 +18,15 @@ Units Type Enum ## Attributes - + ### ANGSTROM `= 'Angstrom'` - + ### BOHR `= 'Bohr'` + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.md b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.md index 9aab5d1928b..155b45a7cd7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.drivers.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.drivers.md @@ -18,7 +18,7 @@ python_api_name: qiskit.chemistry.drivers Qiskit’s chemistry module requires a computational chemistry program or library, accessed via a chemistry *driver*, to be installed on the system for the electronic-structure computation of a given molecule. A driver is created with a molecular configuration, passed in the format compatible with that particular driver. This allows custom configuration specific to each computational chemistry program or library to be passed. -The chemistry module thus allows the user to configure a chemistry problem in a way that a chemist already using the underlying chemistry program or library will be familiar with. The driver is used to compute some intermediate data, which later will be used to form the input to an Aqua algorithm. Such intermediate data, is populated into a [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") object and includes the following for example: +The chemistry module thus allows the user to configure a chemistry problem in a way that a chemist already using the underlying chemistry program or library will be familiar with. The driver is used to compute some intermediate data, which later will be used to form the input to an Aqua algorithm. Such intermediate data, is populated into a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") object and includes the following for example: 1. One- and two-body integrals in Molecular Orbital (MO) basis 2. Dipole integrals @@ -32,21 +32,21 @@ Qiskit’s chemistry module offers the option to serialize the Qmolecule data in # Driver Base Class -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| [`BaseDriver`](qiskit.chemistry.drivers.BaseDriver#qiskit.chemistry.drivers.BaseDriver "qiskit.chemistry.drivers.BaseDriver") | Base class for Qiskit’s chemistry drivers. | -| [`BosonicDriver`](qiskit.chemistry.drivers.BosonicDriver#qiskit.chemistry.drivers.BosonicDriver "qiskit.chemistry.drivers.BosonicDriver") | Base class for Qiskit’s chemistry bosonic drivers. | -| [`FermionicDriver`](qiskit.chemistry.drivers.FermionicDriver#qiskit.chemistry.drivers.FermionicDriver "qiskit.chemistry.drivers.FermionicDriver") | Base class for Qiskit’s chemistry fermionic drivers. | +| | | +| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| [`BaseDriver`](qiskit.chemistry.drivers.BaseDriver "qiskit.chemistry.drivers.BaseDriver") | Base class for Qiskit’s chemistry drivers. | +| [`BosonicDriver`](qiskit.chemistry.drivers.BosonicDriver "qiskit.chemistry.drivers.BosonicDriver") | Base class for Qiskit’s chemistry bosonic drivers. | +| [`FermionicDriver`](qiskit.chemistry.drivers.FermionicDriver "qiskit.chemistry.drivers.FermionicDriver") | Base class for Qiskit’s chemistry fermionic drivers. | # Driver Common -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`Molecule`](qiskit.chemistry.drivers.Molecule#qiskit.chemistry.drivers.Molecule "qiskit.chemistry.drivers.Molecule") | Driver-independent Molecule definition. | -| [`HFMethodType`](qiskit.chemistry.drivers.HFMethodType#qiskit.chemistry.drivers.HFMethodType "qiskit.chemistry.drivers.HFMethodType") | HFMethodType Enum | -| [`UnitsType`](qiskit.chemistry.drivers.UnitsType#qiskit.chemistry.drivers.UnitsType "qiskit.chemistry.drivers.UnitsType") | Units Type Enum | -| [`BasisType`](qiskit.chemistry.drivers.BasisType#qiskit.chemistry.drivers.BasisType "qiskit.chemistry.drivers.BasisType") | Basis Type | -| [`InitialGuess`](qiskit.chemistry.drivers.InitialGuess#qiskit.chemistry.drivers.InitialGuess "qiskit.chemistry.drivers.InitialGuess") | Initial Guess Enum | +| | | +| ----------------------------------------------------------------------------------------------- | --------------------------------------- | +| [`Molecule`](qiskit.chemistry.drivers.Molecule "qiskit.chemistry.drivers.Molecule") | Driver-independent Molecule definition. | +| [`HFMethodType`](qiskit.chemistry.drivers.HFMethodType "qiskit.chemistry.drivers.HFMethodType") | HFMethodType Enum | +| [`UnitsType`](qiskit.chemistry.drivers.UnitsType "qiskit.chemistry.drivers.UnitsType") | Units Type Enum | +| [`BasisType`](qiskit.chemistry.drivers.BasisType "qiskit.chemistry.drivers.BasisType") | Basis Type | +| [`InitialGuess`](qiskit.chemistry.drivers.InitialGuess "qiskit.chemistry.drivers.InitialGuess") | Initial Guess Enum | # Drivers @@ -57,33 +57,33 @@ The drivers in the chemistry module obtain their information from classical ab-i * [PyQuante Installation](qiskit.chemistry.drivers.pyquanted) * [PYSCF Installation](qiskit.chemistry.drivers.pyscfd) -The [`HDF5Driver`](qiskit.chemistry.drivers.HDF5Driver#qiskit.chemistry.drivers.HDF5Driver "qiskit.chemistry.drivers.HDF5Driver") reads molecular data from a pre-existing HDF5 file, as saved from a [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule"), and is not dependent on any external chemistry program/library and needs no special install. +The [`HDF5Driver`](qiskit.chemistry.drivers.HDF5Driver "qiskit.chemistry.drivers.HDF5Driver") reads molecular data from a pre-existing HDF5 file, as saved from a [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule"), and is not dependent on any external chemistry program/library and needs no special install. -The [`FCIDumpDriver`](qiskit.chemistry.drivers.FCIDumpDriver#qiskit.chemistry.drivers.FCIDumpDriver "qiskit.chemistry.drivers.FCIDumpDriver") likewise reads from a pre-existing file in this case a standard FCIDump file and again needs no special install. +The [`FCIDumpDriver`](qiskit.chemistry.drivers.FCIDumpDriver "qiskit.chemistry.drivers.FCIDumpDriver") likewise reads from a pre-existing file in this case a standard FCIDump file and again needs no special install. # Fermionic Drivers -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`GaussianDriver`](qiskit.chemistry.drivers.GaussianDriver#qiskit.chemistry.drivers.GaussianDriver "qiskit.chemistry.drivers.GaussianDriver") | Qiskit chemistry driver using the Gaussian™ 16 program. | -| [`PSI4Driver`](qiskit.chemistry.drivers.PSI4Driver#qiskit.chemistry.drivers.PSI4Driver "qiskit.chemistry.drivers.PSI4Driver") | Qiskit chemistry driver using the PSI4 program. | -| [`PyQuanteDriver`](qiskit.chemistry.drivers.PyQuanteDriver#qiskit.chemistry.drivers.PyQuanteDriver "qiskit.chemistry.drivers.PyQuanteDriver") | Qiskit chemistry driver using the PyQuante2 library. | -| [`PySCFDriver`](qiskit.chemistry.drivers.PySCFDriver#qiskit.chemistry.drivers.PySCFDriver "qiskit.chemistry.drivers.PySCFDriver") | Qiskit chemistry driver using the PySCF library. | -| [`HDF5Driver`](qiskit.chemistry.drivers.HDF5Driver#qiskit.chemistry.drivers.HDF5Driver "qiskit.chemistry.drivers.HDF5Driver") | Qiskit chemistry driver reading an HDF5 file. | -| [`FCIDumpDriver`](qiskit.chemistry.drivers.FCIDumpDriver#qiskit.chemistry.drivers.FCIDumpDriver "qiskit.chemistry.drivers.FCIDumpDriver") | Qiskit chemistry driver reading an FCIDump file. | +| | | +| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| [`GaussianDriver`](qiskit.chemistry.drivers.GaussianDriver "qiskit.chemistry.drivers.GaussianDriver") | Qiskit chemistry driver using the Gaussian™ 16 program. | +| [`PSI4Driver`](qiskit.chemistry.drivers.PSI4Driver "qiskit.chemistry.drivers.PSI4Driver") | Qiskit chemistry driver using the PSI4 program. | +| [`PyQuanteDriver`](qiskit.chemistry.drivers.PyQuanteDriver "qiskit.chemistry.drivers.PyQuanteDriver") | Qiskit chemistry driver using the PyQuante2 library. | +| [`PySCFDriver`](qiskit.chemistry.drivers.PySCFDriver "qiskit.chemistry.drivers.PySCFDriver") | Qiskit chemistry driver using the PySCF library. | +| [`HDF5Driver`](qiskit.chemistry.drivers.HDF5Driver "qiskit.chemistry.drivers.HDF5Driver") | Qiskit chemistry driver reading an HDF5 file. | +| [`FCIDumpDriver`](qiskit.chemistry.drivers.FCIDumpDriver "qiskit.chemistry.drivers.FCIDumpDriver") | Qiskit chemistry driver reading an FCIDump file. | # Bosonic Drivers -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | -| [`GaussianForcesDriver`](qiskit.chemistry.drivers.GaussianForcesDriver#qiskit.chemistry.drivers.GaussianForcesDriver "qiskit.chemistry.drivers.GaussianForcesDriver") | Gaussian™ 16 forces driver. | +| | | +| ----------------------------------------------------------------------------------------------------------------------- | --------------------------- | +| [`GaussianForcesDriver`](qiskit.chemistry.drivers.GaussianForcesDriver "qiskit.chemistry.drivers.GaussianForcesDriver") | Gaussian™ 16 forces driver. | # General Driver -The [`GaussianLogDriver`](qiskit.chemistry.drivers.GaussianLogDriver#qiskit.chemistry.drivers.GaussianLogDriver "qiskit.chemistry.drivers.GaussianLogDriver") allows an arbitrary Gaussian Job Control File to be run and return a [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult#qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult") containing the log as well as ready access certain data of interest that is parsed from the log. +The [`GaussianLogDriver`](qiskit.chemistry.drivers.GaussianLogDriver "qiskit.chemistry.drivers.GaussianLogDriver") allows an arbitrary Gaussian Job Control File to be run and return a [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult") containing the log as well as ready access certain data of interest that is parsed from the log. -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`GaussianLogDriver`](qiskit.chemistry.drivers.GaussianLogDriver#qiskit.chemistry.drivers.GaussianLogDriver "qiskit.chemistry.drivers.GaussianLogDriver") | Gaussian™ 16 log driver. | -| [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult#qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult") | Result for Gaussian™ 16 log driver. | +| | | +| -------------------------------------------------------------------------------------------------------------- | ----------------------------------- | +| [`GaussianLogDriver`](qiskit.chemistry.drivers.GaussianLogDriver "qiskit.chemistry.drivers.GaussianLogDriver") | Gaussian™ 16 log driver. | +| [`GaussianLogResult`](qiskit.chemistry.drivers.GaussianLogResult "qiskit.chemistry.drivers.GaussianLogResult") | Result for Gaussian™ 16 log driver. | 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 4b11fc1f5cc..67d1f416cb9 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.BOPESSamplerResult.md @@ -1,8 +1,16 @@ -# BOPESSamplerResult +--- +title: BOPESSamplerResult +description: API reference for qiskit.chemistry.results.BOPESSamplerResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.results.BOPESSamplerResult +--- +# BOPESSamplerResult + -`BOPESSamplerResult(points, energies, raw_results)` +`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` @@ -12,13 +20,21 @@ Creates an new instance of the result. :type points: `List`\[`float`] :param poi ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`point_results`](qiskit.chemistry.results.BOPESSamplerResult.point_results#qiskit.chemistry.results.BOPESSamplerResult.point_results "qiskit.chemistry.results.BOPESSamplerResult.point_results") | returns all results for a specific point. | +### point\_results -## Attributes + + +`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. + +**Return type** + +`EigenstateResult` +## Attributes + ### energies @@ -28,7 +44,7 @@ returns list of energies. `List`\[`float`] - + ### points @@ -38,7 +54,7 @@ returns list of points. `List`\[`float`] - + ### raw\_results @@ -47,3 +63,4 @@ returns all results for all points. **Return type** `Dict`\[`float`, `EigenstateResult`] + 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 a83416a5511..767ebecf173 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.EigenstateResult.md @@ -1,8 +1,16 @@ -# EigenstateResult +--- +title: EigenstateResult +description: API reference for qiskit.chemistry.results.EigenstateResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.results.EigenstateResult +--- +# EigenstateResult + -`EigenstateResult(a_dict=None)` +`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` @@ -10,24 +18,113 @@ The eigenstate result interface. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.chemistry.results.EigenstateResult.clear#qiskit.chemistry.results.EigenstateResult.clear "qiskit.chemistry.results.EigenstateResult.clear") | **rtype**`None` | -| [`combine`](qiskit.chemistry.results.EigenstateResult.combine#qiskit.chemistry.results.EigenstateResult.combine "qiskit.chemistry.results.EigenstateResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.chemistry.results.EigenstateResult.copy#qiskit.chemistry.results.EigenstateResult.copy "qiskit.chemistry.results.EigenstateResult.copy") | | -| [`fromkeys`](qiskit.chemistry.results.EigenstateResult.fromkeys#qiskit.chemistry.results.EigenstateResult.fromkeys "qiskit.chemistry.results.EigenstateResult.fromkeys") | | -| [`get`](qiskit.chemistry.results.EigenstateResult.get#qiskit.chemistry.results.EigenstateResult.get "qiskit.chemistry.results.EigenstateResult.get") | | -| [`items`](qiskit.chemistry.results.EigenstateResult.items#qiskit.chemistry.results.EigenstateResult.items "qiskit.chemistry.results.EigenstateResult.items") | | -| [`keys`](qiskit.chemistry.results.EigenstateResult.keys#qiskit.chemistry.results.EigenstateResult.keys "qiskit.chemistry.results.EigenstateResult.keys") | | -| [`pop`](qiskit.chemistry.results.EigenstateResult.pop#qiskit.chemistry.results.EigenstateResult.pop "qiskit.chemistry.results.EigenstateResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.chemistry.results.EigenstateResult.popitem#qiskit.chemistry.results.EigenstateResult.popitem "qiskit.chemistry.results.EigenstateResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.chemistry.results.EigenstateResult.setdefault#qiskit.chemistry.results.EigenstateResult.setdefault "qiskit.chemistry.results.EigenstateResult.setdefault") | | -| [`update`](qiskit.chemistry.results.EigenstateResult.update#qiskit.chemistry.results.EigenstateResult.update "qiskit.chemistry.results.EigenstateResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.chemistry.results.EigenstateResult.values#qiskit.chemistry.results.EigenstateResult.values "qiskit.chemistry.results.EigenstateResult.values") | | +### clear -## Attributes + + +`EigenstateResult.clear()` + +**Return type** + +`None` + +### combine + + + +`EigenstateResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`EigenstateResult.copy()` + +### fromkeys + + + +`classmethod EigenstateResult.fromkeys(iterable, value=None)` + +### get + + + +`EigenstateResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`EigenstateResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`EigenstateResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + +`EigenstateResult.pop(key, default=None)` +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`EigenstateResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`EigenstateResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`EigenstateResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`EigenstateResult.values() → an object providing a view on D’s values` + +## Attributes + + ### aux\_operator\_eigenvalues @@ -37,7 +134,7 @@ return aux operator eigen values `Optional`\[`List`\[`float`]] - + ### eigenenergies @@ -47,7 +144,7 @@ returns eigen energies `Optional`\[`ndarray`] - + ### eigenstates @@ -57,7 +154,7 @@ returns eigen states `Optional`\[`List`\[`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]]] - + ### groundenergy @@ -67,7 +164,7 @@ returns ground energy `Optional`\[`float`] - + ### groundstate @@ -77,7 +174,7 @@ returns ground state `Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`, `None`] - + ### raw\_result @@ -86,3 +183,4 @@ Returns the raw algorithm result. **Return type** `Optional`\[`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 d5387277f36..71c4ad2f861 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.ElectronicStructureResult.md @@ -1,8 +1,16 @@ -# ElectronicStructureResult +--- +title: ElectronicStructureResult +description: API reference for qiskit.chemistry.results.ElectronicStructureResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.results.ElectronicStructureResult +--- +# ElectronicStructureResult + -`ElectronicStructureResult(a_dict=None)` +`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` @@ -10,26 +18,133 @@ The electronic structure result. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.chemistry.results.ElectronicStructureResult.clear#qiskit.chemistry.results.ElectronicStructureResult.clear "qiskit.chemistry.results.ElectronicStructureResult.clear") | **rtype**`None` | -| [`combine`](qiskit.chemistry.results.ElectronicStructureResult.combine#qiskit.chemistry.results.ElectronicStructureResult.combine "qiskit.chemistry.results.ElectronicStructureResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.chemistry.results.ElectronicStructureResult.copy#qiskit.chemistry.results.ElectronicStructureResult.copy "qiskit.chemistry.results.ElectronicStructureResult.copy") | | -| [`fromkeys`](qiskit.chemistry.results.ElectronicStructureResult.fromkeys#qiskit.chemistry.results.ElectronicStructureResult.fromkeys "qiskit.chemistry.results.ElectronicStructureResult.fromkeys") | | -| [`get`](qiskit.chemistry.results.ElectronicStructureResult.get#qiskit.chemistry.results.ElectronicStructureResult.get "qiskit.chemistry.results.ElectronicStructureResult.get") | | -| [`has_dipole`](qiskit.chemistry.results.ElectronicStructureResult.has_dipole#qiskit.chemistry.results.ElectronicStructureResult.has_dipole "qiskit.chemistry.results.ElectronicStructureResult.has_dipole") | Returns whether dipole moment is present in result or not | -| [`has_observables`](qiskit.chemistry.results.ElectronicStructureResult.has_observables#qiskit.chemistry.results.ElectronicStructureResult.has_observables "qiskit.chemistry.results.ElectronicStructureResult.has_observables") | Returns whether result has aux op observables such as spin, num particles | -| [`items`](qiskit.chemistry.results.ElectronicStructureResult.items#qiskit.chemistry.results.ElectronicStructureResult.items "qiskit.chemistry.results.ElectronicStructureResult.items") | | -| [`keys`](qiskit.chemistry.results.ElectronicStructureResult.keys#qiskit.chemistry.results.ElectronicStructureResult.keys "qiskit.chemistry.results.ElectronicStructureResult.keys") | | -| [`pop`](qiskit.chemistry.results.ElectronicStructureResult.pop#qiskit.chemistry.results.ElectronicStructureResult.pop "qiskit.chemistry.results.ElectronicStructureResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.chemistry.results.ElectronicStructureResult.popitem#qiskit.chemistry.results.ElectronicStructureResult.popitem "qiskit.chemistry.results.ElectronicStructureResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.chemistry.results.ElectronicStructureResult.setdefault#qiskit.chemistry.results.ElectronicStructureResult.setdefault "qiskit.chemistry.results.ElectronicStructureResult.setdefault") | | -| [`update`](qiskit.chemistry.results.ElectronicStructureResult.update#qiskit.chemistry.results.ElectronicStructureResult.update "qiskit.chemistry.results.ElectronicStructureResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.chemistry.results.ElectronicStructureResult.values#qiskit.chemistry.results.ElectronicStructureResult.values "qiskit.chemistry.results.ElectronicStructureResult.values") | | +### clear -## Attributes + + +`ElectronicStructureResult.clear()` + +**Return type** + +`None` + +### combine + + + +`ElectronicStructureResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + + +`ElectronicStructureResult.copy()` + +### fromkeys + + + +`classmethod ElectronicStructureResult.fromkeys(iterable, value=None)` + +### get + + + +`ElectronicStructureResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### has\_dipole + + + +`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 + +**Return type** + +`bool` + +### has\_observables + + + +`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 + +### items + + + +`ElectronicStructureResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`ElectronicStructureResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`ElectronicStructureResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` +### popitem + + +`ElectronicStructureResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`ElectronicStructureResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`ElectronicStructureResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`ElectronicStructureResult.values() → an object providing a view on D’s values` + +## Attributes + + ### aux\_operator\_eigenvalues @@ -39,7 +154,7 @@ return aux operator eigen values `Optional`\[`List`\[`float`]] - + ### computed\_dipole\_moment @@ -49,7 +164,7 @@ Returns computed electronic part of dipole moment `Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]] - + ### computed\_energies @@ -59,7 +174,7 @@ Returns computed electronic part of ground state energy `ndarray` - + ### dipole\_moment @@ -69,7 +184,7 @@ Returns dipole moment `Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]] - + ### dipole\_moment\_in\_debye @@ -79,7 +194,7 @@ Returns dipole moment in Debye `Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]] - + ### eigenenergies @@ -89,7 +204,7 @@ returns eigen energies `Optional`\[`ndarray`] - + ### eigenstates @@ -99,7 +214,7 @@ returns eigen states `Optional`\[`List`\[`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]]] - + ### electronic\_dipole\_moment @@ -109,7 +224,7 @@ Returns electronic dipole moment `Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]] - + ### electronic\_energies @@ -119,7 +234,7 @@ Returns electronic part of ground state energy `ndarray` - + ### formatted @@ -129,7 +244,7 @@ Formatted result as a list of strings `List`\[`str`] - + ### frozen\_extracted\_dipole\_moment @@ -139,7 +254,7 @@ Returns frozen extracted part of dipole moment `Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]] - + ### frozen\_extracted\_energy @@ -149,7 +264,7 @@ Returns frozen extracted part of ground state energy `float` - + ### groundenergy @@ -159,7 +274,7 @@ returns ground energy `Optional`\[`float`] - + ### groundstate @@ -169,7 +284,7 @@ returns ground state `Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`, `None`] - + ### hartree\_fock\_energy @@ -179,7 +294,7 @@ Returns Hartree-Fock energy `float` - + ### magnetization @@ -189,7 +304,7 @@ Returns measured magnetization `Optional`\[`List`\[`float`]] - + ### nuclear\_dipole\_moment @@ -199,7 +314,7 @@ Returns nuclear dipole moment X,Y,Z components in A.U when available from driver `Optional`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]] - + ### nuclear\_repulsion\_energy @@ -209,7 +324,7 @@ Returns nuclear repulsion energy when available from driver `Optional`\[`float`] - + ### num\_particles @@ -219,7 +334,7 @@ Returns measured number of particles `Optional`\[`List`\[`float`]] - + ### ph\_extracted\_dipole\_moment @@ -229,7 +344,7 @@ Returns particle hole extracted part of dipole moment `Optional`\[`List`\[`Tuple`\[`Optional`\[`float`], `Optional`\[`float`], `Optional`\[`float`]]]] - + ### ph\_extracted\_energy @@ -239,7 +354,7 @@ Returns particle hole extracted part of ground state energy `float` - + ### raw\_result @@ -249,7 +364,7 @@ Returns the raw algorithm result. `Optional`\[`AlgorithmResult`] - + ### reverse\_dipole\_sign @@ -259,7 +374,7 @@ Returns if electronic dipole moment sign should be reversed when adding to nucle `bool` - + ### spin @@ -269,7 +384,7 @@ Returns computed spin `Optional`\[`List`\[`float`]] - + ### total\_angular\_momentum @@ -279,7 +394,7 @@ Returns total angular momentum (S^2) `Optional`\[`List`\[`float`]] - + ### total\_dipole\_moment @@ -289,7 +404,7 @@ Returns total dipole of moment `Optional`\[`List`\[`float`]] - + ### total\_dipole\_moment\_in\_debye @@ -299,7 +414,7 @@ Returns total dipole of moment in Debye `Optional`\[`List`\[`float`]] - + ### total\_energies @@ -308,3 +423,4 @@ Returns ground state energy if nuclear\_repulsion\_energy is available from driv **Return type** `ndarray` + 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 5cf5178336f..cddb6391c36 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.VibronicStructureResult.md @@ -1,8 +1,16 @@ -# VibronicStructureResult +--- +title: VibronicStructureResult +description: API reference for qiskit.chemistry.results.VibronicStructureResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.results.VibronicStructureResult +--- +# VibronicStructureResult + -`VibronicStructureResult(a_dict=None)` +`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` @@ -10,24 +18,113 @@ The vibronic structure result. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.chemistry.results.VibronicStructureResult.clear#qiskit.chemistry.results.VibronicStructureResult.clear "qiskit.chemistry.results.VibronicStructureResult.clear") | **rtype**`None` | -| [`combine`](qiskit.chemistry.results.VibronicStructureResult.combine#qiskit.chemistry.results.VibronicStructureResult.combine "qiskit.chemistry.results.VibronicStructureResult.combine") | Any property from the argument that exists in the receiver is updated. | -| [`copy`](qiskit.chemistry.results.VibronicStructureResult.copy#qiskit.chemistry.results.VibronicStructureResult.copy "qiskit.chemistry.results.VibronicStructureResult.copy") | | -| [`fromkeys`](qiskit.chemistry.results.VibronicStructureResult.fromkeys#qiskit.chemistry.results.VibronicStructureResult.fromkeys "qiskit.chemistry.results.VibronicStructureResult.fromkeys") | | -| [`get`](qiskit.chemistry.results.VibronicStructureResult.get#qiskit.chemistry.results.VibronicStructureResult.get "qiskit.chemistry.results.VibronicStructureResult.get") | | -| [`items`](qiskit.chemistry.results.VibronicStructureResult.items#qiskit.chemistry.results.VibronicStructureResult.items "qiskit.chemistry.results.VibronicStructureResult.items") | | -| [`keys`](qiskit.chemistry.results.VibronicStructureResult.keys#qiskit.chemistry.results.VibronicStructureResult.keys "qiskit.chemistry.results.VibronicStructureResult.keys") | | -| [`pop`](qiskit.chemistry.results.VibronicStructureResult.pop#qiskit.chemistry.results.VibronicStructureResult.pop "qiskit.chemistry.results.VibronicStructureResult.pop") | If key is not found, d is returned if given, otherwise KeyError is raised. | -| [`popitem`](qiskit.chemistry.results.VibronicStructureResult.popitem#qiskit.chemistry.results.VibronicStructureResult.popitem "qiskit.chemistry.results.VibronicStructureResult.popitem") | as a 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.chemistry.results.VibronicStructureResult.setdefault#qiskit.chemistry.results.VibronicStructureResult.setdefault "qiskit.chemistry.results.VibronicStructureResult.setdefault") | | -| [`update`](qiskit.chemistry.results.VibronicStructureResult.update#qiskit.chemistry.results.VibronicStructureResult.update "qiskit.chemistry.results.VibronicStructureResult.update") | If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v | -| [`values`](qiskit.chemistry.results.VibronicStructureResult.values#qiskit.chemistry.results.VibronicStructureResult.values "qiskit.chemistry.results.VibronicStructureResult.values") | | +### clear -## Attributes + + +`VibronicStructureResult.clear()` + +**Return type** + +`None` + +### combine + + + +`VibronicStructureResult.combine(result)` + +Any property from the argument that exists in the receiver is updated. :type result: `AlgorithmResult` :param result: Argument result with properties to be set. + +**Raises** + +**TypeError** – Argument is None + +**Return type** + +`None` + +### copy + + +`VibronicStructureResult.copy()` +### fromkeys + + + +`classmethod VibronicStructureResult.fromkeys(iterable, value=None)` + +### get + + + +`VibronicStructureResult.get(k[, d]) → D[k] if k in D, else d. d defaults to None.` + +### items + + + +`VibronicStructureResult.items() → a set-like object providing a view on D’s items` + +### keys + + + +`VibronicStructureResult.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`VibronicStructureResult.pop(key, default=None)` + +If key is not found, d is returned if given, otherwise KeyError is raised. + +**Return type** + +`object` + +### popitem + + + +`VibronicStructureResult.popitem()` + +as a 2-tuple; but raise KeyError if D is empty. + +**Return type** + +`Tuple`\[`object`, `object`] + +### setdefault + + + +`VibronicStructureResult.setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D` + +### update + + + +`VibronicStructureResult.update(*args, **kwargs)` + +If E present and has a .keys() method, does: for k in E: D\[k] = E\[k] If E present and lacks .keys() method, does: for (k, v) in E: D\[k] = v In either case, this is followed by: for k, v in F.items(): D\[k] = v + +**Return type** + +`None` + +### values + + + +`VibronicStructureResult.values() → an object providing a view on D’s values` + +## Attributes + + ### algorithm\_result @@ -37,7 +134,7 @@ Returns raw algorithm result `AlgorithmResult` - + ### aux\_operator\_eigenvalues @@ -47,7 +144,7 @@ return aux operator eigen values `Optional`\[`List`\[`float`]] - + ### computed\_vibronic\_energies @@ -57,7 +154,7 @@ Returns computed electronic part of ground state energy `ndarray` - + ### eigenenergies @@ -67,7 +164,7 @@ returns eigen energies `Optional`\[`ndarray`] - + ### eigenstates @@ -77,7 +174,7 @@ returns eigen states `Optional`\[`List`\[`Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`]]] - + ### formatted @@ -87,7 +184,7 @@ Formatted result as a list of strings `List`\[`str`] - + ### groundenergy @@ -97,7 +194,7 @@ returns ground energy `Optional`\[`float`] - + ### groundstate @@ -107,7 +204,7 @@ returns ground state `Union`\[`str`, `dict`, `Result`, `list`, `ndarray`, `Statevector`, `QuantumCircuit`, `Instruction`, `OperatorBase`, `None`] - + ### num\_occupied\_modals\_per\_mode @@ -117,7 +214,7 @@ Returns the number of occupied modal per mode `Optional`\[`List`\[`float`]] - + ### raw\_result @@ -126,3 +223,4 @@ Returns the raw algorithm result. **Return type** `Optional`\[`AlgorithmResult`] + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.results.md b/docs/api/qiskit/0.32/qiskit.chemistry.results.md index 90c4d9e5d66..6d08adb6cfa 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.results.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.results.md @@ -20,10 +20,10 @@ Qiskit’s chemistry results for ground and excited states, both Fermionic and B # Results -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`EigenstateResult`](qiskit.chemistry.results.EigenstateResult#qiskit.chemistry.results.EigenstateResult "qiskit.chemistry.results.EigenstateResult") | The eigenstate result interface. | -| [`BOPESSamplerResult`](qiskit.chemistry.results.BOPESSamplerResult#qiskit.chemistry.results.BOPESSamplerResult "qiskit.chemistry.results.BOPESSamplerResult") | The BOPES Sampler result | -| [`ElectronicStructureResult`](qiskit.chemistry.results.ElectronicStructureResult#qiskit.chemistry.results.ElectronicStructureResult "qiskit.chemistry.results.ElectronicStructureResult") | The electronic structure result. | -| [`VibronicStructureResult`](qiskit.chemistry.results.VibronicStructureResult#qiskit.chemistry.results.VibronicStructureResult "qiskit.chemistry.results.VibronicStructureResult") | The vibronic structure result. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | +| [`EigenstateResult`](qiskit.chemistry.results.EigenstateResult "qiskit.chemistry.results.EigenstateResult") | The eigenstate result interface. | +| [`BOPESSamplerResult`](qiskit.chemistry.results.BOPESSamplerResult "qiskit.chemistry.results.BOPESSamplerResult") | The BOPES Sampler result | +| [`ElectronicStructureResult`](qiskit.chemistry.results.ElectronicStructureResult "qiskit.chemistry.results.ElectronicStructureResult") | The electronic structure result. | +| [`VibronicStructureResult`](qiskit.chemistry.results.VibronicStructureResult "qiskit.chemistry.results.VibronicStructureResult") | The vibronic structure result. | 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 18d3407f5c9..ce3d3d3d772 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicQubitMappingType.md @@ -1,8 +1,16 @@ -# BosonicQubitMappingType +--- +title: BosonicQubitMappingType +description: API reference for qiskit.chemistry.transformations.BosonicQubitMappingType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.transformations.BosonicQubitMappingType +--- +# BosonicQubitMappingType + -`BosonicQubitMappingType(value)` +`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` @@ -10,8 +18,9 @@ BosonicQubitMappingType enum ## Attributes - + ### DIRECT `= 'direct'` + 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 b2187bc8318..3127a618daa 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformation.md @@ -1,8 +1,16 @@ -# BosonicTransformation +--- +title: BosonicTransformation +description: API reference for qiskit.chemistry.transformations.BosonicTransformation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.transformations.BosonicTransformation +--- +# BosonicTransformation + -`BosonicTransformation(qubit_mapping=, transformation_type=, basis_size=2, truncation=3)` +`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` @@ -17,16 +25,80 @@ A vibronic Hamiltonian operator representing the energy of the nuclei in the mol ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`build_hopping_operators`](qiskit.chemistry.transformations.BosonicTransformation.build_hopping_operators#qiskit.chemistry.transformations.BosonicTransformation.build_hopping_operators "qiskit.chemistry.transformations.BosonicTransformation.build_hopping_operators") | **type excitations**`Union`\[`str`, `List`\[`List`\[`int`]]] | -| [`get_default_filter_criterion`](qiskit.chemistry.transformations.BosonicTransformation.get_default_filter_criterion#qiskit.chemistry.transformations.BosonicTransformation.get_default_filter_criterion "qiskit.chemistry.transformations.BosonicTransformation.get_default_filter_criterion") | Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. | -| [`interpret`](qiskit.chemistry.transformations.BosonicTransformation.interpret#qiskit.chemistry.transformations.BosonicTransformation.interpret "qiskit.chemistry.transformations.BosonicTransformation.interpret") | Interprets an EigenstateResult in the context of this transformation. | -| [`transform`](qiskit.chemistry.transformations.BosonicTransformation.transform#qiskit.chemistry.transformations.BosonicTransformation.transform "qiskit.chemistry.transformations.BosonicTransformation.transform") | Transformation to qubit operator from the driver | +### build\_hopping\_operators -## Attributes + + +`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** + +**excitations** (`Union`\[`str`, `List`\[`List`\[`int`]]]) – + +**Return type** + +`Tuple`\[`Dict`\[`str`, `WeightedPauliOperator`], `Dict`, `Dict`\[`str`, `List`\[`List`\[`int`]]]] + +**Returns** + +Dict of hopping operators, dict of commutativity types and dict of excitation indices + +### get\_default\_filter\_criterion + + + +`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. + +**Return type** + +`Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] + +### interpret + + + +`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. + +**Parameters** + +**raw\_result** (`Union`\[`EigenstateResult`, `EigensolverResult`, `MinimumEigensolverResult`]) – an eigenstate result object. + +**Return type** + +`VibronicStructureResult` + +**Returns** + +An vibronic structure result. + +### transform + + + +`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 + +**Parameters** + +* **driver** (`BaseDriver`) – BaseDriver +* **aux\_operators** (`Optional`\[`List`\[`Any`]]) – Optional additional aux ops to evaluate + +**Return type** + +`Tuple`\[`WeightedPauliOperator`, `List`\[`WeightedPauliOperator`]] + +**Returns** +qubit operator, auxiliary operators +## Attributes + + ### basis @@ -36,7 +108,7 @@ returns the basis (number of modals per mode) `Union`\[`int`, `List`\[`int`]] - + ### commutation\_rule @@ -46,7 +118,7 @@ Getter of the commutation rule `bool` - + ### num\_modes @@ -60,8 +132,9 @@ Returns `int` - + ### untapered\_qubit\_op Getter for the untapered qubit operator + 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 3bb074b6b4f..bb6afdb8bce 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.BosonicTransformationType.md @@ -1,8 +1,16 @@ -# BosonicTransformationType +--- +title: BosonicTransformationType +description: API reference for qiskit.chemistry.transformations.BosonicTransformationType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.transformations.BosonicTransformationType +--- +# BosonicTransformationType + -`BosonicTransformationType(value)` +`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` @@ -10,8 +18,9 @@ BosonicTransformationType enum ## Attributes - + ### HARMONIC `= 'harmonic'` + 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 bc49b14bf42..3ef9d847003 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicQubitMappingType.md @@ -1,8 +1,16 @@ -# FermionicQubitMappingType +--- +title: FermionicQubitMappingType +description: API reference for qiskit.chemistry.transformations.FermionicQubitMappingType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.transformations.FermionicQubitMappingType +--- +# FermionicQubitMappingType + -`FermionicQubitMappingType(value)` +`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` @@ -10,20 +18,21 @@ FermionicQubitMappingType enum ## Attributes - + ### BRAVYI\_KITAEV `= 'bravyi_kitaev'` - + ### JORDAN\_WIGNER `= 'jordan_wigner'` - + ### PARITY `= 'parity'` + 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 2566389dc45..10bb4baa0fe 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformation.md @@ -1,8 +1,16 @@ -# FermionicTransformation +--- +title: FermionicTransformation +description: API reference for qiskit.chemistry.transformations.FermionicTransformation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.transformations.FermionicTransformation +--- +# FermionicTransformation + -`FermionicTransformation(transformation=, qubit_mapping=, two_qubit_reduction=True, freeze_core=False, orbital_reduction=None, z2symmetry_reduction=None)` +`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` @@ -19,20 +27,88 @@ A transformation from a fermionic problem, represented by a driver, to a qubit o **Raises** -[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid symmetry reduction +[**QiskitChemistryError**](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") – Invalid symmetry reduction ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`build_hopping_operators`](qiskit.chemistry.transformations.FermionicTransformation.build_hopping_operators#qiskit.chemistry.transformations.FermionicTransformation.build_hopping_operators "qiskit.chemistry.transformations.FermionicTransformation.build_hopping_operators") | Builds the product of raising and lowering operators (basic excitation operators) | -| [`get_default_filter_criterion`](qiskit.chemistry.transformations.FermionicTransformation.get_default_filter_criterion#qiskit.chemistry.transformations.FermionicTransformation.get_default_filter_criterion "qiskit.chemistry.transformations.FermionicTransformation.get_default_filter_criterion") | Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. | -| [`interpret`](qiskit.chemistry.transformations.FermionicTransformation.interpret#qiskit.chemistry.transformations.FermionicTransformation.interpret "qiskit.chemistry.transformations.FermionicTransformation.interpret") | Interprets an EigenstateResult in the context of this transformation. | -| [`transform`](qiskit.chemistry.transformations.FermionicTransformation.transform#qiskit.chemistry.transformations.FermionicTransformation.transform "qiskit.chemistry.transformations.FermionicTransformation.transform") | Transformation from the `driver` to a qubit operator. | +### build\_hopping\_operators -## Attributes + + +`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) + +**Parameters** + +**excitations** (`Union`\[`str`, `List`\[`List`\[`int`]]]) – The excitations to be included in the eom pseudo-eigenvalue problem. If a string (‘s’, ‘d’ or ‘sd’) then all excitations of the given type will be used. Otherwise a list of custom excitations can directly be provided. + +**Return type** + +`Tuple`\[`Dict`\[`str`, `WeightedPauliOperator`], `Dict`\[`str`, `List`\[`bool`]], `Dict`\[`str`, `List`\[`Any`]]] + +**Returns** + +A tuple containing the hopping operators, the types of commutativities and the excitation indices. + +### get\_default\_filter\_criterion + + + +`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. + +In the fermionic case the default filter ensures that the number of particles is being preserved. + +**Return type** + +`Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] + +### interpret + + + +`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. +**Parameters** + +**raw\_result** (`Union`\[`EigenstateResult`, `EigensolverResult`, `MinimumEigensolverResult`]) – an eigenstate result object. + +**Return type** + +`ElectronicStructureResult` + +**Returns** + +An electronic structure result. + +### transform + + + +`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. + +**Parameters** +* **driver** (`BaseDriver`) – A driver encoding the molecule information. +* **aux\_operators** (`Optional`\[`List`\[`FermionicOperator`]]) – Additional auxiliary `FermionicOperator` instances to evaluate. + +**Return type** + +`Tuple`\[`OperatorBase`, `List`\[`OperatorBase`]] + +**Returns** + +A qubit operator and a dictionary of auxiliary operators. + +## Attributes + + ### commutation\_rule @@ -42,7 +118,7 @@ Getter of the commutation rule `bool` - + ### molecule\_info @@ -52,7 +128,7 @@ Getter of the molecule information. `Dict`\[`str`, `Any`] - + ### qubit\_mapping @@ -62,8 +138,9 @@ Getter of the qubit mapping. `str` - + ### untapered\_qubit\_op Getter for the untapered 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 0bf144fd3bf..2ae6f6416e7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.FermionicTransformationType.md @@ -1,8 +1,16 @@ -# FermionicTransformationType +--- +title: FermionicTransformationType +description: API reference for qiskit.chemistry.transformations.FermionicTransformationType +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.transformations.FermionicTransformationType +--- +# FermionicTransformationType + -`FermionicTransformationType(value)` +`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` @@ -10,14 +18,15 @@ Electronic Transformation Type enum ## Attributes - + ### FULL `= 'full'` - + ### PARTICLE\_HOLE `= 'particle_hole'` + 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 e2ef956a4fb..db32514f369 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.Transformation.md @@ -1,8 +1,16 @@ -# Transformation +--- +title: Transformation +description: API reference for qiskit.chemistry.transformations.Transformation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.chemistry.transformations.Transformation +--- +# Transformation + -`Transformation` +`Transformation`[GitHub](https://github.com/qiskit-community/qiskit-aqua/tree/stable/0.9/qiskit/chemistry/transformations/transformation.py "view source code") Bases: `abc.ABC` @@ -10,16 +18,80 @@ Base class for transformation to qubit operators for chemistry problems ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`build_hopping_operators`](qiskit.chemistry.transformations.Transformation.build_hopping_operators#qiskit.chemistry.transformations.Transformation.build_hopping_operators "qiskit.chemistry.transformations.Transformation.build_hopping_operators") | Builds the product of raising and lowering operators (basic excitation operators) | -| [`get_default_filter_criterion`](qiskit.chemistry.transformations.Transformation.get_default_filter_criterion#qiskit.chemistry.transformations.Transformation.get_default_filter_criterion "qiskit.chemistry.transformations.Transformation.get_default_filter_criterion") | Returns a default filter criterion method to filter the eigenvalues computed by the eigen solver. | -| [`interpret`](qiskit.chemistry.transformations.Transformation.interpret#qiskit.chemistry.transformations.Transformation.interpret "qiskit.chemistry.transformations.Transformation.interpret") | Interprets an EigenstateResult in the context of this transformation. | -| [`transform`](qiskit.chemistry.transformations.Transformation.transform#qiskit.chemistry.transformations.Transformation.transform "qiskit.chemistry.transformations.Transformation.transform") | Transformation from the `driver` to a qubit operator. | +### build\_hopping\_operators -## Attributes + + +`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) + +**Parameters** + +**excitations** (`Union`\[`str`, `List`\[`List`\[`int`]]]) – The excitations to be included in the eom pseudo-eigenvalue problem. If a string (‘s’, ‘d’ or ‘sd’) then all excitations of the given type will be used. Otherwise a list of custom excitations can directly be provided. + +Returns: + +**Return type** + +`Tuple`\[`Dict`\[`str`, `WeightedPauliOperator`], `Dict`\[`str`, `List`\[`bool`]], `Dict`\[`str`, `List`\[`Any`]]] + +### get\_default\_filter\_criterion + + + +`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. + +**Return type** + +`Optional`\[`Callable`\[\[`Union`\[`List`, `ndarray`], `float`, `Optional`\[`List`\[`float`]]], `bool`]] + +### interpret + + + +`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. +**Parameters** + +**raw\_result** (`Union`\[`EigenstateResult`, `EigensolverResult`, `MinimumEigensolverResult`]) – an eigenstate result object. + +**Return type** + +`EigenstateResult` + +**Returns** + +An “interpreted” eigenstate result. + +### transform + + + +`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. + +**Parameters** + +* **driver** (`BaseDriver`) – A driver encoding the molecule information. +* **aux\_operators** (`Union`\[`List`\[`FermionicOperator`], `List`\[`BosonicOperator`], `None`]) – Additional auxiliary operators to evaluate. Must be of type `FermionicOperator` if the qubit transformation is fermionic and of type `BosonicOperator` it is bosonic. + +**Return type** + +`Tuple`\[`OperatorBase`, `List`\[`OperatorBase`]] + +**Returns** + +A qubit operator and a dictionary of auxiliary operators. + +## Attributes + + ### commutation\_rule @@ -28,3 +100,4 @@ Getter of the commutation rule **Return type** `bool` + diff --git a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.md b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.md index fa95989d3be..47397fcaee7 100644 --- a/docs/api/qiskit/0.32/qiskit.chemistry.transformations.md +++ b/docs/api/qiskit/0.32/qiskit.chemistry.transformations.md @@ -20,23 +20,23 @@ Transformations for both Fermionic and Bosonic operators to qubit operators. Tra # Base Transformation -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [`Transformation`](qiskit.chemistry.transformations.Transformation#qiskit.chemistry.transformations.Transformation "qiskit.chemistry.transformations.Transformation") | Base class for transformation to qubit operators for chemistry problems | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| [`Transformation`](qiskit.chemistry.transformations.Transformation "qiskit.chemistry.transformations.Transformation") | Base class for transformation to qubit operators for chemistry problems | # Fermionic Transformation -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -| [`FermionicTransformation`](qiskit.chemistry.transformations.FermionicTransformation#qiskit.chemistry.transformations.FermionicTransformation "qiskit.chemistry.transformations.FermionicTransformation") | A transformation from a fermionic problem, represented by a driver, to a qubit operator. | -| [`FermionicQubitMappingType`](qiskit.chemistry.transformations.FermionicQubitMappingType#qiskit.chemistry.transformations.FermionicQubitMappingType "qiskit.chemistry.transformations.FermionicQubitMappingType") | FermionicQubitMappingType enum | -| [`FermionicTransformationType`](qiskit.chemistry.transformations.FermionicTransformationType#qiskit.chemistry.transformations.FermionicTransformationType "qiskit.chemistry.transformations.FermionicTransformationType") | Electronic Transformation Type enum | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------- | +| [`FermionicTransformation`](qiskit.chemistry.transformations.FermionicTransformation "qiskit.chemistry.transformations.FermionicTransformation") | A transformation from a fermionic problem, represented by a driver, to a qubit operator. | +| [`FermionicQubitMappingType`](qiskit.chemistry.transformations.FermionicQubitMappingType "qiskit.chemistry.transformations.FermionicQubitMappingType") | FermionicQubitMappingType enum | +| [`FermionicTransformationType`](qiskit.chemistry.transformations.FermionicTransformationType "qiskit.chemistry.transformations.FermionicTransformationType") | Electronic Transformation Type enum | # Bosonic Transformation -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| [`BosonicTransformation`](qiskit.chemistry.transformations.BosonicTransformation#qiskit.chemistry.transformations.BosonicTransformation "qiskit.chemistry.transformations.BosonicTransformation") | A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule | -| [`BosonicQubitMappingType`](qiskit.chemistry.transformations.BosonicQubitMappingType#qiskit.chemistry.transformations.BosonicQubitMappingType "qiskit.chemistry.transformations.BosonicQubitMappingType") | BosonicQubitMappingType enum | -| [`BosonicTransformationType`](qiskit.chemistry.transformations.BosonicTransformationType#qiskit.chemistry.transformations.BosonicTransformationType "qiskit.chemistry.transformations.BosonicTransformationType") | BosonicTransformationType enum | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | +| [`BosonicTransformation`](qiskit.chemistry.transformations.BosonicTransformation "qiskit.chemistry.transformations.BosonicTransformation") | A vibronic Hamiltonian operator representing the energy of the nuclei in the molecule | +| [`BosonicQubitMappingType`](qiskit.chemistry.transformations.BosonicQubitMappingType "qiskit.chemistry.transformations.BosonicQubitMappingType") | BosonicQubitMappingType enum | +| [`BosonicTransformationType`](qiskit.chemistry.transformations.BosonicTransformationType "qiskit.chemistry.transformations.BosonicTransformationType") | BosonicTransformationType enum | diff --git a/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md b/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md index 2613d360775..8cd7b485d02 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.AncillaQubit.md @@ -1,8 +1,16 @@ -# AncillaQubit +--- +title: AncillaQubit +description: API reference for qiskit.circuit.AncillaQubit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.AncillaQubit +--- +# AncillaQubit + -`AncillaQubit(register=None, index=None)` +`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` @@ -12,23 +20,24 @@ Creates a qubit. **Parameters** -* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – Optional. A quantum register containing the bit. +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – Optional. A quantum register containing the bit. * **index** (*int*) – Optional. The index of the bit in its containing register. **Raises** -**CircuitError** – if the provided register is not a valid [`QuantumRegister`](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") +**CircuitError** – if the provided register is not a valid [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") ## Attributes - + ### index Get bit’s index. - + ### register Get bit’s register. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md b/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md index 8237b5c2c69..634b2bed559 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.AncillaRegister.md @@ -1,8 +1,16 @@ -# AncillaRegister +--- +title: AncillaRegister +description: API reference for qiskit.circuit.AncillaRegister +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.AncillaRegister +--- +# AncillaRegister + -`AncillaRegister(size=None, name=None, bits=None)` +`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` @@ -27,38 +35,43 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`qasm`](qiskit.circuit.AncillaRegister.qasm#qiskit.circuit.AncillaRegister.qasm "qiskit.circuit.AncillaRegister.qasm") | Return OPENQASM string for this register. | +### qasm -## Attributes + +`AncillaRegister.qasm()` + +Return OPENQASM string for this register. + +## Attributes + ### instances\_counter `= count(0)` - + ### name Get the register name. - + ### name\_format `= re.compile('[a-z][a-zA-Z0-9_]*')` - + ### prefix `= 'a'` - + ### size Get the register size. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md b/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md index e6a6b82a451..bf25a7cff82 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ClassicalRegister.md @@ -1,8 +1,16 @@ -# ClassicalRegister +--- +title: ClassicalRegister +description: API reference for qiskit.circuit.ClassicalRegister +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.ClassicalRegister +--- +# ClassicalRegister + -`ClassicalRegister(size=None, name=None, bits=None)` +`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` @@ -27,38 +35,43 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`qasm`](qiskit.circuit.ClassicalRegister.qasm#qiskit.circuit.ClassicalRegister.qasm "qiskit.circuit.ClassicalRegister.qasm") | Return OPENQASM string for this register. | +### qasm -## Attributes + +`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. + +## Attributes + ### instances\_counter `= count(0)` - + ### name Get the register name. - + ### name\_format `= re.compile('[a-z][a-zA-Z0-9_]*')` - + ### prefix `= 'c'` - + ### size Get the register size. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md b/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md index 0f7d0a0e523..cf55bda3d15 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Clbit.md @@ -1,8 +1,16 @@ -# Clbit +--- +title: Clbit +description: API reference for qiskit.circuit.Clbit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Clbit +--- +# Clbit + -`Clbit(register=None, index=None)` +`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` @@ -12,23 +20,24 @@ Creates a classical bit. **Parameters** -* **register** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")) – Optional. A classical register containing the bit. +* **register** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")) – Optional. A classical register containing the bit. * **index** (*int*) – Optional. The index of the bit in its containing register. **Raises** -**CircuitError** – if the provided register is not a valid [`ClassicalRegister`](qiskit.circuit.ClassicalRegister#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") +**CircuitError** – if the provided register is not a valid [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") ## Attributes - + ### index Get bit’s index. - + ### register Get bit’s register. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md b/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md index d3e1729f41e..eb392cf3a31 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ControlledGate.md @@ -1,8 +1,16 @@ -# ControlledGate +--- +title: ControlledGate +description: API reference for qiskit.circuit.ControlledGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.ControlledGate +--- +# ControlledGate + -`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)` +`ControlledGate(name, num_qubits, params, label=None, num_ctrl_qubits=1, definition=None, ctrl_state=None, base_gate=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/controlledgate.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -17,7 +25,7 @@ Create a new ControlledGate. In the new gate the first `num_ctrl_qubits` of the * **params** (`List`) – A list of parameters for the gate. * **label** (`Optional`\[`str`]) – An optional label for the gate. * **num\_ctrl\_qubits** (`Optional`\[`int`]) – Number of control qubits. -* **definition** (`Optional`\[`QuantumCircuit`]) – A list of gate rules for implementing this gate. The elements of the list are tuples of ([`Gate()`](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate"), \[qubit\_list], \[clbit\_list]). +* **definition** (`Optional`\[`QuantumCircuit`]) – A list of gate rules for implementing this gate. The elements of the list are tuples of ([`Gate()`](qiskit.circuit.Gate "qiskit.circuit.Gate"), \[qubit\_list], \[clbit\_list]). * **ctrl\_state** (`Union`\[`int`, `str`, `None`]) – The control state in decimal or as a bitstring (e.g. ‘111’). If specified as a bitstring the length must equal num\_ctrl\_qubits, MSB on left. If None, use 2\*\*num\_ctrl\_qubits-1. * **base\_gate** (`Optional`\[`Gate`]) – Gate object to be controlled. @@ -81,28 +89,300 @@ q_3: ──────■─────── ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.circuit.ControlledGate.add_decomposition#qiskit.circuit.ControlledGate.add_decomposition "qiskit.circuit.ControlledGate.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.ControlledGate.assemble#qiskit.circuit.ControlledGate.assemble "qiskit.circuit.ControlledGate.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.ControlledGate.broadcast_arguments#qiskit.circuit.ControlledGate.broadcast_arguments "qiskit.circuit.ControlledGate.broadcast_arguments") | Validation and handling of the arguments and its relationship. | -| [`c_if`](qiskit.circuit.ControlledGate.c_if#qiskit.circuit.ControlledGate.c_if "qiskit.circuit.ControlledGate.c_if") | Add classical condition on register or cbit classical and value val. | -| [`control`](qiskit.circuit.ControlledGate.control#qiskit.circuit.ControlledGate.control "qiskit.circuit.ControlledGate.control") | Return controlled version of gate. | -| [`copy`](qiskit.circuit.ControlledGate.copy#qiskit.circuit.ControlledGate.copy "qiskit.circuit.ControlledGate.copy") | Copy of the instruction. | -| [`inverse`](qiskit.circuit.ControlledGate.inverse#qiskit.circuit.ControlledGate.inverse "qiskit.circuit.ControlledGate.inverse") | Invert this gate by calling inverse on the base gate. | -| [`is_parameterized`](qiskit.circuit.ControlledGate.is_parameterized#qiskit.circuit.ControlledGate.is_parameterized "qiskit.circuit.ControlledGate.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.ControlledGate.mirror#qiskit.circuit.ControlledGate.mirror "qiskit.circuit.ControlledGate.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`power`](qiskit.circuit.ControlledGate.power#qiskit.circuit.ControlledGate.power "qiskit.circuit.ControlledGate.power") | Creates a unitary gate as gate^exponent. | -| [`qasm`](qiskit.circuit.ControlledGate.qasm#qiskit.circuit.ControlledGate.qasm "qiskit.circuit.ControlledGate.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.ControlledGate.repeat#qiskit.circuit.ControlledGate.repeat "qiskit.circuit.ControlledGate.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.ControlledGate.reverse_ops#qiskit.circuit.ControlledGate.reverse_ops "qiskit.circuit.ControlledGate.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.circuit.ControlledGate.soft_compare#qiskit.circuit.ControlledGate.soft_compare "qiskit.circuit.ControlledGate.soft_compare") | Soft comparison between gates. | -| [`to_matrix`](qiskit.circuit.ControlledGate.to_matrix#qiskit.circuit.ControlledGate.to_matrix "qiskit.circuit.ControlledGate.to_matrix") | Return a Numpy.array for the gate unitary matrix. | -| [`validate_parameter`](qiskit.circuit.ControlledGate.validate_parameter#qiskit.circuit.ControlledGate.validate_parameter "qiskit.circuit.ControlledGate.validate_parameter") | Gate parameters should be int, float, or ParameterExpression | +### add\_decomposition -## Attributes + + +`ControlledGate.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`ControlledGate.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`ControlledGate.broadcast_arguments(qargs, cargs)` + +Validation and handling of the arguments and its relationship. + +For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: + +```python +in: [[q[0],q[1]], q[2]],[] +outs: [q[0], q[2]], [] + [q[1], q[2]], [] +``` + +The general broadcasting rules are: + +> * If len(qargs) == 1: +> +> ```python +> [q[0], q[1]] -> [q[0]],[q[1]] +> ``` +> +> * If len(qargs) == 2: +> +> ```python +> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]] +> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]] +> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]] +> ``` +> +> * If len(qargs) >= 3: +> +> ```python +> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...] +> ``` + +**Parameters** + +* **qargs** (`List`) – List of quantum bit arguments. +* **cargs** (`List`) – List of classical bit arguments. + +**Return type** + +`Tuple`\[`List`, `List`] + +**Returns** + +A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`ControlledGate.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### control + + + +`ControlledGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` + +Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. + +**Parameters** + +* **num\_ctrl\_qubits** (`Optional`\[`int`]) – number of controls to add to gate (default=1) +* **label** (`Optional`\[`str`]) – optional gate label +* **ctrl\_state** (`Union`\[`int`, `str`, `None`]) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use 2\*\*num\_ctrl\_qubits-1. + +**Returns** + +Controlled version of gate. This default algorithm uses num\_ctrl\_qubits-1 ancillae qubits so returns a gate of size num\_qubits + 2\*num\_ctrl\_qubits - 1. + +**Return type** + +[qiskit.circuit.ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +**Raises** + +**QiskitError** – unrecognized mode or invalid ctrl\_state + +### copy + + + +`ControlledGate.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`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. + +**Return type** + +`ControlledGate` + +### is\_parameterized + + + +`ControlledGate.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`ControlledGate.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### power + + +`ControlledGate.power(exponent)` +Creates a unitary gate as gate^exponent. + +**Parameters** + +**exponent** (*float*) – Gate^exponent + +**Returns** + +To which to\_matrix is self.to\_matrix^exponent. + +**Return type** + +[qiskit.extensions.UnitaryGate](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") + +**Raises** + +**CircuitError** – If Gate is not unitary + +### qasm + + + +`ControlledGate.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`ControlledGate.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`ControlledGate.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`ControlledGate.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### to\_matrix + + + +`ControlledGate.to_matrix()` + +Return a Numpy.array for the gate unitary matrix. + +**Returns** + +if the Gate subclass has a matrix definition. + +**Return type** + +np.ndarray + +**Raises** + +**CircuitError** – If a Gate subclass does not implement this method an exception will be raised when this base class method is called. + +### validate\_parameter + + + +`ControlledGate.validate_parameter(parameter)` + +Gate parameters should be int, float, or ParameterExpression + +## Attributes + + ### ctrl\_state @@ -112,13 +392,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -128,13 +408,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -144,7 +424,7 @@ Return instruction label `str` - + ### name @@ -158,7 +438,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -172,7 +452,7 @@ The number of control qubits for the gate. int - + ### params @@ -190,8 +470,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Delay.md b/docs/api/qiskit/0.32/qiskit.circuit.Delay.md index d7008ece3e4..4c0eed62094 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Delay.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Delay.md @@ -1,8 +1,16 @@ -# Delay +--- +title: Delay +description: API reference for qiskit.circuit.Delay +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Delay +--- +# Delay + -`Delay(duration, unit='dt')` +`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` @@ -12,44 +20,226 @@ Create new delay instruction. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.circuit.Delay.add_decomposition#qiskit.circuit.Delay.add_decomposition "qiskit.circuit.Delay.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.Delay.assemble#qiskit.circuit.Delay.assemble "qiskit.circuit.Delay.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.Delay.broadcast_arguments#qiskit.circuit.Delay.broadcast_arguments "qiskit.circuit.Delay.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.circuit.Delay.c_if#qiskit.circuit.Delay.c_if "qiskit.circuit.Delay.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.circuit.Delay.copy#qiskit.circuit.Delay.copy "qiskit.circuit.Delay.copy") | Copy of the instruction. | -| [`inverse`](qiskit.circuit.Delay.inverse#qiskit.circuit.Delay.inverse "qiskit.circuit.Delay.inverse") | Special case. | -| [`is_parameterized`](qiskit.circuit.Delay.is_parameterized#qiskit.circuit.Delay.is_parameterized "qiskit.circuit.Delay.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.Delay.mirror#qiskit.circuit.Delay.mirror "qiskit.circuit.Delay.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.circuit.Delay.qasm#qiskit.circuit.Delay.qasm "qiskit.circuit.Delay.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.Delay.repeat#qiskit.circuit.Delay.repeat "qiskit.circuit.Delay.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.Delay.reverse_ops#qiskit.circuit.Delay.reverse_ops "qiskit.circuit.Delay.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.circuit.Delay.soft_compare#qiskit.circuit.Delay.soft_compare "qiskit.circuit.Delay.soft_compare") | Soft comparison between gates. | -| [`to_matrix`](qiskit.circuit.Delay.to_matrix#qiskit.circuit.Delay.to_matrix "qiskit.circuit.Delay.to_matrix") | Return a Numpy.array for the unitary matrix. | -| [`validate_parameter`](qiskit.circuit.Delay.validate_parameter#qiskit.circuit.Delay.validate_parameter "qiskit.circuit.Delay.validate_parameter") | Delay parameter (i.e. | +### add\_decomposition -## Attributes + + +`Delay.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`Delay.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`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. + +### copy + + + +`Delay.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`Delay.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/delay.py "view source code") + +Special case. Return self. + +### is\_parameterized + + + +`Delay.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`Delay.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`Delay.qasm()` + +Return a default OpenQASM string for the instruction. +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). +### repeat + + + +`Delay.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`Delay.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`Delay.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### to\_matrix + + + +`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. + +**Returns** + +matrix representation. + +**Return type** + +np.ndarray + +### validate\_parameter + + + +`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. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration of this delay. - + ### label @@ -59,14 +249,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md b/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md index fb97c8d2e5e..e05c34fb48b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.EquivalenceLibrary.md @@ -1,8 +1,16 @@ -# EquivalenceLibrary +--- +title: EquivalenceLibrary +description: API reference for qiskit.circuit.EquivalenceLibrary +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.EquivalenceLibrary +--- +# EquivalenceLibrary + -`EquivalenceLibrary(*, base=None)` +`EquivalenceLibrary(*, base=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/equivalence.py "view source code") Bases: `object` @@ -16,10 +24,107 @@ Create a new equivalence library. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -| [`add_equivalence`](qiskit.circuit.EquivalenceLibrary.add_equivalence#qiskit.circuit.EquivalenceLibrary.add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence") | Add a new equivalence to the library. | -| [`draw`](qiskit.circuit.EquivalenceLibrary.draw#qiskit.circuit.EquivalenceLibrary.draw "qiskit.circuit.EquivalenceLibrary.draw") | Draws the equivalence relations available in the library. | -| [`get_entry`](qiskit.circuit.EquivalenceLibrary.get_entry#qiskit.circuit.EquivalenceLibrary.get_entry "qiskit.circuit.EquivalenceLibrary.get_entry") | Gets the set of QuantumCircuits circuits from the library which equivalently implement the given Gate. | -| [`has_entry`](qiskit.circuit.EquivalenceLibrary.has_entry#qiskit.circuit.EquivalenceLibrary.has_entry "qiskit.circuit.EquivalenceLibrary.has_entry") | Check if a library contains any decompositions for gate. | -| [`set_entry`](qiskit.circuit.EquivalenceLibrary.set_entry#qiskit.circuit.EquivalenceLibrary.set_entry "qiskit.circuit.EquivalenceLibrary.set_entry") | Set the equivalence record for a Gate. | +### add\_equivalence + + + +`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). + +Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.params) can be marked equivalent to parameterized circuits, provided the parameters match. + +**Parameters** + +* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – A Gate instance. +* **equivalent\_circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – A circuit equivalently implementing the given Gate. + +### draw + + + +`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. + +**Parameters** + +**filename** (*str*) – An optional path to write the output image to if specified this method will return None. + +**Returns** + +**Drawn equivalence library as an** + +IPython SVG if in a jupyter notebook, or as a PIL.Image otherwise. + +**Return type** + +PIL.Image or IPython.display.SVG + +**Raises** + +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when pydot or pillow are not installed. + +### get\_entry + + + +`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. + +Parameterized circuits will have their parameters replaced with the corresponding entries from Gate.params. + +**Parameters** + +**gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – A Gate instance. + +**Returns** + +**A list of equivalent QuantumCircuits. If empty,** + +library contains no known decompositions of Gate. + +Returned circuits will be ordered according to their insertion in the library, from earliest to latest, from top to base. The ordering of the StandardEquivalenceLibrary will not generally be consistent across Qiskit versions. + +**Return type** + +List\[[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")] + +### has\_entry + + + +`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. + +**Parameters** + +**gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – A Gate instance. + +**Returns** + +**True if gate has a known decomposition in the library.** + +False otherwise. + +**Return type** + +Bool + +### set\_entry + + + +`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. + +Parameterized Gates (those including qiskit.circuit.Parameters in their Gate.params) can be marked equivalent to parameterized circuits, provided the parameters match. + +**Parameters** + +* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – A Gate instance. +* **entry** (*List\['QuantumCircuit']*) – A list of QuantumCircuits, each equivalently implementing the given Gate. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Gate.md b/docs/api/qiskit/0.32/qiskit.circuit.Gate.md index 7fdcaaffd5c..59769962af3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Gate.md @@ -1,8 +1,16 @@ -# Gate +--- +title: Gate +description: API reference for qiskit.circuit.Gate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Gate +--- +# Gate + -`Gate(name, num_qubits, params, label=None)` +`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` @@ -19,46 +27,330 @@ Create a new gate. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.circuit.Gate.add_decomposition#qiskit.circuit.Gate.add_decomposition "qiskit.circuit.Gate.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.Gate.assemble#qiskit.circuit.Gate.assemble "qiskit.circuit.Gate.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.Gate.broadcast_arguments#qiskit.circuit.Gate.broadcast_arguments "qiskit.circuit.Gate.broadcast_arguments") | Validation and handling of the arguments and its relationship. | -| [`c_if`](qiskit.circuit.Gate.c_if#qiskit.circuit.Gate.c_if "qiskit.circuit.Gate.c_if") | Add classical condition on register or cbit classical and value val. | -| [`control`](qiskit.circuit.Gate.control#qiskit.circuit.Gate.control "qiskit.circuit.Gate.control") | Return controlled version of gate. | -| [`copy`](qiskit.circuit.Gate.copy#qiskit.circuit.Gate.copy "qiskit.circuit.Gate.copy") | Copy of the instruction. | -| [`inverse`](qiskit.circuit.Gate.inverse#qiskit.circuit.Gate.inverse "qiskit.circuit.Gate.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.circuit.Gate.is_parameterized#qiskit.circuit.Gate.is_parameterized "qiskit.circuit.Gate.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.Gate.mirror#qiskit.circuit.Gate.mirror "qiskit.circuit.Gate.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`power`](qiskit.circuit.Gate.power#qiskit.circuit.Gate.power "qiskit.circuit.Gate.power") | Creates a unitary gate as gate^exponent. | -| [`qasm`](qiskit.circuit.Gate.qasm#qiskit.circuit.Gate.qasm "qiskit.circuit.Gate.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.Gate.repeat#qiskit.circuit.Gate.repeat "qiskit.circuit.Gate.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.Gate.reverse_ops#qiskit.circuit.Gate.reverse_ops "qiskit.circuit.Gate.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.circuit.Gate.soft_compare#qiskit.circuit.Gate.soft_compare "qiskit.circuit.Gate.soft_compare") | Soft comparison between gates. | -| [`to_matrix`](qiskit.circuit.Gate.to_matrix#qiskit.circuit.Gate.to_matrix "qiskit.circuit.Gate.to_matrix") | Return a Numpy.array for the gate unitary matrix. | -| [`validate_parameter`](qiskit.circuit.Gate.validate_parameter#qiskit.circuit.Gate.validate_parameter "qiskit.circuit.Gate.validate_parameter") | Gate parameters should be int, float, or ParameterExpression | +### add\_decomposition -## Attributes + + +`Gate.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`Gate.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`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. + +For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: + +```python +in: [[q[0],q[1]], q[2]],[] +outs: [q[0], q[2]], [] + [q[1], q[2]], [] +``` + +The general broadcasting rules are: + +> * If len(qargs) == 1: +> +> ```python +> [q[0], q[1]] -> [q[0]],[q[1]] +> ``` +> +> * If len(qargs) == 2: +> +> ```python +> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]] +> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]] +> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]] +> ``` +> +> * If len(qargs) >= 3: +> +> ```python +> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...] +> ``` + +**Parameters** + +* **qargs** (`List`) – List of quantum bit arguments. +* **cargs** (`List`) – List of classical bit arguments. + +**Return type** + +`Tuple`\[`List`, `List`] + +**Returns** + +A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`Gate.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### control + + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (`Optional`\[`int`]) – number of controls to add to gate (default=1) +* **label** (`Optional`\[`str`]) – optional gate label +* **ctrl\_state** (`Union`\[`int`, `str`, `None`]) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use 2\*\*num\_ctrl\_qubits-1. + +**Returns** + +Controlled version of gate. This default algorithm uses num\_ctrl\_qubits-1 ancillae qubits so returns a gate of size num\_qubits + 2\*num\_ctrl\_qubits - 1. + +**Return type** + +[qiskit.circuit.ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +**Raises** + +**QiskitError** – unrecognized mode or invalid ctrl\_state + +### copy + + + +`Gate.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`Gate.inverse()` + +Invert this instruction. +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`Gate.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`Gate.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### power + + + +`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. + +**Parameters** + +**exponent** (*float*) – Gate^exponent + +**Returns** + +To which to\_matrix is self.to\_matrix^exponent. + +**Return type** + +[qiskit.extensions.UnitaryGate](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") + +**Raises** + +**CircuitError** – If Gate is not unitary + +### qasm + + + +`Gate.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`Gate.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`Gate.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`Gate.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### to\_matrix + + + +`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. + +**Returns** + +if the Gate subclass has a matrix definition. + +**Return type** + +np.ndarray + +**Raises** + +**CircuitError** – If a Gate subclass does not implement this method an exception will be raised when this base class method is called. + +### validate\_parameter + + + +`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 + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -68,14 +360,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md b/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md index 0f32c297d4f..56dcacff5ea 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Instruction.md @@ -1,8 +1,16 @@ -# Instruction +--- +title: Instruction +description: API reference for qiskit.circuit.Instruction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Instruction +--- +# Instruction + -`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)` +`Instruction(name, num_qubits, num_clbits, params, duration=None, unit='dt', label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") Bases: `object` @@ -26,43 +34,226 @@ Create a new instruction. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.circuit.Instruction.add_decomposition#qiskit.circuit.Instruction.add_decomposition "qiskit.circuit.Instruction.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.Instruction.assemble#qiskit.circuit.Instruction.assemble "qiskit.circuit.Instruction.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.Instruction.broadcast_arguments#qiskit.circuit.Instruction.broadcast_arguments "qiskit.circuit.Instruction.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.circuit.Instruction.c_if#qiskit.circuit.Instruction.c_if "qiskit.circuit.Instruction.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.circuit.Instruction.copy#qiskit.circuit.Instruction.copy "qiskit.circuit.Instruction.copy") | Copy of the instruction. | -| [`inverse`](qiskit.circuit.Instruction.inverse#qiskit.circuit.Instruction.inverse "qiskit.circuit.Instruction.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.circuit.Instruction.is_parameterized#qiskit.circuit.Instruction.is_parameterized "qiskit.circuit.Instruction.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.Instruction.mirror#qiskit.circuit.Instruction.mirror "qiskit.circuit.Instruction.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.circuit.Instruction.qasm#qiskit.circuit.Instruction.qasm "qiskit.circuit.Instruction.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.Instruction.repeat#qiskit.circuit.Instruction.repeat "qiskit.circuit.Instruction.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.Instruction.reverse_ops#qiskit.circuit.Instruction.reverse_ops "qiskit.circuit.Instruction.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.circuit.Instruction.soft_compare#qiskit.circuit.Instruction.soft_compare "qiskit.circuit.Instruction.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.circuit.Instruction.validate_parameter#qiskit.circuit.Instruction.validate_parameter "qiskit.circuit.Instruction.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`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. + +### assemble + + + +`Instruction.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`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. + +### copy + + + +`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. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`Instruction.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`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 + +### mirror + + + +`Instruction.mirror()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instruction.py "view source code") + +DEPRECATED: use instruction.reverse\_ops(). +**Returns** +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`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. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`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. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`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. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`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. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -72,14 +263,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md b/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md index cf60ca02fad..26139092e55 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.InstructionSet.md @@ -1,8 +1,16 @@ -# InstructionSet +--- +title: InstructionSet +description: API reference for qiskit.circuit.InstructionSet +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.InstructionSet +--- +# InstructionSet + -`InstructionSet` +`InstructionSet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/instructionset.py "view source code") Bases: `object` @@ -14,8 +22,27 @@ The context (qargs and cargs that each instruction is attached to) is also store ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [`add`](qiskit.circuit.InstructionSet.add#qiskit.circuit.InstructionSet.add "qiskit.circuit.InstructionSet.add") | Add an instruction and its context (where it is attached). | -| [`c_if`](qiskit.circuit.InstructionSet.c_if#qiskit.circuit.InstructionSet.c_if "qiskit.circuit.InstructionSet.c_if") | Add condition on classical register to all instructions. | -| [`inverse`](qiskit.circuit.InstructionSet.inverse#qiskit.circuit.InstructionSet.inverse "qiskit.circuit.InstructionSet.inverse") | Invert all instructions. | +### add + + + +`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). + +### c\_if + + + +`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. + +### inverse + + + +`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 9934c9ae21b..700d91f1abc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Measure.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Measure.md @@ -1,8 +1,16 @@ -# Measure +--- +title: Measure +description: API reference for qiskit.circuit.Measure +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Measure +--- +# Measure + -`Measure` +`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -12,43 +20,226 @@ Create new measurement instruction. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.circuit.Measure.add_decomposition#qiskit.circuit.Measure.add_decomposition "qiskit.circuit.Measure.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.Measure.assemble#qiskit.circuit.Measure.assemble "qiskit.circuit.Measure.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.Measure.broadcast_arguments#qiskit.circuit.Measure.broadcast_arguments "qiskit.circuit.Measure.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.circuit.Measure.c_if#qiskit.circuit.Measure.c_if "qiskit.circuit.Measure.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.circuit.Measure.copy#qiskit.circuit.Measure.copy "qiskit.circuit.Measure.copy") | Copy of the instruction. | -| [`inverse`](qiskit.circuit.Measure.inverse#qiskit.circuit.Measure.inverse "qiskit.circuit.Measure.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.circuit.Measure.is_parameterized#qiskit.circuit.Measure.is_parameterized "qiskit.circuit.Measure.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.Measure.mirror#qiskit.circuit.Measure.mirror "qiskit.circuit.Measure.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.circuit.Measure.qasm#qiskit.circuit.Measure.qasm "qiskit.circuit.Measure.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.Measure.repeat#qiskit.circuit.Measure.repeat "qiskit.circuit.Measure.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.Measure.reverse_ops#qiskit.circuit.Measure.reverse_ops "qiskit.circuit.Measure.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.circuit.Measure.soft_compare#qiskit.circuit.Measure.soft_compare "qiskit.circuit.Measure.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.circuit.Measure.validate_parameter#qiskit.circuit.Measure.validate_parameter "qiskit.circuit.Measure.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`Measure.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`Measure.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`Measure.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`Measure.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`Measure.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`Measure.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`Measure.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** +**a new instruction with sub-instructions** +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`Measure.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`Measure.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`Measure.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`Measure.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`Measure.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -58,14 +249,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md b/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md index ff1ada74019..999790ae31b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Parameter.md @@ -1,8 +1,16 @@ -# Parameter +--- +title: Parameter +description: API reference for qiskit.circuit.Parameter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Parameter +--- +# Parameter + -`Parameter(name)` +`Parameter(name)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameter.py "view source code") Bases: `qiskit.circuit.parameterexpression.ParameterExpression` @@ -16,32 +24,178 @@ Create a new named [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Param ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [`arccos`](qiskit.circuit.Parameter.arccos#qiskit.circuit.Parameter.arccos "qiskit.circuit.Parameter.arccos") | Arccos of a ParameterExpression | -| [`arcsin`](qiskit.circuit.Parameter.arcsin#qiskit.circuit.Parameter.arcsin "qiskit.circuit.Parameter.arcsin") | Arcsin of a ParameterExpression | -| [`arctan`](qiskit.circuit.Parameter.arctan#qiskit.circuit.Parameter.arctan "qiskit.circuit.Parameter.arctan") | Arctan of a ParameterExpression | -| [`assign`](qiskit.circuit.Parameter.assign#qiskit.circuit.Parameter.assign "qiskit.circuit.Parameter.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`bind`](qiskit.circuit.Parameter.bind#qiskit.circuit.Parameter.bind "qiskit.circuit.Parameter.bind") | Binds the provided set of parameters to their corresponding values. | -| [`conjugate`](qiskit.circuit.Parameter.conjugate#qiskit.circuit.Parameter.conjugate "qiskit.circuit.Parameter.conjugate") | Return the conjugate. | -| [`cos`](qiskit.circuit.Parameter.cos#qiskit.circuit.Parameter.cos "qiskit.circuit.Parameter.cos") | Cosine of a ParameterExpression | -| [`exp`](qiskit.circuit.Parameter.exp#qiskit.circuit.Parameter.exp "qiskit.circuit.Parameter.exp") | Exponential of a ParameterExpression | -| [`gradient`](qiskit.circuit.Parameter.gradient#qiskit.circuit.Parameter.gradient "qiskit.circuit.Parameter.gradient") | Get the derivative of a parameter expression w\.r.t. | -| [`is_real`](qiskit.circuit.Parameter.is_real#qiskit.circuit.Parameter.is_real "qiskit.circuit.Parameter.is_real") | Return whether the expression is real | -| [`log`](qiskit.circuit.Parameter.log#qiskit.circuit.Parameter.log "qiskit.circuit.Parameter.log") | Logarithm of a ParameterExpression | -| [`sin`](qiskit.circuit.Parameter.sin#qiskit.circuit.Parameter.sin "qiskit.circuit.Parameter.sin") | Sine of a ParameterExpression | -| [`subs`](qiskit.circuit.Parameter.subs#qiskit.circuit.Parameter.subs "qiskit.circuit.Parameter.subs") | Substitute self with the corresponding parameter in `parameter_map`. | -| [`tan`](qiskit.circuit.Parameter.tan#qiskit.circuit.Parameter.tan "qiskit.circuit.Parameter.tan") | Tangent of a ParameterExpression | +### arccos -## Attributes + + +`Parameter.arccos()` + +Arccos of a ParameterExpression + +### arcsin + + + +`Parameter.arcsin()` + +Arcsin of a ParameterExpression + +### arctan + + + +`Parameter.arctan()` + +Arctan of a ParameterExpression + +### assign + + + +`Parameter.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Parameters** + +* **parameter** ([*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`ParameterExpression` + +**Returns** + +A new expression parameterized by any parameters which were not bound by assignment. + +### bind + + + +`Parameter.bind(parameter_values)` + +Binds the provided set of parameters to their corresponding values. + +**Parameters** + +**parameter\_values** (`Dict`) – Mapping of Parameter instances to the numeric value to which they will be bound. + +**Raises** + +* **CircuitError** – + + * If parameter\_values contains Parameters outside those in self. - If a non-numeric value is passed in parameter\_values. + +* **ZeroDivisionError** – + + * If binding the provided values requires division by zero. + +**Return type** + +`ParameterExpression` + +**Returns** + +A new expression parameterized by any parameters which were not bound by parameter\_values. + +### conjugate + + + +`Parameter.conjugate()` + +Return the conjugate. +**Return type** + +`ParameterExpression` + +### cos + + + +`Parameter.cos()` + +Cosine of a ParameterExpression + +### exp + + + +`Parameter.exp()` + +Exponential of a ParameterExpression + +### gradient + + + +`Parameter.gradient(param)` + +Get the derivative of a parameter expression w\.r.t. a specified parameter expression. + +**Parameters** + +**param** ([*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +### is\_real + + +`Parameter.is_real()` + +Return whether the expression is real + +### log + + + +`Parameter.log()` + +Logarithm of a ParameterExpression + +### sin + + + +`Parameter.sin()` + +Sine of a ParameterExpression + +### subs + + + +`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`. + +### tan + + + +`Parameter.tan()` + +Tangent of a ParameterExpression + +## Attributes + + ### name Returns the name of the [`Parameter`](#qiskit.circuit.Parameter "qiskit.circuit.Parameter"). - + ### parameters @@ -50,3 +204,4 @@ Returns a set of the unbound Parameters in the expression. **Return type** `Set` + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md b/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md index fb9dcaaa0d8..1d8ee50f6ce 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ParameterExpression.md @@ -1,8 +1,16 @@ -# ParameterExpression +--- +title: ParameterExpression +description: API reference for qiskit.circuit.ParameterExpression +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.ParameterExpression +--- +# ParameterExpression + -`ParameterExpression(symbol_map, expr)` +`ParameterExpression(symbol_map, expr)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") Bases: `object` @@ -10,35 +18,199 @@ ParameterExpression class to enable creating expressions of Parameters. Create a new [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression"). -Not intended to be called directly, but to be instantiated via operations on other [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") or [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects. +Not intended to be called directly, but to be instantiated via operations on other [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") or [`ParameterExpression`](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") objects. **Parameters** -* **symbol\_map** (*Dict\[*[*Parameter*](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter")*, \[*[*ParameterExpression*](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*, float, or int]]*) – Mapping of [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances to the `sympy.Symbol` serving as their placeholder in expr. +* **symbol\_map** (*Dict\[*[*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*, \[*[*ParameterExpression*](#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")*, float, or int]]*) – Mapping of [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances to the `sympy.Symbol` serving as their placeholder in expr. * **expr** (*sympy.Expr*) – Expression of `sympy.Symbol` s. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| [`arccos`](qiskit.circuit.ParameterExpression.arccos#qiskit.circuit.ParameterExpression.arccos "qiskit.circuit.ParameterExpression.arccos") | Arccos of a ParameterExpression | -| [`arcsin`](qiskit.circuit.ParameterExpression.arcsin#qiskit.circuit.ParameterExpression.arcsin "qiskit.circuit.ParameterExpression.arcsin") | Arcsin of a ParameterExpression | -| [`arctan`](qiskit.circuit.ParameterExpression.arctan#qiskit.circuit.ParameterExpression.arctan "qiskit.circuit.ParameterExpression.arctan") | Arctan of a ParameterExpression | -| [`assign`](qiskit.circuit.ParameterExpression.assign#qiskit.circuit.ParameterExpression.assign "qiskit.circuit.ParameterExpression.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`bind`](qiskit.circuit.ParameterExpression.bind#qiskit.circuit.ParameterExpression.bind "qiskit.circuit.ParameterExpression.bind") | Binds the provided set of parameters to their corresponding values. | -| [`conjugate`](qiskit.circuit.ParameterExpression.conjugate#qiskit.circuit.ParameterExpression.conjugate "qiskit.circuit.ParameterExpression.conjugate") | Return the conjugate. | -| [`cos`](qiskit.circuit.ParameterExpression.cos#qiskit.circuit.ParameterExpression.cos "qiskit.circuit.ParameterExpression.cos") | Cosine of a ParameterExpression | -| [`exp`](qiskit.circuit.ParameterExpression.exp#qiskit.circuit.ParameterExpression.exp "qiskit.circuit.ParameterExpression.exp") | Exponential of a ParameterExpression | -| [`gradient`](qiskit.circuit.ParameterExpression.gradient#qiskit.circuit.ParameterExpression.gradient "qiskit.circuit.ParameterExpression.gradient") | Get the derivative of a parameter expression w\.r.t. | -| [`is_real`](qiskit.circuit.ParameterExpression.is_real#qiskit.circuit.ParameterExpression.is_real "qiskit.circuit.ParameterExpression.is_real") | Return whether the expression is real | -| [`log`](qiskit.circuit.ParameterExpression.log#qiskit.circuit.ParameterExpression.log "qiskit.circuit.ParameterExpression.log") | Logarithm of a ParameterExpression | -| [`sin`](qiskit.circuit.ParameterExpression.sin#qiskit.circuit.ParameterExpression.sin "qiskit.circuit.ParameterExpression.sin") | Sine of a ParameterExpression | -| [`subs`](qiskit.circuit.ParameterExpression.subs#qiskit.circuit.ParameterExpression.subs "qiskit.circuit.ParameterExpression.subs") | Returns a new Expression with replacement Parameters. | -| [`tan`](qiskit.circuit.ParameterExpression.tan#qiskit.circuit.ParameterExpression.tan "qiskit.circuit.ParameterExpression.tan") | Tangent of a ParameterExpression | +### arccos -## Attributes + + +`ParameterExpression.arccos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Arccos of a ParameterExpression + +### arcsin + + + +`ParameterExpression.arcsin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Arcsin of a ParameterExpression + +### arctan + + + +`ParameterExpression.arctan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Arctan of a ParameterExpression + +### assign + + + +`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. + +**Parameters** + +* **parameter** ([*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`ParameterExpression` + +**Returns** + +A new expression parameterized by any parameters which were not bound by assignment. + +### bind + + + +`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. + +**Parameters** + +**parameter\_values** (`Dict`) – Mapping of Parameter instances to the numeric value to which they will be bound. + +**Raises** + +* **CircuitError** – + + * If parameter\_values contains Parameters outside those in self. - If a non-numeric value is passed in parameter\_values. + +* **ZeroDivisionError** – + + * If binding the provided values requires division by zero. + +**Return type** + +`ParameterExpression` + +**Returns** + +A new expression parameterized by any parameters which were not bound by parameter\_values. + +### conjugate + + + +`ParameterExpression.conjugate()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Return the conjugate. + +**Return type** + +`ParameterExpression` + +### cos + + +`ParameterExpression.cos()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") +Cosine of a ParameterExpression + +### exp + + + +`ParameterExpression.exp()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Exponential of a ParameterExpression + +### gradient + + + +`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. + +**Parameters** + +**param** ([*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + +### is\_real + + + +`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 + +### log + + + +`ParameterExpression.log()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Logarithm of a ParameterExpression + +### sin + + + +`ParameterExpression.sin()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Sine of a ParameterExpression + +### subs + + + +`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. + +**Parameters** + +**parameter\_map** (`Dict`) – Mapping from Parameters in self to the ParameterExpression instances with which they should be replaced. + +**Raises** + +**CircuitError** – + +* If parameter\_map contains Parameters outside those in self. - If the replacement Parameters in parameter\_map would result in a name conflict in the generated expression. + +**Return type** + +`ParameterExpression` + +**Returns** + +A new expression with the specified parameters replaced. + +### tan + + + +`ParameterExpression.tan()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parameterexpression.py "view source code") + +Tangent of a ParameterExpression + +## Attributes + + ### parameters @@ -47,3 +219,4 @@ Returns a set of the unbound Parameters in the expression. **Return type** `Set` + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md b/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md index adb031ec5bb..f927e45c737 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.ParameterVector.md @@ -1,8 +1,16 @@ -# ParameterVector +--- +title: ParameterVector +description: API reference for qiskit.circuit.ParameterVector +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.ParameterVector +--- +# ParameterVector + -`ParameterVector(name, length=0)` +`ParameterVector(name, length=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") Bases: `object` @@ -10,21 +18,35 @@ ParameterVector class to quickly generate lists of parameters. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`index`](qiskit.circuit.ParameterVector.index#qiskit.circuit.ParameterVector.index "qiskit.circuit.ParameterVector.index") | Returns first index of value. | -| [`resize`](qiskit.circuit.ParameterVector.resize#qiskit.circuit.ParameterVector.resize "qiskit.circuit.ParameterVector.resize") | Resize the parameter vector. | +### index -## Attributes + + +`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. + +### resize + + +`ParameterVector.resize(length)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/parametervector.py "view source code") +Resize the parameter vector. + +If necessary, new elements are generated. If length is smaller than before, the previous elements are cached and not re-generated if the vector is enlarged again. This is to ensure that the parameter instances do not change. + +## Attributes + + ### name Returns the name of the ParameterVector. - + ### params Returns the list of parameters in the ParameterVector. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md b/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md index e4199243aef..944f85a3a93 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.md @@ -1,8 +1,16 @@ -# QuantumCircuit +--- +title: QuantumCircuit +description: API reference for qiskit.circuit.QuantumCircuit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.QuantumCircuit +--- +# QuantumCircuit + -`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)` +`QuantumCircuit(*regs, name=None, global_phase=0, metadata=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") Bases: `object` @@ -16,7 +24,7 @@ A circuit is a list of instructions bound to some registers. The registers to be included in the circuit. - * If a list of `Register` objects, represents the [`QuantumRegister`](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") and/or [`ClassicalRegister`](qiskit.circuit.ClassicalRegister#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") objects to include in the circuit. + * If a list of `Register` objects, represents the [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") and/or [`ClassicalRegister`](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister") objects to include in the circuit. For example: @@ -35,7 +43,7 @@ A circuit is a list of instructions bound to some registers. * **name** (*str*) – the name of the quantum circuit. If not set, an automatically generated string will be assigned. -* **global\_phase** (*float or* [*ParameterExpression*](qiskit.circuit.ParameterExpression#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – The global phase of the circuit in radians. +* **global\_phase** (*float or* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – The global phase of the circuit in radians. * **metadata** (*dict*) – Arbitrary key value metadata to associate with the circuit. This gets stored as free-form data in a dict in the [`metadata`](#qiskit.circuit.QuantumCircuit.metadata "qiskit.circuit.QuantumCircuit.metadata") attribute. It will not be directly used in the circuit. @@ -115,263 +123,2880 @@ ancilla_0: ┤ X ├┤ H ├┤ X ├┤ X ├┤ X ├──────── ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| [`add_bits`](qiskit.circuit.QuantumCircuit.add_bits#qiskit.circuit.QuantumCircuit.add_bits "qiskit.circuit.QuantumCircuit.add_bits") | Add Bits to the circuit. | -| [`add_calibration`](qiskit.circuit.QuantumCircuit.add_calibration#qiskit.circuit.QuantumCircuit.add_calibration "qiskit.circuit.QuantumCircuit.add_calibration") | Register a low-level, custom pulse definition for the given gate. | -| [`add_register`](qiskit.circuit.QuantumCircuit.add_register#qiskit.circuit.QuantumCircuit.add_register "qiskit.circuit.QuantumCircuit.add_register") | Add registers. | -| [`append`](qiskit.circuit.QuantumCircuit.append#qiskit.circuit.QuantumCircuit.append "qiskit.circuit.QuantumCircuit.append") | Append one or more instructions to the end of the circuit, modifying the circuit in place. | -| [`assign_parameters`](qiskit.circuit.QuantumCircuit.assign_parameters#qiskit.circuit.QuantumCircuit.assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters") | Assign parameters to new parameters or values. | -| [`barrier`](qiskit.circuit.QuantumCircuit.barrier#qiskit.circuit.QuantumCircuit.barrier "qiskit.circuit.QuantumCircuit.barrier") | Apply `Barrier`. | -| [`bind_parameters`](qiskit.circuit.QuantumCircuit.bind_parameters#qiskit.circuit.QuantumCircuit.bind_parameters "qiskit.circuit.QuantumCircuit.bind_parameters") | Assign numeric parameters to values yielding a new circuit. | -| [`cast`](qiskit.circuit.QuantumCircuit.cast#qiskit.circuit.QuantumCircuit.cast "qiskit.circuit.QuantumCircuit.cast") | Best effort to cast value to type. | -| [`cbit_argument_conversion`](qiskit.circuit.QuantumCircuit.cbit_argument_conversion#qiskit.circuit.QuantumCircuit.cbit_argument_conversion "qiskit.circuit.QuantumCircuit.cbit_argument_conversion") | Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. | -| [`ccx`](qiskit.circuit.QuantumCircuit.ccx#qiskit.circuit.QuantumCircuit.ccx "qiskit.circuit.QuantumCircuit.ccx") | Apply [`CCXGate`](qiskit.circuit.library.CCXGate#qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). | -| [`ch`](qiskit.circuit.QuantumCircuit.ch#qiskit.circuit.QuantumCircuit.ch "qiskit.circuit.QuantumCircuit.ch") | Apply [`CHGate`](qiskit.circuit.library.CHGate#qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). | -| [`cls_instances`](qiskit.circuit.QuantumCircuit.cls_instances#qiskit.circuit.QuantumCircuit.cls_instances "qiskit.circuit.QuantumCircuit.cls_instances") | Return the current number of instances of this class, useful for auto naming. | -| [`cls_prefix`](qiskit.circuit.QuantumCircuit.cls_prefix#qiskit.circuit.QuantumCircuit.cls_prefix "qiskit.circuit.QuantumCircuit.cls_prefix") | Return the prefix to use for auto naming. | -| [`cnot`](qiskit.circuit.QuantumCircuit.cnot#qiskit.circuit.QuantumCircuit.cnot "qiskit.circuit.QuantumCircuit.cnot") | Apply [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). | -| [`combine`](qiskit.circuit.QuantumCircuit.combine#qiskit.circuit.QuantumCircuit.combine "qiskit.circuit.QuantumCircuit.combine") | DEPRECATED - Returns rhs appended to self if self contains compatible registers. | -| [`compose`](qiskit.circuit.QuantumCircuit.compose#qiskit.circuit.QuantumCircuit.compose "qiskit.circuit.QuantumCircuit.compose") | Compose circuit with `other` circuit or instruction, optionally permuting wires. | -| [`control`](qiskit.circuit.QuantumCircuit.control#qiskit.circuit.QuantumCircuit.control "qiskit.circuit.QuantumCircuit.control") | Control this circuit on `num_ctrl_qubits` qubits. | -| [`copy`](qiskit.circuit.QuantumCircuit.copy#qiskit.circuit.QuantumCircuit.copy "qiskit.circuit.QuantumCircuit.copy") | Copy the circuit. | -| [`count_ops`](qiskit.circuit.QuantumCircuit.count_ops#qiskit.circuit.QuantumCircuit.count_ops "qiskit.circuit.QuantumCircuit.count_ops") | Count each operation kind in the circuit. | -| [`cp`](qiskit.circuit.QuantumCircuit.cp#qiskit.circuit.QuantumCircuit.cp "qiskit.circuit.QuantumCircuit.cp") | Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate#qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). | -| [`crx`](qiskit.circuit.QuantumCircuit.crx#qiskit.circuit.QuantumCircuit.crx "qiskit.circuit.QuantumCircuit.crx") | Apply [`CRXGate`](qiskit.circuit.library.CRXGate#qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). | -| [`cry`](qiskit.circuit.QuantumCircuit.cry#qiskit.circuit.QuantumCircuit.cry "qiskit.circuit.QuantumCircuit.cry") | Apply [`CRYGate`](qiskit.circuit.library.CRYGate#qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). | -| [`crz`](qiskit.circuit.QuantumCircuit.crz#qiskit.circuit.QuantumCircuit.crz "qiskit.circuit.QuantumCircuit.crz") | Apply [`CRZGate`](qiskit.circuit.library.CRZGate#qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). | -| [`cswap`](qiskit.circuit.QuantumCircuit.cswap#qiskit.circuit.QuantumCircuit.cswap "qiskit.circuit.QuantumCircuit.cswap") | Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate#qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). | -| [`csx`](qiskit.circuit.QuantumCircuit.csx#qiskit.circuit.QuantumCircuit.csx "qiskit.circuit.QuantumCircuit.csx") | Apply [`CSXGate`](qiskit.circuit.library.CSXGate#qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). | -| [`cu`](qiskit.circuit.QuantumCircuit.cu#qiskit.circuit.QuantumCircuit.cu "qiskit.circuit.QuantumCircuit.cu") | Apply [`CUGate`](qiskit.circuit.library.CUGate#qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). | -| [`cu1`](qiskit.circuit.QuantumCircuit.cu1#qiskit.circuit.QuantumCircuit.cu1 "qiskit.circuit.QuantumCircuit.cu1") | Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate#qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). | -| [`cu3`](qiskit.circuit.QuantumCircuit.cu3#qiskit.circuit.QuantumCircuit.cu3 "qiskit.circuit.QuantumCircuit.cu3") | Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate#qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). | -| [`cx`](qiskit.circuit.QuantumCircuit.cx#qiskit.circuit.QuantumCircuit.cx "qiskit.circuit.QuantumCircuit.cx") | Apply [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). | -| [`cy`](qiskit.circuit.QuantumCircuit.cy#qiskit.circuit.QuantumCircuit.cy "qiskit.circuit.QuantumCircuit.cy") | Apply [`CYGate`](qiskit.circuit.library.CYGate#qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). | -| [`cz`](qiskit.circuit.QuantumCircuit.cz#qiskit.circuit.QuantumCircuit.cz "qiskit.circuit.QuantumCircuit.cz") | Apply [`CZGate`](qiskit.circuit.library.CZGate#qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). | -| [`dcx`](qiskit.circuit.QuantumCircuit.dcx#qiskit.circuit.QuantumCircuit.dcx "qiskit.circuit.QuantumCircuit.dcx") | Apply [`DCXGate`](qiskit.circuit.library.DCXGate#qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). | -| [`decompose`](qiskit.circuit.QuantumCircuit.decompose#qiskit.circuit.QuantumCircuit.decompose "qiskit.circuit.QuantumCircuit.decompose") | Call a decomposition pass on this circuit, to decompose one level (shallow decompose). | -| [`delay`](qiskit.circuit.QuantumCircuit.delay#qiskit.circuit.QuantumCircuit.delay "qiskit.circuit.QuantumCircuit.delay") | Apply [`Delay`](qiskit.circuit.Delay#qiskit.circuit.Delay "qiskit.circuit.Delay"). | -| [`depth`](qiskit.circuit.QuantumCircuit.depth#qiskit.circuit.QuantumCircuit.depth "qiskit.circuit.QuantumCircuit.depth") | Return circuit depth (i.e., length of critical path). | -| [`diagonal`](qiskit.circuit.QuantumCircuit.diagonal#qiskit.circuit.QuantumCircuit.diagonal "qiskit.circuit.QuantumCircuit.diagonal") | Attach a diagonal gate to a circuit. | -| [`draw`](qiskit.circuit.QuantumCircuit.draw#qiskit.circuit.QuantumCircuit.draw "qiskit.circuit.QuantumCircuit.draw") | Draw the quantum circuit. | -| [`ecr`](qiskit.circuit.QuantumCircuit.ecr#qiskit.circuit.QuantumCircuit.ecr "qiskit.circuit.QuantumCircuit.ecr") | Apply [`ECRGate`](qiskit.circuit.library.ECRGate#qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). | -| [`extend`](qiskit.circuit.QuantumCircuit.extend#qiskit.circuit.QuantumCircuit.extend "qiskit.circuit.QuantumCircuit.extend") | DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. | -| [`fredkin`](qiskit.circuit.QuantumCircuit.fredkin#qiskit.circuit.QuantumCircuit.fredkin "qiskit.circuit.QuantumCircuit.fredkin") | Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate#qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). | -| [`from_qasm_file`](qiskit.circuit.QuantumCircuit.from_qasm_file#qiskit.circuit.QuantumCircuit.from_qasm_file "qiskit.circuit.QuantumCircuit.from_qasm_file") | Take in a QASM file and generate a QuantumCircuit object. | -| [`from_qasm_str`](qiskit.circuit.QuantumCircuit.from_qasm_str#qiskit.circuit.QuantumCircuit.from_qasm_str "qiskit.circuit.QuantumCircuit.from_qasm_str") | Take in a QASM string and generate a QuantumCircuit object. | -| [`get_instructions`](qiskit.circuit.QuantumCircuit.get_instructions#qiskit.circuit.QuantumCircuit.get_instructions "qiskit.circuit.QuantumCircuit.get_instructions") | Get instructions matching name. | -| [`h`](qiskit.circuit.QuantumCircuit.h#qiskit.circuit.QuantumCircuit.h "qiskit.circuit.QuantumCircuit.h") | Apply [`HGate`](qiskit.circuit.library.HGate#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). | -| [`hamiltonian`](qiskit.circuit.QuantumCircuit.hamiltonian#qiskit.circuit.QuantumCircuit.hamiltonian "qiskit.circuit.QuantumCircuit.hamiltonian") | Apply hamiltonian evolution to qubits. | -| [`has_register`](qiskit.circuit.QuantumCircuit.has_register#qiskit.circuit.QuantumCircuit.has_register "qiskit.circuit.QuantumCircuit.has_register") | Test if this circuit has the register r. | -| [`i`](qiskit.circuit.QuantumCircuit.i#qiskit.circuit.QuantumCircuit.i "qiskit.circuit.QuantumCircuit.i") | Apply [`IGate`](qiskit.circuit.library.IGate#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). | -| [`id`](qiskit.circuit.QuantumCircuit.id#qiskit.circuit.QuantumCircuit.id "qiskit.circuit.QuantumCircuit.id") | Apply [`IGate`](qiskit.circuit.library.IGate#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). | -| [`initialize`](qiskit.circuit.QuantumCircuit.initialize#qiskit.circuit.QuantumCircuit.initialize "qiskit.circuit.QuantumCircuit.initialize") | Initialize qubits in a specific state. | -| [`inverse`](qiskit.circuit.QuantumCircuit.inverse#qiskit.circuit.QuantumCircuit.inverse "qiskit.circuit.QuantumCircuit.inverse") | Invert (take adjoint of) this circuit. | -| [`iso`](qiskit.circuit.QuantumCircuit.iso#qiskit.circuit.QuantumCircuit.iso "qiskit.circuit.QuantumCircuit.iso") | Attach an arbitrary isometry from m to n qubits to a circuit. | -| [`isometry`](qiskit.circuit.QuantumCircuit.isometry#qiskit.circuit.QuantumCircuit.isometry "qiskit.circuit.QuantumCircuit.isometry") | Attach an arbitrary isometry from m to n qubits to a circuit. | -| [`iswap`](qiskit.circuit.QuantumCircuit.iswap#qiskit.circuit.QuantumCircuit.iswap "qiskit.circuit.QuantumCircuit.iswap") | Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate#qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). | -| [`mcp`](qiskit.circuit.QuantumCircuit.mcp#qiskit.circuit.QuantumCircuit.mcp "qiskit.circuit.QuantumCircuit.mcp") | Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate#qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). | -| [`mcrx`](qiskit.circuit.QuantumCircuit.mcrx#qiskit.circuit.QuantumCircuit.mcrx "qiskit.circuit.QuantumCircuit.mcrx") | Apply Multiple-Controlled X rotation gate | -| [`mcry`](qiskit.circuit.QuantumCircuit.mcry#qiskit.circuit.QuantumCircuit.mcry "qiskit.circuit.QuantumCircuit.mcry") | Apply Multiple-Controlled Y rotation gate | -| [`mcrz`](qiskit.circuit.QuantumCircuit.mcrz#qiskit.circuit.QuantumCircuit.mcrz "qiskit.circuit.QuantumCircuit.mcrz") | Apply Multiple-Controlled Z rotation gate | -| [`mct`](qiskit.circuit.QuantumCircuit.mct#qiskit.circuit.QuantumCircuit.mct "qiskit.circuit.QuantumCircuit.mct") | Apply [`MCXGate`](qiskit.circuit.library.MCXGate#qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). | -| [`mcu1`](qiskit.circuit.QuantumCircuit.mcu1#qiskit.circuit.QuantumCircuit.mcu1 "qiskit.circuit.QuantumCircuit.mcu1") | Apply `MCU1Gate`. | -| [`mcx`](qiskit.circuit.QuantumCircuit.mcx#qiskit.circuit.QuantumCircuit.mcx "qiskit.circuit.QuantumCircuit.mcx") | Apply [`MCXGate`](qiskit.circuit.library.MCXGate#qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). | -| [`measure`](qiskit.circuit.QuantumCircuit.measure#qiskit.circuit.QuantumCircuit.measure "qiskit.circuit.QuantumCircuit.measure") | Measure quantum bit into classical bit (tuples). | -| [`measure_active`](qiskit.circuit.QuantumCircuit.measure_active#qiskit.circuit.QuantumCircuit.measure_active "qiskit.circuit.QuantumCircuit.measure_active") | Adds measurement to all non-idle qubits. | -| [`measure_all`](qiskit.circuit.QuantumCircuit.measure_all#qiskit.circuit.QuantumCircuit.measure_all "qiskit.circuit.QuantumCircuit.measure_all") | Adds measurement to all qubits. | -| [`ms`](qiskit.circuit.QuantumCircuit.ms#qiskit.circuit.QuantumCircuit.ms "qiskit.circuit.QuantumCircuit.ms") | Apply [`MSGate`](qiskit.circuit.library.MSGate#qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). | -| [`num_connected_components`](qiskit.circuit.QuantumCircuit.num_connected_components#qiskit.circuit.QuantumCircuit.num_connected_components "qiskit.circuit.QuantumCircuit.num_connected_components") | How many non-entangled subcircuits can the circuit be factored to. | -| [`num_nonlocal_gates`](qiskit.circuit.QuantumCircuit.num_nonlocal_gates#qiskit.circuit.QuantumCircuit.num_nonlocal_gates "qiskit.circuit.QuantumCircuit.num_nonlocal_gates") | Return number of non-local gates (i.e. | -| [`num_tensor_factors`](qiskit.circuit.QuantumCircuit.num_tensor_factors#qiskit.circuit.QuantumCircuit.num_tensor_factors "qiskit.circuit.QuantumCircuit.num_tensor_factors") | Computes the number of tensor factors in the unitary (quantum) part of the circuit only. | -| [`num_unitary_factors`](qiskit.circuit.QuantumCircuit.num_unitary_factors#qiskit.circuit.QuantumCircuit.num_unitary_factors "qiskit.circuit.QuantumCircuit.num_unitary_factors") | Computes the number of tensor factors in the unitary (quantum) part of the circuit only. | -| [`p`](qiskit.circuit.QuantumCircuit.p#qiskit.circuit.QuantumCircuit.p "qiskit.circuit.QuantumCircuit.p") | Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate#qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). | -| [`pauli`](qiskit.circuit.QuantumCircuit.pauli#qiskit.circuit.QuantumCircuit.pauli "qiskit.circuit.QuantumCircuit.pauli") | Apply [`PauliGate`](qiskit.circuit.library.PauliGate#qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). | -| [`power`](qiskit.circuit.QuantumCircuit.power#qiskit.circuit.QuantumCircuit.power "qiskit.circuit.QuantumCircuit.power") | Raise this circuit to the power of `power`. | -| [`qasm`](qiskit.circuit.QuantumCircuit.qasm#qiskit.circuit.QuantumCircuit.qasm "qiskit.circuit.QuantumCircuit.qasm") | Return OpenQASM string. | -| [`qbit_argument_conversion`](qiskit.circuit.QuantumCircuit.qbit_argument_conversion#qiskit.circuit.QuantumCircuit.qbit_argument_conversion "qiskit.circuit.QuantumCircuit.qbit_argument_conversion") | Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. | -| [`qubit_duration`](qiskit.circuit.QuantumCircuit.qubit_duration#qiskit.circuit.QuantumCircuit.qubit_duration "qiskit.circuit.QuantumCircuit.qubit_duration") | Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. | -| [`qubit_start_time`](qiskit.circuit.QuantumCircuit.qubit_start_time#qiskit.circuit.QuantumCircuit.qubit_start_time "qiskit.circuit.QuantumCircuit.qubit_start_time") | Return the start time of the first instruction, excluding delays, over the supplied qubits. | -| [`qubit_stop_time`](qiskit.circuit.QuantumCircuit.qubit_stop_time#qiskit.circuit.QuantumCircuit.qubit_stop_time "qiskit.circuit.QuantumCircuit.qubit_stop_time") | Return the stop time of the last instruction, excluding delays, over the supplied qubits. | -| [`r`](qiskit.circuit.QuantumCircuit.r#qiskit.circuit.QuantumCircuit.r "qiskit.circuit.QuantumCircuit.r") | Apply [`RGate`](qiskit.circuit.library.RGate#qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). | -| [`rcccx`](qiskit.circuit.QuantumCircuit.rcccx#qiskit.circuit.QuantumCircuit.rcccx "qiskit.circuit.QuantumCircuit.rcccx") | Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate#qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). | -| [`rccx`](qiskit.circuit.QuantumCircuit.rccx#qiskit.circuit.QuantumCircuit.rccx "qiskit.circuit.QuantumCircuit.rccx") | Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate#qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). | -| [`remove_final_measurements`](qiskit.circuit.QuantumCircuit.remove_final_measurements#qiskit.circuit.QuantumCircuit.remove_final_measurements "qiskit.circuit.QuantumCircuit.remove_final_measurements") | Removes final measurement on all qubits if they are present. | -| [`repeat`](qiskit.circuit.QuantumCircuit.repeat#qiskit.circuit.QuantumCircuit.repeat "qiskit.circuit.QuantumCircuit.repeat") | Repeat this circuit `reps` times. | -| [`reset`](qiskit.circuit.QuantumCircuit.reset#qiskit.circuit.QuantumCircuit.reset "qiskit.circuit.QuantumCircuit.reset") | Reset q. | -| [`reverse_bits`](qiskit.circuit.QuantumCircuit.reverse_bits#qiskit.circuit.QuantumCircuit.reverse_bits "qiskit.circuit.QuantumCircuit.reverse_bits") | Return a circuit with the opposite order of wires. | -| [`reverse_ops`](qiskit.circuit.QuantumCircuit.reverse_ops#qiskit.circuit.QuantumCircuit.reverse_ops "qiskit.circuit.QuantumCircuit.reverse_ops") | Reverse the circuit by reversing the order of instructions. | -| [`rv`](qiskit.circuit.QuantumCircuit.rv#qiskit.circuit.QuantumCircuit.rv "qiskit.circuit.QuantumCircuit.rv") | Apply [`RVGate`](qiskit.circuit.library.RVGate#qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). | -| [`rx`](qiskit.circuit.QuantumCircuit.rx#qiskit.circuit.QuantumCircuit.rx "qiskit.circuit.QuantumCircuit.rx") | Apply [`RXGate`](qiskit.circuit.library.RXGate#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). | -| [`rxx`](qiskit.circuit.QuantumCircuit.rxx#qiskit.circuit.QuantumCircuit.rxx "qiskit.circuit.QuantumCircuit.rxx") | Apply [`RXXGate`](qiskit.circuit.library.RXXGate#qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). | -| [`ry`](qiskit.circuit.QuantumCircuit.ry#qiskit.circuit.QuantumCircuit.ry "qiskit.circuit.QuantumCircuit.ry") | Apply [`RYGate`](qiskit.circuit.library.RYGate#qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). | -| [`ryy`](qiskit.circuit.QuantumCircuit.ryy#qiskit.circuit.QuantumCircuit.ryy "qiskit.circuit.QuantumCircuit.ryy") | Apply [`RYYGate`](qiskit.circuit.library.RYYGate#qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). | -| [`rz`](qiskit.circuit.QuantumCircuit.rz#qiskit.circuit.QuantumCircuit.rz "qiskit.circuit.QuantumCircuit.rz") | Apply [`RZGate`](qiskit.circuit.library.RZGate#qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). | -| [`rzx`](qiskit.circuit.QuantumCircuit.rzx#qiskit.circuit.QuantumCircuit.rzx "qiskit.circuit.QuantumCircuit.rzx") | Apply [`RZXGate`](qiskit.circuit.library.RZXGate#qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). | -| [`rzz`](qiskit.circuit.QuantumCircuit.rzz#qiskit.circuit.QuantumCircuit.rzz "qiskit.circuit.QuantumCircuit.rzz") | Apply [`RZZGate`](qiskit.circuit.library.RZZGate#qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). | -| [`s`](qiskit.circuit.QuantumCircuit.s#qiskit.circuit.QuantumCircuit.s "qiskit.circuit.QuantumCircuit.s") | Apply [`SGate`](qiskit.circuit.library.SGate#qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). | -| [`save_amplitudes`](qiskit.circuit.QuantumCircuit.save_amplitudes#qiskit.circuit.QuantumCircuit.save_amplitudes "qiskit.circuit.QuantumCircuit.save_amplitudes") | Save complex statevector amplitudes. | -| [`save_amplitudes_squared`](qiskit.circuit.QuantumCircuit.save_amplitudes_squared#qiskit.circuit.QuantumCircuit.save_amplitudes_squared "qiskit.circuit.QuantumCircuit.save_amplitudes_squared") | Save squared statevector amplitudes (probabilities). | -| [`save_density_matrix`](qiskit.circuit.QuantumCircuit.save_density_matrix#qiskit.circuit.QuantumCircuit.save_density_matrix "qiskit.circuit.QuantumCircuit.save_density_matrix") | Save the current simulator quantum state as a density matrix. | -| [`save_expectation_value`](qiskit.circuit.QuantumCircuit.save_expectation_value#qiskit.circuit.QuantumCircuit.save_expectation_value "qiskit.circuit.QuantumCircuit.save_expectation_value") | Save the expectation value of a Hermitian operator. | -| [`save_expectation_value_variance`](qiskit.circuit.QuantumCircuit.save_expectation_value_variance#qiskit.circuit.QuantumCircuit.save_expectation_value_variance "qiskit.circuit.QuantumCircuit.save_expectation_value_variance") | Save the expectation value of a Hermitian operator. | -| [`save_matrix_product_state`](qiskit.circuit.QuantumCircuit.save_matrix_product_state#qiskit.circuit.QuantumCircuit.save_matrix_product_state "qiskit.circuit.QuantumCircuit.save_matrix_product_state") | Save the current simulator quantum state as a matrix product state. | -| [`save_probabilities`](qiskit.circuit.QuantumCircuit.save_probabilities#qiskit.circuit.QuantumCircuit.save_probabilities "qiskit.circuit.QuantumCircuit.save_probabilities") | Save measurement outcome probabilities vector. | -| [`save_probabilities_dict`](qiskit.circuit.QuantumCircuit.save_probabilities_dict#qiskit.circuit.QuantumCircuit.save_probabilities_dict "qiskit.circuit.QuantumCircuit.save_probabilities_dict") | Save measurement outcome probabilities vector. | -| [`save_stabilizer`](qiskit.circuit.QuantumCircuit.save_stabilizer#qiskit.circuit.QuantumCircuit.save_stabilizer "qiskit.circuit.QuantumCircuit.save_stabilizer") | Save the current stabilizer simulator quantum state as a Clifford. | -| [`save_state`](qiskit.circuit.QuantumCircuit.save_state#qiskit.circuit.QuantumCircuit.save_state "qiskit.circuit.QuantumCircuit.save_state") | Save the current simulator quantum state. | -| [`save_statevector`](qiskit.circuit.QuantumCircuit.save_statevector#qiskit.circuit.QuantumCircuit.save_statevector "qiskit.circuit.QuantumCircuit.save_statevector") | Save the current simulator quantum state as a statevector. | -| [`save_statevector_dict`](qiskit.circuit.QuantumCircuit.save_statevector_dict#qiskit.circuit.QuantumCircuit.save_statevector_dict "qiskit.circuit.QuantumCircuit.save_statevector_dict") | Save the current simulator quantum state as a statevector as a dict. | -| [`save_superop`](qiskit.circuit.QuantumCircuit.save_superop#qiskit.circuit.QuantumCircuit.save_superop "qiskit.circuit.QuantumCircuit.save_superop") | Save the current state of the superop simulator. | -| [`save_unitary`](qiskit.circuit.QuantumCircuit.save_unitary#qiskit.circuit.QuantumCircuit.save_unitary "qiskit.circuit.QuantumCircuit.save_unitary") | Save the current state of the unitary simulator. | -| [`sdg`](qiskit.circuit.QuantumCircuit.sdg#qiskit.circuit.QuantumCircuit.sdg "qiskit.circuit.QuantumCircuit.sdg") | Apply [`SdgGate`](qiskit.circuit.library.SdgGate#qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). | -| [`set_density_matrix`](qiskit.circuit.QuantumCircuit.set_density_matrix#qiskit.circuit.QuantumCircuit.set_density_matrix "qiskit.circuit.QuantumCircuit.set_density_matrix") | Set the density matrix state of the simulator. | -| [`set_matrix_product_state`](qiskit.circuit.QuantumCircuit.set_matrix_product_state#qiskit.circuit.QuantumCircuit.set_matrix_product_state "qiskit.circuit.QuantumCircuit.set_matrix_product_state") | Set the matrix product state of the simulator. | -| [`set_stabilizer`](qiskit.circuit.QuantumCircuit.set_stabilizer#qiskit.circuit.QuantumCircuit.set_stabilizer "qiskit.circuit.QuantumCircuit.set_stabilizer") | Set the Clifford stabilizer state of the simulator. | -| [`set_statevector`](qiskit.circuit.QuantumCircuit.set_statevector#qiskit.circuit.QuantumCircuit.set_statevector "qiskit.circuit.QuantumCircuit.set_statevector") | Set the statevector state of the simulator. | -| [`set_superop`](qiskit.circuit.QuantumCircuit.set_superop#qiskit.circuit.QuantumCircuit.set_superop "qiskit.circuit.QuantumCircuit.set_superop") | Set the superop state of the simulator. | -| [`set_unitary`](qiskit.circuit.QuantumCircuit.set_unitary#qiskit.circuit.QuantumCircuit.set_unitary "qiskit.circuit.QuantumCircuit.set_unitary") | Set the state state of the simulator. | -| [`size`](qiskit.circuit.QuantumCircuit.size#qiskit.circuit.QuantumCircuit.size "qiskit.circuit.QuantumCircuit.size") | Returns total number of gate operations in circuit. | -| [`snapshot`](qiskit.circuit.QuantumCircuit.snapshot#qiskit.circuit.QuantumCircuit.snapshot "qiskit.circuit.QuantumCircuit.snapshot") | Take a statevector snapshot of the internal simulator representation. | -| [`snapshot_density_matrix`](qiskit.circuit.QuantumCircuit.snapshot_density_matrix#qiskit.circuit.QuantumCircuit.snapshot_density_matrix "qiskit.circuit.QuantumCircuit.snapshot_density_matrix") | Take a density matrix snapshot of simulator state. | -| [`snapshot_expectation_value`](qiskit.circuit.QuantumCircuit.snapshot_expectation_value#qiskit.circuit.QuantumCircuit.snapshot_expectation_value "qiskit.circuit.QuantumCircuit.snapshot_expectation_value") | Take a snapshot of expectation value \ of an Operator. | -| [`snapshot_probabilities`](qiskit.circuit.QuantumCircuit.snapshot_probabilities#qiskit.circuit.QuantumCircuit.snapshot_probabilities "qiskit.circuit.QuantumCircuit.snapshot_probabilities") | Take a probability snapshot of the simulator state. | -| [`snapshot_stabilizer`](qiskit.circuit.QuantumCircuit.snapshot_stabilizer#qiskit.circuit.QuantumCircuit.snapshot_stabilizer "qiskit.circuit.QuantumCircuit.snapshot_stabilizer") | Take a stabilizer snapshot of the simulator state. | -| [`snapshot_statevector`](qiskit.circuit.QuantumCircuit.snapshot_statevector#qiskit.circuit.QuantumCircuit.snapshot_statevector "qiskit.circuit.QuantumCircuit.snapshot_statevector") | Take a statevector snapshot of the simulator state. | -| [`squ`](qiskit.circuit.QuantumCircuit.squ#qiskit.circuit.QuantumCircuit.squ "qiskit.circuit.QuantumCircuit.squ") | Decompose an arbitrary 2\*2 unitary into three rotation gates. | -| [`swap`](qiskit.circuit.QuantumCircuit.swap#qiskit.circuit.QuantumCircuit.swap "qiskit.circuit.QuantumCircuit.swap") | Apply [`SwapGate`](qiskit.circuit.library.SwapGate#qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). | -| [`sx`](qiskit.circuit.QuantumCircuit.sx#qiskit.circuit.QuantumCircuit.sx "qiskit.circuit.QuantumCircuit.sx") | Apply [`SXGate`](qiskit.circuit.library.SXGate#qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). | -| [`sxdg`](qiskit.circuit.QuantumCircuit.sxdg#qiskit.circuit.QuantumCircuit.sxdg "qiskit.circuit.QuantumCircuit.sxdg") | Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate#qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). | -| [`t`](qiskit.circuit.QuantumCircuit.t#qiskit.circuit.QuantumCircuit.t "qiskit.circuit.QuantumCircuit.t") | Apply [`TGate`](qiskit.circuit.library.TGate#qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). | -| [`tdg`](qiskit.circuit.QuantumCircuit.tdg#qiskit.circuit.QuantumCircuit.tdg "qiskit.circuit.QuantumCircuit.tdg") | Apply [`TdgGate`](qiskit.circuit.library.TdgGate#qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). | -| [`tensor`](qiskit.circuit.QuantumCircuit.tensor#qiskit.circuit.QuantumCircuit.tensor "qiskit.circuit.QuantumCircuit.tensor") | Tensor `self` with `other`. | -| [`to_gate`](qiskit.circuit.QuantumCircuit.to_gate#qiskit.circuit.QuantumCircuit.to_gate "qiskit.circuit.QuantumCircuit.to_gate") | Create a Gate out of this circuit. | -| [`to_instruction`](qiskit.circuit.QuantumCircuit.to_instruction#qiskit.circuit.QuantumCircuit.to_instruction "qiskit.circuit.QuantumCircuit.to_instruction") | Create an Instruction out of this circuit. | -| [`toffoli`](qiskit.circuit.QuantumCircuit.toffoli#qiskit.circuit.QuantumCircuit.toffoli "qiskit.circuit.QuantumCircuit.toffoli") | Apply [`CCXGate`](qiskit.circuit.library.CCXGate#qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). | -| [`u`](qiskit.circuit.QuantumCircuit.u#qiskit.circuit.QuantumCircuit.u "qiskit.circuit.QuantumCircuit.u") | Apply [`UGate`](qiskit.circuit.library.UGate#qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). | -| [`u1`](qiskit.circuit.QuantumCircuit.u1#qiskit.circuit.QuantumCircuit.u1 "qiskit.circuit.QuantumCircuit.u1") | Apply [`U1Gate`](qiskit.circuit.library.U1Gate#qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). | -| [`u2`](qiskit.circuit.QuantumCircuit.u2#qiskit.circuit.QuantumCircuit.u2 "qiskit.circuit.QuantumCircuit.u2") | Apply [`U2Gate`](qiskit.circuit.library.U2Gate#qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). | -| [`u3`](qiskit.circuit.QuantumCircuit.u3#qiskit.circuit.QuantumCircuit.u3 "qiskit.circuit.QuantumCircuit.u3") | Apply [`U3Gate`](qiskit.circuit.library.U3Gate#qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). | -| [`uc`](qiskit.circuit.QuantumCircuit.uc#qiskit.circuit.QuantumCircuit.uc "qiskit.circuit.QuantumCircuit.uc") | Attach a uniformly controlled gates (also called multiplexed gates) to a circuit. | -| [`ucrx`](qiskit.circuit.QuantumCircuit.ucrx#qiskit.circuit.QuantumCircuit.ucrx "qiskit.circuit.QuantumCircuit.ucrx") | Attach a uniformly controlled (also called multiplexed) Rx rotation gate to a circuit. | -| [`ucry`](qiskit.circuit.QuantumCircuit.ucry#qiskit.circuit.QuantumCircuit.ucry "qiskit.circuit.QuantumCircuit.ucry") | Attach a uniformly controlled (also called multiplexed) Ry rotation gate to a circuit. | -| [`ucrz`](qiskit.circuit.QuantumCircuit.ucrz#qiskit.circuit.QuantumCircuit.ucrz "qiskit.circuit.QuantumCircuit.ucrz") | Attach a uniformly controlled (also called multiplexed gates) Rz rotation gate to a circuit. | -| [`unitary`](qiskit.circuit.QuantumCircuit.unitary#qiskit.circuit.QuantumCircuit.unitary "qiskit.circuit.QuantumCircuit.unitary") | Apply unitary gate to q. | -| [`width`](qiskit.circuit.QuantumCircuit.width#qiskit.circuit.QuantumCircuit.width "qiskit.circuit.QuantumCircuit.width") | Return number of qubits plus clbits in circuit. | -| [`x`](qiskit.circuit.QuantumCircuit.x#qiskit.circuit.QuantumCircuit.x "qiskit.circuit.QuantumCircuit.x") | Apply [`XGate`](qiskit.circuit.library.XGate#qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). | -| [`y`](qiskit.circuit.QuantumCircuit.y#qiskit.circuit.QuantumCircuit.y "qiskit.circuit.QuantumCircuit.y") | Apply [`YGate`](qiskit.circuit.library.YGate#qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). | -| [`z`](qiskit.circuit.QuantumCircuit.z#qiskit.circuit.QuantumCircuit.z "qiskit.circuit.QuantumCircuit.z") | Apply [`ZGate`](qiskit.circuit.library.ZGate#qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). | +### add\_bits -## Attributes + +`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. -### ancillas +### add\_calibration -Returns a list of ancilla bits in the order that the registers were added. + +`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. -### calibrations +**Parameters** -Return calibration dictionary. +* **gate** (*Union\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*, str]*) – Gate information. +* **qubits** (*Union\[int, Tuple\[int]]*) – List of qubits to be measured. +* **schedule** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")) – Schedule information. +* **params** (*Optional\[List\[Union\[float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]]*) – A list of parameters. -**The custom pulse definition of a given gate is of the form** +**Raises** -\{‘gate\_name’: \{(qubits, params): schedule}} +**Exception** – if the gate is of type string and params is None. +### add\_register + -### clbits +`QuantumCircuit.add_register(*regs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") -Returns a list of classical bits in the order that the registers were added. +Add registers. +### append + -### data +`QuantumCircuit.append(instruction, qargs=None, cargs=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") -Return the circuit data (instructions and context). +Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. + +**Parameters** + +* **instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – Instruction instance to append +* **qargs** (*list(argument)*) – qubits to attach instruction to +* **cargs** (*list(argument)*) – clbits to attach instruction to **Returns** -a list-like object containing the tuples for the circuit’s data. +a handle to the instruction that was just added -Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects. +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +* **CircuitError** – if object passed is a subclass of Instruction +* **CircuitError** – if object passed is neither subclass nor an instance of Instruction + +### assign\_parameters + + + +`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. + +The keys of the parameter dictionary must be Parameter instances in the current circuit. The values of the dictionary can either be numeric values or new parameter objects. The values can be assigned to the current circuit object or to a copy of it. + +**Parameters** + +* **parameters** (*dict or iterable*) – Either a dictionary or iterable specifying the new parameter values. If a dict, it specifies the mapping from `current_parameter` to `new_parameter`, where `new_parameter` can be a new parameter object or a numeric value. If an iterable, the elements are assigned to the existing parameters in the order they were inserted. You can call `QuantumCircuit.parameters` to check this order. +* **inplace** (*bool*) – If False, a copy of the circuit with the bound parameters is returned. If True the circuit instance itself is modified. +* **param\_dict** (*dict*) – Deprecated, use `parameters` instead. + +**Raises** + +* **CircuitError** – If parameters is a dict and contains parameters not present in the circuit. +* **ValueError** – If parameters is a list/array and the length mismatches the number of free parameters in the circuit. + +**Returns** + +A copy of the circuit with bound parameters, if `inplace` is False, otherwise None. **Return type** -QuantumCircuitData +Optional([QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) +#### Examples +Create a parameterized circuit and assign the parameters in-place. -### extension\_lib +```python +from qiskit.circuit import QuantumCircuit, Parameter -`= 'include "qelib1.inc";'` +circuit = QuantumCircuit(2) +params = [Parameter('A'), Parameter('B'), Parameter('C')] +circuit.ry(params[0], 0) +circuit.crx(params[1], 0, 1) +print('Original circuit:') +print(circuit.draw()) +circuit.assign_parameters({params[0]: params[2]}, inplace=True) -### global\_phase +print('Assigned in-place:') +print(circuit.draw()) +``` -Return the global phase of the circuit in radians. +```python +Original circuit: + ┌───────┐ +q_0: ┤ Ry(A) ├────■──── + └───────┘┌───┴───┐ +q_1: ─────────┤ Rx(B) ├ + └───────┘ +Assigned in-place: + ┌───────┐ +q_0: ┤ Ry(C) ├────■──── + └───────┘┌───┴───┐ +q_1: ─────────┤ Rx(B) ├ + └───────┘ +``` +Bind the values out-of-place and get a copy of the original circuit. +```python +from qiskit.circuit import QuantumCircuit, ParameterVector -### header +circuit = QuantumCircuit(2) +params = ParameterVector('P', 2) +circuit.ry(params[0], 0) +circuit.crx(params[1], 0, 1) -`= 'OPENQASM 2.0;'` +bound_circuit = circuit.assign_parameters({params[0]: 1, params[1]: 2}) +print('Bound circuit:') +print(bound_circuit.draw()) +print('The original circuit is unchanged:') +print(circuit.draw()) +``` +```python +Bound circuit: + ┌───────┐ +q_0: ┤ Ry(1) ├────■──── + └───────┘┌───┴───┐ +q_1: ─────────┤ Rx(2) ├ + └───────┘ +The original circuit is unchanged: + ┌──────────┐ +q_0: ┤ Ry(P[0]) ├─────■────── + └──────────┘┌────┴─────┐ +q_1: ────────────┤ Rx(P[1]) ├ + └──────────┘ +``` -### instances +### barrier -`= 16` + +`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. -### metadata +### bind\_parameters -The user provided metadata associated with the circuit + -The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. +`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. +To assign new Parameter objects or bind the values in-place, without yielding a new circuit, use the [`assign_parameters()`](qiskit.circuit.QuantumCircuit#assign_parameters "qiskit.circuit.QuantumCircuit.assign_parameters") method. -### num\_ancillas +**Parameters** -Return the number of ancilla qubits. +* **values** (*dict or iterable*) – \{parameter: value, …} or \[value1, value2, …] +* **value\_dict** (*dict*) – Deprecated, use `values` instead. +**Raises** +* **CircuitError** – If values is a dict and contains parameters not present in the circuit. +* **TypeError** – If values contains a ParameterExpression. -### num\_clbits +**Returns** -Return number of classical bits. +copy of self with assignment substitution. +**Return type** +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") -### num\_parameters +### cast -Convenience function to get the number of parameter objects in the circuit. + +`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. -### num\_qubits +### cbit\_argument\_conversion -Return number of qubits. + +`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. -### parameters +**Parameters** -Convenience function to get the parameters defined in the parameter table. +**clbit\_representation** (*Object*) – representation to expand +**Returns** +Where each tuple is a classical bit. -### prefix +**Return type** -`= 'circuit'` +List(tuple) +### ccx + -### qubits +`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"). + +### ch + + + +`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"). + +### cls\_instances + + + +`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. + +### cls\_prefix + + + +`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. + +### cnot + + + +`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"). + +### combine + + + +`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. + +Two circuits are compatible if they contain the same registers or if they contain different registers with unique names. The returned circuit will contain all unique registers between both circuits. + +Return self + rhs as a new object. + +**Parameters** + +**rhs** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit to append to the right hand side. + +**Returns** + +Returns a new QuantumCircuit object + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the rhs circuit is not compatible + +### compose + + + +`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. + +`other` can be narrower or of equal width to `self`. + +**Parameters** + +* **other** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or BaseOperator*) – (sub)circuit to compose onto self. +* **qubits** (*list\[Qubit|int]*) – qubits of self to compose onto. +* **clbits** (*list\[Clbit|int]*) – clbits of self to compose onto. +* **front** (*bool*) – If True, front composition will be performed (not implemented yet). +* **inplace** (*bool*) – If True, modify the object. Otherwise return composed circuit. +* **wrap** (*bool*) – If True, wraps the other circuit into a gate (or instruction, depending on whether it contains only unitary instructions) before composing it onto self. + +**Returns** + +the composed circuit (returns None if inplace==True). + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **CircuitError** – if composing on the front. +* **QiskitError** – if `other` is wider or there are duplicate edge mappings. + +Examples: + +```python +lhs.compose(rhs, qubits=[3, 2], inplace=True) + +.. parsed-literal:: + + ┌───┐ ┌─────┐ ┌───┐ + lqr_1_0: ───┤ H ├─── rqr_0: ──■──┤ Tdg ├ lqr_1_0: ───┤ H ├─────────────── + ├───┤ ┌─┴─┐└─────┘ ├───┤ + lqr_1_1: ───┤ X ├─── rqr_1: ┤ X ├─────── lqr_1_1: ───┤ X ├─────────────── + ┌──┴───┴──┐ └───┘ ┌──┴───┴──┐┌───┐ + lqr_1_2: ┤ U1(0.1) ├ + = lqr_1_2: ┤ U1(0.1) ├┤ X ├─────── + └─────────┘ └─────────┘└─┬─┘┌─────┐ + lqr_2_0: ─────■───── lqr_2_0: ─────■───────■──┤ Tdg ├ + ┌─┴─┐ ┌─┴─┐ └─────┘ + lqr_2_1: ───┤ X ├─── lqr_2_1: ───┤ X ├─────────────── + └───┘ └───┘ + lcr_0: 0 ═══════════ lcr_0: 0 ═══════════════════════ + + lcr_1: 0 ═══════════ lcr_1: 0 ═══════════════════════ +``` + +### control + + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – The number of control qubits. +* **label** (*str*) – An optional label to give the controlled operation for visualization. +* **ctrl\_state** (*str or int*) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use `2**num_ctrl_qubits - 1`. + +**Returns** + +The controlled version of this circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**CircuitError** – If the circuit contains a non-unitary operation and cannot be controlled. + +### copy + + + +`QuantumCircuit.copy(name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/quantumcircuit.py "view source code") + +Copy the circuit. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit. If None, then the name stays the same + +**Returns** + +a deepcopy of the current circuit, with the specified name + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### count\_ops + + + +`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. + +**Returns** + +a breakdown of how many operations of each kind, sorted by amount. + +**Return type** + +OrderedDict + +### cp + + + +`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"). + +### crx + + + +`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"). + +### cry + + + +`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"). + +### crz + + + +`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"). + +### cswap + + + +`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"). + +### csx + + + +`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"). + +### cu + + + +`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"). + +### cu1 + + + +`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"). + +### cu3 + + + +`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"). + +### cx + + + +`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"). + +### cy + + + +`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"). + +### cz + + + +`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"). + +### dcx + + + +`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"). + +### decompose + + + +`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). + +**Returns** + +a circuit one level decomposed + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### delay + + + +`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. + +**Parameters** + +* **duration** (*int or float or* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – duration of the delay. +* **qarg** (*Object*) – qubit argument to apply this delay. +* **unit** (*str*) – unit of the duration. Supported units: ‘s’, ‘ms’, ‘us’, ‘ns’, ‘ps’, ‘dt’. Default is `dt`, i.e. integer time unit depending on the target backend. + +**Returns** + +the attached delay instruction. + +**Return type** + +qiskit.Instruction + +**Raises** + +**CircuitError** – if arguments have bad format. + +### depth + + + +`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’. + +**Returns** + +Depth of circuit. + +**Return type** + +int + +#### Notes + +The circuit depth and the DAG depth need not be the same. + +### diagonal + + + +`QuantumCircuit.diagonal(diag, qubit)` + +Attach a diagonal gate to a circuit. + +The decomposition is based on Theorem 7 given in “Synthesis of Quantum Logic Circuits” by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)). + +**Parameters** + +* **diag** (*list*) – list of the 2^k diagonal entries (for a diagonal gate on k qubits). Must contain at least two entries +* **qubit** (*QuantumRegister|list*) – list of k qubits the diagonal is acting on (the order of the qubits specifies the computational basis in which the diagonal gate is provided: the first element in diag acts on the state where all the qubits in q are in the state 0, the second entry acts on the state where all the qubits q\[1],…,q\[k-1] are in the state zero and q\[0] is in the state 1, and so on) + +**Returns** + +the diagonal gate which was attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list of the diagonal entries or the qubit list is in bad format; if the number of diagonal entries is not 2^k, where k denotes the number of qubits + +### draw + + + +`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: + +**text**: ASCII art TextDrawing that can be printed in the console. + +**matplotlib**: images with color rendered purely in Python. + +**latex**: high-quality images compiled via latex. + +**latex\_source**: raw uncompiled latex output. + +**Parameters** + +* **output** (*str*) – select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default the text drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file. +* **scale** (*float*) – scale of image to draw (shrink if \< 1.0). Only used by the mpl, latex and latex\_source outputs. Defaults to 1.0. +* **filename** (*str*) – file path to save image to. Defaults to None. +* **style** (*dict or str*) – dictionary of style or file name of style json file. This option is only used by the mpl or latex output type. If style is a str, it is used as the path to a json file which contains a style dict. The file will be opened, parsed, and then any style elements in the dict will replace the default values in the input dict. A file to be loaded must end in `.json`, but the name entered here can omit `.json`. For example, `style='iqx.json'` or `style='iqx'`. If style is a dict and the `'name'` key is set, that name will be used to load a json file, followed by loading the other items in the style dict. For example, `style={'name': 'iqx'}`. If style is not a str and name is not a key in the style dict, then the default value from the user config file (usually `~/.qiskit/settings.conf`) will be used, for example, `circuit_mpl_style = iqx`. If none of these are set, the default style will be used. The search path for style json files can be specified in the user config, for example, `circuit_mpl_style_path = /home/user/styles:/home/user`. See: [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle") for more information on the contents. +* **interactive** (*bool*) – when set to true, show the circuit in a new window (for mpl this depends on the matplotlib backend being used supporting this). Note when used with either the text or the latex\_source output type this has no effect and will be silently ignored. Defaults to False. +* **reverse\_bits** (*bool*) – when set to True, reverse the bit order inside registers for the output visualization. Defaults to False. +* **plot\_barriers** (*bool*) – enable/disable drawing barriers in the output circuit. Defaults to True. +* **justify** (*string*) – options are `left`, `right` or `none`. If anything else is supplied, it defaults to left justified. It refers to where gates should be placed in the output circuit if there is an option. `none` results in each gate being placed in its own column. +* **vertical\_compression** (*string*) – `high`, `medium` or `low`. It merges the lines generated by the text output so the drawing will take less vertical room. Default is `medium`. Only used by the text output, will be silently ignored otherwise. +* **idle\_wires** (*bool*) – include idle wires (wires with no circuit elements) in output visualization. Default is True. +* **with\_layout** (*bool*) – include layout information, with labels on the physical layout. Default is True. +* **fold** (*int*) – sets pagination. It can be disabled using -1. In text, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In mpl, it is the number of (visual) layers before folding. Default is 25. +* **ax** (*matplotlib.axes.Axes*) – Only used by the mpl backend. An optional Axes object to be used for the visualization output. If none is specified, a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. +* **initial\_state** (*bool*) – optional. Adds `|0>` in the beginning of the wire. Default is False. +* **cregbundle** (*bool*) – optional. If set True, bundle classical registers. Default is True. + +**Returns** + +`TextDrawing` or `matplotlib.figure` or `PIL.Image` or `str`: + +* **TextDrawing (output=’text’)** + + A drawing that can be printed as ascii art. + +* **matplotlib.figure.Figure (output=’mpl’)** + + A matplotlib figure object for the circuit diagram. + +* **PIL.Image (output=’latex’)** + + An in-memory representation of the image of the circuit diagram. + +* **str (output=’latex\_source’)** + + The LaTeX source code for visualizing the circuit diagram. + +**Raises** + +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected +* **ImportError** – when the output methods requires non-installed libraries. + +#### Example + +```python +from qiskit import QuantumRegister, ClassicalRegister, QuantumCircuit +from qiskit.tools.visualization import circuit_drawer +q = QuantumRegister(1) +c = ClassicalRegister(1) +qc = QuantumCircuit(q, c) +qc.h(q) +qc.measure(q, c) +qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) +``` + +![../\_images/qiskit.circuit.QuantumCircuit.draw\_0\_0.png](/images/api/qiskit/0.32/qiskit.circuit.QuantumCircuit.draw_0_0.png) + +### ecr + + + +`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"). + +### extend + + + +`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. + +Two circuits are compatible if they contain the same registers or if they contain different registers with unique names. The returned circuit will contain all unique registers between both circuits. + +Modify and return self. + +**Parameters** + +**rhs** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit to append to the right hand side. + +**Returns** + +Returns this QuantumCircuit object (which has been modified) + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the rhs circuit is not compatible + +### fredkin + + + +`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"). + +### from\_qasm\_file + + + +`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. + +**Parameters** + +**path** (*str*) – Path to the file for a QASM program + +**Returns** + +The QuantumCircuit object for the input QASM + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### from\_qasm\_str + + + +`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. + +**Parameters** + +**qasm\_str** (*str*) – A QASM program string + +**Returns** + +The QuantumCircuit object for the input QASM + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### get\_instructions + + + +`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. + +**Parameters** + +**name** (*str*) – The name of instruction to. + +**Returns** + +list of (instruction, qargs, cargs). + +**Return type** + +list(tuple) + +### h + + + +`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"). + +### hamiltonian + + + +`QuantumCircuit.hamiltonian(operator, time, qubits, label=None)` + +Apply hamiltonian evolution to qubits. + +### has\_register + + + +`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. + +**Parameters** + +**register** (*Register*) – a quantum or classical register. + +**Returns** + +True if the register is contained in this circuit. + +**Return type** + +bool + +### i + + + +`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"). + +### id + + + +`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"). + +### initialize + + + +`QuantumCircuit.initialize(params, qubits=None)` + +Initialize qubits in a specific state. + +Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by an state preparing unitary. Both these steps are included in the Initialize instruction. + +**Parameters** + +* **params** (*str or list or int*) – + + * **str: labels of basis states of the Pauli eigenstates Z, X, Y. See** + + `from_label()`. Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to |1> and the qubit one to |0>. + + * list: vector of complex amplitudes to initialize to. + + * **int: an integer that is used as a bitmap indicating which qubits to initialize** + + to |1>. Example: setting params to 5 would initialize qubit 0 and qubit 2 to |1> and qubit 1 to |0>. + +* **qubits** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or int*) – + + * QuantumRegister: A list of qubits to be initialized \[Default: None]. + * int: Index of qubit to initialized \[Default: None]. + +**Returns** + +a handle to the instruction that was just initialized + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +#### Examples + +Prepare a qubit in the state $(|0\rangle - |1\rangle) / \sqrt{2}$. + +```python +import numpy as np +from qiskit import QuantumCircuit + +circuit = QuantumCircuit(1) +circuit.initialize([1/np.sqrt(2), -1/np.sqrt(2)], 0) +circuit.draw() +``` + +```python + ┌──────────────────────────────┐ +q_0: ┤ Initialize(0.70711,-0.70711) ├ + └──────────────────────────────┘ +``` + +#### output: + +┌──────────────────────────────┐ + +#### q\_0: ┤ initialize(0.70711,-0.70711) ├ + +└──────────────────────────────┘ + +Initialize from a string two qubits in the state |10>. The order of the labels is reversed with respect to qubit index. More information about labels for basis states are in `from_label()`. + +```python +import numpy as np +from qiskit import QuantumCircuit + +circuit = QuantumCircuit(2) +circuit.initialize('01', circuit.qubits) +circuit.draw() +``` + +```python + ┌──────────────────┐ +q_0: ┤0 ├ + │ Initialize(0,1) │ +q_1: ┤1 ├ + └──────────────────┘ +``` + +#### output: + +┌──────────────────┐ + +#### q\_0: ┤0 ├ + +│ initialize(0,1) │ + +#### q\_1: ┤1 ├ + +└──────────────────┘ + +Initialize two qubits from an array of complex amplitudes .. jupyter-execute: + +```python +import numpy as np +from qiskit import QuantumCircuit + +circuit = QuantumCircuit(2) +circuit.initialize([0, 1/np.sqrt(2), -1.j/np.sqrt(2), 0], circuit.qubits) +circuit.draw() +``` + +#### output: + +┌────────────────────────────────────┐ + +#### q\_0: ┤0 ├ + +│ initialize(0,0.70711,-0.70711j,0) │ + +#### q\_1: ┤1 ├ + +└────────────────────────────────────┘ + +### inverse + + + +`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. + +This is done by recursively inverting all gates. + +**Returns** + +the inverted circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**CircuitError** – if the circuit cannot be inverted. + +#### Examples + +#### input: + +┌───┐ + +#### q\_0: ┤ H ├─────■────── + +└───┘┌────┴─────┐ + +#### q\_1: ─────┤ RX(1.57) ├ + +└──────────┘ + +#### output: + +┌───┐ + +#### q\_0: ──────■──────┤ H ├ + +┌─────┴─────┐└───┘ + +#### q\_1: ┤ RX(-1.57) ├───── + +└───────────┘ + +### iso + + + +`QuantumCircuit.iso(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None, epsilon=1e-10)` + +Attach an arbitrary isometry from m to n qubits to a circuit. In particular, this allows to attach arbitrary unitaries on n qubits (m=n) or to prepare any state on n qubits (m=0). The decomposition used here was introduced by Iten et al. in [https://arxiv.org/abs/1501.06911](https://arxiv.org/abs/1501.06911). + +**Parameters** + +* **isometry** (*ndarray*) – an isometry from m to n qubits, i.e., a (complex) ndarray of dimension 2^n×2^m with orthonormal columns (given in the computational basis specified by the order of the ancillas and the input qubits, where the ancillas are considered to be more significant than the input qubits.). +* **q\_input** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of m qubits where the input to the isometry is fed in (empty list for state preparation). +* **q\_ancillas\_for\_output** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of n-m ancilla qubits that are used for the output of the isometry and which are assumed to start in the zero state. The qubits are listed with increasing significance. +* **q\_ancillas\_zero** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which are assumed to start in the zero state. Default is q\_ancillas\_zero = None. +* **q\_ancillas\_dirty** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None. +* **epsilon** (*float*) – error tolerance of calculations. Default is epsilon = \_EPS. + +**Returns** + +the isometry is attached to the quantum circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the array is not an isometry of the correct size corresponding to the provided number of qubits. + +### isometry + + + +`QuantumCircuit.isometry(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None, epsilon=1e-10)` + +Attach an arbitrary isometry from m to n qubits to a circuit. In particular, this allows to attach arbitrary unitaries on n qubits (m=n) or to prepare any state on n qubits (m=0). The decomposition used here was introduced by Iten et al. in [https://arxiv.org/abs/1501.06911](https://arxiv.org/abs/1501.06911). + +**Parameters** + +* **isometry** (*ndarray*) – an isometry from m to n qubits, i.e., a (complex) ndarray of dimension 2^n×2^m with orthonormal columns (given in the computational basis specified by the order of the ancillas and the input qubits, where the ancillas are considered to be more significant than the input qubits.). +* **q\_input** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of m qubits where the input to the isometry is fed in (empty list for state preparation). +* **q\_ancillas\_for\_output** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of n-m ancilla qubits that are used for the output of the isometry and which are assumed to start in the zero state. The qubits are listed with increasing significance. +* **q\_ancillas\_zero** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which are assumed to start in the zero state. Default is q\_ancillas\_zero = None. +* **q\_ancillas\_dirty** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None. +* **epsilon** (*float*) – error tolerance of calculations. Default is epsilon = \_EPS. + +**Returns** + +the isometry is attached to the quantum circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the array is not an isometry of the correct size corresponding to the provided number of qubits. + +### iswap + + + +`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"). + +### mcp + + + +`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"). + +### mcrx + + + +`QuantumCircuit.mcrx(theta, q_controls, q_target, use_basis_gates=False)` + +Apply Multiple-Controlled X rotation gate + +**Parameters** + +* **self** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcrx gate on. +* **theta** (*float*) – angle theta +* **q\_controls** (*list(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits +* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit +* **use\_basis\_gates** (*bool*) – use p, u, cx + +**Raises** + +**QiskitError** – parameter errors + +### mcry + + + +`QuantumCircuit.mcry(theta, q_controls, q_target, q_ancillae=None, mode=None, use_basis_gates=False)` + +Apply Multiple-Controlled Y rotation gate + +**Parameters** + +* **self** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcry gate on. +* **theta** (*float*) – angle theta +* **q\_controls** (*list(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits +* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit +* **q\_ancillae** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or tuple(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*, int)*) – The list of ancillary qubits. +* **mode** (*string*) – The implementation mode to use +* **use\_basis\_gates** (*bool*) – use p, u, cx + +**Raises** + +**QiskitError** – parameter errors + +### mcrz + + + +`QuantumCircuit.mcrz(lam, q_controls, q_target, use_basis_gates=False)` + +Apply Multiple-Controlled Z rotation gate + +**Parameters** + +* **self** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcrz gate on. +* **lam** (*float*) – angle lambda +* **q\_controls** (*list(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits +* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit +* **use\_basis\_gates** (*bool*) – use p, u, cx + +**Raises** + +**QiskitError** – parameter errors + +### mct + + + +`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"). + +### mcu1 + + + +`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`. + +### mcx + + + +`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"). + +The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are: - ‘noancilla’: Requires 0 ancilla qubits. - ‘recursion’: Requires 1 ancilla qubit if more than 4 controls are used, otherwise 0. - ‘v-chain’: Requires 2 less ancillas than the number of control qubits. - ‘v-chain-dirty’: Same as for the clean ancillas (but the circuit will be longer). + +### measure + + + +`QuantumCircuit.measure(qubit, cbit)` + +Measure quantum bit into classical bit (tuples). + +**Parameters** + +* **qubit** (*QuantumRegister|list|tuple*) – quantum register +* **cbit** (*ClassicalRegister|list|tuple*) – classical register + +**Returns** + +the attached measure instruction. + +**Return type** + +qiskit.Instruction + +**Raises** + +**CircuitError** – if qubit is not in this circuit or bad format; if cbit is not in this circuit or not creg. + +### measure\_active + + + +`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. + +Returns a new circuit with measurements if inplace=False. + +**Parameters** + +**inplace** (*bool*) – All measurements inplace or return new circuit. + +**Returns** + +Returns circuit with measurements when inplace = False. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### measure\_all + + + +`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. + +Returns a new circuit with measurements if inplace=False. + +**Parameters** + +**inplace** (*bool*) – All measurements inplace or return new circuit. + +**Returns** + +Returns circuit with measurements when inplace = False. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### ms + + + +`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"). + +### num\_connected\_components + + + +`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. + +**Parameters** + +**unitary\_only** (*bool*) – Compute only unitary part of graph. + +**Returns** + +Number of connected components in circuit. + +**Return type** + +int + +### num\_nonlocal\_gates + + + +`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). + +Conditional nonlocal gates are also included. + +### num\_tensor\_factors + + + +`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. + +#### Notes + +This is here for backwards compatibility, and will be removed in a future release of Qiskit. You should call num\_unitary\_factors instead. + +### num\_unitary\_factors + + + +`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. + +### p + + + +`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"). + +### pauli + + + +`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"). + +### power + + + +`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`. + +If `power` is a positive integer and `matrix_power` is `False`, this implementation defaults to calling `repeat`. Otherwise, if the circuit is unitary, the matrix is computed to calculate the matrix power. + +**Parameters** + +* **power** (*int*) – The power to raise this circuit to. +* **matrix\_power** (*bool*) – If True, the circuit is converted to a matrix and then the matrix power is computed. If False, and `power` is a positive integer, the implementation defaults to `repeat`. + +**Raises** + +**CircuitError** – If the circuit needs to be converted to a gate but it is not unitary. + +**Returns** + +A circuit implementing this circuit raised to the power of `power`. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### qasm + + + +`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. + +**Parameters** + +* **formatted** (*bool*) – Return formatted Qasm string. +* **filename** (*str*) – Save Qasm to file with name ‘filename’. +* **encoding** (*str*) – Optionally specify the encoding to use for the output file if `filename` is specified. By default this is set to the system’s default encoding (ie whatever `locale.getpreferredencoding()` returns) and can be set to any valid codec or alias from stdlib’s [codec module](https://docs.python.org/3/library/codecs.html#standard-encodings) + +**Returns** + +If formatted=False. + +**Return type** + +str + +**Raises** + +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If pygments is not installed and `formatted` is `True`. +* [**QasmError**](qiskit.qasm.QasmError "qiskit.qasm.QasmError") – If circuit has free parameters. + +### qbit\_argument\_conversion + + + +`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. + +**Parameters** + +**qubit\_representation** (*Object*) – representation to expand + +**Returns** + +Where each tuple is a qubit. + +**Return type** + +List(tuple) + +### qubit\_duration + + + +`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`. + +**Parameters** + +**\*qubits** – Qubits within `self` to include. + +**Return type** + +`float` + +**Returns** + +Return the duration between the first start and last stop time of non-delay instructions + +### qubit\_start\_time + + + +`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`. + +Return 0 if there are no instructions over qubits + +**Parameters** + +* **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating +* **of self.qubits.** (*indices*) – + +**Return type** + +`float` + +**Returns** + +Return the start time of the first instruction, excluding delays, over the qubits + +**Raises** + +**CircuitError** – if `self` is a not-yet scheduled circuit. + +### qubit\_stop\_time + + + +`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`. + +Return 0 if there are no instructions over qubits + +**Parameters** + +* **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating +* **of self.qubits.** (*indices*) – + +**Return type** + +`float` + +**Returns** + +Return the stop time of the last instruction, excluding delays, over the qubits + +**Raises** + +**CircuitError** – if `self` is a not-yet scheduled circuit. + +### r + + + +`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"). + +### rcccx + + + +`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"). + +### rccx + + + +`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"). + +### remove\_final\_measurements + + + +`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. + +Returns a new circuit without measurements if inplace=False. + +**Parameters** + +**inplace** (*bool*) – All measurements removed inplace or return new circuit. + +**Returns** + +Returns circuit with measurements removed when inplace = False. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### repeat + + + +`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. + +**Parameters** + +**reps** (*int*) – How often this circuit should be repeated. + +**Returns** + +A circuit containing `reps` repetitions of this circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### reset + + + +`QuantumCircuit.reset(qubit)` + +Reset q. + +### reverse\_bits + + + +`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. + +The circuit is “vertically” flipped. If a circuit is defined over multiple registers, the resulting circuit will have the same registers but with their order flipped. + +This method is useful for converting a circuit written in little-endian convention to the big-endian equivalent, and vice versa. + +**Returns** + +the circuit with reversed bit order. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +#### Examples + +#### input: + +┌───┐ + +#### q\_0: ┤ H ├─────■────── + +└───┘┌────┴─────┐ + +#### q\_1: ─────┤ RX(1.57) ├ + +└──────────┘ + +#### output: + +┌──────────┐ + +#### q\_0: ─────┤ RX(1.57) ├ + +┌───┐└────┬─────┘ + +#### q\_1: ┤ H ├─────■────── + +└───┘ + +### reverse\_ops + + + +`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. + +This is done by recursively reversing all instructions. It does not invert (adjoint) any gate. + +**Returns** + +the reversed circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +#### Examples + +#### input: + +┌───┐ + +#### q\_0: ┤ H ├─────■────── + +└───┘┌────┴─────┐ + +#### q\_1: ─────┤ RX(1.57) ├ + +└──────────┘ + +#### output: + +┌───┐ + +#### q\_0: ─────■──────┤ H ├ + +┌────┴─────┐└───┘ + +#### q\_1: ┤ RX(1.57) ├───── + +└──────────┘ + +### rv + + + +`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"). + +### rx + + + +`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"). + +### rxx + + + +`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"). + +### ry + + + +`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"). + +### ryy + + + +`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"). + +### rz + + + +`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"). + +### rzx + + + +`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"). + +### rzz + + + +`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"). + +### s + + + +`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"). + +### save\_amplitudes + + + +`QuantumCircuit.save_amplitudes(params, label='amplitudes', pershot=False, conditional=False)` + +Save complex statevector amplitudes. + +**Parameters** + +* **params** (*List\[int] or List\[str]*) – the basis states to return amplitudes for. +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of amplitudes vectors for each shot of the simulation rather than the a single amplitude vector \[Default: False]. +* **conditional** (*bool*) – if True save the amplitudes vector conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if params is invalid for the specified number of qubits. + +### save\_amplitudes\_squared + + + +`QuantumCircuit.save_amplitudes_squared(params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` + +Save squared statevector amplitudes (probabilities). + +**Parameters** + +* **params** (*List\[int] or List\[str]*) – the basis states to return amplitudes for. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated probabilities over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of probability vectors for each shot of the simulation rather than the a single amplitude vector \[Default: False]. +* **conditional** (*bool*) – if True save the probability vector conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if params is invalid for the specified number of qubits. + +### save\_density\_matrix + + + +`QuantumCircuit.save_density_matrix(qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` + +Save the current simulator quantum state as a density matrix. + +**Parameters** + +* **qubits** (*list or None*) – the qubits to save reduced density matrix on. If None the full density matrix of qubits will be saved \[Default: None]. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated density matrix over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of density matrices for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the average or pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_expectation\_value + + + +`QuantumCircuit.save_expectation_value(operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` + +Save the expectation value of a Hermitian operator. + +**Parameters** + +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **qubits** (*list*) – circuit qubits to apply instruction. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value over all shot \[Default: False]. +* **pershot** (*bool*) – if True save a list of expectation values for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the average or pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if the input operator is invalid or not Hermitian. + + + This method appends a `SaveExpectationValue` instruction to the quantum circuit. + + +### save\_expectation\_value\_variance + + + +`QuantumCircuit.save_expectation_value_variance(operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` + +Save the expectation value of a Hermitian operator. + +**Parameters** + +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **qubits** (*list*) – circuit qubits to apply instruction. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value and variance over all shot \[Default: False]. +* **pershot** (*bool*) – if True save a list of expectation values and variances for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if the input operator is invalid or not Hermitian. + + + This method appends a `SaveExpectationValueVariance` instruction to the quantum circuit. + + +### save\_matrix\_product\_state + + + +`QuantumCircuit.save_matrix_product_state(label='matrix_product_state', pershot=False, conditional=False)` + +Save the current simulator quantum state as a matrix product state. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save the mps for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_probabilities + + + +`QuantumCircuit.save_probabilities(qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` + +Save measurement outcome probabilities vector. + +**Parameters** + +* **qubits** (*list or None*) – the qubits to apply snapshot to. If None all qubits will be snapshot \[Default: None]. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated probabilities over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of probabilities for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the probabilities data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_probabilities\_dict + + + +`QuantumCircuit.save_probabilities_dict(qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` + +Save measurement outcome probabilities vector. + +**Parameters** + +* **qubits** (*list or None*) – the qubits to apply snapshot to. If None all qubits will be snapshot \[Default: None]. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated probabilities over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of probabilities for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the probabilities data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_stabilizer + + + +`QuantumCircuit.save_stabilizer(label='stabilizer', pershot=False, conditional=False)` + +Save the current stabilizer simulator quantum state as a Clifford. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of Cliffords for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_state + + + +`QuantumCircuit.save_state(label=None, pershot=False, conditional=False)` + +Save the current simulator quantum state. + +**Parameters** + +* **label** (*str or None*) – Optional, the key for retrieving saved data from results. If None the key will be the state type of the simulator. +* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_statevector + + + +`QuantumCircuit.save_statevector(label='statevector', pershot=False, conditional=False)` + +Save the current simulator quantum state as a statevector. + +**Parameters** + +* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation \[Default: False]. +* **label** (*str*) – the key for retrieving saved data from results. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_statevector\_dict + + + +`QuantumCircuit.save_statevector_dict(label='statevector', pershot=False, conditional=False)` + +Save the current simulator quantum state as a statevector as a dict. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_superop + + + +`QuantumCircuit.save_superop(label='superop', pershot=False)` + +Save the current state of the superop simulator. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of SuperOp matrices for each shot of the simulation \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_unitary + + + +`QuantumCircuit.save_unitary(label='unitary', pershot=False)` + +Save the current state of the unitary simulator. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of unitaries for each shot of the simulation \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### sdg + + + +`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"). + +### set\_density\_matrix + + + +`QuantumCircuit.set_density_matrix(state)` + +Set the density matrix state of the simulator. + +**Parameters** + +**state** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a density matrix. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the density matrix is the incorrect size for the current circuit. + +### set\_matrix\_product\_state + + + +`QuantumCircuit.set_matrix_product_state(state)` + +Set the matrix product state of the simulator. + +**Parameters** + +**state** (*Tuple\[List\[Tuple\[np.array\[complex\_t]]]], List\[List\[float]]*) – A matrix\_product\_state. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the structure of the state is incorrect + +### set\_stabilizer + + + +`QuantumCircuit.set_stabilizer(state)` + +Set the Clifford stabilizer state of the simulator. + +**Parameters** + +**state** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – A clifford operator. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the state is the incorrect size for the current circuit. + +### set\_statevector + + + +`QuantumCircuit.set_statevector(state)` + +Set the statevector state of the simulator. + +**Parameters** + +**state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – A state matrix. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the state is the incorrect size for the current circuit. + +### set\_superop + + + +`QuantumCircuit.set_superop(state)` + +Set the superop state of the simulator. + +**Parameters** + +**state** (*QuantumChannel*) – A CPTP quantum channel. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **ExtensionError** – If the state is the incorrect size for the current circuit. +* **ExtensionError** – if the input QuantumChannel is not CPTP. + +### set\_unitary + + + +`QuantumCircuit.set_unitary(state)` + +Set the state state of the simulator. + +**Parameters** + +**state** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – A state matrix. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **ExtensionError** – If the state is the incorrect size for the current circuit. +* **ExtensionError** – if the input matrix is not unitary. + +### size + + + +`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. + +**Returns** + +Total number of gate operations. + +**Return type** + +int + +### snapshot + + + +`QuantumCircuit.snapshot(label, snapshot_type='statevector', qubits=None, params=None)` + +Take a statevector snapshot of the internal simulator representation. Works on all qubits, and prevents reordering (like barrier). :param label: a snapshot label to report the result :type label: str :param snapshot\_type: the type of the snapshot. :type snapshot\_type: str :param qubits: the qubits to apply snapshot to \[Default: None]. :type qubits: list or None :param params: the parameters for snapshot\_type \[Default: None]. :type params: list or None + +**Returns** + +with attached command + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – malformed command + +### snapshot\_density\_matrix + + + +`QuantumCircuit.snapshot_density_matrix(label, qubits=None)` + +Take a density matrix snapshot of simulator state. + +**Parameters** + +* **label** (*str*) – a snapshot label to report the result +* **qubits** (*list or None*) – the qubits to apply snapshot to. If None all qubits will be snapshot \[Default: None]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_density_matrix`](qiskit.providers.aer.library.save_density_matrix "qiskit.providers.aer.library.save_density_matrix") circuit method. + + +### snapshot\_expectation\_value + + + +`QuantumCircuit.snapshot_expectation_value(label, op, qubits, single_shot=False, variance=False)` + +Take a snapshot of expectation value \ of an Operator. + +**Parameters** + +* **label** (*str*) – a snapshot label to report the result +* **op** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – operator to snapshot +* **qubits** (*list*) – the qubits to snapshot. +* **single\_shot** (*bool*) – return list for each shot rather than average \[Default: False] +* **variance** (*bool*) – compute variance of values \[Default: False] + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_expectation_value()`](qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value") and [`qiskit.providers.aer.library.save_expectation_value_variance()`](qiskit.providers.aer.library.save_expectation_value_variance "qiskit.providers.aer.library.save_expectation_value_variance") circuit methods. + + +### snapshot\_probabilities + + + +`QuantumCircuit.snapshot_probabilities(label, qubits, variance=False)` + +Take a probability snapshot of the simulator state. + +**Parameters** + +* **label** (*str*) – a snapshot label to report the result +* **qubits** (*list*) – the qubits to snapshot. +* **variance** (*bool*) – compute variance of probabilities \[Default: False] + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_probabilities()`](qiskit.providers.aer.library.save_probabilities "qiskit.providers.aer.library.save_probabilities") and [`qiskit.providers.aer.library.save_probabilities_dict()`](qiskit.providers.aer.library.save_probabilities_dict "qiskit.providers.aer.library.save_probabilities_dict") circuit methods. + + +### snapshot\_stabilizer + + + +`QuantumCircuit.snapshot_stabilizer(label)` + +Take a stabilizer snapshot of the simulator state. + +**Parameters** + +**label** (*str*) – a snapshot label to report the result. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + +#### Additional Information: + +This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_stabilizer()`](qiskit.providers.aer.library.save_stabilizer "qiskit.providers.aer.library.save_stabilizer") circuit method. + + +### snapshot\_statevector + + + +`QuantumCircuit.snapshot_statevector(label)` + +Take a statevector snapshot of the simulator state. + +**Parameters** + +**label** (*str*) – a snapshot label to report the result. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + +#### Additional Information: + +This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_statevector`](qiskit.providers.aer.library.save_statevector "qiskit.providers.aer.library.save_statevector") circuit method. + + +### squ + + + +`QuantumCircuit.squ(unitary_matrix, qubit, mode='ZYZ', up_to_diagonal=False, *, u=None)` + +Decompose an arbitrary 2\*2 unitary into three rotation gates. + +Note that the decomposition is up to a global phase shift. (This is a well known decomposition, which can be found for example in Nielsen and Chuang’s book “Quantum computation and quantum information”.) + +**Parameters** + +* **unitary\_matrix** (*ndarray*) – 2\*2 unitary (given as a (complex) ndarray). +* **qubit** (*QuantumRegister | Qubit*) – The qubit which the gate is acting on. +* **mode** (*string*) – determines the used decomposition by providing the rotation axes. The allowed modes are: “ZYZ” (default) +* **up\_to\_diagonal** (*bool*) – if set to True, the single-qubit unitary is decomposed up to a diagonal matrix, i.e. a unitary u’ is implemented such that there exists a 2\*2 diagonal gate d with u = d.dot(u’) +* **u** (*ndarray*) – Deprecated, use `unitary_matrix` instead. + +**Returns** + +The single-qubit unitary instruction attached to the circuit. + +**Return type** + +[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") + +**Raises** + +**QiskitError** – if the format is wrong; if the array u is not unitary + +### swap + + + +`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"). + +### sx + + + +`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"). + +### sxdg + + + +`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"). + +### t + + + +`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"). + +### tdg + + + +`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"). + +### tensor + + + +`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`. + +Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also \[the docs]\(qiskit.org/documentation/tutorials/circuits/3\_summary\_of\_quantum\_operations.html) for more information. + +```python + ┌────────┐ ┌─────┐ ┌─────┐ +q_0: ┤ bottom ├ ⊗ q_0: ┤ top ├ = q_0: ─┤ top ├── + └────────┘ └─────┘ ┌┴─────┴─┐ + q_1: ┤ bottom ├ + └────────┘ +``` + +**Parameters** + +* **other** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The other circuit to tensor this circuit with. +* **inplace** (*bool*) – If True, modify the object. Otherwise return composed circuit. + +#### Examples + +```python +from qiskit import QuantumCircuit +top = QuantumCircuit(1) +top.x(0); +bottom = QuantumCircuit(2) +bottom.cry(0.2, 0, 1); +tensored = bottom.tensor(top) +print(tensored.draw()) +``` + +```python + ┌───┐ +q_0: ───┤ X ├─── + └───┘ +q_1: ─────■───── + ┌────┴────┐ +q_2: ┤ Ry(0.2) ├ + └─────────┘ +``` + +**Returns** + +The tensored circuit (returns None if inplace==True). + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### to\_gate + + + +`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. + +**Parameters** + +* **parameter\_map** (*dict*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If None, existing circuit parameters will also parameterize the gate. +* **label** (*str*) – Optional gate label. + +**Returns** + +a composite gate encapsulating this circuit (can be decomposed back) + +**Return type** + +[Gate](qiskit.circuit.Gate "qiskit.circuit.Gate") + +### to\_instruction + + + +`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. + +**Parameters** + +* **parameter\_map** (*dict*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. +* **label** (*str*) – Optional gate label. + +**Returns** + +a composite instruction encapsulating this circuit (can be decomposed back) + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### toffoli + + + +`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"). + +### u + + + +`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"). + +### u1 + + + +`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"). + +### u2 + + + +`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"). + +### u3 + + + +`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"). + +### uc + + + +`QuantumCircuit.uc(gate_list, q_controls, q_target, up_to_diagonal=False)` + +Attach a uniformly controlled gates (also called multiplexed gates) to a circuit. + +The decomposition was introduced by Bergholm et al. in [https://arxiv.org/pdf/quant-ph/0410066.pdf](https://arxiv.org/pdf/quant-ph/0410066.pdf). + +**Parameters** + +* **gate\_list** (*list\[ndarray]*) – list of two qubit unitaries \[U\_0,…,U\_\{2^k-1}], where each single-qubit unitary U\_i is a given as a 2\*2 array +* **q\_controls** (*QuantumRegister|list\[(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,int)]*) – list of k control qubits. The qubits are ordered according to their significance in the computational basis. For example if q\_controls=\[q\[1],q\[2]] (with q = QuantumRegister(2)), the unitary U\_0 is performed if q\[1] and q\[2] are in the state zero, U\_1 is performed if q\[2] is in the state zero and q\[1] is in the state one, and so on +* **q\_target** (*QuantumRegister|(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,int)*) – target qubit, where we act on with the single-qubit gates. +* **up\_to\_diagonal** (*bool*) – If set to True, the uniformly controlled gate is decomposed up to a diagonal gate, i.e. a unitary u’ is implemented such that there exists a diagonal gate d with u = d.dot(u’), where the unitary u describes the uniformly controlled gate + +**Returns** + +the uniformly controlled gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### ucrx + + + +`QuantumCircuit.ucrx(angle_list, q_controls, q_target)` + +Attach a uniformly controlled (also called multiplexed) Rx rotation gate to a circuit. + +The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al. + +**Parameters** + +* **angle\_list** (*list*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$ +* **q\_controls** (*QuantumRegister|list*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if `q_controls=[q[0],q[1]]` (with `q = QuantumRegister(2)`), the rotation `Rx(a_0)` is performed if `q[0]` and `q[1]` are in the state zero, the rotation `Rx(a_1)` is performed if `q[0]` is in the state one and `q[1]` is in the state zero, and so on +* **q\_target** (*QuantumRegister|Qubit*) – target qubit, where we act on with the single-qubit rotation gates + +**Returns** + +the uniformly controlled rotation gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### ucry + + + +`QuantumCircuit.ucry(angle_list, q_controls, q_target)` + +Attach a uniformly controlled (also called multiplexed) Ry rotation gate to a circuit. + +The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al. + +**Parameters** + +* **angle\_list** (*list\[numbers*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$ +* **q\_controls** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if `q_controls=[q[0],q[1]]` (with `q = QuantumRegister(2)`), the rotation `Ry(a_0)` is performed if `q[0]` and `q[1]` are in the state zero, the rotation `Ry(a_1)` is performed if `q[0]` is in the state one and `q[1]` is in the state zero, and so on +* **q\_target** (*QuantumRegister|Qubit*) – target qubit, where we act on with the single-qubit rotation gates + +**Returns** + +the uniformly controlled rotation gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### ucrz + + + +`QuantumCircuit.ucrz(angle_list, q_controls, q_target)` + +Attach a uniformly controlled (also called multiplexed gates) Rz rotation gate to a circuit. + +The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al. + +**Parameters** + +* **angle\_list** (*list\[numbers*) – list of (real) rotation angles \[a\_0,…,a\_\{2^k-1}] +* **q\_controls** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if q\_controls=\[q\[1],q\[2]] (with q = QuantumRegister(2)), the rotation Rz(a\_0)is performed if q\[1] and q\[2] are in the state zero, the rotation Rz(a\_1) is performed if q\[1] is in the state one and q\[2] is in the state zero, and so on +* **q\_target** (*QuantumRegister|Qubit*) – target qubit, where we act on with the single-qubit rotation gates + +**Returns** + +the uniformly controlled rotation gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### unitary + + + +`QuantumCircuit.unitary(obj, qubits, label=None)` + +Apply unitary gate to q. + +### width + + + +`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. + +**Returns** + +Width of circuit. + +**Return type** + +int + +### x + + + +`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"). + +### y + + + +`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"). + +### z + + + +`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"). + +## Attributes + + + +### ancillas + +Returns a list of ancilla bits in the order that the registers were added. + + + +### calibrations + +Return calibration dictionary. + +**The custom pulse definition of a given gate is of the form** + +\{‘gate\_name’: \{(qubits, params): schedule}} + + + +### clbits + +Returns a list of classical bits in the order that the registers were added. + + + +### data + +Return the circuit data (instructions and context). + +**Returns** + +a list-like object containing the tuples for the circuit’s data. + +Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects. + +**Return type** + +QuantumCircuitData + + + +### extension\_lib + +`= 'include "qelib1.inc";'` + + + +### global\_phase + +Return the global phase of the circuit in radians. + + + +### header + +`= 'OPENQASM 2.0;'` + + + +### instances + +`= 16` + + + +### metadata + +The user provided metadata associated with the circuit + +The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. + + + +### num\_ancillas + +Return the number of ancilla qubits. + + + +### num\_clbits + +Return number of classical bits. + + + +### num\_parameters + +Convenience function to get the number of parameter objects in the circuit. + + + +### num\_qubits + +Return number of qubits. + + + +### parameters + +Convenience function to get the parameters defined in the parameter table. + + + +### prefix + +`= 'circuit'` + + + +### qubits + +Returns a list of quantum bits in the order that the registers were added. -Returns a list of quantum bits in the order that the registers were added. diff --git a/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md b/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md index 9890b1731b2..631b64d0b63 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.QuantumRegister.md @@ -1,8 +1,16 @@ -# QuantumRegister +--- +title: QuantumRegister +description: API reference for qiskit.circuit.QuantumRegister +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.QuantumRegister +--- +# QuantumRegister + -`QuantumRegister(size=None, name=None, bits=None)` +`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` @@ -27,38 +35,43 @@ Either the `size` or the `bits` argument must be provided. If `size` is not None ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`qasm`](qiskit.circuit.QuantumRegister.qasm#qiskit.circuit.QuantumRegister.qasm "qiskit.circuit.QuantumRegister.qasm") | Return OPENQASM string for this register. | +### qasm -## Attributes + +`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. + +## Attributes + ### instances\_counter `= count(0)` - + ### name Get the register name. - + ### name\_format `= re.compile('[a-z][a-zA-Z0-9_]*')` - + ### prefix `= 'q'` - + ### size Get the register size. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md b/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md index 06382fa45fb..fd6ea387a2e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Qubit.md @@ -1,8 +1,16 @@ -# Qubit +--- +title: Qubit +description: API reference for qiskit.circuit.Qubit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Qubit +--- +# Qubit + -`Qubit(register=None, index=None)` +`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` @@ -12,23 +20,24 @@ Creates a qubit. **Parameters** -* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – Optional. A quantum register containing the bit. +* **register** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – Optional. A quantum register containing the bit. * **index** (*int*) – Optional. The index of the bit in its containing register. **Raises** -**CircuitError** – if the provided register is not a valid [`QuantumRegister`](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") +**CircuitError** – if the provided register is not a valid [`QuantumRegister`](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") ## Attributes - + ### index Get bit’s index. - + ### register Get bit’s register. + diff --git a/docs/api/qiskit/0.32/qiskit.circuit.Reset.md b/docs/api/qiskit/0.32/qiskit.circuit.Reset.md index c8b826d92d5..db36821fa59 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.Reset.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.Reset.md @@ -1,8 +1,16 @@ -# Reset +--- +title: Reset +description: API reference for qiskit.circuit.Reset +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.Reset +--- +# Reset + -`Reset` +`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -12,43 +20,226 @@ Create new reset instruction. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.circuit.Reset.add_decomposition#qiskit.circuit.Reset.add_decomposition "qiskit.circuit.Reset.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.Reset.assemble#qiskit.circuit.Reset.assemble "qiskit.circuit.Reset.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.Reset.broadcast_arguments#qiskit.circuit.Reset.broadcast_arguments "qiskit.circuit.Reset.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.circuit.Reset.c_if#qiskit.circuit.Reset.c_if "qiskit.circuit.Reset.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.circuit.Reset.copy#qiskit.circuit.Reset.copy "qiskit.circuit.Reset.copy") | Copy of the instruction. | -| [`inverse`](qiskit.circuit.Reset.inverse#qiskit.circuit.Reset.inverse "qiskit.circuit.Reset.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.circuit.Reset.is_parameterized#qiskit.circuit.Reset.is_parameterized "qiskit.circuit.Reset.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.Reset.mirror#qiskit.circuit.Reset.mirror "qiskit.circuit.Reset.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.circuit.Reset.qasm#qiskit.circuit.Reset.qasm "qiskit.circuit.Reset.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.Reset.repeat#qiskit.circuit.Reset.repeat "qiskit.circuit.Reset.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.Reset.reverse_ops#qiskit.circuit.Reset.reverse_ops "qiskit.circuit.Reset.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.circuit.Reset.soft_compare#qiskit.circuit.Reset.soft_compare "qiskit.circuit.Reset.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.circuit.Reset.validate_parameter#qiskit.circuit.Reset.validate_parameter "qiskit.circuit.Reset.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`Reset.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`Reset.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`Reset.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`Reset.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`Reset.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`Reset.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`Reset.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** +**a new instruction with sub-instructions** +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`Reset.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`Reset.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`Reset.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`Reset.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`Reset.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -58,14 +249,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 c8af5af0cdc..5575c46c0c3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.BooleanExpression.md @@ -1,8 +1,16 @@ -# BooleanExpression +--- +title: BooleanExpression +description: API reference for qiskit.circuit.classicalfunction.BooleanExpression +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.classicalfunction.BooleanExpression +--- +# BooleanExpression + -`BooleanExpression(expression, name=None)` +`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` @@ -15,49 +23,393 @@ The Boolean Expression gate. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add_decomposition`](qiskit.circuit.classicalfunction.BooleanExpression.add_decomposition#qiskit.circuit.classicalfunction.BooleanExpression.add_decomposition "qiskit.circuit.classicalfunction.BooleanExpression.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.classicalfunction.BooleanExpression.assemble#qiskit.circuit.classicalfunction.BooleanExpression.assemble "qiskit.circuit.classicalfunction.BooleanExpression.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.classicalfunction.BooleanExpression.broadcast_arguments#qiskit.circuit.classicalfunction.BooleanExpression.broadcast_arguments "qiskit.circuit.classicalfunction.BooleanExpression.broadcast_arguments") | Validation and handling of the arguments and its relationship. | -| [`c_if`](qiskit.circuit.classicalfunction.BooleanExpression.c_if#qiskit.circuit.classicalfunction.BooleanExpression.c_if "qiskit.circuit.classicalfunction.BooleanExpression.c_if") | Add classical condition on register or cbit classical and value val. | -| [`control`](qiskit.circuit.classicalfunction.BooleanExpression.control#qiskit.circuit.classicalfunction.BooleanExpression.control "qiskit.circuit.classicalfunction.BooleanExpression.control") | Return controlled version of gate. | -| [`copy`](qiskit.circuit.classicalfunction.BooleanExpression.copy#qiskit.circuit.classicalfunction.BooleanExpression.copy "qiskit.circuit.classicalfunction.BooleanExpression.copy") | Copy of the instruction. | -| [`from_dimacs_file`](qiskit.circuit.classicalfunction.BooleanExpression.from_dimacs_file#qiskit.circuit.classicalfunction.BooleanExpression.from_dimacs_file "qiskit.circuit.classicalfunction.BooleanExpression.from_dimacs_file") | Create a BooleanExpression from the string in the DIMACS format. | -| [`inverse`](qiskit.circuit.classicalfunction.BooleanExpression.inverse#qiskit.circuit.classicalfunction.BooleanExpression.inverse "qiskit.circuit.classicalfunction.BooleanExpression.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.circuit.classicalfunction.BooleanExpression.is_parameterized#qiskit.circuit.classicalfunction.BooleanExpression.is_parameterized "qiskit.circuit.classicalfunction.BooleanExpression.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.classicalfunction.BooleanExpression.mirror#qiskit.circuit.classicalfunction.BooleanExpression.mirror "qiskit.circuit.classicalfunction.BooleanExpression.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`power`](qiskit.circuit.classicalfunction.BooleanExpression.power#qiskit.circuit.classicalfunction.BooleanExpression.power "qiskit.circuit.classicalfunction.BooleanExpression.power") | Creates a unitary gate as gate^exponent. | -| [`qasm`](qiskit.circuit.classicalfunction.BooleanExpression.qasm#qiskit.circuit.classicalfunction.BooleanExpression.qasm "qiskit.circuit.classicalfunction.BooleanExpression.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.classicalfunction.BooleanExpression.repeat#qiskit.circuit.classicalfunction.BooleanExpression.repeat "qiskit.circuit.classicalfunction.BooleanExpression.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.classicalfunction.BooleanExpression.reverse_ops#qiskit.circuit.classicalfunction.BooleanExpression.reverse_ops "qiskit.circuit.classicalfunction.BooleanExpression.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`simulate`](qiskit.circuit.classicalfunction.BooleanExpression.simulate#qiskit.circuit.classicalfunction.BooleanExpression.simulate "qiskit.circuit.classicalfunction.BooleanExpression.simulate") | Evaluate the expression on a bitstring. | -| [`soft_compare`](qiskit.circuit.classicalfunction.BooleanExpression.soft_compare#qiskit.circuit.classicalfunction.BooleanExpression.soft_compare "qiskit.circuit.classicalfunction.BooleanExpression.soft_compare") | Soft comparison between gates. | -| [`synth`](qiskit.circuit.classicalfunction.BooleanExpression.synth#qiskit.circuit.classicalfunction.BooleanExpression.synth "qiskit.circuit.classicalfunction.BooleanExpression.synth") | Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). | -| [`to_matrix`](qiskit.circuit.classicalfunction.BooleanExpression.to_matrix#qiskit.circuit.classicalfunction.BooleanExpression.to_matrix "qiskit.circuit.classicalfunction.BooleanExpression.to_matrix") | Return a Numpy.array for the gate unitary matrix. | -| [`validate_parameter`](qiskit.circuit.classicalfunction.BooleanExpression.validate_parameter#qiskit.circuit.classicalfunction.BooleanExpression.validate_parameter "qiskit.circuit.classicalfunction.BooleanExpression.validate_parameter") | Gate parameters should be int, float, or ParameterExpression | +### add\_decomposition -## Attributes + + +`BooleanExpression.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`BooleanExpression.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`BooleanExpression.broadcast_arguments(qargs, cargs)` + +Validation and handling of the arguments and its relationship. + +For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: + +```python +in: [[q[0],q[1]], q[2]],[] +outs: [q[0], q[2]], [] + [q[1], q[2]], [] +``` + +The general broadcasting rules are: + +> * If len(qargs) == 1: +> +> ```python +> [q[0], q[1]] -> [q[0]],[q[1]] +> ``` +> +> * If len(qargs) == 2: +> +> ```python +> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]] +> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]] +> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]] +> ``` +> +> * If len(qargs) >= 3: +> +> ```python +> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...] +> ``` + +**Parameters** + +* **qargs** (`List`) – List of quantum bit arguments. +* **cargs** (`List`) – List of classical bit arguments. + +**Return type** + +`Tuple`\[`List`, `List`] + +**Returns** + +A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`BooleanExpression.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### control + + + +`BooleanExpression.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` + +Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. + +**Parameters** + +* **num\_ctrl\_qubits** (`Optional`\[`int`]) – number of controls to add to gate (default=1) +* **label** (`Optional`\[`str`]) – optional gate label +* **ctrl\_state** (`Union`\[`int`, `str`, `None`]) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use 2\*\*num\_ctrl\_qubits-1. + +**Returns** + +Controlled version of gate. This default algorithm uses num\_ctrl\_qubits-1 ancillae qubits so returns a gate of size num\_qubits + 2\*num\_ctrl\_qubits - 1. + +**Return type** + +[qiskit.circuit.ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +**Raises** + +**QiskitError** – unrecognized mode or invalid ctrl\_state + +### copy + + + +`BooleanExpression.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### from\_dimacs\_file + + + +`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. + +**Returns** + +A gate for the input string + +**Return type** + +[BooleanExpression](qiskit.circuit.classicalfunction.BooleanExpression "qiskit.circuit.classicalfunction.BooleanExpression") + +**Raises** + +**FileNotFoundError** – If filename is not found. + +### inverse + + + +`BooleanExpression.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) +**Returns** +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`BooleanExpression.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`BooleanExpression.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### power + + + +`BooleanExpression.power(exponent)` + +Creates a unitary gate as gate^exponent. + +**Parameters** + +**exponent** (*float*) – Gate^exponent + +**Returns** + +To which to\_matrix is self.to\_matrix^exponent. + +**Return type** + +[qiskit.extensions.UnitaryGate](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") + +**Raises** + +**CircuitError** – If Gate is not unitary + +### qasm + + + +`BooleanExpression.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`BooleanExpression.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`BooleanExpression.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### simulate + + + +`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. + +This evaluation is done classically. + +**Parameters** + +**bitstring** (`str`) – The bitstring for which to evaluate. + +**Returns** + +result of the evaluation. + +**Return type** + +bool + +### soft\_compare + + + +`BooleanExpression.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### synth + + + +`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"). + +**Parameters** + +* **registerless** (`bool`) – Default `True`. If `False` uses the parameter names to create registers with those names. Otherwise, creates a circuit with a flat quantum register. +* **synthesizer** (`Optional`\[`Callable`\[\[`BooleanExpression`], `QuantumCircuit`]]) – A callable that takes self and returns a Tweedledum circuit. + +**Returns** + +A circuit implementing the logic network. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### to\_matrix + + + +`BooleanExpression.to_matrix()` + +Return a Numpy.array for the gate unitary matrix. + +**Returns** + +if the Gate subclass has a matrix definition. + +**Return type** + +np.ndarray + +**Raises** + +**CircuitError** – If a Gate subclass does not implement this method an exception will be raised when this base class method is called. + +### validate\_parameter + + + +`BooleanExpression.validate_parameter(parameter)` + +Gate parameters should be int, float, or ParameterExpression + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -67,14 +419,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 e07e84a658c..ae94f80d436 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunction.md @@ -1,8 +1,16 @@ -# ClassicalFunction +--- +title: ClassicalFunction +description: API reference for qiskit.circuit.classicalfunction.ClassicalFunction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction +--- +# ClassicalFunction + -`ClassicalFunction(source, name=None)` +`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` @@ -23,56 +31,405 @@ The code should be a single function with types. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add_decomposition`](qiskit.circuit.classicalfunction.ClassicalFunction.add_decomposition#qiskit.circuit.classicalfunction.ClassicalFunction.add_decomposition "qiskit.circuit.classicalfunction.ClassicalFunction.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.circuit.classicalfunction.ClassicalFunction.assemble#qiskit.circuit.classicalfunction.ClassicalFunction.assemble "qiskit.circuit.classicalfunction.ClassicalFunction.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.circuit.classicalfunction.ClassicalFunction.broadcast_arguments#qiskit.circuit.classicalfunction.ClassicalFunction.broadcast_arguments "qiskit.circuit.classicalfunction.ClassicalFunction.broadcast_arguments") | Validation and handling of the arguments and its relationship. | -| [`c_if`](qiskit.circuit.classicalfunction.ClassicalFunction.c_if#qiskit.circuit.classicalfunction.ClassicalFunction.c_if "qiskit.circuit.classicalfunction.ClassicalFunction.c_if") | Add classical condition on register or cbit classical and value val. | -| [`compile`](qiskit.circuit.classicalfunction.ClassicalFunction.compile#qiskit.circuit.classicalfunction.ClassicalFunction.compile "qiskit.circuit.classicalfunction.ClassicalFunction.compile") | Parses and creates the logical circuit | -| [`control`](qiskit.circuit.classicalfunction.ClassicalFunction.control#qiskit.circuit.classicalfunction.ClassicalFunction.control "qiskit.circuit.classicalfunction.ClassicalFunction.control") | Return controlled version of gate. | -| [`copy`](qiskit.circuit.classicalfunction.ClassicalFunction.copy#qiskit.circuit.classicalfunction.ClassicalFunction.copy "qiskit.circuit.classicalfunction.ClassicalFunction.copy") | Copy of the instruction. | -| [`inverse`](qiskit.circuit.classicalfunction.ClassicalFunction.inverse#qiskit.circuit.classicalfunction.ClassicalFunction.inverse "qiskit.circuit.classicalfunction.ClassicalFunction.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.circuit.classicalfunction.ClassicalFunction.is_parameterized#qiskit.circuit.classicalfunction.ClassicalFunction.is_parameterized "qiskit.circuit.classicalfunction.ClassicalFunction.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.circuit.classicalfunction.ClassicalFunction.mirror#qiskit.circuit.classicalfunction.ClassicalFunction.mirror "qiskit.circuit.classicalfunction.ClassicalFunction.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`power`](qiskit.circuit.classicalfunction.ClassicalFunction.power#qiskit.circuit.classicalfunction.ClassicalFunction.power "qiskit.circuit.classicalfunction.ClassicalFunction.power") | Creates a unitary gate as gate^exponent. | -| [`qasm`](qiskit.circuit.classicalfunction.ClassicalFunction.qasm#qiskit.circuit.classicalfunction.ClassicalFunction.qasm "qiskit.circuit.classicalfunction.ClassicalFunction.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.circuit.classicalfunction.ClassicalFunction.repeat#qiskit.circuit.classicalfunction.ClassicalFunction.repeat "qiskit.circuit.classicalfunction.ClassicalFunction.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.circuit.classicalfunction.ClassicalFunction.reverse_ops#qiskit.circuit.classicalfunction.ClassicalFunction.reverse_ops "qiskit.circuit.classicalfunction.ClassicalFunction.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`simulate`](qiskit.circuit.classicalfunction.ClassicalFunction.simulate#qiskit.circuit.classicalfunction.ClassicalFunction.simulate "qiskit.circuit.classicalfunction.ClassicalFunction.simulate") | Evaluate the expression on a bitstring. | -| [`simulate_all`](qiskit.circuit.classicalfunction.ClassicalFunction.simulate_all#qiskit.circuit.classicalfunction.ClassicalFunction.simulate_all "qiskit.circuit.classicalfunction.ClassicalFunction.simulate_all") | Returns a truth table. | -| [`soft_compare`](qiskit.circuit.classicalfunction.ClassicalFunction.soft_compare#qiskit.circuit.classicalfunction.ClassicalFunction.soft_compare "qiskit.circuit.classicalfunction.ClassicalFunction.soft_compare") | Soft comparison between gates. | -| [`synth`](qiskit.circuit.classicalfunction.ClassicalFunction.synth#qiskit.circuit.classicalfunction.ClassicalFunction.synth "qiskit.circuit.classicalfunction.ClassicalFunction.synth") | Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"). | -| [`to_matrix`](qiskit.circuit.classicalfunction.ClassicalFunction.to_matrix#qiskit.circuit.classicalfunction.ClassicalFunction.to_matrix "qiskit.circuit.classicalfunction.ClassicalFunction.to_matrix") | Return a Numpy.array for the gate unitary matrix. | -| [`validate_parameter`](qiskit.circuit.classicalfunction.ClassicalFunction.validate_parameter#qiskit.circuit.classicalfunction.ClassicalFunction.validate_parameter "qiskit.circuit.classicalfunction.ClassicalFunction.validate_parameter") | Gate parameters should be int, float, or ParameterExpression | +### add\_decomposition -## Attributes + + +`ClassicalFunction.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`ClassicalFunction.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`ClassicalFunction.broadcast_arguments(qargs, cargs)` + +Validation and handling of the arguments and its relationship. + +For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: + +```python +in: [[q[0],q[1]], q[2]],[] +outs: [q[0], q[2]], [] + [q[1], q[2]], [] +``` + +The general broadcasting rules are: + +> * If len(qargs) == 1: +> +> ```python +> [q[0], q[1]] -> [q[0]],[q[1]] +> ``` +> +> * If len(qargs) == 2: +> +> ```python +> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]] +> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]] +> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]] +> ``` +> +> * If len(qargs) >= 3: +> +> ```python +> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...] +> ``` + +**Parameters** + +* **qargs** (`List`) – List of quantum bit arguments. +* **cargs** (`List`) – List of classical bit arguments. + +**Return type** + +`Tuple`\[`List`, `List`] + +**Returns** + +A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`ClassicalFunction.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### compile + + + +`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 + +### control + + + +`ClassicalFunction.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` + +Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. + +**Parameters** + +* **num\_ctrl\_qubits** (`Optional`\[`int`]) – number of controls to add to gate (default=1) +* **label** (`Optional`\[`str`]) – optional gate label +* **ctrl\_state** (`Union`\[`int`, `str`, `None`]) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use 2\*\*num\_ctrl\_qubits-1. + +**Returns** + +Controlled version of gate. This default algorithm uses num\_ctrl\_qubits-1 ancillae qubits so returns a gate of size num\_qubits + 2\*num\_ctrl\_qubits - 1. + +**Return type** + +[qiskit.circuit.ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +**Raises** + +**QiskitError** – unrecognized mode or invalid ctrl\_state + +### copy + + + +`ClassicalFunction.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`ClassicalFunction.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`ClassicalFunction.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`ClassicalFunction.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### power + + + +`ClassicalFunction.power(exponent)` + +Creates a unitary gate as gate^exponent. + +**Parameters** + +**exponent** (*float*) – Gate^exponent + +**Returns** + +To which to\_matrix is self.to\_matrix^exponent. + +**Return type** + +[qiskit.extensions.UnitaryGate](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") + +**Raises** + +**CircuitError** – If Gate is not unitary +### qasm + + +`ClassicalFunction.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`ClassicalFunction.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`ClassicalFunction.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### simulate + + + +`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. + +This evaluation is done classically. + +**Parameters** + +**bitstring** (`str`) – The bitstring for which to evaluate. + +**Returns** + +result of the evaluation. + +**Return type** + +bool + +### simulate\_all + + + +`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. + +**Returns** + +a bitstring with a truth table + +**Return type** + +str + +### soft\_compare + + + +`ClassicalFunction.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### synth + + + +`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"). + +**Parameters** + +* **registerless** (`bool`) – Default `True`. If `False` uses the parameter names to create +* **with those names. Otherwise** (*registers*) – +* **a circuit with a flat quantum register.** (*creates*) – +* **synthesizer** (`Optional`\[`Callable`\[\[`ClassicalElement`], `QuantumCircuit`]]) – Optional. If None tweedledum’s pkrm\_synth is used. + +**Returns** + +A circuit implementing the logic network. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### to\_matrix + + + +`ClassicalFunction.to_matrix()` + +Return a Numpy.array for the gate unitary matrix. + +**Returns** + +if the Gate subclass has a matrix definition. + +**Return type** + +np.ndarray + +**Raises** + +**CircuitError** – If a Gate subclass does not implement this method an exception will be raised when this base class method is called. + +### validate\_parameter + + + +`ClassicalFunction.validate_parameter(parameter)` + +Gate parameters should be int, float, or ParameterExpression + +## Attributes + + ### args Returns the classicalfunction arguments - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -82,37 +439,37 @@ Return instruction label `str` - + ### network Returns the logical network - + ### params return instruction params. - + ### qregs The list of qregs used by the classicalfunction - + ### scopes Returns the scope dict - + ### truth\_table Returns (and computes) the truth table - + ### types @@ -126,8 +483,9 @@ A list of scopes as dicts, where key is the variable name and value is its type. list(dict) - + ### unit Get the time unit of duration. + 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 3f293f30507..85a2a4729a6 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError.md @@ -1,9 +1,18 @@ -# qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError +--- +title: ClassicalFunctionCompilerTypeError +description: API reference for qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError +--- +# qiskit.circuit.classicalfunction.ClassicalFunctionCompilerTypeError + -`ClassicalFunctionCompilerTypeError(*message)` +`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. Set the error message. + 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 ae8890d3e14..c691288c43f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.classicalfunction.ClassicalFunctionParseError.md @@ -1,9 +1,18 @@ -# qiskit.circuit.classicalfunction.ClassicalFunctionParseError +--- +title: ClassicalFunctionParseError +description: API reference for qiskit.circuit.classicalfunction.ClassicalFunctionParseError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.circuit.classicalfunction.ClassicalFunctionParseError +--- +# qiskit.circuit.classicalfunction.ClassicalFunctionParseError + -`ClassicalFunctionParseError(*message)` +`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. Set the error message. + 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 2fa3416620d..648a2389ca2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.AND.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.AND.md @@ -1,8 +1,16 @@ -# AND +--- +title: AND +description: API reference for qiskit.circuit.library.AND +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.AND +--- +# AND + -`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')` +`AND(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_and.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -24,13 +32,13 @@ Create a new logical AND circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -40,13 +48,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -62,31 +70,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -94,44 +102,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 1c9f5e05e4e..4a06432d594 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Barrier.md @@ -1,8 +1,16 @@ -# Barrier +--- +title: Barrier +description: API reference for qiskit.circuit.library.Barrier +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.Barrier +--- +# Barrier + -`Barrier(num_qubits)` +`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` @@ -12,33 +20,64 @@ Create new barrier instruction. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`broadcast_arguments`](qiskit.circuit.library.Barrier.broadcast_arguments#qiskit.circuit.library.Barrier.broadcast_arguments "qiskit.circuit.library.Barrier.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.circuit.library.Barrier.c_if#qiskit.circuit.library.Barrier.c_if "qiskit.circuit.library.Barrier.c_if") | Add classical condition on register or cbit classical and value val. | -| [`inverse`](qiskit.circuit.library.Barrier.inverse#qiskit.circuit.library.Barrier.inverse "qiskit.circuit.library.Barrier.inverse") | Special case. | +### broadcast\_arguments -## Attributes + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + +`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. + +### inverse + + + +`Barrier.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/barrier.py "view source code") + +Special case. Return self. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -48,14 +87,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 27e682b1ec0..9e3d5d25d7c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C3SXGate.md @@ -1,8 +1,16 @@ -# C3SXGate +--- +title: C3SXGate +description: API reference for qiskit.circuit.library.C3SXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.C3SXGate +--- +# C3SXGate + -`C3SXGate(label=None, ctrl_state=None, *, angle=None)` +`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` @@ -24,13 +32,17 @@ Create a new 3-qubit controlled sqrt-X gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -| [`inverse`](qiskit.circuit.library.C3SXGate.inverse#qiskit.circuit.library.C3SXGate.inverse "qiskit.circuit.library.C3SXGate.inverse") | Invert this gate. | +### inverse -## Attributes + + +`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. +## Attributes + + ### ctrl\_state @@ -40,13 +52,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -56,13 +68,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -72,7 +84,7 @@ Return instruction label `str` - + ### name @@ -86,7 +98,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -100,7 +112,7 @@ The number of control qubits for the gate. int - + ### params @@ -118,8 +130,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 354055e716f..4f5eb579f84 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C3XGate.md @@ -1,8 +1,16 @@ -# C3XGate +--- +title: C3XGate +description: API reference for qiskit.circuit.library.C3XGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.C3XGate +--- +# C3XGate + -`C3XGate(angle=None, label=None, ctrl_state=None)` +`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` @@ -14,14 +22,39 @@ Create a new 3-qubit controlled X gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`control`](qiskit.circuit.library.C3XGate.control#qiskit.circuit.library.C3XGate.control "qiskit.circuit.library.C3XGate.control") | Controlled version of this gate. | -| [`inverse`](qiskit.circuit.library.C3XGate.inverse#qiskit.circuit.library.C3XGate.inverse "qiskit.circuit.library.C3XGate.inverse") | Invert this gate. | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### inverse + +`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. + +## Attributes + + ### ctrl\_state @@ -31,13 +64,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -47,13 +80,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -63,7 +96,7 @@ Return instruction label `str` - + ### name @@ -77,7 +110,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -91,7 +124,7 @@ The number of control qubits for the gate. int - + ### params @@ -109,8 +142,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 e48f9839f3e..0270ba63699 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.C4XGate.md @@ -1,8 +1,16 @@ -# C4XGate +--- +title: C4XGate +description: API reference for qiskit.circuit.library.C4XGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.C4XGate +--- +# C4XGate + -`C4XGate(label=None, ctrl_state=None)` +`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` @@ -18,14 +26,39 @@ Create a new 4-qubit controlled X gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`control`](qiskit.circuit.library.C4XGate.control#qiskit.circuit.library.C4XGate.control "qiskit.circuit.library.C4XGate.control") | Controlled version of this gate. | -| [`inverse`](qiskit.circuit.library.C4XGate.inverse#qiskit.circuit.library.C4XGate.inverse "qiskit.circuit.library.C4XGate.inverse") | Invert this gate. | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### inverse + +`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. + +## Attributes + + ### ctrl\_state @@ -35,13 +68,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -51,13 +84,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -67,7 +100,7 @@ Return instruction label `str` - + ### name @@ -81,7 +114,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -95,7 +128,7 @@ The number of control qubits for the gate. int - + ### params @@ -113,8 +146,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 9d65cf78a4a..f9854e01b74 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CCXGate.md @@ -1,8 +1,16 @@ -# CCXGate +--- +title: CCXGate +description: API reference for qiskit.circuit.library.CCXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CCXGate +--- +# CCXGate + -`CCXGate(label=None, ctrl_state=None)` +`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` @@ -68,14 +76,39 @@ Create new CCX gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`control`](qiskit.circuit.library.CCXGate.control#qiskit.circuit.library.CCXGate.control "qiskit.circuit.library.CCXGate.control") | Controlled version of this gate. | -| [`inverse`](qiskit.circuit.library.CCXGate.inverse#qiskit.circuit.library.CCXGate.inverse "qiskit.circuit.library.CCXGate.inverse") | Return an inverted CCX gate (also a CCX). | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### inverse + +`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). + +## Attributes + + ### ctrl\_state @@ -85,13 +118,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -101,13 +134,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -117,7 +150,7 @@ Return instruction label `str` - + ### name @@ -131,7 +164,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -145,7 +178,7 @@ The number of control qubits for the gate. int - + ### params @@ -163,8 +196,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 36c70e62131..ea639de97f0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CDKMRippleCarryAdder.md @@ -1,8 +1,16 @@ -# CDKMRippleCarryAdder +--- +title: CDKMRippleCarryAdder +description: API reference for qiskit.circuit.library.CDKMRippleCarryAdder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CDKMRippleCarryAdder +--- +# CDKMRippleCarryAdder + -`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')` +`CDKMRippleCarryAdder(num_state_qubits, kind='full', name='CDKMRippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/cdkm_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` @@ -74,13 +82,13 @@ It has one less qubit than the full-adder since it doesn’t have the carry-out, ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -90,13 +98,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -112,31 +120,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -144,31 +152,31 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -182,20 +190,21 @@ The number of state qubits, i.e. the number of bits in each input register. The number of state qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 832c7152e1e..db9ad0a42b4 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CHGate.md @@ -1,8 +1,16 @@ -# CHGate +--- +title: CHGate +description: API reference for qiskit.circuit.library.CHGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CHGate +--- +# CHGate + -`CHGate(label=None, ctrl_state=None)` +`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` @@ -58,13 +66,17 @@ Create new CH gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`inverse`](qiskit.circuit.library.CHGate.inverse#qiskit.circuit.library.CHGate.inverse "qiskit.circuit.library.CHGate.inverse") | Return inverted CH gate (itself). | +### inverse -## Attributes + + +`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). +## Attributes + + ### ctrl\_state @@ -74,13 +86,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -90,13 +102,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -106,7 +118,7 @@ Return instruction label `str` - + ### name @@ -120,7 +132,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -134,7 +146,7 @@ The number of control qubits for the gate. int - + ### params @@ -152,8 +164,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 6376bcab037..82f2112954e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CPhaseGate.md @@ -1,8 +1,16 @@ -# CPhaseGate +--- +title: CPhaseGate +description: API reference for qiskit.circuit.library.CPhaseGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CPhaseGate +--- +# CPhaseGate + -`CPhaseGate(theta, label=None, ctrl_state=None)` +`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` @@ -39,14 +47,39 @@ Create new CPhase gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| [`control`](qiskit.circuit.library.CPhaseGate.control#qiskit.circuit.library.CPhaseGate.control "qiskit.circuit.library.CPhaseGate.control") | Controlled version of this gate. | -| [`inverse`](qiskit.circuit.library.CPhaseGate.inverse#qiskit.circuit.library.CPhaseGate.inverse "qiskit.circuit.library.CPhaseGate.inverse") | Return inverted CPhase gate ($CPhase(\lambda){\dagger} = CPhase(-\lambda)$) | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### inverse + +`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)$) + +## Attributes + + ### ctrl\_state @@ -56,13 +89,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -72,13 +105,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -88,7 +121,7 @@ Return instruction label `str` - + ### name @@ -102,7 +135,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -116,7 +149,7 @@ The number of control qubits for the gate. int - + ### params @@ -134,8 +167,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 d58767dea59..0e942b081ea 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRXGate.md @@ -1,8 +1,16 @@ -# CRXGate +--- +title: CRXGate +description: API reference for qiskit.circuit.library.CRXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CRXGate +--- +# CRXGate + -`CRXGate(theta, label=None, ctrl_state=None)` +`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` @@ -56,13 +64,17 @@ Create new CRX gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.CRXGate.inverse#qiskit.circuit.library.CRXGate.inverse "qiskit.circuit.library.CRXGate.inverse") | Return inverse CRX gate (i.e. | +### inverse -## Attributes + + +`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). +## Attributes + + ### ctrl\_state @@ -72,13 +84,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -88,13 +100,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -104,7 +116,7 @@ Return instruction label `str` - + ### name @@ -118,7 +130,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -132,7 +144,7 @@ The number of control qubits for the gate. int - + ### params @@ -150,8 +162,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 43dcf9ccf50..292afa15c6c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRYGate.md @@ -1,8 +1,16 @@ -# CRYGate +--- +title: CRYGate +description: API reference for qiskit.circuit.library.CRYGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CRYGate +--- +# CRYGate + -`CRYGate(theta, label=None, ctrl_state=None)` +`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` @@ -56,13 +64,17 @@ Create new CRY gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.CRYGate.inverse#qiskit.circuit.library.CRYGate.inverse "qiskit.circuit.library.CRYGate.inverse") | Return inverse CRY gate (i.e. | +### inverse -## Attributes + + +`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). +## Attributes + + ### ctrl\_state @@ -72,13 +84,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -88,13 +100,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -104,7 +116,7 @@ Return instruction label `str` - + ### name @@ -118,7 +130,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -132,7 +144,7 @@ The number of control qubits for the gate. int - + ### params @@ -150,8 +162,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 119d57f7180..56c6b377137 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CRZGate.md @@ -1,8 +1,16 @@ -# CRZGate +--- +title: CRZGate +description: API reference for qiskit.circuit.library.CRZGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CRZGate +--- +# CRZGate + -`CRZGate(theta, label=None, ctrl_state=None)` +`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` @@ -62,13 +70,17 @@ Create new CRZ gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.CRZGate.inverse#qiskit.circuit.library.CRZGate.inverse "qiskit.circuit.library.CRZGate.inverse") | Return inverse CRZ gate (i.e. | +### inverse -## Attributes + + +`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). +## Attributes + + ### ctrl\_state @@ -78,13 +90,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -94,13 +106,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -110,7 +122,7 @@ Return instruction label `str` - + ### name @@ -124,7 +136,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -138,7 +150,7 @@ The number of control qubits for the gate. int - + ### params @@ -156,8 +168,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 fcbeb34e345..98942079f30 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CSXGate.md @@ -1,8 +1,16 @@ -# CSXGate +--- +title: CSXGate +description: API reference for qiskit.circuit.library.CSXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CSXGate +--- +# CSXGate + -`CSXGate(label=None, ctrl_state=None)` +`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` @@ -56,7 +64,7 @@ Create new CSX gate. ## Attributes - + ### ctrl\_state @@ -66,13 +74,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -82,13 +90,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -98,7 +106,7 @@ Return instruction label `str` - + ### name @@ -112,7 +120,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -126,7 +134,7 @@ The number of control qubits for the gate. int - + ### params @@ -144,8 +152,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 416b973e0b0..1202f7eeba0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CSwapGate.md @@ -1,8 +1,16 @@ -# CSwapGate +--- +title: CSwapGate +description: API reference for qiskit.circuit.library.CSwapGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CSwapGate +--- +# CSwapGate + -`CSwapGate(label=None, ctrl_state=None)` +`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` @@ -75,13 +83,17 @@ Create new CSWAP gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`inverse`](qiskit.circuit.library.CSwapGate.inverse#qiskit.circuit.library.CSwapGate.inverse "qiskit.circuit.library.CSwapGate.inverse") | Return inverse CSwap gate (itself). | +### inverse -## Attributes + + +`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). +## Attributes + + ### ctrl\_state @@ -91,13 +103,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -107,13 +119,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -123,7 +135,7 @@ Return instruction label `str` - + ### name @@ -137,7 +149,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -151,7 +163,7 @@ The number of control qubits for the gate. int - + ### params @@ -169,8 +181,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 6a7995e21c6..da4776b973c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CU1Gate.md @@ -1,8 +1,16 @@ -# CU1Gate +--- +title: CU1Gate +description: API reference for qiskit.circuit.library.CU1Gate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CU1Gate +--- +# CU1Gate + -`CU1Gate(theta, label=None, ctrl_state=None)` +`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` @@ -39,14 +47,39 @@ Create new CU1 gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`control`](qiskit.circuit.library.CU1Gate.control#qiskit.circuit.library.CU1Gate.control "qiskit.circuit.library.CU1Gate.control") | Controlled version of this gate. | -| [`inverse`](qiskit.circuit.library.CU1Gate.inverse#qiskit.circuit.library.CU1Gate.inverse "qiskit.circuit.library.CU1Gate.inverse") | Return inverted CU1 gate ($CU1(\lambda){\dagger} = CU1(-\lambda)$) | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### inverse + +`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)$) + +## Attributes + + ### ctrl\_state @@ -56,13 +89,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -72,13 +105,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -88,7 +121,7 @@ Return instruction label `str` - + ### name @@ -102,7 +135,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -116,7 +149,7 @@ The number of control qubits for the gate. int - + ### params @@ -134,8 +167,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 3823c6a41e5..17ef47f3306 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CU3Gate.md @@ -1,8 +1,16 @@ -# CU3Gate +--- +title: CU3Gate +description: API reference for qiskit.circuit.library.CU3Gate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CU3Gate +--- +# CU3Gate + -`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)` +`CU3Gate(theta, phi, lam, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u3.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -60,13 +68,19 @@ Create new CU3 gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------- | -| [`inverse`](qiskit.circuit.library.CU3Gate.inverse#qiskit.circuit.library.CU3Gate.inverse "qiskit.circuit.library.CU3Gate.inverse") | Return inverted CU3 gate. | +### inverse -## Attributes + + +`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. +$CU3(\theta,\phi,\lambda)^{\dagger} =CU3(-\theta,-\phi,-\lambda)$) + +## Attributes + + ### ctrl\_state @@ -76,13 +90,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -92,13 +106,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -108,7 +122,7 @@ Return instruction label `str` - + ### name @@ -122,7 +136,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -136,7 +150,7 @@ The number of control qubits for the gate. int - + ### params @@ -154,8 +168,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 1e3c677f9f4..43b3ad8715d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CUGate.md @@ -1,8 +1,16 @@ -# CUGate +--- +title: CUGate +description: API reference for qiskit.circuit.library.CUGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CUGate +--- +# CUGate + -`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)` +`CUGate(theta, phi, lam, gamma, label=None, ctrl_state=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/standard_gates/u.py "view source code") Bases: `qiskit.circuit.controlledgate.ControlledGate` @@ -60,13 +68,19 @@ Create new CU gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -| [`inverse`](qiskit.circuit.library.CUGate.inverse#qiskit.circuit.library.CUGate.inverse "qiskit.circuit.library.CUGate.inverse") | Return inverted CU gate. | +### inverse -## Attributes + + +`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. +$CU(\theta,\phi,\lambda,\gamma)^{\dagger} = CU(-\theta,-\phi,-\lambda,-\gamma)$) + +## Attributes + + ### ctrl\_state @@ -76,13 +90,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -92,13 +106,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -108,7 +122,7 @@ Return instruction label `str` - + ### name @@ -122,7 +136,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -136,7 +150,7 @@ The number of control qubits for the gate. int - + ### params @@ -154,8 +168,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 d9dc375eb77..7b91c381efd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CXGate.md @@ -1,8 +1,16 @@ -# CXGate +--- +title: CXGate +description: API reference for qiskit.circuit.library.CXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CXGate +--- +# CXGate + -`CXGate(label=None, ctrl_state=None)` +`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` @@ -62,14 +70,39 @@ Create new CX gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`control`](qiskit.circuit.library.CXGate.control#qiskit.circuit.library.CXGate.control "qiskit.circuit.library.CXGate.control") | Return a controlled-X gate with more control lines. | -| [`inverse`](qiskit.circuit.library.CXGate.inverse#qiskit.circuit.library.CXGate.inverse "qiskit.circuit.library.CXGate.inverse") | Return inverted CX gate (itself). | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### inverse + +`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). + +## Attributes + + ### ctrl\_state @@ -79,13 +112,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -95,13 +128,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -111,7 +144,7 @@ Return instruction label `str` - + ### name @@ -125,7 +158,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -139,7 +172,7 @@ The number of control qubits for the gate. int - + ### params @@ -157,8 +190,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 c1042681264..a378b4b80a7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CYGate.md @@ -1,8 +1,16 @@ -# CYGate +--- +title: CYGate +description: API reference for qiskit.circuit.library.CYGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CYGate +--- +# CYGate + -`CYGate(label=None, ctrl_state=None)` +`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` @@ -56,13 +64,17 @@ Create new CY gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`inverse`](qiskit.circuit.library.CYGate.inverse#qiskit.circuit.library.CYGate.inverse "qiskit.circuit.library.CYGate.inverse") | Return inverted CY gate (itself). | +### inverse -## Attributes + + +`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). +## Attributes + + ### ctrl\_state @@ -72,13 +84,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -88,13 +100,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -104,7 +116,7 @@ Return instruction label `str` - + ### name @@ -118,7 +130,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -132,7 +144,7 @@ The number of control qubits for the gate. int - + ### params @@ -150,8 +162,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 89a4b8b1676..52efb1bfa37 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.CZGate.md @@ -1,8 +1,16 @@ -# CZGate +--- +title: CZGate +description: API reference for qiskit.circuit.library.CZGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.CZGate +--- +# CZGate + -`CZGate(label=None, ctrl_state=None)` +`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` @@ -37,13 +45,17 @@ Create new CZ gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`inverse`](qiskit.circuit.library.CZGate.inverse#qiskit.circuit.library.CZGate.inverse "qiskit.circuit.library.CZGate.inverse") | Return inverted CZ gate (itself). | +### inverse -## Attributes + + +`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). +## Attributes + + ### ctrl\_state @@ -53,13 +65,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -69,13 +81,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -85,7 +97,7 @@ Return instruction label `str` - + ### name @@ -99,7 +111,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -113,7 +125,7 @@ The number of control qubits for the gate. int - + ### params @@ -131,8 +143,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 300f033ee8e..e7e2290cfc7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.DCXGate.md @@ -1,8 +1,16 @@ -# DCXGate +--- +title: DCXGate +description: API reference for qiskit.circuit.library.DCXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.DCXGate +--- +# DCXGate + -`DCXGate` +`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` @@ -34,25 +42,25 @@ Create new DCX gate. ## Attributes - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -62,14 +70,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 8afef229996..2e490ea940e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Diagonal.md @@ -1,8 +1,16 @@ -# Diagonal +--- +title: Diagonal +description: API reference for qiskit.circuit.library.Diagonal +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.Diagonal +--- +# Diagonal + -`Diagonal(diag)` +`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` @@ -56,13 +64,13 @@ Create a new Diagonal circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -72,13 +80,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -94,31 +102,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -126,44 +134,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 ca67898ec1a..a953a4e9416 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.DraperQFTAdder.md @@ -1,8 +1,16 @@ -# DraperQFTAdder +--- +title: DraperQFTAdder +description: API reference for qiskit.circuit.library.DraperQFTAdder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.DraperQFTAdder +--- +# DraperQFTAdder + -`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')` +`DraperQFTAdder(num_state_qubits, kind='fixed', name='DraperQFTAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/draper_qft_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` @@ -45,13 +53,13 @@ cout_0: ┤2 ├──────────────────── ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -61,13 +69,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -83,31 +91,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -115,31 +123,31 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -153,20 +161,21 @@ The number of state qubits, i.e. the number of bits in each input register. The number of state qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 637b3219712..46381f1c63b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ECRGate.md @@ -1,8 +1,16 @@ -# ECRGate +--- +title: ECRGate +description: API reference for qiskit.circuit.library.ECRGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.ECRGate +--- +# ECRGate + -`ECRGate` +`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` @@ -58,31 +66,35 @@ Create new ECR gate. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`to_matrix`](qiskit.circuit.library.ECRGate.to_matrix#qiskit.circuit.library.ECRGate.to_matrix "qiskit.circuit.library.ECRGate.to_matrix") | Return a numpy.array for the ECR gate. | +### to\_matrix -## Attributes + +`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. + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -92,14 +104,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 f6144f6ab50..e61bfd4443f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.EfficientSU2.md @@ -1,8 +1,16 @@ -# EfficientSU2 +--- +title: EfficientSU2 +description: API reference for qiskit.circuit.library.EfficientSU2 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.EfficientSU2 +--- +# 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')` +`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` @@ -24,7 +32,7 @@ On 3 qubits and using the Pauli $Y$ and $Z$ su2\_gates as single qubit gates, th └──────────┘└──────────┘ ░ └───┘└───┘ ░ ░ └───────────┘└───────────┘ ``` -See [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes#qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes") for more detail on the possible arguments and options such as skipping unentanglement qubits, which apply here too. +See [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes") for more detail on the possible arguments and options such as skipping unentanglement qubits, which apply here too. ## Examples @@ -63,22 +71,22 @@ Create a new EfficientSU2 2-local circuit. * **num\_qubits** (`Optional`\[`int`]) – The number of qubits of the EfficientSU2 circuit. * **reps** (`int`) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. * **su2\_gates** (`Union`\[`str`, `type`, `Instruction`, `QuantumCircuit`, `List`\[`Union`\[`str`, `type`, `Instruction`, `QuantumCircuit`]], `None`]) – The SU(2) single qubit gates to apply in single qubit gate layers. If only one gate is provided, the same gate is applied to each qubit. If a list of gates is provided, all gates are applied to each qubit in the provided order. -* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ , ‘circular’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal#qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. +* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ , ‘circular’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** (`Optional`\[`Any`]) – A QuantumCircuit object to prepend to the circuit. * **skip\_unentangled\_qubits** (`bool`) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. * **skip\_final\_rotation\_layer** (`bool`) – If False, a rotation layer is added at the end of the ansatz. If True, no rotation layer is added. -* **parameter\_prefix** (`str`) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector#qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). +* **parameter\_prefix** (`str`) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** (`bool`) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -88,17 +96,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -112,7 +120,7 @@ Get the entanglement strategy. The entanglement strategy, see `get_entangler_map()` for more detail on how the format is interpreted. - + ### entanglement\_blocks @@ -126,25 +134,25 @@ The blocks in the entanglement layers. The blocks in the entanglement layers. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -158,7 +166,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -172,13 +180,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -186,19 +194,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -212,7 +220,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -220,13 +228,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of total parameters that can be set to distinct values. -This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. +This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. **Return type** @@ -240,7 +248,7 @@ The number of parameters originally available in the circuit. This quantity does not require the circuit to be built yet. - + ### num\_qubits @@ -254,7 +262,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -284,7 +292,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -298,7 +306,7 @@ Return the parameter bounds. The parameter bounds. - + ### parameters @@ -306,7 +314,7 @@ The parameter bounds. `ParameterView` - + ### preferred\_init\_points @@ -320,25 +328,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -352,7 +360,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -365,3 +373,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 94031330dc8..f7a3859659a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.EvolvedOperatorAnsatz.md @@ -1,8 +1,16 @@ -# EvolvedOperatorAnsatz +--- +title: EvolvedOperatorAnsatz +description: API reference for qiskit.circuit.library.EvolvedOperatorAnsatz +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.EvolvedOperatorAnsatz +--- +# EvolvedOperatorAnsatz + -`EvolvedOperatorAnsatz(operators=None, reps=1, evolution=None, insert_barriers=False, name='EvolvedOps', initial_state=None)` +`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` @@ -10,22 +18,22 @@ The evolved operator ansatz. **Parameters** -* **operators** (*Optional\[Union\[*[*OperatorBase*](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase")*,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, list]*) – The operators to evolve. If a circuit is passed, we assume it implements an already evolved operator and thus the circuit is not evolved again. Can be a single operator (circuit) or a list of operators (and circuits). +* **operators** (*Optional\[Union\[*[*OperatorBase*](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase")*,* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, list]*) – The operators to evolve. If a circuit is passed, we assume it implements an already evolved operator and thus the circuit is not evolved again. Can be a single operator (circuit) or a list of operators (and circuits). * **reps** (`int`) – The number of times to repeat the evolved operators. -* **evolution** (*Optional\[*[*EvolutionBase*](qiskit.aqua.operators.evolutions.EvolutionBase#qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase")*]*) – An opflow converter object to construct the evolution. Defaults to Trotterization. +* **evolution** (*Optional\[*[*EvolutionBase*](qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase")*]*) – An opflow converter object to construct the evolution. Defaults to Trotterization. * **insert\_barriers** (`bool`) – Whether to insert barriers in between each evolution. * **name** (`str`) – The name of the circuit. * **initial\_state** (`Optional`\[`QuantumCircuit`]) – A QuantumCircuit object to prepend to the circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -35,17 +43,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### evolution @@ -57,27 +65,27 @@ The evolution converter used to compute the evolution. **Return type** -[EvolutionBase](qiskit.aqua.operators.evolutions.EvolutionBase#qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") - +[EvolutionBase](qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -87,13 +95,13 @@ The initial state. `QuantumCircuit` - + ### instances `= 16` - + ### metadata @@ -101,19 +109,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -121,13 +129,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### operators @@ -141,7 +149,7 @@ The operators to be evolved (and circuits) contained in this ansatz. list - + ### parameters @@ -149,31 +157,31 @@ list `ParameterView` - + ### preferred\_init\_points Getter of preferred initial points based on the given initial state. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -182,3 +190,4 @@ The number of times the evolved operators are repeated. **Return type** `int` + 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 9f9803cea68..da57e77275f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ExcitationPreserving.md @@ -1,8 +1,16 @@ -# ExcitationPreserving +--- +title: ExcitationPreserving +description: API reference for qiskit.circuit.library.ExcitationPreserving +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.ExcitationPreserving +--- +# ExcitationPreserving + -`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')` +`ExcitationPreserving(num_qubits=None, mode='iswap', entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='ExcitationPreserving')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/excitation_preserving.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` @@ -25,7 +33,7 @@ Note that other wave functions, such as UCC-ansatzes, are also excitation preser This trial wave function consists of layers of $Z$ rotations with 2-qubit entanglements. The entangling is creating using $XX+YY$ rotations and optionally a controlled-phase gate for the mode `'fsim'`. -See [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes#qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes") for more detail on the possible arguments and options such as skipping unentanglement qubits, which apply here too. +See [`RealAmplitudes`](qiskit.circuit.library.RealAmplitudes "qiskit.circuit.library.RealAmplitudes") for more detail on the possible arguments and options such as skipping unentanglement qubits, which apply here too. The rotations of the ExcitationPreserving ansatz can be written as @@ -76,12 +84,12 @@ Create a new ExcitationPreserving 2-local circuit. * **num\_qubits** (`Optional`\[`int`]) – The number of qubits of the ExcitationPreserving circuit. * **mode** (`str`) – Choose the entangler mode, can be ‘iswap’ or ‘fsim’. * **reps** (`int`) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. -* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal#qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. +* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** (`Optional`\[`Any`]) – A QuantumCircuit object to prepend to the circuit. * **skip\_unentangled\_qubits** (`bool`) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. * **skip\_unentangled\_qubits** – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. * **skip\_final\_rotation\_layer** (`bool`) – If True, a rotation layer is added at the end of the ansatz. If False, no rotation layer is added. Defaults to True. -* **parameter\_prefix** (`str`) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector#qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). +* **parameter\_prefix** (`str`) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** (`bool`) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. **Raises** @@ -90,13 +98,13 @@ Create a new ExcitationPreserving 2-local circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -106,17 +114,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -130,7 +138,7 @@ Get the entanglement strategy. The entanglement strategy, see `get_entangler_map()` for more detail on how the format is interpreted. - + ### entanglement\_blocks @@ -144,25 +152,25 @@ The blocks in the entanglement layers. The blocks in the entanglement layers. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -176,7 +184,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -190,13 +198,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -204,19 +212,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -230,7 +238,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -238,13 +246,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of total parameters that can be set to distinct values. -This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. +This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. **Return type** @@ -258,7 +266,7 @@ The number of parameters originally available in the circuit. This quantity does not require the circuit to be built yet. - + ### num\_qubits @@ -272,7 +280,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -302,7 +310,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -316,7 +324,7 @@ Return the parameter bounds. The parameter bounds. - + ### parameters @@ -324,7 +332,7 @@ The parameter bounds. `ParameterView` - + ### preferred\_init\_points @@ -338,25 +346,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -370,7 +378,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -383,3 +391,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 e49db6af62b..f4e892c337c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.FourierChecking.md @@ -1,8 +1,16 @@ -# FourierChecking +--- +title: FourierChecking +description: API reference for qiskit.circuit.library.FourierChecking +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.FourierChecking +--- +# FourierChecking + -`FourierChecking(f, g)` +`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` @@ -37,13 +45,13 @@ Create Fourier checking circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -53,13 +61,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -75,31 +83,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -107,44 +115,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 ca7f2d10fe3..4d2d9169916 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.FunctionalPauliRotations.md @@ -1,8 +1,16 @@ -# FunctionalPauliRotations +--- +title: FunctionalPauliRotations +description: API reference for qiskit.circuit.library.FunctionalPauliRotations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.FunctionalPauliRotations +--- +# FunctionalPauliRotations + -`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')` +`FunctionalPauliRotations(num_state_qubits=None, basis='Y', name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/functional_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit`, `abc.ABC` @@ -18,13 +26,13 @@ Create a new functional Pauli rotation circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### basis @@ -40,7 +48,7 @@ Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotatio The kind of Pauli rotation used in controlled rotation. - + ### calibrations @@ -50,41 +58,41 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -92,7 +100,7 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits @@ -106,19 +114,19 @@ The minimum number of ancilla qubits in the circuit. The minimal number of ancillas required. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -126,13 +134,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -146,7 +154,7 @@ The number of state qubits representing the state $|x\rangle$. The number of state qubits. - + ### parameters @@ -154,20 +162,21 @@ The number of state qubits. `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 766a6e96840..5a745088e3c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GMS.md @@ -1,8 +1,16 @@ -# GMS +--- +title: GMS +description: API reference for qiskit.circuit.library.GMS +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.GMS +--- +# GMS + -`GMS(num_qubits, theta)` +`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` @@ -46,13 +54,13 @@ Create a new Global Mølmer–Sørensen (GMS) gate. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -62,13 +70,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -84,31 +92,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -116,44 +124,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 9205b7925d4..7209ecc0e08 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GR.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GR.md @@ -1,8 +1,16 @@ -# GR +--- +title: GR +description: API reference for qiskit.circuit.library.GR +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.GR +--- +# GR + -`GR(num_qubits, theta, phi)` +`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` @@ -40,13 +48,13 @@ Create a new Global R (GR) gate. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -56,13 +64,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -78,31 +86,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -110,44 +118,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 a6d2764f9c4..71aa083afec 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRX.md @@ -1,8 +1,16 @@ -# GRX +--- +title: GRX +description: API reference for qiskit.circuit.library.GRX +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.GRX +--- +# GRX + -`GRX(num_qubits, theta)` +`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` @@ -39,13 +47,13 @@ Create a new Global RX (GRX) gate. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -55,13 +63,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -77,31 +85,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -109,44 +117,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 99e32e7640b..6cc06a24d47 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRY.md @@ -1,8 +1,16 @@ -# GRY +--- +title: GRY +description: API reference for qiskit.circuit.library.GRY +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.GRY +--- +# GRY + -`GRY(num_qubits, theta)` +`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` @@ -39,13 +47,13 @@ Create a new Global RY (GRY) gate. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -55,13 +63,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -77,31 +85,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -109,44 +117,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 7273323cd0b..8466600f053 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GRZ.md @@ -1,8 +1,16 @@ -# GRZ +--- +title: GRZ +description: API reference for qiskit.circuit.library.GRZ +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.GRZ +--- +# GRZ + -`GRZ(num_qubits, phi)` +`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` @@ -39,13 +47,13 @@ Create a new Global RZ (GRZ) gate. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -55,13 +63,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -77,31 +85,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -109,44 +117,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 889ea63c674..3a9588f99c8 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GraphState.md @@ -1,8 +1,16 @@ -# GraphState +--- +title: GraphState +description: API reference for qiskit.circuit.library.GraphState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.GraphState +--- +# GraphState + -`GraphState(adjacency_matrix)` +`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` @@ -44,13 +52,13 @@ The circuit prepares a graph state with the given adjacency matrix. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -60,13 +68,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -82,31 +90,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -114,44 +122,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 56a67bff7af..c4c98182d88 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.GroverOperator.md @@ -1,8 +1,16 @@ -# GroverOperator +--- +title: GroverOperator +description: API reference for qiskit.circuit.library.GroverOperator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.GroverOperator +--- +# GroverOperator + -`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')` +`GroverOperator(oracle, state_preparation=None, zero_reflection=None, reflection_qubits=None, insert_barriers=False, mcx_mode='noancilla', name='Q')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/grover_operator.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -149,13 +157,13 @@ Quantum Amplitude Amplification and Estimation. [arXiv:quant-ph/0005055](http:// ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -165,13 +173,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -187,31 +195,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -219,61 +227,61 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### oracle The oracle implementing a reflection about the bad state. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reflection\_qubits Reflection qubits, on which S0 is applied (if S0 is not user-specified). - + ### state\_preparation @@ -283,7 +291,7 @@ The subcircuit implementing the A operator or Hadamards. `QuantumCircuit` - + ### zero\_reflection @@ -292,3 +300,4 @@ The subcircuit implementing the reflection about 0. **Return type** `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 2762e63c284..d24f0a4df5b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HGate.md @@ -1,8 +1,16 @@ -# HGate +--- +title: HGate +description: API reference for qiskit.circuit.library.HGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.HGate +--- +# HGate + -`HGate(label=None)` +`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` @@ -32,32 +40,59 @@ Create new H gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`control`](qiskit.circuit.library.HGate.control#qiskit.circuit.library.HGate.control "qiskit.circuit.library.HGate.control") | Return a (multi-)controlled-H gate. | -| [`inverse`](qiskit.circuit.library.HGate.inverse#qiskit.circuit.library.HGate.inverse "qiskit.circuit.library.HGate.inverse") | Return inverted H gate (itself). | +### control -## Attributes + + +`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. + +One control qubit returns a CH gate. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + + +`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). + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -67,14 +102,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 02c7376d068..500b209d60c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HRSCumulativeMultiplier.md @@ -1,8 +1,16 @@ -# HRSCumulativeMultiplier +--- +title: HRSCumulativeMultiplier +description: API reference for qiskit.circuit.library.HRSCumulativeMultiplier +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.HRSCumulativeMultiplier +--- +# HRSCumulativeMultiplier + -`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')` +`HRSCumulativeMultiplier(num_state_qubits, num_result_qubits=None, adder=None, name='HRSCumulativeMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/hrs_cumulative_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` @@ -58,13 +66,13 @@ Multiplication in this circuit is implemented in a classical approach by perform ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -74,13 +82,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -96,31 +104,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -128,31 +136,31 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### num\_result\_qubits @@ -166,7 +174,7 @@ The number of result qubits to limit the output to. The number of result qubits. - + ### num\_state\_qubits @@ -180,20 +188,21 @@ The number of state qubits, i.e. the number of bits in each input register. The number of state qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 2f1da4d8bc2..1f5fe56e5ea 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.HiddenLinearFunction.md @@ -1,8 +1,16 @@ -# HiddenLinearFunction +--- +title: HiddenLinearFunction +description: API reference for qiskit.circuit.library.HiddenLinearFunction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.HiddenLinearFunction +--- +# HiddenLinearFunction + -`HiddenLinearFunction(adjacency_matrix)` +`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` @@ -48,13 +56,13 @@ Create new HLF circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -64,13 +72,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -86,31 +94,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -118,44 +126,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 eef42d9cfa2..ab0a4176c1d 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IGate.md @@ -1,8 +1,16 @@ -# IGate +--- +title: IGate +description: API reference for qiskit.circuit.library.IGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.IGate +--- +# IGate + -`IGate(label=None)` +`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` @@ -31,31 +39,35 @@ Create new Identity gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------- | -| [`inverse`](qiskit.circuit.library.IGate.inverse#qiskit.circuit.library.IGate.inverse "qiskit.circuit.library.IGate.inverse") | Invert this gate. | +### inverse -## Attributes + +`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. + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -65,14 +77,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 a38d1771597..d94325bb24e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IQP.md @@ -1,8 +1,16 @@ -# IQP +--- +title: IQP +description: API reference for qiskit.circuit.library.IQP +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.IQP +--- +# IQP + -`IQP(interactions)` +`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` @@ -36,13 +44,13 @@ Create IQP circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -52,13 +60,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -74,31 +82,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -106,44 +114,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 d9a812033c8..2c236db1c10 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.InnerProduct.md @@ -1,8 +1,16 @@ -# InnerProduct +--- +title: InnerProduct +description: API reference for qiskit.circuit.library.InnerProduct +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.InnerProduct +--- +# InnerProduct + -`InnerProduct(num_qubits)` +`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` @@ -45,13 +53,13 @@ Return a circuit to compute the inner product of 2 n-qubit registers. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -61,13 +69,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -83,31 +91,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -115,44 +123,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 4ef810feac1..3d904625192 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.IntegerComparator.md @@ -1,8 +1,16 @@ -# IntegerComparator +--- +title: IntegerComparator +description: API reference for qiskit.circuit.library.IntegerComparator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.IntegerComparator +--- +# IntegerComparator + -`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')` +`IntegerComparator(num_state_qubits=None, value=None, geq=True, name='cmp')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/integer_comparator.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -27,13 +35,13 @@ Create a new fixed value comparator circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -43,23 +51,23 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### geq @@ -73,25 +81,25 @@ Return whether the comparator compares greater or less equal. True, if the comparator compares `>=`, False if `<`. - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -99,25 +107,25 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits Deprecated. Use num\_ancillas instead. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -125,13 +133,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -145,7 +153,7 @@ The number of qubits encoding the state for the comparison. The number of state qubits. - + ### parameters @@ -153,25 +161,25 @@ The number of state qubits. `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### value @@ -184,3 +192,4 @@ The value to compare the qubit register to. **Returns** The value against which the value of the qubit register is compared. + 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 3d0bcf61cf4..c99855ecaa0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearAmplitudeFunction.md @@ -1,8 +1,16 @@ -# LinearAmplitudeFunction +--- +title: LinearAmplitudeFunction +description: API reference for qiskit.circuit.library.LinearAmplitudeFunction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.LinearAmplitudeFunction +--- +# LinearAmplitudeFunction + -`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')` +`LinearAmplitudeFunction(num_state_qubits, slope, offset, domain, image, rescaling_factor=1, breakpoints=None, name='F')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_amplitude_function.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -62,19 +70,35 @@ Quantum-Enhanced Simulation-Based Optimization. [arXiv:2005.10780](http://arxiv. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`post_processing`](qiskit.circuit.library.LinearAmplitudeFunction.post_processing#qiskit.circuit.library.LinearAmplitudeFunction.post_processing "qiskit.circuit.library.LinearAmplitudeFunction.post_processing") | Map the function value of the approximated $\hat{f}$ to $f$. | +### post\_processing -## Attributes + + +`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$. + +**Parameters** + +**scaled\_value** (`float`) – A function value from the Taylor expansion of $\hat{f}(x)$. +**Return type** + +`float` + +**Returns** +The `scaled_value` mapped back to the domain of $f$, by first inverting the transformation used for the Taylor approximation and then mapping back from $[0, 1]$ to the original domain. + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -84,13 +108,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -106,31 +130,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -138,44 +162,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 0f1d9f34ad6..74928b7d27a 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LinearPauliRotations.md @@ -1,8 +1,16 @@ -# LinearPauliRotations +--- +title: LinearPauliRotations +description: API reference for qiskit.circuit.library.LinearPauliRotations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.LinearPauliRotations +--- +# LinearPauliRotations + -`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')` +`LinearPauliRotations(num_state_qubits=None, slope=1, offset=0, basis='Y', name='LinRot')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -41,13 +49,13 @@ Create a new linear rotation circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### basis @@ -63,7 +71,7 @@ Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotatio The kind of Pauli rotation used in controlled rotation. - + ### calibrations @@ -73,41 +81,41 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -115,7 +123,7 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits @@ -129,19 +137,19 @@ The minimum number of ancilla qubits in the circuit. The minimal number of ancillas required. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -149,13 +157,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -169,7 +177,7 @@ The number of state qubits representing the state $|x\rangle$. The number of state qubits. - + ### offset @@ -185,7 +193,7 @@ Before applying the controlled rotations, a single rotation of angle `offset` is The offset angle. - + ### parameters @@ -193,25 +201,25 @@ The offset angle. `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### slope @@ -226,3 +234,4 @@ The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` wh **Returns** The rotation angle common in all controlled rotations. + 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 5d5bec5757a..6519f15a0a2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.LogNormalDistribution.md @@ -1,8 +1,16 @@ -# LogNormalDistribution +--- +title: LogNormalDistribution +description: API reference for qiskit.circuit.library.LogNormalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.LogNormalDistribution +--- +# LogNormalDistribution + -`LogNormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` +`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` @@ -63,13 +71,13 @@ Quantum Risk Analysis. [arXiv:1806.06893](http://arxiv.org/abs/1806.06893) ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### bounds @@ -79,7 +87,7 @@ Return the bounds of the probability distribution. `Union`\[`Tuple`\[`float`, `float`], `List`\[`Tuple`\[`float`, `float`]]] - + ### calibrations @@ -89,13 +97,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -111,31 +119,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -143,43 +151,43 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### probabilities @@ -189,13 +197,13 @@ Return the sampling probabilities for the values. `ndarray` - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### values @@ -204,3 +212,4 @@ Return the discretized points of the random variable. **Return type** `ndarray` + 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 16de45c7610..426d49f6834 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMT.md @@ -1,8 +1,16 @@ -# MCMT +--- +title: MCMT +description: API reference for qiskit.circuit.library.MCMT +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MCMT +--- +# MCMT + -`MCMT(gate, num_ctrl_qubits, num_target_qubits, label=None)` +`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` @@ -23,7 +31,7 @@ For example, the H gate controlled on 3 qubits and acting on 2 target qubit is r └──────┘ ``` -This default implementations requires no ancilla qubits, by broadcasting the target gate to the number of target qubits and using Qiskit’s generic control routine to control the broadcasted target on the control qubits. If ancilla qubits are available, a more efficient variant using the so-called V-chain decomposition can be used. This is implemented in [`MCMTVChain`](qiskit.circuit.library.MCMTVChain#qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain"). +This default implementations requires no ancilla qubits, by broadcasting the target gate to the number of target qubits and using Qiskit’s generic control routine to control the broadcasted target on the control qubits. If ancilla qubits are available, a more efficient variant using the so-called V-chain decomposition can be used. This is implemented in [`MCMTVChain`](qiskit.circuit.library.MCMTVChain "qiskit.circuit.library.MCMTVChain"). Create a new multi-control multi-target gate. @@ -41,20 +49,31 @@ Create a new multi-control multi-target gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`control`](qiskit.circuit.library.MCMT.control#qiskit.circuit.library.MCMT.control "qiskit.circuit.library.MCMT.control") | Return the controlled version of the MCMT circuit. | -| [`inverse`](qiskit.circuit.library.MCMT.inverse#qiskit.circuit.library.MCMT.inverse "qiskit.circuit.library.MCMT.inverse") | Return the inverse MCMT circuit, which is itself. | +### control -## Attributes + + +`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. + +### inverse + + +`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. + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -64,13 +83,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -86,31 +105,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -118,50 +137,51 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits Return the number of ancillas. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 91c97df42c7..aeeda9cf0d0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCMTVChain.md @@ -1,14 +1,22 @@ -# MCMTVChain +--- +title: MCMTVChain +description: API reference for qiskit.circuit.library.MCMTVChain +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MCMTVChain +--- +# MCMTVChain + -`MCMTVChain(gate, num_ctrl_qubits, num_target_qubits, label=None)` +`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` The MCMT implementation using the CCX V-chain. -This implementation requires ancillas but is decomposed into a much shallower circuit than the default implementation in [`MCMT`](qiskit.circuit.library.MCMT#qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT"). +This implementation requires ancillas but is decomposed into a much shallower circuit than the default implementation in [`MCMT`](qiskit.circuit.library.MCMT "qiskit.circuit.library.MCMT"). **Expanded Circuit:** @@ -63,19 +71,23 @@ Create a new multi-control multi-target gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| [`inverse`](qiskit.circuit.library.MCMTVChain.inverse#qiskit.circuit.library.MCMTVChain.inverse "qiskit.circuit.library.MCMTVChain.inverse") | Return the inverse MCMT circuit, which is itself. | +### inverse -## Attributes + +`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. + +## Attributes + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -85,13 +97,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -107,31 +119,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -139,50 +151,51 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits Return the number of ancilla qubits required. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 18c61a6d27a..bc67b7ca908 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCPhaseGate.md @@ -1,8 +1,16 @@ -# MCPhaseGate +--- +title: MCPhaseGate +description: API reference for qiskit.circuit.library.MCPhaseGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MCPhaseGate +--- +# MCPhaseGate + -`MCPhaseGate(lam, num_ctrl_qubits, label=None)` +`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` @@ -31,14 +39,39 @@ Create new MCPhase gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`control`](qiskit.circuit.library.MCPhaseGate.control#qiskit.circuit.library.MCPhaseGate.control "qiskit.circuit.library.MCPhaseGate.control") | Controlled version of this gate. | -| [`inverse`](qiskit.circuit.library.MCPhaseGate.inverse#qiskit.circuit.library.MCPhaseGate.inverse "qiskit.circuit.library.MCPhaseGate.inverse") | Return inverted MCU1 gate ($MCU1(\lambda){\dagger} = MCU1(-\lambda)$) | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### inverse + +`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)$) + +## Attributes + + ### ctrl\_state @@ -48,13 +81,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -64,13 +97,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -80,7 +113,7 @@ Return instruction label `str` - + ### name @@ -94,7 +127,7 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ctrl\_qubits @@ -108,7 +141,7 @@ The number of control qubits for the gate. int - + ### params @@ -126,8 +159,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 a42366c5acd..74b06fd9380 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGate.md @@ -1,8 +1,16 @@ -# MCXGate +--- +title: MCXGate +description: API reference for qiskit.circuit.library.MCXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MCXGate +--- +# MCXGate + -`MCXGate(num_ctrl_qubits=None, label=None, ctrl_state=None)` +`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` @@ -12,15 +20,49 @@ Create new MCX gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`control`](qiskit.circuit.library.MCXGate.control#qiskit.circuit.library.MCXGate.control "qiskit.circuit.library.MCXGate.control") | Return a multi-controlled-X gate with more control lines. | -| [`get_num_ancilla_qubits`](qiskit.circuit.library.MCXGate.get_num_ancilla_qubits#qiskit.circuit.library.MCXGate.get_num_ancilla_qubits "qiskit.circuit.library.MCXGate.get_num_ancilla_qubits") | Get the number of required ancilla qubits without instantiating the class. | -| [`inverse`](qiskit.circuit.library.MCXGate.inverse#qiskit.circuit.library.MCXGate.inverse "qiskit.circuit.library.MCXGate.inverse") | Invert this gate. | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +### get\_num\_ancilla\_qubits + + + +`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. +This staticmethod might be necessary to check the number of ancillas before creating the gate, or to use the number of ancillas in the initialization. +### inverse + + + +`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. + +## Attributes + + ### ctrl\_state @@ -30,13 +72,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -46,13 +88,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -62,7 +104,7 @@ Return instruction label `str` - + ### name @@ -76,13 +118,13 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ancilla\_qubits The number of ancilla qubits. - + ### num\_ctrl\_qubits @@ -96,7 +138,7 @@ The number of control qubits for the gate. int - + ### params @@ -114,8 +156,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 d20ac0bcab3..18d5c37cb29 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXGrayCode.md @@ -1,8 +1,16 @@ -# MCXGrayCode +--- +title: MCXGrayCode +description: API reference for qiskit.circuit.library.MCXGrayCode +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MCXGrayCode +--- +# MCXGrayCode + -`MCXGrayCode(num_ctrl_qubits=None, label=None, ctrl_state=None)` +`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` @@ -14,13 +22,17 @@ Create new MCX gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -| [`inverse`](qiskit.circuit.library.MCXGrayCode.inverse#qiskit.circuit.library.MCXGrayCode.inverse "qiskit.circuit.library.MCXGrayCode.inverse") | Invert this gate. | +### inverse -## Attributes + + +`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. +## Attributes + + ### ctrl\_state @@ -30,13 +42,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -46,13 +58,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -62,7 +74,7 @@ Return instruction label `str` - + ### name @@ -76,13 +88,13 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ancilla\_qubits The number of ancilla qubits. - + ### num\_ctrl\_qubits @@ -96,7 +108,7 @@ The number of control qubits for the gate. int - + ### params @@ -114,8 +126,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 654f99953f6..8dcdd3807ad 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXRecursive.md @@ -1,8 +1,16 @@ -# MCXRecursive +--- +title: MCXRecursive +description: API reference for qiskit.circuit.library.MCXRecursive +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MCXRecursive +--- +# MCXRecursive + -`MCXRecursive(num_ctrl_qubits=None, label=None, ctrl_state=None)` +`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` @@ -14,14 +22,25 @@ Create new MCX gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`get_num_ancilla_qubits`](qiskit.circuit.library.MCXRecursive.get_num_ancilla_qubits#qiskit.circuit.library.MCXRecursive.get_num_ancilla_qubits "qiskit.circuit.library.MCXRecursive.get_num_ancilla_qubits") | Get the number of required ancilla qubits. | -| [`inverse`](qiskit.circuit.library.MCXRecursive.inverse#qiskit.circuit.library.MCXRecursive.inverse "qiskit.circuit.library.MCXRecursive.inverse") | Invert this gate. | +### get\_num\_ancilla\_qubits -## Attributes + + +`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. +### inverse + + + +`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. + +## Attributes + ### ctrl\_state @@ -31,13 +50,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -47,13 +66,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -63,7 +82,7 @@ Return instruction label `str` - + ### name @@ -77,13 +96,13 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ancilla\_qubits The number of ancilla qubits. - + ### num\_ctrl\_qubits @@ -97,7 +116,7 @@ The number of control qubits for the gate. int - + ### params @@ -115,8 +134,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 ba78daa63b8..935f91d10df 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MCXVChain.md @@ -1,8 +1,16 @@ -# MCXVChain +--- +title: MCXVChain +description: API reference for qiskit.circuit.library.MCXVChain +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MCXVChain +--- +# MCXVChain + -`MCXVChain(num_ctrl_qubits=None, dirty_ancillas=False, label=None, ctrl_state=None)` +`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` @@ -12,14 +20,25 @@ Create new MCX gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`get_num_ancilla_qubits`](qiskit.circuit.library.MCXVChain.get_num_ancilla_qubits#qiskit.circuit.library.MCXVChain.get_num_ancilla_qubits "qiskit.circuit.library.MCXVChain.get_num_ancilla_qubits") | Get the number of required ancilla qubits. | -| [`inverse`](qiskit.circuit.library.MCXVChain.inverse#qiskit.circuit.library.MCXVChain.inverse "qiskit.circuit.library.MCXVChain.inverse") | Invert this gate. | +### get\_num\_ancilla\_qubits -## Attributes + + +`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. +### inverse + + + +`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. + +## Attributes + ### ctrl\_state @@ -29,13 +48,13 @@ Return the control state of the gate as a decimal integer. `int` - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition @@ -45,13 +64,13 @@ Return definition in terms of other basic gates. If the gate has open controls, `List` - + ### duration Get the duration. - + ### label @@ -61,7 +80,7 @@ Return instruction label `str` - + ### name @@ -75,13 +94,13 @@ where \ is the gate name for the default case of closed control `str` - + ### num\_ancilla\_qubits The number of ancilla qubits. - + ### num\_ctrl\_qubits @@ -95,7 +114,7 @@ The number of control qubits for the gate. int - + ### params @@ -113,8 +132,9 @@ list **CircuitError** – Controlled gate does not define a base gate - + ### unit Get the time unit of duration. + 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 57669032af8..0f11bf418ed 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.MSGate.md @@ -1,8 +1,16 @@ -# MSGate +--- +title: MSGate +description: API reference for qiskit.circuit.library.MSGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.MSGate +--- +# MSGate + -`MSGate(num_qubits, theta, label=None)` +`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` @@ -18,25 +26,25 @@ Create new MS gate. ## Attributes - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -46,14 +54,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 d9d765e316d..00c1ed0cbf3 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Measure.md @@ -1,8 +1,16 @@ -# Measure +--- +title: Measure +description: API reference for qiskit.circuit.library.Measure +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.Measure +--- +# Measure + -`Measure` +`Measure`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/measure.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -12,31 +20,48 @@ Create new measurement instruction. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`broadcast_arguments`](qiskit.circuit.library.Measure.broadcast_arguments#qiskit.circuit.library.Measure.broadcast_arguments "qiskit.circuit.library.Measure.broadcast_arguments") | Validation of the arguments. | +### broadcast\_arguments -## Attributes + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. +**Raises** +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -46,14 +71,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 b6437901940..d50bb0e2dfe 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.NLocal.md @@ -1,8 +1,16 @@ -# NLocal +--- +title: NLocal +description: API reference for qiskit.circuit.library.NLocal +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.NLocal +--- +# NLocal + -`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')` +`NLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement=None, reps=1, insert_barriers=False, parameter_prefix='θ', overwrite_block_parameters=True, skip_final_rotation_layer=False, skip_unentangled_qubits=False, initial_state=None, name='nlocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/n_local.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -40,7 +48,7 @@ Create a new n-local circuit. * **num\_qubits** (`Optional`\[`int`]) – The number of qubits of the circuit. * **rotation\_blocks** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `Instruction`, `List`\[`Instruction`], `None`]) – The blocks used in the rotation layers. If multiple are passed, these will be applied one after another (like new sub-layers). -* **entanglement\_blocks** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `Instruction`, `List`\[`Instruction`], `None`]) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. To use different entanglements for the sub-layers, see [`get_entangler_map()`](qiskit.circuit.library.NLocal.get_entangler_map#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map"). +* **entanglement\_blocks** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`], `Instruction`, `List`\[`Instruction`], `None`]) – The blocks used in the entanglement layers. If multiple are passed, these will be applied one after another. To use different entanglements for the sub-layers, see [`get_entangler_map()`](qiskit.circuit.library.NLocal#get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map"). * **entanglement** (`Union`\[`List`\[`int`], `List`\[`List`\[`int`]], `None`]) – The indices specifying on which qubits the input blocks act. If None, the entanglement blocks are applied at the top of the circuit. * **reps** (`int`) – Specifies how often the rotation blocks and entanglement blocks are repeated. * **insert\_barriers** (`bool`) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. @@ -63,23 +71,127 @@ TODO ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| [`add_layer`](qiskit.circuit.library.NLocal.add_layer#qiskit.circuit.library.NLocal.add_layer "qiskit.circuit.library.NLocal.add_layer") | Append another layer to the NLocal. | -| [`assign_parameters`](qiskit.circuit.library.NLocal.assign_parameters#qiskit.circuit.library.NLocal.assign_parameters "qiskit.circuit.library.NLocal.assign_parameters") | Assign parameters to the n-local circuit. | -| [`get_entangler_map`](qiskit.circuit.library.NLocal.get_entangler_map#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map") | Get the entangler map for in the repetition `rep_num` and the block `block_num`. | -| [`get_unentangled_qubits`](qiskit.circuit.library.NLocal.get_unentangled_qubits#qiskit.circuit.library.NLocal.get_unentangled_qubits "qiskit.circuit.library.NLocal.get_unentangled_qubits") | Get the indices of unentangled qubits in a set. | -| [`print_settings`](qiskit.circuit.library.NLocal.print_settings#qiskit.circuit.library.NLocal.print_settings "qiskit.circuit.library.NLocal.print_settings") | Returns information about the setting. | +### add\_layer -## Attributes + + +`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. + +**Parameters** + +* **other** (`Union`\[`NLocal`, `Instruction`, `QuantumCircuit`]) – The layer to compose, can be another NLocal, an Instruction or Gate, or a QuantumCircuit. +* **entanglement** (`Union`\[`List`\[`int`], `str`, `List`\[`List`\[`int`]], `None`]) – The entanglement or qubit indices. +* **front** (`bool`) – If True, `other` is appended to the front, else to the back. + +**Return type** + +`NLocal` + +**Returns** + +self, such that chained composes are possible. + +**Raises** + +**TypeError** – If other is not compatible, i.e. is no Instruction and does not have a to\_instruction method. + +### assign\_parameters + + + +`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. + +This method also supports passing a list instead of a dictionary. If a list is passed, the list must have the same length as the number of unbound parameters in the circuit. The parameters are assigned in the order of the parameters in [`ordered_parameters()`](qiskit.circuit.library.NLocal#ordered_parameters "qiskit.circuit.library.NLocal.ordered_parameters"). + +**Return type** + +`Optional`\[`QuantumCircuit`] + +**Returns** + +A copy of the NLocal circuit with the specified parameters. + +**Raises** + +**AttributeError** – If the parameters are given as list and do not match the number of parameters. + +### get\_entangler\_map + + + +`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`. + +The entangler map for the current block is derived from the value of `self.entanglement`. Below the different cases are listed, where `i` and `j` denote the repetition number and the block number, respectively, and `n` the number of qubits in the block. + +entanglement type | entangler map ——————————-+——————————————————– None | \[\[0, …, n - 1]] str (e.g ‘full’) | the specified connectivity on `n` qubits List\[int] | \[`entanglement`] List\[List\[int]] | `entanglement` List\[List\[List\[int]]] | `entanglement[i]` List\[List\[List\[List\[int]]]] | `entanglement[i][j]` List\[str] | the connectivity specified in `entanglement[i]` List\[List\[str]] | the connectivity specified in `entanglement[i][j]` Callable\[int, str] | same as List\[str] Callable\[int, List\[List\[int]]] | same as List\[List\[List\[int]]] + +Note that all indices are to be taken modulo the length of the array they act on, i.e. no out-of-bounds index error will be raised but we re-iterate from the beginning of the list. + +**Parameters** + +* **rep\_num** (`int`) – The current repetition we are in. +* **block\_num** (`int`) – The block number within the entanglement layers. +* **num\_block\_qubits** (`int`) – The number of qubits in the block. + +**Return type** + +`List`\[`List`\[`int`]] + +**Returns** + +The entangler map for the current block in the current repetition. + +**Raises** + +**ValueError** – If the value of `entanglement` could not be cast to a corresponding entangler map. +### get\_unentangled\_qubits + + +`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. + +**Return type** + +`Set`\[`int`] + +**Returns** + +The unentangled qubits. + +### print\_settings + + + +`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. + +**Return type** + +`str` + +**Returns** + +The class name and the attributes/parameters of the instance as `str`. + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -89,17 +201,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -111,9 +223,9 @@ Get the entanglement strategy. **Returns** -The entanglement strategy, see [`get_entangler_map()`](qiskit.circuit.library.NLocal.get_entangler_map#qiskit.circuit.library.NLocal.get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map") for more detail on how the format is interpreted. - +The entanglement strategy, see [`get_entangler_map()`](qiskit.circuit.library.NLocal#get_entangler_map "qiskit.circuit.library.NLocal.get_entangler_map") for more detail on how the format is interpreted. + ### entanglement\_blocks @@ -127,25 +239,25 @@ The blocks in the entanglement layers. The blocks in the entanglement layers. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -159,7 +271,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -173,13 +285,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -187,19 +299,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -213,7 +325,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -221,13 +333,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of total parameters that can be set to distinct values. -This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. +This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. **Return type** @@ -241,7 +353,7 @@ The number of parameters originally available in the circuit. This quantity does not require the circuit to be built yet. - + ### num\_qubits @@ -255,7 +367,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -285,7 +397,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -299,7 +411,7 @@ The parameter bounds for the unbound parameters in the circuit. A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded. - + ### parameters @@ -307,7 +419,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo `ParameterView` - + ### preferred\_init\_points @@ -321,25 +433,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -353,7 +465,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -366,3 +478,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 ea1a651aecc..45581f51150 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.NormalDistribution.md @@ -1,8 +1,16 @@ -# NormalDistribution +--- +title: NormalDistribution +description: API reference for qiskit.circuit.library.NormalDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.NormalDistribution +--- +# NormalDistribution + -`NormalDistribution(num_qubits, mu=None, sigma=None, bounds=None, upto_diag=False, name='P(X)')` +`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` @@ -111,13 +119,13 @@ Quantum Risk Analysis. [arXiv:1806.06893](http://arxiv.org/abs/1806.06893) ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### bounds @@ -127,7 +135,7 @@ Return the bounds of the probability distribution. `Union`\[`Tuple`\[`float`, `float`], `List`\[`Tuple`\[`float`, `float`]]] - + ### calibrations @@ -137,13 +145,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -159,31 +167,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -191,43 +199,43 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### probabilities @@ -237,13 +245,13 @@ Return the sampling probabilities for the values. `ndarray` - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### values @@ -252,3 +260,4 @@ Return the discretized points of the random variable. **Return type** `ndarray` + 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 c150b6aafa9..f3ee7c97b11 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.OR.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.OR.md @@ -1,8 +1,16 @@ -# OR +--- +title: OR +description: API reference for qiskit.circuit.library.OR +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.OR +--- +# OR + -`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')` +`OR(num_variable_qubits, flags=None, mcx_mode='noancilla')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/boolean_logic/quantum_or.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -24,13 +32,13 @@ Create a new logical OR circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -40,13 +48,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -62,31 +70,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -94,44 +102,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 e453ddd1db9..e313ef95ab5 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliFeatureMap.md @@ -1,8 +1,16 @@ -# PauliFeatureMap +--- +title: PauliFeatureMap +description: API reference for qiskit.circuit.library.PauliFeatureMap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PauliFeatureMap +--- +# PauliFeatureMap + -`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')` +`PauliFeatureMap(feature_dimension=None, reps=2, entanglement='full', alpha=2.0, paulis=None, data_map_func=None, parameter_prefix='x', insert_barriers=False, name='PauliFeatureMap')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/data_preparation/pauli_feature_map.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -34,7 +42,7 @@ For example, if the Pauli strings are chosen to be $P_0 = Z$ and $P_{0,1} = YY$ └───┘└──────────────┘└──────────┘└───┘└─────────────────────────────────┘└───┘└───────────┘ ``` -Please refer to [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap#qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap") for the case $k = 1$, $P_0 = Z$ and to [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap#qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap") for the case $k = 2$, $P_0 = Z$ and $P_{0,1} = ZZ$. +Please refer to [`ZFeatureMap`](qiskit.circuit.library.ZFeatureMap "qiskit.circuit.library.ZFeatureMap") for the case $k = 1$, $P_0 = Z$ and to [`ZZFeatureMap`](qiskit.circuit.library.ZZFeatureMap "qiskit.circuit.library.ZZFeatureMap") for the case $k = 2$, $P_0 = Z$ and $P_{0,1} = ZZ$. ## Examples @@ -91,7 +99,7 @@ Create a new Pauli expansion circuit. * **feature\_dimension** (`Optional`\[`int`]) – Number of qubits in the circuit. * **reps** (`int`) – The number of repeated circuits. -* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Refer to [`NLocal`](qiskit.circuit.library.NLocal#qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal") for detail. +* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Refer to [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal") for detail. * **alpha** (`float`) – The Pauli rotation factor, multiplicative to the pauli rotations * **paulis** (`Optional`\[`List`\[`str`]]) – A list of strings for to-be-used paulis. If None are provided, `['Z', 'ZZ']` will be used. * **data\_map\_func** (`Optional`\[`Callable`\[\[`ndarray`], `float`]]) – A mapping function for data x which can be supplied to override the default mapping from `self_product()`. @@ -100,14 +108,25 @@ Create a new Pauli expansion circuit. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`pauli_block`](qiskit.circuit.library.PauliFeatureMap.pauli_block#qiskit.circuit.library.PauliFeatureMap.pauli_block "qiskit.circuit.library.PauliFeatureMap.pauli_block") | Get the Pauli block for the feature map circuit. | -| [`pauli_evolution`](qiskit.circuit.library.PauliFeatureMap.pauli_evolution#qiskit.circuit.library.PauliFeatureMap.pauli_evolution "qiskit.circuit.library.PauliFeatureMap.pauli_evolution") | Get the evolution block for the given pauli string. | +### pauli\_block -## Attributes + + +`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. + +### pauli\_evolution + +`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. + +## Attributes + + ### alpha @@ -121,13 +140,13 @@ The Pauli rotation factor (alpha). The Pauli rotation factor. - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -137,17 +156,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -161,17 +180,17 @@ Get the entanglement strategy. The entanglement strategy, see `get_entangler_map()` for more detail on how the format is interpreted. - + ### entanglement\_blocks - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### feature\_dimension @@ -185,19 +204,19 @@ Returns the feature dimension (which is equal to the number of qubits). The feature dimension of this feature map. - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -211,7 +230,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -225,13 +244,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -239,19 +258,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -265,7 +284,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -273,13 +292,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of distinct parameters. - + ### num\_qubits @@ -293,7 +312,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -323,7 +342,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -337,7 +356,7 @@ The parameter bounds for the unbound parameters in the circuit. A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded. - + ### parameters @@ -345,7 +364,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo `ParameterView` - + ### paulis @@ -359,7 +378,7 @@ The Pauli strings used in the entanglement of the qubits. The Pauli strings as list. - + ### preferred\_init\_points @@ -373,25 +392,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -405,7 +424,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -418,3 +437,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 d9b0420111f..8a71080853b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliGate.md @@ -1,8 +1,16 @@ -# PauliGate +--- +title: PauliGate +description: API reference for qiskit.circuit.library.PauliGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PauliGate +--- +# PauliGate + -`PauliGate(label)` +`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` @@ -23,32 +31,43 @@ Create a new gate. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`inverse`](qiskit.circuit.library.PauliGate.inverse#qiskit.circuit.library.PauliGate.inverse "qiskit.circuit.library.PauliGate.inverse") | Return inverted pauli gate (itself). | -| [`validate_parameter`](qiskit.circuit.library.PauliGate.validate_parameter#qiskit.circuit.library.PauliGate.validate_parameter "qiskit.circuit.library.PauliGate.validate_parameter") | Gate parameters should be int, float, or ParameterExpression | +### inverse -## Attributes + + +`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). + +### validate\_parameter + + + +`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 +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -58,14 +77,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 638b0f78ea0..cd786faf28e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PauliTwoDesign.md @@ -1,8 +1,16 @@ -# PauliTwoDesign +--- +title: PauliTwoDesign +description: API reference for qiskit.circuit.library.PauliTwoDesign +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PauliTwoDesign +--- +# PauliTwoDesign + -`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')` +`PauliTwoDesign(num_qubits=None, reps=3, seed=None, insert_barriers=False, name='PauliTwoDesign')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/pauli_two_design.py "view source code") Bases: `qiskit.circuit.library.n_local.two_local.TwoLocal` @@ -55,13 +63,13 @@ Construct a new two-local circuit. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -71,17 +79,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -95,7 +103,7 @@ Get the entanglement strategy. The entanglement strategy, see `get_entangler_map()` for more detail on how the format is interpreted. - + ### entanglement\_blocks @@ -109,25 +117,25 @@ The blocks in the entanglement layers. The blocks in the entanglement layers. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -141,7 +149,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -155,13 +163,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -169,19 +177,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -195,7 +203,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -203,7 +211,7 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable @@ -217,7 +225,7 @@ Return the number of settable parameters. The number of possibly distinct parameters. - + ### num\_qubits @@ -231,7 +239,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -261,7 +269,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -275,7 +283,7 @@ The parameter bounds for the unbound parameters in the circuit. A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded. - + ### parameters @@ -283,7 +291,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo `ParameterView` - + ### preferred\_init\_points @@ -297,25 +305,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -329,7 +337,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -342,3 +350,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 f69d0ffe963..23ec50e1d93 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Permutation.md @@ -1,8 +1,16 @@ -# Permutation +--- +title: Permutation +description: API reference for qiskit.circuit.library.Permutation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.Permutation +--- +# Permutation + -`Permutation(num_qubits, pattern=None, seed=None)` +`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` @@ -28,13 +36,13 @@ Return an n\_qubit permutation circuit implemented using SWAPs. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -44,13 +52,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -66,31 +74,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -98,44 +106,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 772c6a56acf..9a8009546db 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseEstimation.md @@ -1,8 +1,16 @@ -# PhaseEstimation +--- +title: PhaseEstimation +description: API reference for qiskit.circuit.library.PhaseEstimation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PhaseEstimation +--- +# PhaseEstimation + -`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')` +`PhaseEstimation(num_evaluation_qubits, unitary, iqft=None, name='QPE')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/phase_estimation.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -34,7 +42,7 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) * **num\_evaluation\_qubits** (`int`) – The number of evaluation qubits. * **unitary** (`QuantumCircuit`) – The unitary operation $U$ which will be repeated and controlled. -* **iqft** (`Optional`\[`QuantumCircuit`]) – A inverse Quantum Fourier Transform, per default the inverse of [`QFT`](qiskit.circuit.library.QFT#qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") is used. Note that the QFT should not include the usual swaps! +* **iqft** (`Optional`\[`QuantumCircuit`]) – A inverse Quantum Fourier Transform, per default the inverse of [`QFT`](qiskit.circuit.library.QFT "qiskit.circuit.library.QFT") is used. Note that the QFT should not include the usual swaps! * **name** (`str`) – The name of the circuit. @@ -45,13 +53,13 @@ Quantum Computation and Quantum Information: 10th Anniversary Edition (10th ed.) ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -61,13 +69,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -83,31 +91,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -115,44 +123,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 9fa4c56712d..fd53a6d8cab 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseGate.md @@ -1,8 +1,16 @@ -# PhaseGate +--- +title: PhaseGate +description: API reference for qiskit.circuit.library.PhaseGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PhaseGate +--- +# PhaseGate + -`PhaseGate(theta, label=None)` +`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` @@ -56,32 +64,57 @@ Create new Phase gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`control`](qiskit.circuit.library.PhaseGate.control#qiskit.circuit.library.PhaseGate.control "qiskit.circuit.library.PhaseGate.control") | Return a (multi-)controlled-Phase gate. | -| [`inverse`](qiskit.circuit.library.PhaseGate.inverse#qiskit.circuit.library.PhaseGate.inverse "qiskit.circuit.library.PhaseGate.inverse") | Return inverted Phase gate ($Phase(\lambda){\dagger} = Phase(-\lambda)$) | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + +`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)$) + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -91,14 +124,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 a8a5591f831..58771a39d73 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PhaseOracle.md @@ -1,8 +1,16 @@ -# PhaseOracle +--- +title: PhaseOracle +description: API reference for qiskit.circuit.library.PhaseOracle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PhaseOracle +--- +# PhaseOracle + -`PhaseOracle(expression, synthesizer=None)` +`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` @@ -23,20 +31,73 @@ Creates a PhaseOracle object ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [`evaluate_bitstring`](qiskit.circuit.library.PhaseOracle.evaluate_bitstring#qiskit.circuit.library.PhaseOracle.evaluate_bitstring "qiskit.circuit.library.PhaseOracle.evaluate_bitstring") | Evaluate the oracle on a bitstring. | -| [`from_dimacs_file`](qiskit.circuit.library.PhaseOracle.from_dimacs_file#qiskit.circuit.library.PhaseOracle.from_dimacs_file "qiskit.circuit.library.PhaseOracle.from_dimacs_file") | Create a PhaseOracle from the string in the DIMACS format. | +### evaluate\_bitstring -## Attributes + + +`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. + +**Parameters** + +**bitstring** (`str`) – The bitstring for which to evaluate. The input bitstring is expected to be in little-endian order. + +**Return type** + +`bool` + +**Returns** +True if the bitstring is a good state, False otherwise. +### from\_dimacs\_file + + + +`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. + +It is possible to build a PhaseOracle from a file in [DIMACS CNF format](http://www.satcompetition.org/2009/format-benchmarks2009.html), which is the standard format for specifying SATisfiability (SAT) problem instances in [Conjunctive Normal Form (CNF)](https://en.wikipedia.org/wiki/Conjunctive_normal_form), which is a conjunction of one or more clauses, where a clause is a disjunction of one or more literals. + +The following is an example of a CNF expressed in the DIMACS format: + +```python +c DIMACS CNF file with 3 satisfying assignments: 1 -2 3, -1 -2 -3, 1 2 -3. +p cnf 3 5 +-1 -2 -3 0 +1 -2 3 0 +1 2 -3 0 +1 -2 -3 0 +-1 2 3 0 +``` + +The first line, following the c character, is a comment. The second line specifies that the CNF is over three boolean variables — let us call them $x_1, x_2, x_3$, and contains five clauses. The five clauses, listed afterwards, are implicitly joined by the logical AND operator, $\land$, while the variables in each clause, represented by their indices, are implicitly disjoined by the logical OR operator, $lor$. The $-$ symbol preceding a boolean variable index corresponds to the logical NOT operator, $lnot$. Character 0 (zero) marks the end of each clause. Essentially, the code above corresponds to the following CNF: + +$(\lnot x_1 \lor \lnot x_2 \lor \lnot x_3) \land (x_1 \lor \lnot x_2 \lor x_3) \land (x_1 \lor x_2 \lor \lnot x_3) \land (x_1 \lor \lnot x_2 \lor \lnot x_3) \land (\lnot x_1 \lor x_2 \lor x_3)$. + +**Parameters** + +**filename** (`str`) – A file in DIMACS format. + +**Returns** + +A quantum circuit with a phase oracle. + +**Return type** + +[PhaseOracle](qiskit.circuit.library.PhaseOracle "qiskit.circuit.library.PhaseOracle") + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -46,13 +107,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -68,31 +129,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -100,44 +161,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 fa6bf921a57..5e67badd760 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseChebyshev.md @@ -1,8 +1,16 @@ -# PiecewiseChebyshev +--- +title: PiecewiseChebyshev +description: API reference for qiskit.circuit.library.PiecewiseChebyshev +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PiecewiseChebyshev +--- +# PiecewiseChebyshev + -`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')` +`PiecewiseChebyshev(f_x, degree=None, breakpoints=None, num_state_qubits=None, name='pw_cheb')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_chebyshev.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -45,13 +53,13 @@ Optimizing Quantum Circuits for Arithmetic. [arXiv:1805.12445](http://arxiv.org/ ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### breakpoints @@ -65,7 +73,7 @@ The breakpoints for the piecewise approximation. The breakpoints for the piecewise approximation. - + ### calibrations @@ -75,17 +83,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### degree @@ -99,13 +107,13 @@ The degree of the polynomials. The degree of the polynomials. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### f\_x @@ -119,25 +127,25 @@ The function to be approximated. The function to be approximated. - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -145,19 +153,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -165,13 +173,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -185,7 +193,7 @@ The number of state qubits representing the state $|x\rangle$. The number of state qubits. - + ### parameters @@ -193,7 +201,7 @@ The number of state qubits. `ParameterView` - + ### polynomials @@ -207,20 +215,21 @@ The polynomials for the piecewise approximation. The polynomials for the piecewise approximation. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 216e36f61e8..94a1cfd492e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewiseLinearPauliRotations.md @@ -1,8 +1,16 @@ -# PiecewiseLinearPauliRotations +--- +title: PiecewiseLinearPauliRotations +description: API reference for qiskit.circuit.library.PiecewiseLinearPauliRotations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PiecewiseLinearPauliRotations +--- +# PiecewiseLinearPauliRotations + -`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')` +`PiecewiseLinearPauliRotations(num_state_qubits=None, breakpoints=None, slopes=None, offsets=None, basis='Y', name='pw_lin')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_linear_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -32,19 +40,35 @@ Construct piecewise-linearly-controlled Pauli rotations. ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`evaluate`](qiskit.circuit.library.PiecewiseLinearPauliRotations.evaluate#qiskit.circuit.library.PiecewiseLinearPauliRotations.evaluate "qiskit.circuit.library.PiecewiseLinearPauliRotations.evaluate") | Classically evaluate the piecewise linear rotation. | +### evaluate -## Attributes + +`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. + +**Parameters** +**x** (`float`) – Value to be evaluated at. + +**Return type** + +`float` + +**Returns** + +Value of piecewise linear function at x. + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### basis @@ -60,7 +84,7 @@ Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotatio The kind of Pauli rotation used in controlled rotation. - + ### breakpoints @@ -72,7 +96,7 @@ The function is linear in the intervals `[point_i, point_{i+1}]` where the last `List`\[`int`] - + ### calibrations @@ -82,13 +106,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### contains\_zero\_breakpoint @@ -102,35 +126,35 @@ Whether 0 is the first breakpoint. True, if 0 is the first breakpoint, otherwise False. - + ### data - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### mapped\_offsets @@ -144,7 +168,7 @@ The offsets mapped to the internal representation. The mapped offsets. - + ### mapped\_slopes @@ -158,7 +182,7 @@ The slopes mapped to the internal representation. The mapped slopes. - + ### metadata @@ -166,25 +190,25 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits Deprecated. Use num\_ancillas instead. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -192,13 +216,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -212,7 +236,7 @@ The number of state qubits representing the state $|x\rangle$. The number of state qubits. - + ### offsets @@ -224,7 +248,7 @@ The function is linear in the intervals `[point_i, point_{i+1}]` where the last `List`\[`float`] - + ### parameters @@ -232,25 +256,25 @@ The function is linear in the intervals `[point_i, point_{i+1}]` where the last `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### slopes @@ -261,3 +285,4 @@ The function is linear in the intervals `[point_i, point_{i+1}]` where the last **Return type** `List`\[`int`] + 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 738f4c9502e..ffd57dd4534 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PiecewisePolynomialPauliRotations.md @@ -1,8 +1,16 @@ -# PiecewisePolynomialPauliRotations +--- +title: PiecewisePolynomialPauliRotations +description: API reference for qiskit.circuit.library.PiecewisePolynomialPauliRotations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PiecewisePolynomialPauliRotations +--- +# PiecewisePolynomialPauliRotations + -`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')` +`PiecewisePolynomialPauliRotations(num_state_qubits=None, breakpoints=None, coeffs=None, basis='Y', name='pw_poly')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/piecewise_polynomial_pauli_rotations.py "view source code") Bases: `qiskit.circuit.library.arithmetic.functional_pauli_rotations.FunctionalPauliRotations` @@ -76,19 +84,35 @@ Enhancing the Quantum Linear Systems Algorithm using Richardson Extrapolation. [ ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`evaluate`](qiskit.circuit.library.PiecewisePolynomialPauliRotations.evaluate#qiskit.circuit.library.PiecewisePolynomialPauliRotations.evaluate "qiskit.circuit.library.PiecewisePolynomialPauliRotations.evaluate") | Classically evaluate the piecewise polynomial rotation. | +### evaluate -## Attributes + + +`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. + +**Parameters** + +**x** (`float`) – Value to be evaluated at. + +**Return type** +`float` +**Returns** + +Value of piecewise polynomial function at x. + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### basis @@ -104,7 +128,7 @@ Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotatio The kind of Pauli rotation used in controlled rotation. - + ### breakpoints @@ -120,7 +144,7 @@ The function is polynomial in the intervals `[point_i, point_{i+1}]` where the l The list of breakpoints. - + ### calibrations @@ -130,13 +154,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### coeffs @@ -150,7 +174,7 @@ The coefficients of the polynomials. The polynomial coefficients per interval as nested lists. - + ### contains\_zero\_breakpoint @@ -164,35 +188,35 @@ Whether 0 is the first breakpoint. True, if 0 is the first breakpoint, otherwise False. - + ### data - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### mapped\_coeffs @@ -206,7 +230,7 @@ The coefficients mapped to the internal representation, since we only compare x> The mapped coefficients. - + ### metadata @@ -214,7 +238,7 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits @@ -228,19 +252,19 @@ The minimum number of ancilla qubits in the circuit. The minimal number of ancillas required. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -248,13 +272,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -268,7 +292,7 @@ The number of state qubits representing the state $|x\rangle$. The number of state qubits. - + ### parameters @@ -276,20 +300,21 @@ The number of state qubits. `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 a9ee56b5ba4..2ada624c39e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.PolynomialPauliRotations.md @@ -1,8 +1,16 @@ -# PolynomialPauliRotations +--- +title: PolynomialPauliRotations +description: API reference for qiskit.circuit.library.PolynomialPauliRotations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.PolynomialPauliRotations +--- +# PolynomialPauliRotations + -`PolynomialPauliRotations(num_state_qubits=None, coeffs=None, basis='Y', reverse=False, name='poly')` +`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` @@ -40,13 +48,13 @@ Prepare an approximation to a state with amplitudes specified by a polynomial. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### basis @@ -62,7 +70,7 @@ Set the basis to ‘X’, ‘Y’ or ‘Z’ for controlled-X, -Y, or -Z rotatio The kind of Pauli rotation used in controlled rotation. - + ### calibrations @@ -72,13 +80,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### coeffs @@ -94,11 +102,11 @@ The rotation angles are `slope * 2^0`, `slope * 2^1`, … , `slope * 2^(n-1)` wh The rotation angle common in all controlled rotations. - + ### data - + ### degree @@ -112,31 +120,31 @@ Return the degree of the polynomial, equals to the number of coefficients minus The degree of the polynomial. If the coefficients have not been set, return 0. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -144,25 +152,25 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits Deprecated. Use num\_ancillas instead. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -170,13 +178,13 @@ Return number of classical bits. `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -190,7 +198,7 @@ The number of state qubits representing the state $|x\rangle$. The number of state qubits. - + ### parameters @@ -198,25 +206,25 @@ The number of state qubits. `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reverse @@ -229,3 +237,4 @@ Whether to apply the rotations on the reversed list of qubits. **Returns** True, if the rotations are applied on the reversed list, False otherwise. + 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 1b807afb78a..4b91d7718de 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QAOAAnsatz.md @@ -1,8 +1,16 @@ -# QAOAAnsatz +--- +title: QAOAAnsatz +description: API reference for qiskit.circuit.library.QAOAAnsatz +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.QAOAAnsatz +--- +# QAOAAnsatz + -`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')` +`QAOAAnsatz(cost_operator=None, reps=1, initial_state=None, mixer_operator=None, name='QAOA')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/qaoa_ansatz.py "view source code") Bases: `qiskit.circuit.library.evolved_operator_ansatz.EvolvedOperatorAnsatz` @@ -16,21 +24,21 @@ A generalized QAOA quantum circuit with a support of custom initial states and m **Parameters** -* **cost\_operator** ([*OperatorBase*](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase")*, optional*) – The operator representing the cost of the optimization problem, denoted as $U(C, \gamma)$ in the original paper. Must be set either in the constructor or via property setter. +* **cost\_operator** ([*OperatorBase*](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase")*, optional*) – The operator representing the cost of the optimization problem, denoted as $U(C, \gamma)$ in the original paper. Must be set either in the constructor or via property setter. * **reps** (*int*) – The integer parameter p, which determines the depth of the circuit, as specified in the original paper, default is 1. -* **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, optional*) – An optional initial state to use. If None is passed then a set of Hadamard gates is applied as an initial state to all qubits. -* **mixer\_operator** ([*OperatorBase*](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, optional*) – An optional custom mixer to use instead of the global X-rotations, denoted as $U(B, \beta)$ in the original paper. Can be an operator or an optionally parameterized quantum circuit. +* **initial\_state** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, optional*) – An optional initial state to use. If None is passed then a set of Hadamard gates is applied as an initial state to all qubits. +* **mixer\_operator** ([*OperatorBase*](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*, optional*) – An optional custom mixer to use instead of the global X-rotations, denoted as $U(B, \beta)$ in the original paper. Can be an operator or an optionally parameterized quantum circuit. * **name** (*str*) – A name of the circuit, default ‘qaoa’ ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -40,13 +48,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### cost\_operator @@ -58,13 +66,13 @@ cost operator. **Return type** -[OperatorBase](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") - +[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") + ### data - + ### evolution @@ -76,27 +84,27 @@ The evolution converter used to compute the evolution. **Return type** -[EvolutionBase](qiskit.aqua.operators.evolutions.EvolutionBase#qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") - +[EvolutionBase](qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -106,13 +114,13 @@ Returns an optional initial state as a circuit `Optional`\[`QuantumCircuit`] - + ### instances `= 16` - + ### metadata @@ -120,7 +128,7 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### mixer\_operator @@ -132,21 +140,21 @@ mixer operator or circuit. **Return type** -[OperatorBase](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") or [QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), optional - +[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") or [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), optional + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -154,7 +162,7 @@ Return number of classical bits. `int` - + ### num\_qubits @@ -164,7 +172,7 @@ Return the number of qubits, specified by the size of the cost operator. `int` - + ### operators @@ -178,9 +186,9 @@ in this ansatz. **Return type** -List\[Union\[[OperatorBase](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase"), [QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")]] - +List\[Union\[[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase"), [QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")]] + ### parameter\_bounds @@ -194,11 +202,11 @@ an unbounded parameter in the corresponding direction. If None is returned, prob `List`\[`Tuple`\[`float`, `float`]] - + ### parameters -Get the [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. +Get the [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects in the circuit. **Return type** @@ -208,31 +216,31 @@ Get the [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit. A set containing the unbound circuit parameters. - + ### preferred\_init\_points Getter of preferred initial points based on the given initial state. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -241,3 +249,4 @@ Returns the reps parameter, which determines the depth of the circuit. **Return type** `int` + 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 75a50c8da42..932311cba70 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QFT.md @@ -1,8 +1,16 @@ -# QFT +--- +title: QFT +description: API reference for qiskit.circuit.library.QFT +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.QFT +--- +# QFT + -`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)` +`QFT(num_qubits=None, approximation_degree=0, do_swaps=True, inverse=False, insert_barriers=False, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/basis_change/qft.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -37,20 +45,47 @@ Construct a new QFT circuit. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`inverse`](qiskit.circuit.library.QFT.inverse#qiskit.circuit.library.QFT.inverse "qiskit.circuit.library.QFT.inverse") | Invert this circuit. | -| [`is_inverse`](qiskit.circuit.library.QFT.is_inverse#qiskit.circuit.library.QFT.is_inverse "qiskit.circuit.library.QFT.is_inverse") | Whether the inverse Fourier transform is implemented. | +### inverse -## Attributes + + +`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. + +**Return type** + +`QFT` + +**Returns** + +The inverted circuit. +### is\_inverse + + +`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. + +**Return type** + +`bool` + +**Returns** + +True, if the inverse Fourier transform is implemented, False otherwise. + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### approximation\_degree @@ -64,7 +99,7 @@ The approximation degree of the QFT. The currently set approximation degree. - + ### calibrations @@ -74,17 +109,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### do\_swaps @@ -98,25 +133,25 @@ Whether the final swaps of the QFT are applied or not. True, if the final swaps are applied, False if not. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### insert\_barriers @@ -130,13 +165,13 @@ Whether barriers are inserted for better visualization or not. True, if barriers are inserted, False if not. - + ### instances `= 16` - + ### metadata @@ -144,19 +179,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -164,7 +199,7 @@ Return number of classical bits. `int` - + ### num\_qubits @@ -182,7 +217,7 @@ The number of qubits in the circuit. This method needs to be overwritten to allow adding the setter for num\_qubits while still complying to pylint. - + ### parameters @@ -190,20 +225,21 @@ The number of qubits in the circuit. `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 4ce6f862b28..c99fa9a8b13 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QuadraticForm.md @@ -1,8 +1,16 @@ -# QuadraticForm +--- +title: QuadraticForm +description: API reference for qiskit.circuit.library.QuadraticForm +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.QuadraticForm +--- +# QuadraticForm + -`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)` +`QuadraticForm(num_result_qubits=None, quadratic=None, linear=None, offset=None, little_endian=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/quadratic_form.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -49,19 +57,37 @@ The implementation of this circuit is discussed in \[1], Fig. 6. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`required_result_qubits`](qiskit.circuit.library.QuadraticForm.required_result_qubits#qiskit.circuit.library.QuadraticForm.required_result_qubits "qiskit.circuit.library.QuadraticForm.required_result_qubits") | Get the number of required result qubits. | +### required\_result\_qubits -## Attributes + + +`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. + +**Parameters** + +* **quadratic** (`Union`\[`ndarray`, `List`\[`List`\[`float`]]]) – A matrix containing the quadratic coefficients. +* **linear** (`Union`\[`ndarray`, `List`\[`float`]]) – An array containing the linear coefficients. +* **offset** (`float`) – A constant offset. +**Return type** + +`int` + +**Returns** +The number of qubits needed to represent the value of the quadratic form in twos complement. + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -71,13 +97,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -93,31 +119,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -125,44 +151,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 17589fb02be..772c0116d6b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.QuantumVolume.md @@ -1,8 +1,16 @@ -# QuantumVolume +--- +title: QuantumVolume +description: API reference for qiskit.circuit.library.QuantumVolume +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.QuantumVolume +--- +# QuantumVolume + -`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)` +`QuantumVolume(num_qubits, depth=None, seed=None, classical_permutation=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/quantum_volume.py "view source code") Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit` @@ -33,13 +41,13 @@ Create quantum volume model circuit of size num\_qubits x depth. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -49,13 +57,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -71,31 +79,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -103,44 +111,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 7a8e0855cc6..0e3f7bac634 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RC3XGate.md @@ -1,8 +1,16 @@ -# RC3XGate +--- +title: RC3XGate +description: API reference for qiskit.circuit.library.RC3XGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RC3XGate +--- +# RC3XGate + -`RC3XGate(label=None)` +`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` @@ -16,25 +24,25 @@ Create a new RC3X gate. ## Attributes - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -44,14 +52,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 8aec0047b5e..0db3218bc97 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RCCXGate.md @@ -1,8 +1,16 @@ -# RCCXGate +--- +title: RCCXGate +description: API reference for qiskit.circuit.library.RCCXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RCCXGate +--- +# RCCXGate + -`RCCXGate(label=None)` +`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` @@ -16,25 +24,25 @@ Create a new simplified CCX gate. ## Attributes - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -44,14 +52,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 3273bc10276..eab5fe55fe1 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RGQFTMultiplier.md @@ -1,8 +1,16 @@ -# RGQFTMultiplier +--- +title: RGQFTMultiplier +description: API reference for qiskit.circuit.library.RGQFTMultiplier +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RGQFTMultiplier +--- +# RGQFTMultiplier + -`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')` +`RGQFTMultiplier(num_state_qubits, num_result_qubits=None, name='RGQFTMultiplier')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/multipliers/rg_qft_multiplier.py "view source code") Bases: `qiskit.circuit.library.arithmetic.multipliers.multiplier.Multiplier` @@ -37,13 +45,13 @@ out_1: ┤1 ├─────────■────────── ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -53,13 +61,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -75,31 +83,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -107,31 +115,31 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### num\_result\_qubits @@ -145,7 +153,7 @@ The number of result qubits to limit the output to. The number of result qubits. - + ### num\_state\_qubits @@ -159,20 +167,21 @@ The number of state qubits, i.e. the number of bits in each input register. The number of state qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 f76720cc12c..6e023f33c0f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RGate.md @@ -1,8 +1,16 @@ -# RGate +--- +title: RGate +description: API reference for qiskit.circuit.library.RGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RGate +--- +# RGate + -`RGate(theta, phi)` +`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` @@ -30,31 +38,37 @@ Create new r single-qubit gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------- | -| [`inverse`](qiskit.circuit.library.RGate.inverse#qiskit.circuit.library.RGate.inverse "qiskit.circuit.library.RGate.inverse") | Invert this gate. | +### inverse -## Attributes + + +`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. + +r(θ, φ)^dagger = r(-θ, φ) + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -64,14 +78,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 654a2cb42d7..128c18dcf46 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RVGate.md @@ -1,8 +1,16 @@ -# RVGate +--- +title: RVGate +description: API reference for qiskit.circuit.library.RVGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RVGate +--- +# RVGate + -`RVGate(v_x, v_y, v_z, basis='U')` +`RVGate(v_x, v_y, v_z, basis='U')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/rv.py "view source code") Bases: `qiskit.circuit.gate.Gate` @@ -39,32 +47,43 @@ Create new rv single-qubit gate. ## Methods Defined Here -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`inverse`](qiskit.circuit.library.RVGate.inverse#qiskit.circuit.library.RVGate.inverse "qiskit.circuit.library.RVGate.inverse") | Invert this gate. | -| [`to_matrix`](qiskit.circuit.library.RVGate.to_matrix#qiskit.circuit.library.RVGate.to_matrix "qiskit.circuit.library.RVGate.to_matrix") | Return a numpy.array for the R(v) gate. | +### inverse -## Attributes + + +`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. + +### to\_matrix + + + +`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. +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -74,14 +93,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 321339be72c..2b46955c44e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RXGate.md @@ -1,8 +1,16 @@ -# RXGate +--- +title: RXGate +description: API reference for qiskit.circuit.library.RXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RXGate +--- +# RXGate + -`RXGate(theta, label=None)` +`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` @@ -30,32 +38,59 @@ Create new RX gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`control`](qiskit.circuit.library.RXGate.control#qiskit.circuit.library.RXGate.control "qiskit.circuit.library.RXGate.control") | Return a (multi-)controlled-RX gate. | -| [`inverse`](qiskit.circuit.library.RXGate.inverse#qiskit.circuit.library.RXGate.inverse "qiskit.circuit.library.RXGate.inverse") | Return inverted RX gate. | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + +`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. + +$RX(\lambda)^{\dagger} = RX(-\lambda)$ + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -65,14 +100,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 ff40d8e4736..ef77affdaac 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RXXGate.md @@ -1,8 +1,16 @@ -# RXXGate +--- +title: RXXGate +description: API reference for qiskit.circuit.library.RXXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RXXGate +--- +# RXXGate + -`RXXGate(theta)` +`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` @@ -56,31 +64,35 @@ Create new RXX gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.RXXGate.inverse#qiskit.circuit.library.RXXGate.inverse "qiskit.circuit.library.RXXGate.inverse") | Return inverse RXX gate (i.e. | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -90,14 +102,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 b221a639a2a..2f2035eae69 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RYGate.md @@ -1,8 +1,16 @@ -# RYGate +--- +title: RYGate +description: API reference for qiskit.circuit.library.RYGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RYGate +--- +# RYGate + -`RYGate(theta, label=None)` +`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` @@ -30,32 +38,59 @@ Create new RY gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`control`](qiskit.circuit.library.RYGate.control#qiskit.circuit.library.RYGate.control "qiskit.circuit.library.RYGate.control") | Return a (multi-)controlled-RY gate. | -| [`inverse`](qiskit.circuit.library.RYGate.inverse#qiskit.circuit.library.RYGate.inverse "qiskit.circuit.library.RYGate.inverse") | Return inverted RY gate. | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + +`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. + +$RY(\lambda){\dagger} = RY(-\lambda)$ + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -65,14 +100,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 a08ceb4da85..fa44339fb50 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RYYGate.md @@ -1,8 +1,16 @@ -# RYYGate +--- +title: RYYGate +description: API reference for qiskit.circuit.library.RYYGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RYYGate +--- +# RYYGate + -`RYYGate(theta)` +`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` @@ -56,31 +64,35 @@ Create new RYY gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.RYYGate.inverse#qiskit.circuit.library.RYYGate.inverse "qiskit.circuit.library.RYYGate.inverse") | Return inverse RYY gate (i.e. | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -90,14 +102,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 1262da5465f..e8244085f6b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZGate.md @@ -1,8 +1,16 @@ -# RZGate +--- +title: RZGate +description: API reference for qiskit.circuit.library.RZGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RZGate +--- +# RZGate + -`RZGate(phi, label=None)` +`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` @@ -42,32 +50,59 @@ Create new RZ gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`control`](qiskit.circuit.library.RZGate.control#qiskit.circuit.library.RZGate.control "qiskit.circuit.library.RZGate.control") | Return a (multi-)controlled-RZ gate. | -| [`inverse`](qiskit.circuit.library.RZGate.inverse#qiskit.circuit.library.RZGate.inverse "qiskit.circuit.library.RZGate.inverse") | Return inverted RZ gate | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + +`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 + +$RZ(\lambda){\dagger} = RZ(-\lambda)$ + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -77,14 +112,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 487a8f9be9a..4cfbee61b1f 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZXGate.md @@ -1,8 +1,16 @@ -# RZXGate +--- +title: RZXGate +description: API reference for qiskit.circuit.library.RZXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RZXGate +--- +# RZXGate + -`RZXGate(theta)` +`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` @@ -94,31 +102,35 @@ Create new RZX gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.RZXGate.inverse#qiskit.circuit.library.RZXGate.inverse "qiskit.circuit.library.RZXGate.inverse") | Return inverse RZX gate (i.e. | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -128,14 +140,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 8ec3e51c8d2..d38c6c1667b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RZZGate.md @@ -1,8 +1,16 @@ -# RZZGate +--- +title: RZZGate +description: API reference for qiskit.circuit.library.RZZGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RZZGate +--- +# RZZGate + -`RZZGate(theta)` +`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` @@ -68,31 +76,35 @@ Create new RZZ gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.RZZGate.inverse#qiskit.circuit.library.RZZGate.inverse "qiskit.circuit.library.RZZGate.inverse") | Return inverse RZZ gate (i.e. | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -102,14 +114,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 39f7023c114..033b2ec851b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.RealAmplitudes.md @@ -1,8 +1,16 @@ -# RealAmplitudes +--- +title: RealAmplitudes +description: API reference for qiskit.circuit.library.RealAmplitudes +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.RealAmplitudes +--- +# 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')` +`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` @@ -22,7 +30,7 @@ For example a `RealAmplitudes` circuit with 2 repetitions on 3 qubits with `'ful └──────────┘ ░ └───┘└───┘ ░ └──────────┘ ░ └───┘└───┘ ░ └──────────┘ ``` -The entanglement can be set using the `entanglement` keyword as string or a list of index-pairs. See the documentation of [`TwoLocal`](qiskit.circuit.library.TwoLocal#qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") and `NLocal` for more detail. Additional options that can be set include the number of repetitions, skipping rotation gates on qubits that are not entangled, leaving out the final rotation layer and inserting barriers in between the rotation and entanglement layers. +The entanglement can be set using the `entanglement` keyword as string or a list of index-pairs. See the documentation of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") and `NLocal` for more detail. Additional options that can be set include the number of repetitions, skipping rotation gates on qubits that are not entangled, leaving out the final rotation layer and inserting barriers in between the rotation and entanglement layers. If some qubits are not entangled with other qubits it makes sense to not apply rotation gates on these qubits, since a sequence of $Y$ rotations can be reduced to a single $Y$ rotation with summed rotation angles. @@ -89,23 +97,23 @@ Create a new RealAmplitudes 2-local circuit. * **num\_qubits** (`Optional`\[`int`]) – The number of qubits of the RealAmplitudes circuit. * **reps** (`int`) – Specifies how often the structure of a rotation layer followed by an entanglement layer is repeated. -* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal#qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. +* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Can be a string (‘full’, ‘linear’ or ‘sca’), a list of integer-pairs specifying the indices of qubits entangled with one another, or a callable returning such a list provided with the index of the entanglement layer. See the Examples section of [`TwoLocal`](qiskit.circuit.library.TwoLocal "qiskit.circuit.library.TwoLocal") for more detail. * **initial\_state** (`Optional`\[`Any`]) – A QuantumCircuit object to prepend to the circuit. * **skip\_unentangled\_qubits** (`bool`) – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. * **skip\_unentangled\_qubits** – If True, the single qubit gates are only applied to qubits that are entangled with another qubit. If False, the single qubit gates are applied to each qubit in the Ansatz. Defaults to False. * **skip\_final\_rotation\_layer** (`bool`) – If False, a rotation layer is added at the end of the ansatz. If True, no rotation layer is added. -* **parameter\_prefix** (`str`) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector#qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). +* **parameter\_prefix** (`str`) – The parameterized gates require a parameter to be defined, for which we use [`ParameterVector`](qiskit.circuit.ParameterVector "qiskit.circuit.ParameterVector"). * **insert\_barriers** (`bool`) – If True, barriers are inserted in between each layer. If False, no barriers are inserted. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -115,17 +123,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -139,7 +147,7 @@ Get the entanglement strategy. The entanglement strategy, see `get_entangler_map()` for more detail on how the format is interpreted. - + ### entanglement\_blocks @@ -153,25 +161,25 @@ The blocks in the entanglement layers. The blocks in the entanglement layers. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -185,7 +193,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -199,13 +207,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -213,19 +221,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -239,7 +247,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -247,13 +255,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of total parameters that can be set to distinct values. -This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. +This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. **Return type** @@ -267,7 +275,7 @@ The number of parameters originally available in the circuit. This quantity does not require the circuit to be built yet. - + ### num\_qubits @@ -281,7 +289,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -311,7 +319,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -325,7 +333,7 @@ Return the parameter bounds. The parameter bounds. - + ### parameters @@ -333,7 +341,7 @@ The parameter bounds. `ParameterView` - + ### preferred\_init\_points @@ -347,25 +355,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -379,7 +387,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -392,3 +400,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 239e43d63c2..c20563ec423 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.Reset.md @@ -1,8 +1,16 @@ -# Reset +--- +title: Reset +description: API reference for qiskit.circuit.library.Reset +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.Reset +--- +# Reset + -`Reset` +`Reset`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/reset.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -12,31 +20,48 @@ Create new reset instruction. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`broadcast_arguments`](qiskit.circuit.library.Reset.broadcast_arguments#qiskit.circuit.library.Reset.broadcast_arguments "qiskit.circuit.library.Reset.broadcast_arguments") | Validation of the arguments. | +### broadcast\_arguments -## Attributes + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. +**Raises** +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -46,14 +71,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 bf763b9305e..c6a7b1e06cd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SGate.md @@ -1,8 +1,16 @@ -# SGate +--- +title: SGate +description: API reference for qiskit.circuit.library.SGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.SGate +--- +# SGate + -`SGate(label=None)` +`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` @@ -35,31 +43,35 @@ Create new S gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`inverse`](qiskit.circuit.library.SGate.inverse#qiskit.circuit.library.SGate.inverse "qiskit.circuit.library.SGate.inverse") | Return inverse of S (SdgGate). | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +81,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 3a77a7b975e..c657f0ee852 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SXGate.md @@ -1,8 +1,16 @@ -# SXGate +--- +title: SXGate +description: API reference for qiskit.circuit.library.SXGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.SXGate +--- +# SXGate + -`SXGate(label=None)` +`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` @@ -41,32 +49,59 @@ Create new SX gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`control`](qiskit.circuit.library.SXGate.control#qiskit.circuit.library.SXGate.control "qiskit.circuit.library.SXGate.control") | Return a (multi-)controlled-SX gate. | -| [`inverse`](qiskit.circuit.library.SXGate.inverse#qiskit.circuit.library.SXGate.inverse "qiskit.circuit.library.SXGate.inverse") | Return inverse SX gate (i.e. | +### control -## Attributes + + +`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. + +One control returns a CSX gate. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + + +`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). + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -76,14 +111,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 f95fbd8112f..a829101a023 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SXdgGate.md @@ -1,8 +1,16 @@ -# SXdgGate +--- +title: SXdgGate +description: API reference for qiskit.circuit.library.SXdgGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.SXdgGate +--- +# SXdgGate + -`SXdgGate(label=None)` +`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` @@ -31,31 +39,35 @@ Create new SXdg gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`inverse`](qiskit.circuit.library.SXdgGate.inverse#qiskit.circuit.library.SXdgGate.inverse "qiskit.circuit.library.SXdgGate.inverse") | Return inverse SXdg gate (i.e. | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -65,14 +77,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 c25d49889b6..d913f0e62cd 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SdgGate.md @@ -1,8 +1,16 @@ -# SdgGate +--- +title: SdgGate +description: API reference for qiskit.circuit.library.SdgGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.SdgGate +--- +# SdgGate + -`SdgGate(label=None)` +`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` @@ -35,31 +43,35 @@ Create new Sdg gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`inverse`](qiskit.circuit.library.SdgGate.inverse#qiskit.circuit.library.SdgGate.inverse "qiskit.circuit.library.SdgGate.inverse") | Return inverse of Sdg (SGate). | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +81,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 c8b51a6183e..f11d7eb6216 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.SwapGate.md @@ -1,8 +1,16 @@ -# SwapGate +--- +title: SwapGate +description: API reference for qiskit.circuit.library.SwapGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.SwapGate +--- +# SwapGate + -`SwapGate(label=None)` +`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` @@ -40,32 +48,59 @@ Create new SWAP gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`control`](qiskit.circuit.library.SwapGate.control#qiskit.circuit.library.SwapGate.control "qiskit.circuit.library.SwapGate.control") | Return a (multi-)controlled-SWAP gate. | -| [`inverse`](qiskit.circuit.library.SwapGate.inverse#qiskit.circuit.library.SwapGate.inverse "qiskit.circuit.library.SwapGate.inverse") | Return inverse Swap gate (itself). | +### control -## Attributes + + +`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. + +One control returns a CSWAP (Fredkin) gate. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + + +`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). + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -75,14 +110,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 a5c877e2330..b8035708015 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TGate.md @@ -1,8 +1,16 @@ -# TGate +--- +title: TGate +description: API reference for qiskit.circuit.library.TGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.TGate +--- +# TGate + -`TGate(label=None)` +`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` @@ -35,31 +43,35 @@ Create new T gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------- | -| [`inverse`](qiskit.circuit.library.TGate.inverse#qiskit.circuit.library.TGate.inverse "qiskit.circuit.library.TGate.inverse") | Return inverse T gate (i.e. | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +81,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 ad8b5f35b6c..d03585524b0 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TdgGate.md @@ -1,8 +1,16 @@ -# TdgGate +--- +title: TdgGate +description: API reference for qiskit.circuit.library.TdgGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.TdgGate +--- +# TdgGate + -`TdgGate(label=None)` +`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` @@ -35,31 +43,35 @@ Create new Tdg gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`inverse`](qiskit.circuit.library.TdgGate.inverse#qiskit.circuit.library.TdgGate.inverse "qiskit.circuit.library.TdgGate.inverse") | Return inverse Tdg gate (i.e. | +### inverse -## Attributes + +`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). + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +81,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 14fad2123f2..c52df06971b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.TwoLocal.md @@ -1,8 +1,16 @@ -# TwoLocal +--- +title: TwoLocal +description: API reference for qiskit.circuit.library.TwoLocal +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.TwoLocal +--- +# TwoLocal + -`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')` +`TwoLocal(num_qubits=None, rotation_blocks=None, entanglement_blocks=None, entanglement='full', reps=3, skip_unentangled_qubits=False, skip_final_rotation_layer=False, parameter_prefix='θ', insert_barriers=False, initial_state=None, name='TwoLocal')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/n_local/two_local.py "view source code") Bases: `qiskit.circuit.library.n_local.n_local.NLocal` @@ -120,19 +128,27 @@ Construct a new two-local circuit. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- | -| [`get_entangler_map`](qiskit.circuit.library.TwoLocal.get_entangler_map#qiskit.circuit.library.TwoLocal.get_entangler_map "qiskit.circuit.library.TwoLocal.get_entangler_map") | Overloading to handle the special case of 1 qubit where the entanglement are ignored. | +### get\_entangler\_map -## Attributes + + +`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. +**Return type** + +`List`\[`List`\[`int`]] +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -142,17 +158,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -164,9 +180,9 @@ Get the entanglement strategy. **Returns** -The entanglement strategy, see [`get_entangler_map()`](qiskit.circuit.library.TwoLocal.get_entangler_map#qiskit.circuit.library.TwoLocal.get_entangler_map "qiskit.circuit.library.TwoLocal.get_entangler_map") for more detail on how the format is interpreted. - +The entanglement strategy, see [`get_entangler_map()`](qiskit.circuit.library.TwoLocal#get_entangler_map "qiskit.circuit.library.TwoLocal.get_entangler_map") for more detail on how the format is interpreted. + ### entanglement\_blocks @@ -180,25 +196,25 @@ The blocks in the entanglement layers. The blocks in the entanglement layers. - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -212,7 +228,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -226,13 +242,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -240,19 +256,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -266,7 +282,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -274,13 +290,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of total parameters that can be set to distinct values. -This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. +This does not change when the parameters are bound or exchanged for same parameters, and therefore is different from `num_parameters` which counts the number of unique [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") objects currently in the circuit. **Return type** @@ -294,7 +310,7 @@ The number of parameters originally available in the circuit. This quantity does not require the circuit to be built yet. - + ### num\_qubits @@ -308,7 +324,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -338,7 +354,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -352,7 +368,7 @@ The parameter bounds for the unbound parameters in the circuit. A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded. - + ### parameters @@ -360,7 +376,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo `ParameterView` - + ### preferred\_init\_points @@ -374,25 +390,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -406,7 +422,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -419,3 +435,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 9692bfe7601..4f10c56dc2b 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U1Gate.md @@ -1,8 +1,16 @@ -# U1Gate +--- +title: U1Gate +description: API reference for qiskit.circuit.library.U1Gate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.U1Gate +--- +# U1Gate + -`U1Gate(theta, label=None)` +`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` @@ -58,32 +66,57 @@ Create new U1 gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| [`control`](qiskit.circuit.library.U1Gate.control#qiskit.circuit.library.U1Gate.control "qiskit.circuit.library.U1Gate.control") | Return a (multi-)controlled-U1 gate. | -| [`inverse`](qiskit.circuit.library.U1Gate.inverse#qiskit.circuit.library.U1Gate.inverse "qiskit.circuit.library.U1Gate.inverse") | Return inverted U1 gate ($U1(\lambda){\dagger} = U1(-\lambda)$) | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + +`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)$) + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -93,14 +126,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 981d3699a02..a9e5a1e7145 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U2Gate.md @@ -1,8 +1,16 @@ -# U2Gate +--- +title: U2Gate +description: API reference for qiskit.circuit.library.U2Gate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.U2Gate +--- +# U2Gate + -`U2Gate(phi, lam, label=None)` +`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` @@ -48,31 +56,37 @@ Create new U2 gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | -| [`inverse`](qiskit.circuit.library.U2Gate.inverse#qiskit.circuit.library.U2Gate.inverse "qiskit.circuit.library.U2Gate.inverse") | Return inverted U2 gate. | +### inverse -## Attributes + + +`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. + +$U2(\phi, \lambda)^{\dagger} =U2(-\lambda-\pi, -\phi+\pi)$) + +## Attributes + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -82,14 +96,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 55836ef2671..d908894c93e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.U3Gate.md @@ -1,8 +1,16 @@ -# U3Gate +--- +title: U3Gate +description: API reference for qiskit.circuit.library.U3Gate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.U3Gate +--- +# U3Gate + -`U3Gate(theta, phi, lam, label=None)` +`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` @@ -47,32 +55,59 @@ Create new U3 gate. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`control`](qiskit.circuit.library.U3Gate.control#qiskit.circuit.library.U3Gate.control "qiskit.circuit.library.U3Gate.control") | Return a (multi-)controlled-U3 gate. | -| [`inverse`](qiskit.circuit.library.U3Gate.inverse#qiskit.circuit.library.U3Gate.inverse "qiskit.circuit.library.U3Gate.inverse") | Return inverted U3 gate. | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + +`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. + +$U3(\theta,\phi,\lambda)^{\dagger} =U3(-\theta,-\lambda,-\phi)$) + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -82,14 +117,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 e1fbe1cbd77..09a37c12208 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.UGate.md @@ -1,8 +1,16 @@ -# UGate +--- +title: UGate +description: API reference for qiskit.circuit.library.UGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.UGate +--- +# UGate + -`UGate(theta, phi, lam, label=None)` +`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` @@ -47,32 +55,59 @@ Create new U gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`control`](qiskit.circuit.library.UGate.control#qiskit.circuit.library.UGate.control "qiskit.circuit.library.UGate.control") | Return a (multi-)controlled-U gate. | -| [`inverse`](qiskit.circuit.library.UGate.inverse#qiskit.circuit.library.UGate.inverse "qiskit.circuit.library.UGate.inverse") | Return inverted U gate. | +### control -## Attributes + + +`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. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** + +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + +`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. + +$U(\theta,\phi,\lambda)^{\dagger} =U(-\theta,-\lambda,-\phi)$) + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -82,14 +117,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 36cdb2bcf5e..5ea992beacc 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.UniformDistribution.md @@ -1,8 +1,16 @@ -# UniformDistribution +--- +title: UniformDistribution +description: API reference for qiskit.circuit.library.UniformDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.UniformDistribution +--- +# UniformDistribution + -`UniformDistribution(num_qubits, name='P(X)')` +`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` @@ -43,13 +51,13 @@ q_2: ┤ H ├ ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -59,13 +67,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -81,31 +89,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -113,44 +121,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 076abe895f9..25157118440 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.VBERippleCarryAdder.md @@ -1,8 +1,16 @@ -# VBERippleCarryAdder +--- +title: VBERippleCarryAdder +description: API reference for qiskit.circuit.library.VBERippleCarryAdder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.VBERippleCarryAdder +--- +# VBERippleCarryAdder + -`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')` +`VBERippleCarryAdder(num_state_qubits, kind='full', name='VBERippleCarryAdder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/adders/vbe_ripple_carry_adder.py "view source code") Bases: `qiskit.circuit.library.arithmetic.adders.adder.Adder` @@ -46,13 +54,13 @@ Here *Carry* and *Sum* gates correspond to the gates introduced in \[1]. *Carry\ ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -62,13 +70,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -84,31 +92,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -116,31 +124,31 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -154,20 +162,21 @@ The number of state qubits, i.e. the number of bits in each input register. The number of state qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 c4222b33dce..7d5b28937ca 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.WeightedAdder.md @@ -1,8 +1,16 @@ -# WeightedAdder +--- +title: WeightedAdder +description: API reference for qiskit.circuit.library.WeightedAdder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.WeightedAdder +--- +# WeightedAdder + -`WeightedAdder(num_state_qubits=None, weights=None, name='adder')` +`WeightedAdder(num_state_qubits=None, weights=None, name='adder')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/arithmetic/weighted_adder.py "view source code") Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` @@ -59,13 +67,13 @@ Computes the weighted sum controlled by state qubits. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -75,41 +83,41 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -117,7 +125,7 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancilla\_qubits @@ -127,13 +135,13 @@ Deprecated. Use num\_ancillas instead. `int` - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_carry\_qubits @@ -149,13 +157,13 @@ Note that this is not necessarily equal to the number of ancilla qubits, these c The number of carry qubits required to compute the sum. - + ### num\_clbits Return number of classical bits. - + ### num\_control\_qubits @@ -171,7 +179,7 @@ Note that the total number of ancilla qubits can be obtained by calling the meth The number of additional control qubits required (0 or 1). - + ### num\_parameters @@ -179,13 +187,13 @@ The number of additional control qubits required (0 or 1). `int` - + ### num\_qubits Return number of qubits. - + ### num\_state\_qubits @@ -199,7 +207,7 @@ The number of qubits to be summed. The number of state qubits. - + ### num\_sum\_qubits @@ -213,7 +221,7 @@ The number of sum qubits in the circuit. The number of qubits needed to represent the weighted sum of the qubits. - + ### parameters @@ -221,25 +229,25 @@ The number of qubits needed to represent the weighted sum of the qubits. `ParameterView` - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### weights @@ -252,3 +260,4 @@ The weights for the qubit states. **Returns** The weight for the qubit states. + 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 542597d97e1..f18f5ae21b2 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.XGate.md @@ -1,8 +1,16 @@ -# XGate +--- +title: XGate +description: API reference for qiskit.circuit.library.XGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.XGate +--- +# XGate + -`XGate(label=None)` +`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` @@ -50,32 +58,59 @@ Create new X gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`control`](qiskit.circuit.library.XGate.control#qiskit.circuit.library.XGate.control "qiskit.circuit.library.XGate.control") | Return a (multi-)controlled-X gate. | -| [`inverse`](qiskit.circuit.library.XGate.inverse#qiskit.circuit.library.XGate.inverse "qiskit.circuit.library.XGate.inverse") | Return inverted X gate (itself). | +### control -## Attributes + + +`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. + +One control returns a CX gate. Two controls returns a CCX gate. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + + +`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). + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -85,14 +120,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 d88448c01e4..43e734f066e 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.XOR.md @@ -1,8 +1,16 @@ -# XOR +--- +title: XOR +description: API reference for qiskit.circuit.library.XOR +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.XOR +--- +# XOR + -`XOR(num_qubits, amount=None, seed=None)` +`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` @@ -28,13 +36,13 @@ Return a circuit implementing bitwise xor. ## Attributes - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -44,13 +52,13 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data @@ -66,31 +74,31 @@ Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is QuantumCircuitData - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -98,44 +106,45 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters Convenience function to get the number of parameter objects in the circuit. - + ### num\_qubits Return number of qubits. - + ### parameters Convenience function to get the parameters defined in the parameter table. - + ### prefix `= 'circuit'` - + ### qubits Returns a list of quantum bits in the order that the registers were added. + 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 27c28537816..21f9a64cd0c 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.YGate.md @@ -1,8 +1,16 @@ -# YGate +--- +title: YGate +description: API reference for qiskit.circuit.library.YGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.YGate +--- +# YGate + -`YGate(label=None)` +`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` @@ -50,32 +58,59 @@ Create new Y gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| [`control`](qiskit.circuit.library.YGate.control#qiskit.circuit.library.YGate.control "qiskit.circuit.library.YGate.control") | Return a (multi-)controlled-Y gate. | -| [`inverse`](qiskit.circuit.library.YGate.inverse#qiskit.circuit.library.YGate.inverse "qiskit.circuit.library.YGate.inverse") | Return inverted Y gate ($Y{\dagger} = Y$) | +### control -## Attributes + + +`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. + +One control returns a CY gate. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + + +`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$) + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -85,14 +120,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 2d279b00b94..13f02319422 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZFeatureMap.md @@ -1,8 +1,16 @@ -# ZFeatureMap +--- +title: ZFeatureMap +description: API reference for qiskit.circuit.library.ZFeatureMap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.ZFeatureMap +--- +# ZFeatureMap + -`ZFeatureMap(feature_dimension, reps=2, data_map_func=None, insert_barriers=False, name='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") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` @@ -20,7 +28,7 @@ On 3 qubits and with 2 repetitions the circuit is represented by: └───┘└──────────────┘└───┘└──────────────┘ ``` -This is a sub-class of [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap#qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap") where the Pauli strings are fixed as \[‘Z’]. As a result the first order expansion will be a circuit without entangling gates. +This is a sub-class of [`PauliFeatureMap`](qiskit.circuit.library.PauliFeatureMap "qiskit.circuit.library.PauliFeatureMap") where the Pauli strings are fixed as \[‘Z’]. As a result the first order expansion will be a circuit without entangling gates. ## Examples @@ -72,7 +80,7 @@ Create a new first-order Pauli-Z expansion circuit. ## Attributes - + ### alpha @@ -86,13 +94,13 @@ The Pauli rotation factor (alpha). The Pauli rotation factor. - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -102,17 +110,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -126,17 +134,17 @@ Get the entanglement strategy. The entanglement strategy, see `get_entangler_map()` for more detail on how the format is interpreted. - + ### entanglement\_blocks - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### feature\_dimension @@ -150,19 +158,19 @@ Returns the feature dimension (which is equal to the number of qubits). The feature dimension of this feature map. - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -176,7 +184,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -190,13 +198,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -204,19 +212,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -230,7 +238,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -238,13 +246,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of distinct parameters. - + ### num\_qubits @@ -258,7 +266,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -288,7 +296,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -302,7 +310,7 @@ The parameter bounds for the unbound parameters in the circuit. A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded. - + ### parameters @@ -310,7 +318,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo `ParameterView` - + ### paulis @@ -324,7 +332,7 @@ The Pauli strings used in the entanglement of the qubits. The Pauli strings as list. - + ### preferred\_init\_points @@ -338,25 +346,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -370,7 +378,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -383,3 +391,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 5c19b4ab65b..d1e1747e332 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZGate.md @@ -1,8 +1,16 @@ -# ZGate +--- +title: ZGate +description: API reference for qiskit.circuit.library.ZGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.ZGate +--- +# ZGate + -`ZGate(label=None)` +`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` @@ -50,32 +58,59 @@ Create new Z gate. ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`control`](qiskit.circuit.library.ZGate.control#qiskit.circuit.library.ZGate.control "qiskit.circuit.library.ZGate.control") | Return a (multi-)controlled-Z gate. | -| [`inverse`](qiskit.circuit.library.ZGate.inverse#qiskit.circuit.library.ZGate.inverse "qiskit.circuit.library.ZGate.inverse") | Return inverted Z gate (itself). | +### control -## Attributes + + +`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. + +One control returns a CZ gate. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of control qubits. +* **label** (*str or None*) – An optional label for the gate \[Default: None] +* **ctrl\_state** (*int or str or None*) – control state expressed as integer, string (e.g. ‘110’), or None. If None, use all 1s. + +**Returns** + +controlled version of this gate. + +**Return type** +[ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") +### inverse + + + +`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). + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -85,14 +120,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 0abd1911b03..897610289c7 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.ZZFeatureMap.md @@ -1,8 +1,16 @@ -# ZZFeatureMap +--- +title: ZZFeatureMap +description: API reference for qiskit.circuit.library.ZZFeatureMap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.ZZFeatureMap +--- +# ZZFeatureMap + -`ZZFeatureMap(feature_dimension, reps=2, entanglement='full', data_map_func=None, insert_barriers=False, name='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") Bases: `qiskit.circuit.library.data_preparation.pauli_feature_map.PauliFeatureMap` @@ -53,7 +61,7 @@ Create a new second-order Pauli-Z expansion. * **feature\_dimension** (`int`) – Number of features. * **reps** (`int`) – The number of repeated circuits, has a min. value of 1. -* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Refer to [`NLocal`](qiskit.circuit.library.NLocal#qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal") for detail. +* **entanglement** (`Union`\[`str`, `List`\[`List`\[`int`]], `Callable`\[\[`int`], `List`\[`int`]]]) – Specifies the entanglement structure. Refer to [`NLocal`](qiskit.circuit.library.NLocal "qiskit.circuit.library.NLocal") for detail. * **data\_map\_func** (`Optional`\[`Callable`\[\[`ndarray`], `float`]]) – A mapping function for data x. * **insert\_barriers** (`bool`) – If True, barriers are inserted in between the evolution instructions and hadamard layers. @@ -63,7 +71,7 @@ Create a new second-order Pauli-Z expansion. ## Attributes - + ### alpha @@ -77,13 +85,13 @@ The Pauli rotation factor (alpha). The Pauli rotation factor. - + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -93,17 +101,17 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### entanglement @@ -117,17 +125,17 @@ Get the entanglement strategy. The entanglement strategy, see `get_entangler_map()` for more detail on how the format is interpreted. - + ### entanglement\_blocks - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### feature\_dimension @@ -141,19 +149,19 @@ Returns the feature dimension (which is equal to the number of qubits). The feature dimension of this feature map. - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### initial\_state @@ -167,7 +175,7 @@ Return the initial state that is added in front of the n-local circuit. The initial state. - + ### insert\_barriers @@ -181,13 +189,13 @@ If barriers are inserted in between the layers or not. True, if barriers are inserted in between the layers, False if not. - + ### instances `= 16` - + ### metadata @@ -195,19 +203,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_layers @@ -221,7 +229,7 @@ Return the number of layers in the n-local circuit. The number of layers in the circuit. - + ### num\_parameters @@ -229,13 +237,13 @@ The number of layers in the circuit. `int` - + ### num\_parameters\_settable The number of distinct parameters. - + ### num\_qubits @@ -249,7 +257,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -279,7 +287,7 @@ q_0: ┤ Ry(1) ├┤ Ry(θ[1]) ├┤ Ry(θ[1]) ├┤ Ry(θ[3]) ├ The parameters objects used in the circuit. - + ### parameter\_bounds @@ -293,7 +301,7 @@ The parameter bounds for the unbound parameters in the circuit. A list of pairs indicating the bounds, as (lower, upper). None indicates an unbounded parameter in the corresponding direction. If None is returned, problem is fully unbounded. - + ### parameters @@ -301,7 +309,7 @@ A list of pairs indicating the bounds, as (lower, upper). None indicates an unbo `ParameterView` - + ### paulis @@ -315,7 +323,7 @@ The Pauli strings used in the entanglement of the qubits. The Pauli strings as list. - + ### preferred\_init\_points @@ -329,25 +337,25 @@ The initial points for the parameters. Can be stored as initial guess in optimiz The initial values for the parameters, or None, if none have been set. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. - + ### reps @@ -361,7 +369,7 @@ The number of times rotation and entanglement block are repeated. The number of repetitions. - + ### rotation\_blocks @@ -374,3 +382,4 @@ The blocks in the rotation layers. **Returns** The blocks in the rotation layers. + 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 73e396c3bb5..42cf538c532 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_2\_1 +--- +title: clifford_2_1 +description: API reference for qiskit.circuit.library.clifford_2_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_2_1 +--- +# qiskit.circuit.library.clifford\_2\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 6da64935ef2..5bf66e9f98c 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_2\_2 +--- +title: clifford_2_2 +description: API reference for qiskit.circuit.library.clifford_2_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_2_2 +--- +# qiskit.circuit.library.clifford\_2\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 ca963c1d512..927f19fa200 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_2\_3 +--- +title: clifford_2_3 +description: API reference for qiskit.circuit.library.clifford_2_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_2_3 +--- +# qiskit.circuit.library.clifford\_2\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 e2795393298..8b16e2825d6 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_2\_4 +--- +title: clifford_2_4 +description: API reference for qiskit.circuit.library.clifford_2_4 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_2_4 +--- +# qiskit.circuit.library.clifford\_2\_4 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 fef43d4f371..2c09082d230 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_3\_1 +--- +title: clifford_3_1 +description: API reference for qiskit.circuit.library.clifford_3_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_3_1 +--- +# qiskit.circuit.library.clifford\_3\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 ccccb5953de..07b3612de9c 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_4\_1 +--- +title: clifford_4_1 +description: API reference for qiskit.circuit.library.clifford_4_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_4_1 +--- +# qiskit.circuit.library.clifford\_4\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 45f2f8e5ba4..36856209e49 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_4\_2 +--- +title: clifford_4_2 +description: API reference for qiskit.circuit.library.clifford_4_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_4_2 +--- +# qiskit.circuit.library.clifford\_4\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 8d2b1bd18bf..d0f5a22555e 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_4\_3 +--- +title: clifford_4_3 +description: API reference for qiskit.circuit.library.clifford_4_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_4_3 +--- +# qiskit.circuit.library.clifford\_4\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 cc3c24e662e..57ae97f2a84 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_4\_4 +--- +title: clifford_4_4 +description: API reference for qiskit.circuit.library.clifford_4_4 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_4_4 +--- +# qiskit.circuit.library.clifford\_4\_4 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 db63eaf61b1..570f78364e6 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_5\_1 +--- +title: clifford_5_1 +description: API reference for qiskit.circuit.library.clifford_5_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_5_1 +--- +# qiskit.circuit.library.clifford\_5\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 ad1420da98d..a9b3cb55224 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_6\_1 +--- +title: clifford_6_1 +description: API reference for qiskit.circuit.library.clifford_6_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_6_1 +--- +# qiskit.circuit.library.clifford\_6\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 d3f8664a475..0a9966bb05d 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_6\_2 +--- +title: clifford_6_2 +description: API reference for qiskit.circuit.library.clifford_6_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_6_2 +--- +# qiskit.circuit.library.clifford\_6\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 0636da1445c..c979ff290d7 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_6\_3 +--- +title: clifford_6_3 +description: API reference for qiskit.circuit.library.clifford_6_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_6_3 +--- +# qiskit.circuit.library.clifford\_6\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 c29ebb73ce9..e48a68c9e45 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_6\_4 +--- +title: clifford_6_4 +description: API reference for qiskit.circuit.library.clifford_6_4 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_6_4 +--- +# qiskit.circuit.library.clifford\_6\_4 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 df11ecdaa11..69364d28f8d 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_6\_5 +--- +title: clifford_6_5 +description: API reference for qiskit.circuit.library.clifford_6_5 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_6_5 +--- +# qiskit.circuit.library.clifford\_6\_5 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 efc9fe779cf..4e11397bbef 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_8\_1 +--- +title: clifford_8_1 +description: API reference for qiskit.circuit.library.clifford_8_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_8_1 +--- +# qiskit.circuit.library.clifford\_8\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 a68fe4ef5ca..0485bc05efe 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_8\_2 +--- +title: clifford_8_2 +description: API reference for qiskit.circuit.library.clifford_8_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_8_2 +--- +# qiskit.circuit.library.clifford\_8\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 4458cd8704c..feaaa81f23c 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.clifford\_8\_3 +--- +title: clifford_8_3 +description: API reference for qiskit.circuit.library.clifford_8_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.clifford_8_3 +--- +# qiskit.circuit.library.clifford\_8\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 e2afb2c7e9c..6b4367232a1 100644 --- a/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.md +++ b/docs/api/qiskit/0.32/qiskit.circuit.library.iSwapGate.md @@ -1,8 +1,16 @@ -# iSwapGate +--- +title: iSwapGate +description: API reference for qiskit.circuit.library.iSwapGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.circuit.library.iSwapGate +--- +# iSwapGate + -`iSwapGate` +`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` @@ -63,25 +71,25 @@ Create new iSwap gate. ## Attributes - + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -91,14 +99,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 d2b3c5eaa22..bae210512c6 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 @@ -1,7 +1,16 @@ -# qiskit.circuit.library.rzx\_cy +--- +title: rzx_cy +description: API reference for qiskit.circuit.library.rzx_cy +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.rzx_cy +--- +# qiskit.circuit.library.rzx\_cy + -`rzx_cy(theta=None)` +`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 ed5f1e6b97e..6111e4b6d65 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 @@ -1,7 +1,16 @@ -# qiskit.circuit.library.rzx\_xz +--- +title: rzx_xz +description: API reference for qiskit.circuit.library.rzx_xz +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.rzx_xz +--- +# qiskit.circuit.library.rzx\_xz + -`rzx_xz(theta=None)` +`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 e990ab3e451..f5feb56c245 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 @@ -1,7 +1,16 @@ -# qiskit.circuit.library.rzx\_yz +--- +title: rzx_yz +description: API reference for qiskit.circuit.library.rzx_yz +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.rzx_yz +--- +# qiskit.circuit.library.rzx\_yz + -`rzx_yz(theta=None)` +`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 2791b27b390..f8a2218bc4b 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 @@ -1,7 +1,16 @@ -# qiskit.circuit.library.rzx\_zz1 +--- +title: rzx_zz1 +description: API reference for qiskit.circuit.library.rzx_zz1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.rzx_zz1 +--- +# qiskit.circuit.library.rzx\_zz1 + -`rzx_zz1(theta=None)` +`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 f424f5bbde7..d4d76d03eb4 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 @@ -1,7 +1,16 @@ -# qiskit.circuit.library.rzx\_zz2 +--- +title: rzx_zz2 +description: API reference for qiskit.circuit.library.rzx_zz2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.rzx_zz2 +--- +# qiskit.circuit.library.rzx\_zz2 + -`rzx_zz2(theta=None)` +`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 43af1931f3e..9ab0e123a91 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 @@ -1,7 +1,16 @@ -# qiskit.circuit.library.rzx\_zz3 +--- +title: rzx_zz3 +description: API reference for qiskit.circuit.library.rzx_zz3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.rzx_zz3 +--- +# qiskit.circuit.library.rzx\_zz3 + -`rzx_zz3(theta=None)` +`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 74d0c17491f..fccc60c5901 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_2a\_1 +--- +title: template_nct_2a_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_2a_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_2a\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 7493108c2eb..bc9dfac625c 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_2a\_2 +--- +title: template_nct_2a_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_2a_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_2a\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 fd57cdc727e..9a0f1d6e2e0 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_2a\_3 +--- +title: template_nct_2a_3 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_2a_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_2a_3 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_2a\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 c0efc1d49bb..a099d56f93c 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_4a\_1 +--- +title: template_nct_4a_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_4a_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_4a\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 4d9024300b9..199b0ba73fb 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_4a\_2 +--- +title: template_nct_4a_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_4a_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_4a\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 a1819adff2e..d8f119d2cde 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_4a\_3 +--- +title: template_nct_4a_3 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_4a_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_4a_3 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_4a\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 18f0b743418..645f993d038 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_4b\_1 +--- +title: template_nct_4b_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_4b_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_4b\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 0be93528f3a..b29f66cbbd3 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_4b\_2 +--- +title: template_nct_4b_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_4b_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_4b_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_4b\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 40a377a83d6..cdfab95456d 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_1 +--- +title: template_nct_5a_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_5a_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 7484a4745bd..42e44c71ccb 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_2 +--- +title: template_nct_5a_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_5a_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 5926c6fed94..f2bf2fb8ffd 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_3 +--- +title: template_nct_5a_3 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_5a_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_3 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 b87c62d5605..f5857f8be6d 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_5a\_4 +--- +title: template_nct_5a_4 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_5a_4 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_5a_4 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_5a\_4 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 83da931c82c..54d796c48ea 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_1 +--- +title: template_nct_6a_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_6a_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 bb7e198c961..497c7f651c8 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_2 +--- +title: template_nct_6a_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_6a_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 b577ebd4dbe..05dd1473bf2 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_3 +--- +title: template_nct_6a_3 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_6a_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_3 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 51085a29032..bf4346c45e9 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_6a\_4 +--- +title: template_nct_6a_4 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_6a_4 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_6a_4 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_6a\_4 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 f09da2ffb40..143ce700b60 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_6b\_1 +--- +title: template_nct_6b_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_6b_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_6b\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 936c6351e19..bddea475821 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_6b\_2 +--- +title: template_nct_6b_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_6b_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_6b_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_6b\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 3d7ffa12c17..1d23abdcba1 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_6c\_1 +--- +title: template_nct_6c_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_6c_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_6c_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_6c\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 dacfe383756..5e04b1587b2 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_7a\_1 +--- +title: template_nct_7a_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_7a_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_7a_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_7a\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 4b61dc612fe..7f827c64901 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_7b\_1 +--- +title: template_nct_7b_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_7b_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_7b_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_7b\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 43ae4fa8a38..5fd5601a5c9 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_7c\_1 +--- +title: template_nct_7c_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_7c_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_7c_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_7c\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 55d52696cfc..c8b3b9b383b 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_7d\_1 +--- +title: template_nct_7d_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_7d_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_7d_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_7d\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 b9c118f793c..5e36d6a1208 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_7e\_1 +--- +title: template_nct_7e_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_7e_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_7e_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_7e\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 974c24f0200..1340401a8c0 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9a\_1 +--- +title: template_nct_9a_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9a_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9a_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9a\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 3c7a2015417..7d6a80af75b 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_1 +--- +title: template_nct_9c_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 3f3d24553f4..9d72c54ca1a 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_10 +--- +title: template_nct_9c_10 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_10 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_10 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_10 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 0cd2f995e08..cfb20db8ead 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_11 +--- +title: template_nct_9c_11 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_11 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_11 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_11 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 6608fc4214a..8f053052c41 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_12 +--- +title: template_nct_9c_12 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_12 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_12 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_12 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 0ff52ce9af8..0dbc8a78f8c 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_2 +--- +title: template_nct_9c_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 16fe62d521c..767dfc0dc71 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_3 +--- +title: template_nct_9c_3 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_3 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 7cb0ea0123f..fbf1fac3a16 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_4 +--- +title: template_nct_9c_4 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_4 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_4 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_4 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 f1ec2c4f081..e00e9a09031 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_5 +--- +title: template_nct_9c_5 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_5 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_5 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_5 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 91f2c310996..51fafdebc96 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_6 +--- +title: template_nct_9c_6 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_6 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_6 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_6 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 b29e22e3a46..7c6acba7de7 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_7 +--- +title: template_nct_9c_7 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_7 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_7 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_7 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 46df4d0f92a..23417772375 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_8 +--- +title: template_nct_9c_8 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_8 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_8 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_8 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 e7cae915b4a..1f41755ea0a 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9c\_9 +--- +title: template_nct_9c_9 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9c_9 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9c_9 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9c\_9 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 cdfc817c58f..f66ad8c3ec1 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_1 +--- +title: template_nct_9d_1 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_1 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_1 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 cdc9d36d52f..42e65f18b74 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_10 +--- +title: template_nct_9d_10 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_10 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_10 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_10 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 27e1fd7dd61..dcdd118e19e 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_2 +--- +title: template_nct_9d_2 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_2 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_2 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 6b759f35cc8..2eae01bb124 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_3 +--- +title: template_nct_9d_3 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_3 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_3 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 8433044c8f2..4038dc3d507 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_4 +--- +title: template_nct_9d_4 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_4 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_4 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_4 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 d6a39ddf098..705eded25a9 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_5 +--- +title: template_nct_9d_5 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_5 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_5 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_5 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 0db9085948f..4c845969dab 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_6 +--- +title: template_nct_9d_6 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_6 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_6 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_6 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 8f8567ce083..d55538e6a62 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_7 +--- +title: template_nct_9d_7 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_7 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_7 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_7 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 5679f0ec3f9..4865ff7af80 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_8 +--- +title: template_nct_9d_8 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_8 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_8 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_8 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 8a85edf5e48..03d25edc1ff 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.library.templates.nct.template\_nct\_9d\_9 +--- +title: template_nct_9d_9 +description: API reference for qiskit.circuit.library.templates.nct.template_nct_9d_9 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.library.templates.nct.template_nct_9d_9 +--- +# qiskit.circuit.library.templates.nct.template\_nct\_9d\_9 + -`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") **Returns** @@ -10,4 +18,5 @@ template as a quantum circuit. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 29cceee5ad5..6e832dbf55e 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.qpy\_serialization.dump +--- +title: dump +description: API reference for qiskit.circuit.qpy_serialization.dump +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.qpy_serialization.dump +--- +# qiskit.circuit.qpy\_serialization.dump + -`dump(circuits, file_obj)` +`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 @@ -40,5 +48,6 @@ Which will save the qpy serialized circuit to the provided file. **Parameters** -* **circuits** (*list or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit object(s) to store in the specified file like object. This can either be a single QuantumCircuit object or a list of QuantumCircuits. +* **circuits** (*list or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit object(s) to store in the specified file like object. This can either be a single QuantumCircuit object or a list of QuantumCircuits. * **file\_obj** (*file*) – The file like object to write the QPY data too + 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 5ba675e46f5..5df021c72c7 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 @@ -1,12 +1,20 @@ -# qiskit.circuit.qpy\_serialization.load +--- +title: load +description: API reference for qiskit.circuit.qpy_serialization.load +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.qpy_serialization.load +--- +# qiskit.circuit.qpy\_serialization.load + -`load(file_obj)` +`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 -This function is used to load a serialized QPY circuit file and create [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects from its contents. For example: +This function is used to load a serialized QPY circuit file and create [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects from its contents. For example: ```python from qiskit.circuit import qpy_serialization @@ -25,7 +33,7 @@ with gzip.open('bell.qpy.gz', 'rb') as fd: circuits = qpy_serialization.load(fd) ``` -which will read the contents of the qpy and return a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects from the file. +which will read the contents of the qpy and return a list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects from the file. **Parameters** @@ -35,7 +43,7 @@ which will read the contents of the qpy and return a list of [`QuantumCircuit`]( **List of `QuantumCircuit`** -The list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects contained in the QPY data. A list is always returned, even if there is only 1 circuit in the QPY data. +The list of [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects contained in the QPY data. A list is always returned, even if there is only 1 circuit in the QPY data. **Return type** @@ -44,3 +52,4 @@ list **Raises** **QiskitError** – if `file_obj` is not a valid QPY 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 483f1756b5f..a18ffe33b88 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 @@ -1,8 +1,16 @@ -# qiskit.circuit.random.random\_circuit +--- +title: random_circuit +description: API reference for qiskit.circuit.random.random_circuit +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.circuit.random.random_circuit +--- +# qiskit.circuit.random.random\_circuit + -`random_circuit(num_qubits, depth, max_operands=3, measure=False, conditional=False, reset=False, seed=None)` +`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. @@ -33,8 +41,9 @@ constructed circuit **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **CircuitError** – when invalid options given + diff --git a/docs/api/qiskit/0.32/qiskit.compiler.assemble.md b/docs/api/qiskit/0.32/qiskit.compiler.assemble.md index f8eaa5fbd28..5ca3ef24c10 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.assemble.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.assemble.md @@ -1,8 +1,16 @@ -# qiskit.compiler.assemble +--- +title: assemble +description: API reference for qiskit.compiler.assemble +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.compiler.assemble +--- +# 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)` +`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`. @@ -73,7 +81,7 @@ NOTE: Backend.options is not used within assemble. The required values (previous **Return type** -[`Qobj`](qiskit.qobj.Qobj#qiskit.qobj.Qobj "qiskit.qobj.Qobj") +[`Qobj`](qiskit.qobj.Qobj "qiskit.qobj.Qobj") **Returns** @@ -82,3 +90,4 @@ A `Qobj` that can be run on a backend. Depending on the type of input, this will **Raises** **QiskitError** – if the input cannot be interpreted as either circuits or schedules + diff --git a/docs/api/qiskit/0.32/qiskit.compiler.schedule.md b/docs/api/qiskit/0.32/qiskit.compiler.schedule.md index e6eeeb733c3..8e7a6cffa9f 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.schedule.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.schedule.md @@ -1,8 +1,16 @@ -# qiskit.compiler.schedule +--- +title: schedule +description: API reference for qiskit.compiler.schedule +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.compiler.schedule +--- +# qiskit.compiler.schedule + -`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)` +`schedule(circuits, backend=None, inst_map=None, meas_map=None, dt=None, method=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.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"). @@ -26,3 +34,4 @@ A pulse `Schedule` that implements the input circuit **Raises** **QiskitError** – If `inst_map` and `meas_map` are not passed and `backend` is not passed + diff --git a/docs/api/qiskit/0.32/qiskit.compiler.sequence.md b/docs/api/qiskit/0.32/qiskit.compiler.sequence.md index d1437877488..5bfaf303b8b 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.sequence.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.sequence.md @@ -1,8 +1,16 @@ -# qiskit.compiler.sequence +--- +title: sequence +description: API reference for qiskit.compiler.sequence +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.compiler.sequence +--- +# qiskit.compiler.sequence + -`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)` +`sequence(scheduled_circuits, backend=None, inst_map=None, meas_map=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/compiler/sequencer.py "view source code") Schedule a scheduled circuit to a pulse `Schedule`, using the backend. @@ -25,3 +33,4 @@ A pulse `Schedule` that implements the input circuit **Raises** **QiskitError** – If `inst_map` and `meas_map` are not passed and `backend` is not passed + diff --git a/docs/api/qiskit/0.32/qiskit.compiler.transpile.md b/docs/api/qiskit/0.32/qiskit.compiler.transpile.md index ffa623be596..3102cf09b2e 100644 --- a/docs/api/qiskit/0.32/qiskit.compiler.transpile.md +++ b/docs/api/qiskit/0.32/qiskit.compiler.transpile.md @@ -1,8 +1,16 @@ -# qiskit.compiler.transpile +--- +title: transpile +description: API reference for qiskit.compiler.transpile +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.compiler.transpile +--- +# 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)` +`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. @@ -127,4 +135,5 @@ The transpiled circuit(s). **Raises** -[**TranspilerError**](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – in case of bad inputs to transpiler (like conflicting parameters) or errors in passes +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – in case of bad inputs to transpiler (like conflicting parameters) or errors in passes + 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 0d9537a38be..7dde3742cad 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 @@ -1,8 +1,16 @@ -# qiskit.converters.ast\_to\_dag +--- +title: ast_to_dag +description: API reference for qiskit.converters.ast_to_dag +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.ast_to_dag +--- +# qiskit.converters.ast\_to\_dag + -`ast_to_dag(ast)` +`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. @@ -16,7 +24,7 @@ the DAG representing an OpenQASM’s AST **Return type** -[DAGCircuit](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") **Raises** @@ -44,3 +52,4 @@ dag_drawer(dag) ``` ![../\_images/qiskit.converters.ast\_to\_dag\_0\_0.png](/images/api/qiskit/0.32/qiskit.converters.ast_to_dag_0_0.png) + 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 35f342044e8..07532527e1e 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 @@ -1,14 +1,22 @@ -# qiskit.converters.circuit\_to\_dag +--- +title: circuit_to_dag +description: API reference for qiskit.converters.circuit_to_dag +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.circuit_to_dag +--- +# qiskit.converters.circuit\_to\_dag + -`circuit_to_dag(circuit)` +`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`. **Parameters** -**circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. +**circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. **Returns** @@ -16,7 +24,7 @@ the DAG representing the input circuit. **Return type** -[DAGCircuit](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") ## Example @@ -39,3 +47,4 @@ dag_drawer(dag) ``` ![../\_images/qiskit.converters.circuit\_to\_dag\_0\_0.png](/images/api/qiskit/0.32/qiskit.converters.circuit_to_dag_0_0.png) + 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 12f46adc09e..15a315afab9 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 @@ -1,14 +1,22 @@ -# qiskit.converters.circuit\_to\_dagdependency +--- +title: circuit_to_dagdependency +description: API reference for qiskit.converters.circuit_to_dagdependency +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.circuit_to_dagdependency +--- +# qiskit.converters.circuit\_to\_dagdependency + -`circuit_to_dagdependency(circuit)` +`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`. **Parameters** -**circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuits. +**circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuits. **Returns** @@ -16,4 +24,5 @@ the DAG representing the input circuit as a dag dependency. **Return type** -[DAGDependency](qiskit.dagcircuit.DAGDependency#qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") +[DAGDependency](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") + 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 7f48e45618c..9ec3011bd18 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 @@ -1,8 +1,16 @@ -# qiskit.converters.circuit\_to\_gate +--- +title: circuit_to_gate +description: API reference for qiskit.converters.circuit_to_gate +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.circuit_to_gate +--- +# qiskit.converters.circuit\_to\_gate + -`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)` +`circuit_to_gate(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_gate.py "view source code") Build a `Gate` object from a `QuantumCircuit`. @@ -10,9 +18,9 @@ The gate is anonymous (not tied to a named quantum register), and so can be inse **Parameters** -* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. * **parameter\_map** (*dict*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If None, existing circuit parameters will also parameterize the Gate. -* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – Optional equivalence library where the converted gate will be registered. +* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – Optional equivalence library where the converted gate will be registered. * **label** (*str*) – Optional gate label. **Raises** @@ -25,4 +33,5 @@ a Gate equivalent to the action of the input circuit. Upon decomposition, this g **Return type** -[Gate](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate") +[Gate](qiskit.circuit.Gate "qiskit.circuit.Gate") + 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 d92476a6510..612e96b1528 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 @@ -1,8 +1,16 @@ -# qiskit.converters.circuit\_to\_instruction +--- +title: circuit_to_instruction +description: API reference for qiskit.converters.circuit_to_instruction +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.circuit_to_instruction +--- +# qiskit.converters.circuit\_to\_instruction + -`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)` +`circuit_to_instruction(circuit, parameter_map=None, equivalence_library=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/converters/circuit_to_instruction.py "view source code") Build an `Instruction` object from a `QuantumCircuit`. @@ -10,9 +18,9 @@ The instruction is anonymous (not tied to a named quantum register), and so can **Parameters** -* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the input circuit. * **parameter\_map** (*dict*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. -* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – Optional equivalence library where the converted instruction will be registered. +* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – Optional equivalence library where the converted instruction will be registered. * **label** (*str*) – Optional instruction label. **Raises** @@ -25,7 +33,7 @@ an instruction equivalent to the action of the input circuit. Upon decomposition **Return type** -[qiskit.circuit.Instruction](qiskit.circuit.Instruction#qiskit.circuit.Instruction "qiskit.circuit.Instruction") +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") ## Example @@ -47,3 +55,4 @@ circuit_to_instruction(circ) ```python ``` + 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 c09eff09535..9f5a1de142f 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 @@ -1,14 +1,22 @@ -# qiskit.converters.dag\_to\_circuit +--- +title: dag_to_circuit +description: API reference for qiskit.converters.dag_to_circuit +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.dag_to_circuit +--- +# qiskit.converters.dag\_to\_circuit + -`dag_to_circuit(dag)` +`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`. **Parameters** -**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the input dag. +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the input dag. **Returns** @@ -16,7 +24,7 @@ the circuit representing the input dag. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") ## Example @@ -51,3 +59,4 @@ q_2: ───────────╫──────╫───── c: 3/═══════════╩═══╡ = 2 ╞══ 0 └─────┘ ``` + 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 bc90c986e93..1659bc658dd 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 @@ -1,14 +1,22 @@ -# qiskit.converters.dag\_to\_dagdependency +--- +title: dag_to_dagdependency +description: API reference for qiskit.converters.dag_to_dagdependency +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.dag_to_dagdependency +--- +# qiskit.converters.dag\_to\_dagdependency + -`dag_to_dagdependency(dag)` +`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`. **Parameters** -**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the input dag. +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the input dag. **Returns** @@ -16,4 +24,5 @@ the DAG representing the input circuit as a dag dependency. **Return type** -[DAGDependency](qiskit.dagcircuit.DAGDependency#qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") +[DAGDependency](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency") + 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 5f10038a079..8bc14e76d3b 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 @@ -1,14 +1,22 @@ -# qiskit.converters.dagdependency\_to\_circuit +--- +title: dagdependency_to_circuit +description: API reference for qiskit.converters.dagdependency_to_circuit +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.dagdependency_to_circuit +--- +# qiskit.converters.dagdependency\_to\_circuit + -`dagdependency_to_circuit(dagdependency)` +`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`. **Parameters** -**dagdependency** ([*DAGDependency*](qiskit.dagcircuit.DAGDependency#qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")) – the input dag. +**dagdependency** ([*DAGDependency*](qiskit.dagcircuit.DAGDependency "qiskit.dagcircuit.DAGDependency")) – the input dag. **Returns** @@ -16,4 +24,5 @@ the circuit representing the input dag dependency. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 feda8abe910..340e3d702ef 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 @@ -1,8 +1,16 @@ -# qiskit.converters.dagdependency\_to\_dag +--- +title: dagdependency_to_dag +description: API reference for qiskit.converters.dagdependency_to_dag +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.converters.dagdependency_to_dag +--- +# qiskit.converters.dagdependency\_to\_dag + -`dagdependency_to_dag(dagdependency)` +`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`. @@ -16,4 +24,5 @@ the DAG representing the input circuit. **Return type** -[DAGCircuit](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md index 975a2852579..494a5dfc982 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuit.md @@ -1,8 +1,16 @@ -# DAGCircuit +--- +title: DAGCircuit +description: API reference for qiskit.dagcircuit.DAGCircuit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.dagcircuit.DAGCircuit +--- +# DAGCircuit + -`DAGCircuit` +`DAGCircuit`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") Bases: `object` @@ -14,74 +22,761 @@ Create an empty circuit. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add_calibration`](qiskit.dagcircuit.DAGCircuit.add_calibration#qiskit.dagcircuit.DAGCircuit.add_calibration "qiskit.dagcircuit.DAGCircuit.add_calibration") | Register a low-level, custom pulse definition for the given gate. | -| [`add_clbits`](qiskit.dagcircuit.DAGCircuit.add_clbits#qiskit.dagcircuit.DAGCircuit.add_clbits "qiskit.dagcircuit.DAGCircuit.add_clbits") | Add individual clbit wires. | -| [`add_creg`](qiskit.dagcircuit.DAGCircuit.add_creg#qiskit.dagcircuit.DAGCircuit.add_creg "qiskit.dagcircuit.DAGCircuit.add_creg") | Add all wires in a classical register. | -| [`add_qreg`](qiskit.dagcircuit.DAGCircuit.add_qreg#qiskit.dagcircuit.DAGCircuit.add_qreg "qiskit.dagcircuit.DAGCircuit.add_qreg") | Add all wires in a quantum register. | -| [`add_qubits`](qiskit.dagcircuit.DAGCircuit.add_qubits#qiskit.dagcircuit.DAGCircuit.add_qubits "qiskit.dagcircuit.DAGCircuit.add_qubits") | Add individual qubit wires. | -| [`ancestors`](qiskit.dagcircuit.DAGCircuit.ancestors#qiskit.dagcircuit.DAGCircuit.ancestors "qiskit.dagcircuit.DAGCircuit.ancestors") | Returns set of the ancestors of a node as DAGNodes. | -| [`apply_operation_back`](qiskit.dagcircuit.DAGCircuit.apply_operation_back#qiskit.dagcircuit.DAGCircuit.apply_operation_back "qiskit.dagcircuit.DAGCircuit.apply_operation_back") | Apply an operation to the output of the circuit. | -| [`apply_operation_front`](qiskit.dagcircuit.DAGCircuit.apply_operation_front#qiskit.dagcircuit.DAGCircuit.apply_operation_front "qiskit.dagcircuit.DAGCircuit.apply_operation_front") | Apply an operation to the input of the circuit. | -| [`bfs_successors`](qiskit.dagcircuit.DAGCircuit.bfs_successors#qiskit.dagcircuit.DAGCircuit.bfs_successors "qiskit.dagcircuit.DAGCircuit.bfs_successors") | Returns an iterator of tuples of (DAGNode, \[DAGNodes]) where the DAGNode is the current node and \[DAGNode] is its successors in BFS order. | -| [`collect_1q_runs`](qiskit.dagcircuit.DAGCircuit.collect_1q_runs#qiskit.dagcircuit.DAGCircuit.collect_1q_runs "qiskit.dagcircuit.DAGCircuit.collect_1q_runs") | Return a set of non-conditional runs of 1q “op” nodes. | -| [`collect_runs`](qiskit.dagcircuit.DAGCircuit.collect_runs#qiskit.dagcircuit.DAGCircuit.collect_runs "qiskit.dagcircuit.DAGCircuit.collect_runs") | Return a set of non-conditional runs of “op” nodes with the given names. | -| [`compose`](qiskit.dagcircuit.DAGCircuit.compose#qiskit.dagcircuit.DAGCircuit.compose "qiskit.dagcircuit.DAGCircuit.compose") | Compose the `other` circuit onto the output of this circuit. | -| [`compose_back`](qiskit.dagcircuit.DAGCircuit.compose_back#qiskit.dagcircuit.DAGCircuit.compose_back "qiskit.dagcircuit.DAGCircuit.compose_back") | DEPRECATED: use DAGCircuit.compose() instead. | -| [`count_ops`](qiskit.dagcircuit.DAGCircuit.count_ops#qiskit.dagcircuit.DAGCircuit.count_ops "qiskit.dagcircuit.DAGCircuit.count_ops") | Count the occurrences of operation names. | -| [`count_ops_longest_path`](qiskit.dagcircuit.DAGCircuit.count_ops_longest_path#qiskit.dagcircuit.DAGCircuit.count_ops_longest_path "qiskit.dagcircuit.DAGCircuit.count_ops_longest_path") | Count the occurrences of operation names on the longest path. | -| [`depth`](qiskit.dagcircuit.DAGCircuit.depth#qiskit.dagcircuit.DAGCircuit.depth "qiskit.dagcircuit.DAGCircuit.depth") | Return the circuit depth. | -| [`descendants`](qiskit.dagcircuit.DAGCircuit.descendants#qiskit.dagcircuit.DAGCircuit.descendants "qiskit.dagcircuit.DAGCircuit.descendants") | Returns set of the descendants of a node as DAGNodes. | -| [`draw`](qiskit.dagcircuit.DAGCircuit.draw#qiskit.dagcircuit.DAGCircuit.draw "qiskit.dagcircuit.DAGCircuit.draw") | Draws the dag circuit. | -| [`edges`](qiskit.dagcircuit.DAGCircuit.edges#qiskit.dagcircuit.DAGCircuit.edges "qiskit.dagcircuit.DAGCircuit.edges") | Iterator for edge values and source and dest node | -| [`extend_back`](qiskit.dagcircuit.DAGCircuit.extend_back#qiskit.dagcircuit.DAGCircuit.extend_back "qiskit.dagcircuit.DAGCircuit.extend_back") | DEPRECATED: Add dag at the end of self, using edge\_map. | -| [`from_networkx`](qiskit.dagcircuit.DAGCircuit.from_networkx#qiskit.dagcircuit.DAGCircuit.from_networkx "qiskit.dagcircuit.DAGCircuit.from_networkx") | Take a networkx MultiDigraph and create a new DAGCircuit. | -| [`front_layer`](qiskit.dagcircuit.DAGCircuit.front_layer#qiskit.dagcircuit.DAGCircuit.front_layer "qiskit.dagcircuit.DAGCircuit.front_layer") | Return a list of op nodes in the first layer of this dag. | -| [`gate_nodes`](qiskit.dagcircuit.DAGCircuit.gate_nodes#qiskit.dagcircuit.DAGCircuit.gate_nodes "qiskit.dagcircuit.DAGCircuit.gate_nodes") | Get the list of gate nodes in the dag. | -| [`has_calibration_for`](qiskit.dagcircuit.DAGCircuit.has_calibration_for#qiskit.dagcircuit.DAGCircuit.has_calibration_for "qiskit.dagcircuit.DAGCircuit.has_calibration_for") | Return True if the dag has a calibration defined for the node operation. | -| [`idle_wires`](qiskit.dagcircuit.DAGCircuit.idle_wires#qiskit.dagcircuit.DAGCircuit.idle_wires "qiskit.dagcircuit.DAGCircuit.idle_wires") | Return idle wires. | -| [`is_predecessor`](qiskit.dagcircuit.DAGCircuit.is_predecessor#qiskit.dagcircuit.DAGCircuit.is_predecessor "qiskit.dagcircuit.DAGCircuit.is_predecessor") | Checks if a second node is in the predecessors of node. | -| [`is_successor`](qiskit.dagcircuit.DAGCircuit.is_successor#qiskit.dagcircuit.DAGCircuit.is_successor "qiskit.dagcircuit.DAGCircuit.is_successor") | Checks if a second node is in the successors of node. | -| [`layers`](qiskit.dagcircuit.DAGCircuit.layers#qiskit.dagcircuit.DAGCircuit.layers "qiskit.dagcircuit.DAGCircuit.layers") | Yield a shallow view on a layer of this DAGCircuit for all d layers of this circuit. | -| [`longest_path`](qiskit.dagcircuit.DAGCircuit.longest_path#qiskit.dagcircuit.DAGCircuit.longest_path "qiskit.dagcircuit.DAGCircuit.longest_path") | Returns the longest path in the dag as a list of DAGNodes. | -| [`multi_qubit_ops`](qiskit.dagcircuit.DAGCircuit.multi_qubit_ops#qiskit.dagcircuit.DAGCircuit.multi_qubit_ops "qiskit.dagcircuit.DAGCircuit.multi_qubit_ops") | Get list of 3+ qubit operations. | -| [`multigraph_layers`](qiskit.dagcircuit.DAGCircuit.multigraph_layers#qiskit.dagcircuit.DAGCircuit.multigraph_layers "qiskit.dagcircuit.DAGCircuit.multigraph_layers") | Yield layers of the multigraph. | -| [`named_nodes`](qiskit.dagcircuit.DAGCircuit.named_nodes#qiskit.dagcircuit.DAGCircuit.named_nodes "qiskit.dagcircuit.DAGCircuit.named_nodes") | Get the set of “op” nodes with the given name. | -| [`node`](qiskit.dagcircuit.DAGCircuit.node#qiskit.dagcircuit.DAGCircuit.node "qiskit.dagcircuit.DAGCircuit.node") | Get the node in the dag. | -| [`nodes`](qiskit.dagcircuit.DAGCircuit.nodes#qiskit.dagcircuit.DAGCircuit.nodes "qiskit.dagcircuit.DAGCircuit.nodes") | Iterator for node values. | -| [`nodes_on_wire`](qiskit.dagcircuit.DAGCircuit.nodes_on_wire#qiskit.dagcircuit.DAGCircuit.nodes_on_wire "qiskit.dagcircuit.DAGCircuit.nodes_on_wire") | Iterator for nodes that affect a given wire. | -| [`num_clbits`](qiskit.dagcircuit.DAGCircuit.num_clbits#qiskit.dagcircuit.DAGCircuit.num_clbits "qiskit.dagcircuit.DAGCircuit.num_clbits") | Return the total number of classical bits used by the circuit. | -| [`num_qubits`](qiskit.dagcircuit.DAGCircuit.num_qubits#qiskit.dagcircuit.DAGCircuit.num_qubits "qiskit.dagcircuit.DAGCircuit.num_qubits") | Return the total number of qubits used by the circuit. | -| [`num_tensor_factors`](qiskit.dagcircuit.DAGCircuit.num_tensor_factors#qiskit.dagcircuit.DAGCircuit.num_tensor_factors "qiskit.dagcircuit.DAGCircuit.num_tensor_factors") | Compute how many components the circuit can decompose into. | -| [`op_nodes`](qiskit.dagcircuit.DAGCircuit.op_nodes#qiskit.dagcircuit.DAGCircuit.op_nodes "qiskit.dagcircuit.DAGCircuit.op_nodes") | Get the list of “op” nodes in the dag. | -| [`predecessors`](qiskit.dagcircuit.DAGCircuit.predecessors#qiskit.dagcircuit.DAGCircuit.predecessors "qiskit.dagcircuit.DAGCircuit.predecessors") | Returns iterator of the predecessors of a node as DAGNodes. | -| [`properties`](qiskit.dagcircuit.DAGCircuit.properties#qiskit.dagcircuit.DAGCircuit.properties "qiskit.dagcircuit.DAGCircuit.properties") | Return a dictionary of circuit properties. | -| [`quantum_predecessors`](qiskit.dagcircuit.DAGCircuit.quantum_predecessors#qiskit.dagcircuit.DAGCircuit.quantum_predecessors "qiskit.dagcircuit.DAGCircuit.quantum_predecessors") | Returns iterator of the predecessors of a node that are connected by a quantum edge as DAGNodes. | -| [`quantum_successors`](qiskit.dagcircuit.DAGCircuit.quantum_successors#qiskit.dagcircuit.DAGCircuit.quantum_successors "qiskit.dagcircuit.DAGCircuit.quantum_successors") | Returns iterator of the successors of a node that are connected by a quantum edge as DAGNodes. | -| [`remove_all_ops_named`](qiskit.dagcircuit.DAGCircuit.remove_all_ops_named#qiskit.dagcircuit.DAGCircuit.remove_all_ops_named "qiskit.dagcircuit.DAGCircuit.remove_all_ops_named") | Remove all operation nodes with the given name. | -| [`remove_ancestors_of`](qiskit.dagcircuit.DAGCircuit.remove_ancestors_of#qiskit.dagcircuit.DAGCircuit.remove_ancestors_of "qiskit.dagcircuit.DAGCircuit.remove_ancestors_of") | Remove all of the ancestor operation nodes of node. | -| [`remove_descendants_of`](qiskit.dagcircuit.DAGCircuit.remove_descendants_of#qiskit.dagcircuit.DAGCircuit.remove_descendants_of "qiskit.dagcircuit.DAGCircuit.remove_descendants_of") | Remove all of the descendant operation nodes of node. | -| [`remove_nonancestors_of`](qiskit.dagcircuit.DAGCircuit.remove_nonancestors_of#qiskit.dagcircuit.DAGCircuit.remove_nonancestors_of "qiskit.dagcircuit.DAGCircuit.remove_nonancestors_of") | Remove all of the non-ancestors operation nodes of node. | -| [`remove_nondescendants_of`](qiskit.dagcircuit.DAGCircuit.remove_nondescendants_of#qiskit.dagcircuit.DAGCircuit.remove_nondescendants_of "qiskit.dagcircuit.DAGCircuit.remove_nondescendants_of") | Remove all of the non-descendants operation nodes of node. | -| [`remove_op_node`](qiskit.dagcircuit.DAGCircuit.remove_op_node#qiskit.dagcircuit.DAGCircuit.remove_op_node "qiskit.dagcircuit.DAGCircuit.remove_op_node") | Remove an operation node n. | -| [`reverse_ops`](qiskit.dagcircuit.DAGCircuit.reverse_ops#qiskit.dagcircuit.DAGCircuit.reverse_ops "qiskit.dagcircuit.DAGCircuit.reverse_ops") | Reverse the operations in the `self` circuit. | -| [`serial_layers`](qiskit.dagcircuit.DAGCircuit.serial_layers#qiskit.dagcircuit.DAGCircuit.serial_layers "qiskit.dagcircuit.DAGCircuit.serial_layers") | Yield a layer for all gates of this circuit. | -| [`size`](qiskit.dagcircuit.DAGCircuit.size#qiskit.dagcircuit.DAGCircuit.size "qiskit.dagcircuit.DAGCircuit.size") | Return the number of operations. | -| [`substitute_node`](qiskit.dagcircuit.DAGCircuit.substitute_node#qiskit.dagcircuit.DAGCircuit.substitute_node "qiskit.dagcircuit.DAGCircuit.substitute_node") | Replace a DAGNode with a single instruction. | -| [`substitute_node_with_dag`](qiskit.dagcircuit.DAGCircuit.substitute_node_with_dag#qiskit.dagcircuit.DAGCircuit.substitute_node_with_dag "qiskit.dagcircuit.DAGCircuit.substitute_node_with_dag") | Replace one node with dag. | -| [`successors`](qiskit.dagcircuit.DAGCircuit.successors#qiskit.dagcircuit.DAGCircuit.successors "qiskit.dagcircuit.DAGCircuit.successors") | Returns iterator of the successors of a node as DAGNodes. | -| [`threeQ_or_more_gates`](qiskit.dagcircuit.DAGCircuit.threeQ_or_more_gates#qiskit.dagcircuit.DAGCircuit.threeQ_or_more_gates "qiskit.dagcircuit.DAGCircuit.threeQ_or_more_gates") | Get list of 3-or-more-qubit gates: (id, data). | -| [`to_networkx`](qiskit.dagcircuit.DAGCircuit.to_networkx#qiskit.dagcircuit.DAGCircuit.to_networkx "qiskit.dagcircuit.DAGCircuit.to_networkx") | Returns a copy of the DAGCircuit in networkx format. | -| [`topological_nodes`](qiskit.dagcircuit.DAGCircuit.topological_nodes#qiskit.dagcircuit.DAGCircuit.topological_nodes "qiskit.dagcircuit.DAGCircuit.topological_nodes") | Yield nodes in topological order. | -| [`topological_op_nodes`](qiskit.dagcircuit.DAGCircuit.topological_op_nodes#qiskit.dagcircuit.DAGCircuit.topological_op_nodes "qiskit.dagcircuit.DAGCircuit.topological_op_nodes") | Yield op nodes in topological order. | -| [`twoQ_gates`](qiskit.dagcircuit.DAGCircuit.twoQ_gates#qiskit.dagcircuit.DAGCircuit.twoQ_gates "qiskit.dagcircuit.DAGCircuit.twoQ_gates") | Get list of 2-qubit gates. | -| [`two_qubit_ops`](qiskit.dagcircuit.DAGCircuit.two_qubit_ops#qiskit.dagcircuit.DAGCircuit.two_qubit_ops "qiskit.dagcircuit.DAGCircuit.two_qubit_ops") | Get list of 2 qubit operations. | -| [`width`](qiskit.dagcircuit.DAGCircuit.width#qiskit.dagcircuit.DAGCircuit.width "qiskit.dagcircuit.DAGCircuit.width") | Return the total number of qubits + clbits used by the circuit. | +### add\_calibration -## Attributes + + +`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. + +**Parameters** + +* **gate** (*Union\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*, str]*) – Gate information. +* **qubits** (*Union\[int, Tuple\[int]]*) – List of qubits to be measured. +* **schedule** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")) – Schedule information. +* **params** (*Optional\[List\[Union\[float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]]*) – A list of parameters. + +**Raises** + +**Exception** – if the gate is of type string and params is None. + +### add\_clbits + + + +`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. + +### add\_creg + + + +`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. + +### add\_qreg + + + +`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. + +### add\_qubits + + + +`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. + +### ancestors + + + +`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. + +### apply\_operation\_back + + + +`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. + +**Parameters** + +* **op** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – the operation associated with the DAG node +* **qargs** (*list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to +* **cargs** (*list\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to +* **condition** (*tuple or None*) – DEPRECATED optional condition (ClassicalRegister, int) + +**Returns** + +the current max node + +**Return type** + +[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode") + +**Raises** + +[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if a leaf node is connected to multiple outputs + +### apply\_operation\_front + + + +`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. + +**Parameters** + +* **op** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – the operation associated with the DAG node +* **qargs** (*list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – qubits that op will be applied to +* **cargs** (*list\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – cbits that op will be applied to +* **condition** (*tuple or None*) – DEPRECATED optional condition (ClassicalRegister, int) + +**Returns** + +the current max node + +**Return type** + +[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode") + +**Raises** + +[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if initial nodes connected to multiple out edges + +### bfs\_successors + + + +`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. + +### collect\_1q\_runs + + + +`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. + +### collect\_runs + + + +`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. + +For example, “… h q\[0]; cx q\[0],q\[1]; cx q\[0],q\[1]; h q\[1]; ..” would produce the tuple of cx nodes as an element of the set returned from a call to collect\_runs(\[“cx”]). If instead the cx nodes were “cx q\[0],q\[1]; cx q\[1],q\[0];”, the method would still return the pair in a tuple. The namelist can contain names that are not in the circuit’s basis. + +Nodes must have only one successor to continue the run. + +### compose + + + +`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. + +A subset of input wires of `other` are mapped to a subset of output wires of this circuit. + +`other` can be narrower or of equal width to `self`. + +**Parameters** + +* **other** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – circuit to compose with self +* **edge\_map** (*dict*) – DEPRECATED - a \{Bit: Bit} map from input wires of other to output wires of self (i.e. rhs->lhs). The key, value pairs can be either Qubit or Clbit mappings. +* **qubits** (*list\[Qubit|int]*) – qubits of self to compose onto. +* **clbits** (*list\[Clbit|int]*) – clbits of self to compose onto. +* **front** (*bool*) – If True, front composition will be performed (not implemented yet) +* **inplace** (*bool*) – If True, modify the object. Otherwise return composed circuit. + +**Returns** + +the composed dag (returns None if inplace==True). + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if `other` is wider or there are duplicate edge mappings. + +### compose\_back + + + +`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. + +### count\_ops + + + +`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. + +Returns a dictionary of counts keyed on the operation name. + +### count\_ops\_longest\_path + + + +`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. + +Returns a dictionary of counts keyed on the operation name. + +### depth + + + +`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 + +**Raises** + +[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if not a directed acyclic graph + +### descendants + + + +`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. + +### draw + + + +`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. + +This function needs [pydot](https://github.com/erocarrera/pydot), which in turn needs [Graphviz](https://www.graphviz.org/) to be installed. + +**Parameters** + +* **scale** (*float*) – scaling factor +* **filename** (*str*) – file path to save image to (format inferred from name) +* **style** (*str*) – ‘plain’: B\&W graph; ‘color’ (default): color input/output/op nodes + +**Returns** + +if in Jupyter notebook and not saving to file, otherwise None. + +**Return type** + +Ipython.display.Image + +### edges + + + +`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 + +This works by returning the output edges from the specified nodes. If no nodes are specified all edges from the graph are returned. + +#### Parameters + +**nodes** (*DAGNode|list(*[*DAGNode*](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) – Either a list of nodes or a single input node. If none is specified all edges are returned from the graph. + +#### Yields + +*edge* – + +#### the edge in the same format as out\_edges the tuple + +(source node, destination node, edge data) + +### extend\_back + + + +`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. + +### from\_networkx + + + +`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. + +**Parameters** + +**graph** (*networkx.MultiDiGraph*) – The graph to create a DAGCircuit object from. The format of this MultiDiGraph format must be in the same format as returned by to\_networkx. + +**Returns** + +**The dagcircuit object created from the networkx** + +MultiDiGraph. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If networkx is not installed +* [**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – If input networkx graph is malformed + +### front\_layer + + + +`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. + +### gate\_nodes + + + +`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. + +**Returns** + +the list of DAGNodes that represent gates. + +**Return type** + +list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] + +### has\_calibration\_for + + + +`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. + +### idle\_wires + + + +`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. + +**Parameters** + +**ignore** (*list(str)*) – List of node names to ignore. Default: \[] + +**Yields** + +*Bit* – Bit in idle wire. + +### is\_predecessor + + + +`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. + +### is\_successor + + + +`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. + +### layers + + + +`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. + +A layer is a circuit whose gates act on disjoint qubits, i.e., a layer has depth 1. The total number of layers equals the circuit depth d. The layers are indexed from 0 to d-1 with the earliest layer at index 0. The layers are constructed using a greedy algorithm. Each returned layer is a dict containing \{“graph”: circuit graph, “partition”: list of qubit lists}. + +The returned layer contains new (but semantically equivalent) DAGNodes. These are not the same as nodes of the original dag, but are equivalent via DAGNode.semantic\_eq(node1, node2). + +TODO: Gates that use the same cbits will end up in different layers as this is currently implemented. This may not be the desired behavior. + +### longest\_path + + +`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. + +### multi\_qubit\_ops + + + +`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. + +### multigraph\_layers + + + +`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. + +### named\_nodes + + + +`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. + +### node + + + +`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. + +**Parameters** + +**node\_id** (*int*) – Node identifier. + +**Returns** + +the node. + +**Return type** + +node + +### nodes + + + +`DAGCircuit.nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") + +Iterator for node values. + +**Yields** + +*node* – the node. + +### nodes\_on\_wire + + + +`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. + +**Parameters** + +* **wire** (*Bit*) – the wire to be looked at. +* **only\_ops** (*bool*) – True if only the ops nodes are wanted; otherwise, all nodes are returned. + +**Yields** + +*DAGNode* – the successive ops on the given wire + +**Raises** + +[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if the given wire doesn’t exist in the DAG + +### num\_clbits + + + +`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. + +### num\_qubits + + + +`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]. + +### num\_tensor\_factors + + + +`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. + +### op\_nodes + + + +`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. + +**Parameters** + +* **op** (*Type*) – [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") subclass op nodes to return. If None, return all op nodes. +* **include\_directives** (*bool*) – include barrier, snapshot etc. + +**Returns** + +the list of node ids containing the given op. + +**Return type** + +list\[[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")] + +### predecessors + + + +`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. + +### properties + + + +`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. + +### quantum\_predecessors + + + +`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. + +### quantum\_successors + + + +`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. + +### remove\_all\_ops\_named + + + +`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. + +### remove\_ancestors\_of + + + +`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. + +### remove\_descendants\_of + + + +`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. + +### remove\_nonancestors\_of + + + +`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. + +### remove\_nondescendants\_of + + + +`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. + +### remove\_op\_node + + + +`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. + +Add edges from predecessors to successors. + +### reverse\_ops + + + +`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. + +**Returns** + +the reversed dag. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +### serial\_layers + + + +`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. + +A serial layer is a circuit with one gate. The layers have the same structure as in layers(). + +### size + + + +`DAGCircuit.size()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagcircuit.py "view source code") + +Return the number of operations. + +### substitute\_node + + + +`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. + +**Parameters** + +* **node** ([*DAGNode*](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) – Node to be replaced +* **op** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") instance to be added to the DAG +* **inplace** (*bool*) – Optional, default False. If True, existing DAG node will be modified to include op. Otherwise, a new DAG node will be used. + +**Returns** + +the new node containing the added instruction. + +**Return type** + +[DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode") + +**Raises** + +* [**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – If replacement instruction was incompatible with +* **location of target node.** – + +### substitute\_node\_with\_dag + + + +`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. + +**Parameters** + +* **node** ([*DAGNode*](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) – node to substitute +* **input\_dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – circuit that will substitute the node +* **wires** (*list\[Bit]*) – gives an order for (qu)bits in the input circuit. This order gets matched to the node wires by qargs first, then cargs, then conditions. + +**Raises** + +[**DAGCircuitError**](qiskit.dagcircuit.DAGCircuitError "qiskit.dagcircuit.DAGCircuitError") – if met with unexpected predecessor/successors + +### successors + + + +`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. + +### threeQ\_or\_more\_gates + + + +`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). + +### to\_networkx + + + +`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. + +### topological\_nodes + + + +`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. + +**Returns** + +node in topological order + +**Return type** + +generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) + +### topological\_op\_nodes + + + +`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. + +**Returns** + +op node in topological order + +**Return type** + +generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) + +### twoQ\_gates + + + +`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. + +### two\_qubit\_ops + + + +`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. + +### width + + + +`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(). + +## Attributes + + ### calibrations @@ -91,20 +786,21 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### global\_phase Return the global phase of the circuit. - + ### node\_counter Returns the number of nodes in the dag. - + ### wires Return a list of the wires in order. + diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md index e69ff441b57..bb21501298e 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGCircuitError.md @@ -1,9 +1,18 @@ -# qiskit.dagcircuit.DAGCircuitError +--- +title: DAGCircuitError +description: API reference for qiskit.dagcircuit.DAGCircuitError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.dagcircuit.DAGCircuitError +--- +# qiskit.dagcircuit.DAGCircuitError + -`DAGCircuitError(*msg)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md index e484da31695..bcd32521e05 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDepNode.md @@ -1,8 +1,16 @@ -# DAGDepNode +--- +title: DAGDepNode +description: API reference for qiskit.dagcircuit.DAGDepNode +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.dagcircuit.DAGDepNode +--- +# 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)` +`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` @@ -12,79 +20,104 @@ It is used as the return value from \*\_nodes() functions and can be supplied to ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| [`copy`](qiskit.dagcircuit.DAGDepNode.copy#qiskit.dagcircuit.DAGDepNode.copy "qiskit.dagcircuit.DAGDepNode.copy") | Function to copy a DAGDepNode object. | -| [`semantic_eq`](qiskit.dagcircuit.DAGDepNode.semantic_eq#qiskit.dagcircuit.DAGDepNode.semantic_eq "qiskit.dagcircuit.DAGDepNode.semantic_eq") | Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. | +### copy -## Attributes + +`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 -### cargs +### semantic\_eq + +`static DAGDepNode.semantic_eq(node1, node2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdepnode.py "view source code") -### cindices +Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. + +**Parameters** + +* **node1** ([*DAGDepNode*](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")) – A node to compare. +* **node2** ([*DAGDepNode*](qiskit.dagcircuit.DAGDepNode "qiskit.dagcircuit.DAGDepNode")) – The other node to compare. + +**Returns** + +If node1 == node2 + +**Return type** + +Bool + +## Attributes + + + +### cargs + +### cindices + + ### condition Returns the condition of the node.op - + ### isblocked - + ### matchedwith - + ### name - + ### node\_id - + ### op Returns the Instruction object corresponding to the op for the node, else None - + ### predecessors - + ### qargs Returns list of Qubit, else an empty list. - + ### qindices - + ### reachable - + ### sort\_key - + ### successors - + ### successorstovisit - + ### type + diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md index 140dc3e73b0..fa2fb46df2b 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGDependency.md @@ -1,8 +1,16 @@ -# DAGDependency +--- +title: DAGDependency +description: API reference for qiskit.dagcircuit.DAGDependency +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.dagcircuit.DAGDependency +--- +# DAGDependency + -`DAGDependency` +`DAGDependency`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") Bases: `object` @@ -34,34 +42,326 @@ Create an empty DAGDependency. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [`add_clbits`](qiskit.dagcircuit.DAGDependency.add_clbits#qiskit.dagcircuit.DAGDependency.add_clbits "qiskit.dagcircuit.DAGDependency.add_clbits") | Add individual clbit wires. | -| [`add_creg`](qiskit.dagcircuit.DAGDependency.add_creg#qiskit.dagcircuit.DAGDependency.add_creg "qiskit.dagcircuit.DAGDependency.add_creg") | Add clbits in a classical register. | -| [`add_op_node`](qiskit.dagcircuit.DAGDependency.add_op_node#qiskit.dagcircuit.DAGDependency.add_op_node "qiskit.dagcircuit.DAGDependency.add_op_node") | Add a DAGDepNode to the graph and update the edges. | -| [`add_qreg`](qiskit.dagcircuit.DAGDependency.add_qreg#qiskit.dagcircuit.DAGDependency.add_qreg "qiskit.dagcircuit.DAGDependency.add_qreg") | Add qubits in a quantum register. | -| [`add_qubits`](qiskit.dagcircuit.DAGDependency.add_qubits#qiskit.dagcircuit.DAGDependency.add_qubits "qiskit.dagcircuit.DAGDependency.add_qubits") | Add individual qubit wires. | -| [`copy`](qiskit.dagcircuit.DAGDependency.copy#qiskit.dagcircuit.DAGDependency.copy "qiskit.dagcircuit.DAGDependency.copy") | Function to copy a DAGDependency object. | -| [`depth`](qiskit.dagcircuit.DAGDependency.depth#qiskit.dagcircuit.DAGDependency.depth "qiskit.dagcircuit.DAGDependency.depth") | Return the circuit depth. | -| [`direct_predecessors`](qiskit.dagcircuit.DAGDependency.direct_predecessors#qiskit.dagcircuit.DAGDependency.direct_predecessors "qiskit.dagcircuit.DAGDependency.direct_predecessors") | Direct predecessors id of a given node as sorted list. | -| [`direct_successors`](qiskit.dagcircuit.DAGDependency.direct_successors#qiskit.dagcircuit.DAGDependency.direct_successors "qiskit.dagcircuit.DAGDependency.direct_successors") | Direct successors id of a given node as sorted list. | -| [`draw`](qiskit.dagcircuit.DAGDependency.draw#qiskit.dagcircuit.DAGDependency.draw "qiskit.dagcircuit.DAGDependency.draw") | Draws the DAGDependency graph. | -| [`get_all_edges`](qiskit.dagcircuit.DAGDependency.get_all_edges#qiskit.dagcircuit.DAGDependency.get_all_edges "qiskit.dagcircuit.DAGDependency.get_all_edges") | Enumeration of all edges. | -| [`get_edges`](qiskit.dagcircuit.DAGDependency.get_edges#qiskit.dagcircuit.DAGDependency.get_edges "qiskit.dagcircuit.DAGDependency.get_edges") | Edge enumeration between two nodes through method get\_all\_edge\_data. | -| [`get_in_edges`](qiskit.dagcircuit.DAGDependency.get_in_edges#qiskit.dagcircuit.DAGDependency.get_in_edges "qiskit.dagcircuit.DAGDependency.get_in_edges") | Enumeration of all incoming edges for a given node. | -| [`get_node`](qiskit.dagcircuit.DAGDependency.get_node#qiskit.dagcircuit.DAGDependency.get_node "qiskit.dagcircuit.DAGDependency.get_node") | **param node\_id**label of considered node. | -| [`get_nodes`](qiskit.dagcircuit.DAGDependency.get_nodes#qiskit.dagcircuit.DAGDependency.get_nodes "qiskit.dagcircuit.DAGDependency.get_nodes") | **returns**iterator over all the nodes. | -| [`get_out_edges`](qiskit.dagcircuit.DAGDependency.get_out_edges#qiskit.dagcircuit.DAGDependency.get_out_edges "qiskit.dagcircuit.DAGDependency.get_out_edges") | Enumeration of all outgoing edges for a given node. | -| [`predecessors`](qiskit.dagcircuit.DAGDependency.predecessors#qiskit.dagcircuit.DAGDependency.predecessors "qiskit.dagcircuit.DAGDependency.predecessors") | Predecessors id of a given node as sorted list. | -| [`size`](qiskit.dagcircuit.DAGDependency.size#qiskit.dagcircuit.DAGDependency.size "qiskit.dagcircuit.DAGDependency.size") | Returns the number of gates in the circuit | -| [`successors`](qiskit.dagcircuit.DAGDependency.successors#qiskit.dagcircuit.DAGDependency.successors "qiskit.dagcircuit.DAGDependency.successors") | Successors id of a given node as sorted list. | -| [`to_networkx`](qiskit.dagcircuit.DAGDependency.to_networkx#qiskit.dagcircuit.DAGDependency.to_networkx "qiskit.dagcircuit.DAGDependency.to_networkx") | Returns a copy of the DAGDependency in networkx format. | -| [`to_retworkx`](qiskit.dagcircuit.DAGDependency.to_retworkx#qiskit.dagcircuit.DAGDependency.to_retworkx "qiskit.dagcircuit.DAGDependency.to_retworkx") | Returns the DAGDependency in retworkx format. | -| [`topological_nodes`](qiskit.dagcircuit.DAGDependency.topological_nodes#qiskit.dagcircuit.DAGDependency.topological_nodes "qiskit.dagcircuit.DAGDependency.topological_nodes") | Yield nodes in topological order. | +### add\_clbits -## Attributes + + +`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. + +### add\_creg + + + +`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. + +### add\_op\_node + + + +`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. + +**Parameters** + +* **operation** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – operation as a quantum gate. +* **qargs** (*list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of qubits on which the operation acts +* **cargs** (*list\[*[*Clbit*](qiskit.circuit.Clbit "qiskit.circuit.Clbit")*]*) – list of classical wires to attach to. + +### add\_qreg + + + +`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. + +### add\_qubits + + + +`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. + +### copy + + + +`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 + +### depth + + + +`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 + +### direct\_predecessors + + + +`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. + +**Parameters** + +**node\_id** (*int*) – label of considered node. + +**Returns** + +direct predecessors id as a sorted list + +**Return type** + +List + +### direct\_successors + + + +`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. + +**Parameters** + +**node\_id** (*int*) – label of considered node. + +**Returns** + +direct successors id as a sorted list + +**Return type** + +List + +### draw + + + +`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. + +This function needs pydot \<[https://github.com/erocarrera/pydot](https://github.com/erocarrera/pydot)>, which in turn needs Graphviz \<[https://www.graphviz.org/](https://www.graphviz.org/)>\` to be installed. + +**Parameters** + +* **scale** (*float*) – scaling factor +* **filename** (*str*) – file path to save image to (format inferred from name) +* **style** (*str*) – ‘plain’: B\&W graph ‘color’ (default): color input/output/op nodes + +**Returns** + +**if in Jupyter notebook and not saving to file,** + +otherwise None. + +**Return type** + +Ipython.display.Image + +### get\_all\_edges + + + +`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. + +**Returns** + +corresponding to the label. + +**Return type** + +List + +### get\_edges + + + +`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. + +**Parameters** + +* **src\_id** (*int*) – label of the first node. +* **dest\_id** (*int*) – label of the second node. + +**Returns** + +corresponding to all edges between the two nodes. + +**Return type** +List +### get\_in\_edges + + + +`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. + +**Parameters** + +**node\_id** (*int*) – label of considered node. + +**Returns** + +corresponding incoming edges data. + +**Return type** + +List + +### get\_node + + + +`DAGDependency.get_node(node_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") + +**Parameters** + +**node\_id** (*int*) – label of considered node. + +**Returns** + +corresponding to the label. + +**Return type** + +node + +### get\_nodes + + + +`DAGDependency.get_nodes()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/dagcircuit/dagdependency.py "view source code") + +**Returns** + +iterator over all the nodes. + +**Return type** + +generator(dict) + +### get\_out\_edges + + + +`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. + +**Parameters** + +**node\_id** (*int*) – label of considered node. + +**Returns** + +corresponding outgoing edges data. + +**Return type** + +List + +### predecessors + + + +`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. + +**Parameters** + +**node\_id** (*int*) – label of considered node. + +**Returns** + +all predecessors id as a sorted list + +**Return type** + +List + +### size + + + +`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 + +### successors + + + +`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. + +**Parameters** + +**node\_id** (*int*) – label of considered node. + +**Returns** + +all successors id as a sorted list + +**Return type** + +List + +### to\_networkx + + + +`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. + +### to\_retworkx + + + +`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. + +### topological\_nodes + + + +`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. + +**Returns** + +node in topological order. + +**Return type** + +generator([DAGNode](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) + +## Attributes + + ### calibrations @@ -71,8 +371,9 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### global\_phase Return the global phase of the circuit. + diff --git a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md index 3acac908e8b..f1bc71320da 100644 --- a/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md +++ b/docs/api/qiskit/0.32/qiskit.dagcircuit.DAGNode.md @@ -1,8 +1,16 @@ -# DAGNode +--- +title: DAGNode +description: API reference for qiskit.dagcircuit.DAGNode +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.dagcircuit.DAGNode +--- +# DAGNode + -`DAGNode(type=None, op=None, name=None, qargs=None, cargs=None, wire=None, nid=- 1)` +`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` @@ -14,50 +22,70 @@ Create a node ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | -| [`semantic_eq`](qiskit.dagcircuit.DAGNode.semantic_eq#qiskit.dagcircuit.DAGNode.semantic_eq "qiskit.dagcircuit.DAGNode.semantic_eq") | Check if DAG nodes are considered equivalent, e.g., as a node\_match for nx.is\_isomorphic. | +### semantic\_eq -## Attributes + +`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. -### cargs +**Parameters** + +* **node1** ([*DAGNode*](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) – A node to compare. +* **node2** ([*DAGNode*](qiskit.dagcircuit.DAGNode "qiskit.dagcircuit.DAGNode")) – The other node to compare. +* **bit\_indices1** (*dict*) – Dictionary mapping Bit instances to their index within the circuit containing node1 +* **bit\_indices2** (*dict*) – Dictionary mapping Bit instances to their index within the circuit containing node2 + +**Returns** + +If node1 == node2 + +**Return type** + +Bool + +## Attributes + + +### cargs + ### condition Returns the condition of the node.op - + ### name Returns the Instruction name corresponding to the op for this node - + ### op Returns the Instruction object corresponding to the op for the node, else None - + ### qargs Returns list of Qubit, else an empty list. - + ### sort\_key - + ### type - + ### wire Returns the Bit object, else None. + diff --git a/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md b/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md index fbb9a759d40..6e95a5df69a 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.HamiltonianGate.md @@ -1,8 +1,16 @@ -# HamiltonianGate +--- +title: HamiltonianGate +description: API reference for qiskit.extensions.HamiltonianGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.extensions.HamiltonianGate +--- +# HamiltonianGate + -`HamiltonianGate(data, time, label=None)` +`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` @@ -12,7 +20,7 @@ Create a gate from a hamiltonian operator and evolution time parameter t **Parameters** -* **data** (*matrix or* [*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a hermitian operator. +* **data** (*matrix or* [*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a hermitian operator. * **time** (*float*) – time evolution parameter. * **label** (*str*) – unitary name for backend \[Default: None]. @@ -22,49 +30,336 @@ Create a gate from a hamiltonian operator and evolution time parameter t ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.extensions.HamiltonianGate.add_decomposition#qiskit.extensions.HamiltonianGate.add_decomposition "qiskit.extensions.HamiltonianGate.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`adjoint`](qiskit.extensions.HamiltonianGate.adjoint#qiskit.extensions.HamiltonianGate.adjoint "qiskit.extensions.HamiltonianGate.adjoint") | Return the adjoint of the unitary. | -| [`assemble`](qiskit.extensions.HamiltonianGate.assemble#qiskit.extensions.HamiltonianGate.assemble "qiskit.extensions.HamiltonianGate.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.extensions.HamiltonianGate.broadcast_arguments#qiskit.extensions.HamiltonianGate.broadcast_arguments "qiskit.extensions.HamiltonianGate.broadcast_arguments") | Validation and handling of the arguments and its relationship. | -| [`c_if`](qiskit.extensions.HamiltonianGate.c_if#qiskit.extensions.HamiltonianGate.c_if "qiskit.extensions.HamiltonianGate.c_if") | Add classical condition on register or cbit classical and value val. | -| [`conjugate`](qiskit.extensions.HamiltonianGate.conjugate#qiskit.extensions.HamiltonianGate.conjugate "qiskit.extensions.HamiltonianGate.conjugate") | Return the conjugate of the Hamiltonian. | -| [`control`](qiskit.extensions.HamiltonianGate.control#qiskit.extensions.HamiltonianGate.control "qiskit.extensions.HamiltonianGate.control") | Return controlled version of gate. | -| [`copy`](qiskit.extensions.HamiltonianGate.copy#qiskit.extensions.HamiltonianGate.copy "qiskit.extensions.HamiltonianGate.copy") | Copy of the instruction. | -| [`inverse`](qiskit.extensions.HamiltonianGate.inverse#qiskit.extensions.HamiltonianGate.inverse "qiskit.extensions.HamiltonianGate.inverse") | Return the adjoint of the unitary. | -| [`is_parameterized`](qiskit.extensions.HamiltonianGate.is_parameterized#qiskit.extensions.HamiltonianGate.is_parameterized "qiskit.extensions.HamiltonianGate.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.extensions.HamiltonianGate.mirror#qiskit.extensions.HamiltonianGate.mirror "qiskit.extensions.HamiltonianGate.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`power`](qiskit.extensions.HamiltonianGate.power#qiskit.extensions.HamiltonianGate.power "qiskit.extensions.HamiltonianGate.power") | Creates a unitary gate as gate^exponent. | -| [`qasm`](qiskit.extensions.HamiltonianGate.qasm#qiskit.extensions.HamiltonianGate.qasm "qiskit.extensions.HamiltonianGate.qasm") | Raise an error, as QASM is not defined for the HamiltonianGate. | -| [`repeat`](qiskit.extensions.HamiltonianGate.repeat#qiskit.extensions.HamiltonianGate.repeat "qiskit.extensions.HamiltonianGate.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.extensions.HamiltonianGate.reverse_ops#qiskit.extensions.HamiltonianGate.reverse_ops "qiskit.extensions.HamiltonianGate.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.extensions.HamiltonianGate.soft_compare#qiskit.extensions.HamiltonianGate.soft_compare "qiskit.extensions.HamiltonianGate.soft_compare") | Soft comparison between gates. | -| [`to_matrix`](qiskit.extensions.HamiltonianGate.to_matrix#qiskit.extensions.HamiltonianGate.to_matrix "qiskit.extensions.HamiltonianGate.to_matrix") | Return a Numpy.array for the gate unitary matrix. | -| [`transpose`](qiskit.extensions.HamiltonianGate.transpose#qiskit.extensions.HamiltonianGate.transpose "qiskit.extensions.HamiltonianGate.transpose") | Return the transpose of the Hamiltonian. | -| [`validate_parameter`](qiskit.extensions.HamiltonianGate.validate_parameter#qiskit.extensions.HamiltonianGate.validate_parameter "qiskit.extensions.HamiltonianGate.validate_parameter") | Hamiltonian parameter has to be an ndarray, operator or float. | +### add\_decomposition -## Attributes + + +`HamiltonianGate.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### adjoint + + + +`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. + +### assemble + + + +`HamiltonianGate.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`HamiltonianGate.broadcast_arguments(qargs, cargs)` + +Validation and handling of the arguments and its relationship. + +For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: + +```python +in: [[q[0],q[1]], q[2]],[] +outs: [q[0], q[2]], [] + [q[1], q[2]], [] +``` + +The general broadcasting rules are: + +> * If len(qargs) == 1: +> +> ```python +> [q[0], q[1]] -> [q[0]],[q[1]] +> ``` +> +> * If len(qargs) == 2: +> +> ```python +> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]] +> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]] +> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]] +> ``` +> +> * If len(qargs) >= 3: +> +> ```python +> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...] +> ``` + +**Parameters** + +* **qargs** (`List`) – List of quantum bit arguments. +* **cargs** (`List`) – List of classical bit arguments. + +**Return type** + +`Tuple`\[`List`, `List`] + +**Returns** + +A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`HamiltonianGate.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### conjugate + + + +`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. + +### control + + + +`HamiltonianGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` + +Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage. + +**Parameters** + +* **num\_ctrl\_qubits** (`Optional`\[`int`]) – number of controls to add to gate (default=1) +* **label** (`Optional`\[`str`]) – optional gate label +* **ctrl\_state** (`Union`\[`int`, `str`, `None`]) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use 2\*\*num\_ctrl\_qubits-1. + +**Returns** + +Controlled version of gate. This default algorithm uses num\_ctrl\_qubits-1 ancillae qubits so returns a gate of size num\_qubits + 2\*num\_ctrl\_qubits - 1. + +**Return type** + +[qiskit.circuit.ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") + +**Raises** + +**QiskitError** – unrecognized mode or invalid ctrl\_state + +### copy + + + +`HamiltonianGate.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`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. + +### is\_parameterized + + + +`HamiltonianGate.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`HamiltonianGate.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### power + + + +`HamiltonianGate.power(exponent)` + +Creates a unitary gate as gate^exponent. + +**Parameters** + +**exponent** (*float*) – Gate^exponent + +**Returns** + +To which to\_matrix is self.to\_matrix^exponent. + +**Return type** + +[qiskit.extensions.UnitaryGate](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") + +**Raises** + +**CircuitError** – If Gate is not unitary + +### qasm + + + +`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. + +### repeat + + + +`HamiltonianGate.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`HamiltonianGate.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`HamiltonianGate.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### to\_matrix + + + +`HamiltonianGate.to_matrix()` + +Return a Numpy.array for the gate unitary matrix. + +**Returns** + +if the Gate subclass has a matrix definition. + +**Return type** + +np.ndarray + +**Raises** + +**CircuitError** – If a Gate subclass does not implement this method an exception will be raised when this base class method is called. + +### transpose + + + +`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. + +### validate\_parameter + + + +`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. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -74,14 +369,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md b/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md index de33b9fe68e..b853a50324b 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.Initialize.md @@ -1,8 +1,16 @@ -# Initialize +--- +title: Initialize +description: API reference for qiskit.extensions.Initialize +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.extensions.Initialize +--- +# Initialize + -`Initialize(params, num_qubits=None)` +`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` @@ -32,44 +40,242 @@ number of qubits in the initialize call. Example: initialize covers 5 qubits and ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| [`add_decomposition`](qiskit.extensions.Initialize.add_decomposition#qiskit.extensions.Initialize.add_decomposition "qiskit.extensions.Initialize.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.extensions.Initialize.assemble#qiskit.extensions.Initialize.assemble "qiskit.extensions.Initialize.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.extensions.Initialize.broadcast_arguments#qiskit.extensions.Initialize.broadcast_arguments "qiskit.extensions.Initialize.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.extensions.Initialize.c_if#qiskit.extensions.Initialize.c_if "qiskit.extensions.Initialize.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.extensions.Initialize.copy#qiskit.extensions.Initialize.copy "qiskit.extensions.Initialize.copy") | Copy of the instruction. | -| [`gates_to_uncompute`](qiskit.extensions.Initialize.gates_to_uncompute#qiskit.extensions.Initialize.gates_to_uncompute "qiskit.extensions.Initialize.gates_to_uncompute") | Call to create a circuit with gates that take the desired vector to zero. | -| [`inverse`](qiskit.extensions.Initialize.inverse#qiskit.extensions.Initialize.inverse "qiskit.extensions.Initialize.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.extensions.Initialize.is_parameterized#qiskit.extensions.Initialize.is_parameterized "qiskit.extensions.Initialize.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.extensions.Initialize.mirror#qiskit.extensions.Initialize.mirror "qiskit.extensions.Initialize.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.extensions.Initialize.qasm#qiskit.extensions.Initialize.qasm "qiskit.extensions.Initialize.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.extensions.Initialize.repeat#qiskit.extensions.Initialize.repeat "qiskit.extensions.Initialize.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.extensions.Initialize.reverse_ops#qiskit.extensions.Initialize.reverse_ops "qiskit.extensions.Initialize.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.extensions.Initialize.soft_compare#qiskit.extensions.Initialize.soft_compare "qiskit.extensions.Initialize.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.extensions.Initialize.validate_parameter#qiskit.extensions.Initialize.validate_parameter "qiskit.extensions.Initialize.validate_parameter") | Initialize instruction parameter can be str, int, float, and complex. | +### add\_decomposition -## Attributes + + +`Initialize.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`Initialize.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`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. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`Initialize.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`Initialize.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### gates\_to\_uncompute + + + +`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. + +**Returns** + +circuit to take self.params vector to $|{00\ldots0}\rangle$ + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### inverse + + + +`Initialize.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`Initialize.is_parameterized()` + +Return True .IFF. instruction is parameterized else False +### mirror + + +`Initialize.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`Initialize.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`Initialize.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`Initialize.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`Initialize.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`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. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -79,14 +285,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md b/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md index 7701430a376..d83db85713b 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.Snapshot.md @@ -1,8 +1,16 @@ -# Snapshot +--- +title: Snapshot +description: API reference for qiskit.extensions.Snapshot +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.extensions.Snapshot +--- +# Snapshot + -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -24,62 +32,230 @@ Create new snapshot instruction. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.extensions.Snapshot.add_decomposition#qiskit.extensions.Snapshot.add_decomposition "qiskit.extensions.Snapshot.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.extensions.Snapshot.assemble#qiskit.extensions.Snapshot.assemble "qiskit.extensions.Snapshot.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.extensions.Snapshot.broadcast_arguments#qiskit.extensions.Snapshot.broadcast_arguments "qiskit.extensions.Snapshot.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.extensions.Snapshot.c_if#qiskit.extensions.Snapshot.c_if "qiskit.extensions.Snapshot.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.extensions.Snapshot.copy#qiskit.extensions.Snapshot.copy "qiskit.extensions.Snapshot.copy") | Copy of the instruction. | -| [`inverse`](qiskit.extensions.Snapshot.inverse#qiskit.extensions.Snapshot.inverse "qiskit.extensions.Snapshot.inverse") | Special case. | -| [`is_parameterized`](qiskit.extensions.Snapshot.is_parameterized#qiskit.extensions.Snapshot.is_parameterized "qiskit.extensions.Snapshot.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.extensions.Snapshot.mirror#qiskit.extensions.Snapshot.mirror "qiskit.extensions.Snapshot.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.extensions.Snapshot.qasm#qiskit.extensions.Snapshot.qasm "qiskit.extensions.Snapshot.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.extensions.Snapshot.repeat#qiskit.extensions.Snapshot.repeat "qiskit.extensions.Snapshot.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.extensions.Snapshot.reverse_ops#qiskit.extensions.Snapshot.reverse_ops "qiskit.extensions.Snapshot.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.extensions.Snapshot.soft_compare#qiskit.extensions.Snapshot.soft_compare "qiskit.extensions.Snapshot.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.extensions.Snapshot.validate_parameter#qiskit.extensions.Snapshot.validate_parameter "qiskit.extensions.Snapshot.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`Snapshot.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`Snapshot.assemble()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`Snapshot.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`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. + +### copy + + + +`Snapshot.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`Snapshot.inverse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/extensions/simulator/snapshot.py "view source code") + +Special case. Return self. + +### is\_parameterized + + + +`Snapshot.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`Snapshot.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`Snapshot.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`Snapshot.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`Snapshot.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`Snapshot.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`Snapshot.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label Return snapshot label - + ### params return instruction params. - + ### snapshot\_type Return snapshot type - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md b/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md index 1364bba0618..b465d1acd69 100644 --- a/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md +++ b/docs/api/qiskit/0.32/qiskit.extensions.UnitaryGate.md @@ -1,8 +1,16 @@ -# UnitaryGate +--- +title: UnitaryGate +description: API reference for qiskit.extensions.UnitaryGate +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.extensions.UnitaryGate +--- +# UnitaryGate + -`UnitaryGate(data, label=None)` +`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` @@ -12,7 +20,7 @@ Create a gate from a numeric unitary matrix. **Parameters** -* **data** (*matrix or* [*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – unitary operator. +* **data** (*matrix or* [*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – unitary operator. * **label** (*str*) – unitary name for backend \[Default: None]. **Raises** @@ -21,49 +29,337 @@ Create a gate from a numeric unitary matrix. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| [`add_decomposition`](qiskit.extensions.UnitaryGate.add_decomposition#qiskit.extensions.UnitaryGate.add_decomposition "qiskit.extensions.UnitaryGate.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`adjoint`](qiskit.extensions.UnitaryGate.adjoint#qiskit.extensions.UnitaryGate.adjoint "qiskit.extensions.UnitaryGate.adjoint") | Return the adjoint of the unitary. | -| [`assemble`](qiskit.extensions.UnitaryGate.assemble#qiskit.extensions.UnitaryGate.assemble "qiskit.extensions.UnitaryGate.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.extensions.UnitaryGate.broadcast_arguments#qiskit.extensions.UnitaryGate.broadcast_arguments "qiskit.extensions.UnitaryGate.broadcast_arguments") | Validation and handling of the arguments and its relationship. | -| [`c_if`](qiskit.extensions.UnitaryGate.c_if#qiskit.extensions.UnitaryGate.c_if "qiskit.extensions.UnitaryGate.c_if") | Add classical condition on register or cbit classical and value val. | -| [`conjugate`](qiskit.extensions.UnitaryGate.conjugate#qiskit.extensions.UnitaryGate.conjugate "qiskit.extensions.UnitaryGate.conjugate") | Return the conjugate of the unitary. | -| [`control`](qiskit.extensions.UnitaryGate.control#qiskit.extensions.UnitaryGate.control "qiskit.extensions.UnitaryGate.control") | Return controlled version of gate | -| [`copy`](qiskit.extensions.UnitaryGate.copy#qiskit.extensions.UnitaryGate.copy "qiskit.extensions.UnitaryGate.copy") | Copy of the instruction. | -| [`inverse`](qiskit.extensions.UnitaryGate.inverse#qiskit.extensions.UnitaryGate.inverse "qiskit.extensions.UnitaryGate.inverse") | Return the adjoint of the unitary. | -| [`is_parameterized`](qiskit.extensions.UnitaryGate.is_parameterized#qiskit.extensions.UnitaryGate.is_parameterized "qiskit.extensions.UnitaryGate.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.extensions.UnitaryGate.mirror#qiskit.extensions.UnitaryGate.mirror "qiskit.extensions.UnitaryGate.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`power`](qiskit.extensions.UnitaryGate.power#qiskit.extensions.UnitaryGate.power "qiskit.extensions.UnitaryGate.power") | Creates a unitary gate as gate^exponent. | -| [`qasm`](qiskit.extensions.UnitaryGate.qasm#qiskit.extensions.UnitaryGate.qasm "qiskit.extensions.UnitaryGate.qasm") | The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. | -| [`repeat`](qiskit.extensions.UnitaryGate.repeat#qiskit.extensions.UnitaryGate.repeat "qiskit.extensions.UnitaryGate.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.extensions.UnitaryGate.reverse_ops#qiskit.extensions.UnitaryGate.reverse_ops "qiskit.extensions.UnitaryGate.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.extensions.UnitaryGate.soft_compare#qiskit.extensions.UnitaryGate.soft_compare "qiskit.extensions.UnitaryGate.soft_compare") | Soft comparison between gates. | -| [`to_matrix`](qiskit.extensions.UnitaryGate.to_matrix#qiskit.extensions.UnitaryGate.to_matrix "qiskit.extensions.UnitaryGate.to_matrix") | Return a Numpy.array for the gate unitary matrix. | -| [`transpose`](qiskit.extensions.UnitaryGate.transpose#qiskit.extensions.UnitaryGate.transpose "qiskit.extensions.UnitaryGate.transpose") | Return the transpose of the unitary. | -| [`validate_parameter`](qiskit.extensions.UnitaryGate.validate_parameter#qiskit.extensions.UnitaryGate.validate_parameter "qiskit.extensions.UnitaryGate.validate_parameter") | Unitary gate parameter has to be an ndarray. | +### add\_decomposition -## Attributes + + +`UnitaryGate.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### adjoint + + + +`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. + +### assemble + + + +`UnitaryGate.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`UnitaryGate.broadcast_arguments(qargs, cargs)` + +Validation and handling of the arguments and its relationship. + +For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example: + +```python +in: [[q[0],q[1]], q[2]],[] +outs: [q[0], q[2]], [] + [q[1], q[2]], [] +``` + +The general broadcasting rules are: + +> * If len(qargs) == 1: +> +> ```python +> [q[0], q[1]] -> [q[0]],[q[1]] +> ``` +> +> * If len(qargs) == 2: +> +> ```python +> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]] +> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]] +> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]] +> ``` +> +> * If len(qargs) >= 3: +> +> ```python +> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...] +> ``` + +**Parameters** + +* **qargs** (`List`) – List of quantum bit arguments. +* **cargs** (`List`) – List of classical bit arguments. + +**Return type** + +`Tuple`\[`List`, `List`] + +**Returns** + +A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`UnitaryGate.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### conjugate + + + +`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. + +### control + + + +`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 + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – number of controls to add to gate (default=1) +* **label** (*str*) – optional gate label +* **ctrl\_state** (*int or str or None*) – The control state in decimal or as a bit string (e.g. ‘1011’). If None, use 2\*\*num\_ctrl\_qubits-1. + +**Returns** + +controlled version of gate. + +**Return type** + +[UnitaryGate](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") + +**Raises** + +* **QiskitError** – Invalid ctrl\_state. +* **ExtensionError** – Non-unitary controlled unitary. + +### copy + + + +`UnitaryGate.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`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. + +### is\_parameterized + + + +`UnitaryGate.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`UnitaryGate.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### power + + + +`UnitaryGate.power(exponent)` + +Creates a unitary gate as gate^exponent. + +**Parameters** + +**exponent** (*float*) – Gate^exponent + +**Returns** + +To which to\_matrix is self.to\_matrix^exponent. + +**Return type** + +[qiskit.extensions.UnitaryGate](qiskit.extensions.UnitaryGate "qiskit.extensions.UnitaryGate") + +**Raises** + +**CircuitError** – If Gate is not unitary + +### qasm + + + +`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. + +### repeat + + + +`UnitaryGate.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`UnitaryGate.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`UnitaryGate.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### to\_matrix + + + +`UnitaryGate.to_matrix()` + +Return a Numpy.array for the gate unitary matrix. + +**Returns** + +if the Gate subclass has a matrix definition. + +**Return type** + +np.ndarray + +**Raises** + +**CircuitError** – If a Gate subclass does not implement this method an exception will be raised when this base class method is called. + +### transpose + + + +`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. + +### validate\_parameter + + + +`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. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -73,14 +369,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + diff --git a/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md b/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md index 0c3fb8a2b3e..ab5c5a443aa 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md +++ b/docs/api/qiskit/0.32/qiskit.finance.QiskitFinanceError.md @@ -1,9 +1,18 @@ -# qiskit.finance.QiskitFinanceError +--- +title: QiskitFinanceError +description: API reference for qiskit.finance.QiskitFinanceError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.finance.QiskitFinanceError +--- +# qiskit.finance.QiskitFinanceError + -`QiskitFinanceError(*message)` +`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. Set the error message. + 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 116dd82a6c0..05de4ab6cb8 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 @@ -1,8 +1,16 @@ -# EuropeanCallDelta +--- +title: EuropeanCallDelta +description: API reference for qiskit.finance.components.uncertainty_problems.EuropeanCallDelta +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallDelta +--- +# EuropeanCallDelta + -`EuropeanCallDelta(uncertainty_model, strike_price, i_state=None, i_objective=None)` +`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` @@ -21,26 +29,144 @@ Constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_inverse#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_inverse "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_inverse_power#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_inverse_power "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_power#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_power "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_inverse#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_inverse "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_inverse_power#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_inverse_power "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_power#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_power "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.get_num_qubits#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.get_num_qubits "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.get_num_qubits_controlled#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.get_num_qubits_controlled "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.required_ancillas#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.required_ancillas "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.required_ancillas_controlled#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.required_ancillas_controlled "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.required_ancillas_controlled") | returns required ancillas controlled | -| [`value_to_estimation`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.value_to_estimation#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.value_to_estimation "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta.value_to_estimation") | value to estimate | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`EuropeanCallDelta.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + +`EuropeanCallDelta.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`EuropeanCallDelta.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`EuropeanCallDelta.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`EuropeanCallDelta.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`EuropeanCallDelta.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`EuropeanCallDelta.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`EuropeanCallDelta.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`EuropeanCallDelta.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`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 + +### value\_to\_estimation + + + +`EuropeanCallDelta.value_to_estimation(value)` + +value to estimate + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + 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 9396f74a680..392aea5a2ca 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 @@ -1,8 +1,16 @@ -# EuropeanCallExpectedValue +--- +title: EuropeanCallExpectedValue +description: API reference for qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue +--- +# EuropeanCallExpectedValue + -`EuropeanCallExpectedValue(uncertainty_model, strike_price, c_approx, i_state=None, i_compare=None, i_objective=None)` +`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` @@ -23,26 +31,144 @@ Constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_inverse#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_inverse "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_inverse_power#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_inverse_power "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_power#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_power "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_inverse#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_inverse "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_inverse_power#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_inverse_power "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_power#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_power "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.get_num_qubits#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.get_num_qubits "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.get_num_qubits_controlled#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.get_num_qubits_controlled "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.required_ancillas#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.required_ancillas "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.required_ancillas_controlled#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.required_ancillas_controlled "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.required_ancillas_controlled") | returns required ancillas controlled | -| [`value_to_estimation`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.value_to_estimation#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.value_to_estimation "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue.value_to_estimation") | value to estimate | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`EuropeanCallExpectedValue.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + +`EuropeanCallExpectedValue.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`EuropeanCallExpectedValue.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`EuropeanCallExpectedValue.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`EuropeanCallExpectedValue.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`EuropeanCallExpectedValue.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`EuropeanCallExpectedValue.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`EuropeanCallExpectedValue.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`EuropeanCallExpectedValue.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`EuropeanCallExpectedValue.required_ancillas_controlled()` + +returns required ancillas controlled + +### value\_to\_estimation + + + +`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 + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + 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 5c78bb1a63d..316c8b5f2a0 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 @@ -1,8 +1,16 @@ -# FixedIncomeExpectedValue +--- +title: FixedIncomeExpectedValue +description: API reference for qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue +--- +# FixedIncomeExpectedValue + -`FixedIncomeExpectedValue(uncertainty_model, A, b, cash_flow, c_approx, i_state=None, i_objective=None)` +`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` @@ -24,26 +32,144 @@ Constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`build`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build") | Adds corresponding sub-circuit to given circuit | -| [`build_controlled`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled") | Adds corresponding controlled sub-circuit to given circuit | -| [`build_controlled_inverse`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse") | Adds controlled inverse of corresponding sub-circuit to given circuit | -| [`build_controlled_inverse_power`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse_power#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse_power "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_inverse_power") | Adds controlled, inverse, power of corresponding circuit. | -| [`build_controlled_power`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_power#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_power "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_controlled_power") | Adds controlled power of corresponding circuit. | -| [`build_inverse`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse") | Adds inverse of corresponding sub-circuit to given circuit | -| [`build_inverse_power`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse_power#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse_power "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_inverse_power") | Adds inverse power of corresponding circuit. | -| [`build_power`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_power#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_power "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.build_power") | Adds power of corresponding circuit. | -| [`get_num_qubits`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits") | returns number of qubits | -| [`get_num_qubits_controlled`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits_controlled#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits_controlled "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.get_num_qubits_controlled") | returns number of qubits controlled | -| [`required_ancillas`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas") | returns required ancillas | -| [`required_ancillas_controlled`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas_controlled#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas_controlled "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.required_ancillas_controlled") | returns required ancillas controlled | -| [`value_to_estimation`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.value_to_estimation#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.value_to_estimation "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue.value_to_estimation") | value to estimate | +### build -## Attributes + + +`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 + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **params** (*list*) – parameters for circuit + +### build\_controlled + + + +`FixedIncomeExpectedValue.build_controlled(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` + +Adds corresponding controlled sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse + + +`FixedIncomeExpectedValue.build_controlled_inverse(qc, q, q_control, q_ancillas=None, use_basis_gates=True)` +Adds controlled inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_control** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – control qubit +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) +* **use\_basis\_gates** (*bool*) – use basis gates for expansion of controlled circuit + +### build\_controlled\_inverse\_power + + + +`FixedIncomeExpectedValue.build_controlled_inverse_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled, inverse, power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_controlled\_power + + + +`FixedIncomeExpectedValue.build_controlled_power(qc, q, q_control, power, q_ancillas=None, use_basis_gates=True)` + +Adds controlled power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_inverse + + + +`FixedIncomeExpectedValue.build_inverse(qc, q, q_ancillas=None)` + +Adds inverse of corresponding sub-circuit to given circuit + +**Parameters** + +* **qc** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – quantum circuit +* **q** (*list*) – list of qubits (has to be same length as self.\_num\_qubits) +* **q\_ancillas** (*list*) – list of ancilla qubits (or None if none needed) + +### build\_inverse\_power + + + +`FixedIncomeExpectedValue.build_inverse_power(qc, q, power, q_ancillas=None)` + +Adds inverse power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### build\_power + + + +`FixedIncomeExpectedValue.build_power(qc, q, power, q_ancillas=None)` + +Adds power of corresponding circuit. May be overridden if a more efficient implementation is possible + +### get\_num\_qubits + + + +`FixedIncomeExpectedValue.get_num_qubits()` + +returns number of qubits + +### get\_num\_qubits\_controlled + + + +`FixedIncomeExpectedValue.get_num_qubits_controlled()` + +returns number of qubits controlled + +### required\_ancillas + + + +`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 + +### required\_ancillas\_controlled + + + +`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 + +### value\_to\_estimation + + + +`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 + +## Attributes + + ### num\_target\_qubits Returns the number of target qubits + diff --git a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.md b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.md index e558c40d42a..3b26f8edb8c 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.md +++ b/docs/api/qiskit/0.32/qiskit.finance.components.uncertainty_problems.md @@ -16,13 +16,13 @@ python_api_name: qiskit.finance.components.uncertainty_problems `qiskit.finance.components.uncertainty_problems` -These are finance specific Aqua Uncertainty Problems where they inherit from Aqua [`UncertaintyProblem`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem#qiskit.aqua.components.uncertainty_problems.UncertaintyProblem "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem"). Because they rely on finance specific knowledge and/or functions they are located here rather than in Aqua. +These are finance specific Aqua Uncertainty Problems where they inherit from Aqua [`UncertaintyProblem`](qiskit.aqua.components.uncertainty_problems.UncertaintyProblem "qiskit.aqua.components.uncertainty_problems.UncertaintyProblem"). Because they rely on finance specific knowledge and/or functions they are located here rather than in Aqua. # Uncertainty Problems -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`EuropeanCallDelta`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta#qiskit.finance.components.uncertainty_problems.EuropeanCallDelta "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta") | The European Call Option Delta. | -| [`EuropeanCallExpectedValue`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue#qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue") | The European Call Option Expected Value. | -| [`FixedIncomeExpectedValue`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue#qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue") | The Fixed Income Expected Value. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| [`EuropeanCallDelta`](qiskit.finance.components.uncertainty_problems.EuropeanCallDelta "qiskit.finance.components.uncertainty_problems.EuropeanCallDelta") | The European Call Option Delta. | +| [`EuropeanCallExpectedValue`](qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue "qiskit.finance.components.uncertainty_problems.EuropeanCallExpectedValue") | The European Call Option Expected Value. | +| [`FixedIncomeExpectedValue`](qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue "qiskit.finance.components.uncertainty_problems.FixedIncomeExpectedValue") | The Fixed Income Expected Value. | 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 9e34bb26f8a..fb1cdeb326d 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 @@ -1,8 +1,16 @@ -# BaseDataProvider +--- +title: BaseDataProvider +description: API reference for qiskit.finance.data_providers.BaseDataProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.data_providers.BaseDataProvider +--- +# BaseDataProvider + -`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") Bases: `abc.ABC` @@ -14,12 +22,127 @@ To use the subclasses, please see [https://github.com/Qiskit/qiskit-tutorials/bl ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`get_coordinates`](qiskit.finance.data_providers.BaseDataProvider.get_coordinates#qiskit.finance.data_providers.BaseDataProvider.get_coordinates "qiskit.finance.data_providers.BaseDataProvider.get_coordinates") | Returns random coordinates for visualisation purposes. | -| [`get_covariance_matrix`](qiskit.finance.data_providers.BaseDataProvider.get_covariance_matrix#qiskit.finance.data_providers.BaseDataProvider.get_covariance_matrix "qiskit.finance.data_providers.BaseDataProvider.get_covariance_matrix") | Returns the covariance matrix. | -| [`get_mean_vector`](qiskit.finance.data_providers.BaseDataProvider.get_mean_vector#qiskit.finance.data_providers.BaseDataProvider.get_mean_vector "qiskit.finance.data_providers.BaseDataProvider.get_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_covariance_matrix`](qiskit.finance.data_providers.BaseDataProvider.get_period_return_covariance_matrix#qiskit.finance.data_providers.BaseDataProvider.get_period_return_covariance_matrix "qiskit.finance.data_providers.BaseDataProvider.get_period_return_covariance_matrix") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_mean_vector`](qiskit.finance.data_providers.BaseDataProvider.get_period_return_mean_vector#qiskit.finance.data_providers.BaseDataProvider.get_period_return_mean_vector "qiskit.finance.data_providers.BaseDataProvider.get_period_return_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_similarity_matrix`](qiskit.finance.data_providers.BaseDataProvider.get_similarity_matrix#qiskit.finance.data_providers.BaseDataProvider.get_similarity_matrix "qiskit.finance.data_providers.BaseDataProvider.get_similarity_matrix") | Returns time-series similarity matrix computed using dynamic time warping. | -| [`run`](qiskit.finance.data_providers.BaseDataProvider.run#qiskit.finance.data_providers.BaseDataProvider.run "qiskit.finance.data_providers.BaseDataProvider.run") | Loads data. | +### get\_coordinates + + + +`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. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +### get\_covariance\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset covariance matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_mean\_vector + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_covariance\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_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") + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_similarity\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset similarity matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### run + + + +`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. + +**Return type** + +`None` + 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 fd4d21d00e9..94753becaed 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 @@ -1,8 +1,16 @@ -# DataOnDemandProvider +--- +title: DataOnDemandProvider +description: API reference for qiskit.finance.data_providers.DataOnDemandProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.data_providers.DataOnDemandProvider +--- +# DataOnDemandProvider + -`DataOnDemandProvider(token, tickers, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), verify=None)` +`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` @@ -20,12 +28,127 @@ Please see: [https://github.com/Qiskit/qiskit-tutorials/blob/master/tutorials/fi ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| [`get_coordinates`](qiskit.finance.data_providers.DataOnDemandProvider.get_coordinates#qiskit.finance.data_providers.DataOnDemandProvider.get_coordinates "qiskit.finance.data_providers.DataOnDemandProvider.get_coordinates") | Returns random coordinates for visualisation purposes. | -| [`get_covariance_matrix`](qiskit.finance.data_providers.DataOnDemandProvider.get_covariance_matrix#qiskit.finance.data_providers.DataOnDemandProvider.get_covariance_matrix "qiskit.finance.data_providers.DataOnDemandProvider.get_covariance_matrix") | Returns the covariance matrix. | -| [`get_mean_vector`](qiskit.finance.data_providers.DataOnDemandProvider.get_mean_vector#qiskit.finance.data_providers.DataOnDemandProvider.get_mean_vector "qiskit.finance.data_providers.DataOnDemandProvider.get_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_covariance_matrix`](qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_covariance_matrix#qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_covariance_matrix "qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_covariance_matrix") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_mean_vector`](qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_mean_vector#qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_mean_vector "qiskit.finance.data_providers.DataOnDemandProvider.get_period_return_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_similarity_matrix`](qiskit.finance.data_providers.DataOnDemandProvider.get_similarity_matrix#qiskit.finance.data_providers.DataOnDemandProvider.get_similarity_matrix "qiskit.finance.data_providers.DataOnDemandProvider.get_similarity_matrix") | Returns time-series similarity matrix computed using dynamic time warping. | -| [`run`](qiskit.finance.data_providers.DataOnDemandProvider.run#qiskit.finance.data_providers.DataOnDemandProvider.run "qiskit.finance.data_providers.DataOnDemandProvider.run") | Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. | +### get\_coordinates + + + +`DataOnDemandProvider.get_coordinates()` + +Returns random coordinates for visualisation purposes. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +### get\_covariance\_matrix + + + +`DataOnDemandProvider.get_covariance_matrix()` + +Returns the covariance matrix. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset covariance matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_mean\_vector + + + +`DataOnDemandProvider.get_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_covariance\_matrix + + + +`DataOnDemandProvider.get_period_return_covariance_matrix()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_mean\_vector + + + +`DataOnDemandProvider.get_period_return_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_similarity\_matrix + + + +`DataOnDemandProvider.get_similarity_matrix()` + +Returns time-series similarity matrix computed using dynamic time warping. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset similarity matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### run + + + +`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. + +**Return type** + +`None` + 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 69662e4c6a3..e1cc0617a79 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 @@ -1,8 +1,16 @@ -# ExchangeDataProvider +--- +title: ExchangeDataProvider +description: API reference for qiskit.finance.data_providers.ExchangeDataProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.data_providers.ExchangeDataProvider +--- +# ExchangeDataProvider + -`ExchangeDataProvider(token, tickers, stockmarket=, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` +`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` @@ -14,17 +22,132 @@ Initializer :type token: `str` :param token: quandl access token :type tickers: **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Quandl not installed -* [**QiskitFinanceError**](qiskit.finance.QiskitFinanceError#qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – provider doesn’t support given stock market +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Quandl not installed +* [**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – provider doesn’t support given stock market ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| [`get_coordinates`](qiskit.finance.data_providers.ExchangeDataProvider.get_coordinates#qiskit.finance.data_providers.ExchangeDataProvider.get_coordinates "qiskit.finance.data_providers.ExchangeDataProvider.get_coordinates") | Returns random coordinates for visualisation purposes. | -| [`get_covariance_matrix`](qiskit.finance.data_providers.ExchangeDataProvider.get_covariance_matrix#qiskit.finance.data_providers.ExchangeDataProvider.get_covariance_matrix "qiskit.finance.data_providers.ExchangeDataProvider.get_covariance_matrix") | Returns the covariance matrix. | -| [`get_mean_vector`](qiskit.finance.data_providers.ExchangeDataProvider.get_mean_vector#qiskit.finance.data_providers.ExchangeDataProvider.get_mean_vector "qiskit.finance.data_providers.ExchangeDataProvider.get_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_covariance_matrix`](qiskit.finance.data_providers.ExchangeDataProvider.get_period_return_covariance_matrix#qiskit.finance.data_providers.ExchangeDataProvider.get_period_return_covariance_matrix "qiskit.finance.data_providers.ExchangeDataProvider.get_period_return_covariance_matrix") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_mean_vector`](qiskit.finance.data_providers.ExchangeDataProvider.get_period_return_mean_vector#qiskit.finance.data_providers.ExchangeDataProvider.get_period_return_mean_vector "qiskit.finance.data_providers.ExchangeDataProvider.get_period_return_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_similarity_matrix`](qiskit.finance.data_providers.ExchangeDataProvider.get_similarity_matrix#qiskit.finance.data_providers.ExchangeDataProvider.get_similarity_matrix "qiskit.finance.data_providers.ExchangeDataProvider.get_similarity_matrix") | Returns time-series similarity matrix computed using dynamic time warping. | -| [`run`](qiskit.finance.data_providers.ExchangeDataProvider.run#qiskit.finance.data_providers.ExchangeDataProvider.run "qiskit.finance.data_providers.ExchangeDataProvider.run") | Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. | +### get\_coordinates + + + +`ExchangeDataProvider.get_coordinates()` + +Returns random coordinates for visualisation purposes. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +### get\_covariance\_matrix + + + +`ExchangeDataProvider.get_covariance_matrix()` + +Returns the covariance matrix. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset covariance matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_mean\_vector + + + +`ExchangeDataProvider.get_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_covariance\_matrix + + + +`ExchangeDataProvider.get_period_return_covariance_matrix()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_mean\_vector + + + +`ExchangeDataProvider.get_period_return_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_similarity\_matrix + + + +`ExchangeDataProvider.get_similarity_matrix()` + +Returns time-series similarity matrix computed using dynamic time warping. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset similarity matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### run + + + +`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. + +**Return type** + +`None` + 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 9d2f7a324e1..1bcbc4c4948 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 @@ -1,8 +1,16 @@ -# RandomDataProvider +--- +title: RandomDataProvider +description: API reference for qiskit.finance.data_providers.RandomDataProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.data_providers.RandomDataProvider +--- +# RandomDataProvider + -`RandomDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0), seed=None)` +`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` @@ -12,16 +20,131 @@ Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param ticker **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Pandas not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Pandas not installed ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| [`get_coordinates`](qiskit.finance.data_providers.RandomDataProvider.get_coordinates#qiskit.finance.data_providers.RandomDataProvider.get_coordinates "qiskit.finance.data_providers.RandomDataProvider.get_coordinates") | Returns random coordinates for visualisation purposes. | -| [`get_covariance_matrix`](qiskit.finance.data_providers.RandomDataProvider.get_covariance_matrix#qiskit.finance.data_providers.RandomDataProvider.get_covariance_matrix "qiskit.finance.data_providers.RandomDataProvider.get_covariance_matrix") | Returns the covariance matrix. | -| [`get_mean_vector`](qiskit.finance.data_providers.RandomDataProvider.get_mean_vector#qiskit.finance.data_providers.RandomDataProvider.get_mean_vector "qiskit.finance.data_providers.RandomDataProvider.get_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_covariance_matrix`](qiskit.finance.data_providers.RandomDataProvider.get_period_return_covariance_matrix#qiskit.finance.data_providers.RandomDataProvider.get_period_return_covariance_matrix "qiskit.finance.data_providers.RandomDataProvider.get_period_return_covariance_matrix") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_mean_vector`](qiskit.finance.data_providers.RandomDataProvider.get_period_return_mean_vector#qiskit.finance.data_providers.RandomDataProvider.get_period_return_mean_vector "qiskit.finance.data_providers.RandomDataProvider.get_period_return_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_similarity_matrix`](qiskit.finance.data_providers.RandomDataProvider.get_similarity_matrix#qiskit.finance.data_providers.RandomDataProvider.get_similarity_matrix "qiskit.finance.data_providers.RandomDataProvider.get_similarity_matrix") | Returns time-series similarity matrix computed using dynamic time warping. | -| [`run`](qiskit.finance.data_providers.RandomDataProvider.run#qiskit.finance.data_providers.RandomDataProvider.run "qiskit.finance.data_providers.RandomDataProvider.run") | Generates data pseudo-randomly, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. | +### get\_coordinates + + + +`RandomDataProvider.get_coordinates()` + +Returns random coordinates for visualisation purposes. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +### get\_covariance\_matrix + + + +`RandomDataProvider.get_covariance_matrix()` + +Returns the covariance matrix. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset covariance matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_mean\_vector + + + +`RandomDataProvider.get_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_covariance\_matrix + + + +`RandomDataProvider.get_period_return_covariance_matrix()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_mean\_vector + + + +`RandomDataProvider.get_period_return_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_similarity\_matrix + + + +`RandomDataProvider.get_similarity_matrix()` + +Returns time-series similarity matrix computed using dynamic time warping. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset similarity matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### run + + + +`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. + +**Return type** + +`None` + 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 0859004c9af..52aba5452c7 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 @@ -1,8 +1,16 @@ -# StockMarket +--- +title: StockMarket +description: API reference for qiskit.finance.data_providers.StockMarket +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.data_providers.StockMarket +--- +# StockMarket + -`StockMarket(value)` +`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` @@ -10,20 +18,21 @@ Stock Market enum ## Attributes - + ### EURONEXT `= 'XPAR'` - + ### LONDON `= 'XLON'` - + ### SINGAPORE `= 'XSES'` + 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 642af355349..f19acad7323 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 @@ -1,8 +1,16 @@ -# WikipediaDataProvider +--- +title: WikipediaDataProvider +description: API reference for qiskit.finance.data_providers.WikipediaDataProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.data_providers.WikipediaDataProvider +--- +# WikipediaDataProvider + -`WikipediaDataProvider(token=None, tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` +`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` @@ -18,12 +26,127 @@ Initializer :type token: `Optional`\[`str`] :param token: quandl access token, w ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- | -| [`get_coordinates`](qiskit.finance.data_providers.WikipediaDataProvider.get_coordinates#qiskit.finance.data_providers.WikipediaDataProvider.get_coordinates "qiskit.finance.data_providers.WikipediaDataProvider.get_coordinates") | Returns random coordinates for visualisation purposes. | -| [`get_covariance_matrix`](qiskit.finance.data_providers.WikipediaDataProvider.get_covariance_matrix#qiskit.finance.data_providers.WikipediaDataProvider.get_covariance_matrix "qiskit.finance.data_providers.WikipediaDataProvider.get_covariance_matrix") | Returns the covariance matrix. | -| [`get_mean_vector`](qiskit.finance.data_providers.WikipediaDataProvider.get_mean_vector#qiskit.finance.data_providers.WikipediaDataProvider.get_mean_vector "qiskit.finance.data_providers.WikipediaDataProvider.get_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_covariance_matrix`](qiskit.finance.data_providers.WikipediaDataProvider.get_period_return_covariance_matrix#qiskit.finance.data_providers.WikipediaDataProvider.get_period_return_covariance_matrix "qiskit.finance.data_providers.WikipediaDataProvider.get_period_return_covariance_matrix") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_mean_vector`](qiskit.finance.data_providers.WikipediaDataProvider.get_period_return_mean_vector#qiskit.finance.data_providers.WikipediaDataProvider.get_period_return_mean_vector "qiskit.finance.data_providers.WikipediaDataProvider.get_period_return_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_similarity_matrix`](qiskit.finance.data_providers.WikipediaDataProvider.get_similarity_matrix#qiskit.finance.data_providers.WikipediaDataProvider.get_similarity_matrix "qiskit.finance.data_providers.WikipediaDataProvider.get_similarity_matrix") | Returns time-series similarity matrix computed using dynamic time warping. | -| [`run`](qiskit.finance.data_providers.WikipediaDataProvider.run#qiskit.finance.data_providers.WikipediaDataProvider.run "qiskit.finance.data_providers.WikipediaDataProvider.run") | Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. | +### get\_coordinates + + + +`WikipediaDataProvider.get_coordinates()` + +Returns random coordinates for visualisation purposes. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +### get\_covariance\_matrix + + + +`WikipediaDataProvider.get_covariance_matrix()` + +Returns the covariance matrix. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset covariance matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_mean\_vector + + + +`WikipediaDataProvider.get_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_covariance\_matrix + + + +`WikipediaDataProvider.get_period_return_covariance_matrix()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_mean\_vector + + + +`WikipediaDataProvider.get_period_return_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_similarity\_matrix + + + +`WikipediaDataProvider.get_similarity_matrix()` + +Returns time-series similarity matrix computed using dynamic time warping. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset similarity matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### run + + + +`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. + +**Return type** + +`None` + 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 754132e66c6..2ee584d5c10 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 @@ -1,8 +1,16 @@ -# YahooDataProvider +--- +title: YahooDataProvider +description: API reference for qiskit.finance.data_providers.YahooDataProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.finance.data_providers.YahooDataProvider +--- +# YahooDataProvider + -`YahooDataProvider(tickers=None, start=datetime.datetime(2016, 1, 1, 0, 0), end=datetime.datetime(2016, 1, 30, 0, 0))` +`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` @@ -14,16 +22,131 @@ Initializer :type tickers: `Union`\[`str`, `List`\[`str`], `None`] :param ticker **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – YFinance not installed +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – YFinance not installed ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- | -| [`get_coordinates`](qiskit.finance.data_providers.YahooDataProvider.get_coordinates#qiskit.finance.data_providers.YahooDataProvider.get_coordinates "qiskit.finance.data_providers.YahooDataProvider.get_coordinates") | Returns random coordinates for visualisation purposes. | -| [`get_covariance_matrix`](qiskit.finance.data_providers.YahooDataProvider.get_covariance_matrix#qiskit.finance.data_providers.YahooDataProvider.get_covariance_matrix "qiskit.finance.data_providers.YahooDataProvider.get_covariance_matrix") | Returns the covariance matrix. | -| [`get_mean_vector`](qiskit.finance.data_providers.YahooDataProvider.get_mean_vector#qiskit.finance.data_providers.YahooDataProvider.get_mean_vector "qiskit.finance.data_providers.YahooDataProvider.get_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_covariance_matrix`](qiskit.finance.data_providers.YahooDataProvider.get_period_return_covariance_matrix#qiskit.finance.data_providers.YahooDataProvider.get_period_return_covariance_matrix "qiskit.finance.data_providers.YahooDataProvider.get_period_return_covariance_matrix") | Returns a vector containing the mean value of each asset. | -| [`get_period_return_mean_vector`](qiskit.finance.data_providers.YahooDataProvider.get_period_return_mean_vector#qiskit.finance.data_providers.YahooDataProvider.get_period_return_mean_vector "qiskit.finance.data_providers.YahooDataProvider.get_period_return_mean_vector") | Returns a vector containing the mean value of each asset. | -| [`get_similarity_matrix`](qiskit.finance.data_providers.YahooDataProvider.get_similarity_matrix#qiskit.finance.data_providers.YahooDataProvider.get_similarity_matrix "qiskit.finance.data_providers.YahooDataProvider.get_similarity_matrix") | Returns time-series similarity matrix computed using dynamic time warping. | -| [`run`](qiskit.finance.data_providers.YahooDataProvider.run#qiskit.finance.data_providers.YahooDataProvider.run "qiskit.finance.data_providers.YahooDataProvider.run") | Loads data, thus enabling get\_similarity\_matrix and get\_covariance\_matrix methods in the base class. | +### get\_coordinates + + + +`YahooDataProvider.get_coordinates()` + +Returns random coordinates for visualisation purposes. + +**Return type** + +`Tuple`\[`ndarray`, `ndarray`] + +### get\_covariance\_matrix + + + +`YahooDataProvider.get_covariance_matrix()` + +Returns the covariance matrix. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset covariance matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_mean\_vector + + + +`YahooDataProvider.get_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_covariance\_matrix + + + +`YahooDataProvider.get_period_return_covariance_matrix()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_period\_return\_mean\_vector + + + +`YahooDataProvider.get_period_return_mean_vector()` + +Returns a vector containing the mean value of each asset. + +**Return type** + +`ndarray` + +**Returns** + +a per-asset mean vector. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### get\_similarity\_matrix + + + +`YahooDataProvider.get_similarity_matrix()` + +Returns time-series similarity matrix computed using dynamic time warping. + +**Return type** + +`ndarray` + +**Returns** + +an asset-to-asset similarity matrix. + +**Raises** + +[**QiskitFinanceError**](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") – no data loaded + +### run + + + +`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. + +**Return type** + +`None` + diff --git a/docs/api/qiskit/0.32/qiskit.finance.data_providers.md b/docs/api/qiskit/0.32/qiskit.finance.data_providers.md index 2a5d5954ce6..e6ba2980b00 100644 --- a/docs/api/qiskit/0.32/qiskit.finance.data_providers.md +++ b/docs/api/qiskit/0.32/qiskit.finance.data_providers.md @@ -20,23 +20,23 @@ A selection of providers for financial data. These may be backed by an external # Data Provider Base Class -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [`BaseDataProvider`](qiskit.finance.data_providers.BaseDataProvider#qiskit.finance.data_providers.BaseDataProvider "qiskit.finance.data_providers.BaseDataProvider") | The abstract base class for data\_provider modules within Qiskit’s finance module. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| [`BaseDataProvider`](qiskit.finance.data_providers.BaseDataProvider "qiskit.finance.data_providers.BaseDataProvider") | The abstract base class for data\_provider modules within Qiskit’s finance module. | # Data Provider Types -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | -| [`StockMarket`](qiskit.finance.data_providers.StockMarket#qiskit.finance.data_providers.StockMarket "qiskit.finance.data_providers.StockMarket") | Stock Market enum | +| | | +| ------------------------------------------------------------------------------------------------------ | ----------------- | +| [`StockMarket`](qiskit.finance.data_providers.StockMarket "qiskit.finance.data_providers.StockMarket") | Stock Market enum | # Data Providers -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [`DataOnDemandProvider`](qiskit.finance.data_providers.DataOnDemandProvider#qiskit.finance.data_providers.DataOnDemandProvider "qiskit.finance.data_providers.DataOnDemandProvider") | NASDAQ Data on Demand data provider. | -| [`ExchangeDataProvider`](qiskit.finance.data_providers.ExchangeDataProvider#qiskit.finance.data_providers.ExchangeDataProvider "qiskit.finance.data_providers.ExchangeDataProvider") | Exchange data provider. | -| [`WikipediaDataProvider`](qiskit.finance.data_providers.WikipediaDataProvider#qiskit.finance.data_providers.WikipediaDataProvider "qiskit.finance.data_providers.WikipediaDataProvider") | Wikipedia data provider. | -| [`YahooDataProvider`](qiskit.finance.data_providers.YahooDataProvider#qiskit.finance.data_providers.YahooDataProvider "qiskit.finance.data_providers.YahooDataProvider") | Yahoo data provider. | -| [`RandomDataProvider`](qiskit.finance.data_providers.RandomDataProvider#qiskit.finance.data_providers.RandomDataProvider "qiskit.finance.data_providers.RandomDataProvider") | Pseudo-randomly generated mock stock-market data provider. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- | +| [`DataOnDemandProvider`](qiskit.finance.data_providers.DataOnDemandProvider "qiskit.finance.data_providers.DataOnDemandProvider") | NASDAQ Data on Demand data provider. | +| [`ExchangeDataProvider`](qiskit.finance.data_providers.ExchangeDataProvider "qiskit.finance.data_providers.ExchangeDataProvider") | Exchange data provider. | +| [`WikipediaDataProvider`](qiskit.finance.data_providers.WikipediaDataProvider "qiskit.finance.data_providers.WikipediaDataProvider") | Wikipedia data provider. | +| [`YahooDataProvider`](qiskit.finance.data_providers.YahooDataProvider "qiskit.finance.data_providers.YahooDataProvider") | Yahoo data provider. | +| [`RandomDataProvider`](qiskit.finance.data_providers.RandomDataProvider "qiskit.finance.data_providers.RandomDataProvider") | Pseudo-randomly generated mock stock-market data provider. | 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 4a892aa8e17..dd9d483900a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalCXFitter.md @@ -1,8 +1,16 @@ -# AmpCalCXFitter +--- +title: AmpCalCXFitter +description: API reference for qiskit.ignis.characterization.AmpCalCXFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.AmpCalCXFitter +--- +# AmpCalCXFitter + -`AmpCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` +`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` @@ -12,16 +20,87 @@ See BaseFitter \_\_init\_\_ ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.AmpCalCXFitter.add_data#qiskit.ignis.characterization.AmpCalCXFitter.add_data "qiskit.ignis.characterization.AmpCalCXFitter.add_data") | Add new execution results to previous execution results | -| [`angle_err`](qiskit.ignis.characterization.AmpCalCXFitter.angle_err#qiskit.ignis.characterization.AmpCalCXFitter.angle_err "qiskit.ignis.characterization.AmpCalCXFitter.angle_err") | Return the gate angle error | -| [`fit_data`](qiskit.ignis.characterization.AmpCalCXFitter.fit_data#qiskit.ignis.characterization.AmpCalCXFitter.fit_data "qiskit.ignis.characterization.AmpCalCXFitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.AmpCalCXFitter.plot#qiskit.ignis.characterization.AmpCalCXFitter.plot "qiskit.ignis.characterization.AmpCalCXFitter.plot") | Plot err data. | +### add\_data -## Attributes + + +`AmpCalCXFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### angle\_err + + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index to return (-1 return all) + +**Returns** + +a list of errors + +**Return type** + +list + +### fit\_data + + + +`AmpCalCXFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) +### plot + + + +`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. + +**Parameters** + +* **qind** (*int*) – qubit index to plot +* **series** (*str*) – the series to plot +* **ax** (*Axes*) – plot axes +* **show\_plot** (*bool*) – call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +## Attributes + + ### backend\_result @@ -31,7 +110,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -41,7 +120,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -51,7 +130,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -61,7 +140,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -71,7 +150,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -81,7 +160,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -91,7 +170,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -101,7 +180,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -120,3 +199,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 96ac0a2edff..d0f88c08567 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AmpCalFitter.md @@ -1,8 +1,16 @@ -# AmpCalFitter +--- +title: AmpCalFitter +description: API reference for qiskit.ignis.characterization.AmpCalFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.AmpCalFitter +--- +# AmpCalFitter + -`AmpCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` +`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` @@ -12,17 +20,107 @@ See BaseFitter \_\_init\_\_ ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.AmpCalFitter.add_data#qiskit.ignis.characterization.AmpCalFitter.add_data "qiskit.ignis.characterization.AmpCalFitter.add_data") | Add new execution results to previous execution results | -| [`angle_err`](qiskit.ignis.characterization.AmpCalFitter.angle_err#qiskit.ignis.characterization.AmpCalFitter.angle_err "qiskit.ignis.characterization.AmpCalFitter.angle_err") | Return the gate angle error | -| [`fit_data`](qiskit.ignis.characterization.AmpCalFitter.fit_data#qiskit.ignis.characterization.AmpCalFitter.fit_data "qiskit.ignis.characterization.AmpCalFitter.fit_data") | Fit the curve. | -| [`guess_params`](qiskit.ignis.characterization.AmpCalFitter.guess_params#qiskit.ignis.characterization.AmpCalFitter.guess_params "qiskit.ignis.characterization.AmpCalFitter.guess_params") | Guess fit parameters for the amp cal | -| [`plot`](qiskit.ignis.characterization.AmpCalFitter.plot#qiskit.ignis.characterization.AmpCalFitter.plot "qiskit.ignis.characterization.AmpCalFitter.plot") | Plot err data. | +### add\_data -## Attributes + + +`AmpCalFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### angle\_err + + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index to return (-1 return all) + +**Returns** + +a list of errors + +**Return type** + +list + +### fit\_data + + + +`AmpCalFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### guess\_params + + + +`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 + +**Parameters** +**qind** (*int*) – qubit index to guess fit parameters for +**Returns** + +List of fit guess parameters \[thetaerr, offset] + +**Return type** + +list + +### plot + + + +`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. + +**Parameters** + +* **qind** (*int*) – qubit index to plot +* **series** (*str*) – the series to plot +* **ax** (*Axes*) – plot axes +* **show\_plot** (*bool*) – call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +## Attributes + + ### backend\_result @@ -32,7 +130,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -42,7 +140,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -52,7 +150,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -62,7 +160,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -72,7 +170,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -82,7 +180,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -92,7 +190,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -102,7 +200,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -121,3 +219,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 13db4e8609c..90e5c8b58f0 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalCXFitter.md @@ -1,8 +1,16 @@ -# AngleCalCXFitter +--- +title: AngleCalCXFitter +description: API reference for qiskit.ignis.characterization.AngleCalCXFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.AngleCalCXFitter +--- +# AngleCalCXFitter + -`AngleCalCXFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` +`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` @@ -12,16 +20,87 @@ See BaseFitter \_\_init\_\_ ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.AngleCalCXFitter.add_data#qiskit.ignis.characterization.AngleCalCXFitter.add_data "qiskit.ignis.characterization.AngleCalCXFitter.add_data") | Add new execution results to previous execution results | -| [`angle_err`](qiskit.ignis.characterization.AngleCalCXFitter.angle_err#qiskit.ignis.characterization.AngleCalCXFitter.angle_err "qiskit.ignis.characterization.AngleCalCXFitter.angle_err") | Return the gate angle error | -| [`fit_data`](qiskit.ignis.characterization.AngleCalCXFitter.fit_data#qiskit.ignis.characterization.AngleCalCXFitter.fit_data "qiskit.ignis.characterization.AngleCalCXFitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.AngleCalCXFitter.plot#qiskit.ignis.characterization.AngleCalCXFitter.plot "qiskit.ignis.characterization.AngleCalCXFitter.plot") | Plot err data. | +### add\_data -## Attributes + + +`AngleCalCXFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### angle\_err + + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index to return (-1 return all) + +**Returns** + +a list of errors + +**Return type** + +list + +### fit\_data + + + +`AngleCalCXFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) +### plot + + + +`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. + +**Parameters** + +* **qind** (*int*) – qubit index to plot +* **series** (*str*) – the series to plot +* **ax** (*Axes*) – plot axes +* **show\_plot** (*bool*) – call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +## Attributes + + ### backend\_result @@ -31,7 +110,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -41,7 +120,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -51,7 +130,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -61,7 +140,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -71,7 +150,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -81,7 +160,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -91,7 +170,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -101,7 +180,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -120,3 +199,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 1f8b7069657..fd940e7ee8c 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.AngleCalFitter.md @@ -1,8 +1,16 @@ -# AngleCalFitter +--- +title: AngleCalFitter +description: API reference for qiskit.ignis.characterization.AngleCalFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.AngleCalFitter +--- +# AngleCalFitter + -`AngleCalFitter(backend_result, xdata, qubits, fit_p0, fit_bounds)` +`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` @@ -12,16 +20,87 @@ See BaseFitter \_\_init\_\_ ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.AngleCalFitter.add_data#qiskit.ignis.characterization.AngleCalFitter.add_data "qiskit.ignis.characterization.AngleCalFitter.add_data") | Add new execution results to previous execution results | -| [`angle_err`](qiskit.ignis.characterization.AngleCalFitter.angle_err#qiskit.ignis.characterization.AngleCalFitter.angle_err "qiskit.ignis.characterization.AngleCalFitter.angle_err") | Return the gate angle error | -| [`fit_data`](qiskit.ignis.characterization.AngleCalFitter.fit_data#qiskit.ignis.characterization.AngleCalFitter.fit_data "qiskit.ignis.characterization.AngleCalFitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.AngleCalFitter.plot#qiskit.ignis.characterization.AngleCalFitter.plot "qiskit.ignis.characterization.AngleCalFitter.plot") | Plot err data. | +### add\_data -## Attributes + + +`AngleCalFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### angle\_err + + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index to return (-1 return all) + +**Returns** + +a list of errors + +**Return type** + +list + +### fit\_data + + + +`AngleCalFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) +### plot + + + +`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. + +**Parameters** + +* **qind** (*int*) – qubit index to plot +* **series** (*str*) – the series to plot +* **ax** (*Axes*) – plot axes +* **show\_plot** (*bool*) – call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +## Attributes + + ### backend\_result @@ -31,7 +110,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -41,7 +120,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -51,7 +130,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -61,7 +140,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -71,7 +150,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -81,7 +160,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -91,7 +170,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -101,7 +180,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -120,3 +199,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 5bacfe3cadd..c71f6cc0b9a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseCoherenceFitter.md @@ -1,8 +1,16 @@ -# BaseCoherenceFitter +--- +title: BaseCoherenceFitter +description: API reference for qiskit.ignis.characterization.BaseCoherenceFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.BaseCoherenceFitter +--- +# 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')` +`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` @@ -25,17 +33,109 @@ Base class for fitters of characteristic times ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.BaseCoherenceFitter.add_data#qiskit.ignis.characterization.BaseCoherenceFitter.add_data "qiskit.ignis.characterization.BaseCoherenceFitter.add_data") | Add new execution results to previous execution results | -| [`fit_data`](qiskit.ignis.characterization.BaseCoherenceFitter.fit_data#qiskit.ignis.characterization.BaseCoherenceFitter.fit_data "qiskit.ignis.characterization.BaseCoherenceFitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.BaseCoherenceFitter.plot#qiskit.ignis.characterization.BaseCoherenceFitter.plot "qiskit.ignis.characterization.BaseCoherenceFitter.plot") | Plot coherence data. | -| [`time`](qiskit.ignis.characterization.BaseCoherenceFitter.time#qiskit.ignis.characterization.BaseCoherenceFitter.time "qiskit.ignis.characterization.BaseCoherenceFitter.time") | Return the characteristic time for the given qubit and series | -| [`time_err`](qiskit.ignis.characterization.BaseCoherenceFitter.time_err#qiskit.ignis.characterization.BaseCoherenceFitter.time_err "qiskit.ignis.characterization.BaseCoherenceFitter.time_err") | Return the error of characteristic time for the given qubit and series | +### add\_data -## Attributes + + +`BaseCoherenceFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### fit\_data + + + +`BaseCoherenceFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### plot + + + +`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. + +**Parameters** + +* **qind** (`int`) – qubit index to plot +* **series** (`str`) – which series to plot (if list then plot multiple) +* **ax** (`Optional`\[`Any`]) – plot axes +* **show\_plot** (`bool`) – whether to call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +### time + + +`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 + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The characteristic time of the qubit, or all qubits + +### time\_err + + + +`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 + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The error of the characteristic time of the qubit, or all qubits + +## Attributes + + ### backend\_result @@ -45,7 +145,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -55,7 +155,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -65,7 +165,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -75,7 +175,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -85,7 +185,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -95,7 +195,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -105,7 +205,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -115,7 +215,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -134,3 +234,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 73098bb0e8c..1cec73b08a3 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.BaseGateFitter.md @@ -1,8 +1,16 @@ -# BaseGateFitter +--- +title: BaseGateFitter +description: API reference for qiskit.ignis.characterization.BaseGateFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.BaseGateFitter +--- +# BaseGateFitter + -`BaseGateFitter(description, backend_result, xdata, qubits, fit_fun, fit_p0, fit_bounds, circuit_names, series=None, expected_state='0')` +`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` @@ -12,15 +20,67 @@ See BaseFitter \_\_init\_\_ ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.BaseGateFitter.add_data#qiskit.ignis.characterization.BaseGateFitter.add_data "qiskit.ignis.characterization.BaseGateFitter.add_data") | Add new execution results to previous execution results | -| [`fit_data`](qiskit.ignis.characterization.BaseGateFitter.fit_data#qiskit.ignis.characterization.BaseGateFitter.fit_data "qiskit.ignis.characterization.BaseGateFitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.BaseGateFitter.plot#qiskit.ignis.characterization.BaseGateFitter.plot "qiskit.ignis.characterization.BaseGateFitter.plot") | Plot err data. | +### add\_data -## Attributes + + +`BaseGateFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### fit\_data + + + +`BaseGateFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### plot + + + +`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. + +**Parameters** +* **qind** (*int*) – qubit index to plot +* **series** (*str*) – the series to plot +* **ax** (*Axes*) – plot axes +* **show\_plot** (*bool*) – call plt.show() +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +## Attributes + + ### backend\_result @@ -30,7 +90,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -40,7 +100,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -50,7 +110,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -60,7 +120,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -70,7 +130,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -80,7 +140,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -90,7 +150,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -100,7 +160,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -119,3 +179,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 c4b4a336ad9..2242b5d8764 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.DragFitter.md @@ -1,8 +1,16 @@ -# DragFitter +--- +title: DragFitter +description: API reference for qiskit.ignis.characterization.DragFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.DragFitter +--- +# DragFitter + -`DragFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` +`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` @@ -14,17 +22,105 @@ fit\_p0 is \[a, x0, c] where the fit is a\*(x-x0)^2+c ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.DragFitter.add_data#qiskit.ignis.characterization.DragFitter.add_data "qiskit.ignis.characterization.DragFitter.add_data") | Add new execution results to previous execution results | -| [`drag_amplitude`](qiskit.ignis.characterization.DragFitter.drag_amplitude#qiskit.ignis.characterization.DragFitter.drag_amplitude "qiskit.ignis.characterization.DragFitter.drag_amplitude") | Return the drag amplitude from the fit | -| [`fit_data`](qiskit.ignis.characterization.DragFitter.fit_data#qiskit.ignis.characterization.DragFitter.fit_data "qiskit.ignis.characterization.DragFitter.fit_data") | Fit the curve. | -| [`guess_params`](qiskit.ignis.characterization.DragFitter.guess_params#qiskit.ignis.characterization.DragFitter.guess_params "qiskit.ignis.characterization.DragFitter.guess_params") | Guess parameters for the drag fit | -| [`plot`](qiskit.ignis.characterization.DragFitter.plot#qiskit.ignis.characterization.DragFitter.plot "qiskit.ignis.characterization.DragFitter.plot") | Plot the data and fit | +### add\_data -## Attributes + + +`DragFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### drag\_amplitude + + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index + +**Returns** + +drag amp + +**Return type** + +float + +### fit\_data + + + +`DragFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### guess\_params + + + +`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 +**Parameters** +**qind** (*int*) – qubit index + +**Returns** + +**guess parameters** + +\[a, x0, c] where the fit is $a * (x - x0)^{2+c}$ + +**Return type** + +list + +### plot + + + +`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 + +**Parameters** + +* **qind** (*int*) – qubit index +* **series** (*str*) – data series to plot (for rabi data always ‘0’) +* **ax** (*Axes*) – matploblib axes (if none created) +* **show\_plot** (*bool*) – do plot.show + +**Returns** + +Plot axes + +**Return type** + +Axes + +## Attributes + + ### backend\_result @@ -34,7 +130,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -44,7 +140,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -54,7 +150,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -64,7 +160,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -74,7 +170,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -84,7 +180,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -94,7 +190,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -104,7 +200,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -123,3 +219,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 ddeb1b5433e..d02ec6dd010 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.RabiFitter.md @@ -1,8 +1,16 @@ -# RabiFitter +--- +title: RabiFitter +description: API reference for qiskit.ignis.characterization.RabiFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.RabiFitter +--- +# RabiFitter + -`RabiFitter(backend_result, xdata, qubits, fit_p0, fit_bounds=None)` +`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` @@ -14,18 +22,125 @@ fit\_po is \[amp, freq, phase, offset] ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.RabiFitter.add_data#qiskit.ignis.characterization.RabiFitter.add_data "qiskit.ignis.characterization.RabiFitter.add_data") | Add new execution results to previous execution results | -| [`fit_data`](qiskit.ignis.characterization.RabiFitter.fit_data#qiskit.ignis.characterization.RabiFitter.fit_data "qiskit.ignis.characterization.RabiFitter.fit_data") | Fit the curve. | -| [`guess_params`](qiskit.ignis.characterization.RabiFitter.guess_params#qiskit.ignis.characterization.RabiFitter.guess_params "qiskit.ignis.characterization.RabiFitter.guess_params") | Guess fit parameters for rabi oscillation data | -| [`pi2_amplitude`](qiskit.ignis.characterization.RabiFitter.pi2_amplitude#qiskit.ignis.characterization.RabiFitter.pi2_amplitude "qiskit.ignis.characterization.RabiFitter.pi2_amplitude") | Return the pi/2 amplitude from the fit | -| [`pi_amplitude`](qiskit.ignis.characterization.RabiFitter.pi_amplitude#qiskit.ignis.characterization.RabiFitter.pi_amplitude "qiskit.ignis.characterization.RabiFitter.pi_amplitude") | Return the pi amplitude from the fit | -| [`plot`](qiskit.ignis.characterization.RabiFitter.plot#qiskit.ignis.characterization.RabiFitter.plot "qiskit.ignis.characterization.RabiFitter.plot") | Plot the data and fit | +### add\_data -## Attributes + + +`RabiFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### fit\_data + + + +`RabiFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### guess\_params + + + +`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 +**Parameters** + +**qind** (*int*) – qubit index to guess fit parameters for + +**Returns** + +**List of fit guess parameters** + +\[amp, freq, phase, offset] + +**Return type** + +list + +### pi2\_amplitude + + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index + +**Returns** + +$\frac{\pi}{2}$ amp + +**Return type** +float + +### pi\_amplitude + + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index + +**Returns** + +$\pi$ amp + +**Return type** + +float + +### plot + + + +`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 + +**Parameters** + +* **qind** (*int*) – qubit index +* **series** (*str*) – data series to plot (for rabi data always ‘0’) +* **ax** (*Axes*) – matploblib axes (if none created) +* **show\_plot** (*bool*) – do plot.show + +**Returns** + +Plot axes + +**Return type** + +Axes + +## Attributes + + ### backend\_result @@ -35,7 +150,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -45,7 +160,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -55,7 +170,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -65,7 +180,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -75,7 +190,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -85,7 +200,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -95,7 +210,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -105,7 +220,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -124,3 +239,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 7a269d29d63..c18ff34c92c 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T1Fitter.md @@ -1,8 +1,16 @@ -# T1Fitter +--- +title: T1Fitter +description: API reference for qiskit.ignis.characterization.T1Fitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.T1Fitter +--- +# T1Fitter + -`T1Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` +`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` @@ -29,17 +37,109 @@ for unknown parameters A, B, and T1. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.T1Fitter.add_data#qiskit.ignis.characterization.T1Fitter.add_data "qiskit.ignis.characterization.T1Fitter.add_data") | Add new execution results to previous execution results | -| [`fit_data`](qiskit.ignis.characterization.T1Fitter.fit_data#qiskit.ignis.characterization.T1Fitter.fit_data "qiskit.ignis.characterization.T1Fitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.T1Fitter.plot#qiskit.ignis.characterization.T1Fitter.plot "qiskit.ignis.characterization.T1Fitter.plot") | Plot coherence data. | -| [`time`](qiskit.ignis.characterization.T1Fitter.time#qiskit.ignis.characterization.T1Fitter.time "qiskit.ignis.characterization.T1Fitter.time") | Return the characteristic time for the given qubit and series | -| [`time_err`](qiskit.ignis.characterization.T1Fitter.time_err#qiskit.ignis.characterization.T1Fitter.time_err "qiskit.ignis.characterization.T1Fitter.time_err") | Return the error of characteristic time for the given qubit and series | +### add\_data -## Attributes + + +`T1Fitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### fit\_data + + + +`T1Fitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### plot + + + +`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. + +**Parameters** + +* **qind** – qubit index to plot +* **series** – which series to plot (if list then plot multiple) +* **ax** – plot axes +* **show\_plot** – whether to call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +### time + + +`T1Fitter.time(qid=- 1, series='0')` +Return the characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The characteristic time of the qubit, or all qubits + +### time\_err + + + +`T1Fitter.time_err(qid=- 1, series='0')` + +Return the error of characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The error of the characteristic time of the qubit, or all qubits + +## Attributes + + ### backend\_result @@ -49,7 +149,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -59,7 +159,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -69,7 +169,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -79,7 +179,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -89,7 +189,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -99,7 +199,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -109,7 +209,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -119,7 +219,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -138,3 +238,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 b97bf078e7d..46efe0157ed 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2Fitter.md @@ -1,8 +1,16 @@ -# T2Fitter +--- +title: T2Fitter +description: API reference for qiskit.ignis.characterization.T2Fitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.T2Fitter +--- +# T2Fitter + -`T2Fitter(backend_result, xdata, qubits, fit_p0, fit_bounds, circbasename='t2', time_unit='micro-seconds')` +`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` @@ -30,17 +38,109 @@ for unknown parameters A, B, and T2. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.T2Fitter.add_data#qiskit.ignis.characterization.T2Fitter.add_data "qiskit.ignis.characterization.T2Fitter.add_data") | Add new execution results to previous execution results | -| [`fit_data`](qiskit.ignis.characterization.T2Fitter.fit_data#qiskit.ignis.characterization.T2Fitter.fit_data "qiskit.ignis.characterization.T2Fitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.T2Fitter.plot#qiskit.ignis.characterization.T2Fitter.plot "qiskit.ignis.characterization.T2Fitter.plot") | Plot coherence data. | -| [`time`](qiskit.ignis.characterization.T2Fitter.time#qiskit.ignis.characterization.T2Fitter.time "qiskit.ignis.characterization.T2Fitter.time") | Return the characteristic time for the given qubit and series | -| [`time_err`](qiskit.ignis.characterization.T2Fitter.time_err#qiskit.ignis.characterization.T2Fitter.time_err "qiskit.ignis.characterization.T2Fitter.time_err") | Return the error of characteristic time for the given qubit and series | +### add\_data -## Attributes + + +`T2Fitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### fit\_data + + + +`T2Fitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### plot + + + +`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. + +**Parameters** + +* **qind** – qubit index to plot +* **series** – which series to plot (if list then plot multiple) +* **ax** – plot axes +* **show\_plot** – whether to call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +### time + + +`T2Fitter.time(qid=- 1, series='0')` +Return the characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The characteristic time of the qubit, or all qubits + +### time\_err + + + +`T2Fitter.time_err(qid=- 1, series='0')` + +Return the error of characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The error of the characteristic time of the qubit, or all qubits + +## Attributes + + ### backend\_result @@ -50,7 +150,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -60,7 +160,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -70,7 +170,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -80,7 +180,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -90,7 +190,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -100,7 +200,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -110,7 +210,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -120,7 +220,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -139,3 +239,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 9e26a8fbf8a..b7627d45203 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.T2StarFitter.md @@ -1,8 +1,16 @@ -# T2StarFitter +--- +title: T2StarFitter +description: API reference for qiskit.ignis.characterization.T2StarFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.T2StarFitter +--- +# T2StarFitter + -`T2StarFitter(backend_result, xdata, qubits, fit_p0, fit_bounds, time_unit='micro-seconds')` +`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` @@ -29,18 +37,129 @@ for unknown parameters $A, B, f, \phi, T_2^*$. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.characterization.T2StarFitter.add_data#qiskit.ignis.characterization.T2StarFitter.add_data "qiskit.ignis.characterization.T2StarFitter.add_data") | Add new execution results to previous execution results | -| [`fit_data`](qiskit.ignis.characterization.T2StarFitter.fit_data#qiskit.ignis.characterization.T2StarFitter.fit_data "qiskit.ignis.characterization.T2StarFitter.fit_data") | Fit the curve. | -| [`guess_params`](qiskit.ignis.characterization.T2StarFitter.guess_params#qiskit.ignis.characterization.T2StarFitter.guess_params "qiskit.ignis.characterization.T2StarFitter.guess_params") | Guess fit parameters for oscillation data | -| [`plot`](qiskit.ignis.characterization.T2StarFitter.plot#qiskit.ignis.characterization.T2StarFitter.plot "qiskit.ignis.characterization.T2StarFitter.plot") | Plot coherence data. | -| [`time`](qiskit.ignis.characterization.T2StarFitter.time#qiskit.ignis.characterization.T2StarFitter.time "qiskit.ignis.characterization.T2StarFitter.time") | Return the characteristic time for the given qubit and series | -| [`time_err`](qiskit.ignis.characterization.T2StarFitter.time_err#qiskit.ignis.characterization.T2StarFitter.time_err "qiskit.ignis.characterization.T2StarFitter.time_err") | Return the error of characteristic time for the given qubit and series | +### add\_data -## Attributes + + +`T2StarFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### fit\_data + + + +`T2StarFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### guess\_params + + + +`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 +**Parameters** + +**qind** (`int`) – qubit index to guess fit parameters for + +**Return type** + +`List`\[`float`] + +**Returns** + +Fit guessed parameters + +### plot + + + +`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. + +**Parameters** + +* **qind** – qubit index to plot +* **series** – which series to plot (if list then plot multiple) +* **ax** – plot axes +* **show\_plot** – whether to call plt.show() + +**Returns** + +The axes object + +**Return type** +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +### time + + + +`T2StarFitter.time(qid=- 1, series='0')` + +Return the characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The characteristic time of the qubit, or all qubits + +### time\_err + + + +`T2StarFitter.time_err(qid=- 1, series='0')` + +Return the error of characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The error of the characteristic time of the qubit, or all qubits + +## Attributes + + ### backend\_result @@ -50,7 +169,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -60,7 +179,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -70,7 +189,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -80,7 +199,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -90,7 +209,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -100,7 +219,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -110,7 +229,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -120,7 +239,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -139,3 +258,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 72d0d58924d..3a8aa5098ec 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.characterization.ZZFitter.md @@ -1,8 +1,16 @@ -# ZZFitter +--- +title: ZZFitter +description: API reference for qiskit.ignis.characterization.ZZFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.characterization.ZZFitter +--- +# ZZFitter + -`ZZFitter(backend_result, xdata, qubits, spectators, fit_p0, fit_bounds, time_unit='micro-seconds')` +`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` @@ -10,19 +18,155 @@ ZZ fitter ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`ZZ_rate`](qiskit.ignis.characterization.ZZFitter.ZZ_rate#qiskit.ignis.characterization.ZZFitter.ZZ_rate "qiskit.ignis.characterization.ZZFitter.ZZ_rate") | Return the ZZ rate from the fit of the two curves | -| [`add_data`](qiskit.ignis.characterization.ZZFitter.add_data#qiskit.ignis.characterization.ZZFitter.add_data "qiskit.ignis.characterization.ZZFitter.add_data") | Add new execution results to previous execution results | -| [`fit_data`](qiskit.ignis.characterization.ZZFitter.fit_data#qiskit.ignis.characterization.ZZFitter.fit_data "qiskit.ignis.characterization.ZZFitter.fit_data") | Fit the curve. | -| [`plot`](qiskit.ignis.characterization.ZZFitter.plot#qiskit.ignis.characterization.ZZFitter.plot "qiskit.ignis.characterization.ZZFitter.plot") | Plot coherence data. | -| [`plot_ZZ`](qiskit.ignis.characterization.ZZFitter.plot_ZZ#qiskit.ignis.characterization.ZZFitter.plot_ZZ "qiskit.ignis.characterization.ZZFitter.plot_ZZ") | Plot ZZ data. | -| [`time`](qiskit.ignis.characterization.ZZFitter.time#qiskit.ignis.characterization.ZZFitter.time "qiskit.ignis.characterization.ZZFitter.time") | Return the characteristic time for the given qubit and series | -| [`time_err`](qiskit.ignis.characterization.ZZFitter.time_err#qiskit.ignis.characterization.ZZFitter.time_err "qiskit.ignis.characterization.ZZFitter.time_err") | Return the error of characteristic time for the given qubit and series | +### ZZ\_rate -## Attributes + + +`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 + +**Parameters** + +**qind** (*int*) – qubit index to return (-1 return all) + +**Returns** + +a list of zz\_rates + +**Return type** + +list + +### add\_data + + + +`ZZFitter.add_data(results, recalc=True, refit=True)` + +Add new execution results to previous execution results + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – new execution results +* **recalc** (`bool`) – whether tp recalculate the data +* **refit** (`bool`) – whether to refit the data + +### fit\_data + + + +`ZZFitter.fit_data(qid=- 1, p0=None, bounds=None, series=None)` + +Fit the curve. + +Compute self.\_params and self.\_params\_err + +**Parameters** + +* **qid** (`int`) – qubit for fitting. If -1 fit for all the qubits +* **p0** (`Optional`\[`List`\[`float`]]) – initial guess, equivalent to p0 in scipy.optimize +* **bounds** (`Optional`\[`Tuple`\[`List`\[`float`], `List`\[`float`]]]) – bounds, equivalent to bounds in scipy.optimize +* **series** (`Optional`\[`str`]) – series to fit (if None fit all) + +### plot + + + +`ZZFitter.plot(qind, series, ax=None, show_plot=True)` + +Plot coherence data. + +**Parameters** + +* **qind** (`int`) – qubit index to plot +* **series** (`str`) – which series to plot (if list then plot multiple) +* **ax** (`Optional`\[`Any`]) – plot axes +* **show\_plot** (`bool`) – whether to call plt.show() + +**Returns** + +The axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – if matplotlib is not installed + +### plot\_ZZ + + + +`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. +**Parameters** +* **qind** (*int*) – qubit index to plot +* **ax** (*Axes*) – plot axes +* **show\_plot** (*bool*) – call plt.show() + +**Returns** + +the axes object + +**Return type** + +Axes + +**Raises** + +**ImportError** – If matplotlib is not installed + +### time + + + +`ZZFitter.time(qid=- 1, series='0')` + +Return the characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The characteristic time of the qubit, or all qubits + +### time\_err + + + +`ZZFitter.time_err(qid=- 1, series='0')` + +Return the error of characteristic time for the given qubit and series + +**Parameters** + +* **qid** (`int`) – the qubit index (or all qubits if -1) +* **series** (`str`) – the series to get + +**Return type** + +`Union`\[`float`, `List`\[`float`]] + +**Returns** + +The error of the characteristic time of the qubit, or all qubits + +## Attributes + + ### backend\_result @@ -32,7 +176,7 @@ Return the execution results `Union`\[`Result`, `List`\[`Result`]] - + ### description @@ -42,7 +186,7 @@ Return the fitter’s purpose, e.g. ‘T1’ `str` - + ### fit\_fun @@ -52,7 +196,7 @@ Return the function used in the fit, e.g. BaseFitter.\_exp\_fit\_fun `Callable` - + ### measured\_qubits @@ -62,7 +206,7 @@ Return the indices of the qubits to be characterized `List`\[`int`] - + ### params @@ -72,7 +216,7 @@ Return the fit function parameters that were calculated by curve\_fit `List`\[`float`] - + ### params\_err @@ -82,7 +226,7 @@ Return the error of the fit function parameters `List`\[`float`] - + ### series @@ -92,7 +236,7 @@ Return the list of series for the data `Optional`\[`List`\[`str`]] - + ### xdata @@ -102,7 +246,7 @@ Return the data points on the x-axis, the independenet parameter which is fit ag `Union`\[`List`\[`float`], `array`] - + ### ydata @@ -121,3 +265,4 @@ The data points are returning in the form of a list of dictionaries: **Return type** `List`\[`Dict`] + 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 40d410fdf1d..8aee6e83ae9 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.ampcal\_1Q\_circuits +--- +title: ampcal_1Q_circuits +description: API reference for qiskit.ignis.characterization.ampcal_1Q_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.ampcal_1Q_circuits +--- +# qiskit.ignis.characterization.ampcal\_1Q\_circuits + -`ampcal_1Q_circuits(max_reps, qubits)` +`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 @@ -24,3 +32,4 @@ Y90-(Y90-Y90)^n **Return type** tuple + 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 1e7a0f3d212..4314a0bf66b 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.ampcal\_cx\_circuits +--- +title: ampcal_cx_circuits +description: API reference for qiskit.ignis.characterization.ampcal_cx_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.ampcal_cx_circuits +--- +# qiskit.ignis.characterization.ampcal\_cx\_circuits + -`ampcal_cx_circuits(max_reps, qubits, control_qubits)` +`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 @@ -27,3 +35,4 @@ Note: the circuit may not behave as intended if the target-control pairs are not **Return type** tuple + 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 22779b2b9f9..96c0ac8dce4 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.anglecal\_1Q\_circuits +--- +title: anglecal_1Q_circuits +description: API reference for qiskit.ignis.characterization.anglecal_1Q_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.anglecal_1Q_circuits +--- +# qiskit.ignis.characterization.anglecal\_1Q\_circuits + -`anglecal_1Q_circuits(max_reps, qubits, angleerr=0.0)` +`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 @@ -23,3 +31,4 @@ Y90-(X90-X90-Y90-Y90)^n - X90 **Return type** tuple + 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 fea3f6341e3..fae2ef72cb7 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.anglecal\_cx\_circuits +--- +title: anglecal_cx_circuits +description: API reference for qiskit.ignis.characterization.anglecal_cx_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.anglecal_cx_circuits +--- +# qiskit.ignis.characterization.anglecal\_cx\_circuits + -`anglecal_cx_circuits(max_reps, qubits, control_qubits, angleerr=0.0)` +`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 @@ -28,3 +36,4 @@ Note: the circuit may not behave as intended if the target-control pairs are not **Return type** tuple + 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 22a60153e13..7a064bbe13f 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.drag\_schedules +--- +title: drag_schedules +description: API reference for qiskit.ignis.characterization.drag_schedules +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.drag_schedules +--- +# 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)` +`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 @@ -15,8 +23,8 @@ Generates schedules for a drag experiment doing a pulse then the - pulse * **pulse\_width** (*float*) – width of gaussian (in dt units) * **pulse\_sigma** (*float*) – sigma of gaussian * **width\_sigma\_ratio** (*int*) – set sigma to a certain ratio of the width (use if pulse\_sigma is None) -* **drives** (*list*) – list of [`DriveChannel`](qiskit.pulse.DriveChannel#qiskit.pulse.DriveChannel "qiskit.pulse.DriveChannel") objects -* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap#qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – InstructionScheduleMap object to use +* **drives** (*list*) – list of [`DriveChannel`](qiskit.pulse.DriveChannel "qiskit.pulse.DriveChannel") objects +* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – InstructionScheduleMap object to use * **meas\_map** (*list*) – meas\_map to use **Returns** @@ -26,3 +34,4 @@ A list of QuantumSchedules xdata: a list of amps **Raises** **QiskitError** – when necessary variables are not supplied. + 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 eb606bbc20c..1df8be1c539 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.get\_single\_q\_pulse +--- +title: get_single_q_pulse +description: API reference for qiskit.ignis.characterization.get_single_q_pulse +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.get_single_q_pulse +--- +# qiskit.ignis.characterization.get\_single\_q\_pulse + -`get_single_q_pulse(inst_map, qubits)` +`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 @@ -22,3 +30,4 @@ list ## Notes Deprecated once parameterized pulses are supported + 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 f1a11899e43..77a15744bbb 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.rabi\_schedules +--- +title: rabi_schedules +description: API reference for qiskit.ignis.characterization.rabi_schedules +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.rabi_schedules +--- +# 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)` +`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 @@ -13,8 +21,8 @@ Generates schedules for a rabi experiment using a Gaussian pulse * **pulse\_width** (*float*) – width of gaussian (in dt units) * **pulse\_sigma** (*float*) – sigma of gaussian * **width\_sigma\_ratio** (*int*) – set sigma to a certain ratio of the width (use if pulse\_sigma is None) -* **drives** (*list*) – list of [`DriveChannel`](qiskit.pulse.DriveChannel#qiskit.pulse.DriveChannel "qiskit.pulse.DriveChannel") objects -* **inst\_map** ([*qiskit.pulse.InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap#qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – InstructionScheduleMap object to use +* **drives** (*list*) – list of [`DriveChannel`](qiskit.pulse.DriveChannel "qiskit.pulse.DriveChannel") objects +* **inst\_map** ([*qiskit.pulse.InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – InstructionScheduleMap object to use * **meas\_map** (*list*) – meas\_map to use **Returns** @@ -24,3 +32,4 @@ A list of QuantumSchedules xdata: a list of amps **Raises** **QiskitError** – when necessary variables are not supplied. + 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 1b0ea634bf2..e7e4301ac50 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.t1\_circuits +--- +title: t1_circuits +description: API reference for qiskit.ignis.characterization.t1_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.t1_circuits +--- +# qiskit.ignis.characterization.t1\_circuits + -`t1_circuits(num_of_gates, gate_time, qubits)` +`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. @@ -22,3 +30,4 @@ Each circuit consists of an X gate, followed by a sequence of identity gates. * Generated circuits * Delay times, i.e., gate\_time multiplied by the numbers in num\_of\_gates + 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 d4ddd571e84..d1ff2dea23a 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.t2\_circuits +--- +title: t2_circuits +description: API reference for qiskit.ignis.characterization.t2_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.t2_circuits +--- +# qiskit.ignis.characterization.t2\_circuits + -`t2_circuits(num_of_gates, gate_time, qubits, n_echos=1, phase_alt_echo=False)` +`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. @@ -34,3 +42,4 @@ Standard T2\* echo is $n_echos=1$ **Raises** **ValueError** – If n\_echos is less than 1 + 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 c3d1c37a810..8c6fec17c14 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.t2star\_circuits +--- +title: t2star_circuits +description: API reference for qiskit.ignis.characterization.t2star_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.t2star_circuits +--- +# qiskit.ignis.characterization.t2star\_circuits + -`t2star_circuits(num_of_gates, gate_time, qubits, nosc=0)` +`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. @@ -24,3 +32,4 @@ Each circuit consists of a Hadamard gate, followed by a sequence of identity gat * The generated circuits * Delay times, i.e., gate\_time multiplied by the numbers in num\_of\_gates * The induced oscillation frequency + 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 03d761063c7..29c1b537f61 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.update\_u\_gates +--- +title: update_u_gates +description: API reference for qiskit.ignis.characterization.update_u_gates +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.update_u_gates +--- +# qiskit.ignis.characterization.update\_u\_gates + -`update_u_gates(drag_params, pi2_pulse_schedules=None, qubits=None, inst_map=None, drives=None)` +`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 @@ -13,5 +21,6 @@ Will update U2, U3 * **drag\_params** (*list*) – list of drag params * **pi2\_pulse\_schedules** (*list*) – list of new pi/2 gate as a pulse schedule will use the drag\_params if this is None. * **qubits** (*list*) – list of qubits to update -* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap#qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – InstructionScheduleMap providing circuit instruction to schedule definitions. +* **inst\_map** ([*InstructionScheduleMap*](qiskit.pulse.InstructionScheduleMap "qiskit.pulse.InstructionScheduleMap")) – InstructionScheduleMap providing circuit instruction to schedule definitions. * **drives** (*list*) – List of drive chs + 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 c7297d5b154..1f4c9fbc60d 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.characterization.zz\_circuits +--- +title: zz_circuits +description: API reference for qiskit.ignis.characterization.zz_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.characterization.zz_circuits +--- +# qiskit.ignis.characterization.zz\_circuits + -`zz_circuits(num_of_gates, gate_time, qubits, spectators, nosc=5)` +`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 @@ -21,3 +29,4 @@ A list of QuantumCircuit xdata: a list of delay times osc\_freq: the induced osc **Raises** **ValueError** – If the number of qubits differs from the number of spectators + 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 949e196a8aa..3922362b0f9 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogReader.md @@ -1,8 +1,16 @@ -# IgnisLogReader +--- +title: IgnisLogReader +description: API reference for qiskit.ignis.logging.IgnisLogReader +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.logging.IgnisLogReader +--- +# IgnisLogReader + -`IgnisLogReader` +`IgnisLogReader`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/logging/ignis_logging.py "view source code") Bases: `object` @@ -12,7 +20,47 @@ Reads and constructs tabular representation of logged data based on date/time an ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| [`get_log_files`](qiskit.ignis.logging.IgnisLogReader.get_log_files#qiskit.ignis.logging.IgnisLogReader.get_log_files "qiskit.ignis.logging.IgnisLogReader.get_log_files") | Get Names of all log files (several may be present due to logging file rotation). | -| [`read_values`](qiskit.ignis.logging.IgnisLogReader.read_values#qiskit.ignis.logging.IgnisLogReader.read_values "qiskit.ignis.logging.IgnisLogReader.read_values") | Retrieve log lines using key and date/time filtering criteria | +### get\_log\_files + + + +`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. + +**Returns** + +list of all log file names + +**Return type** + +list + +### read\_values + + + +`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 + +#### Params: + +log\_files: List of log files to read from keys: Retrieve only key value pairs of corresponding to keys A row with no matching keys will not be retrieved. If not specified, all keys are retrieved (optional) + +from\_datetime(None): Retrieve only rows newer than the given date and time + +from\_datetime\_format(None): datetime format string. If not specified will assume “%Y/%m/%d %H:%M:%S” + +to\_datetime(None): Retrieve only rows older than the given date and time + +to\_datetime\_format(None): datetime format string. If not specified will assume “%Y/%m/%d %H:%M:%S” + +**Returns** + +A list containing the retrieved rows of key pair values + +**Return type** + +list + 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 eaaaf348f6c..033560eff61 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogger.md @@ -1,14 +1,22 @@ -# IgnisLogger +--- +title: IgnisLogger +description: API reference for qiskit.ignis.logging.IgnisLogger +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.logging.IgnisLogger +--- +# IgnisLogger + -`IgnisLogger(name, level=0)` +`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` A logger class for Ignis -IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger.log_to_file#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. +IgnisLogger is a like any other `logging.Logger` object except it has an additional method, [`log_to_file()`](qiskit.ignis.logging.IgnisLogger#log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file"), used to log data in the form of key:value pairs to a log file. Logging configuration is performed via a configuration file and is handled by IgnisLogging. Refer to Python’s logging documentation for more details on how to use logging in Python @@ -21,46 +29,292 @@ Initialize the IgnisLogger object ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| [`addFilter`](qiskit.ignis.logging.IgnisLogger.addFilter#qiskit.ignis.logging.IgnisLogger.addFilter "qiskit.ignis.logging.IgnisLogger.addFilter") | Add the specified filter to this handler. | -| [`addHandler`](qiskit.ignis.logging.IgnisLogger.addHandler#qiskit.ignis.logging.IgnisLogger.addHandler "qiskit.ignis.logging.IgnisLogger.addHandler") | Add the specified handler to this logger. | -| [`callHandlers`](qiskit.ignis.logging.IgnisLogger.callHandlers#qiskit.ignis.logging.IgnisLogger.callHandlers "qiskit.ignis.logging.IgnisLogger.callHandlers") | Pass a record to all relevant handlers. | -| [`configure`](qiskit.ignis.logging.IgnisLogger.configure#qiskit.ignis.logging.IgnisLogger.configure "qiskit.ignis.logging.IgnisLogger.configure") | Internal configuration method of IgnisLogger. | -| [`critical`](qiskit.ignis.logging.IgnisLogger.critical#qiskit.ignis.logging.IgnisLogger.critical "qiskit.ignis.logging.IgnisLogger.critical") | Log ‘msg % args’ with severity ‘CRITICAL’. | -| [`debug`](qiskit.ignis.logging.IgnisLogger.debug#qiskit.ignis.logging.IgnisLogger.debug "qiskit.ignis.logging.IgnisLogger.debug") | Log ‘msg % args’ with severity ‘DEBUG’. | -| [`disable_file_logging`](qiskit.ignis.logging.IgnisLogger.disable_file_logging#qiskit.ignis.logging.IgnisLogger.disable_file_logging "qiskit.ignis.logging.IgnisLogger.disable_file_logging") | Disable file logging for this logger object (note there is a single object for a given logger name | -| [`enable_file_logging`](qiskit.ignis.logging.IgnisLogger.enable_file_logging#qiskit.ignis.logging.IgnisLogger.enable_file_logging "qiskit.ignis.logging.IgnisLogger.enable_file_logging") | Enable file logging for this logger object (note there is a single object for a given logger name | -| [`error`](qiskit.ignis.logging.IgnisLogger.error#qiskit.ignis.logging.IgnisLogger.error "qiskit.ignis.logging.IgnisLogger.error") | Log ‘msg % args’ with severity ‘ERROR’. | -| [`exception`](qiskit.ignis.logging.IgnisLogger.exception#qiskit.ignis.logging.IgnisLogger.exception "qiskit.ignis.logging.IgnisLogger.exception") | Convenience method for logging an ERROR with exception information. | -| [`fatal`](qiskit.ignis.logging.IgnisLogger.fatal#qiskit.ignis.logging.IgnisLogger.fatal "qiskit.ignis.logging.IgnisLogger.fatal") | Log ‘msg % args’ with severity ‘CRITICAL’. | -| [`filter`](qiskit.ignis.logging.IgnisLogger.filter#qiskit.ignis.logging.IgnisLogger.filter "qiskit.ignis.logging.IgnisLogger.filter") | Determine if a record is loggable by consulting all the filters. | -| [`findCaller`](qiskit.ignis.logging.IgnisLogger.findCaller#qiskit.ignis.logging.IgnisLogger.findCaller "qiskit.ignis.logging.IgnisLogger.findCaller") | Find the stack frame of the caller so that we can note the source file name, line number and function name. | -| [`getChild`](qiskit.ignis.logging.IgnisLogger.getChild#qiskit.ignis.logging.IgnisLogger.getChild "qiskit.ignis.logging.IgnisLogger.getChild") | Get a logger which is a descendant to this one. | -| [`getEffectiveLevel`](qiskit.ignis.logging.IgnisLogger.getEffectiveLevel#qiskit.ignis.logging.IgnisLogger.getEffectiveLevel "qiskit.ignis.logging.IgnisLogger.getEffectiveLevel") | Get the effective level for this logger. | -| [`handle`](qiskit.ignis.logging.IgnisLogger.handle#qiskit.ignis.logging.IgnisLogger.handle "qiskit.ignis.logging.IgnisLogger.handle") | Call the handlers for the specified record. | -| [`hasHandlers`](qiskit.ignis.logging.IgnisLogger.hasHandlers#qiskit.ignis.logging.IgnisLogger.hasHandlers "qiskit.ignis.logging.IgnisLogger.hasHandlers") | See if this logger has any handlers configured. | -| [`info`](qiskit.ignis.logging.IgnisLogger.info#qiskit.ignis.logging.IgnisLogger.info "qiskit.ignis.logging.IgnisLogger.info") | Log ‘msg % args’ with severity ‘INFO’. | -| [`isEnabledFor`](qiskit.ignis.logging.IgnisLogger.isEnabledFor#qiskit.ignis.logging.IgnisLogger.isEnabledFor "qiskit.ignis.logging.IgnisLogger.isEnabledFor") | Is this logger enabled for level ‘level’? | -| [`log`](qiskit.ignis.logging.IgnisLogger.log#qiskit.ignis.logging.IgnisLogger.log "qiskit.ignis.logging.IgnisLogger.log") | Log ‘msg % args’ with the integer severity ‘level’. | -| [`log_to_file`](qiskit.ignis.logging.IgnisLogger.log_to_file#qiskit.ignis.logging.IgnisLogger.log_to_file "qiskit.ignis.logging.IgnisLogger.log_to_file") | Log key:value pairs to a log file. | -| [`makeRecord`](qiskit.ignis.logging.IgnisLogger.makeRecord#qiskit.ignis.logging.IgnisLogger.makeRecord "qiskit.ignis.logging.IgnisLogger.makeRecord") | A factory method which can be overridden in subclasses to create specialized LogRecords. | -| [`removeFilter`](qiskit.ignis.logging.IgnisLogger.removeFilter#qiskit.ignis.logging.IgnisLogger.removeFilter "qiskit.ignis.logging.IgnisLogger.removeFilter") | Remove the specified filter from this handler. | -| [`removeHandler`](qiskit.ignis.logging.IgnisLogger.removeHandler#qiskit.ignis.logging.IgnisLogger.removeHandler "qiskit.ignis.logging.IgnisLogger.removeHandler") | Remove the specified handler from this logger. | -| [`setLevel`](qiskit.ignis.logging.IgnisLogger.setLevel#qiskit.ignis.logging.IgnisLogger.setLevel "qiskit.ignis.logging.IgnisLogger.setLevel") | Set the logging level of this logger. | -| [`warn`](qiskit.ignis.logging.IgnisLogger.warn#qiskit.ignis.logging.IgnisLogger.warn "qiskit.ignis.logging.IgnisLogger.warn") | | -| [`warning`](qiskit.ignis.logging.IgnisLogger.warning#qiskit.ignis.logging.IgnisLogger.warning "qiskit.ignis.logging.IgnisLogger.warning") | Log ‘msg % args’ with severity ‘WARNING’. | +### addFilter -## Attributes + + +`IgnisLogger.addFilter(filter)` + +Add the specified filter to this handler. + +### addHandler + + + +`IgnisLogger.addHandler(hdlr)` + +Add the specified handler to this logger. + +### callHandlers + + + +`IgnisLogger.callHandlers(record)` + +Pass a record to all relevant handlers. + +Loop through all handlers for this logger and its parents in the logger hierarchy. If no handler was found, output a one-off error message to sys.stderr. Stop searching up the hierarchy whenever a logger with the “propagate” attribute set to zero is found - that will be the last logger whose handlers are called. + +### configure + + + +`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 + +**Parameters** + +* **sh** (`StreamHandler`) – StreamHandler object +* **conf\_file\_exists** (`bool`) – Whether or not a file config exists + +### critical + + + +`IgnisLogger.critical(msg, *args, **kwargs)` + +Log ‘msg % args’ with severity ‘CRITICAL’. + +To pass exception information, use the keyword argument exc\_info with a true value, e.g. + +logger.critical(“Houston, we have a %s”, “major disaster”, exc\_info=1) + +### debug + + + +`IgnisLogger.debug(msg, *args, **kwargs)` + +Log ‘msg % args’ with severity ‘DEBUG’. + +To pass exception information, use the keyword argument exc\_info with a true value, e.g. + +logger.debug(“Houston, we have a %s”, “thorny problem”, exc\_info=1) + +### disable\_file\_logging + + + +`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 + +### enable\_file\_logging + + + +`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 + +### error + + + +`IgnisLogger.error(msg, *args, **kwargs)` + +Log ‘msg % args’ with severity ‘ERROR’. + +To pass exception information, use the keyword argument exc\_info with a true value, e.g. + +logger.error(“Houston, we have a %s”, “major problem”, exc\_info=1) + +### exception + + + +`IgnisLogger.exception(msg, *args, exc_info=True, **kwargs)` + +Convenience method for logging an ERROR with exception information. + +### fatal + + + +`IgnisLogger.fatal(msg, *args, **kwargs)` + +Log ‘msg % args’ with severity ‘CRITICAL’. + +To pass exception information, use the keyword argument exc\_info with a true value, e.g. + +logger.critical(“Houston, we have a %s”, “major disaster”, exc\_info=1) + +### filter + + + +`IgnisLogger.filter(record)` + +Determine if a record is loggable by consulting all the filters. + +The default is to allow the record to be logged; any filter can veto this and the record is then dropped. Returns a zero value if a record is to be dropped, else non-zero. + +Changed in version 3.2: Allow filters to be just callables. + +### findCaller + + + +`IgnisLogger.findCaller(stack_info=False)` + +Find the stack frame of the caller so that we can note the source file name, line number and function name. + +### getChild + + + +`IgnisLogger.getChild(suffix)` + +Get a logger which is a descendant to this one. + +This is a convenience method, such that +logging.getLogger(‘abc’).getChild(‘def.ghi’) +is the same as + +logging.getLogger(‘abc.def.ghi’) + +It’s useful, for example, when the parent logger is named using \_\_name\_\_ rather than a literal string. + +### getEffectiveLevel + + + +`IgnisLogger.getEffectiveLevel()` + +Get the effective level for this logger. + +Loop through this logger and its parents in the logger hierarchy, looking for a non-zero logging level. Return the first one found. + +### handle + + + +`IgnisLogger.handle(record)` + +Call the handlers for the specified record. + +This method is used for unpickled records received from a socket, as well as those created locally. Logger-level filtering is applied. + +### hasHandlers + + + +`IgnisLogger.hasHandlers()` + +See if this logger has any handlers configured. + +Loop through all handlers for this logger and its parents in the logger hierarchy. Return True if a handler was found, else False. Stop searching up the hierarchy whenever a logger with the “propagate” attribute set to zero is found - that will be the last logger which is checked for the existence of handlers. + +### info + + + +`IgnisLogger.info(msg, *args, **kwargs)` + +Log ‘msg % args’ with severity ‘INFO’. + +To pass exception information, use the keyword argument exc\_info with a true value, e.g. + +logger.info(“Houston, we have a %s”, “interesting problem”, exc\_info=1) + +### isEnabledFor + + + +`IgnisLogger.isEnabledFor(level)` + +Is this logger enabled for level ‘level’? + +### log + + + +`IgnisLogger.log(level, msg, *args, **kwargs)` + +Log ‘msg % args’ with the integer severity ‘level’. + +To pass exception information, use the keyword argument exc\_info with a true value, e.g. + +logger.log(level, “We have a %s”, “mysterious problem”, exc\_info=1) + +### log\_to\_file + + + +`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. + +Note: Logger name in the log file is fixed (ignis\_logging) + +**Parameters** + +**kwargs** – key/value pairs to be logged, e.g t1=0.02, qubits=\[1,2,4] + +### makeRecord + + + +`IgnisLogger.makeRecord(name, level, fn, lno, msg, args, exc_info, func=None, extra=None, sinfo=None)` + +A factory method which can be overridden in subclasses to create specialized LogRecords. + +### removeFilter + + + +`IgnisLogger.removeFilter(filter)` + +Remove the specified filter from this handler. + +### removeHandler + + + +`IgnisLogger.removeHandler(hdlr)` + +Remove the specified handler from this logger. + +### setLevel + + + +`IgnisLogger.setLevel(level)` + +Set the logging level of this logger. level must be an int or a str. + +### warn + + + +`IgnisLogger.warn(msg, *args, **kwargs)` + +### warning + + + +`IgnisLogger.warning(msg, *args, **kwargs)` + +Log ‘msg % args’ with severity ‘WARNING’. + +To pass exception information, use the keyword argument exc\_info with a true value, e.g. + +logger.warning(“Houston, we have a %s”, “bit of a problem”, exc\_info=1) + +## Attributes + + ### manager `=` - + ### root `=` + 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 6b10d4e2b22..54364b12efc 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.logging.IgnisLogging.md @@ -1,8 +1,16 @@ -# IgnisLogging +--- +title: IgnisLogging +description: API reference for qiskit.ignis.logging.IgnisLogging +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.logging.IgnisLogging +--- +# IgnisLogging + -`IgnisLogging(log_config_path=None)` +`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` @@ -24,9 +32,73 @@ max\_rotations: \ - maximum number of log files to rotate (oldest file is ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | -| [`default_datetime_fmt`](qiskit.ignis.logging.IgnisLogging.default_datetime_fmt#qiskit.ignis.logging.IgnisLogging.default_datetime_fmt "qiskit.ignis.logging.IgnisLogging.default_datetime_fmt") | Get the default date time format used for writing log entries | -| [`get_file_handler`](qiskit.ignis.logging.IgnisLogging.get_file_handler#qiskit.ignis.logging.IgnisLogging.get_file_handler "qiskit.ignis.logging.IgnisLogging.get_file_handler") | Configure and retrieve the RotatingFileHandler object. | -| [`get_log_file`](qiskit.ignis.logging.IgnisLogging.get_log_file#qiskit.ignis.logging.IgnisLogging.get_log_file "qiskit.ignis.logging.IgnisLogging.get_log_file") | Get the name of the log file | -| [`get_logger`](qiskit.ignis.logging.IgnisLogging.get_logger#qiskit.ignis.logging.IgnisLogging.get_logger "qiskit.ignis.logging.IgnisLogging.get_logger") | Return an IgnisLogger object | +### default\_datetime\_fmt + + + +`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 + +**Return type** + +`str` + +**Returns** + +Default date time format + +### get\_file\_handler + + + +`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 + +**Returns** + +The configured RotatingFileHandler object + +**Return type** + +RotatingFileHandler + +### get\_log\_file + + + +`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 + +**Return type** + +`str` + +**Returns** + +Name of the log file + +### get\_logger + + + +`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 + +To be used in by the code which needs logging. + +**Parameters** + +**name** (`str`) – Name of the module being logged + +**Return type** + +`IgnisLogger` + +**Returns** + +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 b53d5092a3a..8584a3a690f 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.DiscriminationFilter.md @@ -1,8 +1,16 @@ -# DiscriminationFilter +--- +title: DiscriminationFilter +description: API reference for qiskit.ignis.measurement.DiscriminationFilter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.measurement.DiscriminationFilter +--- +# DiscriminationFilter + -`DiscriminationFilter(discriminator, base=None)` +`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` @@ -19,8 +27,73 @@ my\_filter = DiscriminationFilter(my\_discriminator) new\_result = filter.apply( ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | -| [`apply`](qiskit.ignis.measurement.DiscriminationFilter.apply#qiskit.ignis.measurement.DiscriminationFilter.apply "qiskit.ignis.measurement.DiscriminationFilter.apply") | Create a new result from the raw\_data by converting level 1 data to level 2 data. | -| [`count`](qiskit.ignis.measurement.DiscriminationFilter.count#qiskit.ignis.measurement.DiscriminationFilter.count "qiskit.ignis.measurement.DiscriminationFilter.count") | Converts discriminated results into raw counts. | -| [`get_base`](qiskit.ignis.measurement.DiscriminationFilter.get_base#qiskit.ignis.measurement.DiscriminationFilter.get_base "qiskit.ignis.measurement.DiscriminationFilter.get_base") | Returns the base inferred from expected\_states. | +### 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") + +Create a new result from the raw\_data by converting level 1 data to level 2 data. + +**Parameters** + +**raw\_data** (`Result`) – list of qiskit.Result or qiskit.Result. + +**Return type** + +`Result` + +**Returns** + +A list of qiskit.Result or qiskit.Result. + +### count + + + +`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. + +**Parameters** + +**y\_data** (`List`\[`str`]) – result of a discrimination. + +**Return type** + +`dict` + +**Returns** + +A dict of raw counts. + +### get\_base + + + +`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. + +The intent is to allow users to discriminate states higher than 0/1. + +DiscriminationFilter infers the basis from the expected states to allow users to discriminate states outside of the computational sub-space. For example, if the discriminated states are 00, 01, 02, 10, 11, …, 22 the basis will be 3. + +With this implementation the basis can be at most 10. + +**Parameters** + +**expected\_states** (`dict`) – + +**Returns** + +the base inferred from the expected states + +**Return type** + +int + +**Raises** + +**QiskitError** – if there is an invalid input in the 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 afd1f222ace..40d7957630a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.IQDiscriminationFitter.md @@ -1,8 +1,16 @@ -# IQDiscriminationFitter +--- +title: IQDiscriminationFitter +description: API reference for qiskit.ignis.measurement.IQDiscriminationFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.measurement.IQDiscriminationFitter +--- +# IQDiscriminationFitter + -`IQDiscriminationFitter(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` +`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` @@ -10,42 +18,217 @@ Abstract discriminator that implements the data formatting for IQ level 1 data. **Parameters** -* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. +* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. * **qubit\_mask** (*List\[int]*) – determines which qubit’s level 1 data to use in the discrimination process. * **expected\_states** (*List\[str]*) – a list that should have the same length as schedules. All results in cal\_results are used if schedules is None. expected\_states must have the corresponding length. * **standardize** (*bool*) – if true the discriminator will standardize the xdata using the internal method \_scale\_data. -* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. +* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.measurement.IQDiscriminationFitter.add_data#qiskit.ignis.measurement.IQDiscriminationFitter.add_data "qiskit.ignis.measurement.IQDiscriminationFitter.add_data") | **type result**`Result` | -| [`discriminate`](qiskit.ignis.measurement.IQDiscriminationFitter.discriminate#qiskit.ignis.measurement.IQDiscriminationFitter.discriminate "qiskit.ignis.measurement.IQDiscriminationFitter.discriminate") | Applies the discriminator to x\_data. | -| [`fit`](qiskit.ignis.measurement.IQDiscriminationFitter.fit#qiskit.ignis.measurement.IQDiscriminationFitter.fit "qiskit.ignis.measurement.IQDiscriminationFitter.fit") | Fits the discriminator using self.\_xdata and self.\_ydata. | -| [`format_iq_data`](qiskit.ignis.measurement.IQDiscriminationFitter.format_iq_data#qiskit.ignis.measurement.IQDiscriminationFitter.format_iq_data "qiskit.ignis.measurement.IQDiscriminationFitter.format_iq_data") | Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. | -| [`get_xdata`](qiskit.ignis.measurement.IQDiscriminationFitter.get_xdata#qiskit.ignis.measurement.IQDiscriminationFitter.get_xdata "qiskit.ignis.measurement.IQDiscriminationFitter.get_xdata") | Retrieves feature data (xdata) for the discriminator. | -| [`get_ydata`](qiskit.ignis.measurement.IQDiscriminationFitter.get_ydata#qiskit.ignis.measurement.IQDiscriminationFitter.get_ydata "qiskit.ignis.measurement.IQDiscriminationFitter.get_ydata") | Retrieves the expected states (ydata) for the discriminator. | -| [`is_calibration`](qiskit.ignis.measurement.IQDiscriminationFitter.is_calibration#qiskit.ignis.measurement.IQDiscriminationFitter.is_calibration "qiskit.ignis.measurement.IQDiscriminationFitter.is_calibration") | Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. | -| [`plot`](qiskit.ignis.measurement.IQDiscriminationFitter.plot#qiskit.ignis.measurement.IQDiscriminationFitter.plot "qiskit.ignis.measurement.IQDiscriminationFitter.plot") | Creates a plot of the data used to fit the discriminator. | -| [`plot_xdata`](qiskit.ignis.measurement.IQDiscriminationFitter.plot_xdata#qiskit.ignis.measurement.IQDiscriminationFitter.plot_xdata "qiskit.ignis.measurement.IQDiscriminationFitter.plot_xdata") | Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. | +### add\_data -## Attributes + + +`IQDiscriminationFitter.add_data(result, expected_states, refit=True, schedules=None)` + +**Parameters** + +* **result** (`Result`) – a Result containing new data to be used to train the discriminator. +* **expected\_states** (`List`\[`str`]) – the expected states of the results in result. +* **refit** (`bool`) – refit the discriminator if True. +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. + +### discriminate + + + +`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. + +**Parameters** + +**x\_data** (*List\[List\[float]]*) – list of features. Each feature is itself a list. + +#### Returns (List\[str]): + +The discriminated x\_data as a list of labels. + +**Return type** + +`List`\[`str`] + +### fit + + + +`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. + +### format\_iq\_data + + + +`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. + +**Parameters** + +**iq\_data** (*np.ndarray*) – data obtained from get\_memory(). + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +A list of shots where each entry is a list of IQ points. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if the measurement return type is unknown + +### get\_xdata + + + +`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. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – the get\_memory() method is used to retrieve the level 1 data. If result is a list of Result, then the first Result in the list that returns the data of schedule (through get\_memory(schedule)) is used. +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to (`0`) calibration data only (`1`) non-calibration data (`2`) both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +data as a list of features. Each feature is a list. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if IQ data could not be found + +### get\_ydata + + +`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. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – results for which to retrieve the y data (i.e. expected states). +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to \* 0 calibration data only \* 1 non-calibration data \* 2 both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Returns** + +**The y data, i.e. expected states. get\_ydata is designed to produce** + +y data with the same length as the x data. + +**Return type** + +list + +### is\_calibration + + + +`IQDiscriminationFitter.is_calibration(result_name)` + +Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. + +**Parameters** + +**result\_name** (`str`) – name of the result to be tested. + +**Returns** + +**True if the name of the result indicates that it is a** + +calibration result. + +**Return type** + +bool + +### plot + + + +`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. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If it is none, the plot method will create its own axis instance. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **show\_boundary** (*bool*) – plot the decision regions if true. Some discriminators may put additional constraints on whether the decision regions are plotted or not. +* **show\_fitting\_data** (*bool*) – if True the x data and labels used to fit the discriminator are shown in the plot. +* **flag\_misclassified** (*bool*) – plot the misclassified training data points if true. +* **qubits\_to\_plot** (*list*) – each qubit in this list will receive its own plot. The qubits in qubits to plot must be in the qubit mask. If qubits\_to\_plot is None then the qubit mask will be used. +* **title** (*bool*) – adds a title to each subplot with the number of the qubit. + +**Returns** + +**A tuple of the form: `(Union[List[axes], axes], figure)`** + +where the axes object used for the plot as well as the figure handle. The figure handle returned is not None only when the figure handle is created by the discriminator’s plot method. + +**Return type** + +tuple + +**Raises** + +**QiskitError** – If matplotlib is not installed, or there is invalid input + +### plot\_xdata + + + +`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. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – the discriminators get\_xdata will be used to retrieve the x data from the Result or list of Results. +* **color** (*str*) – color of the IQ points in the scatter plot. + +**Raises** + +**QiskitError** – If not enough axis instances are provided + +## Attributes + + ### expected\_states Returns the expected states used to train the discriminator. - + ### fitted True if the discriminator has been fitted to calibration data. - + ### schedules Returns the schedules with which the discriminator was fitted. + 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 25357dd7b3d..ba4bd514893 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.LinearIQDiscriminator.md @@ -1,8 +1,16 @@ -# LinearIQDiscriminator +--- +title: LinearIQDiscriminator +description: API reference for qiskit.ignis.measurement.LinearIQDiscriminator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.measurement.LinearIQDiscriminator +--- +# LinearIQDiscriminator + -`LinearIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` +`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` @@ -10,11 +18,11 @@ Linear discriminant analysis discriminator for IQ data. **Parameters** -* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. +* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. * **qubit\_mask** (*List\[int]*) – determines which qubit’s level 1 data to use in the discrimination process. * **expected\_states** (*List\[str]*) – a list that should have the same length as schedules. All results in cal\_results are used if schedules is None. expected\_states must have the corresponding length. * **standardize** (*bool*) – if true the discriminator will standardize the xdata using the internal method \_scale\_data. -* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. +* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. * **discriminator\_parameters** (*dict*) – parameters for Sklearn’s LDA. **Raises** @@ -23,34 +31,209 @@ Linear discriminant analysis discriminator for IQ data. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.measurement.LinearIQDiscriminator.add_data#qiskit.ignis.measurement.LinearIQDiscriminator.add_data "qiskit.ignis.measurement.LinearIQDiscriminator.add_data") | **type result**`Result` | -| [`discriminate`](qiskit.ignis.measurement.LinearIQDiscriminator.discriminate#qiskit.ignis.measurement.LinearIQDiscriminator.discriminate "qiskit.ignis.measurement.LinearIQDiscriminator.discriminate") | Applies the discriminator to x\_data. | -| [`fit`](qiskit.ignis.measurement.LinearIQDiscriminator.fit#qiskit.ignis.measurement.LinearIQDiscriminator.fit "qiskit.ignis.measurement.LinearIQDiscriminator.fit") | Fits the discriminator using self.\_xdata and self.\_ydata. | -| [`format_iq_data`](qiskit.ignis.measurement.LinearIQDiscriminator.format_iq_data#qiskit.ignis.measurement.LinearIQDiscriminator.format_iq_data "qiskit.ignis.measurement.LinearIQDiscriminator.format_iq_data") | Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. | -| [`get_xdata`](qiskit.ignis.measurement.LinearIQDiscriminator.get_xdata#qiskit.ignis.measurement.LinearIQDiscriminator.get_xdata "qiskit.ignis.measurement.LinearIQDiscriminator.get_xdata") | Retrieves feature data (xdata) for the discriminator. | -| [`get_ydata`](qiskit.ignis.measurement.LinearIQDiscriminator.get_ydata#qiskit.ignis.measurement.LinearIQDiscriminator.get_ydata "qiskit.ignis.measurement.LinearIQDiscriminator.get_ydata") | Retrieves the expected states (ydata) for the discriminator. | -| [`is_calibration`](qiskit.ignis.measurement.LinearIQDiscriminator.is_calibration#qiskit.ignis.measurement.LinearIQDiscriminator.is_calibration "qiskit.ignis.measurement.LinearIQDiscriminator.is_calibration") | Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. | -| [`plot`](qiskit.ignis.measurement.LinearIQDiscriminator.plot#qiskit.ignis.measurement.LinearIQDiscriminator.plot "qiskit.ignis.measurement.LinearIQDiscriminator.plot") | Creates a plot of the data used to fit the discriminator. | -| [`plot_xdata`](qiskit.ignis.measurement.LinearIQDiscriminator.plot_xdata#qiskit.ignis.measurement.LinearIQDiscriminator.plot_xdata "qiskit.ignis.measurement.LinearIQDiscriminator.plot_xdata") | Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. | +### add\_data -## Attributes + + +`LinearIQDiscriminator.add_data(result, expected_states, refit=True, schedules=None)` + +**Parameters** + +* **result** (`Result`) – a Result containing new data to be used to train the discriminator. +* **expected\_states** (`List`\[`str`]) – the expected states of the results in result. +* **refit** (`bool`) – refit the discriminator if True. +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. + +### discriminate + + + +`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. + +**Parameters** + +**x\_data** (*List\[List\[float]]*) – list of features. Each feature is itself a list. + +**Return type** + +`List`\[`str`] + +**Returns** + +The discriminated x\_data as a list of labels. + +### fit + + + +`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. + +### format\_iq\_data + + + +`LinearIQDiscriminator.format_iq_data(iq_data)` + +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. + +**Parameters** + +**iq\_data** (*np.ndarray*) – data obtained from get\_memory(). + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +A list of shots where each entry is a list of IQ points. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if the measurement return type is unknown + +### get\_xdata + + + +`LinearIQDiscriminator.get_xdata(results, schedule_type_to_get, schedules=None)` + +Retrieves feature data (xdata) for the discriminator. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – the get\_memory() method is used to retrieve the level 1 data. If result is a list of Result, then the first Result in the list that returns the data of schedule (through get\_memory(schedule)) is used. +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to (`0`) calibration data only (`1`) non-calibration data (`2`) both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +data as a list of features. Each feature is a list. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if IQ data could not be found + +### get\_ydata + + +`LinearIQDiscriminator.get_ydata(results, schedule_type_to_get, schedules=None)` +Retrieves the expected states (ydata) for the discriminator. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – results for which to retrieve the y data (i.e. expected states). +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to \* 0 calibration data only \* 1 non-calibration data \* 2 both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Returns** + +**The y data, i.e. expected states. get\_ydata is designed to produce** + +y data with the same length as the x data. + +**Return type** + +list + +### is\_calibration + + + +`LinearIQDiscriminator.is_calibration(result_name)` + +Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. + +**Parameters** + +**result\_name** (`str`) – name of the result to be tested. + +**Returns** + +**True if the name of the result indicates that it is a** + +calibration result. + +**Return type** + +bool + +### plot + + + +`LinearIQDiscriminator.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` + +Creates a plot of the data used to fit the discriminator. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If it is none, the plot method will create its own axis instance. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **show\_boundary** (*bool*) – plot the decision regions if true. Some discriminators may put additional constraints on whether the decision regions are plotted or not. +* **show\_fitting\_data** (*bool*) – if True the x data and labels used to fit the discriminator are shown in the plot. +* **flag\_misclassified** (*bool*) – plot the misclassified training data points if true. +* **qubits\_to\_plot** (*list*) – each qubit in this list will receive its own plot. The qubits in qubits to plot must be in the qubit mask. If qubits\_to\_plot is None then the qubit mask will be used. +* **title** (*bool*) – adds a title to each subplot with the number of the qubit. + +**Returns** + +**A tuple of the form: `(Union[List[axes], axes], figure)`** + +where the axes object used for the plot as well as the figure handle. The figure handle returned is not None only when the figure handle is created by the discriminator’s plot method. + +**Return type** + +tuple + +**Raises** + +**QiskitError** – If matplotlib is not installed, or there is invalid input + +### plot\_xdata + + + +`LinearIQDiscriminator.plot_xdata(axs, results, color=None)` + +Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – the discriminators get\_xdata will be used to retrieve the x data from the Result or list of Results. +* **color** (*str*) – color of the IQ points in the scatter plot. + +**Raises** + +**QiskitError** – If not enough axis instances are provided + +## Attributes + + ### expected\_states Returns the expected states used to train the discriminator. - + ### fitted True if the discriminator has been fitted to calibration data. - + ### schedules Returns the schedules with which the discriminator was fitted. + 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 a31bf07bebd..3d6f722a7e0 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.QuadraticIQDiscriminator.md @@ -1,8 +1,16 @@ -# QuadraticIQDiscriminator +--- +title: QuadraticIQDiscriminator +description: API reference for qiskit.ignis.measurement.QuadraticIQDiscriminator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.measurement.QuadraticIQDiscriminator +--- +# QuadraticIQDiscriminator + -`QuadraticIQDiscriminator(cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None, discriminator_parameters=None)` +`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` @@ -10,11 +18,11 @@ Quadratic discriminant analysis discriminator for IQ data. **Parameters** -* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. +* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. * **qubit\_mask** (*List\[int]*) – determines which qubit’s level 1 data to use in the discrimination process. * **expected\_states** (*List\[str]*) – a list that should have the same length as schedules. All results in cal\_results are used if schedules is None. expected\_states must have the corresponding length. * **standardize** (*bool*) – if true the discriminator will standardize the xdata using the internal method \_scale\_data. -* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. +* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. * **discriminator\_parameters** (*dict*) – parameters for Sklearn’s LDA. **Raises** @@ -23,34 +31,209 @@ Quadratic discriminant analysis discriminator for IQ data. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.measurement.QuadraticIQDiscriminator.add_data#qiskit.ignis.measurement.QuadraticIQDiscriminator.add_data "qiskit.ignis.measurement.QuadraticIQDiscriminator.add_data") | **type result**`Result` | -| [`discriminate`](qiskit.ignis.measurement.QuadraticIQDiscriminator.discriminate#qiskit.ignis.measurement.QuadraticIQDiscriminator.discriminate "qiskit.ignis.measurement.QuadraticIQDiscriminator.discriminate") | Applies the discriminator to x\_data. | -| [`fit`](qiskit.ignis.measurement.QuadraticIQDiscriminator.fit#qiskit.ignis.measurement.QuadraticIQDiscriminator.fit "qiskit.ignis.measurement.QuadraticIQDiscriminator.fit") | Fits the discriminator using self.\_xdata and self.\_ydata. | -| [`format_iq_data`](qiskit.ignis.measurement.QuadraticIQDiscriminator.format_iq_data#qiskit.ignis.measurement.QuadraticIQDiscriminator.format_iq_data "qiskit.ignis.measurement.QuadraticIQDiscriminator.format_iq_data") | Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. | -| [`get_xdata`](qiskit.ignis.measurement.QuadraticIQDiscriminator.get_xdata#qiskit.ignis.measurement.QuadraticIQDiscriminator.get_xdata "qiskit.ignis.measurement.QuadraticIQDiscriminator.get_xdata") | Retrieves feature data (xdata) for the discriminator. | -| [`get_ydata`](qiskit.ignis.measurement.QuadraticIQDiscriminator.get_ydata#qiskit.ignis.measurement.QuadraticIQDiscriminator.get_ydata "qiskit.ignis.measurement.QuadraticIQDiscriminator.get_ydata") | Retrieves the expected states (ydata) for the discriminator. | -| [`is_calibration`](qiskit.ignis.measurement.QuadraticIQDiscriminator.is_calibration#qiskit.ignis.measurement.QuadraticIQDiscriminator.is_calibration "qiskit.ignis.measurement.QuadraticIQDiscriminator.is_calibration") | Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. | -| [`plot`](qiskit.ignis.measurement.QuadraticIQDiscriminator.plot#qiskit.ignis.measurement.QuadraticIQDiscriminator.plot "qiskit.ignis.measurement.QuadraticIQDiscriminator.plot") | Creates a plot of the data used to fit the discriminator. | -| [`plot_xdata`](qiskit.ignis.measurement.QuadraticIQDiscriminator.plot_xdata#qiskit.ignis.measurement.QuadraticIQDiscriminator.plot_xdata "qiskit.ignis.measurement.QuadraticIQDiscriminator.plot_xdata") | Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. | +### add\_data -## Attributes + + +`QuadraticIQDiscriminator.add_data(result, expected_states, refit=True, schedules=None)` + +**Parameters** + +* **result** (`Result`) – a Result containing new data to be used to train the discriminator. +* **expected\_states** (`List`\[`str`]) – the expected states of the results in result. +* **refit** (`bool`) – refit the discriminator if True. +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. + +### discriminate + + + +`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. + +**Parameters** + +**x\_data** (*List\[List\[float]]*) – list of features. Each feature is itself a list. + +**Return type** + +`List`\[`str`] + +**Returns** + +The discriminated x\_data as a list of labels. + +### fit + + + +`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. + +### format\_iq\_data + + + +`QuadraticIQDiscriminator.format_iq_data(iq_data)` + +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. + +**Parameters** + +**iq\_data** (*np.ndarray*) – data obtained from get\_memory(). + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +A list of shots where each entry is a list of IQ points. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if the measurement return type is unknown + +### get\_xdata + + + +`QuadraticIQDiscriminator.get_xdata(results, schedule_type_to_get, schedules=None)` + +Retrieves feature data (xdata) for the discriminator. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – the get\_memory() method is used to retrieve the level 1 data. If result is a list of Result, then the first Result in the list that returns the data of schedule (through get\_memory(schedule)) is used. +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to (`0`) calibration data only (`1`) non-calibration data (`2`) both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +data as a list of features. Each feature is a list. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if IQ data could not be found + +### get\_ydata + + +`QuadraticIQDiscriminator.get_ydata(results, schedule_type_to_get, schedules=None)` +Retrieves the expected states (ydata) for the discriminator. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – results for which to retrieve the y data (i.e. expected states). +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to \* 0 calibration data only \* 1 non-calibration data \* 2 both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Returns** + +**The y data, i.e. expected states. get\_ydata is designed to produce** + +y data with the same length as the x data. + +**Return type** + +list + +### is\_calibration + + + +`QuadraticIQDiscriminator.is_calibration(result_name)` + +Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. + +**Parameters** + +**result\_name** (`str`) – name of the result to be tested. + +**Returns** + +**True if the name of the result indicates that it is a** + +calibration result. + +**Return type** + +bool + +### plot + + + +`QuadraticIQDiscriminator.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` + +Creates a plot of the data used to fit the discriminator. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If it is none, the plot method will create its own axis instance. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **show\_boundary** (*bool*) – plot the decision regions if true. Some discriminators may put additional constraints on whether the decision regions are plotted or not. +* **show\_fitting\_data** (*bool*) – if True the x data and labels used to fit the discriminator are shown in the plot. +* **flag\_misclassified** (*bool*) – plot the misclassified training data points if true. +* **qubits\_to\_plot** (*list*) – each qubit in this list will receive its own plot. The qubits in qubits to plot must be in the qubit mask. If qubits\_to\_plot is None then the qubit mask will be used. +* **title** (*bool*) – adds a title to each subplot with the number of the qubit. + +**Returns** + +**A tuple of the form: `(Union[List[axes], axes], figure)`** + +where the axes object used for the plot as well as the figure handle. The figure handle returned is not None only when the figure handle is created by the discriminator’s plot method. + +**Return type** + +tuple + +**Raises** + +**QiskitError** – If matplotlib is not installed, or there is invalid input + +### plot\_xdata + + + +`QuadraticIQDiscriminator.plot_xdata(axs, results, color=None)` + +Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – the discriminators get\_xdata will be used to retrieve the x data from the Result or list of Results. +* **color** (*str*) – color of the IQ points in the scatter plot. + +**Raises** + +**QiskitError** – If not enough axis instances are provided + +## Attributes + + ### expected\_states Returns the expected states used to train the discriminator. - + ### fitted True if the discriminator has been fitted to calibration data. - + ### schedules Returns the schedules with which the discriminator was fitted. + 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 6de831dbe71..93de99f8d05 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.measurement.SklearnIQDiscriminator.md @@ -1,8 +1,16 @@ -# SklearnIQDiscriminator +--- +title: SklearnIQDiscriminator +description: API reference for qiskit.ignis.measurement.SklearnIQDiscriminator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.measurement.SklearnIQDiscriminator +--- +# SklearnIQDiscriminator + -`SklearnIQDiscriminator(classifier, cal_results, qubit_mask, expected_states=None, standardize=False, schedules=None)` +`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` @@ -11,42 +19,217 @@ A generic discriminant analysis discriminator for IQ data that takes an sklearn **Parameters** * **classifier** (*Classifier*) – An sklearn classifier to train and do the discrimination. The classifier must have a fit method and a predict method -* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. +* **cal\_results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – calibration results, Result or list of Result used to fit the discriminator. * **qubit\_mask** (*List\[int]*) – determines which qubit’s level 1 data to use in the discrimination process. * **expected\_states** (*List\[str]*) – a list that should have the same length as schedules. All results in cal\_results are used if schedules is None. expected\_states must have the corresponding length. * **standardize** (*bool*) – if true the discriminator will standardize the xdata using the internal method \_scale\_data. -* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. +* **schedules** (*Union\[List\[str], List\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*]]*) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.measurement.SklearnIQDiscriminator.add_data#qiskit.ignis.measurement.SklearnIQDiscriminator.add_data "qiskit.ignis.measurement.SklearnIQDiscriminator.add_data") | **type result**`Result` | -| [`discriminate`](qiskit.ignis.measurement.SklearnIQDiscriminator.discriminate#qiskit.ignis.measurement.SklearnIQDiscriminator.discriminate "qiskit.ignis.measurement.SklearnIQDiscriminator.discriminate") | Applies the discriminator to x\_data. | -| [`fit`](qiskit.ignis.measurement.SklearnIQDiscriminator.fit#qiskit.ignis.measurement.SklearnIQDiscriminator.fit "qiskit.ignis.measurement.SklearnIQDiscriminator.fit") | Fits the discriminator using self.\_xdata and self.\_ydata. | -| [`format_iq_data`](qiskit.ignis.measurement.SklearnIQDiscriminator.format_iq_data#qiskit.ignis.measurement.SklearnIQDiscriminator.format_iq_data "qiskit.ignis.measurement.SklearnIQDiscriminator.format_iq_data") | Takes IQ data obtained from get\_memory(), applies the qubit mask and formats the data as a list of lists. | -| [`get_xdata`](qiskit.ignis.measurement.SklearnIQDiscriminator.get_xdata#qiskit.ignis.measurement.SklearnIQDiscriminator.get_xdata "qiskit.ignis.measurement.SklearnIQDiscriminator.get_xdata") | Retrieves feature data (xdata) for the discriminator. | -| [`get_ydata`](qiskit.ignis.measurement.SklearnIQDiscriminator.get_ydata#qiskit.ignis.measurement.SklearnIQDiscriminator.get_ydata "qiskit.ignis.measurement.SklearnIQDiscriminator.get_ydata") | Retrieves the expected states (ydata) for the discriminator. | -| [`is_calibration`](qiskit.ignis.measurement.SklearnIQDiscriminator.is_calibration#qiskit.ignis.measurement.SklearnIQDiscriminator.is_calibration "qiskit.ignis.measurement.SklearnIQDiscriminator.is_calibration") | Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. | -| [`plot`](qiskit.ignis.measurement.SklearnIQDiscriminator.plot#qiskit.ignis.measurement.SklearnIQDiscriminator.plot "qiskit.ignis.measurement.SklearnIQDiscriminator.plot") | Creates a plot of the data used to fit the discriminator. | -| [`plot_xdata`](qiskit.ignis.measurement.SklearnIQDiscriminator.plot_xdata#qiskit.ignis.measurement.SklearnIQDiscriminator.plot_xdata "qiskit.ignis.measurement.SklearnIQDiscriminator.plot_xdata") | Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. | +### add\_data -## Attributes + + +`SklearnIQDiscriminator.add_data(result, expected_states, refit=True, schedules=None)` + +**Parameters** + +* **result** (`Result`) – a Result containing new data to be used to train the discriminator. +* **expected\_states** (`List`\[`str`]) – the expected states of the results in result. +* **refit** (`bool`) – refit the discriminator if True. +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – The schedules or a subset of schedules in cal\_results used to train the discriminator. The user may also pass the name of the schedules instead of the schedules. If schedules is None, then all the schedules in cal\_results are used. + +### discriminate + + + +`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. + +**Parameters** + +**x\_data** (*List\[List\[float]]*) – list of features. Each feature is itself a list. + +**Return type** + +`List`\[`str`] + +**Returns** + +the discriminated x\_data as a list of labels. + +### fit + + + +`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. + +### format\_iq\_data + + + +`SklearnIQDiscriminator.format_iq_data(iq_data)` + +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. + +**Parameters** + +**iq\_data** (*np.ndarray*) – data obtained from get\_memory(). + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +A list of shots where each entry is a list of IQ points. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if the measurement return type is unknown + +### get\_xdata + + + +`SklearnIQDiscriminator.get_xdata(results, schedule_type_to_get, schedules=None)` + +Retrieves feature data (xdata) for the discriminator. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – the get\_memory() method is used to retrieve the level 1 data. If result is a list of Result, then the first Result in the list that returns the data of schedule (through get\_memory(schedule)) is used. +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to (`0`) calibration data only (`1`) non-calibration data (`2`) both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Return type** + +`List`\[`List`\[`float`]] + +**Returns** + +data as a list of features. Each feature is a list. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – if IQ data could not be found + +### get\_ydata + + +`SklearnIQDiscriminator.get_ydata(results, schedule_type_to_get, schedules=None)` +Retrieves the expected states (ydata) for the discriminator. + +**Parameters** + +* **results** (`Union`\[`Result`, `List`\[`Result`]]) – results for which to retrieve the y data (i.e. expected states). +* **schedule\_type\_to\_get** (`int`) – use to specify if we should return data corresponding to \* 0 calibration data only \* 1 non-calibration data \* 2 both calibration and non-calibration data +* **schedules** (`Union`\[`List`\[`str`], `List`\[`Schedule`], `None`]) – Either the names of the schedules or the schedules themselves. + +**Returns** + +**The y data, i.e. expected states. get\_ydata is designed to produce** + +y data with the same length as the x data. + +**Return type** + +list + +### is\_calibration + + + +`SklearnIQDiscriminator.is_calibration(result_name)` + +Identify if a name corresponds to a calibration name identified by the regex pattern self.\_cal\_pattern. + +**Parameters** + +**result\_name** (`str`) – name of the result to be tested. + +**Returns** + +**True if the name of the result indicates that it is a** + +calibration result. + +**Return type** + +bool + +### plot + + + +`SklearnIQDiscriminator.plot(axs=None, show_boundary=False, show_fitting_data=True, flag_misclassified=False, qubits_to_plot=None, title=True)` + +Creates a plot of the data used to fit the discriminator. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If it is none, the plot method will create its own axis instance. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **show\_boundary** (*bool*) – plot the decision regions if true. Some discriminators may put additional constraints on whether the decision regions are plotted or not. +* **show\_fitting\_data** (*bool*) – if True the x data and labels used to fit the discriminator are shown in the plot. +* **flag\_misclassified** (*bool*) – plot the misclassified training data points if true. +* **qubits\_to\_plot** (*list*) – each qubit in this list will receive its own plot. The qubits in qubits to plot must be in the qubit mask. If qubits\_to\_plot is None then the qubit mask will be used. +* **title** (*bool*) – adds a title to each subplot with the number of the qubit. + +**Returns** + +**A tuple of the form: `(Union[List[axes], axes], figure)`** + +where the axes object used for the plot as well as the figure handle. The figure handle returned is not None only when the figure handle is created by the discriminator’s plot method. + +**Return type** + +tuple + +**Raises** + +**QiskitError** – If matplotlib is not installed, or there is invalid input + +### plot\_xdata + + + +`SklearnIQDiscriminator.plot_xdata(axs, results, color=None)` + +Add the relevant IQ data from the Qiskit Result, or list thereof, to the given axes as a scatter plot. + +**Parameters** + +* **axs** (*Union\[np.ndarray, axes]*) – the axis to use for the plot. If the number of axis instances provided is less than the number of qubits then only the data for the first len(axs) qubits will be plotted. +* **results** (*Union\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*, List\[*[*Result*](qiskit.result.Result "qiskit.result.Result")*]]*) – the discriminators get\_xdata will be used to retrieve the x data from the Result or list of Results. +* **color** (*str*) – color of the IQ points in the scatter plot. + +**Raises** + +**QiskitError** – If not enough axis instances are provided + +## Attributes + + ### expected\_states Returns the expected states used to train the discriminator. - + ### fitted True if the discriminator has been fitted to calibration data. - + ### schedules Returns the schedules with which the discriminator was fitted. + 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 427e96df844..334088e40ef 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.md @@ -1,32 +1,281 @@ -# CTMPExpvalMeasMitigator +--- +title: CTMPExpvalMeasMitigator +description: API reference for qiskit.ignis.mitigation.CTMPExpvalMeasMitigator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.CTMPExpvalMeasMitigator +--- +# CTMPExpvalMeasMitigator + -`CTMPExpvalMeasMitigator(generators, rates, num_qubits=None, seed=None)` +`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` N-qubit CTMP measurement error mitigator. -This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value#qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of N-qubit measurement errors caused by one and two-body error generators. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value#qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. +This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of N-qubit measurement errors caused by one and two-body error generators. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. -For measurement mitigation to be applied the mitigator should be calibrated using the [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits#qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") function and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter#qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class with the `'CTMP'` mitigation method. +For measurement mitigation to be applied the mitigator should be calibrated using the [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") function and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class with the `'CTMP'` mitigation method. Initialize a TensorMeasurementMitigator ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`assignment_fidelity`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_fidelity#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_fidelity "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_fidelity") | Return the measurement assignment fidelity on the specified qubits. | -| [`assignment_matrix`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_matrix#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_matrix "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_matrix") | Return the measurement assignment matrix for specified qubits. | -| [`expectation_value`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.expectation_value#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.expectation_value "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.expectation_value") | Compute the mitigated expectation value of a diagonal observable. | -| [`generator_matrix`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.generator_matrix#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.generator_matrix "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.generator_matrix") | Return the generator matrix on the specified qubits. | -| [`mitigation_matrix`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mitigation_matrix#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mitigation_matrix "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mitigation_matrix") | Return the measurement mitigation matrix for the specified qubits. | -| [`mitigation_overhead`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mitigation_overhead#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mitigation_overhead "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mitigation_overhead") | Return the mitigation overhead for expectation value estimation. | -| [`noise_strength`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.noise_strength#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.noise_strength "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.noise_strength") | Return the noise strength $gamma$ on the specified qubits | -| [`plot_assignment_matrix`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.plot_assignment_matrix#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.plot_assignment_matrix "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.plot_assignment_matrix") | Matrix plot of the readout error assignment matrix. | -| [`plot_mitigation_matrix`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.plot_mitigation_matrix#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.plot_mitigation_matrix "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.plot_mitigation_matrix") | Matrix plot of the readout error mitigation matrix. | -| [`required_shots`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.required_shots#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.required_shots "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.required_shots") | Return the number of shots required for expectation value estimation. | -| [`seed`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.seed#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.seed "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.seed") | Set the seed for the quantum state RNG. | -| [`stddev_upper_bound`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.stddev_upper_bound#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.stddev_upper_bound "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.stddev_upper_bound") | Return an upper bound on standard deviation of expval estimator. | +### assignment\_fidelity + + + +`CTMPExpvalMeasMitigator.assignment_fidelity(qubits=None)` + +Return the measurement assignment fidelity on the specified qubits. + +The assignment fidelity on N-qubits is defined as $\sum_{x\in\{0, 1\}^n} P(x|x) / 2^n$, where $P(x|x) = \rangle x|A|x\langle$, and $A$ is the [`assignment_matrix()`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator#assignment_matrix "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_matrix"). + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the assignment fidelity. + +**Return type** + +float + +### assignment\_matrix + + + +`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. + +The assignment matrix is the stochastic matrix $A$ which assigns a noisy measurement probability distribution to an ideal input measurement distribution: $P(i|j) = \langle i | A | j \rangle$. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the assignment matrix A. + +**Return type** + +np.ndarray + +### expectation\_value + + + +`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. + +This computes the mitigated estimator of $\langle O \rangle = \mbox{Tr}[\rho. O]$ of a diagonal observable $O = \sum_{x\in\{0, 1\}^n} O(x)|x\rangle\!\langle x|$. + +**Parameters** + +* **counts** (`Dict`) – counts object +* **diagonal** (`Optional`\[`ndarray`]) – Optional, the vector of diagonal values for summing the expectation value. If `None` the the default value is $[1, -1]^\otimes n$. +* **qubits** (`Optional`\[`List`\[`int`]]) – Optional, the measured physical qubits the count bitstrings correspond to. If None qubits are assumed to be $[0, ..., n-1]$. +* **clbits** (`Optional`\[`List`\[`int`]]) – Optional, if not None marginalize counts to the specified bits. + +**Returns** + +the expectation value and standard deviation. + +**Return type** + +(float, float) + +#### Additional Information: + +The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Numpy array $[O(0), ..., O(2^n -1)]$. If no diagonal is specified the diagonal of the Pauli operator :math\`O = mbox\{diag}(Z^\{otimes n}) = \[1, -1]^\{otimes n}\` is used. + +The `clbits` kwarg is used to marginalize the input counts dictionary over the specified bit-values, and the `qubits` kwarg is used to specify which physical qubits these bit-values correspond to as `circuit.measure(qubits, clbits)`. + +### generator\_matrix + + + +`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. + +The generator matrix $G$ is given by $\sum_i r_i G_i$ where the sum is taken over all $G_i$ acting on the specified qubits subset. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubit subset for the generators. + +**Returns** + +the generator matrix $G$. + +**Return type** + +sps.coo\_matrix + +### mitigation\_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") + +Return the measurement mitigation matrix for the specified qubits. + +The mitigation matrix $A^{-1}$ is defined as the inverse of the [`assignment_matrix()`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator#assignment_matrix "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.assignment_matrix") $A$. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the measurement error mitigation matrix $A^{-1}$. + +**Return type** + +np.ndarray + +### mitigation\_overhead + + + +`CTMPExpvalMeasMitigator.mitigation_overhead(qubits=None)` + +Return the mitigation overhead for expectation value estimation. + +This is the multiplicative factor of extra shots required for estimating a mitigated expectation value with the same accuracy as an unmitigated expectation value. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the mitigation overhead factor. + +**Return type** + +int + +### noise\_strength + + + +`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 + +**Return type** + +`float` + +### plot\_assignment\_matrix + + + +`CTMPExpvalMeasMitigator.plot_assignment_matrix(qubits=None, ax=None)` + +Matrix plot of the readout error assignment matrix. + +**Parameters** + +* **qubits** (*list(int)*) – Optional, qubits being measured for operator expval. +* **ax** (*axes*) – Optional. Axes object to add plot to. + +**Returns** + +the figure axes object. + +**Return type** + +plt.axes + +**Raises** + +**ImportError** – if matplotlib is not installed. + +### plot\_mitigation\_matrix + + + +`CTMPExpvalMeasMitigator.plot_mitigation_matrix(qubits=None, ax=None)` + +Matrix plot of the readout error mitigation matrix. + +**Parameters** + +* **qubits** (*list(int)*) – Optional, qubits being measured for operator expval. +* **ax** (*plt.axes*) – Optional. Axes object to add plot to. + +**Returns** + +the figure axes object. + +**Return type** + +plt.axes + +**Raises** + +**ImportError** – if matplotlib is not installed. + +### required\_shots + + + +`CTMPExpvalMeasMitigator.required_shots(delta, qubits=None)` + +Return the number of shots required for expectation value estimation. + +This is the number of shots required so that $|\langle O \rangle_{est} - \langle O \rangle_{true}| < \delta$ with high probability (at least 2/3) and is given by $4\delta^2 \Gamma^2$ where $\Gamma^2$ is the [`mitigation_overhead()`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator#mitigation_overhead "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator.mitigation_overhead"). + +**Parameters** + +* **delta** (`float`) – Error tolerance for expectation value estimator. +* **qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the required shots. + +**Return type** + +int + +### seed + + + +`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. + +### stddev\_upper\_bound + + + +`CTMPExpvalMeasMitigator.stddev_upper_bound(shots=1, qubits=None)` + +Return an upper bound on standard deviation of expval estimator. + +**Parameters** + +* **shots** (`int`) – Number of shots used for expectation value measurement. +* **qubits** (`Optional`\[`List`\[`int`]]) – qubits being measured for operator expval. + +**Returns** + +the standard deviation upper bound. + +**Return type** + +float + 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 f0981ee546d..0ca0b7b67c0 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.md @@ -1,16 +1,24 @@ -# CompleteExpvalMeasMitigator +--- +title: CompleteExpvalMeasMitigator +description: API reference for qiskit.ignis.mitigation.CompleteExpvalMeasMitigator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.CompleteExpvalMeasMitigator +--- +# CompleteExpvalMeasMitigator + -`CompleteExpvalMeasMitigator(amat)` +`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` N-qubit measurement error mitigator. -This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value#qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of general N-qubit measurement errors when calculating expectation values from counts. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value#qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. +This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of general N-qubit measurement errors when calculating expectation values from counts. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. -For measurement mitigation to be applied the mitigator should be calibrated using the [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits#qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") function and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter#qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class with the `'complete'` mitigation method. +For measurement mitigation to be applied the mitigator should be calibrated using the [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") function and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class with the `'complete'` mitigation method. Initialize a TensorMeasurementMitigator @@ -20,14 +28,220 @@ Initialize a TensorMeasurementMitigator ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`assignment_fidelity`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_fidelity#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_fidelity "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_fidelity") | Return the measurement assignment fidelity on the specified qubits. | -| [`assignment_matrix`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_matrix#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_matrix "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_matrix") | Return the measurement assignment matrix for specified qubits. | -| [`expectation_value`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.expectation_value#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.expectation_value "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.expectation_value") | Compute the mitigated expectation value of a diagonal observable. | -| [`mitigation_matrix`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mitigation_matrix#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mitigation_matrix "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mitigation_matrix") | Return the measurement mitigation matrix for the specified qubits. | -| [`mitigation_overhead`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mitigation_overhead#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mitigation_overhead "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mitigation_overhead") | Return the mitigation overhead for expectation value estimation. | -| [`plot_assignment_matrix`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.plot_assignment_matrix#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.plot_assignment_matrix "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.plot_assignment_matrix") | Matrix plot of the readout error assignment matrix. | -| [`plot_mitigation_matrix`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.plot_mitigation_matrix#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.plot_mitigation_matrix "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.plot_mitigation_matrix") | Matrix plot of the readout error mitigation matrix. | -| [`required_shots`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.required_shots#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.required_shots "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.required_shots") | Return the number of shots required for expectation value estimation. | -| [`stddev_upper_bound`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.stddev_upper_bound#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.stddev_upper_bound "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.stddev_upper_bound") | Return an upper bound on standard deviation of expval estimator. | +### assignment\_fidelity + + + +`CompleteExpvalMeasMitigator.assignment_fidelity(qubits=None)` + +Return the measurement assignment fidelity on the specified qubits. + +The assignment fidelity on N-qubits is defined as $\sum_{x\in\{0, 1\}^n} P(x|x) / 2^n$, where $P(x|x) = \rangle x|A|x\langle$, and $A$ is the [`assignment_matrix()`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator#assignment_matrix "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_matrix"). + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the assignment fidelity. + +**Return type** + +float + +### assignment\_matrix + + + +`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. + +The assignment matrix is the stochastic matrix $A$ which assigns a noisy measurement probability distribution to an ideal input measurement distribution: $P(i|j) = \langle i | A | j \rangle$. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the assignment matrix A. + +**Return type** + +np.ndarray + +### expectation\_value + + + +`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. + +This computes the mitigated estimator of $\langle O \rangle = \mbox{Tr}[\rho. O]$ of a diagonal observable $O = \sum_{x\in\{0, 1\}^n} O(x)|x\rangle\!\langle x|$. + +**Parameters** + +* **counts** (`Dict`) – counts object +* **diagonal** (`Optional`\[`ndarray`]) – Optional, the vector of diagonal values for summing the expectation value. If `None` the the default value is $[1, -1]^\otimes n$. +* **qubits** (`Optional`\[`List`\[`int`]]) – Optional, the measured physical qubits the count bitstrings correspond to. If None qubits are assumed to be $[0, ..., n-1]$. +* **clbits** (`Optional`\[`List`\[`int`]]) – Optional, if not None marginalize counts to the specified bits. + +**Returns** + +the expectation value and standard deviation. + +**Return type** + +(float, float) + +**Raises** + +**QiskitError** – if input arguments are invalid. + +#### Additional Information: + +The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Numpy array $[O(0), ..., O(2^n -1)]$. If no diagonal is specified the diagonal of the Pauli operator :math\`O = mbox\{diag}(Z^\{otimes n}) = \[1, -1]^\{otimes n}\` is used. + +The `clbits` kwarg is used to marginalize the input counts dictionary over the specified bit-values, and the `qubits` kwarg is used to specify which physical qubits these bit-values correspond to as `circuit.measure(qubits, clbits)`. + +### mitigation\_matrix + + + +`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. + +The mitigation matrix $A^{-1}$ is defined as the inverse of the [`assignment_matrix()`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator#assignment_matrix "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.assignment_matrix") $A$. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the measurement error mitigation matrix $A^{-1}$. + +**Return type** + +np.ndarray + +### mitigation\_overhead + + + +`CompleteExpvalMeasMitigator.mitigation_overhead(qubits=None)` + +Return the mitigation overhead for expectation value estimation. + +This is the multiplicative factor of extra shots required for estimating a mitigated expectation value with the same accuracy as an unmitigated expectation value. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the mitigation overhead factor. + +**Return type** + +int + +### plot\_assignment\_matrix + + + +`CompleteExpvalMeasMitigator.plot_assignment_matrix(qubits=None, ax=None)` + +Matrix plot of the readout error assignment matrix. + +**Parameters** + +* **qubits** (*list(int)*) – Optional, qubits being measured for operator expval. +* **ax** (*axes*) – Optional. Axes object to add plot to. + +**Returns** + +the figure axes object. + +**Return type** + +plt.axes + +**Raises** + +**ImportError** – if matplotlib is not installed. + +### plot\_mitigation\_matrix + + + +`CompleteExpvalMeasMitigator.plot_mitigation_matrix(qubits=None, ax=None)` + +Matrix plot of the readout error mitigation matrix. + +**Parameters** + +* **qubits** (*list(int)*) – Optional, qubits being measured for operator expval. +* **ax** (*plt.axes*) – Optional. Axes object to add plot to. + +**Returns** + +the figure axes object. + +**Return type** + +plt.axes + +**Raises** + +**ImportError** – if matplotlib is not installed. + +### required\_shots + + + +`CompleteExpvalMeasMitigator.required_shots(delta, qubits=None)` + +Return the number of shots required for expectation value estimation. + +This is the number of shots required so that $|\langle O \rangle_{est} - \langle O \rangle_{true}| < \delta$ with high probability (at least 2/3) and is given by $4\delta^2 \Gamma^2$ where $\Gamma^2$ is the [`mitigation_overhead()`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator#mitigation_overhead "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator.mitigation_overhead"). + +**Parameters** + +* **delta** (`float`) – Error tolerance for expectation value estimator. +* **qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the required shots. + +**Return type** + +int + +### stddev\_upper\_bound + + + +`CompleteExpvalMeasMitigator.stddev_upper_bound(shots=1, qubits=None)` + +Return an upper bound on standard deviation of expval estimator. + +**Parameters** + +* **shots** (`int`) – Number of shots used for expectation value measurement. +* **qubits** (`Optional`\[`List`\[`int`]]) – qubits being measured for operator expval. + +**Returns** + +the standard deviation upper bound. + +**Return type** + +float + 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 dffe58e0ceb..0f3bba86927 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.CompleteMeasFitter.md @@ -1,8 +1,16 @@ -# CompleteMeasFitter +--- +title: CompleteMeasFitter +description: API reference for qiskit.ignis.mitigation.CompleteMeasFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.CompleteMeasFitter +--- +# CompleteMeasFitter + -`CompleteMeasFitter(results, state_labels, qubit_list=None, circlabel='')` +`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` @@ -21,35 +29,105 @@ A wrapper for the tensored fitter ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.mitigation.CompleteMeasFitter.add_data#qiskit.ignis.mitigation.CompleteMeasFitter.add_data "qiskit.ignis.mitigation.CompleteMeasFitter.add_data") | Add measurement calibration data | -| [`plot_calibration`](qiskit.ignis.mitigation.CompleteMeasFitter.plot_calibration#qiskit.ignis.mitigation.CompleteMeasFitter.plot_calibration "qiskit.ignis.mitigation.CompleteMeasFitter.plot_calibration") | Plot the calibration matrix (2D color grid plot) | -| [`readout_fidelity`](qiskit.ignis.mitigation.CompleteMeasFitter.readout_fidelity#qiskit.ignis.mitigation.CompleteMeasFitter.readout_fidelity "qiskit.ignis.mitigation.CompleteMeasFitter.readout_fidelity") | Based on the results, output the readout fidelity which is the normalized trace of the calibration matrix | -| [`subset_fitter`](qiskit.ignis.mitigation.CompleteMeasFitter.subset_fitter#qiskit.ignis.mitigation.CompleteMeasFitter.subset_fitter "qiskit.ignis.mitigation.CompleteMeasFitter.subset_fitter") | Return a fitter object that is a subset of the qubits in the original list. | +### add\_data -## Attributes + + +`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 + +**Parameters** + +* **new\_results** (*list or* [*qiskit.result.Result*](qiskit.result.Result "qiskit.result.Result")) – a single result or list of result objects. +* **rebuild\_cal\_matrix** (*bool*) – rebuild the calibration matrix + +### plot\_calibration + + + +`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) + +**Parameters** + +* **show\_plot** (*bool*) – call plt.show() +* **ax** (*matplotlib.axes.Axes*) – An optional Axes object to use for the plot + +### readout\_fidelity + + + +`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 + +**Parameters** + +**label\_list** (*bool*) – If None, returns the average assignment fidelity of a single state. Otherwise it returns the assignment fidelity to be in any one of these states averaged over the second index. + +**Returns** + +readout fidelity (assignment fidelity) +**Return type** +numpy.array + +#### Additional Information: + +The on-diagonal elements of the calibration matrix are the probabilities of measuring state ‘x’ given preparation of state ‘x’ and so the normalized trace is the average assignment fidelity + +### subset\_fitter + + + +`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. + +**Parameters** + +**qubit\_sublist** (*list*) – must be a subset of qubit\_list + +**Returns** + +**A new fitter that has the calibration for a** + +subset of qubits + +**Return type** + +[CompleteMeasFitter](qiskit.ignis.mitigation.CompleteMeasFitter "qiskit.ignis.mitigation.CompleteMeasFitter") + +**Raises** + +**QiskitError** – If the calibration matrix is not initialized + +## Attributes + + ### cal\_matrix Return cal\_matrix. - + ### filter Return a measurement filter using the cal matrix. - + ### qubit\_list Return list of qubits. - + ### state\_labels Return state\_labels. + 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 0ef10c4e9b9..57a69ef51fa 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.md @@ -1,14 +1,22 @@ -# ExpvalMeasMitigatorFitter +--- +title: ExpvalMeasMitigatorFitter +description: API reference for qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter +--- +# ExpvalMeasMitigatorFitter + -`ExpvalMeasMitigatorFitter(result, metadata)` +`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` Expectation value measurement error mitigator calibration fitter. -See [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits#qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") for additional documentation. +See [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") for additional documentation. Fit a measurement error mitigator object from experiment data. @@ -19,14 +27,23 @@ Fit a measurement error mitigator object from experiment data. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | -| [`fit`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.fit#qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.fit "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter.fit") | Fit and return the Mitigator object from the calibration data. | +### fit -## Attributes + + +`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. +**Return type** +`Union`\[`CompleteExpvalMeasMitigator`, `TensoredExpvalMeasMitigator`, `CTMPExpvalMeasMitigator`] + +## Attributes + + ### mitigator Return the fitted mitigator object + 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 cb539c67d20..4bc47d26b5b 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.MeasurementFilter.md @@ -1,8 +1,16 @@ -# MeasurementFilter +--- +title: MeasurementFilter +description: API reference for qiskit.ignis.mitigation.MeasurementFilter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.MeasurementFilter +--- +# MeasurementFilter + -`MeasurementFilter(cal_matrix, state_labels)` +`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` @@ -19,20 +27,59 @@ Initialize a measurement error mitigation filter using the cal\_matrix from a me ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | -| [`apply`](qiskit.ignis.mitigation.MeasurementFilter.apply#qiskit.ignis.mitigation.MeasurementFilter.apply "qiskit.ignis.mitigation.MeasurementFilter.apply") | Apply the calibration matrix to results. | +### apply -## Attributes + + +`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. + +**Parameters** + +* **raw\_data** (*dict or list*) – + + The data to be corrected. Can be in a number of forms: + + Form 1: a counts dictionary from results.get\_counts + + Form 2: a list of counts of length==len(state\_labels) + + Form 3: a list of counts of length==M\*len(state\_labels) where M is an integer (e.g. for use with the tomography data) + + Form 4: a qiskit Result +* **method** (*str*) – + fitting method. If None, then least\_squares is used. + + `pseudo_inverse`: direct inversion of the A matrix + + `least_squares`: constrained to have physical probabilities + +**Returns** + +The corrected data in the same form as raw\_data + +**Return type** + +dict or list + +**Raises** + +**QiskitError** – if raw\_data is not an integer multiple of the number of calibrated states. + +## Attributes + + ### cal\_matrix Return cal\_matrix. - + ### state\_labels return the state label ordering of the cal matrix + 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 1cd5c3a6e01..49e3ba02622 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.md @@ -1,16 +1,24 @@ -# TensoredExpvalMeasMitigator +--- +title: TensoredExpvalMeasMitigator +description: API reference for qiskit.ignis.mitigation.TensoredExpvalMeasMitigator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.TensoredExpvalMeasMitigator +--- +# TensoredExpvalMeasMitigator + -`TensoredExpvalMeasMitigator(amats)` +`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` 1-qubit tensor product measurement error mitigator. -This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value#qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of local single-qubit measurement errors. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value#qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. +This class can be used with the [`qiskit.ignis.mitigation.expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") function to apply measurement error mitigation of local single-qubit measurement errors. Expectation values can also be computed directly using the [`expectation_value()`](qiskit.ignis.mitigation.expectation_value "qiskit.ignis.mitigation.expectation_value") method. -For measurement mitigation to be applied the mitigator should be calibrated using the [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits#qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") function and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter#qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class with the `'tensored'` mitigation method. +For measurement mitigation to be applied the mitigator should be calibrated using the [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") function and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class with the `'tensored'` mitigation method. Initialize a TensorMeasurementMitigator @@ -20,14 +28,216 @@ Initialize a TensorMeasurementMitigator ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`assignment_fidelity`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_fidelity#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_fidelity "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_fidelity") | Return the measurement assignment fidelity on the specified qubits. | -| [`assignment_matrix`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_matrix#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_matrix "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_matrix") | Return the measurement assignment matrix for specified qubits. | -| [`expectation_value`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.expectation_value#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.expectation_value "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.expectation_value") | Compute the mitigated expectation value of a diagonal observable. | -| [`mitigation_matrix`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mitigation_matrix#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mitigation_matrix "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mitigation_matrix") | Return the measurement mitigation matrix for the specified qubits. | -| [`mitigation_overhead`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mitigation_overhead#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mitigation_overhead "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mitigation_overhead") | Return the mitigation overhead for expectation value estimation. | -| [`plot_assignment_matrix`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.plot_assignment_matrix#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.plot_assignment_matrix "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.plot_assignment_matrix") | Matrix plot of the readout error assignment matrix. | -| [`plot_mitigation_matrix`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.plot_mitigation_matrix#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.plot_mitigation_matrix "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.plot_mitigation_matrix") | Matrix plot of the readout error mitigation matrix. | -| [`required_shots`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.required_shots#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.required_shots "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.required_shots") | Return the number of shots required for expectation value estimation. | -| [`stddev_upper_bound`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.stddev_upper_bound#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.stddev_upper_bound "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.stddev_upper_bound") | Return an upper bound on standard deviation of expval estimator. | +### assignment\_fidelity + + + +`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. + +The assignment fidelity on N-qubits is defined as $\sum_{x\in\{0, 1\}^n} P(x|x) / 2^n$, where $P(x|x) = \rangle x|A|x\langle$, and $A$ is the [`assignment_matrix()`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator#assignment_matrix "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_matrix"). + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the assignment fidelity. + +**Return type** + +float + +### assignment\_matrix + + + +`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. + +The assignment matrix is the stochastic matrix $A$ which assigns a noisy measurement probability distribution to an ideal input measurement distribution: $P(i|j) = \langle i | A | j \rangle$. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the assignment matrix A. + +**Return type** + +np.ndarray + +### expectation\_value + + + +`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. + +This computes the mitigated estimator of $\langle O \rangle = \mbox{Tr}[\rho. O]$ of a diagonal observable $O = \sum_{x\in\{0, 1\}^n} O(x)|x\rangle\!\langle x|$. + +**Parameters** + +* **counts** (`Dict`) – counts object +* **diagonal** (`Optional`\[`ndarray`]) – Optional, the vector of diagonal values for summing the expectation value. If `None` the the default value is $[1, -1]^\otimes n$. +* **qubits** (`Optional`\[`List`\[`int`]]) – Optional, the measured physical qubits the count bitstrings correspond to. If None qubits are assumed to be $[0, ..., n-1]$. +* **clbits** (`Optional`\[`List`\[`int`]]) – Optional, if not None marginalize counts to the specified bits. + +**Returns** + +the expectation value and standard deviation. + +**Return type** + +(float, float) + +#### Additional Information: + +The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Numpy array $[O(0), ..., O(2^n -1)]$. If no diagonal is specified the diagonal of the Pauli operator :math\`O = mbox\{diag}(Z^\{otimes n}) = \[1, -1]^\{otimes n}\` is used. + +The `clbits` kwarg is used to marginalize the input counts dictionary over the specified bit-values, and the `qubits` kwarg is used to specify which physical qubits these bit-values correspond to as `circuit.measure(qubits, clbits)`. + +### mitigation\_matrix + + + +`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. + +The mitigation matrix $A^{-1}$ is defined as the inverse of the [`assignment_matrix()`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator#assignment_matrix "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.assignment_matrix") $A$. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the measurement error mitigation matrix $A^{-1}$. + +**Return type** + +np.ndarray + +### mitigation\_overhead + + + +`TensoredExpvalMeasMitigator.mitigation_overhead(qubits=None)` + +Return the mitigation overhead for expectation value estimation. + +This is the multiplicative factor of extra shots required for estimating a mitigated expectation value with the same accuracy as an unmitigated expectation value. + +**Parameters** + +**qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the mitigation overhead factor. + +**Return type** + +int + +### plot\_assignment\_matrix + + + +`TensoredExpvalMeasMitigator.plot_assignment_matrix(qubits=None, ax=None)` + +Matrix plot of the readout error assignment matrix. + +**Parameters** + +* **qubits** (*list(int)*) – Optional, qubits being measured for operator expval. +* **ax** (*axes*) – Optional. Axes object to add plot to. + +**Returns** + +the figure axes object. + +**Return type** + +plt.axes + +**Raises** + +**ImportError** – if matplotlib is not installed. + +### plot\_mitigation\_matrix + + + +`TensoredExpvalMeasMitigator.plot_mitigation_matrix(qubits=None, ax=None)` + +Matrix plot of the readout error mitigation matrix. + +**Parameters** + +* **qubits** (*list(int)*) – Optional, qubits being measured for operator expval. +* **ax** (*plt.axes*) – Optional. Axes object to add plot to. + +**Returns** + +the figure axes object. + +**Return type** + +plt.axes + +**Raises** + +**ImportError** – if matplotlib is not installed. + +### required\_shots + + + +`TensoredExpvalMeasMitigator.required_shots(delta, qubits=None)` + +Return the number of shots required for expectation value estimation. + +This is the number of shots required so that $|\langle O \rangle_{est} - \langle O \rangle_{true}| < \delta$ with high probability (at least 2/3) and is given by $4\delta^2 \Gamma^2$ where $\Gamma^2$ is the [`mitigation_overhead()`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator#mitigation_overhead "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator.mitigation_overhead"). + +**Parameters** + +* **delta** (`float`) – Error tolerance for expectation value estimator. +* **qubits** (`Optional`\[`List`\[`int`]]) – Optional, qubits being measured for operator expval. + +**Returns** + +the required shots. + +**Return type** + +int + +### stddev\_upper\_bound + + + +`TensoredExpvalMeasMitigator.stddev_upper_bound(shots=1, qubits=None)` + +Return an upper bound on standard deviation of expval estimator. + +**Parameters** + +* **shots** (`int`) – Number of shots used for expectation value measurement. +* **qubits** (`Optional`\[`List`\[`int`]]) – qubits being measured for operator expval. + +**Returns** + +the standard deviation upper bound. + +**Return type** + +float + 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 9b75378b2be..2b0a1ce3bd7 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredFilter.md @@ -1,8 +1,16 @@ -# TensoredFilter +--- +title: TensoredFilter +description: API reference for qiskit.ignis.mitigation.TensoredFilter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.TensoredFilter +--- +# TensoredFilter + -`TensoredFilter(cal_matrices, substate_labels_list, mit_pattern)` +`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` @@ -20,34 +28,108 @@ Initialize a tensored measurement error mitigation filter using the cal\_matrice ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`apply`](qiskit.ignis.mitigation.TensoredFilter.apply#qiskit.ignis.mitigation.TensoredFilter.apply "qiskit.ignis.mitigation.TensoredFilter.apply") | Apply the calibration matrices to results. | -| [`compute_index_of_cal_mat`](qiskit.ignis.mitigation.TensoredFilter.compute_index_of_cal_mat#qiskit.ignis.mitigation.TensoredFilter.compute_index_of_cal_mat "qiskit.ignis.mitigation.TensoredFilter.compute_index_of_cal_mat") | Return the index of (pseudo inverse) calibration matrix for the input quantum state | -| [`flip_state`](qiskit.ignis.mitigation.TensoredFilter.flip_state#qiskit.ignis.mitigation.TensoredFilter.flip_state "qiskit.ignis.mitigation.TensoredFilter.flip_state") | Flip the state according to the chosen qubit positions | +### apply -## Attributes + + +`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. + +**Parameters** + +* **raw\_data** (*dict or* [*Result*](qiskit.result.Result "qiskit.result.Result")) – + + The data to be corrected. Can be in one of two forms: + + * A counts dictionary from results.get\_counts + * A Qiskit Result + +* **method** (*str*) – + + fitting method. The following methods are supported: + + * **’pseudo\_inverse’: direct inversion of the cal matrices.** + + Mitigated counts can contain negative values and the sum of counts would not equal to the shots. Mitigation is conducted qubit wise: For each qubit, mitigate the whole counts using the calibration matrices which affect the corresponding qubit. For example, assume we are mitigating the 3rd bit of the 4-bit counts using ‘2 imes 2’ calibration matrix A\_3. When mitigating the count of ‘0110’ in this step, the following formula is applied: count\[‘0110’] = A\_3^\{-1}\[1, 0]\*count\[‘0100’] + A\_3^\{-1}\[1, 1]\*count\[‘0110’]. + + The total time complexity of this method is O(m2^\{n + t}), where n is the size of calibrated qubits, m is the number of sets in mit\_pattern, and t is the size of largest set of mit\_pattern. If the mit\_pattern is shaped like \[\[0], \[1], \[2], …, \[n-1]], which corresponds to the tensor product noise model without cross-talk, then the time complexity would be O(n2^n). If the mit\_pattern is shaped like \[\[0, 1, 2, …, n-1]], which exactly corresponds to the complete error mitigation, then the time complexity would be O(2^(n+n)) = O(4^n). + + * **’least\_squares’: constrained to have physical probabilities.** + + Instead of directly applying inverse calibration matrices, this method solve a constrained optimization problem to find the closest probability vector to the result from ‘pseudo\_inverse’ method. Sequential least square quadratic programming (SLSQP) is used in the internal process. Every updating step in SLSQP takes O(m2^\{n+t}) time. Since this method is using the SLSQP optimization over the vector with lenght 2^n, the mitigation for 8 bit counts with the mit\_pattern = \[\[0], \[1], \[2], …, \[n-1]] would take 10 seconds or more. + + * If None, ‘least\_squares’ is used. + +* **meas\_layout** (*list of int*) – + + the mapping from classical registers to qubits + + * **If you measure qubit 2 to clbit 0, 0 to 1, and 1 to 2,** + + the list becomes \[2, 0, 1] + + * If None, flatten(mit\_pattern) is used. +**Returns** +The corrected data in the same form as raw\_data + +**Return type** + +dict or [Result](qiskit.result.Result "qiskit.result.Result") + +**Raises** + +**QiskitError** – if raw\_data is not in a one of the defined forms. + +### compute\_index\_of\_cal\_mat + + + +`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 + +**Return type** + +`int` + +### flip\_state + + + +`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 + +**Return type** + +`str` + +## Attributes + + ### cal\_matrices Return cal\_matrices. - + ### nqubits Return the number of qubits. See also MeasurementFilter.apply() - + ### qubit\_list\_sizes Return \_qubit\_list\_sizes. - + ### substate\_labels\_list Return \_substate\_labels\_list + diff --git a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md index 586d03ba728..a4bb48a9b8e 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.mitigation.TensoredMeasFitter.md @@ -1,8 +1,16 @@ -# TensoredMeasFitter +--- +title: TensoredMeasFitter +description: API reference for qiskit.ignis.mitigation.TensoredMeasFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.mitigation.TensoredMeasFitter +--- +# TensoredMeasFitter + -`TensoredMeasFitter(results, mit_pattern, substate_labels_list=None, circlabel='')` +`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` @@ -23,34 +31,90 @@ Initialize a measurement calibration matrix from the results of running the circ ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.mitigation.TensoredMeasFitter.add_data#qiskit.ignis.mitigation.TensoredMeasFitter.add_data "qiskit.ignis.mitigation.TensoredMeasFitter.add_data") | Add measurement calibration data | -| [`plot_calibration`](qiskit.ignis.mitigation.TensoredMeasFitter.plot_calibration#qiskit.ignis.mitigation.TensoredMeasFitter.plot_calibration "qiskit.ignis.mitigation.TensoredMeasFitter.plot_calibration") | Plot one of the calibration matrices (2D color grid plot). | -| [`readout_fidelity`](qiskit.ignis.mitigation.TensoredMeasFitter.readout_fidelity#qiskit.ignis.mitigation.TensoredMeasFitter.readout_fidelity "qiskit.ignis.mitigation.TensoredMeasFitter.readout_fidelity") | Based on the results, output the readout fidelity, which is the average of the diagonal entries in the calibration matrices. | +### add\_data -## Attributes + + +`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 + +**Parameters** + +* **new\_results** (*list or* [*qiskit.result.Result*](qiskit.result.Result "qiskit.result.Result")) – a single result or list of Result objects. +* **rebuild\_cal\_matrix** (*bool*) – rebuild the calibration matrix + +### plot\_calibration + + + +`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). + +**Parameters** + +* **cal\_index** (*integer*) – calibration matrix to plot +* **ax** (*matplotlib.axes*) – settings for the graph +* **show\_plot** (*bool*) – call plt.show() + +**Raises** + +* **QiskitError** – if \_cal\_matrices was not set. +* **ImportError** – if matplotlib was not installed. + +### readout\_fidelity + + +`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. + +**Parameters** + +* **cal\_index** (*integer*) – readout fidelity for this index in \_cal\_matrices +* **label\_list** (*list*) – Returns the average fidelity over of the groups f states. In the form of a list of lists of states. If None, then each state used in the construction of the calibration matrices forms a group of size 1 + +**Returns** + +The readout fidelity (assignment fidelity) + +**Return type** + +numpy.array + +**Raises** + +**QiskitError** – If the calibration matrix has not been set for the object. + +#### Additional Information: + +The on-diagonal elements of the calibration matrices are the probabilities of measuring state ‘x’ given preparation of state ‘x’. + +## Attributes + + ### cal\_matrices Return cal\_matrices. - + ### filter Return a measurement filter using the cal matrices. - + ### nqubits Return \_qubit\_list\_sizes. - + ### substate\_labels\_list Return \_substate\_labels\_list. + 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 93488f3ae43..744a88e8a2b 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.mitigation.complete\_meas\_cal +--- +title: complete_meas_cal +description: API reference for qiskit.ignis.mitigation.complete_meas_cal +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.mitigation.complete_meas_cal +--- +# qiskit.ignis.mitigation.complete\_meas\_cal + -`complete_meas_cal(qubit_list=None, qr=None, cr=None, circlabel='')` +`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. @@ -38,3 +46,4 @@ Pass the results of these circuits to the CompleteMeasurementFitter constructor. **Raises** **QiskitError** – if both qubit\_list and qr are None. + 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 6637a3dc49c..5ba83e1a0c4 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.mitigation.expectation\_value +--- +title: expectation_value +description: API reference for qiskit.ignis.mitigation.expectation_value +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.mitigation.expectation_value +--- +# qiskit.ignis.mitigation.expectation\_value + -`expectation_value(counts, diagonal=None, qubits=None, clbits=None, meas_mitigator=None)` +`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. @@ -30,4 +38,5 @@ The diagonal observable $O$ is input using the `diagonal` kwarg as a list or Num The `clbits` kwarg is used to marginalize the input counts dictionary over the specified bit-values, and the `qubits` kwarg is used to specify which physical qubits these bit-values correspond to as `circuit.measure(qubits, clbits)`. -For calibrating a expval measurement error mitigator for the `meas_mitigator` kwarg see [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits#qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter#qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter"). +For calibrating a expval measurement error mitigator for the `meas_mitigator` kwarg see [`qiskit.ignis.mitigation.expval_meas_mitigator_circuits()`](qiskit.ignis.mitigation.expval_meas_mitigator_circuits "qiskit.ignis.mitigation.expval_meas_mitigator_circuits") and [`qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter"). + 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 ba7f9ff5e5b..be21f7c7fe9 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 @@ -1,12 +1,20 @@ -# qiskit.ignis.mitigation.expval\_meas\_mitigator\_circuits +--- +title: expval_meas_mitigator_circuits +description: API reference for qiskit.ignis.mitigation.expval_meas_mitigator_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.mitigation.expval_meas_mitigator_circuits +--- +# qiskit.ignis.mitigation.expval\_meas\_mitigator\_circuits + -`expval_meas_mitigator_circuits(num_qubits, method='CTMP', labels=None)` +`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. -Use the [`ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter#qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class to fit the execution results to construct a calibrated expectation value measurement error mitigator. +Use the [`ExpvalMeasMitigatorFitter`](qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter "qiskit.ignis.mitigation.ExpvalMeasMitigatorFitter") class to fit the execution results to construct a calibrated expectation value measurement error mitigator. **Parameters** @@ -26,9 +34,9 @@ tuple ## Mitigation Method: -* The `'complete'` method will generate all $2^n$ computational basis states measurement circuits and fitting will return a [`CompleteExpvalMeasMitigator`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator#qiskit.ignis.mitigation.CompleteExpvalMeasMitigator "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator"). This method should only be used for small numbers of qubits. -* The `'tensored'` method will generate two input state circuits of the all 0 and all 1 states on number of qubits unless custom labels are specified. Ftting will return a [`TensoredExpvalMeasMitigator`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator#qiskit.ignis.mitigation.TensoredExpvalMeasMitigator "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator"). This method assumes measurement errors are uncorrelated between qubits. -* The `'CTMP'` method will generate input state circuits, unless custom labels are specified. The default input states must obey the following cirterion: for every pair of qubits, projection of the input states on the two qubits contains all four possible assignments to the qubits (00, 01, 10, 11). For n\<7, these would be the all 1 state and the $n$ states with a single qubit in the 1 state and all others in the 0 state (also the all 0 state, if n\<3). For n>=7, these would be the all 0 state, the all 1 state, and 2\*ceil(log2(n)) states resulting from the following procedure: For each qubits, write its index in binary form, horizontically. For example: with 8 qubits 0, 1, 2,…, 7, for qubit 7 we write: 1 1 1 And for all 8 qubits, we obtain ceil(log2(n))=3 lines: 00001111 00110011 01010101 One can see that the every column is the binary form of the column number. Then write again, the same lines, negated: 11110000 11001100 10101010 The all 0 and all 1 states guarantee that each pair of qubits has input states with projections 00 and 11. The other lines guarantee the projections 01 and 10 (since the qubits are different, when written in binary form, there must be a digit in which they differ). Fitting will return a [`CTMPExpvalMeasMitigator`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator#qiskit.ignis.mitigation.CTMPExpvalMeasMitigator "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator"). +* The `'complete'` method will generate all $2^n$ computational basis states measurement circuits and fitting will return a [`CompleteExpvalMeasMitigator`](qiskit.ignis.mitigation.CompleteExpvalMeasMitigator "qiskit.ignis.mitigation.CompleteExpvalMeasMitigator"). This method should only be used for small numbers of qubits. +* The `'tensored'` method will generate two input state circuits of the all 0 and all 1 states on number of qubits unless custom labels are specified. Ftting will return a [`TensoredExpvalMeasMitigator`](qiskit.ignis.mitigation.TensoredExpvalMeasMitigator "qiskit.ignis.mitigation.TensoredExpvalMeasMitigator"). This method assumes measurement errors are uncorrelated between qubits. +* The `'CTMP'` method will generate input state circuits, unless custom labels are specified. The default input states must obey the following cirterion: for every pair of qubits, projection of the input states on the two qubits contains all four possible assignments to the qubits (00, 01, 10, 11). For n\<7, these would be the all 1 state and the $n$ states with a single qubit in the 1 state and all others in the 0 state (also the all 0 state, if n\<3). For n>=7, these would be the all 0 state, the all 1 state, and 2\*ceil(log2(n)) states resulting from the following procedure: For each qubits, write its index in binary form, horizontically. For example: with 8 qubits 0, 1, 2,…, 7, for qubit 7 we write: 1 1 1 And for all 8 qubits, we obtain ceil(log2(n))=3 lines: 00001111 00110011 01010101 One can see that the every column is the binary form of the column number. Then write again, the same lines, negated: 11110000 11001100 10101010 The all 0 and all 1 states guarantee that each pair of qubits has input states with projections 00 and 11. The other lines guarantee the projections 01 and 10 (since the qubits are different, when written in binary form, there must be a digit in which they differ). Fitting will return a [`CTMPExpvalMeasMitigator`](qiskit.ignis.mitigation.CTMPExpvalMeasMitigator "qiskit.ignis.mitigation.CTMPExpvalMeasMitigator"). ## Example @@ -92,3 +100,4 @@ print('Expval (with mitigation): {:.2f} ± {:.2f}'.format( Expval (no mitigation): -0.66 ± 0.01 Expval (with mitigation): -0.98 ± 0.01 ``` + 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 77e8319d99e..3a447011701 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.mitigation.tensored\_meas\_cal +--- +title: tensored_meas_cal +description: API reference for qiskit.ignis.mitigation.tensored_meas_cal +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.mitigation.tensored_meas_cal +--- +# qiskit.ignis.mitigation.tensored\_meas\_cal + -`tensored_meas_cal(mit_pattern=None, qr=None, cr=None, circlabel='')` +`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 @@ -35,3 +43,4 @@ Pass the results of these circuits to the TensoredMeasurementFitter constructor. * **QiskitError** – if both mit\_pattern and qr are None. * **QiskitError** – if a qubit appears more than once in mit\_pattern. + 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 251895b2097..5dc44ca0492 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationCircuits.md @@ -1,8 +1,16 @@ -# AccreditationCircuits +--- +title: AccreditationCircuits +description: API reference for qiskit.ignis.verification.AccreditationCircuits +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.AccreditationCircuits +--- +# AccreditationCircuits + -`AccreditationCircuits(target_circ, two_qubit_gate='cx', coupling_map=None, seed=None)` +`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` @@ -14,14 +22,46 @@ Initialize the circuit generation class parse into layers **Parameters** -* **target\_circ** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – a qiskit circuit to accredit +* **target\_circ** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – a qiskit circuit to accredit * **two\_qubit\_gate** (*string*) – a flag as to which 2 qubit gate to compile with, can be cx or cz * **coupling\_map** (*list*) – some particular device topology as list of list (e.g. \[\[0,1],\[1,2],\[2,0]]) * **seed** (*int*) – seed to the random number generator ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | -| [`generate_circuits`](qiskit.ignis.verification.AccreditationCircuits.generate_circuits#qiskit.ignis.verification.AccreditationCircuits.generate_circuits "qiskit.ignis.verification.AccreditationCircuits.generate_circuits") | Generate quantum circuits for accreditation | -| [`target_circuit`](qiskit.ignis.verification.AccreditationCircuits.target_circuit#qiskit.ignis.verification.AccreditationCircuits.target_circuit "qiskit.ignis.verification.AccreditationCircuits.target_circuit") | Load target circuit in to class, and parse into layers | +### generate\_circuits + + + +`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 + +**Parameters** + +**num\_trap** (*int*) – number of trap circuits + +**Returns** + +**A tuple of the form** + +(`circuit_list`, postp\_list\`, `v_zero`) where: circuit\_list (list): accreditation circuits postp\_list (list): strings used for classical post-processing v\_zero (int): position of target circuit + +**Return type** + +tuple + +### target\_circuit + + + +`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 + +**Parameters** + +* **target\_circ** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – a qiskit circuit to accredit +* **two\_qubit\_gate** (*string*) – a flag as to which 2 qubit gate to compile with, can be cx or cz +* **coupling\_map** (*list*) – some particular device topology as list of list (e.g. \[\[0,1],\[1,2],\[2,0]]) + 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 e3cfd319de4..4d41f6e5e23 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.AccreditationFitter.md @@ -1,8 +1,16 @@ -# AccreditationFitter +--- +title: AccreditationFitter +description: API reference for qiskit.ignis.verification.AccreditationFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.AccreditationFitter +--- +# AccreditationFitter + -`AccreditationFitter` +`AccreditationFitter`[GitHub](https://github.com/qiskit-community/qiskit-ignis/tree/stable/0.6/qiskit/ignis/verification/accreditation/fitters.py "view source code") Bases: `object` @@ -12,57 +20,79 @@ Implementation follows the methods from Samuele Ferracin, Theodoros Kapourniotis ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| [`bound_variation_distance`](qiskit.ignis.verification.AccreditationFitter.bound_variation_distance#qiskit.ignis.verification.AccreditationFitter.bound_variation_distance "qiskit.ignis.verification.AccreditationFitter.bound_variation_distance") | This function computes the bound on variation distance based and the confidence | -| [`single_protocol_run`](qiskit.ignis.verification.AccreditationFitter.single_protocol_run#qiskit.ignis.verification.AccreditationFitter.single_protocol_run "qiskit.ignis.verification.AccreditationFitter.single_protocol_run") | Single protocol run of accreditation protocol on simul backend | +### bound\_variation\_distance -## Attributes + + +`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 + +**Parameters** + +**theta** (*float*) – number between 0 and 1 + +### single\_protocol\_run + + + +`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 +**Parameters** +* **results** ([*Result*](qiskit.result.Result "qiskit.result.Result")) – results of the quantum job +* **postp\_list** (*list*) – list of strings used to post-process outputs +* **v\_zero** (*int*) – position of target + +## Attributes + + ### N\_acc `= 0` - + ### bound `= 1` - + ### confidence `= 1` - + ### flag `= 'accepted'` - + ### g\_num `= 1` - + ### num\_runs `= 0` - + ### num\_traps `= 0` - + ### outputs `= []` + 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 7905815bd28..01718a5447a 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.BConfig.md @@ -1,8 +1,16 @@ -# BConfig +--- +title: BConfig +description: API reference for qiskit.ignis.verification.BConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.BConfig +--- +# BConfig + -`BConfig(backend, indicator=True)` +`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` @@ -10,13 +18,167 @@ This class is used to create a GHZ circuit with parallellized CNOT gates to incr ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`get_ghz_layout`](qiskit.ignis.verification.BConfig.get_ghz_layout#qiskit.ignis.verification.BConfig.get_ghz_layout "qiskit.ignis.verification.BConfig.get_ghz_layout") | 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 | -| [`get_ghz_mqc`](qiskit.ignis.verification.BConfig.get_ghz_mqc#qiskit.ignis.verification.BConfig.get_ghz_mqc "qiskit.ignis.verification.BConfig.get_ghz_mqc") | This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta | -| [`get_ghz_mqc_para`](qiskit.ignis.verification.BConfig.get_ghz_mqc_para#qiskit.ignis.verification.BConfig.get_ghz_mqc_para "qiskit.ignis.verification.BConfig.get_ghz_mqc_para") | Get a parametrized MQC circuit. | -| [`get_ghz_po`](qiskit.ignis.verification.BConfig.get_ghz_po#qiskit.ignis.verification.BConfig.get_ghz_po "qiskit.ignis.verification.BConfig.get_ghz_po") | This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta | -| [`get_ghz_po_para`](qiskit.ignis.verification.BConfig.get_ghz_po_para#qiskit.ignis.verification.BConfig.get_ghz_po_para "qiskit.ignis.verification.BConfig.get_ghz_po_para") | Get a parametrized PO circuit. | -| [`get_ghz_simple`](qiskit.ignis.verification.BConfig.get_ghz_simple#qiskit.ignis.verification.BConfig.get_ghz_simple "qiskit.ignis.verification.BConfig.get_ghz_simple") | Get simple GHZ circuit with measurement | -| [`get_measurement_circ`](qiskit.ignis.verification.BConfig.get_measurement_circ#qiskit.ignis.verification.BConfig.get_measurement_circ "qiskit.ignis.verification.BConfig.get_measurement_circ") | Creates a measurement circuit that can toggle between measuring the control qubit or measuring all qubits. | -| [`get_tier_dict`](qiskit.ignis.verification.BConfig.get_tier_dict#qiskit.ignis.verification.BConfig.get_tier_dict "qiskit.ignis.verification.BConfig.get_tier_dict") | 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]. | +### get\_ghz\_layout + + + +`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 + +**Return type** + +`Tuple`\[`QuantumCircuit`, `Dict`] + +**Returns** + +A GHZ Circuit and its initial GHZ layout + +### get\_ghz\_mqc + + + +`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 + +**Parameters** + +* **n** (`int`) – number of qubits +* **delta** (`float`) – the rotation of the middle phase around the z axis +* **full\_measurement** (`bool`) – Whether to append full measurement, or only on the first qubit + +**Return type** + +`Tuple`\[`QuantumCircuit`, `Dict`] + +**Returns** + +The MQC circuit and the initial GHZ layout + +### get\_ghz\_mqc\_para + + + +`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 + +**Parameters** + +* **n** (`int`) – number of qubits +* **full\_measurement** (`bool`) – Whether to append full measurement, or only on the first qubit + +**Return type** + +`Tuple`\[`QuantumCircuit`, `Parameter`, `Dict`] + +**Returns** + +The MQC circuit, its delta parameter, and the initial GHZ layout + +### get\_ghz\_po + + + +`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 + +**Parameters** + +* **n** (`int`) – number of qubits +* **delta** (`float`) – the middle superposition rotation + +**Return type** + +`Tuple`\[`QuantumCircuit`, `Dict`] + +**Returns** + +The Parity Oscillation circuit and the initial GHZ layout + +### get\_ghz\_po\_para + + + +`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 + +**Parameters** + +**n** (`int`) – number of qubits + +**Return type** + +`Tuple`\[`QuantumCircuit`, `List`\[`Parameter`], `Dict`] + +**Returns** + +**A parity oscillation circuit, its Delta/minus-delta parameters,** + +and the initial ghz layout + +### get\_ghz\_simple + + + +`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 + +**Parameters** + +* **n** (`int`) – number of qubits +* **full\_measurement** (`bool`) – Whether to append full measurement, or only on the first qubit + +**Return type** + +`Tuple`\[`QuantumCircuit`, `QuantumRegister`, `Dict`] + +**Returns** + +A GHZ Circuit, its measurement circle quantum register and the initial GHZ layout + +### get\_measurement\_circ + + + +`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. + +**Parameters** + +* **n** (`int`) – number of qubits +* **qregname** (`str`) – name of the qubit register +* **cregname** (`str`) – name of the classical register +* **full\_measurement** (`bool`) – Whether to append full measurement, or only on the first qubit + +**Return type** + +`QuantumCircuit` + +**Returns** + +The measurement circuit + +### get\_tier\_dict + + + +`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. + +**Return type** + +`Dict` + +**Returns** + +**Tier dictionary - \[step in process, control-target connection]** + +Facilitates parallelized GHZ circuits + 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 facdefc8c30..17a64ede7cb 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedral.md @@ -1,8 +1,16 @@ -# CNOTDihedral +--- +title: CNOTDihedral +description: API reference for qiskit.ignis.verification.CNOTDihedral +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.CNOTDihedral +--- +# CNOTDihedral + -`CNOTDihedral(data, validate=True)` +`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` @@ -17,58 +25,335 @@ Initialize a CNOTDihedral operator object. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.ignis.verification.CNOTDihedral.adjoint#qiskit.ignis.verification.CNOTDihedral.adjoint "qiskit.ignis.verification.CNOTDihedral.adjoint") | Return the conjugate transpose of the CNOTDihedral element | -| [`cnot`](qiskit.ignis.verification.CNOTDihedral.cnot#qiskit.ignis.verification.CNOTDihedral.cnot "qiskit.ignis.verification.CNOTDihedral.cnot") | Apply a CNOT gate to this element. | -| [`compose`](qiskit.ignis.verification.CNOTDihedral.compose#qiskit.ignis.verification.CNOTDihedral.compose "qiskit.ignis.verification.CNOTDihedral.compose") | Return the composed operator. | -| [`conjugate`](qiskit.ignis.verification.CNOTDihedral.conjugate#qiskit.ignis.verification.CNOTDihedral.conjugate "qiskit.ignis.verification.CNOTDihedral.conjugate") | Return the conjugate of the CNOTDihedral element. | -| [`copy`](qiskit.ignis.verification.CNOTDihedral.copy#qiskit.ignis.verification.CNOTDihedral.copy "qiskit.ignis.verification.CNOTDihedral.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.ignis.verification.CNOTDihedral.dot#qiskit.ignis.verification.CNOTDihedral.dot "qiskit.ignis.verification.CNOTDihedral.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.ignis.verification.CNOTDihedral.expand#qiskit.ignis.verification.CNOTDihedral.expand "qiskit.ignis.verification.CNOTDihedral.expand") | Return the tensor product operator: other tensor self. | -| [`flip`](qiskit.ignis.verification.CNOTDihedral.flip#qiskit.ignis.verification.CNOTDihedral.flip "qiskit.ignis.verification.CNOTDihedral.flip") | Apply X to this element. | -| [`from_circuit`](qiskit.ignis.verification.CNOTDihedral.from_circuit#qiskit.ignis.verification.CNOTDihedral.from_circuit "qiskit.ignis.verification.CNOTDihedral.from_circuit") | Initialize from a QuantumCircuit or Instruction. | -| [`input_dims`](qiskit.ignis.verification.CNOTDihedral.input_dims#qiskit.ignis.verification.CNOTDihedral.input_dims "qiskit.ignis.verification.CNOTDihedral.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_cnotdihedral`](qiskit.ignis.verification.CNOTDihedral.is_cnotdihedral#qiskit.ignis.verification.CNOTDihedral.is_cnotdihedral "qiskit.ignis.verification.CNOTDihedral.is_cnotdihedral") | Return True if input is a CNOTDihedral element. | -| [`output_dims`](qiskit.ignis.verification.CNOTDihedral.output_dims#qiskit.ignis.verification.CNOTDihedral.output_dims "qiskit.ignis.verification.CNOTDihedral.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`phase`](qiskit.ignis.verification.CNOTDihedral.phase#qiskit.ignis.verification.CNOTDihedral.phase "qiskit.ignis.verification.CNOTDihedral.phase") | Apply an k-th power of T to this element. | -| [`power`](qiskit.ignis.verification.CNOTDihedral.power#qiskit.ignis.verification.CNOTDihedral.power "qiskit.ignis.verification.CNOTDihedral.power") | Return the compose of a operator with itself n times. | -| [`reshape`](qiskit.ignis.verification.CNOTDihedral.reshape#qiskit.ignis.verification.CNOTDihedral.reshape "qiskit.ignis.verification.CNOTDihedral.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.ignis.verification.CNOTDihedral.tensor#qiskit.ignis.verification.CNOTDihedral.tensor "qiskit.ignis.verification.CNOTDihedral.tensor") | Return the tensor product operator: self tensor other. | -| [`to_circuit`](qiskit.ignis.verification.CNOTDihedral.to_circuit#qiskit.ignis.verification.CNOTDihedral.to_circuit "qiskit.ignis.verification.CNOTDihedral.to_circuit") | Return a QuantumCircuit implementing the CNOT-Dihedral element. | -| [`to_instruction`](qiskit.ignis.verification.CNOTDihedral.to_instruction#qiskit.ignis.verification.CNOTDihedral.to_instruction "qiskit.ignis.verification.CNOTDihedral.to_instruction") | Return a Gate instruction implementing the CNOTDihedral object. | -| [`to_matrix`](qiskit.ignis.verification.CNOTDihedral.to_matrix#qiskit.ignis.verification.CNOTDihedral.to_matrix "qiskit.ignis.verification.CNOTDihedral.to_matrix") | Convert operator to Numpy matrix. | -| [`to_operator`](qiskit.ignis.verification.CNOTDihedral.to_operator#qiskit.ignis.verification.CNOTDihedral.to_operator "qiskit.ignis.verification.CNOTDihedral.to_operator") | Convert to an Operator object. | -| [`transpose`](qiskit.ignis.verification.CNOTDihedral.transpose#qiskit.ignis.verification.CNOTDihedral.transpose "qiskit.ignis.verification.CNOTDihedral.transpose") | Return the transpose of the CNOT-Dihedral element. | +### adjoint -## Attributes + + +`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 + +### cnot + + + +`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}. + +### compose + + + +`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. + +**Parameters** + +* **other** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")) – an operator object. +* **qargs** (*None*) – using specific qargs is not implemented for this operator. +* **front** (*bool*) – if True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The operator self @ other. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + +**Raises** + +* **QiskitError** – if operators have incompatible dimensions for composition. +* **NotImplementedError** – if qargs is not None. + +#### Additional Information: + +Composition (`@`) is defined as left matrix multiplication for matrix operators. That is that `A @ B` is equal to `B * A`. Setting `front=True` returns right matrix multiplication `A * B` and is equivalent to the [`dot()`](qiskit.ignis.verification.CNOTDihedral#dot "qiskit.ignis.verification.CNOTDihedral.dot") method. + +### conjugate + + + +`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. + +### copy + + + +`CNOTDihedral.copy()` + +Make a deep copy of current operator. + +### dot + + + +`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. + +**Parameters** + +* **other** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")) – an operator object. +* **qargs** (*None*) – using specific qargs is not implemented for this operator. + +**Returns** + +The operator self \* other. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + +**Raises** + +* **QiskitError** – if operators have incompatible dimensions for composition. +* **NotImplementedError** – if qargs is not None. + +### expand + + + +`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. + +**Parameters** + +**other** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")) – an operator subclass object. + +**Returns** + +the tensor product operator: other tensor other. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + +### flip + + + +`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. + +### from\_circuit + + + +`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. + +**Parameters** + +**circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – instruction to initialize. + +**Returns** + +the CNOTDihedral object for the circuit. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + +**Raises** + +**QiskitError** – if the input instruction is not CNOTDihedral or contains classical register instruction. + +### input\_dims + + + +`CNOTDihedral.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_cnotdihedral + + + +`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. + +### output\_dims + +`CNOTDihedral.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### phase + + + +`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. + +### power + + + +`CNOTDihedral.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### reshape + + + +`CNOTDihedral.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")) – an operator subclass object. + +**Returns** + +the tensor product operator: self tensor other. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + +### to\_circuit + + + +`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. + +**Returns** + +a circuit implementation of the CNOTDihedral object. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +#### Remark: + +Decompose 1 and 2-qubit CNOTDihedral elements. + +#### References + +1. Shelly Garion and Andrew W. Cross, *On the structure of the CNOT-Dihedral group*, [arXiv:2006.12042 \[quant-ph\]](https://arxiv.org/abs/2006.12042) +2. Andrew W. Cross, Easwar Magesan, Lev S. Bishop, John A. Smolin and Jay M. Gambetta, *Scalable randomised benchmarking of non-Clifford gates*, npj Quantum Inf 2, 16012 (2016). + +### to\_instruction + + + +`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. + +### to\_matrix + + + +`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. + +### to\_operator + + + +`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. + +### transpose + + + +`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. + +## Attributes + + ### dim Return tuple (input\_shape, output\_shape). - + ### key Return a string representation of a CNOT-dihedral object. - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### settings Return operator settings. + 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 cea9b08f005..754b7eacb30 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.CNOTDihedralRBFitter.md @@ -1,8 +1,16 @@ -# CNOTDihedralRBFitter +--- +title: CNOTDihedralRBFitter +description: API reference for qiskit.ignis.verification.CNOTDihedralRBFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.CNOTDihedralRBFitter +--- +# CNOTDihedralRBFitter + -`CNOTDihedralRBFitter(cnotdihedral_Z_result, cnotdihedral_X_result, elmnts_lengths, rb_pattern=None)` +`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` @@ -19,73 +27,157 @@ Derived from RBFitterBase class. Contains two RBFitter objects. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.verification.CNOTDihedralRBFitter.add_data#qiskit.ignis.verification.CNOTDihedralRBFitter.add_data "qiskit.ignis.verification.CNOTDihedralRBFitter.add_data") | Add a new result. | -| [`calc_data`](qiskit.ignis.verification.CNOTDihedralRBFitter.calc_data#qiskit.ignis.verification.CNOTDihedralRBFitter.calc_data "qiskit.ignis.verification.CNOTDihedralRBFitter.calc_data") | Retrieve probabilities of success from execution results. | -| [`calc_statistics`](qiskit.ignis.verification.CNOTDihedralRBFitter.calc_statistics#qiskit.ignis.verification.CNOTDihedralRBFitter.calc_statistics "qiskit.ignis.verification.CNOTDihedralRBFitter.calc_statistics") | Extract averages and std dev. | -| [`fit_data`](qiskit.ignis.verification.CNOTDihedralRBFitter.fit_data#qiskit.ignis.verification.CNOTDihedralRBFitter.fit_data "qiskit.ignis.verification.CNOTDihedralRBFitter.fit_data") | Fit the non-Clifford cnot-dihedral RB results. | -| [`fit_data_pattern`](qiskit.ignis.verification.CNOTDihedralRBFitter.fit_data_pattern#qiskit.ignis.verification.CNOTDihedralRBFitter.fit_data_pattern "qiskit.ignis.verification.CNOTDihedralRBFitter.fit_data_pattern") | Fit the RB results of a particular pattern to an exponential curve. | -| [`plot_rb_data`](qiskit.ignis.verification.CNOTDihedralRBFitter.plot_rb_data#qiskit.ignis.verification.CNOTDihedralRBFitter.plot_rb_data "qiskit.ignis.verification.CNOTDihedralRBFitter.plot_rb_data") | Plot non-Clifford cnot-dihedral randomized benchmarking data of a single pattern. | +### add\_data -## Attributes + + +`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. + +**Parameters** + +* **new\_cnotdihedral\_Z\_result** (*list*) – list of rb results of the cnot-dihedral Z circuits. +* **new\_cnotdihedral\_X\_result** (*list*) – list of rb results of the cnot-dihedral X circuits. +* **rerun\_fit** (*bool*) – re-calculate the means and fit the result. + +#### Additional information: + +Assumes that the executed ‘result’ is the output of circuits generated by randomized\_benchmarking\_seq. + +### calc\_data + + + +`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 . + +### calc\_statistics + + + +`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 . + +### fit\_data + + + +`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. + +Fit each of the patterns. According to the paper: + +[Scalable randomized benchmarking of non-Clifford gates](https://www.nature.com/articles/npjqi201612) + +**Returns** + +A list of dictionaries where each dictionary corresponds to a pattern and has fields: + +> * `alpha` - alpha parameter of the non-Clifford cnot-dihedral RB. +> * `'alpha_err` - the error of the alpha parameter of the non-Clifford cnot-dihedral RB. +> * `epg_est` - the estimated error per a CNOT-dihedral element. +> * `epg_est_error` - the estimated error derived from the params\_err. + +**Return type** +list +### fit\_data\_pattern + + + +`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. + +**Parameters** + +* **patt\_ind** (*int*) – index of the data pattern to fit. +* **fit\_guess** (*list*) – guess values for the fit. +* **fit\_index** (*int*) – 0 fit the standard data, 1 fit the interleaved data. + +### plot\_rb\_data + + + +`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. + +**Parameters** + +* **pattern\_index** (*int*) – which RB pattern to plot. +* **ax** (*Axes*) – plot axis (if passed in). +* **add\_label** (*bool*) – Add an EPG label. +* **show\_plt** (*bool*) – display the plot. + +**Raises** + +**ImportError** – if matplotlib is not installed. + +## Attributes + + ### cliff\_lengths Return group elements lengths. - + ### fit Return fit as a 2 element list. - + ### fit\_cnotdihedral Return cnotdihedral fit parameters. - + ### raw\_data Return raw\_data as 2 element list. - + ### rb\_fit\_fun Return the fit function rb\_fit\_fun. - + ### rbfit\_X Return the cnotdihedral X fitter. - + ### rbfit\_Z Return the cnotdihedral Z fitter. - + ### results Return all the results as a 2 element list. - + ### seeds Return the number of loaded seeds as a 2 element list. - + ### ydata Return ydata (means and std devs) as a 2 element list. + diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md index f41251e3e25..b18f6f79193 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.GatesetTomographyFitter.md @@ -1,8 +1,16 @@ -# GatesetTomographyFitter +--- +title: GatesetTomographyFitter +description: API reference for qiskit.ignis.verification.GatesetTomographyFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.GatesetTomographyFitter +--- +# GatesetTomographyFitter + -`GatesetTomographyFitter(result, circuits, gateset_basis='default')` +`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` @@ -43,7 +51,47 @@ result_gate = result_gates[gate.name] ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`fit`](qiskit.ignis.verification.GatesetTomographyFitter.fit#qiskit.ignis.verification.GatesetTomographyFitter.fit "qiskit.ignis.verification.GatesetTomographyFitter.fit") | Reconstruct a gate set from measurement data using optimization. | -| [`linear_inversion`](qiskit.ignis.verification.GatesetTomographyFitter.linear_inversion#qiskit.ignis.verification.GatesetTomographyFitter.linear_inversion "qiskit.ignis.verification.GatesetTomographyFitter.linear_inversion") | Reconstruct a gate set from measurement data using linear inversion. | +### fit + + + +`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. + +**Returns** + +its approximation found using the optimization process. + +**Return type** + +For each gate in the gateset + +#### Additional Information: + +The gateset optimization process con/.sists of three phases: 1) Use linear inversion to obtain an initial approximation. 2) Use gauge optimization to ensure the linear inversion results are close enough to the expected optimization outcome to serve as a suitable starting point 3) Use MLE optimization to obtain the final outcome + +### linear\_inversion + + + +`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. + +**Returns** + +its approximation found using the linear inversion process. + +**Return type** + +For each gate in the gateset + +#### Additional Information: + +Given a gate set (G1,…,Gm) and SPAM circuits (F1,…,Fn) constructed from those gates the data should contain the probabilities of the following types: p\_ijk = E\*F\_i\*G\_k\*F\_j\*rho p\_ij = E\*F\_i\*F\_j\*rho + +We have p\_ijk = self.probs\[(Fj, Gk, Fi)] since in self.probs (Fj, Gk, Fi) indicates first applying Fj, then Gk, then Fi. + +One constructs the Gram matrix g = (p\_ij)\_ij which can be described as a product g=AB where A = sum (i> \\ -`GraphDecoder(code, S=None)` +`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` @@ -19,10 +27,109 @@ The decoder for the supplied `code` is initialized by running `_make_syndrome_gr ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`get_error_probs`](qiskit.ignis.verification.GraphDecoder.get_error_probs#qiskit.ignis.verification.GraphDecoder.get_error_probs "qiskit.ignis.verification.GraphDecoder.get_error_probs") | Generate probabilities of single error events from result counts. | -| [`get_logical_prob`](qiskit.ignis.verification.GraphDecoder.get_logical_prob#qiskit.ignis.verification.GraphDecoder.get_logical_prob "qiskit.ignis.verification.GraphDecoder.get_logical_prob") | **param results**A results dictionary, as produced by the | -| [`make_error_graph`](qiskit.ignis.verification.GraphDecoder.make_error_graph#qiskit.ignis.verification.GraphDecoder.make_error_graph "qiskit.ignis.verification.GraphDecoder.make_error_graph") | **param string**A string describing the output from the code. | -| [`matching`](qiskit.ignis.verification.GraphDecoder.matching#qiskit.ignis.verification.GraphDecoder.matching "qiskit.ignis.verification.GraphDecoder.matching") | **param string**A string describing the output from the code. | -| [`weight_syndrome_graph`](qiskit.ignis.verification.GraphDecoder.weight_syndrome_graph#qiskit.ignis.verification.GraphDecoder.weight_syndrome_graph "qiskit.ignis.verification.GraphDecoder.weight_syndrome_graph") | Generate weighted syndrome graph from result counts. | +### get\_error\_probs + + + +`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. + +**Parameters** + +* **results** (*dict*) – A results dictionary, as produced by the +* **method of the code.** (*process\_results*) – + +**Returns** + +Keys are the edges for specific error events, and values are the calculated probabilities + +**Return type** + +dict + +#### Additional information: + +Uses results to estimate the probability of the errors that create the pairs of nodes specified by the edge. Calculation done using the method of Spitz, et al. [https://doi.org/10.1002/qute.201800012](https://doi.org/10.1002/qute.201800012) + +### get\_logical\_prob + + + +`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** + +* **results** (*dict*) – A results dictionary, as produced by the +* **method of the code.** (*process\_results*) – +* **algorithm** (*str*) – Choice of which decoder to use. + +**Returns** + +Dictionary of logical error probabilities for each of the encoded logical states whose results were given in the input. + +**Return type** + +dict + +### make\_error\_graph + + + +`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** + +* **string** (*str*) – A string describing the output from the code. +* **subgraphs** (*list*) – Used when multiple, semi-independent graphs need +* **to created.** (*need*) – + +**Returns** + +The subgraph(s) of S which corresponds to the non-trivial syndrome elements in the given string. + +**Return type** + +E + +### matching + + + +`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** + +**string** (*str*) – A string describing the output from the code. + +**Returns** + +**A string with corrected logical values,** + +computed using minimum weight perfect matching. + +**Return type** + +str + +#### Additional information: + +This function can be run directly, or used indirectly to calculate a logical error probability with get\_logical\_prob + +### weight\_syndrome\_graph + + + +`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. + +**Parameters** + +* **results** (*dict*) – A results dictionary, as produced by the +* **method of the code.** (*process\_results*) – + +#### Additional information: + +Uses results to estimate the probability of the errors that create the pairs of nodes in S. The edge weights are then replaced with the corresponding -log(p/(1-p). + 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 00cc3dbbb16..e82966c03c0 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.InterleavedRBFitter.md @@ -1,8 +1,16 @@ -# InterleavedRBFitter +--- +title: InterleavedRBFitter +description: API reference for qiskit.ignis.verification.InterleavedRBFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.InterleavedRBFitter +--- +# InterleavedRBFitter + -`InterleavedRBFitter(original_result, interleaved_result, cliff_lengths, rb_pattern=None)` +`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` @@ -19,73 +27,154 @@ Contains two RBFitter objects: the original RBFitter and the interleaved RBFitte ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.verification.InterleavedRBFitter.add_data#qiskit.ignis.verification.InterleavedRBFitter.add_data "qiskit.ignis.verification.InterleavedRBFitter.add_data") | Add a new result. | -| [`calc_data`](qiskit.ignis.verification.InterleavedRBFitter.calc_data#qiskit.ignis.verification.InterleavedRBFitter.calc_data "qiskit.ignis.verification.InterleavedRBFitter.calc_data") | Retrieve probabilities of success from execution results. | -| [`calc_statistics`](qiskit.ignis.verification.InterleavedRBFitter.calc_statistics#qiskit.ignis.verification.InterleavedRBFitter.calc_statistics "qiskit.ignis.verification.InterleavedRBFitter.calc_statistics") | Extract averages and std dev. | -| [`fit_data`](qiskit.ignis.verification.InterleavedRBFitter.fit_data#qiskit.ignis.verification.InterleavedRBFitter.fit_data "qiskit.ignis.verification.InterleavedRBFitter.fit_data") | Fit the interleaved RB results. | -| [`fit_data_pattern`](qiskit.ignis.verification.InterleavedRBFitter.fit_data_pattern#qiskit.ignis.verification.InterleavedRBFitter.fit_data_pattern "qiskit.ignis.verification.InterleavedRBFitter.fit_data_pattern") | Fit the RB results of a particular pattern to an exponential curve. | -| [`plot_rb_data`](qiskit.ignis.verification.InterleavedRBFitter.plot_rb_data#qiskit.ignis.verification.InterleavedRBFitter.plot_rb_data "qiskit.ignis.verification.InterleavedRBFitter.plot_rb_data") | Plot interleaved randomized benchmarking data of a single pattern. | +### add\_data -## Attributes + + +`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. + +**Parameters** + +* **new\_original\_result** (*list*) – list of RB results of the original circuits. +* **new\_interleaved\_result** (*list*) – list of RB results of the interleaved circuits. +* **rerun\_fit** (*bool*) – re-calculate the means and fit the result. + +#### Additional information: + +Assumes that the executed ‘result’ is the output of circuits generated by randomized\_benchmarking\_seq. + +### calc\_data + + + +`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. + +Outputs results into an internal variables: \_raw\_original\_data and \_raw\_interleaved\_data + +### calc\_statistics + + + +`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. + +Output \[ydata\_original, ydata\_interleaved] + +### fit\_data + + + +`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. + +According to the paper: “Efficient measurement of quantum gate error by interleaved randomized benchmarking” (arXiv:1203.4550) - Equations (4) and (5). + +Puts the results into a list of fit dictionaries: where each dictionary corresponds to a pattern and has fields: + +> * ‘epc\_est’ - the estimated error per the interleaved Clifford. +> * ‘epc\_est\_error’ - the estimated error derived from the params\_err. +> * ‘systematic\_err’ - systematic error bound of epc\_est. +> * ‘systematic\_err\_L’ = epc\_est - systematic\_err (left error bound). +> * ‘systematic\_err\_R’ = epc\_est + systematic\_err (right error bound). +### fit\_data\_pattern + + +`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. + +**Parameters** + +* **patt\_ind** (*int*) – index of the data to fit. +* **fit\_guess** (*list*) – guess values for the fit. +* **fit\_index** (*int*) – 0 fit the standard data, 1 fit the interleaved data. + +### plot\_rb\_data + + + +`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. + +**Parameters** + +* **pattern\_index** (*int*) – which RB pattern to plot. +* **ax** (*Axes*) – plot axis (if passed in). +* **add\_label** (*bool*) – Add an EPC label. +* **show\_plt** (*bool*) – display the plot. + +**Raises** + +**ImportError** – if matplotlib is not installed. + +## Attributes + + ### cliff\_lengths Return clifford lengths. - + ### fit Return fit as a 2 element list. - + ### fit\_int Return interleaved fit parameters. - + ### raw\_data Return raw\_data as a 2 element list. - + ### rb\_fit\_fun Return the fit function rb\_fit\_fun. - + ### rbfit\_int Return the interleaved RB fitter. - + ### rbfit\_std Return the original RB fitter. - + ### results Return all the results as a 2 element list. - + ### seeds Return the number of loaded seeds as a 2 element list. - + ### ydata Return ydata (means and std devs) as a 2 element list. + diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md index 5cbf24e7147..3d42ae904cb 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.Plotter.md @@ -1,8 +1,16 @@ -# Plotter +--- +title: Plotter +description: API reference for qiskit.ignis.verification.Plotter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.Plotter +--- +# Plotter + -`Plotter(label)` +`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` @@ -10,8 +18,52 @@ Various plots of the ground state in MQC and PO experiments ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | -| [`get_fourier_info`](qiskit.ignis.verification.Plotter.get_fourier_info#qiskit.ignis.verification.Plotter.get_fourier_info "qiskit.ignis.verification.Plotter.get_fourier_info") | Get fourier trans. | -| [`sin_plotter`](qiskit.ignis.verification.Plotter.sin_plotter#qiskit.ignis.verification.Plotter.sin_plotter "qiskit.ignis.verification.Plotter.sin_plotter") | Make sin plot of counts in both mqc and po exps. | -| [`title_maker`](qiskit.ignis.verification.Plotter.title_maker#qiskit.ignis.verification.Plotter.title_maker "qiskit.ignis.verification.Plotter.title_maker") | Make title depending on type of exp. | +### get\_fourier\_info + + + +`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 + +**Return type** + +`Dict` + +**Returns** + +The fourier transform data + +**Raises** + +* **ImportError** – If matplotlib is not present +* **Exception** – If y\_m or p\_dict are not provided + +### sin\_plotter + + + +`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 + +**Raises** + +**ImportError** – If matplotlib is not present + +### title\_maker + + + +`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. + +**Return type** + +`Tuple`\[`str`, `str`] + +**Returns** + +The title strings + 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 451c67c54e2..b74bafa3b11 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.ProcessTomographyFitter.md @@ -1,8 +1,16 @@ -# ProcessTomographyFitter +--- +title: ProcessTomographyFitter +description: API reference for qiskit.ignis.verification.ProcessTomographyFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.ProcessTomographyFitter +--- +# ProcessTomographyFitter + -`ProcessTomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` +`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` @@ -19,29 +27,146 @@ Initialize tomography fitter with experimental data. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.verification.ProcessTomographyFitter.add_data#qiskit.ignis.verification.ProcessTomographyFitter.add_data "qiskit.ignis.verification.ProcessTomographyFitter.add_data") | Add tomography data from a Qiskit Result object. | -| [`fit`](qiskit.ignis.verification.ProcessTomographyFitter.fit#qiskit.ignis.verification.ProcessTomographyFitter.fit "qiskit.ignis.verification.ProcessTomographyFitter.fit") | Reconstruct a quantum channel using CVXPY convex optimization. | -| [`set_measure_basis`](qiskit.ignis.verification.ProcessTomographyFitter.set_measure_basis#qiskit.ignis.verification.ProcessTomographyFitter.set_measure_basis "qiskit.ignis.verification.ProcessTomographyFitter.set_measure_basis") | Set the measurement basis | -| [`set_preparation_basis`](qiskit.ignis.verification.ProcessTomographyFitter.set_preparation_basis#qiskit.ignis.verification.ProcessTomographyFitter.set_preparation_basis "qiskit.ignis.verification.ProcessTomographyFitter.set_preparation_basis") | Set the preparation basis function | +### add\_data -## Attributes + + +`ProcessTomographyFitter.add_data(results, circuits)` + +Add tomography data from a Qiskit Result object. + +**Parameters** + +* **results** (`List`\[`Result`]) – The results obtained from executing tomography circuits. +* **circuits** (`List`\[`Union`\[`QuantumCircuit`, `str`]]) – circuits or circuit names to extract count information from the result object. + +**Raises** + +**QiskitError** – In case some of the tomography data is not found in the results + +### fit + + + +`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. + +**Choi matrix** + +The Choi matrix object is a QuantumChannel representation which may be converted to other representations using the classes SuperOp, Kraus, Stinespring, PTM, Chi from the module qiskit.quantum\_info.operators. The raw matrix data for the representation may be obtained by channel.data. + +**Fitter method** + +The `cvx` fitter method used CVXPY convex optimization package. The `lstsq` method uses least-squares fitting (linear inversion). The `auto` method will use `cvx` if the CVXPY package is found on the system, otherwise it will default to `lstsq`. + +**Objective function** + +This fitter solves the constrained least-squares minimization: $minimize: ||a \cdot x - b ||_2$ + +subject to: + +> * $x >> 0$ (PSD) +> * $\text{trace}(x) = \text{dim}$ (trace) +> * $\text{partial_trace}(x) = \text{identity}$ (trace\_preserving) + +where: + +> * a is the matrix of measurement operators $a[i] = \text{vec}(M_i).H$ +> * b is the vector of expectation value data for each projector $b[i] \sim \text{Tr}[M_i.H \cdot x] = (a \cdot x)[i]$ +> * x is the vectorized Choi-matrix to be fitted + +**PSD constraint** + +The PSD keyword constrains the fitted matrix to be postive-semidefinite. For the `lstsq` fitter method the fitted matrix is rescaled using the method proposed in Reference \[1]. For the `cvx` fitter method the convex constraint makes the optimization problem a SDP. If PSD=False the fitted matrix will still be constrained to be Hermitian, but not PSD. In this case the optimization problem becomes a SOCP. + +**Trace constraint** + +The trace keyword constrains the trace of the fitted matrix. If trace=None there will be no trace constraint on the fitted matrix. This constraint should not be used for process tomography and the trace preserving constraint should be used instead. + +**Trace preserving (TP) constraint** + +The trace\_preserving keyword constrains the fitted matrix to be TP. This should only be used for process tomography, not state tomography. Note that the TP constraint implicitly enforces the trace of the fitted matrix to be equal to the square-root of the matrix dimension. If a trace constraint is also specified that differs from this value the fit will likely fail. Note that this can only be used for the CVX method. + +**CVXPY Solvers:** + +Various solvers can be called in CVXPY using the solver keyword argument. See the [CVXPY documentation](https://www.cvxpy.org/tutorial/advanced/index.html#solve-method-options) for more information on solvers. + +References: +#### \[1] J Smolin, JM Gambetta, G Smith, Phys. Rev. Lett. 108, 070502 +(2012). Open access: arXiv:1106.5458 \[quant-ph]. + +**Parameters** + +* **method** (`str`) – (default: ‘auto’) the fitter method ‘auto’, ‘cvx’ or ‘lstsq’. +* **standard\_weights** (`bool`) – (default: True) apply weights to tomography data based on count probability +* **beta** (`float`) – (default: 0.5) hedging parameter for converting counts to probabilities +* **\*\*kwargs** – kwargs for fitter method. + +**Raises** + +* **ValueError** – In case the input data is no a valid process matrix +* **QiskitError** – If the fit method is unrecognized + +**Returns** + +The fitted Choi-matrix J for the channel that maximizes $||\text{basis_matrix} \cdot \text{vec}(J) - \text{data}||_2$. The Numpy matrix can be obtained from Choi.data. + +**Return type** + +[Choi](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") + +### set\_measure\_basis + + + +`ProcessTomographyFitter.set_measure_basis(basis)` + +Set the measurement basis + +**Parameters** + +**basis** (`Union`\[`TomographyBasis`, `str`]) – measurement basis + +**Raises** + +**QiskitError** – In case of invalid measurement or preparation basis. + +### set\_preparation\_basis + + + +`ProcessTomographyFitter.set_preparation_basis(basis)` + +Set the preparation basis function + +**Parameters** + +**basis** (`Union`\[`TomographyBasis`, `str`]) – preparation basis + +**Raises** + +**QiskitError** – in case the basis has no preperation data + +## Attributes + + ### data Return tomography data - + ### measure\_basis Return the tomography measurement basis. - + ### preparation\_basis Return the tomography preparation basis. + 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 53c7bab65ed..751d05ee71f 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.PurityRBFitter.md @@ -1,8 +1,16 @@ -# PurityRBFitter +--- +title: PurityRBFitter +description: API reference for qiskit.ignis.verification.PurityRBFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.PurityRBFitter +--- +# PurityRBFitter + -`PurityRBFitter(purity_result, npurity, cliff_lengths, rb_pattern=None)` +`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` @@ -19,63 +27,158 @@ Derived from RBFitterBase class. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| [`F234`](qiskit.ignis.verification.PurityRBFitter.F234#qiskit.ignis.verification.PurityRBFitter.F234 "qiskit.ignis.verification.PurityRBFitter.F234") | Function than maps: 2^n x 3^n –> 4^n , namely: (a,b) –> c where a in 2^n, b in 3^n, c in 4^n | -| [`add_data`](qiskit.ignis.verification.PurityRBFitter.add_data#qiskit.ignis.verification.PurityRBFitter.add_data "qiskit.ignis.verification.PurityRBFitter.add_data") | Add a new result. | -| [`add_zdict_ops`](qiskit.ignis.verification.PurityRBFitter.add_zdict_ops#qiskit.ignis.verification.PurityRBFitter.add_zdict_ops "qiskit.ignis.verification.PurityRBFitter.add_zdict_ops") | Creating all Z-correlators in order to compute the expectation values. | -| [`calc_data`](qiskit.ignis.verification.PurityRBFitter.calc_data#qiskit.ignis.verification.PurityRBFitter.calc_data "qiskit.ignis.verification.PurityRBFitter.calc_data") | Retrieve probabilities of success from execution results. | -| [`calc_statistics`](qiskit.ignis.verification.PurityRBFitter.calc_statistics#qiskit.ignis.verification.PurityRBFitter.calc_statistics "qiskit.ignis.verification.PurityRBFitter.calc_statistics") | Extract averages and std dev from the raw data (self.\_raw\_data). | -| [`fit_data`](qiskit.ignis.verification.PurityRBFitter.fit_data#qiskit.ignis.verification.PurityRBFitter.fit_data "qiskit.ignis.verification.PurityRBFitter.fit_data") | Fit the Purity RB results to an exponential curve. | -| [`fit_data_pattern`](qiskit.ignis.verification.PurityRBFitter.fit_data_pattern#qiskit.ignis.verification.PurityRBFitter.fit_data_pattern "qiskit.ignis.verification.PurityRBFitter.fit_data_pattern") | Fit the RB results of a particular pattern to an exponential curve. | -| [`plot_rb_data`](qiskit.ignis.verification.PurityRBFitter.plot_rb_data#qiskit.ignis.verification.PurityRBFitter.plot_rb_data "qiskit.ignis.verification.PurityRBFitter.plot_rb_data") | Plot purity RB data of a single pattern. | +### F234 -## Attributes + + +`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 + +### add\_data + + + +`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. + +**Parameters** + +* **new\_purity\_result** (*list*) – list of RB results of the purity RB circuits. +* **rerun\_fit** (*bool*) – re-calculate the means and fit the result. + +#### Additional information: + +Assumes that the executed ‘result’ is the output of circuits generated by randomized\_benchmarking\_seq where is\_purity = True. + +### add\_zdict\_ops + + + +`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. + +### calc\_data + + + +`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. + +Measure the purity calculation into an internal variable \_raw\_data which is a 3-dimensional list, where item (i,j,k) is the purity of the set of qubits in pattern “i” for seed no. j and vector length self.\_cliff\_lengths\[i]\[k]. + +#### Additional information: + +Assumes that the executed ‘result’ is the output of circuits generated by randomized\_benchmarking\_seq, + +### calc\_statistics + + + +`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). + +Assumes that self.\_calc\_data has been run. Output into internal \_ydata variable. ydata is a list of dictionaries (length number of patterns): + +Dictionary ydata\[i]: +> * ydata\[i]\[‘mean’] is a numpy\_array of length n; entry j of this array contains the mean probability of success over seeds, for vector length self.\_cliff\_lengths\[i]\[j]. +> * ydata\[i]\[‘std’] is a numpy\_array of length n; entry j of this array contains the std of the probability of success over seeds, for vector length self.\_cliff\_lengths\[i]\[j]. +### fit\_data + + + +`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. + +Use the data to construct guess values for the fits. + +Puts the results into a list of fit dictionaries where each dictionary corresponds to a pattern and has fields: + +> * `params` - three parameters of rb\_fit\_fun. The middle one is the exponent. +> * `err` - the error limits of the parameters. +> * `epc` - Error per Clifford. +> * `pepc` - Purity Error per Clifford. + +### fit\_data\_pattern + + + +`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. + +**Parameters** + +* **patt\_ind** (*int*) – index of the subsystem to fit. +* **fit\_guess** (*list*) – guess values for the fit. + +Puts the results into a list of fit dictionaries where each dictionary corresponds to a pattern and has fields: + +> * `params` - three parameters of rb\_fit\_fun. The middle one is the exponent. +> * `err` - the error limits of the parameters. + +### plot\_rb\_data + + + +`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. + +## Attributes + + ### cliff\_lengths Return clifford lengths. - + ### fit Return the purity fit parameters. - + ### raw\_data Return raw data. - + ### rb\_fit\_fun Return the fit function rb\_fit\_fun. - + ### rbfit\_pur Return the purity RB fitter. - + ### results Return all the results. - + ### seeds Return the number of loaded seeds. - + ### ydata Return ydata (means and std devs). + diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md index 00f2926d35e..0eee1191e89 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTP.md @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.QOTP +--- +title: QOTP +description: API reference for qiskit.ignis.verification.QOTP +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.QOTP +--- +# qiskit.ignis.verification.QOTP + -`QOTP(circ, num, two_qubit_gate='cx', coupling_map=None, seed=None)` +`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. @@ -10,7 +18,7 @@ This is essentially the same protocol as used in randomized compiling, but follo **Parameters** -* **circ** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – A generic quantum circuit +* **circ** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – A generic quantum circuit * **num** (*int*) – the number of one-time pads to return * **two\_qubit\_gate** (*string*) – a flag as to which 2 qubit gate to compile with, can be cx or cz * **coupling\_map** (*list*) – a particular device topology as a list of list (e.g. \[\[0,1],\[1,2],\[2,0]]) @@ -25,3 +33,4 @@ qotp\_circs (list): a list of circuits with qotp applied qotp\_postps (list): a **Return type** tuple + 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 71564497bdb..fe011e399c6 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTPCorrectCounts.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.QOTPCorrectCounts.md @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.QOTPCorrectCounts +--- +title: QOTPCorrectCounts +description: API reference for qiskit.ignis.verification.QOTPCorrectCounts +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.QOTPCorrectCounts +--- +# qiskit.ignis.verification.QOTPCorrectCounts + -`QOTPCorrectCounts(qotp_counts, qotp_postp)` +`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 @@ -18,3 +26,4 @@ the corrected counts dict **Return type** dict + 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 ec4bdb0d3e4..1454540bb20 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.QVFitter.md @@ -1,8 +1,16 @@ -# QVFitter +--- +title: QVFitter +description: API reference for qiskit.ignis.verification.QVFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.QVFitter +--- +# QVFitter + -`QVFitter(backend_result=None, statevector_result=None, qubit_lists=None)` +`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` @@ -16,60 +24,255 @@ Class for fitters for quantum volume. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.verification.QVFitter.add_data#qiskit.ignis.verification.QVFitter.add_data "qiskit.ignis.verification.QVFitter.add_data") | Add a new result. | -| [`add_statevectors`](qiskit.ignis.verification.QVFitter.add_statevectors#qiskit.ignis.verification.QVFitter.add_statevectors "qiskit.ignis.verification.QVFitter.add_statevectors") | Add the ideal results and convert to the heavy outputs. | -| [`calc_confidence_level`](qiskit.ignis.verification.QVFitter.calc_confidence_level#qiskit.ignis.verification.QVFitter.calc_confidence_level "qiskit.ignis.verification.QVFitter.calc_confidence_level") | Calculate confidence level using z value. | -| [`calc_data`](qiskit.ignis.verification.QVFitter.calc_data#qiskit.ignis.verification.QVFitter.calc_data "qiskit.ignis.verification.QVFitter.calc_data") | Make a count dictionary for each unique circuit from all the results. | -| [`calc_statistics`](qiskit.ignis.verification.QVFitter.calc_statistics#qiskit.ignis.verification.QVFitter.calc_statistics "qiskit.ignis.verification.QVFitter.calc_statistics") | Convert the heavy outputs in the different trials into mean and error for plotting. | -| [`calc_z_value`](qiskit.ignis.verification.QVFitter.calc_z_value#qiskit.ignis.verification.QVFitter.calc_z_value "qiskit.ignis.verification.QVFitter.calc_z_value") | Calculate z value using mean and sigma. | -| [`plot_hop_accumulative`](qiskit.ignis.verification.QVFitter.plot_hop_accumulative#qiskit.ignis.verification.QVFitter.plot_hop_accumulative "qiskit.ignis.verification.QVFitter.plot_hop_accumulative") | Plot individual and accumulative heavy output probability (HOP) as a function of number of trials. | -| [`plot_qv_data`](qiskit.ignis.verification.QVFitter.plot_qv_data#qiskit.ignis.verification.QVFitter.plot_qv_data "qiskit.ignis.verification.QVFitter.plot_qv_data") | Plot the qv data as a function of depth | -| [`plot_qv_trial`](qiskit.ignis.verification.QVFitter.plot_qv_trial#qiskit.ignis.verification.QVFitter.plot_qv_trial "qiskit.ignis.verification.QVFitter.plot_qv_trial") | Plot individual trial. | -| [`quantum_volume`](qiskit.ignis.verification.QVFitter.quantum_volume#qiskit.ignis.verification.QVFitter.quantum_volume "qiskit.ignis.verification.QVFitter.quantum_volume") | Return the volume for each depth. | -| [`qv_success`](qiskit.ignis.verification.QVFitter.qv_success#qiskit.ignis.verification.QVFitter.qv_success "qiskit.ignis.verification.QVFitter.qv_success") | Return whether each depth was successful (> 2/3 with confidence level > 0.977 corresponding to z\_value = 2) and the confidence level. | +### add\_data -## Attributes + + +`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 + +**Parameters** + +* **new\_backend\_result** (*list*) – list of qv results +* **rerun\_fit** (*bool*) – re calculate the means and fit the result + +**Raises** + +**QiskitError** – If the ideal distribution isn’t loaded yet + +#### Additional information: + +Assumes that ‘result’ was executed is the output of circuits generated by qv\_circuits, + +### add\_statevectors + + + +`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. + +Assume the result is from ‘statevector\_simulator’ + +**Parameters** + +**new\_statevector\_result** (*list*) – ideal results + +**Raises** + +**QiskitError** – If the result has already been added for the circuit + +### calc\_confidence\_level + + + +`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. + +Accumulative probability for standard normal distribution in \[-z, +infinity] is 1/2 (1 + erf(z/sqrt(2))), where z = (X - mu)/sigma = (hmean - 2/3)/sigma + +**Parameters** + +**z\_value** (*float*) – z value in in standard normal distibution. + +**Returns** + +confidence level in decimal (not percentage). + +**Return type** + +float + +### calc\_data + + + +`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. + +Calculate the heavy output probability. + +#### Additional information: + +Assumes that ‘result’ was executed is the output of circuits generated by qv\_circuits, + +### calc\_statistics + + + +`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. + +Here we assume the error is due to a binomial distribution. Error (standard deviation) for binomial distribution is sqrt(np(1-p)), where n is the number of trials (self.\_ntrials) and p is the success probability (self.\_ydata\[0]\[depthidx]/self.\_ntrials). + +### calc\_z\_value + + + +`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. + +**Parameters** + +* **mean** (*float*) – mean +* **sigma** (*float*) – standard deviation + +**Returns** + +z\_value in standard normal distibution. + +**Return type** + +float + +### plot\_hop\_accumulative + +`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. + +**Parameters** + +* **depth** (*int*) – depth of QV circuits +* **ax** (*Axes or None*) – plot axis (if passed in). +* **figsize** (*tuple*) – figure size in inches. + +**Raises** + +**ImportError** – If matplotlib is not installed. + +**Returns** + +A figure of individual and accumulative HOP as a function of number of trials, with 2-sigma confidence interval and 2/3 threshold. + +**Return type** + +matplotlib.Figure + +### plot\_qv\_data + + + +`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 + +**Parameters** + +* **ax** (*Axes or None*) – plot axis (if passed in). +* **show\_plt** (*bool*) – display the plot. +* **figsize** (*tuple*) – Figure size in inches. +* **set\_title** (*bool*) – set figure title. +* **title** (*String or None*) – text for setting figure title + +**Raises** + +**ImportError** – If matplotlib is not installed. + +**Returns** + +A figure of Quantum Volume data (heavy output probability) with two-sigma error bar as a function of circuit depth. + +**Return type** + +matplotlib.Figure + +### plot\_qv\_trial + + + +`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 + +**Returns** + +A figure for histogram of ideal and experiment probabilities. + +**Return type** + +matplotlib.Figure + +### quantum\_volume + + + +`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. + +**Returns** + +List of quantum volumes + +**Return type** + +list + +### qv\_success + + + +`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. + +**Returns** + +List of list of 2 elements for each depth: - success True/False - confidence level + +**Return type** + +list + +## Attributes + + ### depths Return depth list. - + ### heavy\_output\_counts Return the number of heavy output counts as measured. - + ### heavy\_output\_prob\_ideal Return the heavy output probability ideally. - + ### heavy\_outputs Return the ideal heavy outputs dictionary. - + ### qubit\_lists Return depth list. - + ### results Return all the results. - + ### ydata Return the average and std of the output probability. + 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 34aebd2314e..397eae2c7c4 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.RBFitter.md @@ -1,8 +1,16 @@ -# RBFitter +--- +title: RBFitter +description: API reference for qiskit.ignis.verification.RBFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.RBFitter +--- +# RBFitter + -`RBFitter(backend_result, cliff_lengths, rb_pattern=None)` +`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` @@ -10,61 +18,151 @@ Class for fitters for randomized benchmarking. **Parameters** -* **backend\_result** ([*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")) – list of results (qiskit.Result). +* **backend\_result** ([*Result*](qiskit.result.Result "qiskit.result.Result")) – list of results (qiskit.Result). * **cliff\_lengths** (*list*) – the Clifford lengths, 2D list i x j where i is the number of patterns, j is the number of cliffords lengths. * **rb\_pattern** (*list*) – the pattern for the RB sequences. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`add_data`](qiskit.ignis.verification.RBFitter.add_data#qiskit.ignis.verification.RBFitter.add_data "qiskit.ignis.verification.RBFitter.add_data") | Add a new result. | -| [`calc_data`](qiskit.ignis.verification.RBFitter.calc_data#qiskit.ignis.verification.RBFitter.calc_data "qiskit.ignis.verification.RBFitter.calc_data") | Retrieve probabilities of success from execution results. | -| [`calc_statistics`](qiskit.ignis.verification.RBFitter.calc_statistics#qiskit.ignis.verification.RBFitter.calc_statistics "qiskit.ignis.verification.RBFitter.calc_statistics") | Extract averages and std dev from the raw data (self.\_raw\_data). | -| [`fit_data`](qiskit.ignis.verification.RBFitter.fit_data#qiskit.ignis.verification.RBFitter.fit_data "qiskit.ignis.verification.RBFitter.fit_data") | Fit the RB results to an exponential curve. | -| [`fit_data_pattern`](qiskit.ignis.verification.RBFitter.fit_data_pattern#qiskit.ignis.verification.RBFitter.fit_data_pattern "qiskit.ignis.verification.RBFitter.fit_data_pattern") | Fit the RB results of a particular pattern to an exponential curve. | -| [`plot_rb_data`](qiskit.ignis.verification.RBFitter.plot_rb_data#qiskit.ignis.verification.RBFitter.plot_rb_data "qiskit.ignis.verification.RBFitter.plot_rb_data") | Plot randomized benchmarking data of a single pattern. | +### add\_data -## Attributes + + +`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. + +**Parameters** + +* **new\_backend\_result** (*list*) – list of RB results. +* **rerun\_fit** (*bool*) – re calculate the means and fit the result. + +#### Additional information: + +Assumes that the executed ‘result’ is the output of circuits generated by randomized\_benchmarking\_seq. + +### calc\_data + + + +`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. + +Outputs results into an internal variable \_raw\_data which is a 3-dimensional list, where item (i,j,k) is the probability to measure the ground state for the set of qubits in pattern “i” for seed no. j and vector length self.\_cliff\_lengths\[i]\[k]. + +#### Additional information: + +Assumes that the executed ‘result’ is the output of circuits generated by randomized\_benchmarking\_seq. + +### calc\_statistics + + + +`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). + +Assumes that self.\_calc\_data has been run. Output into internal \_ydata variable. ydata is a list of dictionaries (length number of patterns). Dictionary ydata\[i]: + +> * ydata\[i]\[‘mean’] is a numpy\_array of length n; entry j of this array contains the mean probability of success over seeds, for vector length self.\_cliff\_lengths\[i]\[j]. +> * ydata\[i]\[‘std’] is a numpy\_array of length n; entry j of this array contains the std of the probability of success over seeds, for vector length self.\_cliff\_lengths\[i]\[j]. + +### fit\_data + + + +`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. + +Fit each of the patterns. Use the data to construct guess values for the fits. +Puts the results into a list of fit dictionaries where each dictionary corresponds to a pattern and has fields: +> * `params` - three parameters of rb\_fit\_fun. The middle one is the exponent. +> * `err` - the error limits of the parameters. +> * `epc` - error per Clifford. + +### fit\_data\_pattern + + + +`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. + +**Parameters** + +* **patt\_ind** (*int*) – index of the data pattern to fit. +* **fit\_guess** (*list*) – guess values for the fit. + +Puts the results into a list of fit dictionaries where each dictionary corresponds to a pattern and has fields: + +> * `params` - three parameters of rb\_fit\_fun. The middle one is the exponent. +> * `err` - the error limits of the parameters. +> * `epc` - error per Clifford. + +### plot\_rb\_data + + + +`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. + +**Parameters** + +* **pattern\_index** (*int*) – which RB pattern to plot. +* **ax** (*Axes*) – plot axis (if passed in). +* **add\_label** (*bool*) – Add an EPC label. +* **show\_plt** (*bool*) – display the plot. + +**Raises** + +**ImportError** – if matplotlib is not installed. + +## Attributes + + ### cliff\_lengths Return clifford lengths. - + ### fit Return fit. - + ### raw\_data Return raw data. - + ### rb\_fit\_fun Return the fit function rb\_fit\_fun. - + ### results Return all the results. - + ### seeds Return the number of loaded seeds. - + ### ydata Return ydata (means and std devs). + diff --git a/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md b/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md index 68208f39f65..a7421af715c 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.RepetitionCode.md @@ -1,8 +1,16 @@ -# RepetitionCode +--- +title: RepetitionCode +description: API reference for qiskit.ignis.verification.RepetitionCode +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.RepetitionCode +--- +# RepetitionCode + -`RepetitionCode(d, T=0)` +`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` @@ -21,10 +29,75 @@ No measurements are added to the circuit if T=0. Otherwise T rounds are added, f ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| [`get_circuit_list`](qiskit.ignis.verification.RepetitionCode.get_circuit_list#qiskit.ignis.verification.RepetitionCode.get_circuit_list "qiskit.ignis.verification.RepetitionCode.get_circuit_list") | **returns**self.circuit as a list, with | -| [`process_results`](qiskit.ignis.verification.RepetitionCode.process_results#qiskit.ignis.verification.RepetitionCode.process_results "qiskit.ignis.verification.RepetitionCode.process_results") | **param raw\_results**A dictionary whose keys are logical values, | -| [`readout`](qiskit.ignis.verification.RepetitionCode.readout#qiskit.ignis.verification.RepetitionCode.readout "qiskit.ignis.verification.RepetitionCode.readout") | Readout of all code qubits, which corresponds to a logical measurement as well as allowing for a measurement of the syndrome to be inferred. | -| [`syndrome_measurement`](qiskit.ignis.verification.RepetitionCode.syndrome_measurement#qiskit.ignis.verification.RepetitionCode.syndrome_measurement "qiskit.ignis.verification.RepetitionCode.syndrome_measurement") | Application of a syndrome measurement round. | -| [`x`](qiskit.ignis.verification.RepetitionCode.x#qiskit.ignis.verification.RepetitionCode.x "qiskit.ignis.verification.RepetitionCode.x") | Applies a logical x to the circuits for the given logical values. | +### get\_circuit\_list + + + +`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** + +self.circuit as a list, with circuit\_list\[0] = circuit\[‘0’] circuit\_list\[1] = circuit\[‘1’] + +**Return type** + +circuit\_list + +### process\_results + + + +`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** + +**raw\_results** (*dict*) – A dictionary whose keys are logical values, and whose values are standard counts dictionaries, (as obtained from the get\_counts method of a `qiskit.Result` object). + +**Returns** + +**Dictionary with the same structure as the input, but with** + +the bit strings used as keys in the counts dictionaries converted to the form required by the decoder. + +**Return type** + +results + +#### Additional information: + +The circuits must be executed outside of this class, so that their is full freedom to compile, choose a backend, use a noise model, etc. The results from these executions should then be used to create the input for this method. + +### readout + + + +`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. + +### syndrome\_measurement + + + +`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. + +**Parameters** + +* **reset** (*bool*) – If set to true add a boolean at the end of each round +* **barrier** (*bool*) – Boolean denoting whether to include a barrier at the end. + +### x + + + +`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. + +**Parameters** + +* **logs** (*list or tuple*) – List or tuple of logical values expressed as strings. +* **barrier** (*bool*) – Boolean denoting whether to include a barrier at the end. + 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 c8959b2cdec..69e323d90d6 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.StateTomographyFitter.md @@ -1,8 +1,16 @@ -# StateTomographyFitter +--- +title: StateTomographyFitter +description: API reference for qiskit.ignis.verification.StateTomographyFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.StateTomographyFitter +--- +# StateTomographyFitter + -`StateTomographyFitter(result, circuits, meas_basis='Pauli')` +`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` @@ -18,29 +26,136 @@ Initialize state tomography fitter with experimental data. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`add_data`](qiskit.ignis.verification.StateTomographyFitter.add_data#qiskit.ignis.verification.StateTomographyFitter.add_data "qiskit.ignis.verification.StateTomographyFitter.add_data") | Add tomography data from a Qiskit Result object. | -| [`fit`](qiskit.ignis.verification.StateTomographyFitter.fit#qiskit.ignis.verification.StateTomographyFitter.fit "qiskit.ignis.verification.StateTomographyFitter.fit") | Reconstruct a quantum state using CVXPY convex optimization. | -| [`set_measure_basis`](qiskit.ignis.verification.StateTomographyFitter.set_measure_basis#qiskit.ignis.verification.StateTomographyFitter.set_measure_basis "qiskit.ignis.verification.StateTomographyFitter.set_measure_basis") | Set the measurement basis | -| [`set_preparation_basis`](qiskit.ignis.verification.StateTomographyFitter.set_preparation_basis#qiskit.ignis.verification.StateTomographyFitter.set_preparation_basis "qiskit.ignis.verification.StateTomographyFitter.set_preparation_basis") | Set the preparation basis function | +### add\_data -## Attributes + + +`StateTomographyFitter.add_data(results, circuits)` + +Add tomography data from a Qiskit Result object. + +**Parameters** + +* **results** (`List`\[`Result`]) – The results obtained from executing tomography circuits. +* **circuits** (`List`\[`Union`\[`QuantumCircuit`, `str`]]) – circuits or circuit names to extract count information from the result object. + +**Raises** + +**QiskitError** – In case some of the tomography data is not found in the results + +### fit + + + +`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. + +**Fitter method** + +The `cvx` fitter method used CVXPY convex optimization package. The `lstsq` method uses least-squares fitting (linear inversion). The `auto` method will use ‘cvx’ if the CVXPY package is found on the system, otherwise it will default to ‘lstsq’. + +**Objective function** + +This fitter solves the constrained least-squares minimization: $minimize: ||a \cdot x - b ||_2$ + +subject to: + +> * $x >> 0$ +> * $\text{trace}(x) = 1$ + +where: + +> * a is the matrix of measurement operators $a[i] = \text{vec}(M_i).H$ +> * b is the vector of expectation value data for each projector $b[i] \sim \text{Tr}[M_i.H \cdot x] = (a \cdot x)[i]$ +> * x is the vectorized density matrix to be fitted + +**PSD constraint** + +The PSD keyword constrains the fitted matrix to be postive-semidefinite. For the `lstsq` fitter method the fitted matrix is rescaled using the method proposed in Reference \[1]. For the `cvx` fitter method the convex constraint makes the optimization problem a SDP. If PSD=False the fitted matrix will still be constrained to be Hermitian, but not PSD. In this case the optimization problem becomes a SOCP. + +**Trace constraint** + +The trace keyword constrains the trace of the fitted matrix. If trace=None there will be no trace constraint on the fitted matrix. This constraint should not be used for process tomography and the trace preserving constraint should be used instead. + +**CVXPY Solvers:** + +Various solvers can be called in CVXPY using the solver keyword argument. See the [CVXPY documentation](https://www.cvxpy.org/tutorial/advanced/index.html#solve-method-options) for more information on solvers. + +References: + +#### \[1] J Smolin, JM Gambetta, G Smith, Phys. Rev. Lett. 108, 070502 + +(2012). Open access: arXiv:1106.5458 \[quant-ph]. +**Parameters** + +* **method** (`str`) – The fitter method ‘auto’, ‘cvx’ or ‘lstsq’. +* **standard\_weights** (`bool`) – (default: True) Apply weights to tomography data based on count probability +* **beta** (`float`) – (default: 0.5) hedging parameter for converting counts to probabilities +* **\*\*kwargs** – kwargs for fitter method. + +**Raises** + +**QiskitError** – In case the fitting method is unrecognized. + +**Return type** + +`array` + +**Returns** + +The fitted matrix rho that minimizes $||\text{basis_matrix} \cdot \text{vec}(\text{rho}) - \text{data}||_2$. + +### set\_measure\_basis + + + +`StateTomographyFitter.set_measure_basis(basis)` + +Set the measurement basis + +**Parameters** + +**basis** (`Union`\[`TomographyBasis`, `str`]) – measurement basis + +**Raises** +**QiskitError** – In case of invalid measurement or preparation basis. + +### set\_preparation\_basis + + + +`StateTomographyFitter.set_preparation_basis(basis)` + +Set the preparation basis function + +**Parameters** + +**basis** (`Union`\[`TomographyBasis`, `str`]) – preparation basis + +**Raises** + +**QiskitError** – in case the basis has no preperation data + +## Attributes + + ### data Return tomography data - + ### measure\_basis Return the tomography measurement basis. - + ### preparation\_basis Return the tomography preparation basis. + 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 f1624be6c56..9ec254be6af 100644 --- a/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.md +++ b/docs/api/qiskit/0.32/qiskit.ignis.verification.TomographyFitter.md @@ -1,8 +1,16 @@ -# TomographyFitter +--- +title: TomographyFitter +description: API reference for qiskit.ignis.verification.TomographyFitter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ignis.verification.TomographyFitter +--- +# TomographyFitter + -`TomographyFitter(result, circuits, meas_basis='Pauli', prep_basis='Pauli')` +`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` @@ -19,29 +27,139 @@ Initialize tomography fitter with experimental data. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`add_data`](qiskit.ignis.verification.TomographyFitter.add_data#qiskit.ignis.verification.TomographyFitter.add_data "qiskit.ignis.verification.TomographyFitter.add_data") | Add tomography data from a Qiskit Result object. | -| [`fit`](qiskit.ignis.verification.TomographyFitter.fit#qiskit.ignis.verification.TomographyFitter.fit "qiskit.ignis.verification.TomographyFitter.fit") | Reconstruct a quantum state using CVXPY convex optimization. | -| [`set_measure_basis`](qiskit.ignis.verification.TomographyFitter.set_measure_basis#qiskit.ignis.verification.TomographyFitter.set_measure_basis "qiskit.ignis.verification.TomographyFitter.set_measure_basis") | Set the measurement basis | -| [`set_preparation_basis`](qiskit.ignis.verification.TomographyFitter.set_preparation_basis#qiskit.ignis.verification.TomographyFitter.set_preparation_basis "qiskit.ignis.verification.TomographyFitter.set_preparation_basis") | Set the preparation basis function | +### add\_data -## Attributes + + +`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. + +**Parameters** + +* **results** (`List`\[`Result`]) – The results obtained from executing tomography circuits. +* **circuits** (`List`\[`Union`\[`QuantumCircuit`, `str`]]) – circuits or circuit names to extract count information from the result object. + +**Raises** + +**QiskitError** – In case some of the tomography data is not found in the results + +### fit + + + +`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. + +**Fitter method** + +The `'cvx'` fitter method uses the CVXPY convex optimization package with a SDP solver. The `'lstsq'` method uses least-squares fitting. The `'auto'` method will use `'cvx'` if the both the CVXPY and a suitable SDP solver packages are found on the system, otherwise it will default to `'lstsq'`. + +**Objective function** + +This fitter solves the constrained least-squares minimization: minimize: $||a \cdot x - b ||_2$ + +subject to: + +> * $x \succeq 0$ +> * $\text{trace}(x) = 1$ + +where: + +> * a is the matrix of measurement operators $a[i] = \text{vec}(M_i).H$ +> * b is the vector of expectation value data for each projector $b[i] \sim \text{Tr}[M_i.H \cdot x] = (a \cdot x)[i]$ +> * x is the vectorized density matrix to be fitted + +**PSD constraint** + +The PSD keyword constrains the fitted matrix to be postive-semidefinite. For the `lstsq` fitter method the fitted matrix is rescaled using the method proposed in Reference \[1]. For the `cvx` fitter method the convex constraint makes the optimization problem a SDP. If PSD=False the fitted matrix will still be constrained to be Hermitian, but not PSD. In this case the optimization problem becomes a SOCP. + +**Trace constraint** + +The trace keyword constrains the trace of the fitted matrix. If trace=None there will be no trace constraint on the fitted matrix. This constraint should not be used for process tomography and the trace preserving constraint should be used instead. + +**CVXPY Solvers:** + +Various solvers can be called in CVXPY using the solver keyword argument. If `psd=True` an SDP solver is required other an SOCP solver is required. See the [CVXPY documentation](https://www.cvxpy.org/tutorial/advanced/index.html#solve-method-options) for more information on solvers. Note that the default SDP solver (‘SCS’) distributed with CVXPY will not be used for the `'auto'` method due its reduced accuracy compared to other solvers. When using the `'cvx'` method we strongly recommend installing one of the other supported SDP solvers. + +References: + +#### \[1] J Smolin, JM Gambetta, G Smith, Phys. Rev. Lett. 108, 070502 + +(2012). Open access: [arXiv:1106.5458](https://arxiv.org/abs/1106.5458) \[quant-ph]. +**Parameters** + +* **method** (`str`) – The fitter method ‘auto’, ‘cvx’ or ‘lstsq’. +* **standard\_weights** (`bool`) – (default: True) Apply weights to tomography data based on count probability +* **beta** (`float`) – hedging parameter for converting counts to probabilities +* **psd** (`bool`) – Enforced the fitted matrix to be positive semidefinite. +* **trace** (`Optional`\[`int`]) – trace constraint for the fitted matrix. +* **trace\_preserving** (`bool`) – Enforce the fitted matrix to be trace preserving when fitting a Choi-matrix in quantum process tomography. Note this method does not apply for ‘lstsq’ fitter method. +* **\*\*kwargs** – kwargs for fitter method. + +**Raises** + +**QiskitError** – In case the fitting method is unrecognized. + +**Return type** + +`array` + +**Returns** + +The fitted matrix rho that minimizes $||\text{basis_matrix} * \text{vec(rho)} - \text{data}||_2$. + +### set\_measure\_basis + + + +`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 + +**Parameters** + +**basis** (`Union`\[`TomographyBasis`, `str`]) – measurement basis + +**Raises** +**QiskitError** – In case of invalid measurement or preparation basis. + +### set\_preparation\_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") + +Set the preparation basis function + +**Parameters** + +**basis** (`Union`\[`TomographyBasis`, `str`]) – preparation basis + +**Raises** + +**QiskitError** – in case the basis has no preperation data + +## Attributes + + ### data Return tomography data - + ### measure\_basis Return the tomography measurement basis. - + ### preparation\_basis Return the tomography preparation basis. + 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 0a683901e31..cfdab2fd85b 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.calculate\_1q\_epc +--- +title: calculate_1q_epc +description: API reference for qiskit.ignis.verification.calculate_1q_epc +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.calculate_1q_epc +--- +# qiskit.ignis.verification.calculate\_1q\_epc + -`calculate_1q_epc(gate_per_cliff, epg_1q, qubit)` +`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. @@ -38,7 +46,7 @@ print(epc) **Parameters** -* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford#qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). +* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). * **epg\_1q** (`Dict`\[`str`, `float`]) – EPG of single qubit gates estimated by error model. * **qubit** (`int`) – index of qubit to calculate EPC. @@ -53,3 +61,4 @@ EPG of 2Q gate. **Raises** **QiskitError** – when specified `qubit` is not included in the gate count dictionary + 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 6a5785742e2..1b2f96bb99a 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.calculate\_1q\_epg +--- +title: calculate_1q_epg +description: API reference for qiskit.ignis.verification.calculate_1q_epg +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.calculate_1q_epg +--- +# qiskit.ignis.verification.calculate\_1q\_epg + -`calculate_1q_epg(gate_per_cliff, epc_1q, qubit)` +`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. @@ -52,7 +60,7 @@ pprint.pprint(epgs) {'u1': 0, 'u2': 0.0011278195488721805, 'u3': 0.002255639097744361} ``` -In the example, `gpc` can be generated by [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford#qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). The output of the function `epgs` can be used to calculate EPG of CNOT gate in conjugation with 2Q RB results, see [`calculate_2q_epg()`](qiskit.ignis.verification.calculate_2q_epg#qiskit.ignis.verification.calculate_2q_epg "qiskit.ignis.verification.calculate_2q_epg"). +In the example, `gpc` can be generated by [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). The output of the function `epgs` can be used to calculate EPG of CNOT gate in conjugation with 2Q RB results, see [`calculate_2q_epg()`](qiskit.ignis.verification.calculate_2q_epg "qiskit.ignis.verification.calculate_2q_epg"). This function presupposes the basis gate consists of `u1`, `u2` and `u3`. @@ -60,7 +68,7 @@ In the example, `gpc` can be generated by [`gates_per_clifford()`](qiskit.ignis. **Parameters** -* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford#qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). +* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). * **epc\_1q** (`float`) – EPC fit from 1Q RB experiment data. * **qubit** (`int`) – index of qubit to calculate EPGs. @@ -75,3 +83,4 @@ Dictionary of EPGs of single qubit basis gates. **Raises** **QiskitError** – when `u2` or `u3` is not found, `cx` gate count is nonzero, or specified qubit is not included in the gate count dictionary. + 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 2dc73462653..3fe0c5bfc94 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.calculate\_2q\_epc +--- +title: calculate_2q_epc +description: API reference for qiskit.ignis.verification.calculate_2q_epc +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.calculate_2q_epc +--- +# qiskit.ignis.verification.calculate\_2q\_epc + -`calculate_2q_epc(gate_per_cliff, epg_2q, qubit_pair, list_epgs_1q, two_qubit_name='cx')` +`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. @@ -57,7 +65,7 @@ As you can see two qubit gate contribution is dominant in this RB sequence. **Parameters** -* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford#qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). +* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). * **epg\_2q** (`float`) – EPG estimated by error model. * **qubit\_pair** (`List`\[`int`]) – index of two qubits to calculate EPC. * **list\_epgs\_1q** (`List`\[`Dict`\[`str`, `float`]]) – list of single qubit EPGs of qubit listed in `qubit_pair`. @@ -74,3 +82,4 @@ EPG of 2Q gate. **Raises** **QiskitError** – when `cx` is not found, specified `qubit_pair` is not included in the gate count dictionary, or length of `qubit_pair` is not 2. + 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 f94bdc0e23a..68e2f68dfa9 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 @@ -1,14 +1,22 @@ -# qiskit.ignis.verification.calculate\_2q\_epg +--- +title: calculate_2q_epg +description: API reference for qiskit.ignis.verification.calculate_2q_epg +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.calculate_2q_epg +--- +# qiskit.ignis.verification.calculate\_2q\_epg + -`calculate_2q_epg(gate_per_cliff, epc_2q, qubit_pair, list_epgs_1q=None, two_qubit_name='cx')` +`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. Given that a standard 2Q RB sequences consist of `u1`, `u2`, `u3`, and `cx` gates, the EPG of `cx` gate can be roughly approximated by $EPG_{CX} = EPC/N_{CX}$, where $N_{CX}$ is number of `cx` gates per Clifford which is designed to be 1.5. Because an error from two qubit gates are usually dominant and the contribution of single qubit gates in 2Q RB experiments is thus able to be ignored. If `list_epgs_1q` is not provided, the function returns the EPG calculated based upon this assumption. -When we know the EPG of every single qubit gates used in the 2Q RB experiment, we can isolate the EPC of the two qubit gate, ie $EPG_{CX} = EPC_{CX}/N_{CX}$ \[1]. This will give you more accurate estimation of EPG, especially when the `cx` gate fidelity is close to that of single qubit gate. To evaluate EPGs of single qubit gates, you first need to run standard 1Q RB experiments separately and feed the fit result and gate counts to [`calculate_1q_epg()`](qiskit.ignis.verification.calculate_1q_epg#qiskit.ignis.verification.calculate_1q_epg "qiskit.ignis.verification.calculate_1q_epg"). +When we know the EPG of every single qubit gates used in the 2Q RB experiment, we can isolate the EPC of the two qubit gate, ie $EPG_{CX} = EPC_{CX}/N_{CX}$ \[1]. This will give you more accurate estimation of EPG, especially when the `cx` gate fidelity is close to that of single qubit gate. To evaluate EPGs of single qubit gates, you first need to run standard 1Q RB experiments separately and feed the fit result and gate counts to [`calculate_1q_epg()`](qiskit.ignis.verification.calculate_1q_epg "qiskit.ignis.verification.calculate_1q_epg"). ```python import qiskit.ignis.verification.randomized_benchmarking as rb @@ -57,7 +65,7 @@ EPG without `list_epgs_1q`: 0.016107, with `list_epgs_1q`: 0.013622 **Parameters** -* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford#qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). +* **gate\_per\_cliff** (`Dict`\[`int`, `Dict`\[`str`, `float`]]) – dictionary of gate per Clifford. see [`gates_per_clifford()`](qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford"). * **epc\_2q** (`float`) – EPC fit from 2Q RB experiment data. * **qubit\_pair** (`List`\[`int`]) – index of two qubits to calculate EPG. * **list\_epgs\_1q** (`Optional`\[`List`\[`Dict`\[`str`, `float`]]]) – list of single qubit EPGs of qubit listed in `qubit_pair`. @@ -74,3 +82,4 @@ EPG of 2Q gate. **Raises** **QiskitError** – when `cx` is not found, specified `qubit_pair` is not included in the gate count dictionary, or length of `qubit_pair` is not 2. + 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 9a0dcdc1d5d..0d135b85af3 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.coherence\_limit +--- +title: coherence_limit +description: API reference for qiskit.ignis.verification.coherence_limit +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.coherence_limit +--- +# qiskit.ignis.verification.coherence\_limit + -`coherence_limit(nQ=2, T1_list=None, T2_list=None, gatelen=0.1)` +`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. @@ -24,3 +32,4 @@ float **Raises** **ValueError** – if there are invalid inputs + 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 f3eea2ac218..6399ca750f9 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.combine\_counts +--- +title: combine_counts +description: API reference for qiskit.ignis.verification.combine_counts +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.combine_counts +--- +# qiskit.ignis.verification.combine\_counts + -`combine_counts(counts1, counts2)` +`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. @@ -22,3 +30,4 @@ A dict containing the **sum** of entries in counts1 and counts2 where a nonexist >>> combine_counts(counts1, counts2) {'00': 7, '01': 5, '10': 7} ``` + 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 56886fd5c8c..430c5a64a9f 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.composite\_pauli\_z +--- +title: composite_pauli_z +description: API reference for qiskit.ignis.verification.composite_pauli_z +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.composite_pauli_z +--- +# qiskit.ignis.verification.composite\_pauli\_z + -`composite_pauli_z(qn)` +`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 @@ -17,3 +25,4 @@ Generates n tensored pauli z matrix upon input of qubit number **Returns** The tensored pauli z matrices + 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 27b7b94e380..bc5a0956aac 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.composite\_pauli\_z\_expvalue +--- +title: composite_pauli_z_expvalue +description: API reference for qiskit.ignis.verification.composite_pauli_z_expvalue +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.composite_pauli_z_expvalue +--- +# qiskit.ignis.verification.composite\_pauli\_z\_expvalue + -`composite_pauli_z_expvalue(counts_dictionary, qn)` +`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 @@ -18,3 +26,4 @@ Generates expectation value of n tensored pauli matrix upon input of qubit numbe **Returns** The expectation value + 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 ab8730748e4..ef90a823e16 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.count\_gates +--- +title: count_gates +description: API reference for qiskit.ignis.verification.count_gates +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.count_gates +--- +# qiskit.ignis.verification.count\_gates + -`count_gates(qobj, basis, qubits)` +`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. @@ -27,3 +35,4 @@ list ## Additional Information: nQ gates are counted in each qubit’s set of gates. + 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 09d2339f5b1..40141f39fe2 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.count\_keys +--- +title: count_keys +description: API reference for qiskit.ignis.verification.count_keys +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.count_keys +--- +# qiskit.ignis.verification.count\_keys + -`count_keys(num_qubits)` +`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. @@ -24,3 +32,4 @@ The strings of all 0/1 combinations of the given number of qubits >>> count_keys(3) ['000', '001', '010', '011', '100', '101', '110', '111'] ``` + 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 a89d6f9e3ea..0f52b196cd2 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.expectation\_counts +--- +title: expectation_counts +description: API reference for qiskit.ignis.verification.expectation_counts +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.expectation_counts +--- +# qiskit.ignis.verification.expectation\_counts + -`expectation_counts(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") Converts count dict to an expectation counts dict. @@ -26,3 +34,4 @@ Consider a input counts dictionary for s shots of measurement of the two-qubit o > * `01`: $s * $, > * `10`: $s * $, > * `11`: $s * $ + 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 615ff1bb12c..30492db94d6 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.gates\_per\_clifford +--- +title: gates_per_clifford +description: API reference for qiskit.ignis.verification.gates_per_clifford +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.gates_per_clifford +--- +# qiskit.ignis.verification.gates\_per\_clifford + -`gates_per_clifford(transpiled_circuits_list, clifford_lengths, basis, qubits)` +`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. @@ -70,3 +78,4 @@ Nested dictionary of gate counts per Clifford. **Raises** **QiskitError** – when input object is not a list of QuantumCircuit. + 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 27002319759..d7e9e5cdd5c 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.gateset\_tomography\_circuits +--- +title: gateset_tomography_circuits +description: API reference for qiskit.ignis.verification.gateset_tomography_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.gateset_tomography_circuits +--- +# qiskit.ignis.verification.gateset\_tomography\_circuits + -`gateset_tomography_circuits(measured_qubits=None, gateset_basis='default')` +`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. @@ -46,3 +54,4 @@ We perform three types of experiments: This experiment enables us to reconstruct \ -`get_ghz_mqc(n, delta, full_measurement=True)` +`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 @@ -19,3 +27,4 @@ This function creates an MQC circuit with n qubits, where the middle phase rotat **Returns** The MQC circuit + 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 33929c2c1fa..d14912cb064 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.get\_ghz\_mqc\_para +--- +title: get_ghz_mqc_para +description: API reference for qiskit.ignis.verification.get_ghz_mqc_para +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.get_ghz_mqc_para +--- +# qiskit.ignis.verification.get\_ghz\_mqc\_para + -`get_ghz_mqc_para(n, full_measurement=True)` +`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 @@ -18,3 +26,4 @@ This function creates an MQC circuit with n qubits, where the middle phase rotat **Returns** An mqc circuit and its Delta parameter + 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 263c4d1a301..facd849e662 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.get\_ghz\_po +--- +title: get_ghz_po +description: API reference for qiskit.ignis.verification.get_ghz_po +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.get_ghz_po +--- +# qiskit.ignis.verification.get\_ghz\_po + -`get_ghz_po(n, delta)` +`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 @@ -18,3 +26,4 @@ This function creates an Parity Oscillation circuit with n qubits, where the mid **Returns** The Parity Oscillation circuit + 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 b639593f1bd..8118f0f1438 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.get\_ghz\_po\_para +--- +title: get_ghz_po_para +description: API reference for qiskit.ignis.verification.get_ghz_po_para +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.get_ghz_po_para +--- +# qiskit.ignis.verification.get\_ghz\_po\_para + -`get_ghz_po_para(n)` +`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 @@ -19,3 +27,4 @@ the x and y axes is by delta **Returns** The parity oscillation circuit and its Delta/minus-delta parameters + 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 074a1f156b2..f66325ec0e0 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.get\_ghz\_simple +--- +title: get_ghz_simple +description: API reference for qiskit.ignis.verification.get_ghz_simple +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.get_ghz_simple +--- +# qiskit.ignis.verification.get\_ghz\_simple + -`get_ghz_simple(n, measure=True, full_measurement=True)` +`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 @@ -19,3 +27,4 @@ Creates a linear GHZ state with the option of measurement **Returns** A linear GHZ Circuit + 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 e5223c17ccc..c78ef327870 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.lookuptable\_decoding +--- +title: lookuptable_decoding +description: API reference for qiskit.ignis.verification.lookuptable_decoding +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.lookuptable_decoding +--- +# qiskit.ignis.verification.lookuptable\_decoding + -`lookuptable_decoding(training_results, real_results)` +`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. @@ -24,3 +32,4 @@ dict ## Additional information: Given a two dictionaries of results, as produced by a code object, thelogical error probability is calculated for lookup table decoding. This is done using training\_results as a guide to which syndrome is most probable for each logical value, and the probability is calculated for the results in real\_results. + 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 fabb8128716..cc2f9087a12 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.marginal\_counts +--- +title: marginal_counts +description: API reference for qiskit.ignis.verification.marginal_counts +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.marginal_counts +--- +# qiskit.ignis.verification.marginal\_counts + -`marginal_counts(counts, meas_qubits=True, pad_zeros=False)` +`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. @@ -19,3 +27,4 @@ Compute marginal counts from a counts dictionary. **Returns** A counts dictionary for the specified qubits. The returned dictionary will have any whitespace trimmed from the input counts keys. Thus if meas\_qubits=True the returned dictionary will have the same values as the input dictionary, but with whitespace trimmed from the keys. + 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 9be9fc5a496..12eba09e677 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.ordered\_list\_generator +--- +title: ordered_list_generator +description: API reference for qiskit.ignis.verification.ordered_list_generator +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.ordered_list_generator +--- +# qiskit.ignis.verification.ordered\_list\_generator + -`ordered_list_generator(counts_dictionary, qn)` +`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 @@ -18,3 +26,4 @@ For parity oscillations; just arranges dictionary of counts in bitwise binary or **Returns** The counts rearrangement + 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 c41c4e804b1..56c05ff9cd9 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.postselection\_decoding +--- +title: postselection_decoding +description: API reference for qiskit.ignis.verification.postselection_decoding +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.postselection_decoding +--- +# qiskit.ignis.verification.postselection\_decoding + -`postselection_decoding(results)` +`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. @@ -21,3 +29,4 @@ each of the encoded logical states whose results were given in the input. **Return type** dict + 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 0b548bbad6f..65d65c19f98 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.process\_tomography\_circuits +--- +title: process_tomography_circuits +description: API reference for qiskit.ignis.verification.process_tomography_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.process_tomography_circuits +--- +# 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')` +`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. @@ -34,3 +42,4 @@ on each qubit, and measurement in the Pauli-basis X, Y, Z resulting in $4^n 3^n$ A list of QuantumCircuit objects containing the original circuit with state preparation circuits prepended, and measurement circuits appended. The returned circuits are named by the preparation and measurement basis. + 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 88574b02201..5e6fd01c6bd 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.qv\_circuits +--- +title: qv_circuits +description: API reference for qiskit.ignis.verification.qv_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.qv_circuits +--- +# qiskit.ignis.verification.qv\_circuits + -`qv_circuits(qubit_lists, ntrials=1, qr=None, cr=None, seed=None)` +`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) @@ -12,8 +20,8 @@ The qubit\_lists is specified as a list of qubit lists. For each set of qubits, * **qubit\_lists** (*list*) – list of list of qubits to apply qv circuits to. Assume the list is ordered in increasing number of qubits * **ntrials** (*int*) – number of random iterations -* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister#qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – quantum register to act on (if None one is created) -* **cr** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister#qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")) – classical register to measure to (if None one is created) +* **qr** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")) – quantum register to act on (if None one is created) +* **cr** ([*ClassicalRegister*](qiskit.circuit.ClassicalRegister "qiskit.circuit.ClassicalRegister")) – classical register to measure to (if None one is created) * **seed** (*int*) – An optional RNG seed to use for the generated circuit **Returns** @@ -25,3 +33,4 @@ The qubit\_lists is specified as a list of qubit lists. For each set of qubits, **Return type** tuple + 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 9fb700026c5..10237d0cf82 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.randomized\_benchmarking\_seq +--- +title: randomized_benchmarking_seq +description: API reference for qiskit.ignis.verification.randomized_benchmarking_seq +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.randomized_benchmarking_seq +--- +# 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)` +`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. @@ -131,3 +139,4 @@ npurity = True ``` Create purity 2-qubit RB circuits separately on qubits Q0 and Q3 and on qubtis Q1 and Q2. The output is `npurity = 9` in this case. + 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 b091520c9d8..ec6a875a999 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.rho\_to\_fidelity +--- +title: rho_to_fidelity +description: API reference for qiskit.ignis.verification.rho_to_fidelity +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.rho_to_fidelity +--- +# qiskit.ignis.verification.rho\_to\_fidelity + -`rho_to_fidelity(rho)` +`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 @@ -13,3 +21,4 @@ Get fidelity given rho :type rho: `float` :param rho: The density matrix **Returns** The fidelity value for rho + 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 a3cb758a422..83b6bfdffff 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.state\_tomography\_circuits +--- +title: state_tomography_circuits +description: API reference for qiskit.ignis.verification.state_tomography_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.state_tomography_circuits +--- +# qiskit.ignis.verification.state\_tomography\_circuits + -`state_tomography_circuits(circuit, measured_qubits, meas_labels='Pauli', meas_basis='Pauli')` +`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. @@ -28,3 +36,4 @@ A list containing copies of the original circuit with state tomography measureme The returned circuits are named by the measurement basis. To perform tomography measurement in a custom basis, or to generate a subset of state tomography circuits for a partial tomography experiment use the general function 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 7d56dd94634..7026900f3fd 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 @@ -1,8 +1,16 @@ -# qiskit.ignis.verification.twoQ\_clifford\_error +--- +title: twoQ_clifford_error +description: API reference for qiskit.ignis.verification.twoQ_clifford_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ignis.verification.twoQ_clifford_error +--- +# qiskit.ignis.verification.twoQ\_clifford\_error + -`twoQ_clifford_error(ngates, gate_qubit, gate_err)` +`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. @@ -27,3 +35,4 @@ float **Raises** **QiskitError** – when number of qubit contained in `ngates` is not 2. + 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 b6f243e5219..c16001a1528 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 @@ -1,210 +1,2724 @@ +--- +title: RawFeatureVector +description: API reference for qiskit.ml.circuit.library.RawFeatureVector +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.ml.circuit.library.RawFeatureVector +--- + # 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") + +Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` + +The raw feature vector circuit. + +This circuit acts as parameterized initialization for statevectors with `feature_dimension` dimensions, thus with `log2(feature_dimension)` qubits. As long as there are free parameters, this circuit holds a placeholder instruction and can not be decomposed. Once all parameters are bound, the placeholder is replaced by a state initialization and can be unrolled. + +In ML, this circuit can be used to load the training data into qubit amplitudes. It does not apply an kernel transformation. (Therefore, it is a “raw” feature vector.) + +Examples: + +```python +from qiskit.ml.circuit.library import RawFeatureVector +circuit = RawFeatureVector(4) +print(circuit.num_qubits) +# prints: 2 + +print(circuit.draw(output='text')) +# prints: +# ┌──────┐ +# q_0: ┤0 ├ +# │ Raw │ +# q_1: ┤1 ├ +# └──────┘ + +print(circuit.ordered_parameters) +# prints: [Parameter(p[0]), Parameter(p[1]), Parameter(p[2]), Parameter(p[3])] + +import numpy as np +state = np.array([1, 0, 0, 1]) / np.sqrt(2) +bound = circuit.assign_parameters(state) +print(bound.draw()) +# prints: +# ┌──────────────────────────────────┐ +# q_0: ┤0 ├ +# │ initialize(0.70711,0,0,0.70711) │ +# q_1: ┤1 ├ +# └──────────────────────────────────┘ +``` + +**Parameters** + +**feature\_dimension** (`Optional`\[`int`]) – The feature dimension and number of qubits. + +## Methods + +### add\_bits + + + +`RawFeatureVector.add_bits(bits)` + +Add Bits to the circuit. + +### add\_calibration + + + +`RawFeatureVector.add_calibration(gate, qubits, schedule, params=None)` + +Register a low-level, custom pulse definition for the given gate. + +**Parameters** + +* **gate** (*Union\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*, str]*) – Gate information. +* **qubits** (*Union\[int, Tuple\[int]]*) – List of qubits to be measured. +* **schedule** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")) – Schedule information. +* **params** (*Optional\[List\[Union\[float,* [*Parameter*](qiskit.circuit.Parameter "qiskit.circuit.Parameter")*]]]*) – A list of parameters. + +**Raises** + +**Exception** – if the gate is of type string and params is None. + +### add\_register + + + +`RawFeatureVector.add_register(*regs)` + +Add registers. + +### append + + + +`RawFeatureVector.append(instruction, qargs=None, cargs=None)` + +Append one or more instructions to the end of the circuit, modifying the circuit in place. Expands qargs and cargs. + +**Parameters** + +* **instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – Instruction instance to append +* **qargs** (*list(argument)*) – qubits to attach instruction to +* **cargs** (*list(argument)*) – clbits to attach instruction to + +**Returns** + +a handle to the instruction that was just added + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +* **CircuitError** – if object passed is a subclass of Instruction +* **CircuitError** – if object passed is neither subclass nor an instance of Instruction + +### assign\_parameters + + + +`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. + +### barrier + + + +`RawFeatureVector.barrier(*qargs)` + +Apply `Barrier`. If qargs is None, applies to all. + +### bind\_parameters + + + +`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. + +### cast + + + +`static RawFeatureVector.cast(value, _type)` + +Best effort to cast value to type. Otherwise, returns the value. + +### cbit\_argument\_conversion + + + +`RawFeatureVector.cbit_argument_conversion(clbit_representation)` + +Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. + +**Parameters** + +**clbit\_representation** (*Object*) – representation to expand + +**Returns** + +Where each tuple is a classical bit. + +**Return type** + +List(tuple) + +### ccx + + + +`RawFeatureVector.ccx(control_qubit1, control_qubit2, target_qubit, ctrl_state=None)` + +Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). + +### ch + + + +`RawFeatureVector.ch(control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). + +### cls\_instances + + + +`classmethod RawFeatureVector.cls_instances()` + +Return the current number of instances of this class, useful for auto naming. + +### cls\_prefix + + + +`classmethod RawFeatureVector.cls_prefix()` + +Return the prefix to use for auto naming. + +### cnot + + + +`RawFeatureVector.cnot(control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). + +### combine + + + +`RawFeatureVector.combine(rhs)` + +DEPRECATED - Returns rhs appended to self if self contains compatible registers. + +Two circuits are compatible if they contain the same registers or if they contain different registers with unique names. The returned circuit will contain all unique registers between both circuits. + +Return self + rhs as a new object. + +**Parameters** + +**rhs** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit to append to the right hand side. + +**Returns** + +Returns a new QuantumCircuit object + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the rhs circuit is not compatible + +### compose + + + +`RawFeatureVector.compose(other, qubits=None, clbits=None, front=False, inplace=False, wrap=False)` + +Compose circuit with `other` circuit or instruction, optionally permuting wires. + +`other` can be narrower or of equal width to `self`. + +**Parameters** + +* **other** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or BaseOperator*) – (sub)circuit to compose onto self. +* **qubits** (*list\[Qubit|int]*) – qubits of self to compose onto. +* **clbits** (*list\[Clbit|int]*) – clbits of self to compose onto. +* **front** (*bool*) – If True, front composition will be performed (not implemented yet). +* **inplace** (*bool*) – If True, modify the object. Otherwise return composed circuit. +* **wrap** (*bool*) – If True, wraps the other circuit into a gate (or instruction, depending on whether it contains only unitary instructions) before composing it onto self. + +**Returns** + +the composed circuit (returns None if inplace==True). + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **CircuitError** – if composing on the front. +* **QiskitError** – if `other` is wider or there are duplicate edge mappings. + +Examples: + +```python +lhs.compose(rhs, qubits=[3, 2], inplace=True) + +.. parsed-literal:: + + ┌───┐ ┌─────┐ ┌───┐ + lqr_1_0: ───┤ H ├─── rqr_0: ──■──┤ Tdg ├ lqr_1_0: ───┤ H ├─────────────── + ├───┤ ┌─┴─┐└─────┘ ├───┤ + lqr_1_1: ───┤ X ├─── rqr_1: ┤ X ├─────── lqr_1_1: ───┤ X ├─────────────── + ┌──┴───┴──┐ └───┘ ┌──┴───┴──┐┌───┐ + lqr_1_2: ┤ U1(0.1) ├ + = lqr_1_2: ┤ U1(0.1) ├┤ X ├─────── + └─────────┘ └─────────┘└─┬─┘┌─────┐ + lqr_2_0: ─────■───── lqr_2_0: ─────■───────■──┤ Tdg ├ + ┌─┴─┐ ┌─┴─┐ └─────┘ + lqr_2_1: ───┤ X ├─── lqr_2_1: ───┤ X ├─────────────── + └───┘ └───┘ + lcr_0: 0 ═══════════ lcr_0: 0 ═══════════════════════ + + lcr_1: 0 ═══════════ lcr_1: 0 ═══════════════════════ +``` + +### control + + + +`RawFeatureVector.control(num_ctrl_qubits=1, label=None, ctrl_state=None)` + +Control this circuit on `num_ctrl_qubits` qubits. + +**Parameters** + +* **num\_ctrl\_qubits** (*int*) – The number of control qubits. +* **label** (*str*) – An optional label to give the controlled operation for visualization. +* **ctrl\_state** (*str or int*) – The control state in decimal or as a bitstring (e.g. ‘111’). If None, use `2**num_ctrl_qubits - 1`. + +**Returns** + +The controlled version of this circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**CircuitError** – If the circuit contains a non-unitary operation and cannot be controlled. + +### copy + + + +`RawFeatureVector.copy(name=None)` + +Copy the circuit. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit. If None, then the name stays the same + +**Returns** + +a deepcopy of the current circuit, with the specified name + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### count\_ops + + + +`RawFeatureVector.count_ops()` + +Count each operation kind in the circuit. + +**Returns** + +a breakdown of how many operations of each kind, sorted by amount. + +**Return type** + +OrderedDict + +### cp + + + +`RawFeatureVector.cp(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). + +### crx + + + +`RawFeatureVector.crx(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). + +### cry + + + +`RawFeatureVector.cry(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). + +### crz + + + +`RawFeatureVector.crz(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). + +### cswap + + + +`RawFeatureVector.cswap(control_qubit, target_qubit1, target_qubit2, label=None, ctrl_state=None)` + +Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). + +### csx + + + +`RawFeatureVector.csx(control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). + +### cu + + + +`RawFeatureVector.cu(theta, phi, lam, gamma, control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). + +### cu1 + + + +`RawFeatureVector.cu1(theta, control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). + +### cu3 + + + +`RawFeatureVector.cu3(theta, phi, lam, control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). + +### cx + + + +`RawFeatureVector.cx(control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). + +### cy + + + +`RawFeatureVector.cy(control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). + +### cz + + + +`RawFeatureVector.cz(control_qubit, target_qubit, label=None, ctrl_state=None)` + +Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). + +### dcx + + + +`RawFeatureVector.dcx(qubit1, qubit2)` + +Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). + +### decompose + + + +`RawFeatureVector.decompose()` + +Call a decomposition pass on this circuit, to decompose one level (shallow decompose). + +**Returns** + +a circuit one level decomposed + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### delay + + + +`RawFeatureVector.delay(duration, qarg=None, unit='dt')` + +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. + +**Parameters** + +* **duration** (*int or float or* [*ParameterExpression*](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression")) – duration of the delay. +* **qarg** (*Object*) – qubit argument to apply this delay. +* **unit** (*str*) – unit of the duration. Supported units: ‘s’, ‘ms’, ‘us’, ‘ns’, ‘ps’, ‘dt’. Default is `dt`, i.e. integer time unit depending on the target backend. + +**Returns** + +the attached delay instruction. + +**Return type** + +qiskit.Instruction + +**Raises** + +**CircuitError** – if arguments have bad format. + +### depth + + + +`RawFeatureVector.depth()` + +Return circuit depth (i.e., length of critical path). This does not include compiler or simulator directives such as ‘barrier’ or ‘snapshot’. + +**Returns** + +Depth of circuit. + +**Return type** + +int + +#### Notes + +The circuit depth and the DAG depth need not be the same. + +### diagonal + + + +`RawFeatureVector.diagonal(diag, qubit)` + +Attach a diagonal gate to a circuit. + +The decomposition is based on Theorem 7 given in “Synthesis of Quantum Logic Circuits” by Shende et al. ([https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf)). + +**Parameters** + +* **diag** (*list*) – list of the 2^k diagonal entries (for a diagonal gate on k qubits). Must contain at least two entries +* **qubit** (*QuantumRegister|list*) – list of k qubits the diagonal is acting on (the order of the qubits specifies the computational basis in which the diagonal gate is provided: the first element in diag acts on the state where all the qubits in q are in the state 0, the second entry acts on the state where all the qubits q\[1],…,q\[k-1] are in the state zero and q\[0] is in the state 1, and so on) + +**Returns** + +the diagonal gate which was attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list of the diagonal entries or the qubit list is in bad format; if the number of diagonal entries is not 2^k, where k denotes the number of qubits + +### draw + + + +`RawFeatureVector.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)` + +Draw the quantum circuit. Use the output parameter to choose the drawing format: + +**text**: ASCII art TextDrawing that can be printed in the console. + +**matplotlib**: images with color rendered purely in Python. + +**latex**: high-quality images compiled via latex. + +**latex\_source**: raw uncompiled latex output. + +**Parameters** + +* **output** (*str*) – select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default the text drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file. +* **scale** (*float*) – scale of image to draw (shrink if \< 1.0). Only used by the mpl, latex and latex\_source outputs. Defaults to 1.0. +* **filename** (*str*) – file path to save image to. Defaults to None. +* **style** (*dict or str*) – dictionary of style or file name of style json file. This option is only used by the mpl or latex output type. If style is a str, it is used as the path to a json file which contains a style dict. The file will be opened, parsed, and then any style elements in the dict will replace the default values in the input dict. A file to be loaded must end in `.json`, but the name entered here can omit `.json`. For example, `style='iqx.json'` or `style='iqx'`. If style is a dict and the `'name'` key is set, that name will be used to load a json file, followed by loading the other items in the style dict. For example, `style={'name': 'iqx'}`. If style is not a str and name is not a key in the style dict, then the default value from the user config file (usually `~/.qiskit/settings.conf`) will be used, for example, `circuit_mpl_style = iqx`. If none of these are set, the default style will be used. The search path for style json files can be specified in the user config, for example, `circuit_mpl_style_path = /home/user/styles:/home/user`. See: [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle") for more information on the contents. +* **interactive** (*bool*) – when set to true, show the circuit in a new window (for mpl this depends on the matplotlib backend being used supporting this). Note when used with either the text or the latex\_source output type this has no effect and will be silently ignored. Defaults to False. +* **reverse\_bits** (*bool*) – when set to True, reverse the bit order inside registers for the output visualization. Defaults to False. +* **plot\_barriers** (*bool*) – enable/disable drawing barriers in the output circuit. Defaults to True. +* **justify** (*string*) – options are `left`, `right` or `none`. If anything else is supplied, it defaults to left justified. It refers to where gates should be placed in the output circuit if there is an option. `none` results in each gate being placed in its own column. +* **vertical\_compression** (*string*) – `high`, `medium` or `low`. It merges the lines generated by the text output so the drawing will take less vertical room. Default is `medium`. Only used by the text output, will be silently ignored otherwise. +* **idle\_wires** (*bool*) – include idle wires (wires with no circuit elements) in output visualization. Default is True. +* **with\_layout** (*bool*) – include layout information, with labels on the physical layout. Default is True. +* **fold** (*int*) – sets pagination. It can be disabled using -1. In text, sets the length of the lines. This is useful when the drawing does not fit in the console. If None (default), it will try to guess the console width using `shutil.get_terminal_size()`. However, if running in jupyter, the default line length is set to 80 characters. In mpl, it is the number of (visual) layers before folding. Default is 25. +* **ax** (*matplotlib.axes.Axes*) – Only used by the mpl backend. An optional Axes object to be used for the visualization output. If none is specified, a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. +* **initial\_state** (*bool*) – optional. Adds `|0>` in the beginning of the wire. Default is False. +* **cregbundle** (*bool*) – optional. If set True, bundle classical registers. Default is True. + +**Returns** + +`TextDrawing` or `matplotlib.figure` or `PIL.Image` or `str`: + +* **TextDrawing (output=’text’)** + + A drawing that can be printed as ascii art. + +* **matplotlib.figure.Figure (output=’mpl’)** + + A matplotlib figure object for the circuit diagram. + +* **PIL.Image (output=’latex’)** + + An in-memory representation of the image of the circuit diagram. + +* **str (output=’latex\_source’)** + + The LaTeX source code for visualizing the circuit diagram. + +**Raises** + +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected +* **ImportError** – when the output methods requires non-installed libraries. + +#### Example + +```python +from qiskit import QuantumRegister, ClassicalRegister, QuantumCircuit +from qiskit.tools.visualization import circuit_drawer +q = QuantumRegister(1) +c = ClassicalRegister(1) +qc = QuantumCircuit(q, c) +qc.h(q) +qc.measure(q, c) +qc.draw(output='mpl', style={'backgroundcolor': '#EEEEEE'}) +``` + +![../\_images/qiskit.ml.circuit.library.RawFeatureVector.draw\_0\_0.png](/images/api/qiskit/0.32/qiskit.ml.circuit.library.RawFeatureVector.draw_0_0.png) + +### ecr + + + +`RawFeatureVector.ecr(qubit1, qubit2)` + +Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). + +### extend + + + +`RawFeatureVector.extend(rhs)` + +DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. + +Two circuits are compatible if they contain the same registers or if they contain different registers with unique names. The returned circuit will contain all unique registers between both circuits. + +Modify and return self. + +**Parameters** + +**rhs** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The quantum circuit to append to the right hand side. + +**Returns** + +Returns this QuantumCircuit object (which has been modified) + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the rhs circuit is not compatible + +### fredkin + + + +`RawFeatureVector.fredkin(control_qubit, target_qubit1, target_qubit2)` + +Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). + +### from\_qasm\_file + + + +`static RawFeatureVector.from_qasm_file(path)` + +Take in a QASM file and generate a QuantumCircuit object. + +**Parameters** + +**path** (*str*) – Path to the file for a QASM program + +**Returns** + +The QuantumCircuit object for the input QASM + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### from\_qasm\_str + + + +`static RawFeatureVector.from_qasm_str(qasm_str)` + +Take in a QASM string and generate a QuantumCircuit object. + +**Parameters** + +**qasm\_str** (*str*) – A QASM program string + +**Returns** + +The QuantumCircuit object for the input QASM + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### get\_instructions + + + +`RawFeatureVector.get_instructions(name)` + +Get instructions matching name. + +**Parameters** + +**name** (*str*) – The name of instruction to. + +**Returns** + +list of (instruction, qargs, cargs). + +**Return type** + +list(tuple) + +### h + + + +`RawFeatureVector.h(qubit)` + +Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). + +### hamiltonian + + + +`RawFeatureVector.hamiltonian(operator, time, qubits, label=None)` + +Apply hamiltonian evolution to qubits. + +### has\_register + + + +`RawFeatureVector.has_register(register)` + +Test if this circuit has the register r. + +**Parameters** + +**register** (*Register*) – a quantum or classical register. + +**Returns** + +True if the register is contained in this circuit. + +**Return type** + +bool + +### i + + + +`RawFeatureVector.i(qubit)` + +Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). + +### id + + + +`RawFeatureVector.id(qubit)` + +Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). + +### initialize + + + +`RawFeatureVector.initialize(params, qubits=None)` + +Initialize qubits in a specific state. + +Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by an state preparing unitary. Both these steps are included in the Initialize instruction. + +**Parameters** + +* **params** (*str or list or int*) – + + * **str: labels of basis states of the Pauli eigenstates Z, X, Y. See** + + `from_label()`. Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to |1> and the qubit one to |0>. + + * list: vector of complex amplitudes to initialize to. + + * **int: an integer that is used as a bitmap indicating which qubits to initialize** + + to |1>. Example: setting params to 5 would initialize qubit 0 and qubit 2 to |1> and qubit 1 to |0>. + +* **qubits** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or int*) – + + * QuantumRegister: A list of qubits to be initialized \[Default: None]. + * int: Index of qubit to initialized \[Default: None]. + +**Returns** + +a handle to the instruction that was just initialized + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +#### Examples + +Prepare a qubit in the state $(|0\rangle - |1\rangle) / \sqrt{2}$. + +```python +import numpy as np +from qiskit import QuantumCircuit + +circuit = QuantumCircuit(1) +circuit.initialize([1/np.sqrt(2), -1/np.sqrt(2)], 0) +circuit.draw() +``` + +```python + ┌──────────────────────────────┐ +q_0: ┤ Initialize(0.70711,-0.70711) ├ + └──────────────────────────────┘ +``` + +#### output: + +┌──────────────────────────────┐ + +#### q\_0: ┤ initialize(0.70711,-0.70711) ├ + +└──────────────────────────────┘ + +Initialize from a string two qubits in the state |10>. The order of the labels is reversed with respect to qubit index. More information about labels for basis states are in `from_label()`. + +```python +import numpy as np +from qiskit import QuantumCircuit + +circuit = QuantumCircuit(2) +circuit.initialize('01', circuit.qubits) +circuit.draw() +``` + +```python + ┌──────────────────┐ +q_0: ┤0 ├ + │ Initialize(0,1) │ +q_1: ┤1 ├ + └──────────────────┘ +``` + +#### output: + +┌──────────────────┐ + +#### q\_0: ┤0 ├ + +│ initialize(0,1) │ + +#### q\_1: ┤1 ├ + +└──────────────────┘ + +Initialize two qubits from an array of complex amplitudes .. jupyter-execute: + +```python +import numpy as np +from qiskit import QuantumCircuit + +circuit = QuantumCircuit(2) +circuit.initialize([0, 1/np.sqrt(2), -1.j/np.sqrt(2), 0], circuit.qubits) +circuit.draw() +``` + +#### output: + +┌────────────────────────────────────┐ + +#### q\_0: ┤0 ├ + +│ initialize(0,0.70711,-0.70711j,0) │ + +#### q\_1: ┤1 ├ + +└────────────────────────────────────┘ + +### inverse + + + +`RawFeatureVector.inverse()` + +Invert (take adjoint of) this circuit. + +This is done by recursively inverting all gates. + +**Returns** + +the inverted circuit + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**CircuitError** – if the circuit cannot be inverted. + +#### Examples + +#### input: + +┌───┐ + +#### q\_0: ┤ H ├─────■────── + +└───┘┌────┴─────┐ + +#### q\_1: ─────┤ RX(1.57) ├ + +└──────────┘ + +#### output: + +┌───┐ + +#### q\_0: ──────■──────┤ H ├ + +┌─────┴─────┐└───┘ + +#### q\_1: ┤ RX(-1.57) ├───── + +└───────────┘ + +### iso + + + +`RawFeatureVector.iso(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None, epsilon=1e-10)` + +Attach an arbitrary isometry from m to n qubits to a circuit. In particular, this allows to attach arbitrary unitaries on n qubits (m=n) or to prepare any state on n qubits (m=0). The decomposition used here was introduced by Iten et al. in [https://arxiv.org/abs/1501.06911](https://arxiv.org/abs/1501.06911). + +**Parameters** + +* **isometry** (*ndarray*) – an isometry from m to n qubits, i.e., a (complex) ndarray of dimension 2^n×2^m with orthonormal columns (given in the computational basis specified by the order of the ancillas and the input qubits, where the ancillas are considered to be more significant than the input qubits.). +* **q\_input** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of m qubits where the input to the isometry is fed in (empty list for state preparation). +* **q\_ancillas\_for\_output** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of n-m ancilla qubits that are used for the output of the isometry and which are assumed to start in the zero state. The qubits are listed with increasing significance. +* **q\_ancillas\_zero** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which are assumed to start in the zero state. Default is q\_ancillas\_zero = None. +* **q\_ancillas\_dirty** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None. +* **epsilon** (*float*) – error tolerance of calculations. Default is epsilon = \_EPS. + +**Returns** + +the isometry is attached to the quantum circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the array is not an isometry of the correct size corresponding to the provided number of qubits. + +### isometry + + + +`RawFeatureVector.isometry(isometry, q_input, q_ancillas_for_output, q_ancillas_zero=None, q_ancillas_dirty=None, epsilon=1e-10)` + +Attach an arbitrary isometry from m to n qubits to a circuit. In particular, this allows to attach arbitrary unitaries on n qubits (m=n) or to prepare any state on n qubits (m=0). The decomposition used here was introduced by Iten et al. in [https://arxiv.org/abs/1501.06911](https://arxiv.org/abs/1501.06911). + +**Parameters** + +* **isometry** (*ndarray*) – an isometry from m to n qubits, i.e., a (complex) ndarray of dimension 2^n×2^m with orthonormal columns (given in the computational basis specified by the order of the ancillas and the input qubits, where the ancillas are considered to be more significant than the input qubits.). +* **q\_input** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of m qubits where the input to the isometry is fed in (empty list for state preparation). +* **q\_ancillas\_for\_output** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of n-m ancilla qubits that are used for the output of the isometry and which are assumed to start in the zero state. The qubits are listed with increasing significance. +* **q\_ancillas\_zero** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which are assumed to start in the zero state. Default is q\_ancillas\_zero = None. +* **q\_ancillas\_dirty** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of ancilla qubits which can start in an arbitrary state. Default is q\_ancillas\_dirty = None. +* **epsilon** (*float*) – error tolerance of calculations. Default is epsilon = \_EPS. + +**Returns** + +the isometry is attached to the quantum circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the array is not an isometry of the correct size corresponding to the provided number of qubits. + +### iswap + + + +`RawFeatureVector.iswap(qubit1, qubit2)` + +Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). + +### mcp + + + +`RawFeatureVector.mcp(lam, control_qubits, target_qubit)` + +Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). + +### mcrx + + + +`RawFeatureVector.mcrx(theta, q_controls, q_target, use_basis_gates=False)` + +Apply Multiple-Controlled X rotation gate + +**Parameters** + +* **self** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcrx gate on. +* **theta** (*float*) – angle theta +* **q\_controls** (*list(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits +* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit +* **use\_basis\_gates** (*bool*) – use p, u, cx + +**Raises** + +**QiskitError** – parameter errors + +### mcry + + + +`RawFeatureVector.mcry(theta, q_controls, q_target, q_ancillae=None, mode=None, use_basis_gates=False)` + +Apply Multiple-Controlled Y rotation gate + +**Parameters** + +* **self** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcry gate on. +* **theta** (*float*) – angle theta +* **q\_controls** (*list(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits +* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit +* **q\_ancillae** ([*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister") *or tuple(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*, int)*) – The list of ancillary qubits. +* **mode** (*string*) – The implementation mode to use +* **use\_basis\_gates** (*bool*) – use p, u, cx + +**Raises** + +**QiskitError** – parameter errors + +### mcrz + + + +`RawFeatureVector.mcrz(lam, q_controls, q_target, use_basis_gates=False)` + +Apply Multiple-Controlled Z rotation gate + +**Parameters** + +* **self** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The QuantumCircuit object to apply the mcrz gate on. +* **lam** (*float*) – angle lambda +* **q\_controls** (*list(*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*)*) – The list of control qubits +* **q\_target** ([*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")) – The target qubit +* **use\_basis\_gates** (*bool*) – use p, u, cx + +**Raises** + +**QiskitError** – parameter errors + +### mct + + + +`RawFeatureVector.mct(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` + +Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). + +### mcu1 + + + +`RawFeatureVector.mcu1(lam, control_qubits, target_qubit)` + +Apply `MCU1Gate`. + +### mcx + + + +`RawFeatureVector.mcx(control_qubits, target_qubit, ancilla_qubits=None, mode='noancilla')` + +Apply [`MCXGate`](qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). + +The multi-cX gate can be implemented using different techniques, which use different numbers of ancilla qubits and have varying circuit depth. These modes are: - ‘noancilla’: Requires 0 ancilla qubits. - ‘recursion’: Requires 1 ancilla qubit if more than 4 controls are used, otherwise 0. - ‘v-chain’: Requires 2 less ancillas than the number of control qubits. - ‘v-chain-dirty’: Same as for the clean ancillas (but the circuit will be longer). + +### measure + + + +`RawFeatureVector.measure(qubit, cbit)` + +Measure quantum bit into classical bit (tuples). + +**Parameters** + +* **qubit** (*QuantumRegister|list|tuple*) – quantum register +* **cbit** (*ClassicalRegister|list|tuple*) – classical register + +**Returns** + +the attached measure instruction. + +**Return type** + +qiskit.Instruction + +**Raises** + +**CircuitError** – if qubit is not in this circuit or bad format; if cbit is not in this circuit or not creg. + +### measure\_active + + + +`RawFeatureVector.measure_active(inplace=True)` + +Adds measurement to all non-idle qubits. Creates a new ClassicalRegister with a size equal to the number of non-idle qubits being measured. + +Returns a new circuit with measurements if inplace=False. + +**Parameters** + +**inplace** (*bool*) – All measurements inplace or return new circuit. + +**Returns** + +Returns circuit with measurements when inplace = False. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### measure\_all + + + +`RawFeatureVector.measure_all(inplace=True)` + +Adds measurement to all qubits. Creates a new ClassicalRegister with a size equal to the number of qubits being measured. + +Returns a new circuit with measurements if inplace=False. + +**Parameters** + +**inplace** (*bool*) – All measurements inplace or return new circuit. + +**Returns** + +Returns circuit with measurements when inplace = False. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### ms + + + +`RawFeatureVector.ms(theta, qubits)` + +Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). + +### num\_connected\_components + + + +`RawFeatureVector.num_connected_components(unitary_only=False)` + +How many non-entangled subcircuits can the circuit be factored to. + +**Parameters** + +**unitary\_only** (*bool*) – Compute only unitary part of graph. + +**Returns** + +Number of connected components in circuit. + +**Return type** + +int + +### num\_nonlocal\_gates + + + +`RawFeatureVector.num_nonlocal_gates()` + +Return number of non-local gates (i.e. involving 2+ qubits). + +Conditional nonlocal gates are also included. + +### num\_tensor\_factors + + + +`RawFeatureVector.num_tensor_factors()` + +Computes the number of tensor factors in the unitary (quantum) part of the circuit only. + +#### Notes + +This is here for backwards compatibility, and will be removed in a future release of Qiskit. You should call num\_unitary\_factors instead. + +### num\_unitary\_factors + + + +`RawFeatureVector.num_unitary_factors()` + +Computes the number of tensor factors in the unitary (quantum) part of the circuit only. + +### p + + + +`RawFeatureVector.p(theta, qubit)` + +Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). + +### pauli + + + +`RawFeatureVector.pauli(pauli_string, qubits)` + +Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). + +### power + + + +`RawFeatureVector.power(power, matrix_power=False)` + +Raise this circuit to the power of `power`. + +If `power` is a positive integer and `matrix_power` is `False`, this implementation defaults to calling `repeat`. Otherwise, if the circuit is unitary, the matrix is computed to calculate the matrix power. + +**Parameters** + +* **power** (*int*) – The power to raise this circuit to. +* **matrix\_power** (*bool*) – If True, the circuit is converted to a matrix and then the matrix power is computed. If False, and `power` is a positive integer, the implementation defaults to `repeat`. + +**Raises** + +**CircuitError** – If the circuit needs to be converted to a gate but it is not unitary. + +**Returns** + +A circuit implementing this circuit raised to the power of `power`. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### qasm + + + +`RawFeatureVector.qasm(formatted=False, filename=None, encoding=None)` + +Return OpenQASM string. + +**Parameters** + +* **formatted** (*bool*) – Return formatted Qasm string. +* **filename** (*str*) – Save Qasm to file with name ‘filename’. +* **encoding** (*str*) – Optionally specify the encoding to use for the output file if `filename` is specified. By default this is set to the system’s default encoding (ie whatever `locale.getpreferredencoding()` returns) and can be set to any valid codec or alias from stdlib’s [codec module](https://docs.python.org/3/library/codecs.html#standard-encodings) + +**Returns** + +If formatted=False. + +**Return type** + +str + +**Raises** + +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If pygments is not installed and `formatted` is `True`. +* [**QasmError**](qiskit.qasm.QasmError "qiskit.qasm.QasmError") – If circuit has free parameters. + +### qbit\_argument\_conversion + + + +`RawFeatureVector.qbit_argument_conversion(qubit_representation)` + +Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. + +**Parameters** + +**qubit\_representation** (*Object*) – representation to expand + +**Returns** + +Where each tuple is a qubit. + +**Return type** + +List(tuple) + +### qubit\_duration + + + +`RawFeatureVector.qubit_duration(*qubits)` + +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`. + +**Parameters** + +**\*qubits** – Qubits within `self` to include. + +**Return type** + +`float` + +**Returns** + +Return the duration between the first start and last stop time of non-delay instructions + +### qubit\_start\_time + + + +`RawFeatureVector.qubit_start_time(*qubits)` + +Return the start time of the first instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. + +Return 0 if there are no instructions over qubits + +**Parameters** + +* **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating +* **of self.qubits.** (*indices*) – + +**Return type** + +`float` + +**Returns** + +Return the start time of the first instruction, excluding delays, over the qubits + +**Raises** + +**CircuitError** – if `self` is a not-yet scheduled circuit. + +### qubit\_stop\_time + + + +`RawFeatureVector.qubit_stop_time(*qubits)` + +Return the stop time of the last instruction, excluding delays, over the supplied qubits. Its time unit is `self.unit`. + +Return 0 if there are no instructions over qubits + +**Parameters** + +* **\*qubits** – Qubits within `self` to include. Integers are allowed for qubits, indicating +* **of self.qubits.** (*indices*) – + +**Return type** + +`float` + +**Returns** + +Return the stop time of the last instruction, excluding delays, over the qubits + +**Raises** + +**CircuitError** – if `self` is a not-yet scheduled circuit. + +### r + + + +`RawFeatureVector.r(theta, phi, qubit)` + +Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). + +### rcccx + + + +`RawFeatureVector.rcccx(control_qubit1, control_qubit2, control_qubit3, target_qubit)` + +Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). + +### rccx + + + +`RawFeatureVector.rccx(control_qubit1, control_qubit2, target_qubit)` + +Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). + +### remove\_final\_measurements + + + +`RawFeatureVector.remove_final_measurements(inplace=True)` + +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. + +Returns a new circuit without measurements if inplace=False. + +**Parameters** + +**inplace** (*bool*) – All measurements removed inplace or return new circuit. + +**Returns** + +Returns circuit with measurements removed when inplace = False. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### repeat + + + +`RawFeatureVector.repeat(reps)` + +Repeat this circuit `reps` times. + +**Parameters** + +**reps** (*int*) – How often this circuit should be repeated. + +**Returns** + +A circuit containing `reps` repetitions of this circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### reset + + + +`RawFeatureVector.reset(qubit)` + +Reset q. + +### reverse\_bits + + + +`RawFeatureVector.reverse_bits()` + +Return a circuit with the opposite order of wires. + +The circuit is “vertically” flipped. If a circuit is defined over multiple registers, the resulting circuit will have the same registers but with their order flipped. + +This method is useful for converting a circuit written in little-endian convention to the big-endian equivalent, and vice versa. + +**Returns** + +the circuit with reversed bit order. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +#### Examples + +#### input: + +┌───┐ + +#### q\_0: ┤ H ├─────■────── + +└───┘┌────┴─────┐ + +#### q\_1: ─────┤ RX(1.57) ├ + +└──────────┘ + +#### output: + +┌──────────┐ + +#### q\_0: ─────┤ RX(1.57) ├ + +┌───┐└────┬─────┘ + +#### q\_1: ┤ H ├─────■────── + +└───┘ + +### reverse\_ops + + + +`RawFeatureVector.reverse_ops()` + +Reverse the circuit by reversing the order of instructions. + +This is done by recursively reversing all instructions. It does not invert (adjoint) any gate. + +**Returns** + +the reversed circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +#### Examples + +#### input: + +┌───┐ + +#### q\_0: ┤ H ├─────■────── + +└───┘┌────┴─────┐ + +#### q\_1: ─────┤ RX(1.57) ├ + +└──────────┘ + +#### output: + +┌───┐ + +#### q\_0: ─────■──────┤ H ├ + +┌────┴─────┐└───┘ + +#### q\_1: ┤ RX(1.57) ├───── + +└──────────┘ + +### rv + + + +`RawFeatureVector.rv(vx, vy, vz, qubit)` + +Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). + +### rx + + + +`RawFeatureVector.rx(theta, qubit, label=None)` + +Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). + +### rxx + + + +`RawFeatureVector.rxx(theta, qubit1, qubit2)` + +Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). + +### ry + + + +`RawFeatureVector.ry(theta, qubit, label=None)` + +Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). + +### ryy + + + +`RawFeatureVector.ryy(theta, qubit1, qubit2)` + +Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). + +### rz + + + +`RawFeatureVector.rz(phi, qubit)` + +Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). + +### rzx + + + +`RawFeatureVector.rzx(theta, qubit1, qubit2)` + +Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). + +### rzz + + + +`RawFeatureVector.rzz(theta, qubit1, qubit2)` + +Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). + +### s + + + +`RawFeatureVector.s(qubit)` + +Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). + +### save\_amplitudes + + + +`RawFeatureVector.save_amplitudes(params, label='amplitudes', pershot=False, conditional=False)` + +Save complex statevector amplitudes. + +**Parameters** + +* **params** (*List\[int] or List\[str]*) – the basis states to return amplitudes for. +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of amplitudes vectors for each shot of the simulation rather than the a single amplitude vector \[Default: False]. +* **conditional** (*bool*) – if True save the amplitudes vector conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if params is invalid for the specified number of qubits. + +### save\_amplitudes\_squared + + + +`RawFeatureVector.save_amplitudes_squared(params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` + +Save squared statevector amplitudes (probabilities). + +**Parameters** + +* **params** (*List\[int] or List\[str]*) – the basis states to return amplitudes for. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated probabilities over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of probability vectors for each shot of the simulation rather than the a single amplitude vector \[Default: False]. +* **conditional** (*bool*) – if True save the probability vector conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if params is invalid for the specified number of qubits. + +### save\_density\_matrix + + + +`RawFeatureVector.save_density_matrix(qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` + +Save the current simulator quantum state as a density matrix. + +**Parameters** + +* **qubits** (*list or None*) – the qubits to save reduced density matrix on. If None the full density matrix of qubits will be saved \[Default: None]. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated density matrix over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of density matrices for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the average or pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_expectation\_value + + + +`RawFeatureVector.save_expectation_value(operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` + +Save the expectation value of a Hermitian operator. + +**Parameters** + +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **qubits** (*list*) – circuit qubits to apply instruction. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value over all shot \[Default: False]. +* **pershot** (*bool*) – if True save a list of expectation values for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the average or pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if the input operator is invalid or not Hermitian. + + + This method appends a `SaveExpectationValue` instruction to the quantum circuit. + + +### save\_expectation\_value\_variance + + + +`RawFeatureVector.save_expectation_value_variance(operator, qubits, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` + +Save the expectation value of a Hermitian operator. + +**Parameters** + +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **qubits** (*list*) – circuit qubits to apply instruction. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value and variance over all shot \[Default: False]. +* **pershot** (*bool*) – if True save a list of expectation values and variances for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if the input operator is invalid or not Hermitian. + + + This method appends a `SaveExpectationValueVariance` instruction to the quantum circuit. + + +### save\_matrix\_product\_state + + + +`RawFeatureVector.save_matrix_product_state(label='matrix_product_state', pershot=False, conditional=False)` + +Save the current simulator quantum state as a matrix product state. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save the mps for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_probabilities + + + +`RawFeatureVector.save_probabilities(qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` + +Save measurement outcome probabilities vector. + +**Parameters** + +* **qubits** (*list or None*) – the qubits to apply snapshot to. If None all qubits will be snapshot \[Default: None]. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated probabilities over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of probabilities for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the probabilities data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_probabilities\_dict + + + +`RawFeatureVector.save_probabilities_dict(qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` + +Save measurement outcome probabilities vector. + +**Parameters** + +* **qubits** (*list or None*) – the qubits to apply snapshot to. If None all qubits will be snapshot \[Default: None]. +* **label** (*str*) – the key for retrieving saved data from results. +* **unnormalized** (*bool*) – If True return save the unnormalized accumulated probabilities over all shots \[Default: False]. +* **pershot** (*bool*) – if True save a list of probabilities for each shot of the simulation rather than the average over all shots \[Default: False]. +* **conditional** (*bool*) – if True save the probabilities data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_stabilizer + + + +`RawFeatureVector.save_stabilizer(label='stabilizer', pershot=False, conditional=False)` + +Save the current stabilizer simulator quantum state as a Clifford. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of Cliffords for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_state + + + +`RawFeatureVector.save_state(label=None, pershot=False, conditional=False)` + +Save the current simulator quantum state. + +**Parameters** + +* **label** (*str or None*) – Optional, the key for retrieving saved data from results. If None the key will be the state type of the simulator. +* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### save\_statevector + + + +`RawFeatureVector.save_statevector(label='statevector', pershot=False, conditional=False)` + +Save the current simulator quantum state as a statevector. + +**Parameters** + +* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation \[Default: False]. +* **label** (*str*) – the key for retrieving saved data from results. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_statevector\_dict + + + +`RawFeatureVector.save_statevector_dict(label='statevector', pershot=False, conditional=False)` + +Save the current simulator quantum state as a statevector as a dict. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of statevectors for each shot of the simulation \[Default: False]. +* **conditional** (*bool*) – if True save pershot data conditional on the current classical register values \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_superop + + + +`RawFeatureVector.save_superop(label='superop', pershot=False)` + +Save the current state of the superop simulator. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of SuperOp matrices for each shot of the simulation \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### save\_unitary + + + +`RawFeatureVector.save_unitary(label='unitary', pershot=False)` + +Save the current state of the unitary simulator. + +**Parameters** + +* **label** (*str*) – the key for retrieving saved data from results. +* **pershot** (*bool*) – if True save a list of unitaries for each shot of the simulation \[Default: False]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + + + This instruction is always defined across all qubits in a circuit. + + +### sdg + + + +`RawFeatureVector.sdg(qubit)` + +Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). + +### set\_density\_matrix + + + +`RawFeatureVector.set_density_matrix(state)` + +Set the density matrix state of the simulator. + +**Parameters** + +**state** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a density matrix. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the density matrix is the incorrect size for the current circuit. + +### set\_matrix\_product\_state + + + +`RawFeatureVector.set_matrix_product_state(state)` + +Set the matrix product state of the simulator. + +**Parameters** + +**state** (*Tuple\[List\[Tuple\[np.array\[complex\_t]]]], List\[List\[float]]*) – A matrix\_product\_state. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the structure of the state is incorrect + +### set\_stabilizer + + + +`RawFeatureVector.set_stabilizer(state)` + +Set the Clifford stabilizer state of the simulator. + +**Parameters** + +**state** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – A clifford operator. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the state is the incorrect size for the current circuit. + +### set\_statevector + + + +`RawFeatureVector.set_statevector(state)` + +Set the statevector state of the simulator. + +**Parameters** + +**state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – A state matrix. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – If the state is the incorrect size for the current circuit. + +### set\_superop + + + +`RawFeatureVector.set_superop(state)` + +Set the superop state of the simulator. + +**Parameters** + +**state** (*QuantumChannel*) – A CPTP quantum channel. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **ExtensionError** – If the state is the incorrect size for the current circuit. +* **ExtensionError** – if the input QuantumChannel is not CPTP. + +### set\_unitary + + + +`RawFeatureVector.set_unitary(state)` + +Set the state state of the simulator. + +**Parameters** + +**state** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – A state matrix. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +* **ExtensionError** – If the state is the incorrect size for the current circuit. +* **ExtensionError** – if the input matrix is not unitary. + +### size + + + +`RawFeatureVector.size()` + +Returns total number of gate operations in circuit. + +**Returns** + +Total number of gate operations. + +**Return type** + +int + +### snapshot + + + +`RawFeatureVector.snapshot(label, snapshot_type='statevector', qubits=None, params=None)` + +Take a statevector snapshot of the internal simulator representation. Works on all qubits, and prevents reordering (like barrier). :param label: a snapshot label to report the result :type label: str :param snapshot\_type: the type of the snapshot. :type snapshot\_type: str :param qubits: the qubits to apply snapshot to \[Default: None]. :type qubits: list or None :param params: the parameters for snapshot\_type \[Default: None]. :type params: list or None + +**Returns** + +with attached command + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – malformed command + +### snapshot\_density\_matrix + + + +`RawFeatureVector.snapshot_density_matrix(label, qubits=None)` + +Take a density matrix snapshot of simulator state. + +**Parameters** + +* **label** (*str*) – a snapshot label to report the result +* **qubits** (*list or None*) – the qubits to apply snapshot to. If None all qubits will be snapshot \[Default: None]. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_density_matrix`](qiskit.providers.aer.library.save_density_matrix "qiskit.providers.aer.library.save_density_matrix") circuit method. + + +### snapshot\_expectation\_value + + + +`RawFeatureVector.snapshot_expectation_value(label, op, qubits, single_shot=False, variance=False)` + +Take a snapshot of expectation value \ of an Operator. + +**Parameters** + +* **label** (*str*) – a snapshot label to report the result +* **op** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – operator to snapshot +* **qubits** (*list*) – the qubits to snapshot. +* **single\_shot** (*bool*) – return list for each shot rather than average \[Default: False] +* **variance** (*bool*) – compute variance of values \[Default: False] + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_expectation_value()`](qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value") and [`qiskit.providers.aer.library.save_expectation_value_variance()`](qiskit.providers.aer.library.save_expectation_value_variance "qiskit.providers.aer.library.save_expectation_value_variance") circuit methods. + + +### snapshot\_probabilities + + + +`RawFeatureVector.snapshot_probabilities(label, qubits, variance=False)` + +Take a probability snapshot of the simulator state. + +**Parameters** + +* **label** (*str*) – a snapshot label to report the result +* **qubits** (*list*) – the qubits to snapshot. +* **variance** (*bool*) – compute variance of probabilities \[Default: False] + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_probabilities()`](qiskit.providers.aer.library.save_probabilities "qiskit.providers.aer.library.save_probabilities") and [`qiskit.providers.aer.library.save_probabilities_dict()`](qiskit.providers.aer.library.save_probabilities_dict "qiskit.providers.aer.library.save_probabilities_dict") circuit methods. + + +### snapshot\_stabilizer + + + +`RawFeatureVector.snapshot_stabilizer(label)` + +Take a stabilizer snapshot of the simulator state. + +**Parameters** + +**label** (*str*) – a snapshot label to report the result. + +**Returns** +with attached instruction. -`RawFeatureVector(feature_dimension)` +**Return type** -Bases: `qiskit.circuit.library.blueprintcircuit.BlueprintCircuit` +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") -The raw feature vector circuit. +**Raises** -This circuit acts as parameterized initialization for statevectors with `feature_dimension` dimensions, thus with `log2(feature_dimension)` qubits. As long as there are free parameters, this circuit holds a placeholder instruction and can not be decomposed. Once all parameters are bound, the placeholder is replaced by a state initialization and can be unrolled. +**ExtensionError** – if snapshot is invalid. -In ML, this circuit can be used to load the training data into qubit amplitudes. It does not apply an kernel transformation. (Therefore, it is a “raw” feature vector.) +#### Additional Information: -Examples: +This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_stabilizer()`](qiskit.providers.aer.library.save_stabilizer "qiskit.providers.aer.library.save_stabilizer") circuit method. + + +### snapshot\_statevector + + + +`RawFeatureVector.snapshot_statevector(label)` + +Take a statevector snapshot of the simulator state. + +**Parameters** + +**label** (*str*) – a snapshot label to report the result. + +**Returns** + +with attached instruction. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**ExtensionError** – if snapshot is invalid. + +#### Additional Information: + +This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit. + + + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.save_statevector`](qiskit.providers.aer.library.save_statevector "qiskit.providers.aer.library.save_statevector") circuit method. + + +### squ + + + +`RawFeatureVector.squ(unitary_matrix, qubit, mode='ZYZ', up_to_diagonal=False, *, u=None)` + +Decompose an arbitrary 2\*2 unitary into three rotation gates. + +Note that the decomposition is up to a global phase shift. (This is a well known decomposition, which can be found for example in Nielsen and Chuang’s book “Quantum computation and quantum information”.) + +**Parameters** + +* **unitary\_matrix** (*ndarray*) – 2\*2 unitary (given as a (complex) ndarray). +* **qubit** (*QuantumRegister | Qubit*) – The qubit which the gate is acting on. +* **mode** (*string*) – determines the used decomposition by providing the rotation axes. The allowed modes are: “ZYZ” (default) +* **up\_to\_diagonal** (*bool*) – if set to True, the single-qubit unitary is decomposed up to a diagonal matrix, i.e. a unitary u’ is implemented such that there exists a 2\*2 diagonal gate d with u = d.dot(u’) +* **u** (*ndarray*) – Deprecated, use `unitary_matrix` instead. + +**Returns** + +The single-qubit unitary instruction attached to the circuit. + +**Return type** + +[InstructionSet](qiskit.circuit.InstructionSet "qiskit.circuit.InstructionSet") + +**Raises** + +**QiskitError** – if the format is wrong; if the array u is not unitary + +### swap + + + +`RawFeatureVector.swap(qubit1, qubit2)` + +Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). + +### sx + + + +`RawFeatureVector.sx(qubit)` + +Apply [`SXGate`](qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). + +### sxdg + + + +`RawFeatureVector.sxdg(qubit)` + +Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). + +### t + + + +`RawFeatureVector.t(qubit)` + +Apply [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). + +### tdg + + + +`RawFeatureVector.tdg(qubit)` + +Apply [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). + +### tensor + + + +`RawFeatureVector.tensor(other, inplace=False)` + +Tensor `self` with `other`. + +Remember that in the little-endian convention the leftmost operation will be at the bottom of the circuit. See also \[the docs]\(qiskit.org/documentation/tutorials/circuits/3\_summary\_of\_quantum\_operations.html) for more information. ```python -from qiskit.ml.circuit.library import RawFeatureVector -circuit = RawFeatureVector(4) -print(circuit.num_qubits) -# prints: 2 + ┌────────┐ ┌─────┐ ┌─────┐ +q_0: ┤ bottom ├ ⊗ q_0: ┤ top ├ = q_0: ─┤ top ├── + └────────┘ └─────┘ ┌┴─────┴─┐ + q_1: ┤ bottom ├ + └────────┘ +``` -print(circuit.draw(output='text')) -# prints: -# ┌──────┐ -# q_0: ┤0 ├ -# │ Raw │ -# q_1: ┤1 ├ -# └──────┘ +**Parameters** -print(circuit.ordered_parameters) -# prints: [Parameter(p[0]), Parameter(p[1]), Parameter(p[2]), Parameter(p[3])] +* **other** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The other circuit to tensor this circuit with. +* **inplace** (*bool*) – If True, modify the object. Otherwise return composed circuit. -import numpy as np -state = np.array([1, 0, 0, 1]) / np.sqrt(2) -bound = circuit.assign_parameters(state) -print(bound.draw()) -# prints: -# ┌──────────────────────────────────┐ -# q_0: ┤0 ├ -# │ initialize(0.70711,0,0,0.70711) │ -# q_1: ┤1 ├ -# └──────────────────────────────────┘ +#### Examples + +```python +from qiskit import QuantumCircuit +top = QuantumCircuit(1) +top.x(0); +bottom = QuantumCircuit(2) +bottom.cry(0.2, 0, 1); +tensored = bottom.tensor(top) +print(tensored.draw()) +``` + +```python + ┌───┐ +q_0: ───┤ X ├─── + └───┘ +q_1: ─────■───── + ┌────┴────┐ +q_2: ┤ Ry(0.2) ├ + └─────────┘ ``` +**Returns** + +The tensored circuit (returns None if inplace==True). + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +### to\_gate + + + +`RawFeatureVector.to_gate(parameter_map=None, label=None)` + +Create a Gate out of this circuit. + **Parameters** -**feature\_dimension** (`Optional`\[`int`]) – The feature dimension and number of qubits. +* **parameter\_map** (*dict*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the gate. If None, existing circuit parameters will also parameterize the gate. +* **label** (*str*) – Optional gate label. -## Methods +**Returns** -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| [`add_bits`](qiskit.ml.circuit.library.RawFeatureVector.add_bits#qiskit.ml.circuit.library.RawFeatureVector.add_bits "qiskit.ml.circuit.library.RawFeatureVector.add_bits") | Add Bits to the circuit. | -| [`add_calibration`](qiskit.ml.circuit.library.RawFeatureVector.add_calibration#qiskit.ml.circuit.library.RawFeatureVector.add_calibration "qiskit.ml.circuit.library.RawFeatureVector.add_calibration") | Register a low-level, custom pulse definition for the given gate. | -| [`add_register`](qiskit.ml.circuit.library.RawFeatureVector.add_register#qiskit.ml.circuit.library.RawFeatureVector.add_register "qiskit.ml.circuit.library.RawFeatureVector.add_register") | Add registers. | -| [`append`](qiskit.ml.circuit.library.RawFeatureVector.append#qiskit.ml.circuit.library.RawFeatureVector.append "qiskit.ml.circuit.library.RawFeatureVector.append") | Append one or more instructions to the end of the circuit, modifying the circuit in place. | -| [`assign_parameters`](qiskit.ml.circuit.library.RawFeatureVector.assign_parameters#qiskit.ml.circuit.library.RawFeatureVector.assign_parameters "qiskit.ml.circuit.library.RawFeatureVector.assign_parameters") | Call the initialize instruction. | -| [`barrier`](qiskit.ml.circuit.library.RawFeatureVector.barrier#qiskit.ml.circuit.library.RawFeatureVector.barrier "qiskit.ml.circuit.library.RawFeatureVector.barrier") | Apply `Barrier`. | -| [`bind_parameters`](qiskit.ml.circuit.library.RawFeatureVector.bind_parameters#qiskit.ml.circuit.library.RawFeatureVector.bind_parameters "qiskit.ml.circuit.library.RawFeatureVector.bind_parameters") | Bind parameters. | -| [`cast`](qiskit.ml.circuit.library.RawFeatureVector.cast#qiskit.ml.circuit.library.RawFeatureVector.cast "qiskit.ml.circuit.library.RawFeatureVector.cast") | Best effort to cast value to type. | -| [`cbit_argument_conversion`](qiskit.ml.circuit.library.RawFeatureVector.cbit_argument_conversion#qiskit.ml.circuit.library.RawFeatureVector.cbit_argument_conversion "qiskit.ml.circuit.library.RawFeatureVector.cbit_argument_conversion") | Converts several classical bit representations (such as indexes, range, etc.) into a list of classical bits. | -| [`ccx`](qiskit.ml.circuit.library.RawFeatureVector.ccx#qiskit.ml.circuit.library.RawFeatureVector.ccx "qiskit.ml.circuit.library.RawFeatureVector.ccx") | Apply [`CCXGate`](qiskit.circuit.library.CCXGate#qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). | -| [`ch`](qiskit.ml.circuit.library.RawFeatureVector.ch#qiskit.ml.circuit.library.RawFeatureVector.ch "qiskit.ml.circuit.library.RawFeatureVector.ch") | Apply [`CHGate`](qiskit.circuit.library.CHGate#qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate"). | -| [`cls_instances`](qiskit.ml.circuit.library.RawFeatureVector.cls_instances#qiskit.ml.circuit.library.RawFeatureVector.cls_instances "qiskit.ml.circuit.library.RawFeatureVector.cls_instances") | Return the current number of instances of this class, useful for auto naming. | -| [`cls_prefix`](qiskit.ml.circuit.library.RawFeatureVector.cls_prefix#qiskit.ml.circuit.library.RawFeatureVector.cls_prefix "qiskit.ml.circuit.library.RawFeatureVector.cls_prefix") | Return the prefix to use for auto naming. | -| [`cnot`](qiskit.ml.circuit.library.RawFeatureVector.cnot#qiskit.ml.circuit.library.RawFeatureVector.cnot "qiskit.ml.circuit.library.RawFeatureVector.cnot") | Apply [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). | -| [`combine`](qiskit.ml.circuit.library.RawFeatureVector.combine#qiskit.ml.circuit.library.RawFeatureVector.combine "qiskit.ml.circuit.library.RawFeatureVector.combine") | DEPRECATED - Returns rhs appended to self if self contains compatible registers. | -| [`compose`](qiskit.ml.circuit.library.RawFeatureVector.compose#qiskit.ml.circuit.library.RawFeatureVector.compose "qiskit.ml.circuit.library.RawFeatureVector.compose") | Compose circuit with `other` circuit or instruction, optionally permuting wires. | -| [`control`](qiskit.ml.circuit.library.RawFeatureVector.control#qiskit.ml.circuit.library.RawFeatureVector.control "qiskit.ml.circuit.library.RawFeatureVector.control") | Control this circuit on `num_ctrl_qubits` qubits. | -| [`copy`](qiskit.ml.circuit.library.RawFeatureVector.copy#qiskit.ml.circuit.library.RawFeatureVector.copy "qiskit.ml.circuit.library.RawFeatureVector.copy") | Copy the circuit. | -| [`count_ops`](qiskit.ml.circuit.library.RawFeatureVector.count_ops#qiskit.ml.circuit.library.RawFeatureVector.count_ops "qiskit.ml.circuit.library.RawFeatureVector.count_ops") | Count each operation kind in the circuit. | -| [`cp`](qiskit.ml.circuit.library.RawFeatureVector.cp#qiskit.ml.circuit.library.RawFeatureVector.cp "qiskit.ml.circuit.library.RawFeatureVector.cp") | Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate#qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate"). | -| [`crx`](qiskit.ml.circuit.library.RawFeatureVector.crx#qiskit.ml.circuit.library.RawFeatureVector.crx "qiskit.ml.circuit.library.RawFeatureVector.crx") | Apply [`CRXGate`](qiskit.circuit.library.CRXGate#qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate"). | -| [`cry`](qiskit.ml.circuit.library.RawFeatureVector.cry#qiskit.ml.circuit.library.RawFeatureVector.cry "qiskit.ml.circuit.library.RawFeatureVector.cry") | Apply [`CRYGate`](qiskit.circuit.library.CRYGate#qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate"). | -| [`crz`](qiskit.ml.circuit.library.RawFeatureVector.crz#qiskit.ml.circuit.library.RawFeatureVector.crz "qiskit.ml.circuit.library.RawFeatureVector.crz") | Apply [`CRZGate`](qiskit.circuit.library.CRZGate#qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate"). | -| [`cswap`](qiskit.ml.circuit.library.RawFeatureVector.cswap#qiskit.ml.circuit.library.RawFeatureVector.cswap "qiskit.ml.circuit.library.RawFeatureVector.cswap") | Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate#qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). | -| [`csx`](qiskit.ml.circuit.library.RawFeatureVector.csx#qiskit.ml.circuit.library.RawFeatureVector.csx "qiskit.ml.circuit.library.RawFeatureVector.csx") | Apply [`CSXGate`](qiskit.circuit.library.CSXGate#qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate"). | -| [`cu`](qiskit.ml.circuit.library.RawFeatureVector.cu#qiskit.ml.circuit.library.RawFeatureVector.cu "qiskit.ml.circuit.library.RawFeatureVector.cu") | Apply [`CUGate`](qiskit.circuit.library.CUGate#qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate"). | -| [`cu1`](qiskit.ml.circuit.library.RawFeatureVector.cu1#qiskit.ml.circuit.library.RawFeatureVector.cu1 "qiskit.ml.circuit.library.RawFeatureVector.cu1") | Apply [`CU1Gate`](qiskit.circuit.library.CU1Gate#qiskit.circuit.library.CU1Gate "qiskit.circuit.library.CU1Gate"). | -| [`cu3`](qiskit.ml.circuit.library.RawFeatureVector.cu3#qiskit.ml.circuit.library.RawFeatureVector.cu3 "qiskit.ml.circuit.library.RawFeatureVector.cu3") | Apply [`CU3Gate`](qiskit.circuit.library.CU3Gate#qiskit.circuit.library.CU3Gate "qiskit.circuit.library.CU3Gate"). | -| [`cx`](qiskit.ml.circuit.library.RawFeatureVector.cx#qiskit.ml.circuit.library.RawFeatureVector.cx "qiskit.ml.circuit.library.RawFeatureVector.cx") | Apply [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"). | -| [`cy`](qiskit.ml.circuit.library.RawFeatureVector.cy#qiskit.ml.circuit.library.RawFeatureVector.cy "qiskit.ml.circuit.library.RawFeatureVector.cy") | Apply [`CYGate`](qiskit.circuit.library.CYGate#qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate"). | -| [`cz`](qiskit.ml.circuit.library.RawFeatureVector.cz#qiskit.ml.circuit.library.RawFeatureVector.cz "qiskit.ml.circuit.library.RawFeatureVector.cz") | Apply [`CZGate`](qiskit.circuit.library.CZGate#qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"). | -| [`dcx`](qiskit.ml.circuit.library.RawFeatureVector.dcx#qiskit.ml.circuit.library.RawFeatureVector.dcx "qiskit.ml.circuit.library.RawFeatureVector.dcx") | Apply [`DCXGate`](qiskit.circuit.library.DCXGate#qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate"). | -| [`decompose`](qiskit.ml.circuit.library.RawFeatureVector.decompose#qiskit.ml.circuit.library.RawFeatureVector.decompose "qiskit.ml.circuit.library.RawFeatureVector.decompose") | Call a decomposition pass on this circuit, to decompose one level (shallow decompose). | -| [`delay`](qiskit.ml.circuit.library.RawFeatureVector.delay#qiskit.ml.circuit.library.RawFeatureVector.delay "qiskit.ml.circuit.library.RawFeatureVector.delay") | Apply [`Delay`](qiskit.circuit.Delay#qiskit.circuit.Delay "qiskit.circuit.Delay"). | -| [`depth`](qiskit.ml.circuit.library.RawFeatureVector.depth#qiskit.ml.circuit.library.RawFeatureVector.depth "qiskit.ml.circuit.library.RawFeatureVector.depth") | Return circuit depth (i.e., length of critical path). | -| [`diagonal`](qiskit.ml.circuit.library.RawFeatureVector.diagonal#qiskit.ml.circuit.library.RawFeatureVector.diagonal "qiskit.ml.circuit.library.RawFeatureVector.diagonal") | Attach a diagonal gate to a circuit. | -| [`draw`](qiskit.ml.circuit.library.RawFeatureVector.draw#qiskit.ml.circuit.library.RawFeatureVector.draw "qiskit.ml.circuit.library.RawFeatureVector.draw") | Draw the quantum circuit. | -| [`ecr`](qiskit.ml.circuit.library.RawFeatureVector.ecr#qiskit.ml.circuit.library.RawFeatureVector.ecr "qiskit.ml.circuit.library.RawFeatureVector.ecr") | Apply [`ECRGate`](qiskit.circuit.library.ECRGate#qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate"). | -| [`extend`](qiskit.ml.circuit.library.RawFeatureVector.extend#qiskit.ml.circuit.library.RawFeatureVector.extend "qiskit.ml.circuit.library.RawFeatureVector.extend") | DEPRECATED - Append QuantumCircuit to the RHS if it contains compatible registers. | -| [`fredkin`](qiskit.ml.circuit.library.RawFeatureVector.fredkin#qiskit.ml.circuit.library.RawFeatureVector.fredkin "qiskit.ml.circuit.library.RawFeatureVector.fredkin") | Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate#qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate"). | -| [`from_qasm_file`](qiskit.ml.circuit.library.RawFeatureVector.from_qasm_file#qiskit.ml.circuit.library.RawFeatureVector.from_qasm_file "qiskit.ml.circuit.library.RawFeatureVector.from_qasm_file") | Take in a QASM file and generate a QuantumCircuit object. | -| [`from_qasm_str`](qiskit.ml.circuit.library.RawFeatureVector.from_qasm_str#qiskit.ml.circuit.library.RawFeatureVector.from_qasm_str "qiskit.ml.circuit.library.RawFeatureVector.from_qasm_str") | Take in a QASM string and generate a QuantumCircuit object. | -| [`get_instructions`](qiskit.ml.circuit.library.RawFeatureVector.get_instructions#qiskit.ml.circuit.library.RawFeatureVector.get_instructions "qiskit.ml.circuit.library.RawFeatureVector.get_instructions") | Get instructions matching name. | -| [`h`](qiskit.ml.circuit.library.RawFeatureVector.h#qiskit.ml.circuit.library.RawFeatureVector.h "qiskit.ml.circuit.library.RawFeatureVector.h") | Apply [`HGate`](qiskit.circuit.library.HGate#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"). | -| [`hamiltonian`](qiskit.ml.circuit.library.RawFeatureVector.hamiltonian#qiskit.ml.circuit.library.RawFeatureVector.hamiltonian "qiskit.ml.circuit.library.RawFeatureVector.hamiltonian") | Apply hamiltonian evolution to qubits. | -| [`has_register`](qiskit.ml.circuit.library.RawFeatureVector.has_register#qiskit.ml.circuit.library.RawFeatureVector.has_register "qiskit.ml.circuit.library.RawFeatureVector.has_register") | Test if this circuit has the register r. | -| [`i`](qiskit.ml.circuit.library.RawFeatureVector.i#qiskit.ml.circuit.library.RawFeatureVector.i "qiskit.ml.circuit.library.RawFeatureVector.i") | Apply [`IGate`](qiskit.circuit.library.IGate#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). | -| [`id`](qiskit.ml.circuit.library.RawFeatureVector.id#qiskit.ml.circuit.library.RawFeatureVector.id "qiskit.ml.circuit.library.RawFeatureVector.id") | Apply [`IGate`](qiskit.circuit.library.IGate#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"). | -| [`initialize`](qiskit.ml.circuit.library.RawFeatureVector.initialize#qiskit.ml.circuit.library.RawFeatureVector.initialize "qiskit.ml.circuit.library.RawFeatureVector.initialize") | Initialize qubits in a specific state. | -| [`inverse`](qiskit.ml.circuit.library.RawFeatureVector.inverse#qiskit.ml.circuit.library.RawFeatureVector.inverse "qiskit.ml.circuit.library.RawFeatureVector.inverse") | Invert (take adjoint of) this circuit. | -| [`iso`](qiskit.ml.circuit.library.RawFeatureVector.iso#qiskit.ml.circuit.library.RawFeatureVector.iso "qiskit.ml.circuit.library.RawFeatureVector.iso") | Attach an arbitrary isometry from m to n qubits to a circuit. | -| [`isometry`](qiskit.ml.circuit.library.RawFeatureVector.isometry#qiskit.ml.circuit.library.RawFeatureVector.isometry "qiskit.ml.circuit.library.RawFeatureVector.isometry") | Attach an arbitrary isometry from m to n qubits to a circuit. | -| [`iswap`](qiskit.ml.circuit.library.RawFeatureVector.iswap#qiskit.ml.circuit.library.RawFeatureVector.iswap "qiskit.ml.circuit.library.RawFeatureVector.iswap") | Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate#qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate"). | -| [`mcp`](qiskit.ml.circuit.library.RawFeatureVector.mcp#qiskit.ml.circuit.library.RawFeatureVector.mcp "qiskit.ml.circuit.library.RawFeatureVector.mcp") | Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate#qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate"). | -| [`mcrx`](qiskit.ml.circuit.library.RawFeatureVector.mcrx#qiskit.ml.circuit.library.RawFeatureVector.mcrx "qiskit.ml.circuit.library.RawFeatureVector.mcrx") | Apply Multiple-Controlled X rotation gate | -| [`mcry`](qiskit.ml.circuit.library.RawFeatureVector.mcry#qiskit.ml.circuit.library.RawFeatureVector.mcry "qiskit.ml.circuit.library.RawFeatureVector.mcry") | Apply Multiple-Controlled Y rotation gate | -| [`mcrz`](qiskit.ml.circuit.library.RawFeatureVector.mcrz#qiskit.ml.circuit.library.RawFeatureVector.mcrz "qiskit.ml.circuit.library.RawFeatureVector.mcrz") | Apply Multiple-Controlled Z rotation gate | -| [`mct`](qiskit.ml.circuit.library.RawFeatureVector.mct#qiskit.ml.circuit.library.RawFeatureVector.mct "qiskit.ml.circuit.library.RawFeatureVector.mct") | Apply [`MCXGate`](qiskit.circuit.library.MCXGate#qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). | -| [`mcu1`](qiskit.ml.circuit.library.RawFeatureVector.mcu1#qiskit.ml.circuit.library.RawFeatureVector.mcu1 "qiskit.ml.circuit.library.RawFeatureVector.mcu1") | Apply `MCU1Gate`. | -| [`mcx`](qiskit.ml.circuit.library.RawFeatureVector.mcx#qiskit.ml.circuit.library.RawFeatureVector.mcx "qiskit.ml.circuit.library.RawFeatureVector.mcx") | Apply [`MCXGate`](qiskit.circuit.library.MCXGate#qiskit.circuit.library.MCXGate "qiskit.circuit.library.MCXGate"). | -| [`measure`](qiskit.ml.circuit.library.RawFeatureVector.measure#qiskit.ml.circuit.library.RawFeatureVector.measure "qiskit.ml.circuit.library.RawFeatureVector.measure") | Measure quantum bit into classical bit (tuples). | -| [`measure_active`](qiskit.ml.circuit.library.RawFeatureVector.measure_active#qiskit.ml.circuit.library.RawFeatureVector.measure_active "qiskit.ml.circuit.library.RawFeatureVector.measure_active") | Adds measurement to all non-idle qubits. | -| [`measure_all`](qiskit.ml.circuit.library.RawFeatureVector.measure_all#qiskit.ml.circuit.library.RawFeatureVector.measure_all "qiskit.ml.circuit.library.RawFeatureVector.measure_all") | Adds measurement to all qubits. | -| [`ms`](qiskit.ml.circuit.library.RawFeatureVector.ms#qiskit.ml.circuit.library.RawFeatureVector.ms "qiskit.ml.circuit.library.RawFeatureVector.ms") | Apply [`MSGate`](qiskit.circuit.library.MSGate#qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate"). | -| [`num_connected_components`](qiskit.ml.circuit.library.RawFeatureVector.num_connected_components#qiskit.ml.circuit.library.RawFeatureVector.num_connected_components "qiskit.ml.circuit.library.RawFeatureVector.num_connected_components") | How many non-entangled subcircuits can the circuit be factored to. | -| [`num_nonlocal_gates`](qiskit.ml.circuit.library.RawFeatureVector.num_nonlocal_gates#qiskit.ml.circuit.library.RawFeatureVector.num_nonlocal_gates "qiskit.ml.circuit.library.RawFeatureVector.num_nonlocal_gates") | Return number of non-local gates (i.e. | -| [`num_tensor_factors`](qiskit.ml.circuit.library.RawFeatureVector.num_tensor_factors#qiskit.ml.circuit.library.RawFeatureVector.num_tensor_factors "qiskit.ml.circuit.library.RawFeatureVector.num_tensor_factors") | Computes the number of tensor factors in the unitary (quantum) part of the circuit only. | -| [`num_unitary_factors`](qiskit.ml.circuit.library.RawFeatureVector.num_unitary_factors#qiskit.ml.circuit.library.RawFeatureVector.num_unitary_factors "qiskit.ml.circuit.library.RawFeatureVector.num_unitary_factors") | Computes the number of tensor factors in the unitary (quantum) part of the circuit only. | -| [`p`](qiskit.ml.circuit.library.RawFeatureVector.p#qiskit.ml.circuit.library.RawFeatureVector.p "qiskit.ml.circuit.library.RawFeatureVector.p") | Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate#qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate"). | -| [`pauli`](qiskit.ml.circuit.library.RawFeatureVector.pauli#qiskit.ml.circuit.library.RawFeatureVector.pauli "qiskit.ml.circuit.library.RawFeatureVector.pauli") | Apply [`PauliGate`](qiskit.circuit.library.PauliGate#qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate"). | -| [`power`](qiskit.ml.circuit.library.RawFeatureVector.power#qiskit.ml.circuit.library.RawFeatureVector.power "qiskit.ml.circuit.library.RawFeatureVector.power") | Raise this circuit to the power of `power`. | -| [`qasm`](qiskit.ml.circuit.library.RawFeatureVector.qasm#qiskit.ml.circuit.library.RawFeatureVector.qasm "qiskit.ml.circuit.library.RawFeatureVector.qasm") | Return OpenQASM string. | -| [`qbit_argument_conversion`](qiskit.ml.circuit.library.RawFeatureVector.qbit_argument_conversion#qiskit.ml.circuit.library.RawFeatureVector.qbit_argument_conversion "qiskit.ml.circuit.library.RawFeatureVector.qbit_argument_conversion") | Converts several qubit representations (such as indexes, range, etc.) into a list of qubits. | -| [`qubit_duration`](qiskit.ml.circuit.library.RawFeatureVector.qubit_duration#qiskit.ml.circuit.library.RawFeatureVector.qubit_duration "qiskit.ml.circuit.library.RawFeatureVector.qubit_duration") | Return the duration between the start and stop time of the first and last instructions, excluding delays, over the supplied qubits. | -| [`qubit_start_time`](qiskit.ml.circuit.library.RawFeatureVector.qubit_start_time#qiskit.ml.circuit.library.RawFeatureVector.qubit_start_time "qiskit.ml.circuit.library.RawFeatureVector.qubit_start_time") | Return the start time of the first instruction, excluding delays, over the supplied qubits. | -| [`qubit_stop_time`](qiskit.ml.circuit.library.RawFeatureVector.qubit_stop_time#qiskit.ml.circuit.library.RawFeatureVector.qubit_stop_time "qiskit.ml.circuit.library.RawFeatureVector.qubit_stop_time") | Return the stop time of the last instruction, excluding delays, over the supplied qubits. | -| [`r`](qiskit.ml.circuit.library.RawFeatureVector.r#qiskit.ml.circuit.library.RawFeatureVector.r "qiskit.ml.circuit.library.RawFeatureVector.r") | Apply [`RGate`](qiskit.circuit.library.RGate#qiskit.circuit.library.RGate "qiskit.circuit.library.RGate"). | -| [`rcccx`](qiskit.ml.circuit.library.RawFeatureVector.rcccx#qiskit.ml.circuit.library.RawFeatureVector.rcccx "qiskit.ml.circuit.library.RawFeatureVector.rcccx") | Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate#qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate"). | -| [`rccx`](qiskit.ml.circuit.library.RawFeatureVector.rccx#qiskit.ml.circuit.library.RawFeatureVector.rccx "qiskit.ml.circuit.library.RawFeatureVector.rccx") | Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate#qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate"). | -| [`remove_final_measurements`](qiskit.ml.circuit.library.RawFeatureVector.remove_final_measurements#qiskit.ml.circuit.library.RawFeatureVector.remove_final_measurements "qiskit.ml.circuit.library.RawFeatureVector.remove_final_measurements") | Removes final measurement on all qubits if they are present. | -| [`repeat`](qiskit.ml.circuit.library.RawFeatureVector.repeat#qiskit.ml.circuit.library.RawFeatureVector.repeat "qiskit.ml.circuit.library.RawFeatureVector.repeat") | Repeat this circuit `reps` times. | -| [`reset`](qiskit.ml.circuit.library.RawFeatureVector.reset#qiskit.ml.circuit.library.RawFeatureVector.reset "qiskit.ml.circuit.library.RawFeatureVector.reset") | Reset q. | -| [`reverse_bits`](qiskit.ml.circuit.library.RawFeatureVector.reverse_bits#qiskit.ml.circuit.library.RawFeatureVector.reverse_bits "qiskit.ml.circuit.library.RawFeatureVector.reverse_bits") | Return a circuit with the opposite order of wires. | -| [`reverse_ops`](qiskit.ml.circuit.library.RawFeatureVector.reverse_ops#qiskit.ml.circuit.library.RawFeatureVector.reverse_ops "qiskit.ml.circuit.library.RawFeatureVector.reverse_ops") | Reverse the circuit by reversing the order of instructions. | -| [`rv`](qiskit.ml.circuit.library.RawFeatureVector.rv#qiskit.ml.circuit.library.RawFeatureVector.rv "qiskit.ml.circuit.library.RawFeatureVector.rv") | Apply [`RVGate`](qiskit.circuit.library.RVGate#qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate"). | -| [`rx`](qiskit.ml.circuit.library.RawFeatureVector.rx#qiskit.ml.circuit.library.RawFeatureVector.rx "qiskit.ml.circuit.library.RawFeatureVector.rx") | Apply [`RXGate`](qiskit.circuit.library.RXGate#qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate"). | -| [`rxx`](qiskit.ml.circuit.library.RawFeatureVector.rxx#qiskit.ml.circuit.library.RawFeatureVector.rxx "qiskit.ml.circuit.library.RawFeatureVector.rxx") | Apply [`RXXGate`](qiskit.circuit.library.RXXGate#qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate"). | -| [`ry`](qiskit.ml.circuit.library.RawFeatureVector.ry#qiskit.ml.circuit.library.RawFeatureVector.ry "qiskit.ml.circuit.library.RawFeatureVector.ry") | Apply [`RYGate`](qiskit.circuit.library.RYGate#qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate"). | -| [`ryy`](qiskit.ml.circuit.library.RawFeatureVector.ryy#qiskit.ml.circuit.library.RawFeatureVector.ryy "qiskit.ml.circuit.library.RawFeatureVector.ryy") | Apply [`RYYGate`](qiskit.circuit.library.RYYGate#qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate"). | -| [`rz`](qiskit.ml.circuit.library.RawFeatureVector.rz#qiskit.ml.circuit.library.RawFeatureVector.rz "qiskit.ml.circuit.library.RawFeatureVector.rz") | Apply [`RZGate`](qiskit.circuit.library.RZGate#qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate"). | -| [`rzx`](qiskit.ml.circuit.library.RawFeatureVector.rzx#qiskit.ml.circuit.library.RawFeatureVector.rzx "qiskit.ml.circuit.library.RawFeatureVector.rzx") | Apply [`RZXGate`](qiskit.circuit.library.RZXGate#qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate"). | -| [`rzz`](qiskit.ml.circuit.library.RawFeatureVector.rzz#qiskit.ml.circuit.library.RawFeatureVector.rzz "qiskit.ml.circuit.library.RawFeatureVector.rzz") | Apply [`RZZGate`](qiskit.circuit.library.RZZGate#qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate"). | -| [`s`](qiskit.ml.circuit.library.RawFeatureVector.s#qiskit.ml.circuit.library.RawFeatureVector.s "qiskit.ml.circuit.library.RawFeatureVector.s") | Apply [`SGate`](qiskit.circuit.library.SGate#qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"). | -| [`save_amplitudes`](qiskit.ml.circuit.library.RawFeatureVector.save_amplitudes#qiskit.ml.circuit.library.RawFeatureVector.save_amplitudes "qiskit.ml.circuit.library.RawFeatureVector.save_amplitudes") | Save complex statevector amplitudes. | -| [`save_amplitudes_squared`](qiskit.ml.circuit.library.RawFeatureVector.save_amplitudes_squared#qiskit.ml.circuit.library.RawFeatureVector.save_amplitudes_squared "qiskit.ml.circuit.library.RawFeatureVector.save_amplitudes_squared") | Save squared statevector amplitudes (probabilities). | -| [`save_density_matrix`](qiskit.ml.circuit.library.RawFeatureVector.save_density_matrix#qiskit.ml.circuit.library.RawFeatureVector.save_density_matrix "qiskit.ml.circuit.library.RawFeatureVector.save_density_matrix") | Save the current simulator quantum state as a density matrix. | -| [`save_expectation_value`](qiskit.ml.circuit.library.RawFeatureVector.save_expectation_value#qiskit.ml.circuit.library.RawFeatureVector.save_expectation_value "qiskit.ml.circuit.library.RawFeatureVector.save_expectation_value") | Save the expectation value of a Hermitian operator. | -| [`save_expectation_value_variance`](qiskit.ml.circuit.library.RawFeatureVector.save_expectation_value_variance#qiskit.ml.circuit.library.RawFeatureVector.save_expectation_value_variance "qiskit.ml.circuit.library.RawFeatureVector.save_expectation_value_variance") | Save the expectation value of a Hermitian operator. | -| [`save_matrix_product_state`](qiskit.ml.circuit.library.RawFeatureVector.save_matrix_product_state#qiskit.ml.circuit.library.RawFeatureVector.save_matrix_product_state "qiskit.ml.circuit.library.RawFeatureVector.save_matrix_product_state") | Save the current simulator quantum state as a matrix product state. | -| [`save_probabilities`](qiskit.ml.circuit.library.RawFeatureVector.save_probabilities#qiskit.ml.circuit.library.RawFeatureVector.save_probabilities "qiskit.ml.circuit.library.RawFeatureVector.save_probabilities") | Save measurement outcome probabilities vector. | -| [`save_probabilities_dict`](qiskit.ml.circuit.library.RawFeatureVector.save_probabilities_dict#qiskit.ml.circuit.library.RawFeatureVector.save_probabilities_dict "qiskit.ml.circuit.library.RawFeatureVector.save_probabilities_dict") | Save measurement outcome probabilities vector. | -| [`save_stabilizer`](qiskit.ml.circuit.library.RawFeatureVector.save_stabilizer#qiskit.ml.circuit.library.RawFeatureVector.save_stabilizer "qiskit.ml.circuit.library.RawFeatureVector.save_stabilizer") | Save the current stabilizer simulator quantum state as a Clifford. | -| [`save_state`](qiskit.ml.circuit.library.RawFeatureVector.save_state#qiskit.ml.circuit.library.RawFeatureVector.save_state "qiskit.ml.circuit.library.RawFeatureVector.save_state") | Save the current simulator quantum state. | -| [`save_statevector`](qiskit.ml.circuit.library.RawFeatureVector.save_statevector#qiskit.ml.circuit.library.RawFeatureVector.save_statevector "qiskit.ml.circuit.library.RawFeatureVector.save_statevector") | Save the current simulator quantum state as a statevector. | -| [`save_statevector_dict`](qiskit.ml.circuit.library.RawFeatureVector.save_statevector_dict#qiskit.ml.circuit.library.RawFeatureVector.save_statevector_dict "qiskit.ml.circuit.library.RawFeatureVector.save_statevector_dict") | Save the current simulator quantum state as a statevector as a dict. | -| [`save_superop`](qiskit.ml.circuit.library.RawFeatureVector.save_superop#qiskit.ml.circuit.library.RawFeatureVector.save_superop "qiskit.ml.circuit.library.RawFeatureVector.save_superop") | Save the current state of the superop simulator. | -| [`save_unitary`](qiskit.ml.circuit.library.RawFeatureVector.save_unitary#qiskit.ml.circuit.library.RawFeatureVector.save_unitary "qiskit.ml.circuit.library.RawFeatureVector.save_unitary") | Save the current state of the unitary simulator. | -| [`sdg`](qiskit.ml.circuit.library.RawFeatureVector.sdg#qiskit.ml.circuit.library.RawFeatureVector.sdg "qiskit.ml.circuit.library.RawFeatureVector.sdg") | Apply [`SdgGate`](qiskit.circuit.library.SdgGate#qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"). | -| [`set_density_matrix`](qiskit.ml.circuit.library.RawFeatureVector.set_density_matrix#qiskit.ml.circuit.library.RawFeatureVector.set_density_matrix "qiskit.ml.circuit.library.RawFeatureVector.set_density_matrix") | Set the density matrix state of the simulator. | -| [`set_matrix_product_state`](qiskit.ml.circuit.library.RawFeatureVector.set_matrix_product_state#qiskit.ml.circuit.library.RawFeatureVector.set_matrix_product_state "qiskit.ml.circuit.library.RawFeatureVector.set_matrix_product_state") | Set the matrix product state of the simulator. | -| [`set_stabilizer`](qiskit.ml.circuit.library.RawFeatureVector.set_stabilizer#qiskit.ml.circuit.library.RawFeatureVector.set_stabilizer "qiskit.ml.circuit.library.RawFeatureVector.set_stabilizer") | Set the Clifford stabilizer state of the simulator. | -| [`set_statevector`](qiskit.ml.circuit.library.RawFeatureVector.set_statevector#qiskit.ml.circuit.library.RawFeatureVector.set_statevector "qiskit.ml.circuit.library.RawFeatureVector.set_statevector") | Set the statevector state of the simulator. | -| [`set_superop`](qiskit.ml.circuit.library.RawFeatureVector.set_superop#qiskit.ml.circuit.library.RawFeatureVector.set_superop "qiskit.ml.circuit.library.RawFeatureVector.set_superop") | Set the superop state of the simulator. | -| [`set_unitary`](qiskit.ml.circuit.library.RawFeatureVector.set_unitary#qiskit.ml.circuit.library.RawFeatureVector.set_unitary "qiskit.ml.circuit.library.RawFeatureVector.set_unitary") | Set the state state of the simulator. | -| [`size`](qiskit.ml.circuit.library.RawFeatureVector.size#qiskit.ml.circuit.library.RawFeatureVector.size "qiskit.ml.circuit.library.RawFeatureVector.size") | Returns total number of gate operations in circuit. | -| [`snapshot`](qiskit.ml.circuit.library.RawFeatureVector.snapshot#qiskit.ml.circuit.library.RawFeatureVector.snapshot "qiskit.ml.circuit.library.RawFeatureVector.snapshot") | Take a statevector snapshot of the internal simulator representation. | -| [`snapshot_density_matrix`](qiskit.ml.circuit.library.RawFeatureVector.snapshot_density_matrix#qiskit.ml.circuit.library.RawFeatureVector.snapshot_density_matrix "qiskit.ml.circuit.library.RawFeatureVector.snapshot_density_matrix") | Take a density matrix snapshot of simulator state. | -| [`snapshot_expectation_value`](qiskit.ml.circuit.library.RawFeatureVector.snapshot_expectation_value#qiskit.ml.circuit.library.RawFeatureVector.snapshot_expectation_value "qiskit.ml.circuit.library.RawFeatureVector.snapshot_expectation_value") | Take a snapshot of expectation value \ of an Operator. | -| [`snapshot_probabilities`](qiskit.ml.circuit.library.RawFeatureVector.snapshot_probabilities#qiskit.ml.circuit.library.RawFeatureVector.snapshot_probabilities "qiskit.ml.circuit.library.RawFeatureVector.snapshot_probabilities") | Take a probability snapshot of the simulator state. | -| [`snapshot_stabilizer`](qiskit.ml.circuit.library.RawFeatureVector.snapshot_stabilizer#qiskit.ml.circuit.library.RawFeatureVector.snapshot_stabilizer "qiskit.ml.circuit.library.RawFeatureVector.snapshot_stabilizer") | Take a stabilizer snapshot of the simulator state. | -| [`snapshot_statevector`](qiskit.ml.circuit.library.RawFeatureVector.snapshot_statevector#qiskit.ml.circuit.library.RawFeatureVector.snapshot_statevector "qiskit.ml.circuit.library.RawFeatureVector.snapshot_statevector") | Take a statevector snapshot of the simulator state. | -| [`squ`](qiskit.ml.circuit.library.RawFeatureVector.squ#qiskit.ml.circuit.library.RawFeatureVector.squ "qiskit.ml.circuit.library.RawFeatureVector.squ") | Decompose an arbitrary 2\*2 unitary into three rotation gates. | -| [`swap`](qiskit.ml.circuit.library.RawFeatureVector.swap#qiskit.ml.circuit.library.RawFeatureVector.swap "qiskit.ml.circuit.library.RawFeatureVector.swap") | Apply [`SwapGate`](qiskit.circuit.library.SwapGate#qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). | -| [`sx`](qiskit.ml.circuit.library.RawFeatureVector.sx#qiskit.ml.circuit.library.RawFeatureVector.sx "qiskit.ml.circuit.library.RawFeatureVector.sx") | Apply [`SXGate`](qiskit.circuit.library.SXGate#qiskit.circuit.library.SXGate "qiskit.circuit.library.SXGate"). | -| [`sxdg`](qiskit.ml.circuit.library.RawFeatureVector.sxdg#qiskit.ml.circuit.library.RawFeatureVector.sxdg "qiskit.ml.circuit.library.RawFeatureVector.sxdg") | Apply [`SXdgGate`](qiskit.circuit.library.SXdgGate#qiskit.circuit.library.SXdgGate "qiskit.circuit.library.SXdgGate"). | -| [`t`](qiskit.ml.circuit.library.RawFeatureVector.t#qiskit.ml.circuit.library.RawFeatureVector.t "qiskit.ml.circuit.library.RawFeatureVector.t") | Apply [`TGate`](qiskit.circuit.library.TGate#qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"). | -| [`tdg`](qiskit.ml.circuit.library.RawFeatureVector.tdg#qiskit.ml.circuit.library.RawFeatureVector.tdg "qiskit.ml.circuit.library.RawFeatureVector.tdg") | Apply [`TdgGate`](qiskit.circuit.library.TdgGate#qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate"). | -| [`tensor`](qiskit.ml.circuit.library.RawFeatureVector.tensor#qiskit.ml.circuit.library.RawFeatureVector.tensor "qiskit.ml.circuit.library.RawFeatureVector.tensor") | Tensor `self` with `other`. | -| [`to_gate`](qiskit.ml.circuit.library.RawFeatureVector.to_gate#qiskit.ml.circuit.library.RawFeatureVector.to_gate "qiskit.ml.circuit.library.RawFeatureVector.to_gate") | Create a Gate out of this circuit. | -| [`to_instruction`](qiskit.ml.circuit.library.RawFeatureVector.to_instruction#qiskit.ml.circuit.library.RawFeatureVector.to_instruction "qiskit.ml.circuit.library.RawFeatureVector.to_instruction") | Create an Instruction out of this circuit. | -| [`toffoli`](qiskit.ml.circuit.library.RawFeatureVector.toffoli#qiskit.ml.circuit.library.RawFeatureVector.toffoli "qiskit.ml.circuit.library.RawFeatureVector.toffoli") | Apply [`CCXGate`](qiskit.circuit.library.CCXGate#qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). | -| [`u`](qiskit.ml.circuit.library.RawFeatureVector.u#qiskit.ml.circuit.library.RawFeatureVector.u "qiskit.ml.circuit.library.RawFeatureVector.u") | Apply [`UGate`](qiskit.circuit.library.UGate#qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). | -| [`u1`](qiskit.ml.circuit.library.RawFeatureVector.u1#qiskit.ml.circuit.library.RawFeatureVector.u1 "qiskit.ml.circuit.library.RawFeatureVector.u1") | Apply [`U1Gate`](qiskit.circuit.library.U1Gate#qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). | -| [`u2`](qiskit.ml.circuit.library.RawFeatureVector.u2#qiskit.ml.circuit.library.RawFeatureVector.u2 "qiskit.ml.circuit.library.RawFeatureVector.u2") | Apply [`U2Gate`](qiskit.circuit.library.U2Gate#qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). | -| [`u3`](qiskit.ml.circuit.library.RawFeatureVector.u3#qiskit.ml.circuit.library.RawFeatureVector.u3 "qiskit.ml.circuit.library.RawFeatureVector.u3") | Apply [`U3Gate`](qiskit.circuit.library.U3Gate#qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). | -| [`uc`](qiskit.ml.circuit.library.RawFeatureVector.uc#qiskit.ml.circuit.library.RawFeatureVector.uc "qiskit.ml.circuit.library.RawFeatureVector.uc") | Attach a uniformly controlled gates (also called multiplexed gates) to a circuit. | -| [`ucrx`](qiskit.ml.circuit.library.RawFeatureVector.ucrx#qiskit.ml.circuit.library.RawFeatureVector.ucrx "qiskit.ml.circuit.library.RawFeatureVector.ucrx") | Attach a uniformly controlled (also called multiplexed) Rx rotation gate to a circuit. | -| [`ucry`](qiskit.ml.circuit.library.RawFeatureVector.ucry#qiskit.ml.circuit.library.RawFeatureVector.ucry "qiskit.ml.circuit.library.RawFeatureVector.ucry") | Attach a uniformly controlled (also called multiplexed) Ry rotation gate to a circuit. | -| [`ucrz`](qiskit.ml.circuit.library.RawFeatureVector.ucrz#qiskit.ml.circuit.library.RawFeatureVector.ucrz "qiskit.ml.circuit.library.RawFeatureVector.ucrz") | Attach a uniformly controlled (also called multiplexed gates) Rz rotation gate to a circuit. | -| [`unitary`](qiskit.ml.circuit.library.RawFeatureVector.unitary#qiskit.ml.circuit.library.RawFeatureVector.unitary "qiskit.ml.circuit.library.RawFeatureVector.unitary") | Apply unitary gate to q. | -| [`width`](qiskit.ml.circuit.library.RawFeatureVector.width#qiskit.ml.circuit.library.RawFeatureVector.width "qiskit.ml.circuit.library.RawFeatureVector.width") | Return number of qubits plus clbits in circuit. | -| [`x`](qiskit.ml.circuit.library.RawFeatureVector.x#qiskit.ml.circuit.library.RawFeatureVector.x "qiskit.ml.circuit.library.RawFeatureVector.x") | Apply [`XGate`](qiskit.circuit.library.XGate#qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). | -| [`y`](qiskit.ml.circuit.library.RawFeatureVector.y#qiskit.ml.circuit.library.RawFeatureVector.y "qiskit.ml.circuit.library.RawFeatureVector.y") | Apply [`YGate`](qiskit.circuit.library.YGate#qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). | -| [`z`](qiskit.ml.circuit.library.RawFeatureVector.z#qiskit.ml.circuit.library.RawFeatureVector.z "qiskit.ml.circuit.library.RawFeatureVector.z") | Apply [`ZGate`](qiskit.circuit.library.ZGate#qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). | +a composite gate encapsulating this circuit (can be decomposed back) -## Attributes +**Return type** + +[Gate](qiskit.circuit.Gate "qiskit.circuit.Gate") + +### to\_instruction + + + +`RawFeatureVector.to_instruction(parameter_map=None, label=None)` + +Create an Instruction out of this circuit. + +**Parameters** + +* **parameter\_map** (*dict*) – For parameterized circuits, a mapping from parameters in the circuit to parameters to be used in the instruction. If None, existing circuit parameters will also parameterize the instruction. +* **label** (*str*) – Optional gate label. + +**Returns** + +a composite instruction encapsulating this circuit (can be decomposed back) + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### toffoli + + +`RawFeatureVector.toffoli(control_qubit1, control_qubit2, target_qubit)` +Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate"). + +### u + + + +`RawFeatureVector.u(theta, phi, lam, qubit)` + +Apply [`UGate`](qiskit.circuit.library.UGate "qiskit.circuit.library.UGate"). + +### u1 + + + +`RawFeatureVector.u1(theta, qubit)` + +Apply [`U1Gate`](qiskit.circuit.library.U1Gate "qiskit.circuit.library.U1Gate"). + +### u2 + + + +`RawFeatureVector.u2(phi, lam, qubit)` + +Apply [`U2Gate`](qiskit.circuit.library.U2Gate "qiskit.circuit.library.U2Gate"). + +### u3 + + + +`RawFeatureVector.u3(theta, phi, lam, qubit)` + +Apply [`U3Gate`](qiskit.circuit.library.U3Gate "qiskit.circuit.library.U3Gate"). + +### uc + + + +`RawFeatureVector.uc(gate_list, q_controls, q_target, up_to_diagonal=False)` + +Attach a uniformly controlled gates (also called multiplexed gates) to a circuit. + +The decomposition was introduced by Bergholm et al. in [https://arxiv.org/pdf/quant-ph/0410066.pdf](https://arxiv.org/pdf/quant-ph/0410066.pdf). + +**Parameters** + +* **gate\_list** (*list\[ndarray]*) – list of two qubit unitaries \[U\_0,…,U\_\{2^k-1}], where each single-qubit unitary U\_i is a given as a 2\*2 array +* **q\_controls** (*QuantumRegister|list\[(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,int)]*) – list of k control qubits. The qubits are ordered according to their significance in the computational basis. For example if q\_controls=\[q\[1],q\[2]] (with q = QuantumRegister(2)), the unitary U\_0 is performed if q\[1] and q\[2] are in the state zero, U\_1 is performed if q\[2] is in the state zero and q\[1] is in the state one, and so on +* **q\_target** (*QuantumRegister|(*[*QuantumRegister*](qiskit.circuit.QuantumRegister "qiskit.circuit.QuantumRegister")*,int)*) – target qubit, where we act on with the single-qubit gates. +* **up\_to\_diagonal** (*bool*) – If set to True, the uniformly controlled gate is decomposed up to a diagonal gate, i.e. a unitary u’ is implemented such that there exists a diagonal gate d with u = d.dot(u’), where the unitary u describes the uniformly controlled gate + +**Returns** + +the uniformly controlled gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### ucrx + + + +`RawFeatureVector.ucrx(angle_list, q_controls, q_target)` + +Attach a uniformly controlled (also called multiplexed) Rx rotation gate to a circuit. + +The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al. + +**Parameters** + +* **angle\_list** (*list*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$ +* **q\_controls** (*QuantumRegister|list*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if `q_controls=[q[0],q[1]]` (with `q = QuantumRegister(2)`), the rotation `Rx(a_0)` is performed if `q[0]` and `q[1]` are in the state zero, the rotation `Rx(a_1)` is performed if `q[0]` is in the state one and `q[1]` is in the state zero, and so on +* **q\_target** (*QuantumRegister|Qubit*) – target qubit, where we act on with the single-qubit rotation gates + +**Returns** + +the uniformly controlled rotation gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### ucry + + + +`RawFeatureVector.ucry(angle_list, q_controls, q_target)` + +Attach a uniformly controlled (also called multiplexed) Ry rotation gate to a circuit. + +The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al. + +**Parameters** + +* **angle\_list** (*list\[numbers*) – list of (real) rotation angles $[a_0,...,a_{2^k-1}]$ +* **q\_controls** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if `q_controls=[q[0],q[1]]` (with `q = QuantumRegister(2)`), the rotation `Ry(a_0)` is performed if `q[0]` and `q[1]` are in the state zero, the rotation `Ry(a_1)` is performed if `q[0]` is in the state one and `q[1]` is in the state zero, and so on +* **q\_target** (*QuantumRegister|Qubit*) – target qubit, where we act on with the single-qubit rotation gates + +**Returns** + +the uniformly controlled rotation gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### ucrz + + + +`RawFeatureVector.ucrz(angle_list, q_controls, q_target)` + +Attach a uniformly controlled (also called multiplexed gates) Rz rotation gate to a circuit. + +The decomposition is base on [https://arxiv.org/pdf/quant-ph/0406176.pdf](https://arxiv.org/pdf/quant-ph/0406176.pdf) by Shende et al. + +**Parameters** + +* **angle\_list** (*list\[numbers*) – list of (real) rotation angles \[a\_0,…,a\_\{2^k-1}] +* **q\_controls** (*QuantumRegister|list\[*[*Qubit*](qiskit.circuit.Qubit "qiskit.circuit.Qubit")*]*) – list of k control qubits (or empty list if no controls). The control qubits are ordered according to their significance in increasing order: For example if q\_controls=\[q\[1],q\[2]] (with q = QuantumRegister(2)), the rotation Rz(a\_0)is performed if q\[1] and q\[2] are in the state zero, the rotation Rz(a\_1) is performed if q\[1] is in the state one and q\[2] is in the state zero, and so on +* **q\_target** (*QuantumRegister|Qubit*) – target qubit, where we act on with the single-qubit rotation gates + +**Returns** + +the uniformly controlled rotation gate is attached to the circuit. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +**Raises** + +**QiskitError** – if the list number of control qubits does not correspond to the provided number of single-qubit unitaries; if an input is of the wrong type + +### unitary + + + +`RawFeatureVector.unitary(obj, qubits, label=None)` + +Apply unitary gate to q. + +### width + + + +`RawFeatureVector.width()` + +Return number of qubits plus clbits in circuit. + +**Returns** + +Width of circuit. + +**Return type** + +int + +### x + + + +`RawFeatureVector.x(qubit, label=None)` + +Apply [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). + +### y + + + +`RawFeatureVector.y(qubit)` + +Apply [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"). + +### z + + + +`RawFeatureVector.z(qubit)` + +Apply [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"). + +## Attributes + + ### ancillas Returns a list of ancilla bits in the order that the registers were added. - + ### calibrations @@ -214,23 +2728,23 @@ Return calibration dictionary. \{‘gate\_name’: \{(qubits, params): schedule}} - + ### clbits Returns a list of classical bits in the order that the registers were added. - + ### data - + ### extension\_lib `= 'include "qelib1.inc";'` - + ### feature\_dimension @@ -244,25 +2758,25 @@ Return the feature dimension. The feature dimension, which is `2 ** num_qubits`. - + ### global\_phase Return the global phase of the circuit in radians. - + ### header `= 'OPENQASM 2.0;'` - + ### instances `= 16` - + ### metadata @@ -270,19 +2784,19 @@ The user provided metadata associated with the circuit The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit. - + ### num\_ancillas Return the number of ancilla qubits. - + ### num\_clbits Return number of classical bits. - + ### num\_parameters @@ -290,7 +2804,7 @@ Return number of classical bits. `int` - + ### num\_qubits @@ -304,7 +2818,7 @@ Returns the number of qubits in this circuit. The number of qubits. - + ### ordered\_parameters @@ -318,7 +2832,7 @@ Return the free parameters in the RawFeatureVector. A list of the free parameters. - + ### parameters @@ -332,20 +2846,21 @@ Return the free parameters in the RawFeatureVector. A set of the free parameters. - + ### prefix `= 'circuit'` - + ### qregs A list of the quantum registers associated with the circuit. - + ### qubits Returns a list of quantum bits in the order that the registers were added. + diff --git a/docs/api/qiskit/0.32/qiskit.ml.circuit.library.md b/docs/api/qiskit/0.32/qiskit.ml.circuit.library.md index ba89e59ab24..5df155dae26 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.circuit.library.md +++ b/docs/api/qiskit/0.32/qiskit.ml.circuit.library.md @@ -20,7 +20,7 @@ A library of quantum circuits used for machine learning applications and as buil # Feature Maps -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`RawFeatureVector`](qiskit.ml.circuit.library.RawFeatureVector#qiskit.ml.circuit.library.RawFeatureVector "qiskit.ml.circuit.library.RawFeatureVector") | The raw feature vector circuit. | +| | | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------- | +| [`RawFeatureVector`](qiskit.ml.circuit.library.RawFeatureVector "qiskit.ml.circuit.library.RawFeatureVector") | The raw feature vector circuit. | 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 14c6f8f9199..f53d2f592c9 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 @@ -1,7 +1,16 @@ -# qiskit.ml.datasets.ad\_hoc\_data +--- +title: ad_hoc_data +description: API reference for qiskit.ml.datasets.ad_hoc_data +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ml.datasets.ad_hoc_data +--- +# qiskit.ml.datasets.ad\_hoc\_data + -`ad_hoc_data(training_size, test_size, n, gap, plot_data=False)` +`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 f4a566e460d..bfb5399794a 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 @@ -1,7 +1,16 @@ -# qiskit.ml.datasets.breast\_cancer +--- +title: breast_cancer +description: API reference for qiskit.ml.datasets.breast_cancer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ml.datasets.breast_cancer +--- +# qiskit.ml.datasets.breast\_cancer + -`breast_cancer(training_size, test_size, n, plot_data=False)` +`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 d2cc5b7ca67..bda77e505f7 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.digits.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.digits.md @@ -1,7 +1,16 @@ -# qiskit.ml.datasets.digits +--- +title: digits +description: API reference for qiskit.ml.datasets.digits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ml.datasets.digits +--- +# qiskit.ml.datasets.digits + -`digits(training_size, test_size, n, plot_data=False)` +`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 e456a5e151e..6a901751ab5 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.gaussian.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.gaussian.md @@ -1,7 +1,16 @@ -# qiskit.ml.datasets.gaussian +--- +title: gaussian +description: API reference for qiskit.ml.datasets.gaussian +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ml.datasets.gaussian +--- +# qiskit.ml.datasets.gaussian + -`gaussian(training_size, test_size, n, plot_data=False)` +`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 8fdc44c6cda..6af1aa464cf 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.iris.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.iris.md @@ -1,7 +1,16 @@ -# qiskit.ml.datasets.iris +--- +title: iris +description: API reference for qiskit.ml.datasets.iris +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ml.datasets.iris +--- +# qiskit.ml.datasets.iris + -`iris(training_size, test_size, n, plot_data=False)` +`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.md b/docs/api/qiskit/0.32/qiskit.ml.datasets.md index 3b0c7735783..71240ab458c 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.md @@ -20,13 +20,13 @@ Sample datasets suitable for machine learning problems # Datasets -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`ad_hoc_data`](qiskit.ml.datasets.ad_hoc_data#qiskit.ml.datasets.ad_hoc_data "qiskit.ml.datasets.ad_hoc_data") | returns ad hoc dataset | -| [`sample_ad_hoc_data`](qiskit.ml.datasets.sample_ad_hoc_data#qiskit.ml.datasets.sample_ad_hoc_data "qiskit.ml.datasets.sample_ad_hoc_data") | returns sample ad hoc data | -| [`breast_cancer`](qiskit.ml.datasets.breast_cancer#qiskit.ml.datasets.breast_cancer "qiskit.ml.datasets.breast_cancer") | returns breast cancer dataset | -| [`digits`](qiskit.ml.datasets.digits#qiskit.ml.datasets.digits "qiskit.ml.datasets.digits") | returns digits dataset | -| [`gaussian`](qiskit.ml.datasets.gaussian#qiskit.ml.datasets.gaussian "qiskit.ml.datasets.gaussian") | returns gaussian dataset | -| [`iris`](qiskit.ml.datasets.iris#qiskit.ml.datasets.iris "qiskit.ml.datasets.iris") | returns iris dataset | -| [`wine`](qiskit.ml.datasets.wine#qiskit.ml.datasets.wine "qiskit.ml.datasets.wine") | returns wine dataset | +| | | +| ----------------------------------------------------------------------------------------------------- | ----------------------------- | +| [`ad_hoc_data`](qiskit.ml.datasets.ad_hoc_data "qiskit.ml.datasets.ad_hoc_data") | returns ad hoc dataset | +| [`sample_ad_hoc_data`](qiskit.ml.datasets.sample_ad_hoc_data "qiskit.ml.datasets.sample_ad_hoc_data") | returns sample ad hoc data | +| [`breast_cancer`](qiskit.ml.datasets.breast_cancer "qiskit.ml.datasets.breast_cancer") | returns breast cancer dataset | +| [`digits`](qiskit.ml.datasets.digits "qiskit.ml.datasets.digits") | returns digits dataset | +| [`gaussian`](qiskit.ml.datasets.gaussian "qiskit.ml.datasets.gaussian") | returns gaussian dataset | +| [`iris`](qiskit.ml.datasets.iris "qiskit.ml.datasets.iris") | returns iris dataset | +| [`wine`](qiskit.ml.datasets.wine "qiskit.ml.datasets.wine") | returns wine 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 e94ac30b7d6..d83ed7a2041 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 @@ -1,7 +1,16 @@ -# qiskit.ml.datasets.sample\_ad\_hoc\_data +--- +title: sample_ad_hoc_data +description: API reference for qiskit.ml.datasets.sample_ad_hoc_data +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ml.datasets.sample_ad_hoc_data +--- +# qiskit.ml.datasets.sample\_ad\_hoc\_data + -`sample_ad_hoc_data(sample_total, test_size, n)` +`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 2061e6b2aca..5713bd323fd 100644 --- a/docs/api/qiskit/0.32/qiskit.ml.datasets.wine.md +++ b/docs/api/qiskit/0.32/qiskit.ml.datasets.wine.md @@ -1,7 +1,16 @@ -# qiskit.ml.datasets.wine +--- +title: wine +description: API reference for qiskit.ml.datasets.wine +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.ml.datasets.wine +--- +# qiskit.ml.datasets.wine + -`wine(training_size, test_size, n, plot_data=False)` +`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 1a384e24d53..56fc97fec81 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.OperatorBase.md @@ -1,8 +1,16 @@ -# OperatorBase +--- +title: OperatorBase +description: API reference for qiskit.opflow.OperatorBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.OperatorBase +--- +# OperatorBase + -`OperatorBase` +`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` @@ -12,37 +20,353 @@ Operators can be used to construct complicated functions and computation, and se ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.OperatorBase.add#qiskit.opflow.OperatorBase.add "qiskit.opflow.OperatorBase.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.OperatorBase.adjoint#qiskit.opflow.OperatorBase.adjoint "qiskit.opflow.OperatorBase.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.opflow.OperatorBase.assign_parameters#qiskit.opflow.OperatorBase.assign_parameters "qiskit.opflow.OperatorBase.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`bind_parameters`](qiskit.opflow.OperatorBase.bind_parameters#qiskit.opflow.OperatorBase.bind_parameters "qiskit.opflow.OperatorBase.bind_parameters") | Same as assign\_parameters, but maintained for consistency with QuantumCircuit in Terra (which has both assign\_parameters and bind\_parameters). | -| [`compose`](qiskit.opflow.OperatorBase.compose#qiskit.opflow.OperatorBase.compose "qiskit.opflow.OperatorBase.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`copy`](qiskit.opflow.OperatorBase.copy#qiskit.opflow.OperatorBase.copy "qiskit.opflow.OperatorBase.copy") | Return a deep copy of the Operator. | -| [`equals`](qiskit.opflow.OperatorBase.equals#qiskit.opflow.OperatorBase.equals "qiskit.opflow.OperatorBase.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.OperatorBase.eval#qiskit.opflow.OperatorBase.eval "qiskit.opflow.OperatorBase.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`mul`](qiskit.opflow.OperatorBase.mul#qiskit.opflow.OperatorBase.mul "qiskit.opflow.OperatorBase.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`neg`](qiskit.opflow.OperatorBase.neg#qiskit.opflow.OperatorBase.neg "qiskit.opflow.OperatorBase.neg") | Return the Operator’s negation, effectively just multiplying by -1.0, overloaded by `-`. | -| [`permute`](qiskit.opflow.OperatorBase.permute#qiskit.opflow.OperatorBase.permute "qiskit.opflow.OperatorBase.permute") | Permutes the qubits of the operator. | -| [`primitive_strings`](qiskit.opflow.OperatorBase.primitive_strings#qiskit.opflow.OperatorBase.primitive_strings "qiskit.opflow.OperatorBase.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.OperatorBase.reduce#qiskit.opflow.OperatorBase.reduce "qiskit.opflow.OperatorBase.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.opflow.OperatorBase.tensor#qiskit.opflow.OperatorBase.tensor "qiskit.opflow.OperatorBase.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.opflow.OperatorBase.tensorpower#qiskit.opflow.OperatorBase.tensorpower "qiskit.opflow.OperatorBase.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit_op`](qiskit.opflow.OperatorBase.to_circuit_op#qiskit.opflow.OperatorBase.to_circuit_op "qiskit.opflow.OperatorBase.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_matrix`](qiskit.opflow.OperatorBase.to_matrix#qiskit.opflow.OperatorBase.to_matrix "qiskit.opflow.OperatorBase.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.OperatorBase.to_matrix_op#qiskit.opflow.OperatorBase.to_matrix_op "qiskit.opflow.OperatorBase.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | -| [`to_spmatrix`](qiskit.opflow.OperatorBase.to_spmatrix#qiskit.opflow.OperatorBase.to_spmatrix "qiskit.opflow.OperatorBase.to_spmatrix") | Return SciPy sparse matrix representation of the Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`complex`, `ParameterExpression`, `List`\[`Union`\[`complex`, `ParameterExpression`]]]]) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### bind\_parameters + + + +`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). + +**Return type** + +`OperatorBase` + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### copy + + + +`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. + +**Return type** + +`OperatorBase` + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### neg + + +`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 `-`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the negation of self. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new OperatorBase containing the permuted operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if indices do not define a new index for each qubit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_spmatrix + + + +`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. + +**Return type** + +`spmatrix` + +**Returns** + +The SciPy `spmatrix` equivalent to this Operator. + +## Attributes + + ### INDENTATION `= ' '` - + ### instance\_id @@ -52,7 +376,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -66,13 +390,13 @@ The number of qubits over which the Operator is defined. If `op.num_qubits == 5` The number of qubits accepted by the Operator’s underlying function. - + ### parameters Return a set of Parameter objects contained in the Operator. - + ### settings @@ -87,3 +411,4 @@ You can, for example, use this `settings` dictionary to serialize the object in **Returns** Object settings in a dictionary. + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md b/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md index e74709516e6..28c74b79a54 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.OpflowError.md @@ -1,9 +1,18 @@ -# qiskit.opflow\.OpflowError +--- +title: OpflowError +description: API reference for qiskit.opflow.OpflowError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.opflow.OpflowError +--- +# qiskit.opflow\.OpflowError + -`OpflowError(*message)` +`OpflowError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/exceptions.py "view source code") For Opflow specific errors. Set the error message. + 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 fe940f36c9d..3898db790be 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.anti_commutator.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.anti_commutator.md @@ -1,8 +1,16 @@ -# qiskit.opflow\.anti\_commutator +--- +title: anti_commutator +description: API reference for qiskit.opflow.anti_commutator +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.opflow.anti_commutator +--- +# qiskit.opflow\.anti\_commutator + -`anti_commutator(op_a, op_b)` +`anti_commutator(op_a, op_b)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/utils.py "view source code") Compute anti-commutator of op\_a and op\_b. @@ -21,4 +29,5 @@ the anti-commutator **Return type** -[OperatorBase](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") +[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.commutator.md b/docs/api/qiskit/0.32/qiskit.opflow.commutator.md index 7e94117fe27..fee5b93b02a 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.commutator.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.commutator.md @@ -1,8 +1,16 @@ -# qiskit.opflow\.commutator +--- +title: commutator +description: API reference for qiskit.opflow.commutator +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.opflow.commutator +--- +# qiskit.opflow\.commutator + -`commutator(op_a, op_b)` +`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. @@ -21,4 +29,5 @@ the commutator **Return type** -[OperatorBase](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") +[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") + 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 61e3a177faa..a00d134ed2c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.AbelianGrouper.md @@ -1,8 +1,16 @@ -# AbelianGrouper +--- +title: AbelianGrouper +description: API reference for qiskit.opflow.converters.AbelianGrouper +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.converters.AbelianGrouper +--- +# AbelianGrouper + -`AbelianGrouper(traverse=True)` +`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` @@ -16,7 +24,47 @@ Meaning, it will traverse the Operator, and when it finds a SummedOp, it will ev ## Methods Defined Here -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.converters.AbelianGrouper.convert#qiskit.opflow.converters.AbelianGrouper.convert "qiskit.opflow.converters.AbelianGrouper.convert") | 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. | -| [`group_subops`](qiskit.opflow.converters.AbelianGrouper.group_subops#qiskit.opflow.converters.AbelianGrouper.group_subops "qiskit.opflow.converters.AbelianGrouper.group_subops") | Given a ListOp, attempt to group into Abelian ListOps of the same type. | +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to attempt to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator. + +### group\_subops + + + +`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. + +**Parameters** + +**list\_op** (`Union`\[`ListOp`, `PauliSumOp`]) – The Operator to group into Abelian groups + +**Return type** + +`ListOp` + +**Returns** + +The grouped Operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If any of list\_op’s sub-ops is not `PauliOp`. + 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 4e020b2a580..f2d2e759eed 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.CircuitSampler.md @@ -1,8 +1,16 @@ -# CircuitSampler +--- +title: CircuitSampler +description: API reference for qiskit.opflow.converters.CircuitSampler +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.converters.CircuitSampler +--- +# CircuitSampler + -`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')` +`CircuitSampler(backend, statevector=None, param_qobj=False, attach_results=False, caching='last')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/circuit_sampler.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -24,15 +32,71 @@ The CircuitSampler aggressively caches transpiled circuits to handle re-paramete ## Methods Defined Here -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| [`clear_cache`](qiskit.opflow.converters.CircuitSampler.clear_cache#qiskit.opflow.converters.CircuitSampler.clear_cache "qiskit.opflow.converters.CircuitSampler.clear_cache") | Clear the cache of sampled operator expressions. | -| [`convert`](qiskit.opflow.converters.CircuitSampler.convert#qiskit.opflow.converters.CircuitSampler.convert "qiskit.opflow.converters.CircuitSampler.convert") | Converts the Operator to one in which the CircuitStateFns are replaced by DictStateFns or VectorStateFns. | -| [`sample_circuits`](qiskit.opflow.converters.CircuitSampler.sample_circuits#qiskit.opflow.converters.CircuitSampler.sample_circuits "qiskit.opflow.converters.CircuitSampler.sample_circuits") | Samples the CircuitStateFns and returns a dict associating their `id()` values to their replacement DictStateFn or VectorStateFn. | +### clear\_cache -## Attributes + + +`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. + +**Return type** + +`None` + +### convert + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – The Operator to convert +* **params** (`Optional`\[`Dict`\[`Parameter`, `Union`\[`float`, `List`\[`float`], `List`\[`List`\[`float`]]]]]) – A dictionary mapping parameters to either single binding values or lists of binding values. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator with CircuitStateFns replaced by DictStateFns or VectorStateFns. +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if extracted circuits are empty. + +### sample\_circuits + + + +`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. + +**Parameters** + +* **circuit\_sfns** (`Optional`\[`List`\[`CircuitStateFn`]]) – The list of CircuitStateFns to sample. +* **param\_bindings** (`Optional`\[`List`\[`Dict`\[`Parameter`, `float`]]]) – The parameterizations to bind to each CircuitStateFn. + +**Return type** +`Dict`\[`int`, `List`\[`StateFn`]] + +**Returns** + +The dictionary mapping ids of the CircuitStateFns to their replacement StateFns. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if extracted circuits are empty. + +## Attributes + + ### quantum\_instance @@ -45,3 +109,4 @@ Returns the quantum instance. **Returns** The QuantumInstance used by the CircuitSampler + 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 da2854e40e7..e3684e8963c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.ConverterBase.md @@ -1,8 +1,16 @@ -# ConverterBase +--- +title: ConverterBase +description: API reference for qiskit.opflow.converters.ConverterBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.converters.ConverterBase +--- +# ConverterBase + -`ConverterBase` +`ConverterBase`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/converter_base.py "view source code") Bases: `abc.ABC` @@ -10,6 +18,23 @@ Converters take an Operator and return a new Operator, generally isomorphic in s ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`convert`](qiskit.opflow.converters.ConverterBase.convert#qiskit.opflow.converters.ConverterBase.convert "qiskit.opflow.converters.ConverterBase.convert") | Accept the Operator and return the converted Operator | +### convert + + + +`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 + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +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 ea16b1c1257..72f672de34f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.DictToCircuitSum.md @@ -1,8 +1,16 @@ -# DictToCircuitSum +--- +title: DictToCircuitSum +description: API reference for qiskit.opflow.converters.DictToCircuitSum +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.converters.DictToCircuitSum +--- +# DictToCircuitSum + -`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)` +`DictToCircuitSum(traverse=True, convert_dicts=True, convert_vectors=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/dict_to_circuit_sum.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -16,6 +24,23 @@ Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or s ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.converters.DictToCircuitSum.convert#qiskit.opflow.converters.DictToCircuitSum.convert "qiskit.opflow.converters.DictToCircuitSum.convert") | Convert the Operator to `CircuitStateFns`, recursively if `traverse` is True. | +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator. + 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 e9c2934e03e..325cb11c1d4 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.PauliBasisChange.md @@ -1,8 +1,16 @@ -# PauliBasisChange +--- +title: PauliBasisChange +description: API reference for qiskit.opflow.converters.PauliBasisChange +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.converters.PauliBasisChange +--- +# PauliBasisChange + -`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)` +`PauliBasisChange(destination_basis=None, traverse=True, replacement_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/converters/pauli_basis_change.py "view source code") Bases: `qiskit.opflow.converters.converter_base.ConverterBase` @@ -27,22 +35,228 @@ This class uses the typical basis change method found in most Quantum Computing ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`construct_cnot_chain`](qiskit.opflow.converters.PauliBasisChange.construct_cnot_chain#qiskit.opflow.converters.PauliBasisChange.construct_cnot_chain "qiskit.opflow.converters.PauliBasisChange.construct_cnot_chain") | 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). | -| [`convert`](qiskit.opflow.converters.PauliBasisChange.convert#qiskit.opflow.converters.PauliBasisChange.convert "qiskit.opflow.converters.PauliBasisChange.convert") | 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`. | -| [`get_cob_circuit`](qiskit.opflow.converters.PauliBasisChange.get_cob_circuit#qiskit.opflow.converters.PauliBasisChange.get_cob_circuit "qiskit.opflow.converters.PauliBasisChange.get_cob_circuit") | Construct an Operator which maps the +1 and -1 eigenvectors of the origin Pauli to the +1 and -1 eigenvectors of the destination Pauli. | -| [`get_diagonal_pauli_op`](qiskit.opflow.converters.PauliBasisChange.get_diagonal_pauli_op#qiskit.opflow.converters.PauliBasisChange.get_diagonal_pauli_op "qiskit.opflow.converters.PauliBasisChange.get_diagonal_pauli_op") | Get the diagonal `PualiOp` to which `pauli_op` could be rotated with only single-qubit operations. | -| [`get_diagonalizing_clifford`](qiskit.opflow.converters.PauliBasisChange.get_diagonalizing_clifford#qiskit.opflow.converters.PauliBasisChange.get_diagonalizing_clifford "qiskit.opflow.converters.PauliBasisChange.get_diagonalizing_clifford") | Construct a `CircuitOp` with only single-qubit gates which takes the eigenvectors of `pauli` to eigenvectors composed only of \|0⟩ and \|1⟩ tensor products. | -| [`get_tpb_pauli`](qiskit.opflow.converters.PauliBasisChange.get_tpb_pauli#qiskit.opflow.converters.PauliBasisChange.get_tpb_pauli "qiskit.opflow.converters.PauliBasisChange.get_tpb_pauli") | 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`. | -| [`measurement_replacement_fn`](qiskit.opflow.converters.PauliBasisChange.measurement_replacement_fn#qiskit.opflow.converters.PauliBasisChange.measurement_replacement_fn "qiskit.opflow.converters.PauliBasisChange.measurement_replacement_fn") | A built-in convenience replacement function which produces measurements isomorphic to an `OperatorStateFn` measurement holding the origin `PauliOp`. | -| [`operator_replacement_fn`](qiskit.opflow.converters.PauliBasisChange.operator_replacement_fn#qiskit.opflow.converters.PauliBasisChange.operator_replacement_fn "qiskit.opflow.converters.PauliBasisChange.operator_replacement_fn") | A built-in convenience replacement function which produces Operators isomorphic to the origin `PauliOp`. | -| [`pad_paulis_to_equal_length`](qiskit.opflow.converters.PauliBasisChange.pad_paulis_to_equal_length#qiskit.opflow.converters.PauliBasisChange.pad_paulis_to_equal_length "qiskit.opflow.converters.PauliBasisChange.pad_paulis_to_equal_length") | 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. | -| [`statefn_replacement_fn`](qiskit.opflow.converters.PauliBasisChange.statefn_replacement_fn#qiskit.opflow.converters.PauliBasisChange.statefn_replacement_fn "qiskit.opflow.converters.PauliBasisChange.statefn_replacement_fn") | A built-in convenience replacement function which produces state functions isomorphic to an `OperatorStateFn` state function holding the origin `PauliOp`. | +### construct\_cnot\_chain -## Attributes + + +`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. + +**Parameters** + +* **diag\_pauli\_op1** (`PauliOp`) – The origin `PauliOp`. +* **diag\_pauli\_op2** (`PauliOp`) – The destination `PauliOp`. + +**Return type** + +`PrimitiveOp` + +**Returns** + +The `PrimitiveOp` performs the mapping. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator. + +### get\_cob\_circuit + + + +`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 + +1. converting any |i+⟩ or |i+⟩ eigenvector bits in the origin to |+⟩ and |-⟩ with S†s, then +2. converting any |+⟩ or |+⟩ eigenvector bits in the converted origin to |0⟩ and |1⟩ with Hs, then +3. writing the parity of the significant (Z-measured, rather than I) bits in the origin to a single “origin anchor bit,” using cnots, which will hold the parity of these bits, +4. swapping the parity of the pauli anchor bit into a destination anchor bit using a swap gate (only if they are different, if there are any bits which are significant in both origin and dest, we set both anchors to one of these bits to avoid a swap). +5. writing the parity of the destination anchor bit into the other significant bits of the destination, +6. converting the |0⟩ and |1⟩ significant eigenvector bits to |+⟩ and |-⟩ eigenvector bits in the destination where the destination demands it (e.g. pauli.x == true for a bit), using Hs 8) converting the |+⟩ and |-⟩ significant eigenvector bits to |i+⟩ and |i-⟩ eigenvector bits in the destination where the destination demands it (e.g. pauli.x == true and pauli.z == true for a bit), using Ss + +**Parameters** + +**origin** (`Union`\[`Pauli`, `PauliOp`]) – The `Pauli` or `PauliOp` to map. + +**Return type** + +`Tuple`\[`PrimitiveOp`, `PauliOp`] + +**Returns** + +A tuple of a `PrimitiveOp` which equals the basis change mapping and a `PauliOp` which equals the destination basis. + +**Raises** + +* **TypeError** – Attempting to convert from non-Pauli origin. +* **ValueError** – Attempting to change a non-identity Pauli to an identity Pauli, or vice versa. + +### get\_diagonal\_pauli\_op + + + +`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. + +**Parameters** + +**pauli\_op** (`PauliOp`) – The `PauliOp` whose diagonal to compute. + +**Return type** + +`PauliOp` + +**Returns** + +The diagonal `PauliOp`. + +### get\_diagonalizing\_clifford + + + +`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. + +Note, underlying Pauli bits are in Qiskit endianness, so we need to reverse before we begin composing with Operator flow. + +**Parameters** + +**pauli** (`Union`\[`Pauli`, `PauliOp`]) – the `Pauli` or `PauliOp` to whose diagonalizing circuit to compute. + +**Return type** + +`OperatorBase` + +**Returns** +The diagonalizing `CircuitOp`. +### get\_tpb\_pauli + + + +`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. + +**Parameters** + +**list\_op** (`ListOp`) – the `ListOp` whose TPB Pauli to return. + +**Return type** + +`Pauli` + +**Returns** + +The TBP Pauli. + +### measurement\_replacement\_fn + + + +`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`. + +**Parameters** + +* **cob\_instr\_op** (`PrimitiveOp`) – The basis-change `CircuitOp`. +* **dest\_pauli\_op** (`Union`\[`PauliOp`, `PauliSumOp`, `ListOp`]) – The destination Pauli type operator. + +**Return type** + +`OperatorBase` + +**Returns** + +The `~StateFn @ CircuitOp` composition equivalent to a measurement by the original `PauliOp`. + +### operator\_replacement\_fn + + + +`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`. + +**Parameters** + +* **cob\_instr\_op** (`PrimitiveOp`) – The basis-change `CircuitOp`. +* **dest\_pauli\_op** (`Union`\[`PauliOp`, `PauliSumOp`, `ListOp`]) – The destination `PauliOp`. + +**Return type** + +`OperatorBase` + +**Returns** + +The `~CircuitOp @ PauliOp @ CircuitOp` composition isomorphic to the original `PauliOp`. + +### pad\_paulis\_to\_equal\_length + + + +`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. + +**Parameters** + +* **pauli\_op1** (`PauliOp`) – A pauli\_op to possibly pad. +* **pauli\_op2** (`PauliOp`) – A pauli\_op to possibly pad. + +**Return type** + +`Tuple`\[`PauliOp`, `PauliOp`] + +**Returns** + +A tuple containing the padded PauliOps. + +### statefn\_replacement\_fn + + + +`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`. + +**Parameters** + +* **cob\_instr\_op** (`PrimitiveOp`) – The basis-change `CircuitOp`. +* **dest\_pauli\_op** (`Union`\[`PauliOp`, `PauliSumOp`, `ListOp`]) – The destination Pauli type operator. + +**Return type** + +`OperatorBase` + +**Returns** + +The `~CircuitOp @ StateFn` composition equivalent to a state function defined by the original `PauliOp`. + +## Attributes + + ### destination @@ -51,3 +265,4 @@ The destination `PauliOp`, or `None` if using the default destination, the diago **Return type** `Optional`\[`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 fb4c3dcc9dc..93a5e86999e 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.TwoQubitReduction.md @@ -1,8 +1,16 @@ -# TwoQubitReduction +--- +title: TwoQubitReduction +description: API reference for qiskit.opflow.converters.TwoQubitReduction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.converters.TwoQubitReduction +--- +# TwoQubitReduction + -`TwoQubitReduction(num_particles)` +`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` @@ -16,6 +24,23 @@ Chemistry specific method: It can be used to taper two qubits in parity and bina ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| [`convert`](qiskit.opflow.converters.TwoQubitReduction.convert#qiskit.opflow.converters.TwoQubitReduction.convert "qiskit.opflow.converters.TwoQubitReduction.convert") | Converts the Operator to tapered one by Z2 symmetries. | +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – the operator + +**Return type** + +`OperatorBase` + +**Returns** + +A new operator whose qubit number is reduced by 2. + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.converters.md b/docs/api/qiskit/0.32/qiskit.opflow.converters.md index 6be189f855b..de1cf2608c0 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.converters.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.converters.md @@ -4,7 +4,7 @@ ## Converters ([`qiskit.opflow.converters`](#module-qiskit.opflow.converters "qiskit.opflow.converters")) -Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp#qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp#qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp#qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation#qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution#qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp#qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp#qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). +Converters are objects which manipulate Operators, usually traversing an Operator to change certain sub-Operators into a desired representation. Often the converted Operator is isomorphic or approximate to the original Operator in some way, but not always. For example, a converter may accept [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") and return a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") of [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s representing the circuit unitary. Converters may not have polynomial space or time scaling in their operations. On the contrary, many converters, such as a [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation") or [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution"), which convert [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")’s to [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")’s internally, will require time or space exponential in the number of qubits unless a clever trick is known (such as the use of sparse matrices). Not all converters are in this module, as [`expectations`](qiskit.opflow.expectations#module-qiskit.opflow.expectations "qiskit.opflow.expectations") and [`evolutions`](qiskit.opflow.evolutions#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions") are also converters. @@ -12,20 +12,20 @@ Converters are objects which manipulate Operators, usually traversing an Operato ### Converter Base Class -The converter base class simply enforces the presence of a [`convert()`](qiskit.opflow.converters.ConverterBase.convert#qiskit.opflow.converters.ConverterBase.convert "qiskit.opflow.converters.ConverterBase.convert") method. +The converter base class simply enforces the presence of a [`convert()`](qiskit.opflow.converters.ConverterBase#convert "qiskit.opflow.converters.ConverterBase.convert") method. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| [`ConverterBase`](qiskit.opflow.converters.ConverterBase#qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.ConverterBase")() | Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. | +| | | +| ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | +| [`ConverterBase`](qiskit.opflow.converters.ConverterBase "qiskit.opflow.converters.ConverterBase")() | Converters take an Operator and return a new Operator, generally isomorphic in some way with the first, but with certain desired properties. | ### Converters In addition to the base class, directory holds a few miscellaneous converters which are used frequently around the Operator flow. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler#qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler")(backend\[, statevector, …]) | The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. | -| [`AbelianGrouper`](qiskit.opflow.converters.AbelianGrouper#qiskit.opflow.converters.AbelianGrouper "qiskit.opflow.converters.AbelianGrouper")(\[traverse]) | The AbelianGrouper converts SummedOps into a sum of Abelian sums. | -| [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum#qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | -| [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange#qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | -| [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction#qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | 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. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler")(backend\[, statevector, …]) | The CircuitSampler traverses an Operator and converts any CircuitStateFns into approximations of the state function by a DictStateFn or VectorStateFn using a quantum backend. | +| [`AbelianGrouper`](qiskit.opflow.converters.AbelianGrouper "qiskit.opflow.converters.AbelianGrouper")(\[traverse]) | The AbelianGrouper converts SummedOps into a sum of Abelian sums. | +| [`DictToCircuitSum`](qiskit.opflow.converters.DictToCircuitSum "qiskit.opflow.converters.DictToCircuitSum")(\[traverse, convert\_dicts, …]) | Converts `DictStateFns` or `VectorStateFns` to equivalent `CircuitStateFns` or sums thereof. | +| [`PauliBasisChange`](qiskit.opflow.converters.PauliBasisChange "qiskit.opflow.converters.PauliBasisChange")(\[destination\_basis, …]) | Converter for changing Paulis into other bases. | +| [`TwoQubitReduction`](qiskit.opflow.converters.TwoQubitReduction "qiskit.opflow.converters.TwoQubitReduction")(num\_particles) | Two qubit reduction converter which eliminates the central and last qubit in a list of Pauli that has diagonal operators (Z,I) at those positions. | diff --git a/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md b/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md index 4aaeca45f52..4bdc73dda07 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.double_commutator.md @@ -1,8 +1,16 @@ -# qiskit.opflow\.double\_commutator +--- +title: double_commutator +description: API reference for qiskit.opflow.double_commutator +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.opflow.double_commutator +--- +# qiskit.opflow\.double\_commutator + -`double_commutator(op_a, op_b, op_c, sign=False)` +`double_commutator(op_a, op_b, op_c, sign=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.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) @@ -33,4 +41,5 @@ the double commutator **Return type** -[OperatorBase](qiskit.aqua.operators.OperatorBase#qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") +[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") + 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 a640ddc7324..bba55129dca 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionBase.md @@ -1,8 +1,16 @@ -# EvolutionBase +--- +title: EvolutionBase +description: API reference for qiskit.opflow.evolutions.EvolutionBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.EvolutionBase +--- +# EvolutionBase + -`EvolutionBase` +`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` @@ -10,6 +18,23 @@ A base for Evolution converters. Evolutions are converters which traverse an Ope ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.evolutions.EvolutionBase.convert#qiskit.opflow.evolutions.EvolutionBase.convert "qiskit.opflow.evolutions.EvolutionBase.convert") | Traverse the operator, replacing any `EvolutionOps` with their equivalent evolution `CircuitOps`. | +### convert + + + +`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`. + +> #### Args: +> +> operator: The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted Operator, with `EvolutionOps` replaced by `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 3f12571ca56..ae71ca2719c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolutionFactory.md @@ -1,8 +1,16 @@ -# EvolutionFactory +--- +title: EvolutionFactory +description: API reference for qiskit.opflow.evolutions.EvolutionFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.EvolutionFactory +--- +# EvolutionFactory + -`EvolutionFactory` +`EvolutionFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/evolution_factory.py "view source code") Bases: `object` @@ -10,6 +18,27 @@ A factory class for convenient automatic selection of an Evolution algorithm bas ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- | -| [`build`](qiskit.opflow.evolutions.EvolutionFactory.build#qiskit.opflow.evolutions.EvolutionFactory.build "qiskit.opflow.evolutions.EvolutionFactory.build") | A factory method for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. | +### build + + + +`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. + +**Parameters** + +**operator** (`Optional`\[`OperatorBase`]) – the Operator being evolved + +**Returns** + +the `EvolutionBase` best suited to evolve operator. + +**Return type** + +[EvolutionBase](qiskit.aqua.operators.evolutions.EvolutionBase "qiskit.aqua.operators.evolutions.EvolutionBase") + +**Raises** + +**ValueError** – If operator is not of a composition for which we know the best Evolution method. + 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 cc6b412a521..4e93b0b8f51 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.EvolvedOp.md @@ -1,8 +1,16 @@ -# EvolvedOp +--- +title: EvolvedOp +description: API reference for qiskit.opflow.evolutions.EvolvedOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.EvolvedOp +--- +# EvolvedOp + -`EvolvedOp(primitive, coeff=1.0)` +`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` @@ -15,32 +23,273 @@ Class for wrapping Operator Evolutions for compilation (`convert`) by an Evoluti ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.evolutions.EvolvedOp.add#qiskit.opflow.evolutions.EvolvedOp.add "qiskit.opflow.evolutions.EvolvedOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.evolutions.EvolvedOp.adjoint#qiskit.opflow.evolutions.EvolvedOp.adjoint "qiskit.opflow.evolutions.EvolvedOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.opflow.evolutions.EvolvedOp.assign_parameters#qiskit.opflow.evolutions.EvolvedOp.assign_parameters "qiskit.opflow.evolutions.EvolvedOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`compose`](qiskit.opflow.evolutions.EvolvedOp.compose#qiskit.opflow.evolutions.EvolvedOp.compose "qiskit.opflow.evolutions.EvolvedOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.opflow.evolutions.EvolvedOp.equals#qiskit.opflow.evolutions.EvolvedOp.equals "qiskit.opflow.evolutions.EvolvedOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.evolutions.EvolvedOp.eval#qiskit.opflow.evolutions.EvolvedOp.eval "qiskit.opflow.evolutions.EvolvedOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`log_i`](qiskit.opflow.evolutions.EvolvedOp.log_i#qiskit.opflow.evolutions.EvolvedOp.log_i "qiskit.opflow.evolutions.EvolvedOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`permute`](qiskit.opflow.evolutions.EvolvedOp.permute#qiskit.opflow.evolutions.EvolvedOp.permute "qiskit.opflow.evolutions.EvolvedOp.permute") | Permutes the qubits of the operator. | -| [`primitive_strings`](qiskit.opflow.evolutions.EvolvedOp.primitive_strings#qiskit.opflow.evolutions.EvolvedOp.primitive_strings "qiskit.opflow.evolutions.EvolvedOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.evolutions.EvolvedOp.reduce#qiskit.opflow.evolutions.EvolvedOp.reduce "qiskit.opflow.evolutions.EvolvedOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.opflow.evolutions.EvolvedOp.tensor#qiskit.opflow.evolutions.EvolvedOp.tensor "qiskit.opflow.evolutions.EvolvedOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_instruction`](qiskit.opflow.evolutions.EvolvedOp.to_instruction#qiskit.opflow.evolutions.EvolvedOp.to_instruction "qiskit.opflow.evolutions.EvolvedOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_matrix`](qiskit.opflow.evolutions.EvolvedOp.to_matrix#qiskit.opflow.evolutions.EvolvedOp.to_matrix "qiskit.opflow.evolutions.EvolvedOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.evolutions.EvolvedOp.to_matrix_op#qiskit.opflow.evolutions.EvolvedOp.to_matrix_op "qiskit.opflow.evolutions.EvolvedOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`Union`\[`EvolvedOp`, `SummedOp`] + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`EvolvedOp` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`Union`\[`EvolvedOp`, `ListOp`] + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### log\_i + + + +`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. + +**Return type** +`OperatorBase` + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`EvolvedOp` + +**Returns** + +A new OperatorBase containing the permuted operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if indices do not define a new index for each qubit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`EvolvedOp` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`TensoredOp` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`Union`\[`ListOp`, `MatrixOp`] + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -54,7 +303,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### instance\_id @@ -64,7 +313,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -72,11 +321,11 @@ Return the unique instance id. `int` - + ### parameters - + ### primitive @@ -92,7 +341,7 @@ The primitive defining the underlying function of the Operator. The primitive object. - + ### settings @@ -101,3 +350,4 @@ Return operator settings. **Return type** `Dict` + 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 a73cc2e695f..8993a5179ad 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.MatrixEvolution.md @@ -1,8 +1,16 @@ -# MatrixEvolution +--- +title: MatrixEvolution +description: API reference for qiskit.opflow.evolutions.MatrixEvolution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.MatrixEvolution +--- +# MatrixEvolution + -`MatrixEvolution` +`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` @@ -10,6 +18,23 @@ Performs Evolution by classical matrix exponentiation, constructing a circuit wi ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.evolutions.MatrixEvolution.convert#qiskit.opflow.evolutions.MatrixEvolution.convert "qiskit.opflow.evolutions.MatrixEvolution.convert") | Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing `UnitaryGates` or `HamiltonianGates` (if self.coeff is a `ParameterExpression`) equalling the exponentiation of -i \* operator. | +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 df67d5b80d0..c8094df0d06 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.PauliTrotterEvolution.md @@ -1,8 +1,16 @@ -# PauliTrotterEvolution +--- +title: PauliTrotterEvolution +description: API reference for qiskit.opflow.evolutions.PauliTrotterEvolution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.PauliTrotterEvolution +--- +# PauliTrotterEvolution + -`PauliTrotterEvolution(trotter_mode='trotter', reps=1)` +`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` @@ -22,15 +30,61 @@ More specifically, we compute basis change circuits for each Pauli into a single ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.evolutions.PauliTrotterEvolution.convert#qiskit.opflow.evolutions.PauliTrotterEvolution.convert "qiskit.opflow.evolutions.PauliTrotterEvolution.convert") | Traverse the operator, replacing `EvolvedOps` with `CircuitOps` containing Trotterized evolutions equalling the exponentiation of -i \* operator. | -| [`evolution_for_abelian_paulisum`](qiskit.opflow.evolutions.PauliTrotterEvolution.evolution_for_abelian_paulisum#qiskit.opflow.evolutions.PauliTrotterEvolution.evolution_for_abelian_paulisum "qiskit.opflow.evolutions.PauliTrotterEvolution.evolution_for_abelian_paulisum") | Evolution for abelian pauli sum | -| [`evolution_for_pauli`](qiskit.opflow.evolutions.PauliTrotterEvolution.evolution_for_pauli#qiskit.opflow.evolutions.PauliTrotterEvolution.evolution_for_pauli "qiskit.opflow.evolutions.PauliTrotterEvolution.evolution_for_pauli") | Compute evolution Operator for a single Pauli using a `PauliBasisChange`. | +### convert -## Attributes + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The Operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + +### evolution\_for\_abelian\_paulisum + + + +`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 +**Return type** + +`PrimitiveOp` + +### evolution\_for\_pauli + + + +`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`. + +**Parameters** + +**pauli\_op** (`PauliOp`) – The `PauliOp` to evolve. + +**Return type** + +`PrimitiveOp` + +**Returns** + +A `PrimitiveOp`, either the evolution `CircuitOp` or a `PauliOp` equal to the identity if pauli\_op is the identity. + +## Attributes + + ### trotter @@ -39,3 +93,4 @@ TrotterizationBase used to evolve SummedOps. **Return type** `TrotterizationBase` + 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 0bbaa406522..78ae73fad20 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.QDrift.md @@ -1,8 +1,16 @@ -# QDrift +--- +title: QDrift +description: API reference for qiskit.opflow.evolutions.QDrift +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.QDrift +--- +# QDrift + -`QDrift(reps=1)` +`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` @@ -14,13 +22,33 @@ The QDrift Trotterization method, which selects each each term in the Trotteriza ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.evolutions.QDrift.convert#qiskit.opflow.evolutions.QDrift.convert "qiskit.opflow.evolutions.QDrift.convert") | Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. | +### convert -## Attributes + + +`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\`\`. +**Parameters** + +**operator** (`OperatorBase`) – The `SummedOp` to evolve. + +**Return type** +`OperatorBase` + +**Returns** + +The Operator approximating op\_sum’s evolution. + +**Raises** + +**TypeError** – A non-SummedOps Operator is passed into `convert`. + +## Attributes + + ### reps @@ -29,3 +57,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 aafcf01f737..e846c732386 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Suzuki.md @@ -1,8 +1,16 @@ -# Suzuki +--- +title: Suzuki +description: API reference for qiskit.opflow.evolutions.Suzuki +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.Suzuki +--- +# Suzuki + -`Suzuki(reps=1, order=2)` +`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` @@ -17,13 +25,33 @@ Detailed in [https://arxiv.org/pdf/quant-ph/0508139.pdf](https://arxiv.org/pdf/q ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.evolutions.Suzuki.convert#qiskit.opflow.evolutions.Suzuki.convert "qiskit.opflow.evolutions.Suzuki.convert") | Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. | +### convert -## Attributes + + +`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\`\`. + +**Parameters** + +**operator** (`OperatorBase`) – The `SummedOp` to evolve. + +**Return type** + +`OperatorBase` + +**Returns** +The Operator approximating op\_sum’s evolution. +**Raises** + +**TypeError** – A non-SummedOps Operator is passed into `convert`. + +## Attributes + + ### order @@ -33,7 +61,7 @@ returns order `int` - + ### reps @@ -42,3 +70,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 8756e364e04..e781c2e76c8 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.Trotter.md @@ -1,8 +1,16 @@ -# Trotter +--- +title: Trotter +description: API reference for qiskit.opflow.evolutions.Trotter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.Trotter +--- +# Trotter + -`Trotter(reps=1)` +`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` @@ -14,7 +22,7 @@ Simple Trotter expansion, composing the evolution circuits of each Operator in t ## Attributes - + ### order @@ -24,7 +32,7 @@ returns order `int` - + ### reps @@ -33,3 +41,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 75881432d19..95c23779df5 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationBase.md @@ -1,8 +1,16 @@ -# TrotterizationBase +--- +title: TrotterizationBase +description: API reference for qiskit.opflow.evolutions.TrotterizationBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.TrotterizationBase +--- +# TrotterizationBase + -`TrotterizationBase(reps=1)` +`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` @@ -10,13 +18,33 @@ A base for Trotterization methods, algorithms for approximating exponentiations ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.evolutions.TrotterizationBase.convert#qiskit.opflow.evolutions.TrotterizationBase.convert "qiskit.opflow.evolutions.TrotterizationBase.convert") | Convert a `SummedOp` into a `ComposedOp` or `CircuitOp` representing an approximation of e^-i\*\`\`op\_sum\`\`. | +### convert -## Attributes + + +`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\`\`. + +**Parameters** + +**operator** (`OperatorBase`) – The `SummedOp` to evolve. + +**Return type** + +`OperatorBase` + +**Returns** + +The Operator approximating op\_sum’s evolution. +**Raises** +**TypeError** – A non-SummedOps Operator is passed into `convert`. + +## Attributes + + ### reps @@ -25,3 +53,4 @@ The number of repetitions to use in the Trotterization, improving the approximat **Return type** `int` + 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 54af183b1d4..161563dd794 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.TrotterizationFactory.md @@ -1,8 +1,16 @@ -# TrotterizationFactory +--- +title: TrotterizationFactory +description: API reference for qiskit.opflow.evolutions.TrotterizationFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.evolutions.TrotterizationFactory +--- +# TrotterizationFactory + -`TrotterizationFactory` +`TrotterizationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/evolutions/trotterizations/trotterization_factory.py "view source code") Bases: `object` @@ -10,6 +18,28 @@ A factory for conveniently creating TrotterizationBase instances. ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`build`](qiskit.opflow.evolutions.TrotterizationFactory.build#qiskit.opflow.evolutions.TrotterizationFactory.build "qiskit.opflow.evolutions.TrotterizationFactory.build") | A factory for conveniently creating TrotterizationBase instances. | +### build + + + +`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. + +**Parameters** + +* **mode** (`str`) – One of ‘trotter’, ‘suzuki’, ‘qdrift’ +* **reps** (`int`) – The number of times to repeat the Trotterization circuit. + +**Return type** + +`TrotterizationBase` + +**Returns** + +The desired TrotterizationBase instance. + +**Raises** + +**ValueError** – A string not in \[‘trotter’, ‘suzuki’, ‘qdrift’] is given for mode. + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md index c740387cc4e..c1fbc4558e7 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.evolutions.md @@ -4,37 +4,37 @@ ## Operator Evolutions ([`qiskit.opflow.evolutions`](#module-qiskit.opflow.evolutions "qiskit.opflow.evolutions")) -Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp#qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp#qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. +Evolutions are converters which traverse an Operator tree, replacing any [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") e with a Schrodinger equation-style evolution [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equalling or approximating the matrix exponential of -i \* the Operator contained inside (e.primitive). The Evolutions are essentially implementations of Hamiltonian Simulation algorithms, including various methods for Trotterization. -The [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp#qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") is simply a placeholder signifying that the Operator inside it should be converted to its exponential by the Evolution converter. All Operators (not [`state_fns`](qiskit.opflow.state_fns#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) have `.exp_i()` methods which either return the exponential of the Operator directly, or an [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp#qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") containing the Operator. +The [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") is simply a placeholder signifying that the Operator inside it should be converted to its exponential by the Evolution converter. All Operators (not [`state_fns`](qiskit.opflow.state_fns#module-qiskit.opflow.state_fns "qiskit.opflow.state_fns")) have `.exp_i()` methods which either return the exponential of the Operator directly, or an [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp") containing the Operator. - Evolutions work with parameterized Operator coefficients, so `my_expectation.convert((t * H).exp_i())`, where t is a scalar or Terra Parameter and H is an Operator, will produce a [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp#qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equivalent to e^iHt. + Evolutions work with parameterized Operator coefficients, so `my_expectation.convert((t * H).exp_i())`, where t is a scalar or Terra Parameter and H is an Operator, will produce a [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp") equivalent to e^iHt. ### Evolution Base Class -The EvolutionBase class gives an interface for algorithms to ask for Evolutions as execution settings. For example, if an algorithm contains an Operator evolution step within it, such as [`QAOA`](qiskit.algorithms.QAOA#qiskit.algorithms.QAOA "qiskit.algorithms.QAOA"), the algorithm can give the opportunity for the user to pass an EvolutionBase of their choice to be used in that evolution step. +The EvolutionBase class gives an interface for algorithms to ask for Evolutions as execution settings. For example, if an algorithm contains an Operator evolution step within it, such as [`QAOA`](qiskit.algorithms.QAOA "qiskit.algorithms.QAOA"), the algorithm can give the opportunity for the user to pass an EvolutionBase of their choice to be used in that evolution step. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase#qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.EvolutionBase")() | A base for Evolution converters. | +| | | +| ---------------------------------------------------------------------------------------------------- | -------------------------------- | +| [`EvolutionBase`](qiskit.opflow.evolutions.EvolutionBase "qiskit.opflow.evolutions.EvolutionBase")() | A base for Evolution converters. | ### Evolutions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`EvolutionFactory`](qiskit.opflow.evolutions.EvolutionFactory#qiskit.opflow.evolutions.EvolutionFactory "qiskit.opflow.evolutions.EvolutionFactory")() | A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. | -| [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp#qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp")(primitive\[, coeff]) | Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. | -| [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution#qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution")() | Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. | -| [`PauliTrotterEvolution`](qiskit.opflow.evolutions.PauliTrotterEvolution#qiskit.opflow.evolutions.PauliTrotterEvolution "qiskit.opflow.evolutions.PauliTrotterEvolution")(\[trotter\_mode, reps]) | An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`EvolutionFactory`](qiskit.opflow.evolutions.EvolutionFactory "qiskit.opflow.evolutions.EvolutionFactory")() | A factory class for convenient automatic selection of an Evolution algorithm based on the Operator to be converted. | +| [`EvolvedOp`](qiskit.opflow.evolutions.EvolvedOp "qiskit.opflow.evolutions.EvolvedOp")(primitive\[, coeff]) | Class for wrapping Operator Evolutions for compilation (`convert`) by an EvolutionBase method later, essentially acting as a placeholder. | +| [`MatrixEvolution`](qiskit.opflow.evolutions.MatrixEvolution "qiskit.opflow.evolutions.MatrixEvolution")() | Performs Evolution by classical matrix exponentiation, constructing a circuit with `UnitaryGates` or `HamiltonianGates` containing the exponentiation of the Operator. | +| [`PauliTrotterEvolution`](qiskit.opflow.evolutions.PauliTrotterEvolution "qiskit.opflow.evolutions.PauliTrotterEvolution")(\[trotter\_mode, reps]) | An Evolution algorithm replacing exponentiated sums of Paulis by changing them each to the Z basis, rotating with an rZ, changing back, and Trotterizing. | ### Trotterizations -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase#qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.TrotterizationBase")(\[reps]) | A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. | -| [`TrotterizationFactory`](qiskit.opflow.evolutions.TrotterizationFactory#qiskit.opflow.evolutions.TrotterizationFactory "qiskit.opflow.evolutions.TrotterizationFactory")() | A factory for conveniently creating TrotterizationBase instances. | -| [`Trotter`](qiskit.opflow.evolutions.Trotter#qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | 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`. | -| [`Suzuki`](qiskit.opflow.evolutions.Suzuki#qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | 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. | -| [`QDrift`](qiskit.opflow.evolutions.QDrift#qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`TrotterizationBase`](qiskit.opflow.evolutions.TrotterizationBase "qiskit.opflow.evolutions.TrotterizationBase")(\[reps]) | A base for Trotterization methods, algorithms for approximating exponentiations of operator sums by compositions of exponentiations. | +| [`TrotterizationFactory`](qiskit.opflow.evolutions.TrotterizationFactory "qiskit.opflow.evolutions.TrotterizationFactory")() | A factory for conveniently creating TrotterizationBase instances. | +| [`Trotter`](qiskit.opflow.evolutions.Trotter "qiskit.opflow.evolutions.Trotter")(\[reps]) | 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`. | +| [`Suzuki`](qiskit.opflow.evolutions.Suzuki "qiskit.opflow.evolutions.Suzuki")(\[reps, order]) | 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. | +| [`QDrift`](qiskit.opflow.evolutions.QDrift "qiskit.opflow.evolutions.QDrift")(\[reps]) | The QDrift Trotterization method, which selects each each term in the Trotterization randomly, with a probability proportional to its weight. | 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 b9f17e6aafe..79cea305c20 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.AerPauliExpectation.md @@ -1,8 +1,16 @@ -# AerPauliExpectation +--- +title: AerPauliExpectation +description: API reference for qiskit.opflow.expectations.AerPauliExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.expectations.AerPauliExpectation +--- +# AerPauliExpectation + -`AerPauliExpectation` +`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` @@ -10,7 +18,43 @@ An Expectation converter for using Aer’s operator snapshot to take expectation ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.opflow.expectations.AerPauliExpectation.compute_variance#qiskit.opflow.expectations.AerPauliExpectation.compute_variance "qiskit.opflow.expectations.AerPauliExpectation.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.opflow.expectations.AerPauliExpectation.convert#qiskit.opflow.expectations.AerPauliExpectation.convert "qiskit.opflow.expectations.AerPauliExpectation.convert") | Accept an Operator and return a new Operator with the Pauli measurements replaced by AerSnapshot-based expectation circuits. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator after sampling. + +**Return type** + +`Union`\[`list`, `float`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation, equal to 0. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 9b3d36a1d21..527364945eb 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.CVaRExpectation.md @@ -1,8 +1,16 @@ -# CVaRExpectation +--- +title: CVaRExpectation +description: API reference for qiskit.opflow.expectations.CVaRExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.expectations.CVaRExpectation +--- +# CVaRExpectation + -`CVaRExpectation(alpha, expectation=None)` +`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` @@ -33,7 +41,45 @@ Let $\alpha$ be a real number in $[0,1]$ which specifies the fraction of best ob ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.opflow.expectations.CVaRExpectation.compute_variance#qiskit.opflow.expectations.CVaRExpectation.compute_variance "qiskit.opflow.expectations.CVaRExpectation.compute_variance") | Returns the variance of the CVaR calculation | -| [`convert`](qiskit.opflow.expectations.CVaRExpectation.convert#qiskit.opflow.expectations.CVaRExpectation.convert "qiskit.opflow.expectations.CVaRExpectation.convert") | Return an expression that computes the CVaR expectation upon calling `eval`. | +### compute\_variance + + + +`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 + +**Parameters** + +**exp\_op** (`OperatorBase`) – The operator whose evaluation yields an expectation of some StateFn against a diagonal observable. + +**Return type** + +`Union`\[`list`, `float`] + +**Returns** + +**The variance of the CVaR estimate corresponding to the converted** + +exp\_op. + +**Raises** + +**ValueError** – If the exp\_op does not correspond to an expectation value. + +### convert + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 faa4d7faf74..33966301d47 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationBase.md @@ -1,8 +1,16 @@ -# ExpectationBase +--- +title: ExpectationBase +description: API reference for qiskit.opflow.expectations.ExpectationBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.expectations.ExpectationBase +--- +# ExpectationBase + -`ExpectationBase` +`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` @@ -10,7 +18,43 @@ A base for Expectation value converters. Expectations are converters which enabl ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.opflow.expectations.ExpectationBase.compute_variance#qiskit.opflow.expectations.ExpectationBase.compute_variance "qiskit.opflow.expectations.ExpectationBase.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.opflow.expectations.ExpectationBase.convert#qiskit.opflow.expectations.ExpectationBase.convert "qiskit.opflow.expectations.ExpectationBase.convert") | Accept an Operator and return a new Operator with the measurements replaced by alternate methods to compute the expectation value. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator after sampling. + +**Return type** + +`Union`\[`list`, `complex`, `ndarray`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 e51d7b303c2..afcaea6d4a0 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.ExpectationFactory.md @@ -1,8 +1,16 @@ -# ExpectationFactory +--- +title: ExpectationFactory +description: API reference for qiskit.opflow.expectations.ExpectationFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.expectations.ExpectationFactory +--- +# ExpectationFactory + -`ExpectationFactory` +`ExpectationFactory`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/expectations/expectation_factory.py "view source code") Bases: `object` @@ -10,6 +18,29 @@ A factory class for convenient automatic selection of an Expectation based on th ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`build`](qiskit.opflow.expectations.ExpectationFactory.build#qiskit.opflow.expectations.ExpectationFactory.build "qiskit.opflow.expectations.ExpectationFactory.build") | A factory method for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. | +### build + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – The Operator whose expectation value will be taken. +* **backend** (`Union`\[`Backend`, `BaseBackend`, `QuantumInstance`, `None`]) – The backend which will be used to sample the expectation value. +* **include\_custom** (`bool`) – Whether the factory will include the (Aer) specific custom expectations if their behavior against the backend might not be as expected. For instance when using Aer qasm\_simulator with paulis the Aer snapshot can be used but the outcome lacks shot noise and hence does not intuitively behave overall as people might expect when choosing a qasm\_simulator. It is however fast as long as the more state vector like behavior is acceptable. + +**Return type** + +`ExpectationBase` + +**Returns** + +The expectation algorithm which best fits the Operator and backend. + +**Raises** + +**ValueError** – If operator is not of a composition for which we know the best Expectation method. + 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 e7dad0a727e..f6b8202b43d 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.MatrixExpectation.md @@ -1,8 +1,16 @@ -# MatrixExpectation +--- +title: MatrixExpectation +description: API reference for qiskit.opflow.expectations.MatrixExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.expectations.MatrixExpectation +--- +# MatrixExpectation + -`MatrixExpectation` +`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` @@ -10,7 +18,43 @@ An Expectation converter which converts Operator measurements to be matrix-based ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| [`compute_variance`](qiskit.opflow.expectations.MatrixExpectation.compute_variance#qiskit.opflow.expectations.MatrixExpectation.compute_variance "qiskit.opflow.expectations.MatrixExpectation.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.opflow.expectations.MatrixExpectation.convert#qiskit.opflow.expectations.MatrixExpectation.convert "qiskit.opflow.expectations.MatrixExpectation.convert") | Accept an Operator and return a new Operator with the Pauli measurements replaced by Matrix based measurements. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator. + +**Return type** + +`Union`\[`list`, `float`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation, equal to 0. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + 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 35fffb5bcf5..c07db9f3256 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.PauliExpectation.md @@ -1,8 +1,16 @@ -# PauliExpectation +--- +title: PauliExpectation +description: API reference for qiskit.opflow.expectations.PauliExpectation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.expectations.PauliExpectation +--- +# PauliExpectation + -`PauliExpectation(group_paulis=True)` +`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` @@ -14,7 +22,43 @@ An Expectation converter for Pauli-basis observables by changing Pauli measureme ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`compute_variance`](qiskit.opflow.expectations.PauliExpectation.compute_variance#qiskit.opflow.expectations.PauliExpectation.compute_variance "qiskit.opflow.expectations.PauliExpectation.compute_variance") | Compute the variance of the expectation estimator. | -| [`convert`](qiskit.opflow.expectations.PauliExpectation.convert#qiskit.opflow.expectations.PauliExpectation.convert "qiskit.opflow.expectations.PauliExpectation.convert") | 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. | +### compute\_variance + + + +`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. + +**Parameters** + +**exp\_op** (`OperatorBase`) – The full expectation value Operator after sampling. + +**Return type** + +`Union`\[`list`, `float`, `ndarray`] + +**Returns** + +The variances or lists thereof (if exp\_op contains ListOps) of the expectation value estimation. + +### convert + + + +`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. + +**Parameters** + +**operator** (`OperatorBase`) – The operator to convert. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted operator. + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.expectations.md b/docs/api/qiskit/0.32/qiskit.opflow.expectations.md index ed841591e53..5f7f2c40cb7 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.expectations.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.expectations.md @@ -4,22 +4,22 @@ ## Expectations ([`qiskit.opflow.expectations`](#module-qiskit.opflow.expectations "qiskit.opflow.expectations")) -Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn#qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation#qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler#qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. +Expectations are converters which enable the computation of the expectation value of an Observable with respect to some state function. They traverse an Operator tree, replacing [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn") measurements with equivalent measurements which are more amenable to computation on quantum or classical hardware. For example, if one would like to measure the expectation value of an Operator `o` expressed as a sum of Paulis with respect to some state function, but only has access to diagonal measurements on Quantum hardware, we can create a measurement \~StateFn(o), use a [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation") to convert it to a diagonal measurement and circuit pre-rotations to append to the state, and sample this circuit on Quantum hardware with a [`CircuitSampler`](qiskit.opflow.converters.CircuitSampler "qiskit.opflow.converters.CircuitSampler"). All in all, this would be: `my_sampler.convert(my_expect.convert(~StateFn(o)) @ my_state).eval()`. ### Expectation Base Class -The ExpectationBase class gives an interface for algorithms to ask for Expectations as execution settings. For example, if an algorithm contains an expectation value step within it, such as [`VQE`](qiskit.algorithms.VQE#qiskit.algorithms.VQE "qiskit.algorithms.VQE"), the algorithm can give the opportunity for the user to pass an ExpectationBase of their choice to be used in that expectation value step. +The ExpectationBase class gives an interface for algorithms to ask for Expectations as execution settings. For example, if an algorithm contains an expectation value step within it, such as [`VQE`](qiskit.algorithms.VQE "qiskit.algorithms.VQE"), the algorithm can give the opportunity for the user to pass an ExpectationBase of their choice to be used in that expectation value step. -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase#qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.ExpectationBase")() | A base for Expectation value converters. | +| | | +| -------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| [`ExpectationBase`](qiskit.opflow.expectations.ExpectationBase "qiskit.opflow.expectations.ExpectationBase")() | A base for Expectation value converters. | ### Expectations -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`ExpectationFactory`](qiskit.opflow.expectations.ExpectationFactory#qiskit.opflow.expectations.ExpectationFactory "qiskit.opflow.expectations.ExpectationFactory")() | A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. | -| [`AerPauliExpectation`](qiskit.opflow.expectations.AerPauliExpectation#qiskit.opflow.expectations.AerPauliExpectation "qiskit.opflow.expectations.AerPauliExpectation")() | An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. | -| [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation#qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | -| [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation#qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | 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. | -| [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation#qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`ExpectationFactory`](qiskit.opflow.expectations.ExpectationFactory "qiskit.opflow.expectations.ExpectationFactory")() | A factory class for convenient automatic selection of an Expectation based on the Operator to be converted and backend used to sample the expectation value. | +| [`AerPauliExpectation`](qiskit.opflow.expectations.AerPauliExpectation "qiskit.opflow.expectations.AerPauliExpectation")() | An Expectation converter for using Aer’s operator snapshot to take expectations of quantum state circuits over Pauli observables. | +| [`MatrixExpectation`](qiskit.opflow.expectations.MatrixExpectation "qiskit.opflow.expectations.MatrixExpectation")() | An Expectation converter which converts Operator measurements to be matrix-based so they can be evaluated by matrix multiplication. | +| [`PauliExpectation`](qiskit.opflow.expectations.PauliExpectation "qiskit.opflow.expectations.PauliExpectation")(\[group\_paulis]) | 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. | +| [`CVaRExpectation`](qiskit.opflow.expectations.CVaRExpectation "qiskit.opflow.expectations.CVaRExpectation")(alpha\[, expectation]) | Compute the Conditional Value at Risk (CVaR) expectation value. | 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 d8c1f3abf89..d6afd8ebc0b 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitGradient.md @@ -1,8 +1,16 @@ -# CircuitGradient +--- +title: CircuitGradient +description: API reference for qiskit.opflow.gradients.CircuitGradient +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.CircuitGradient +--- +# CircuitGradient + -`CircuitGradient` +`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` @@ -16,6 +24,26 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`convert`](qiskit.opflow.gradients.CircuitGradient.convert#qiskit.opflow.gradients.CircuitGradient.convert "qiskit.opflow.gradients.CircuitGradient.convert") | **type operator**`OperatorBase` | +### convert + + + +`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** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient of +* **params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters we are taking the gradient wrt: ω If a ParameterExpression, ParameterVector or List\[ParameterExpression] is given, then the 1st order derivative of the operator is calculated. If a Tuple\[ParameterExpression, ParameterExpression] or List\[Tuple\[ParameterExpression, ParameterExpression]] is given, then the 2nd order derivative of the operator is calculated. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the Gradient. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + 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 05ac62119c5..f375c3475b6 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.CircuitQFI.md @@ -1,8 +1,16 @@ -# CircuitQFI +--- +title: CircuitQFI +description: API reference for qiskit.opflow.gradients.CircuitQFI +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.CircuitQFI +--- +# CircuitQFI + -`CircuitQFI` +`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` @@ -16,6 +24,26 @@ CircuitQFI - uses quantum techniques to get the QFI of circuits DerivativeBase - ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`convert`](qiskit.opflow.gradients.CircuitQFI.convert#qiskit.opflow.gradients.CircuitQFI.convert "qiskit.opflow.gradients.CircuitQFI.convert") | **type operator**`OperatorBase` | +### convert + + + +`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** + +* **operator** (`OperatorBase`) – The operator corresponding to the quantum state $|\psi(\omega)\rangle$ for which we compute the QFI. +* **params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The parameters $\omega$ with respect to which we are computing the QFI. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the QFI metric tensor. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + 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 1ec46459acb..598fc181127 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.DerivativeBase.md @@ -1,8 +1,16 @@ -# DerivativeBase +--- +title: DerivativeBase +description: API reference for qiskit.opflow.gradients.DerivativeBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.DerivativeBase +--- +# DerivativeBase + -`DerivativeBase` +`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` @@ -16,8 +24,71 @@ CircuitGradient - uses quantum techniques to get derivatives of circuits Derivat ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.opflow.gradients.DerivativeBase.convert#qiskit.opflow.gradients.DerivativeBase.convert "qiskit.opflow.gradients.DerivativeBase.convert") | **type operator**`OperatorBase` | -| [`gradient_wrapper`](qiskit.opflow.gradients.DerivativeBase.gradient_wrapper#qiskit.opflow.gradients.DerivativeBase.gradient_wrapper "qiskit.opflow.gradients.DerivativeBase.gradient_wrapper") | Get a callable function which provides the respective gradient, Hessian or QFI for given parameter values. | -| [`parameter_expression_grad`](qiskit.opflow.gradients.DerivativeBase.parameter_expression_grad#qiskit.opflow.gradients.DerivativeBase.parameter_expression_grad "qiskit.opflow.gradients.DerivativeBase.parameter_expression_grad") | Get the derivative of a parameter expression w\.r.t. | +### convert + + + +`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** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient, Hessian or QFI of +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient, Hessian or QFI with respect to. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the gradient, Hessian or QFI. + +**Raises** + +**ValueError** – If `params` contains a parameter not present in `operator`. + +### gradient\_wrapper + + + +`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. + +**Parameters** + +* **operator** (`OperatorBase`) – The operator for which we want to get the gradient, Hessian or QFI. +* **bind\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – The operator parameters to which the parameter values are assigned. +* **grad\_params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`], `Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `None`]) – The parameters with respect to which we are taking the gradient, Hessian or QFI. If grad\_params = None, then grad\_params = bind\_params +* **backend** (`Union`\[`Backend`, `BaseBackend`, `QuantumInstance`, `None`]) – The quantum backend or QuantumInstance to use to evaluate the gradient, Hessian or QFI. +* **expectation** (`Optional`\[`ExpectationBase`]) – The expectation converter to be used. If none is set then PauliExpectation() is used. + +**Return type** + +`Callable`\[\[`Iterable`], `ndarray`] + +**Returns** + +Function to compute a gradient, Hessian or QFI. The function takes an iterable as argument which holds the parameter values. + +### parameter\_expression\_grad + + + +`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. + +**Parameters** + +* **param\_expr** (`ParameterExpression`) – The Parameter Expression for which we compute the derivative +* **param** (`ParameterExpression`) – Parameter w\.r.t. which we want to take the derivative + +**Return type** + +`Union`\[`ParameterExpression`, `float`] + +**Returns** + +ParameterExpression representing the gradient of param\_expr w\.r.t. param + 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 f61954a508d..850df331191 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Gradient.md @@ -1,8 +1,16 @@ -# Gradient +--- +title: Gradient +description: API reference for qiskit.opflow.gradients.Gradient +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.Gradient +--- +# Gradient + -`Gradient(grad_method='param_shift', **kwargs)` +`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` @@ -19,14 +27,63 @@ Convert an operator expression to the first-order gradient. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| [`convert`](qiskit.opflow.gradients.Gradient.convert#qiskit.opflow.gradients.Gradient.convert "qiskit.opflow.gradients.Gradient.convert") | **type operator**`OperatorBase` | -| [`get_gradient`](qiskit.opflow.gradients.Gradient.get_gradient#qiskit.opflow.gradients.Gradient.get_gradient "qiskit.opflow.gradients.Gradient.get_gradient") | Get the gradient for the given operator w\.r.t. | +### convert -## Attributes + + +`Gradient.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/gradient.py "view source code") + +**Parameters** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient of. +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient with respect to. If not explicitly passed, they are inferred from the operator and sorted by name. + +**Return type** + +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the Gradient. + +**Raises** + +* **ValueError** – If `params` contains a parameter not present in `operator`. +* **ValueError** – If `operator` is not parameterized. + +### get\_gradient + +`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 + +**Parameters** + +* **operator** (`OperatorBase`) – Operator w\.r.t. which we take the gradient. +* **params** (`Union`\[`ParameterExpression`, `ParameterVector`, `List`\[`ParameterExpression`]]) – Parameters w\.r.t. which we compute the gradient. + +**Return type** + +`OperatorBase` + +**Returns** + +Operator which represents the gradient w\.r.t. the given params. + +**Raises** + +* **ValueError** – If `params` contains a parameter not present in `operator`. +* [**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If the coefficient of the operator could not be reduced to 1. +* [**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If the differentiation of a combo\_fn requires JAX but the package is not installed. +* **TypeError** – If the operator does not include a StateFn given by a quantum circuit +* **Exception** – Unintended code is reached +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – jax not installed + +## Attributes + + ### grad\_method @@ -39,3 +96,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 a72f1e25b43..8d79589afe0 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.GradientBase.md @@ -1,8 +1,16 @@ -# GradientBase +--- +title: GradientBase +description: API reference for qiskit.opflow.gradients.GradientBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.GradientBase +--- +# GradientBase + -`GradientBase(grad_method='param_shift', **kwargs)` +`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` @@ -21,7 +29,7 @@ Convert an operator expression to the first-order gradient. ## Attributes - + ### grad\_method @@ -34,3 +42,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 4905483b8de..352d43dd268 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.Hessian.md @@ -1,8 +1,16 @@ -# Hessian +--- +title: Hessian +description: API reference for qiskit.opflow.gradients.Hessian +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.Hessian +--- +# Hessian + -`Hessian(hess_method='param_shift', **kwargs)` +`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` @@ -19,14 +27,60 @@ Compute the Hessian of an expected value. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | -| [`convert`](qiskit.opflow.gradients.Hessian.convert#qiskit.opflow.gradients.Hessian.convert "qiskit.opflow.gradients.Hessian.convert") | **type operator**`OperatorBase` | -| [`get_hessian`](qiskit.opflow.gradients.Hessian.get_hessian#qiskit.opflow.gradients.Hessian.get_hessian "qiskit.opflow.gradients.Hessian.get_hessian") | Get the Hessian for the given operator w\.r.t. | +### convert -## Attributes + + +`Hessian.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/hessian.py "view source code") + +**Parameters** + +* **operator** (`OperatorBase`) – The operator for which we compute the Hessian +* **params** (`Union`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `List`\[`ParameterExpression`], `ParameterVector`, `None`]) – The parameters we are computing the Hessian with respect to Either give directly the tuples/list of tuples for which the second order derivative is to be computed or give a list of parameters to build the full Hessian for those parameters. If not explicitly passed, the full Hessian is constructed. The parameters are then inferred from the operator and sorted by name. + +**Returns** + +An operator whose evaluation yields the Hessian + +**Return type** +[OperatorBase](qiskit.aqua.operators.OperatorBase "qiskit.aqua.operators.OperatorBase") +### get\_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") + +Get the Hessian for the given operator w\.r.t. the given parameters + +**Parameters** + +* **operator** (`OperatorBase`) – Operator w\.r.t. which we take the Hessian. +* **params** (`Union`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`], `List`\[`Tuple`\[`ParameterExpression`, `ParameterExpression`]], `List`\[`ParameterExpression`], `ParameterVector`, `None`]) – Parameters w\.r.t. which we compute the Hessian. If not explicitly passed, the full Hessian is constructed. The parameters are then inferred from the operator and sorted by name. + +**Return type** + +`OperatorBase` + +**Returns** + +Operator which represents the gradient w\.r.t. the given params. + +**Raises** + +* **ValueError** – If `params` contains a parameter not present in `operator`. +* **ValueError** – If `operator` is not parameterized. +* [**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If the coefficient of the operator could not be reduced to 1. +* [**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If the differentiation of a combo\_fn requires JAX but the package is not installed. +* **TypeError** – If the operator does not include a StateFn given by a quantum circuit +* **TypeError** – If the parameters were given in an unsupported format. +* **Exception** – Unintended code is reached +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – jax not installed + +## Attributes + + ### hess\_method @@ -39,3 +93,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 dd3c5a9a613..f4ac8a832c8 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.HessianBase.md @@ -1,8 +1,16 @@ -# HessianBase +--- +title: HessianBase +description: API reference for qiskit.opflow.gradients.HessianBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.HessianBase +--- +# HessianBase + -`HessianBase(hess_method='param_shift', **kwargs)` +`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` @@ -19,7 +27,7 @@ Base class for the Hessian of an expected value. ## Attributes - + ### hess\_method @@ -32,3 +40,4 @@ Returns `CircuitGradient`. **Returns** `CircuitGradient`. + 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 08e228f8680..11e541cabb8 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.NaturalGradient.md @@ -1,8 +1,16 @@ -# NaturalGradient +--- +title: NaturalGradient +description: API reference for qiskit.opflow.gradients.NaturalGradient +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.NaturalGradient +--- +# NaturalGradient + -`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)` +`NaturalGradient(grad_method='lin_comb', qfi_method='lin_comb_full', regularization=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/natural_gradient.py "view source code") Bases: `qiskit.opflow.gradients.gradient_base.GradientBase` @@ -27,13 +35,34 @@ where R(x) represents the penalization term. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`convert`](qiskit.opflow.gradients.NaturalGradient.convert#qiskit.opflow.gradients.NaturalGradient.convert "qiskit.opflow.gradients.NaturalGradient.convert") | **type operator**`OperatorBase` | +### convert -## Attributes + + +`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** + +* **operator** (`OperatorBase`) – The operator we are taking the gradient of. +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are taking the gradient with respect to. If not explicitly passed, they are inferred from the operator and sorted by name. +**Return type** +`OperatorBase` + +**Returns** + +An operator whose evaluation yields the NaturalGradient. + +**Raises** + +* **TypeError** – If `operator` does not represent an expectation value or the quantum state is not `CircuitStateFn`. +* **ValueError** – If `params` contains a parameter not present in `operator`. +* **ValueError** – If `operator` is not parameterized. + +## Attributes + + ### grad\_method @@ -47,7 +76,7 @@ Returns `CircuitGradient`. `CircuitGradient`. - + ### qfi\_method @@ -59,7 +88,7 @@ Returns: `CircuitQFI` `CircuitQFI` - + ### regularization @@ -70,3 +99,4 @@ Returns: the regularization option. **Return type** `Optional`\[`str`] + 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 c635474af21..08944253b50 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFI.md @@ -1,8 +1,16 @@ -# QFI +--- +title: QFI +description: API reference for qiskit.opflow.gradients.QFI +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.QFI +--- +# QFI + -`QFI(qfi_method='lin_comb_full')` +`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` @@ -17,7 +25,7 @@ $$ **Parameters** -**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.opflow.gradients.CircuitQFI#qiskit.opflow.gradients.CircuitQFI "qiskit.opflow.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. +**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.opflow.gradients.CircuitQFI "qiskit.opflow.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. **Raises** @@ -25,13 +33,32 @@ $$ ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`convert`](qiskit.opflow.gradients.QFI.convert#qiskit.opflow.gradients.QFI.convert "qiskit.opflow.gradients.QFI.convert") | **type operator**`CircuitStateFn` | +### convert -## Attributes + + +`QFI.convert(operator, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/gradients/qfi.py "view source code") + +**Parameters** + +* **operator** (`CircuitStateFn`) – The operator corresponding to the quantum state |ψ(ω)〉for which we compute the QFI +* **params** (`Union`\[`ParameterVector`, `ParameterExpression`, `List`\[`ParameterExpression`], `None`]) – The parameters we are computing the QFI wrt: ω If not explicitly passed, they are inferred from the operator and sorted by name. + +**Return type** +`ListOp` +**Returns** + +ListOp\[ListOp] where the operator at position k,l corresponds to QFI\_kl + +**Raises** + +**ValueError** – If operator is not parameterized. + +## Attributes + + ### qfi\_method @@ -44,3 +71,4 @@ Returns `CircuitQFI`. **Returns** `CircuitQFI`. + 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 3864ed83516..407fe1b1b01 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.QFIBase.md @@ -1,8 +1,16 @@ -# QFIBase +--- +title: QFIBase +description: API reference for qiskit.opflow.gradients.QFIBase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.gradients.QFIBase +--- +# QFIBase + -`QFIBase(qfi_method='lin_comb_full')` +`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` @@ -16,7 +24,7 @@ The QFI is: **Parameters** -**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.opflow.gradients.CircuitQFI#qiskit.opflow.gradients.CircuitQFI "qiskit.opflow.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. +**qfi\_method** (`Union`\[`str`, `CircuitQFI`]) – The method used to compute the state/probability gradient. Can be either a [`CircuitQFI`](qiskit.opflow.gradients.CircuitQFI "qiskit.opflow.gradients.CircuitQFI") instance or one of the following pre-defined strings `'lin_comb_full'`, `` 'overlap_diag'` `` or `` 'overlap_block_diag'` ``. **Raises** @@ -24,7 +32,7 @@ The QFI is: ## Attributes - + ### qfi\_method @@ -37,3 +45,4 @@ Returns `CircuitQFI`. **Returns** `CircuitQFI`. + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.gradients.md b/docs/api/qiskit/0.32/qiskit.opflow.gradients.md index 2893d09979f..d47fd11d45b 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.gradients.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.gradients.md @@ -87,25 +87,25 @@ The derivative classes come with a gradient\_wrapper() function which returns th ### Base Classes -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | -| [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase#qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.DerivativeBase")() | Base class for differentiating opflow objects. | -| [`GradientBase`](qiskit.opflow.gradients.GradientBase#qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.GradientBase")(\[grad\_method]) | Base class for first-order operator gradient. | -| [`HessianBase`](qiskit.opflow.gradients.HessianBase#qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.HessianBase")(\[hess\_method]) | Base class for the Hessian of an expected value. | -| [`QFIBase`](qiskit.opflow.gradients.QFIBase#qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.QFIBase")(\[qfi\_method]) | Base class for Quantum Fisher Information (QFI). | +| | | +| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | +| [`DerivativeBase`](qiskit.opflow.gradients.DerivativeBase "qiskit.opflow.gradients.DerivativeBase")() | Base class for differentiating opflow objects. | +| [`GradientBase`](qiskit.opflow.gradients.GradientBase "qiskit.opflow.gradients.GradientBase")(\[grad\_method]) | Base class for first-order operator gradient. | +| [`HessianBase`](qiskit.opflow.gradients.HessianBase "qiskit.opflow.gradients.HessianBase")(\[hess\_method]) | Base class for the Hessian of an expected value. | +| [`QFIBase`](qiskit.opflow.gradients.QFIBase "qiskit.opflow.gradients.QFIBase")(\[qfi\_method]) | Base class for Quantum Fisher Information (QFI). | ### Converters -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------- | -| [`CircuitGradient`](qiskit.opflow.gradients.CircuitGradient#qiskit.opflow.gradients.CircuitGradient "qiskit.opflow.gradients.CircuitGradient")() | Circuit to gradient operator converter. | -| [`CircuitQFI`](qiskit.opflow.gradients.CircuitQFI#qiskit.opflow.gradients.CircuitQFI "qiskit.opflow.gradients.CircuitQFI")() | Circuit to Quantum Fisher Information operator converter. | +| | | +| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | +| [`CircuitGradient`](qiskit.opflow.gradients.CircuitGradient "qiskit.opflow.gradients.CircuitGradient")() | Circuit to gradient operator converter. | +| [`CircuitQFI`](qiskit.opflow.gradients.CircuitQFI "qiskit.opflow.gradients.CircuitQFI")() | Circuit to Quantum Fisher Information operator converter. | ### Derivatives -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`Gradient`](qiskit.opflow.gradients.Gradient#qiskit.opflow.gradients.Gradient "qiskit.opflow.gradients.Gradient")(\[grad\_method]) | Convert an operator expression to the first-order gradient. | -| [`Hessian`](qiskit.opflow.gradients.Hessian#qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | -| [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient#qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | -| [`QFI`](qiskit.opflow.gradients.QFI#qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| [`Gradient`](qiskit.opflow.gradients.Gradient "qiskit.opflow.gradients.Gradient")(\[grad\_method]) | Convert an operator expression to the first-order gradient. | +| [`Hessian`](qiskit.opflow.gradients.Hessian "qiskit.opflow.gradients.Hessian")(\[hess\_method]) | Compute the Hessian of an expected value. | +| [`NaturalGradient`](qiskit.opflow.gradients.NaturalGradient "qiskit.opflow.gradients.NaturalGradient")(\[grad\_method, qfi\_method, …]) | Convert an operator expression to the first-order gradient. | +| [`QFI`](qiskit.opflow.gradients.QFI "qiskit.opflow.gradients.QFI")(\[qfi\_method]) | Compute the Quantum Fisher Information (QFI). | 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 424ad2e3b10..03cc0694b50 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 @@ -1,8 +1,16 @@ -# ComposedOp +--- +title: ComposedOp +description: API reference for qiskit.opflow.list_ops.ComposedOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.list_ops.ComposedOp +--- +# ComposedOp + -`ComposedOp(oplist, coeff=1.0, abelian=False)` +`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` @@ -16,24 +24,139 @@ A class for lazily representing compositions of Operators. Often Operators canno ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -| [`adjoint`](qiskit.opflow.list_ops.ComposedOp.adjoint#qiskit.opflow.list_ops.ComposedOp.adjoint "qiskit.opflow.list_ops.ComposedOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`compose`](qiskit.opflow.list_ops.ComposedOp.compose#qiskit.opflow.list_ops.ComposedOp.compose "qiskit.opflow.list_ops.ComposedOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`eval`](qiskit.opflow.list_ops.ComposedOp.eval#qiskit.opflow.list_ops.ComposedOp.eval "qiskit.opflow.list_ops.ComposedOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`non_distributive_reduce`](qiskit.opflow.list_ops.ComposedOp.non_distributive_reduce#qiskit.opflow.list_ops.ComposedOp.non_distributive_reduce "qiskit.opflow.list_ops.ComposedOp.non_distributive_reduce") | Reduce without attempting to expand all distributive compositions. | -| [`reduce`](qiskit.opflow.list_ops.ComposedOp.reduce#qiskit.opflow.list_ops.ComposedOp.reduce "qiskit.opflow.list_ops.ComposedOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`to_circuit`](qiskit.opflow.list_ops.ComposedOp.to_circuit#qiskit.opflow.list_ops.ComposedOp.to_circuit "qiskit.opflow.list_ops.ComposedOp.to_circuit") | Returns the quantum circuit, representing the composed operator. | +### adjoint -## Attributes + + +`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. + +**Return type** + +`ComposedOp` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### eval + + + +`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). + +ListOp’s eval recursively evaluates each Operator in `oplist`, and combines the results using the recombination function `combo_fn`. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the `oplist` Operators’ evaluation function, combined with the `combo_fn`. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +**Raises** + +* **NotImplementedError** – Raised if called for a subclass which is not distributive. +* **TypeError** – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported. +* **NotImplementedError** – Attempting to call ListOp’s eval from a non-distributive subclass. + +### non\_distributive\_reduce + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The circuit representation of the composed operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – for operators where a single underlying circuit can not be obtained. + +## Attributes + + ### INDENTATION `= ' '` - + ### abelian @@ -47,7 +170,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -61,7 +184,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -75,7 +198,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -83,7 +206,7 @@ The combination function. `bool` - + ### grad\_combo\_fn @@ -93,7 +216,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### instance\_id @@ -103,7 +226,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -111,7 +234,7 @@ Return the unique instance id. `int` - + ### oplist @@ -125,11 +248,11 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters - + ### settings @@ -138,3 +261,4 @@ Return settings. **Return type** `Dict` + 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 5b931c288d7..7f1a289097d 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 @@ -1,8 +1,16 @@ -# ListOp +--- +title: ListOp +description: API reference for qiskit.opflow.list_ops.ListOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.list_ops.ListOp +--- +# ListOp + -`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)` +`ListOp(oplist, combo_fn=None, coeff=1.0, abelian=False, grad_combo_fn=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/list_ops/list_op.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -25,40 +33,404 @@ The base `ListOp` class is particularly interesting, as its `combo_fn` is “the ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.list_ops.ListOp.add#qiskit.opflow.list_ops.ListOp.add "qiskit.opflow.list_ops.ListOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.list_ops.ListOp.adjoint#qiskit.opflow.list_ops.ListOp.adjoint "qiskit.opflow.list_ops.ListOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.opflow.list_ops.ListOp.assign_parameters#qiskit.opflow.list_ops.ListOp.assign_parameters "qiskit.opflow.list_ops.ListOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`compose`](qiskit.opflow.list_ops.ListOp.compose#qiskit.opflow.list_ops.ListOp.compose "qiskit.opflow.list_ops.ListOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`default_combo_fn`](qiskit.opflow.list_ops.ListOp.default_combo_fn#qiskit.opflow.list_ops.ListOp.default_combo_fn "qiskit.opflow.list_ops.ListOp.default_combo_fn") | ListOp default combo function i.e. lambda x: x. | -| [`equals`](qiskit.opflow.list_ops.ListOp.equals#qiskit.opflow.list_ops.ListOp.equals "qiskit.opflow.list_ops.ListOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.list_ops.ListOp.eval#qiskit.opflow.list_ops.ListOp.eval "qiskit.opflow.list_ops.ListOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.opflow.list_ops.ListOp.exp_i#qiskit.opflow.list_ops.ListOp.exp_i "qiskit.opflow.list_ops.ListOp.exp_i") | Return an `OperatorBase` equivalent to an exponentiation of self \* -i, e^(-i\*op). | -| [`log_i`](qiskit.opflow.list_ops.ListOp.log_i#qiskit.opflow.list_ops.ListOp.log_i "qiskit.opflow.list_ops.ListOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.opflow.list_ops.ListOp.mul#qiskit.opflow.list_ops.ListOp.mul "qiskit.opflow.list_ops.ListOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`permute`](qiskit.opflow.list_ops.ListOp.permute#qiskit.opflow.list_ops.ListOp.permute "qiskit.opflow.list_ops.ListOp.permute") | Permute the qubits of the operator. | -| [`power`](qiskit.opflow.list_ops.ListOp.power#qiskit.opflow.list_ops.ListOp.power "qiskit.opflow.list_ops.ListOp.power") | Return Operator composed with self multiple times, overloaded by `**`. | -| [`primitive_strings`](qiskit.opflow.list_ops.ListOp.primitive_strings#qiskit.opflow.list_ops.ListOp.primitive_strings "qiskit.opflow.list_ops.ListOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.list_ops.ListOp.reduce#qiskit.opflow.list_ops.ListOp.reduce "qiskit.opflow.list_ops.ListOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.opflow.list_ops.ListOp.tensor#qiskit.opflow.list_ops.ListOp.tensor "qiskit.opflow.list_ops.ListOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.opflow.list_ops.ListOp.tensorpower#qiskit.opflow.list_ops.ListOp.tensorpower "qiskit.opflow.list_ops.ListOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit_op`](qiskit.opflow.list_ops.ListOp.to_circuit_op#qiskit.opflow.list_ops.ListOp.to_circuit_op "qiskit.opflow.list_ops.ListOp.to_circuit_op") | Returns an equivalent Operator composed of only QuantumCircuit-based primitives, such as `CircuitOp` and `CircuitStateFn`. | -| [`to_matrix`](qiskit.opflow.list_ops.ListOp.to_matrix#qiskit.opflow.list_ops.ListOp.to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.list_ops.ListOp.to_matrix_op#qiskit.opflow.list_ops.ListOp.to_matrix_op "qiskit.opflow.list_ops.ListOp.to_matrix_op") | Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. | -| [`to_pauli_op`](qiskit.opflow.list_ops.ListOp.to_pauli_op#qiskit.opflow.list_ops.ListOp.to_pauli_op "qiskit.opflow.list_ops.ListOp.to_pauli_op") | Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. | -| [`to_spmatrix`](qiskit.opflow.list_ops.ListOp.to_spmatrix#qiskit.opflow.list_ops.ListOp.to_spmatrix "qiskit.opflow.list_ops.ListOp.to_spmatrix") | Returns SciPy sparse matrix representation of the Operator. | -| [`traverse`](qiskit.opflow.list_ops.ListOp.traverse#qiskit.opflow.list_ops.ListOp.traverse "qiskit.opflow.list_ops.ListOp.traverse") | Apply the convert\_fn to each node in the oplist. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`ListOp` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`ListOp` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### default\_combo\_fn + + + +`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 +**Return type** + +`Any` + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +ListOp’s eval recursively evaluates each Operator in `oplist`, and combines the results using the recombination function `combo_fn`. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the `oplist` Operators’ evaluation function, combined with the `combo_fn`. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +**Raises** + +* **NotImplementedError** – Raised if called for a subclass which is not distributive. +* **TypeError** – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported. +* **NotImplementedError** – Attempting to call ListOp’s eval from a non-distributive subclass. + +### exp\_i + + + +`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). + +**Return type** + +`OperatorBase` + +### log\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`ListOp` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new ListOp representing the permuted operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if indices do not define a new index for each qubit. + +### power + + + +`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 `**`. + +**Return type** + +`OperatorBase` + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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`. + +**Return type** + +`ListOp` + +### to\_pauli\_op + + + +`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`. + +**Return type** + +`ListOp` + +### to\_spmatrix + + + +`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. + +**Return type** + +`Union`\[`spmatrix`, `List`\[`spmatrix`]] + +**Returns** + +CSR sparse matrix representation of the Operator, or List thereof. + +### traverse + + + +`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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`ListOp` + +**Returns** + +The converted ListOp. + +## Attributes + + ### INDENTATION `= ' '` - + ### abelian @@ -72,7 +444,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -86,7 +458,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -100,7 +472,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -114,7 +486,7 @@ Indicates whether the ListOp or subclass is distributive under composition. List A bool indicating whether the ListOp is distributive under composition. - + ### grad\_combo\_fn @@ -124,7 +496,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### instance\_id @@ -134,7 +506,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -142,7 +514,7 @@ Return the unique instance id. `int` - + ### oplist @@ -156,11 +528,11 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters - + ### settings @@ -169,3 +541,4 @@ Return settings. **Return type** `Dict` + 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 c3649153257..4e896f5f8c6 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 @@ -1,8 +1,16 @@ -# SummedOp +--- +title: SummedOp +description: API reference for qiskit.opflow.list_ops.SummedOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.list_ops.SummedOp +--- +# SummedOp + -`SummedOp(oplist, coeff=1.0, abelian=False)` +`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` @@ -16,25 +24,154 @@ A class for lazily representing sums of Operators. Often Operators cannot be eff ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.list_ops.SummedOp.add#qiskit.opflow.list_ops.SummedOp.add "qiskit.opflow.list_ops.SummedOp.add") | Return Operator addition of `self` and `other`, overloaded by `+`. | -| [`collapse_summands`](qiskit.opflow.list_ops.SummedOp.collapse_summands#qiskit.opflow.list_ops.SummedOp.collapse_summands "qiskit.opflow.list_ops.SummedOp.collapse_summands") | Return Operator by simplifying duplicate operators. | -| [`equals`](qiskit.opflow.list_ops.SummedOp.equals#qiskit.opflow.list_ops.SummedOp.equals "qiskit.opflow.list_ops.SummedOp.equals") | Check if other is equal to self. | -| [`reduce`](qiskit.opflow.list_ops.SummedOp.reduce#qiskit.opflow.list_ops.SummedOp.reduce "qiskit.opflow.list_ops.SummedOp.reduce") | Try collapsing list or trees of sums. | -| [`to_circuit`](qiskit.opflow.list_ops.SummedOp.to_circuit#qiskit.opflow.list_ops.SummedOp.to_circuit "qiskit.opflow.list_ops.SummedOp.to_circuit") | Returns the quantum circuit, representing the SummedOp. | -| [`to_matrix_op`](qiskit.opflow.list_ops.SummedOp.to_matrix_op#qiskit.opflow.list_ops.SummedOp.to_matrix_op "qiskit.opflow.list_ops.SummedOp.to_matrix_op") | Returns an equivalent Operator composed of only NumPy-based primitives, such as `MatrixOp` and `VectorStateFn`. | -| [`to_pauli_op`](qiskit.opflow.list_ops.SummedOp.to_pauli_op#qiskit.opflow.list_ops.SummedOp.to_pauli_op "qiskit.opflow.list_ops.SummedOp.to_pauli_op") | Returns an equivalent Operator composed of only Pauli-based primitives, such as `PauliOp`. | +### add -## Attributes + + +`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 `+`. + + + This appends `other` to `self.oplist` without checking `other` is already included or not. If you want to simplify them, please use `simplify()`. + + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`SummedOp` + +**Returns** + +A `SummedOp` equivalent to the sum of self and other. + +### collapse\_summands + + + +`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. + +E.g., `SummedOp([2 * X ^ Y, X ^ Y]).collapse_summands() -> SummedOp([3 * X ^ Y])`. + +**Return type** + +`SummedOp` + +**Returns** + +A simplified `SummedOp` equivalent to self. + +### equals + + + +`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. + + + This is not a mathematical check for equality. If `self` and `other` implement the same operation but differ in the representation (e.g. different type of summands) `equals` will evaluate to `False`. + + +**Parameters** + +**other** (`OperatorBase`) – The other operator to check for equality. + +**Return type** + +`bool` + +**Returns** + +True, if other and self are equal, otherwise False. + +#### Examples + +```python +>>> from qiskit.opflow import X, Z +>>> 2 * X == X + X +True +>>> X + Z == Z + X +True +``` + +### reduce + + + +`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. +Tries to sum up duplicate operators and reduces the operators in the sum. + +**Return type** + +`OperatorBase` + +**Returns** + +A collapsed version of self, if possible. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +**Returns** + +The circuit representation of the summed operator. + +**Raises** + +* [**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if SummedOp can not be converted to MatrixOp (e.g. SummedOp is composed of +* **parameterized PrimitiveOps**\*\*)\*\*\*\*\*\* – + +### to\_matrix\_op + + + +`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`. + +**Return type** + +`SummedOp` + +### to\_pauli\_op + + + +`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`. + +**Return type** + +`SummedOp` + +## Attributes + + ### INDENTATION `= ' '` - + ### abelian @@ -48,7 +185,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -62,7 +199,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -76,7 +213,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -84,7 +221,7 @@ The combination function. `bool` - + ### grad\_combo\_fn @@ -94,7 +231,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### instance\_id @@ -104,7 +241,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -112,7 +249,7 @@ Return the unique instance id. `int` - + ### oplist @@ -126,11 +263,11 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters - + ### settings @@ -139,3 +276,4 @@ Return settings. **Return type** `Dict` + 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 29c6c92fb9d..773dac11de7 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 @@ -1,8 +1,16 @@ -# TensoredOp +--- +title: TensoredOp +description: API reference for qiskit.opflow.list_ops.TensoredOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.list_ops.TensoredOp +--- +# TensoredOp + -`TensoredOp(oplist, coeff=1.0, abelian=False)` +`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` @@ -16,22 +24,103 @@ A class for lazily representing tensor products of Operators. Often Operators ca ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| [`eval`](qiskit.opflow.list_ops.TensoredOp.eval#qiskit.opflow.list_ops.TensoredOp.eval "qiskit.opflow.list_ops.TensoredOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`reduce`](qiskit.opflow.list_ops.TensoredOp.reduce#qiskit.opflow.list_ops.TensoredOp.reduce "qiskit.opflow.list_ops.TensoredOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.opflow.list_ops.TensoredOp.tensor#qiskit.opflow.list_ops.TensoredOp.tensor "qiskit.opflow.list_ops.TensoredOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_circuit`](qiskit.opflow.list_ops.TensoredOp.to_circuit#qiskit.opflow.list_ops.TensoredOp.to_circuit "qiskit.opflow.list_ops.TensoredOp.to_circuit") | Returns the quantum circuit, representing the tensored operator. | +### eval -## Attributes + + +`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). + +ListOp’s eval recursively evaluates each Operator in `oplist`, and combines the results using the recombination function `combo_fn`. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the `oplist` Operators’ evaluation function, combined with the `combo_fn`. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +**Raises** + +* **NotImplementedError** – Raised if called for a subclass which is not distributive. +* **TypeError** – Operators with mixed hierarchies, such as a ListOp containing both PrimitiveOps and ListOps, are not supported. +* **NotImplementedError** – Attempting to call ListOp’s eval from a non-distributive subclass. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +**Returns** +The circuit representation of the tensored operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – for operators where a single underlying circuit can not be produced. + +## Attributes + + ### INDENTATION `= ' '` - + ### abelian @@ -45,7 +134,7 @@ Whether the Operators in `oplist` are known to commute with one another. A bool indicating whether the `oplist` is Abelian. - + ### coeff @@ -59,7 +148,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### combo\_fn @@ -73,7 +162,7 @@ The function defining how to combine `oplist` (or Numbers, or NumPy arrays) to p The combination function. - + ### distributive @@ -81,7 +170,7 @@ The combination function. `bool` - + ### grad\_combo\_fn @@ -91,7 +180,7 @@ The gradient of `combo_fn`. `Optional`\[`Callable`] - + ### instance\_id @@ -101,7 +190,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -109,7 +198,7 @@ Return the unique instance id. `int` - + ### oplist @@ -123,11 +212,11 @@ The list of `OperatorBases` defining the underlying function of this Operator. The Operators defining the ListOp - + ### parameters - + ### settings @@ -136,3 +225,4 @@ Return settings. **Return type** `Dict` + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md index 1c84905ca02..e4108d55522 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.list_ops.md @@ -4,9 +4,9 @@ ## List Operators ([`qiskit.opflow.list_ops`](#module-qiskit.opflow.list_ops "qiskit.opflow.list_ops")) -List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp#qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp#qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp#qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp.to_matrix#qiskit.opflow.list_ops.ListOp.to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp#qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](qiskit.aqua.operators.list_ops#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. +List Operators are classes for storing and manipulating lists of Operators, State functions, or Measurements, and include some rule or `combo_fn` defining how the Operator functions of the list constituents should be combined to form to cumulative Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). For example, a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp") has an addition-based `combo_fn`, so once the Operators in its list are evaluated against some bitstring to produce a list of results, we know to add up those results to produce the final result of the [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")’s evaluation. In theory, this `combo_fn` can be any function over classical complex values, but for convenience we’ve chosen for them to be defined over NumPy arrays and values. This way, large numbers of evaluations, such as after calling [`to_matrix()`](qiskit.opflow.list_ops.ListOp#to_matrix "qiskit.opflow.list_ops.ListOp.to_matrix") on the list constituents, can be efficiently combined. While the combination function is defined over classical values, it should be understood as the operation by which each Operators’ underlying function is combined to form the underlying Operator function of the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp"). In this way, the [`list_ops`](qiskit.aqua.operators.list_ops#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops") are the basis for constructing large and sophisticated Operators, State Functions, and Measurements. -The base [`ListOp`](qiskit.opflow.list_ops.ListOp#qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp") class is particularly interesting, as its `combo_fn` is “the identity list Operation”. Meaning, if we understand the `combo_fn` as a function from a list of complex values to some output, one such function is returning the list as-is. This is powerful for constructing compact hierarchical Operators which return many measurements in multiple dimensional lists. For example, if we want to estimate the gradient of some Observable measurement with respect to some parameters in the State function, we can construct separate evaluation Operators for each parameter’s gradient which we must keep track of ourselves in a list, or we can construct a single [`ListOp`](qiskit.opflow.list_ops.ListOp#qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp") containing the evaluation Operators for each parameter, so the [`eval()`](qiskit.opflow.list_ops.ListOp.eval#qiskit.opflow.list_ops.ListOp.eval "qiskit.opflow.list_ops.ListOp.eval") function returns the full gradient vector. Another excellent example of this power is constructing a Quantum kernel matrix: +The base [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp") class is particularly interesting, as its `combo_fn` is “the identity list Operation”. Meaning, if we understand the `combo_fn` as a function from a list of complex values to some output, one such function is returning the list as-is. This is powerful for constructing compact hierarchical Operators which return many measurements in multiple dimensional lists. For example, if we want to estimate the gradient of some Observable measurement with respect to some parameters in the State function, we can construct separate evaluation Operators for each parameter’s gradient which we must keep track of ourselves in a list, or we can construct a single [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp") containing the evaluation Operators for each parameter, so the [`eval()`](qiskit.opflow.list_ops.ListOp#eval "qiskit.opflow.list_ops.ListOp.eval") function returns the full gradient vector. Another excellent example of this power is constructing a Quantum kernel matrix: ```python data_sfn_list_op = ListOp(data_circuit_state_fns) @@ -15,9 +15,9 @@ qkernel_sampled = CircuitSampler(backend).convert(qkernel_op_circuits) qkernel_sampled.eval() ``` -This will return the two dimensional Quantum kernel matrix, where each element is the inner product of some pair of the data State functions, or in other terms, a measurement of one data [`CircuitStateFn`](qiskit.aqua.operators.state_fns.CircuitStateFn#qiskit.aqua.operators.state_fns.CircuitStateFn "qiskit.aqua.operators.state_fns.CircuitStateFn") by another. +This will return the two dimensional Quantum kernel matrix, where each element is the inner product of some pair of the data State functions, or in other terms, a measurement of one data [`CircuitStateFn`](qiskit.aqua.operators.state_fns.CircuitStateFn "qiskit.aqua.operators.state_fns.CircuitStateFn") by another. -You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp#qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp") subclasses ([`SummedOp`](qiskit.opflow.list_ops.SummedOp#qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp"), [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp#qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp#qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")) more often as lazy results of Operator construction operations than as something you need to explicitly construct. Any time we don’t know how to efficiently add, compose, or tensor two [`primitive_ops`](qiskit.aqua.operators.primitive_ops#module-qiskit.aqua.operators.primitive_ops "qiskit.aqua.operators.primitive_ops") or [`state_fns`](qiskit.aqua.operators.state_fns#module-qiskit.aqua.operators.state_fns "qiskit.aqua.operators.state_fns") together, they’re returned in a [`SummedOp`](qiskit.opflow.list_ops.SummedOp#qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp"), [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp#qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp#qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp"), respectively, so we can still work with their combined function and perhaps convert them into an efficiently combine-able format later. +You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp") subclasses ([`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp"), [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")) more often as lazy results of Operator construction operations than as something you need to explicitly construct. Any time we don’t know how to efficiently add, compose, or tensor two [`primitive_ops`](qiskit.aqua.operators.primitive_ops#module-qiskit.aqua.operators.primitive_ops "qiskit.aqua.operators.primitive_ops") or [`state_fns`](qiskit.aqua.operators.state_fns#module-qiskit.aqua.operators.state_fns "qiskit.aqua.operators.state_fns") together, they’re returned in a [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp"), [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp"), or [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp"), respectively, so we can still work with their combined function and perhaps convert them into an efficiently combine-able format later. Combination functions do not always behave predictably, and you must understand the conversions you’re making when you working with [`list_ops`](qiskit.aqua.operators.list_ops#module-qiskit.aqua.operators.list_ops "qiskit.aqua.operators.list_ops"). Most notably - sampling a sum of two circuits on Quantum hardware does not incorporate interference between the wavefunctions! In this case, we’re sending our State functions through a depolarizing channel before adding them, rather than adding them directly before the measurement. @@ -25,9 +25,9 @@ You’ll encounter the [`ListOp`](qiskit.opflow.list_ops.ListOp#qiskit.opflow.li ### List Operators -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| [`ListOp`](qiskit.opflow.list_ops.ListOp#qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp")(oplist\[, combo\_fn, coeff, abelian, …]) | A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. | -| [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp#qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | -| [`SummedOp`](qiskit.opflow.list_ops.SummedOp#qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | -| [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp#qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------- | +| [`ListOp`](qiskit.opflow.list_ops.ListOp "qiskit.opflow.list_ops.ListOp")(oplist\[, combo\_fn, coeff, abelian, …]) | A Class for manipulating List Operators, and parent class to `SummedOp`, `ComposedOp`, and `TensoredOp`. | +| [`ComposedOp`](qiskit.opflow.list_ops.ComposedOp "qiskit.opflow.list_ops.ComposedOp")(oplist\[, coeff, abelian]) | A class for lazily representing compositions of Operators. | +| [`SummedOp`](qiskit.opflow.list_ops.SummedOp "qiskit.opflow.list_ops.SummedOp")(oplist\[, coeff, abelian]) | A class for lazily representing sums of Operators. | +| [`TensoredOp`](qiskit.opflow.list_ops.TensoredOp "qiskit.opflow.list_ops.TensoredOp")(oplist\[, coeff, abelian]) | A class for lazily representing tensor products of Operators. | 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 4e91a2139c6..38ff1eda070 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 @@ -1,8 +1,16 @@ -# CircuitOp +--- +title: CircuitOp +description: API reference for qiskit.opflow.primitive_ops.CircuitOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.primitive_ops.CircuitOp +--- +# CircuitOp + -`CircuitOp(primitive, coeff=1.0)` +`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` @@ -20,32 +28,269 @@ Class for Operators backed by Terra’s `QuantumCircuit` module. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.primitive_ops.CircuitOp.add#qiskit.opflow.primitive_ops.CircuitOp.add "qiskit.opflow.primitive_ops.CircuitOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.primitive_ops.CircuitOp.adjoint#qiskit.opflow.primitive_ops.CircuitOp.adjoint "qiskit.opflow.primitive_ops.CircuitOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.opflow.primitive_ops.CircuitOp.assign_parameters#qiskit.opflow.primitive_ops.CircuitOp.assign_parameters "qiskit.opflow.primitive_ops.CircuitOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`compose`](qiskit.opflow.primitive_ops.CircuitOp.compose#qiskit.opflow.primitive_ops.CircuitOp.compose "qiskit.opflow.primitive_ops.CircuitOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.opflow.primitive_ops.CircuitOp.equals#qiskit.opflow.primitive_ops.CircuitOp.equals "qiskit.opflow.primitive_ops.CircuitOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.primitive_ops.CircuitOp.eval#qiskit.opflow.primitive_ops.CircuitOp.eval "qiskit.opflow.primitive_ops.CircuitOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`permute`](qiskit.opflow.primitive_ops.CircuitOp.permute#qiskit.opflow.primitive_ops.CircuitOp.permute "qiskit.opflow.primitive_ops.CircuitOp.permute") | Permute the qubits of the circuit. | -| [`primitive_strings`](qiskit.opflow.primitive_ops.CircuitOp.primitive_strings#qiskit.opflow.primitive_ops.CircuitOp.primitive_strings "qiskit.opflow.primitive_ops.CircuitOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.primitive_ops.CircuitOp.reduce#qiskit.opflow.primitive_ops.CircuitOp.reduce "qiskit.opflow.primitive_ops.CircuitOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.opflow.primitive_ops.CircuitOp.tensor#qiskit.opflow.primitive_ops.CircuitOp.tensor "qiskit.opflow.primitive_ops.CircuitOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_circuit`](qiskit.opflow.primitive_ops.CircuitOp.to_circuit#qiskit.opflow.primitive_ops.CircuitOp.to_circuit "qiskit.opflow.primitive_ops.CircuitOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_circuit_op`](qiskit.opflow.primitive_ops.CircuitOp.to_circuit_op#qiskit.opflow.primitive_ops.CircuitOp.to_circuit_op "qiskit.opflow.primitive_ops.CircuitOp.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_instruction`](qiskit.opflow.primitive_ops.CircuitOp.to_instruction#qiskit.opflow.primitive_ops.CircuitOp.to_instruction "qiskit.opflow.primitive_ops.CircuitOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_matrix`](qiskit.opflow.primitive_ops.CircuitOp.to_matrix#qiskit.opflow.primitive_ops.CircuitOp.to_matrix "qiskit.opflow.primitive_ops.CircuitOp.to_matrix") | Return NumPy representation of the Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`CircuitOp` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like +> -\[Y]-\[X]- +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`CircuitOp` + +**Returns** + +A new CircuitOp containing the permuted circuit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`Union`\[`CircuitOp`, `TensoredOp`] + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`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. + +**Return type** + +`CircuitOp` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -59,7 +304,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### instance\_id @@ -69,7 +314,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -77,11 +322,11 @@ Return the unique instance id. `int` - + ### parameters - + ### primitive @@ -97,7 +342,7 @@ The primitive defining the underlying function of the Operator. The primitive object. - + ### settings @@ -106,3 +351,4 @@ Return operator settings. **Return type** `Dict` + 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 efb0e7b4164..2b3d38ad8d7 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 @@ -1,8 +1,16 @@ -# MatrixOp +--- +title: MatrixOp +description: API reference for qiskit.opflow.primitive_ops.MatrixOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.primitive_ops.MatrixOp +--- +# MatrixOp + -`MatrixOp(primitive, coeff=1.0)` +`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` @@ -20,30 +28,237 @@ Class for Operators represented by matrices, backed by Terra’s `Operator` modu ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.primitive_ops.MatrixOp.add#qiskit.opflow.primitive_ops.MatrixOp.add "qiskit.opflow.primitive_ops.MatrixOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.primitive_ops.MatrixOp.adjoint#qiskit.opflow.primitive_ops.MatrixOp.adjoint "qiskit.opflow.primitive_ops.MatrixOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`compose`](qiskit.opflow.primitive_ops.MatrixOp.compose#qiskit.opflow.primitive_ops.MatrixOp.compose "qiskit.opflow.primitive_ops.MatrixOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.opflow.primitive_ops.MatrixOp.equals#qiskit.opflow.primitive_ops.MatrixOp.equals "qiskit.opflow.primitive_ops.MatrixOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.primitive_ops.MatrixOp.eval#qiskit.opflow.primitive_ops.MatrixOp.eval "qiskit.opflow.primitive_ops.MatrixOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.opflow.primitive_ops.MatrixOp.exp_i#qiskit.opflow.primitive_ops.MatrixOp.exp_i "qiskit.opflow.primitive_ops.MatrixOp.exp_i") | Return a `CircuitOp` equivalent to e^-iH for this operator H | -| [`permute`](qiskit.opflow.primitive_ops.MatrixOp.permute#qiskit.opflow.primitive_ops.MatrixOp.permute "qiskit.opflow.primitive_ops.MatrixOp.permute") | Creates a new MatrixOp that acts on the permuted qubits. | -| [`primitive_strings`](qiskit.opflow.primitive_ops.MatrixOp.primitive_strings#qiskit.opflow.primitive_ops.MatrixOp.primitive_strings "qiskit.opflow.primitive_ops.MatrixOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`tensor`](qiskit.opflow.primitive_ops.MatrixOp.tensor#qiskit.opflow.primitive_ops.MatrixOp.tensor "qiskit.opflow.primitive_ops.MatrixOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_instruction`](qiskit.opflow.primitive_ops.MatrixOp.to_instruction#qiskit.opflow.primitive_ops.MatrixOp.to_instruction "qiskit.opflow.primitive_ops.MatrixOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_matrix`](qiskit.opflow.primitive_ops.MatrixOp.to_matrix#qiskit.opflow.primitive_ops.MatrixOp.to_matrix "qiskit.opflow.primitive_ops.MatrixOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.primitive_ops.MatrixOp.to_matrix_op#qiskit.opflow.primitive_ops.MatrixOp.to_matrix_op "qiskit.opflow.primitive_ops.MatrixOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`Union`\[`MatrixOp`, `SummedOp`] + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`MatrixOp` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`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 + +**Return type** + +`OperatorBase` +### permute + + +`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. + +**Parameters** + +**permutation** (`Optional`\[`List`\[`int`]]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new MatrixOp representing the permuted operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if indices do not define a new index for each qubit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`Union`\[`MatrixOp`, `TensoredOp`] + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`MatrixOp` + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -57,7 +272,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### instance\_id @@ -67,7 +282,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -75,11 +290,11 @@ Return the unique instance id. `int` - + ### parameters - + ### primitive @@ -95,7 +310,7 @@ The primitive defining the underlying function of the Operator. The primitive object. - + ### settings @@ -104,3 +319,4 @@ Return operator settings. **Return type** `Dict` + 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 aecd07198b3..a6a95e2a19d 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 @@ -1,8 +1,16 @@ -# PauliOp +--- +title: PauliOp +description: API reference for qiskit.opflow.primitive_ops.PauliOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.primitive_ops.PauliOp +--- +# PauliOp + -`PauliOp(primitive, coeff=1.0)` +`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` @@ -19,32 +27,269 @@ Class for Operators backed by Terra’s `Pauli` module. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.primitive_ops.PauliOp.add#qiskit.opflow.primitive_ops.PauliOp.add "qiskit.opflow.primitive_ops.PauliOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.primitive_ops.PauliOp.adjoint#qiskit.opflow.primitive_ops.PauliOp.adjoint "qiskit.opflow.primitive_ops.PauliOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`compose`](qiskit.opflow.primitive_ops.PauliOp.compose#qiskit.opflow.primitive_ops.PauliOp.compose "qiskit.opflow.primitive_ops.PauliOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.opflow.primitive_ops.PauliOp.equals#qiskit.opflow.primitive_ops.PauliOp.equals "qiskit.opflow.primitive_ops.PauliOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.primitive_ops.PauliOp.eval#qiskit.opflow.primitive_ops.PauliOp.eval "qiskit.opflow.primitive_ops.PauliOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.opflow.primitive_ops.PauliOp.exp_i#qiskit.opflow.primitive_ops.PauliOp.exp_i "qiskit.opflow.primitive_ops.PauliOp.exp_i") | Return a `CircuitOp` equivalent to e^-iH for this operator H. | -| [`permute`](qiskit.opflow.primitive_ops.PauliOp.permute#qiskit.opflow.primitive_ops.PauliOp.permute "qiskit.opflow.primitive_ops.PauliOp.permute") | Permutes the sequence of Pauli matrices. | -| [`primitive_strings`](qiskit.opflow.primitive_ops.PauliOp.primitive_strings#qiskit.opflow.primitive_ops.PauliOp.primitive_strings "qiskit.opflow.primitive_ops.PauliOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`tensor`](qiskit.opflow.primitive_ops.PauliOp.tensor#qiskit.opflow.primitive_ops.PauliOp.tensor "qiskit.opflow.primitive_ops.PauliOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_circuit`](qiskit.opflow.primitive_ops.PauliOp.to_circuit#qiskit.opflow.primitive_ops.PauliOp.to_circuit "qiskit.opflow.primitive_ops.PauliOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_instruction`](qiskit.opflow.primitive_ops.PauliOp.to_instruction#qiskit.opflow.primitive_ops.PauliOp.to_instruction "qiskit.opflow.primitive_ops.PauliOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_matrix`](qiskit.opflow.primitive_ops.PauliOp.to_matrix#qiskit.opflow.primitive_ops.PauliOp.to_matrix "qiskit.opflow.primitive_ops.PauliOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_pauli_op`](qiskit.opflow.primitive_ops.PauliOp.to_pauli_op#qiskit.opflow.primitive_ops.PauliOp.to_pauli_op "qiskit.opflow.primitive_ops.PauliOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | -| [`to_spmatrix`](qiskit.opflow.primitive_ops.PauliOp.to_spmatrix#qiskit.opflow.primitive_ops.PauliOp.to_spmatrix "qiskit.opflow.primitive_ops.PauliOp.to_spmatrix") | Returns SciPy sparse matrix representation of the Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`PauliOp` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each Pauli should be permuted. The Pauli at index j of the primitive should be permuted to position permutation\[j]. + +**Return type** + +`PauliOp` + +**Returns** + +A new PauliOp representing the permuted operator. For operator (X ^ Y ^ Z) and indices=\[1,2,4], it returns (X ^ I ^ Y ^ Z ^ I). + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if indices do not define a new index for each qubit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_pauli\_op + + + +`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. + +**Return type** + +`PauliOp` + +### to\_spmatrix + + + +`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. + +**Return type** + +`spmatrix` + +**Returns** + +CSR sparse matrix representation of the Operator. + +**Raises** + +**ValueError** – invalid parameters. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -58,7 +303,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### instance\_id @@ -68,7 +313,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -76,11 +321,11 @@ Return the unique instance id. `int` - + ### parameters - + ### primitive @@ -96,7 +341,7 @@ The primitive defining the underlying function of the Operator. The primitive object. - + ### settings @@ -105,3 +350,4 @@ Return operator settings. **Return type** `Dict` + 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 9dad05555f6..27e7660a535 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 @@ -1,8 +1,16 @@ -# PauliSumOp +--- +title: PauliSumOp +description: API reference for qiskit.opflow.primitive_ops.PauliSumOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.primitive_ops.PauliSumOp +--- +# PauliSumOp + -`PauliSumOp(primitive, coeff=1.0, grouping_type='None')` +`PauliSumOp(primitive, coeff=1.0, grouping_type='None')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/primitive_ops/pauli_sum_op.py "view source code") Bases: `qiskit.opflow.primitive_ops.primitive_op.PrimitiveOp` @@ -20,36 +28,353 @@ Class for Operators backend by Terra’s `SparsePauliOp` class. ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.primitive_ops.PauliSumOp.add#qiskit.opflow.primitive_ops.PauliSumOp.add "qiskit.opflow.primitive_ops.PauliSumOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.primitive_ops.PauliSumOp.adjoint#qiskit.opflow.primitive_ops.PauliSumOp.adjoint "qiskit.opflow.primitive_ops.PauliSumOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`compose`](qiskit.opflow.primitive_ops.PauliSumOp.compose#qiskit.opflow.primitive_ops.PauliSumOp.compose "qiskit.opflow.primitive_ops.PauliSumOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.opflow.primitive_ops.PauliSumOp.equals#qiskit.opflow.primitive_ops.PauliSumOp.equals "qiskit.opflow.primitive_ops.PauliSumOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.primitive_ops.PauliSumOp.eval#qiskit.opflow.primitive_ops.PauliSumOp.eval "qiskit.opflow.primitive_ops.PauliSumOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.opflow.primitive_ops.PauliSumOp.exp_i#qiskit.opflow.primitive_ops.PauliSumOp.exp_i "qiskit.opflow.primitive_ops.PauliSumOp.exp_i") | Return a `CircuitOp` equivalent to e^-iH for this operator H. | -| [`from_list`](qiskit.opflow.primitive_ops.PauliSumOp.from_list#qiskit.opflow.primitive_ops.PauliSumOp.from_list "qiskit.opflow.primitive_ops.PauliSumOp.from_list") | Construct from a pauli\_list with the form \[(pauli\_str, coeffs)] | -| [`is_zero`](qiskit.opflow.primitive_ops.PauliSumOp.is_zero#qiskit.opflow.primitive_ops.PauliSumOp.is_zero "qiskit.opflow.primitive_ops.PauliSumOp.is_zero") | Return this operator is zero operator or not. | -| [`matrix_iter`](qiskit.opflow.primitive_ops.PauliSumOp.matrix_iter#qiskit.opflow.primitive_ops.PauliSumOp.matrix_iter "qiskit.opflow.primitive_ops.PauliSumOp.matrix_iter") | Return a matrix representation iterator. | -| [`mul`](qiskit.opflow.primitive_ops.PauliSumOp.mul#qiskit.opflow.primitive_ops.PauliSumOp.mul "qiskit.opflow.primitive_ops.PauliSumOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`permute`](qiskit.opflow.primitive_ops.PauliSumOp.permute#qiskit.opflow.primitive_ops.PauliSumOp.permute "qiskit.opflow.primitive_ops.PauliSumOp.permute") | Permutes the sequence of `PauliSumOp`. | -| [`primitive_strings`](qiskit.opflow.primitive_ops.PauliSumOp.primitive_strings#qiskit.opflow.primitive_ops.PauliSumOp.primitive_strings "qiskit.opflow.primitive_ops.PauliSumOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.primitive_ops.PauliSumOp.reduce#qiskit.opflow.primitive_ops.PauliSumOp.reduce "qiskit.opflow.primitive_ops.PauliSumOp.reduce") | Simplify the primitive `SparsePauliOp`. | -| [`tensor`](qiskit.opflow.primitive_ops.PauliSumOp.tensor#qiskit.opflow.primitive_ops.PauliSumOp.tensor "qiskit.opflow.primitive_ops.PauliSumOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_instruction`](qiskit.opflow.primitive_ops.PauliSumOp.to_instruction#qiskit.opflow.primitive_ops.PauliSumOp.to_instruction "qiskit.opflow.primitive_ops.PauliSumOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_matrix`](qiskit.opflow.primitive_ops.PauliSumOp.to_matrix#qiskit.opflow.primitive_ops.PauliSumOp.to_matrix "qiskit.opflow.primitive_ops.PauliSumOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_pauli_op`](qiskit.opflow.primitive_ops.PauliSumOp.to_pauli_op#qiskit.opflow.primitive_ops.PauliSumOp.to_pauli_op "qiskit.opflow.primitive_ops.PauliSumOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | -| [`to_spmatrix`](qiskit.opflow.primitive_ops.PauliSumOp.to_spmatrix#qiskit.opflow.primitive_ops.PauliSumOp.to_spmatrix "qiskit.opflow.primitive_ops.PauliSumOp.to_spmatrix") | Returns SciPy sparse matrix representation of the `PauliSumOp`. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`PauliSumOp` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### from\_list + + + +`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)] + +**Parameters** + +* **pauli\_list** (`List`\[`Tuple`\[`str`, `complex`]]) – A list of Tuple of pauli\_str and coefficient. +* **coeff** (`Union`\[`complex`, `ParameterExpression`]) – A coefficient multiplying the primitive. + +**Return type** + +`PauliSumOp` + +**Returns** + +The PauliSumOp constructed from the pauli\_list. + +### is\_zero + + + +`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. + +**Return type** + +`bool` + +### matrix\_iter + + + +`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. + +This is a lazy iterator that converts each term in the PauliSumOp into a matrix as it is used. To convert to a single matrix use the [`to_matrix()`](qiskit.opflow.primitive_ops.PauliSumOp#to_matrix "qiskit.opflow.primitive_ops.PauliSumOp.to_matrix") method. + +**Parameters** + +**sparse** (*bool*) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False) + +**Returns** + +matrix iterator object for the PauliTable. + +**Return type** + +MatrixIterator + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### permute + + + +`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`. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each Pauli should be permuted. The Pauli at index j of the primitive should be permuted to position permutation\[j]. + +**Return type** + +`PauliSumOp` + +**Returns** + +A new PauliSumOp representing the permuted operator. For operator (X ^ Y ^ Z) and indices=\[1,2,4], it returns (X ^ I ^ Y ^ Z ^ I). + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if indices do not define a new index for each qubit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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`. + +**Parameters** + +* **atol** (`Optional`\[`float`]) – Absolute tolerance for checking if coefficients are zero (Default: 1e-8). +* **rtol** (`Optional`\[`float`]) – Relative tolerance for checking if coefficients are zero (Default: 1e-5). + +**Return type** + +`PauliSumOp` + +**Returns** + +The simplified `PauliSumOp`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`Union`\[`PauliSumOp`, `TensoredOp`] + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_pauli\_op + + + +`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. + +**Return type** + +`Union`\[`PauliOp`, `SummedOp`] + +### to\_spmatrix + + + +`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`. + +**Return type** + +`spmatrix` + +**Returns** + +CSR sparse matrix representation of the `PauliSumOp`. + +**Raises** + +**ValueError** – invalid parameters. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -63,13 +388,13 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### coeffs Return the Pauli coefficients. - + ### grouping\_type @@ -83,7 +408,7 @@ Returns `str` - + ### instance\_id @@ -93,7 +418,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -101,11 +426,11 @@ Return the unique instance id. `int` - + ### parameters - + ### primitive @@ -121,7 +446,7 @@ The primitive defining the underlying function of the Operator. The primitive object. - + ### settings @@ -130,3 +455,4 @@ Return operator settings. **Return type** `Dict` + 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 1f0783245e8..adc7134555c 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 @@ -1,8 +1,16 @@ -# PrimitiveOp +--- +title: PrimitiveOp +description: API reference for qiskit.opflow.primitive_ops.PrimitiveOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.primitive_ops.PrimitiveOp +--- +# PrimitiveOp + -`PrimitiveOp(primitive, coeff=1.0)` +`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` @@ -17,38 +25,361 @@ Note that all mathematical methods are not in-place, meaning that they return a ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.primitive_ops.PrimitiveOp.add#qiskit.opflow.primitive_ops.PrimitiveOp.add "qiskit.opflow.primitive_ops.PrimitiveOp.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.primitive_ops.PrimitiveOp.adjoint#qiskit.opflow.primitive_ops.PrimitiveOp.adjoint "qiskit.opflow.primitive_ops.PrimitiveOp.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.opflow.primitive_ops.PrimitiveOp.assign_parameters#qiskit.opflow.primitive_ops.PrimitiveOp.assign_parameters "qiskit.opflow.primitive_ops.PrimitiveOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`compose`](qiskit.opflow.primitive_ops.PrimitiveOp.compose#qiskit.opflow.primitive_ops.PrimitiveOp.compose "qiskit.opflow.primitive_ops.PrimitiveOp.compose") | Return Operator Composition between self and other (linear algebra-style: A\@B(x) = A(B(x))), overloaded by `@`. | -| [`equals`](qiskit.opflow.primitive_ops.PrimitiveOp.equals#qiskit.opflow.primitive_ops.PrimitiveOp.equals "qiskit.opflow.primitive_ops.PrimitiveOp.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.primitive_ops.PrimitiveOp.eval#qiskit.opflow.primitive_ops.PrimitiveOp.eval "qiskit.opflow.primitive_ops.PrimitiveOp.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`exp_i`](qiskit.opflow.primitive_ops.PrimitiveOp.exp_i#qiskit.opflow.primitive_ops.PrimitiveOp.exp_i "qiskit.opflow.primitive_ops.PrimitiveOp.exp_i") | Return Operator exponentiation, equaling e^(-i \* op) | -| [`log_i`](qiskit.opflow.primitive_ops.PrimitiveOp.log_i#qiskit.opflow.primitive_ops.PrimitiveOp.log_i "qiskit.opflow.primitive_ops.PrimitiveOp.log_i") | Return a `MatrixOp` equivalent to log(H)/-i for this operator H. | -| [`mul`](qiskit.opflow.primitive_ops.PrimitiveOp.mul#qiskit.opflow.primitive_ops.PrimitiveOp.mul "qiskit.opflow.primitive_ops.PrimitiveOp.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`permute`](qiskit.opflow.primitive_ops.PrimitiveOp.permute#qiskit.opflow.primitive_ops.PrimitiveOp.permute "qiskit.opflow.primitive_ops.PrimitiveOp.permute") | Permutes the qubits of the operator. | -| [`primitive_strings`](qiskit.opflow.primitive_ops.PrimitiveOp.primitive_strings#qiskit.opflow.primitive_ops.PrimitiveOp.primitive_strings "qiskit.opflow.primitive_ops.PrimitiveOp.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.primitive_ops.PrimitiveOp.reduce#qiskit.opflow.primitive_ops.PrimitiveOp.reduce "qiskit.opflow.primitive_ops.PrimitiveOp.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`tensor`](qiskit.opflow.primitive_ops.PrimitiveOp.tensor#qiskit.opflow.primitive_ops.PrimitiveOp.tensor "qiskit.opflow.primitive_ops.PrimitiveOp.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.opflow.primitive_ops.PrimitiveOp.tensorpower#qiskit.opflow.primitive_ops.PrimitiveOp.tensorpower "qiskit.opflow.primitive_ops.PrimitiveOp.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit`](qiskit.opflow.primitive_ops.PrimitiveOp.to_circuit#qiskit.opflow.primitive_ops.PrimitiveOp.to_circuit "qiskit.opflow.primitive_ops.PrimitiveOp.to_circuit") | Returns a `QuantumCircuit` equivalent to this Operator. | -| [`to_circuit_op`](qiskit.opflow.primitive_ops.PrimitiveOp.to_circuit_op#qiskit.opflow.primitive_ops.PrimitiveOp.to_circuit_op "qiskit.opflow.primitive_ops.PrimitiveOp.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_instruction`](qiskit.opflow.primitive_ops.PrimitiveOp.to_instruction#qiskit.opflow.primitive_ops.PrimitiveOp.to_instruction "qiskit.opflow.primitive_ops.PrimitiveOp.to_instruction") | Returns an `Instruction` equivalent to this Operator. | -| [`to_matrix`](qiskit.opflow.primitive_ops.PrimitiveOp.to_matrix#qiskit.opflow.primitive_ops.PrimitiveOp.to_matrix "qiskit.opflow.primitive_ops.PrimitiveOp.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.primitive_ops.PrimitiveOp.to_matrix_op#qiskit.opflow.primitive_ops.PrimitiveOp.to_matrix_op "qiskit.opflow.primitive_ops.PrimitiveOp.to_matrix_op") | Returns a `MatrixOp` equivalent to this Operator. | -| [`to_pauli_op`](qiskit.opflow.primitive_ops.PrimitiveOp.to_pauli_op#qiskit.opflow.primitive_ops.PrimitiveOp.to_pauli_op "qiskit.opflow.primitive_ops.PrimitiveOp.to_pauli_op") | Returns a sum of `PauliOp` s equivalent to this Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### compose + + + +`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 `@`. + +Note: You must be conscious of Quantum Circuit vs. Linear Algebra ordering conventions. Meaning, X.compose(Y) produces an X∘Y on qubit 0, but would produce a QuantumCircuit which looks like + +> -\[Y]-\[X]- + +Because Terra prints circuits with the initial state at the left side of the circuit. + +**Parameters** + +* **other** (`OperatorBase`) – The `OperatorBase` with which to compose self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the function composition of self and other. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### exp\_i + + + +`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) + +**Return type** + +`OperatorBase` + +### log\_i + + + +`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. + +**Return type** + +`OperatorBase` + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### permute + + + +`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. + +**Parameters** +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new OperatorBase containing the permuted operator. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – if indices do not define a new index for each qubit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### tensor + + + +`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 + +> -\[Y]- -\[X]- + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit + + + +`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. + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_instruction + + + +`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. + +**Return type** + +`Instruction` + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_pauli\_op + + + +`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. + +**Return type** + +`OperatorBase` + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -62,7 +393,7 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### instance\_id @@ -72,7 +403,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -80,11 +411,11 @@ Return the unique instance id. `int` - + ### parameters - + ### primitive @@ -98,7 +429,7 @@ The primitive defining the underlying function of the Operator. The primitive object. - + ### settings @@ -107,3 +438,4 @@ Return operator settings. **Return type** `Dict` + 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 f96625961b1..e79d5a51100 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 @@ -1,8 +1,16 @@ -# TaperedPauliSumOp +--- +title: TaperedPauliSumOp +description: API reference for qiskit.opflow.primitive_ops.TaperedPauliSumOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.primitive_ops.TaperedPauliSumOp +--- +# TaperedPauliSumOp + -`TaperedPauliSumOp(primitive, z2_symmetries, coeff=1.0)` +`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` @@ -20,19 +28,35 @@ Class for PauliSumOp after tapering ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | -| [`assign_parameters`](qiskit.opflow.primitive_ops.TaperedPauliSumOp.assign_parameters#qiskit.opflow.primitive_ops.TaperedPauliSumOp.assign_parameters "qiskit.opflow.primitive_ops.TaperedPauliSumOp.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | +### assign\_parameters -## Attributes + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -46,13 +70,13 @@ The scalar coefficient multiplying the Operator. The coefficient. - + ### coeffs Return the Pauli coefficients. - + ### grouping\_type @@ -66,7 +90,7 @@ Returns `str` - + ### instance\_id @@ -76,7 +100,7 @@ Return the unique instance id. `int` - + ### num\_qubits @@ -84,11 +108,11 @@ Return the unique instance id. `int` - + ### parameters - + ### primitive @@ -104,7 +128,7 @@ The primitive defining the underlying function of the Operator. The primitive object. - + ### settings @@ -114,7 +138,7 @@ Return operator settings. `Dict` - + ### z2\_symmetries @@ -127,3 +151,4 @@ Z2 symmetries which the Operator has. **Returns** The Z2 Symmetries. + 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 a0d37d8ef53..7b5e72bf7c5 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 @@ -1,8 +1,16 @@ -# Z2Symmetries +--- +title: Z2Symmetries +description: API reference for qiskit.opflow.primitive_ops.Z2Symmetries +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.primitive_ops.Z2Symmetries +--- +# Z2Symmetries + -`Z2Symmetries(symmetries, sq_paulis, sq_list, tapering_values=None)` +`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` @@ -17,27 +25,99 @@ Z2 Symmetries **Raises** -[**OpflowError**](qiskit.opflow.OpflowError#qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – Invalid paulis +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – Invalid paulis ## Methods Defined Here -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| [`consistent_tapering`](qiskit.opflow.primitive_ops.Z2Symmetries.consistent_tapering#qiskit.opflow.primitive_ops.Z2Symmetries.consistent_tapering "qiskit.opflow.primitive_ops.Z2Symmetries.consistent_tapering") | Tapering the operator with the same manner of how this tapered operator is created. | -| [`copy`](qiskit.opflow.primitive_ops.Z2Symmetries.copy#qiskit.opflow.primitive_ops.Z2Symmetries.copy "qiskit.opflow.primitive_ops.Z2Symmetries.copy") | Get a copy of self. | -| [`find_Z2_symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries.find_Z2_symmetries#qiskit.opflow.primitive_ops.Z2Symmetries.find_Z2_symmetries "qiskit.opflow.primitive_ops.Z2Symmetries.find_Z2_symmetries") | Finds Z2 Pauli-type symmetries of an Operator. | -| [`is_empty`](qiskit.opflow.primitive_ops.Z2Symmetries.is_empty#qiskit.opflow.primitive_ops.Z2Symmetries.is_empty "qiskit.opflow.primitive_ops.Z2Symmetries.is_empty") | Check the z2\_symmetries is empty or not. | -| [`taper`](qiskit.opflow.primitive_ops.Z2Symmetries.taper#qiskit.opflow.primitive_ops.Z2Symmetries.taper "qiskit.opflow.primitive_ops.Z2Symmetries.taper") | Taper an operator based on the z2\_symmetries info and sector defined by tapering\_values. | +### consistent\_tapering -## Attributes + + +`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. + +**Parameters** + +**operator** (`PauliSumOp`) – the to-be-tapered operator + +**Return type** + +`OperatorBase` + +**Returns** + +The tapered operator + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – The given operator does not commute with the symmetry + +### copy + + + +`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 + +### find\_Z2\_symmetries + + + +`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. + +**Return type** + +`Z2Symmetries` + +**Returns** +a z2\_symmetries object contains symmetries, single-qubit X, single-qubit list. +### is\_empty + + + +`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 + +### taper + + + +`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. + +**Parameters** + +**operator** (`PauliSumOp`) – the to-be-tapered operator. + +**Returns** + +\[:class\`PauliSumOp\`]; otherwise, [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp") + +**Return type** + +If tapering\_values is None + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – Z2 symmetries, single qubit pauli and single qubit list cannot be empty + +## Attributes + + ### cliffords Get clifford operators, build based on symmetries and single-qubit X. :rtype: `List`\[`PauliSumOp`] :returns: a list of unitaries used to diagonalize the Hamiltonian. - + ### settings @@ -47,26 +127,27 @@ Return operator settings. `Dict` - + ### sq\_list returns sq list - + ### sq\_paulis returns sq paulis - + ### symmetries return symmetries - + ### tapering\_values returns tapering values + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md index 3e247a95519..9b8d4929b0c 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.primitive_ops.md @@ -14,17 +14,17 @@ PrimitiveOps are the classes for representing basic Operators, backed by computa ### Primitive Operators -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp#qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.PrimitiveOp")(primitive\[, coeff]) | A class for representing basic Operators, backed by Operator primitives from Terra. | -| [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp#qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp")(primitive\[, coeff]) | Class for Operators backed by Terra’s `QuantumCircuit` module. | -| [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp#qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")(primitive\[, coeff]) | Class for Operators represented by matrices, backed by Terra’s `Operator` module. | -| [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp#qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")(primitive\[, coeff]) | Class for Operators backed by Terra’s `Pauli` module. | -| [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp#qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")(primitive\[, coeff, grouping\_type]) | Class for Operators backend by Terra’s `SparsePauliOp` class. | -| [`TaperedPauliSumOp`](qiskit.opflow.primitive_ops.TaperedPauliSumOp#qiskit.opflow.primitive_ops.TaperedPauliSumOp "qiskit.opflow.primitive_ops.TaperedPauliSumOp")(primitive, z2\_symmetries) | Class for PauliSumOp after tapering | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| [`PrimitiveOp`](qiskit.opflow.primitive_ops.PrimitiveOp "qiskit.opflow.primitive_ops.PrimitiveOp")(primitive\[, coeff]) | A class for representing basic Operators, backed by Operator primitives from Terra. | +| [`CircuitOp`](qiskit.opflow.primitive_ops.CircuitOp "qiskit.opflow.primitive_ops.CircuitOp")(primitive\[, coeff]) | Class for Operators backed by Terra’s `QuantumCircuit` module. | +| [`MatrixOp`](qiskit.opflow.primitive_ops.MatrixOp "qiskit.opflow.primitive_ops.MatrixOp")(primitive\[, coeff]) | Class for Operators represented by matrices, backed by Terra’s `Operator` module. | +| [`PauliOp`](qiskit.opflow.primitive_ops.PauliOp "qiskit.opflow.primitive_ops.PauliOp")(primitive\[, coeff]) | Class for Operators backed by Terra’s `Pauli` module. | +| [`PauliSumOp`](qiskit.opflow.primitive_ops.PauliSumOp "qiskit.opflow.primitive_ops.PauliSumOp")(primitive\[, coeff, grouping\_type]) | Class for Operators backend by Terra’s `SparsePauliOp` class. | +| [`TaperedPauliSumOp`](qiskit.opflow.primitive_ops.TaperedPauliSumOp "qiskit.opflow.primitive_ops.TaperedPauliSumOp")(primitive, z2\_symmetries) | Class for PauliSumOp after tapering | ### Symmetries -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -| [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries#qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------- | ------------- | +| [`Z2Symmetries`](qiskit.opflow.primitive_ops.Z2Symmetries "qiskit.opflow.primitive_ops.Z2Symmetries")(symmetries, sq\_paulis, sq\_list) | Z2 Symmetries | 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 7db6b1fd5da..e4d35b103db 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 @@ -1,8 +1,16 @@ -# CVaRMeasurement +--- +title: CVaRMeasurement +description: API reference for qiskit.opflow.state_fns.CVaRMeasurement +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.state_fns.CVaRMeasurement +--- +# CVaRMeasurement + -`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)` +`CVaRMeasurement(primitive=None, alpha=1.0, coeff=1.0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/cvar_measurement.py "view source code") Bases: `qiskit.opflow.state_fns.operator_state_fn.OperatorStateFn` @@ -22,36 +30,271 @@ Used in `CVaRExpectation`, see there for more details. * **ValueError** – TODO remove that this raises an error * **ValueError** – If alpha is not in \[0, 1]. -* [**OpflowError**](qiskit.opflow.OpflowError#qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If the primitive is not diagonal. +* [**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – If the primitive is not diagonal. ## Methods Defined Here -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.state_fns.CVaRMeasurement.add#qiskit.opflow.state_fns.CVaRMeasurement.add "qiskit.opflow.state_fns.CVaRMeasurement.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.state_fns.CVaRMeasurement.adjoint#qiskit.opflow.state_fns.CVaRMeasurement.adjoint "qiskit.opflow.state_fns.CVaRMeasurement.adjoint") | The adjoint of a CVaRMeasurement is not defined. | -| [`compute_cvar`](qiskit.opflow.state_fns.CVaRMeasurement.compute_cvar#qiskit.opflow.state_fns.CVaRMeasurement.compute_cvar "qiskit.opflow.state_fns.CVaRMeasurement.compute_cvar") | 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. | -| [`eval`](qiskit.opflow.state_fns.CVaRMeasurement.eval#qiskit.opflow.state_fns.CVaRMeasurement.eval "qiskit.opflow.state_fns.CVaRMeasurement.eval") | 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.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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`SummedOp` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Returns** + +Does not return anything, raises an error. + +**Raises** + +[**OpflowError**](qiskit.opflow.OpflowError "qiskit.opflow.OpflowError") – The adjoint of a CVaRMeasurement is not defined. + +### compute\_cvar + + + +`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. + +Consider the outcome with index j, such that only some of the samples with measurement outcome j will be used in computing CVaR. The CVaR calculation can then be separated into two parts. First we sum each of the energies for outcomes i \< j, weighted by the probability of observing that outcome (i.e the normalized counts). Second, we add the energy for outcome j, weighted by the difference (α - sum\_i\ + +`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") + +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] + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `None`]) – A StateFn or primitive which specifies the results of evaluating a quantum state. + +**Return type** + +`complex` + +**Returns** + +**The Var\[CVaR] of the diagonal observable specified by self.primitive** + +and the sampled quantum state described by the inputs (energies, probabilities). For index j (described above), the CVaR is computed as H\_j^2 + 1/α\*(sum\_i\ + +`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). + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `Statevector`, `None`]) – A StateFn or a primitive which defines a StateFn. This input holds the results of a sampled/simulated circuit. + +**Return type** + +`Tuple`\[`list`, `list`] + +**Returns** +**Two lists of equal length. energies contains the energy of each** +unique measurement outcome computed against the diagonal observable stored in self.primitive. probabilities contains the corresponding sampling probability for each measurement outcome in energies. + +**Raises** + +**ValueError** – front isn’t a DictStateFn or VectorStateFn + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`CVaRMeasurement` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`Union`\[`OperatorStateFn`, `TensoredOp`] + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit\_op + + + +`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. + +### to\_density\_matrix + + + +`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. + +### to\_matrix + + + +`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. + +### to\_matrix\_op + + + +`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. + +### traverse + + + +`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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### INDENTATION `= ' '` - + ### alpha @@ -67,7 +310,7 @@ fraction of observed samples to include when computing the objective value. alph The parameter alpha which was given at initialization - + ### coeff @@ -77,7 +320,7 @@ A coefficient by which the state function is multiplied. `Union`\[`complex`, `ParameterExpression`] - + ### instance\_id @@ -87,7 +330,7 @@ Return the unique instance id. `int` - + ### is\_measurement @@ -97,7 +340,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -105,11 +348,11 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive @@ -117,7 +360,7 @@ Whether the StateFn object is a measurement Operator. The primitive which defines the behavior of the underlying State function. - + ### settings @@ -126,3 +369,4 @@ Return settings. **Return type** `Dict` + 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 4abd5d45aca..e1dd3b4e91f 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 @@ -1,8 +1,16 @@ -# CircuitStateFn +--- +title: CircuitStateFn +description: API reference for qiskit.opflow.state_fns.CircuitStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.state_fns.CircuitStateFn +--- +# CircuitStateFn + -`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` +`CircuitStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/circuit_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -21,35 +29,307 @@ A class for state functions and measurements which are defined by the action of ## Methods Defined Here -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.state_fns.CircuitStateFn.add#qiskit.opflow.state_fns.CircuitStateFn.add "qiskit.opflow.state_fns.CircuitStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.state_fns.CircuitStateFn.adjoint#qiskit.opflow.state_fns.CircuitStateFn.adjoint "qiskit.opflow.state_fns.CircuitStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.opflow.state_fns.CircuitStateFn.assign_parameters#qiskit.opflow.state_fns.CircuitStateFn.assign_parameters "qiskit.opflow.state_fns.CircuitStateFn.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`compose`](qiskit.opflow.state_fns.CircuitStateFn.compose#qiskit.opflow.state_fns.CircuitStateFn.compose "qiskit.opflow.state_fns.CircuitStateFn.compose") | 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. | -| [`eval`](qiskit.opflow.state_fns.CircuitStateFn.eval#qiskit.opflow.state_fns.CircuitStateFn.eval "qiskit.opflow.state_fns.CircuitStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`from_dict`](qiskit.opflow.state_fns.CircuitStateFn.from_dict#qiskit.opflow.state_fns.CircuitStateFn.from_dict "qiskit.opflow.state_fns.CircuitStateFn.from_dict") | Construct the CircuitStateFn from a dict mapping strings to probability densities. | -| [`from_vector`](qiskit.opflow.state_fns.CircuitStateFn.from_vector#qiskit.opflow.state_fns.CircuitStateFn.from_vector "qiskit.opflow.state_fns.CircuitStateFn.from_vector") | Construct the CircuitStateFn from a vector representing the statevector. | -| [`permute`](qiskit.opflow.state_fns.CircuitStateFn.permute#qiskit.opflow.state_fns.CircuitStateFn.permute "qiskit.opflow.state_fns.CircuitStateFn.permute") | Permute the qubits of the circuit. | -| [`primitive_strings`](qiskit.opflow.state_fns.CircuitStateFn.primitive_strings#qiskit.opflow.state_fns.CircuitStateFn.primitive_strings "qiskit.opflow.state_fns.CircuitStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.state_fns.CircuitStateFn.reduce#qiskit.opflow.state_fns.CircuitStateFn.reduce "qiskit.opflow.state_fns.CircuitStateFn.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`sample`](qiskit.opflow.state_fns.CircuitStateFn.sample#qiskit.opflow.state_fns.CircuitStateFn.sample "qiskit.opflow.state_fns.CircuitStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.opflow.state_fns.CircuitStateFn.tensor#qiskit.opflow.state_fns.CircuitStateFn.tensor "qiskit.opflow.state_fns.CircuitStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_circuit`](qiskit.opflow.state_fns.CircuitStateFn.to_circuit#qiskit.opflow.state_fns.CircuitStateFn.to_circuit "qiskit.opflow.state_fns.CircuitStateFn.to_circuit") | Return QuantumCircuit representing StateFn | -| [`to_circuit_op`](qiskit.opflow.state_fns.CircuitStateFn.to_circuit_op#qiskit.opflow.state_fns.CircuitStateFn.to_circuit_op "qiskit.opflow.state_fns.CircuitStateFn.to_circuit_op") | Return `StateFnCircuit` corresponding to this StateFn. | -| [`to_density_matrix`](qiskit.opflow.state_fns.CircuitStateFn.to_density_matrix#qiskit.opflow.state_fns.CircuitStateFn.to_density_matrix "qiskit.opflow.state_fns.CircuitStateFn.to_density_matrix") | 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. | -| [`to_instruction`](qiskit.opflow.state_fns.CircuitStateFn.to_instruction#qiskit.opflow.state_fns.CircuitStateFn.to_instruction "qiskit.opflow.state_fns.CircuitStateFn.to_instruction") | Return Instruction corresponding to primitive. | -| [`to_matrix`](qiskit.opflow.state_fns.CircuitStateFn.to_matrix#qiskit.opflow.state_fns.CircuitStateFn.to_matrix "qiskit.opflow.state_fns.CircuitStateFn.to_matrix") | Return NumPy representation of the Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`CircuitStateFn` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. + +**Return type** + +`Union`\[`CircuitStateFn`, `ListOp`] + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### compose + + + +`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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### from\_dict + + + +`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. + +**Parameters** + +**density\_dict** (`dict`) – The dict representing the desired state. + +**Return type** + +`CircuitStateFn` + +**Returns** + +The CircuitStateFn created from the dict. + +### from\_vector + + + +`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. + +**Parameters** + +**statevector** (`ndarray`) – The statevector representing the desired state. + +**Return type** + +`CircuitStateFn` + +**Returns** + +The CircuitStateFn created from the vector. + +### permute + + + +`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. +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`CircuitStateFn` + +**Returns** + +A new CircuitStateFn containing the permuted circuit. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`CircuitStateFn` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Return type** + +`dict` + +### tensor + + + +`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: + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`Union`\[`CircuitStateFn`, `TensoredOp`] + +**Returns** +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit + + + +`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 + +**Return type** + +`QuantumCircuit` + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Return type** + +`ndarray` + +### to\_instruction + + + +`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. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -59,7 +339,7 @@ A coefficient by which the state function is multiplied. `Union`\[`complex`, `ParameterExpression`] - + ### instance\_id @@ -69,7 +349,7 @@ Return the unique instance id. `int` - + ### is\_measurement @@ -79,7 +359,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -87,11 +367,11 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive @@ -99,7 +379,7 @@ Whether the StateFn object is a measurement Operator. The primitive which defines the behavior of the underlying State function. - + ### settings @@ -108,3 +388,4 @@ Return settings. **Return type** `Dict` + 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 1eaab66bcf3..9206389fb7c 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 @@ -1,8 +1,16 @@ -# DictStateFn +--- +title: DictStateFn +description: API reference for qiskit.opflow.state_fns.DictStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.state_fns.DictStateFn +--- +# DictStateFn + -`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)` +`DictStateFn(primitive=None, coeff=1.0, is_measurement=False, from_operator=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/dict_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -21,30 +29,239 @@ A class for state functions and measurements which are defined by a lookup table ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.state_fns.DictStateFn.add#qiskit.opflow.state_fns.DictStateFn.add "qiskit.opflow.state_fns.DictStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.state_fns.DictStateFn.adjoint#qiskit.opflow.state_fns.DictStateFn.adjoint "qiskit.opflow.state_fns.DictStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`eval`](qiskit.opflow.state_fns.DictStateFn.eval#qiskit.opflow.state_fns.DictStateFn.eval "qiskit.opflow.state_fns.DictStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`permute`](qiskit.opflow.state_fns.DictStateFn.permute#qiskit.opflow.state_fns.DictStateFn.permute "qiskit.opflow.state_fns.DictStateFn.permute") | Permute the qubits of the state function. | -| [`primitive_strings`](qiskit.opflow.state_fns.DictStateFn.primitive_strings#qiskit.opflow.state_fns.DictStateFn.primitive_strings "qiskit.opflow.state_fns.DictStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`sample`](qiskit.opflow.state_fns.DictStateFn.sample#qiskit.opflow.state_fns.DictStateFn.sample "qiskit.opflow.state_fns.DictStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.opflow.state_fns.DictStateFn.tensor#qiskit.opflow.state_fns.DictStateFn.tensor "qiskit.opflow.state_fns.DictStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_circuit_op`](qiskit.opflow.state_fns.DictStateFn.to_circuit_op#qiskit.opflow.state_fns.DictStateFn.to_circuit_op "qiskit.opflow.state_fns.DictStateFn.to_circuit_op") | Convert this state function to a `CircuitStateFn`. | -| [`to_density_matrix`](qiskit.opflow.state_fns.DictStateFn.to_density_matrix#qiskit.opflow.state_fns.DictStateFn.to_density_matrix "qiskit.opflow.state_fns.DictStateFn.to_density_matrix") | Return matrix representing product of StateFn evaluated on pairs of basis states. | -| [`to_matrix`](qiskit.opflow.state_fns.DictStateFn.to_matrix#qiskit.opflow.state_fns.DictStateFn.to_matrix "qiskit.opflow.state_fns.DictStateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_spmatrix`](qiskit.opflow.state_fns.DictStateFn.to_spmatrix#qiskit.opflow.state_fns.DictStateFn.to_spmatrix "qiskit.opflow.state_fns.DictStateFn.to_spmatrix") | Same as to\_matrix, but returns csr sparse matrix. | -| [`to_spmatrix_op`](qiskit.opflow.state_fns.DictStateFn.to_spmatrix_op#qiskit.opflow.state_fns.DictStateFn.to_spmatrix_op "qiskit.opflow.state_fns.DictStateFn.to_spmatrix_op") | Convert this state function to a `SparseVectorStateFn`. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`DictStateFn` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`DictStateFn` + +**Returns** + +A new StateFn containing the permuted primitive. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`Dict`\[`str`, `float`] + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy array representing the density matrix of the State function. + +**Raises** + +**ValueError** – If massive is set to False, and exponentially large computation is needed. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_spmatrix + + + +`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. + +**Return type** + +`spmatrix` + +**Returns** + +CSR sparse matrix representation of the State function. + +**Raises** + +**ValueError** – invalid parameters. + +### to\_spmatrix\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -54,7 +271,7 @@ A coefficient by which the state function is multiplied. `Union`\[`complex`, `ParameterExpression`] - + ### instance\_id @@ -64,7 +281,7 @@ Return the unique instance id. `int` - + ### is\_measurement @@ -74,7 +291,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -82,11 +299,11 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive @@ -94,7 +311,7 @@ Whether the StateFn object is a measurement Operator. The primitive which defines the behavior of the underlying State function. - + ### settings @@ -103,3 +320,4 @@ Return settings. **Return type** `Dict` + 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 b4466a70392..33a6664f407 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 @@ -1,8 +1,16 @@ -# OperatorStateFn +--- +title: OperatorStateFn +description: API reference for qiskit.opflow.state_fns.OperatorStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.state_fns.OperatorStateFn +--- +# OperatorStateFn + -`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)` +`OperatorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/operator_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -16,29 +24,209 @@ A class for state functions and measurements which are defined by a density Oper ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.state_fns.OperatorStateFn.add#qiskit.opflow.state_fns.OperatorStateFn.add "qiskit.opflow.state_fns.OperatorStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.state_fns.OperatorStateFn.adjoint#qiskit.opflow.state_fns.OperatorStateFn.adjoint "qiskit.opflow.state_fns.OperatorStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`eval`](qiskit.opflow.state_fns.OperatorStateFn.eval#qiskit.opflow.state_fns.OperatorStateFn.eval "qiskit.opflow.state_fns.OperatorStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`permute`](qiskit.opflow.state_fns.OperatorStateFn.permute#qiskit.opflow.state_fns.OperatorStateFn.permute "qiskit.opflow.state_fns.OperatorStateFn.permute") | Permute the qubits of the state function. | -| [`primitive_strings`](qiskit.opflow.state_fns.OperatorStateFn.primitive_strings#qiskit.opflow.state_fns.OperatorStateFn.primitive_strings "qiskit.opflow.state_fns.OperatorStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`sample`](qiskit.opflow.state_fns.OperatorStateFn.sample#qiskit.opflow.state_fns.OperatorStateFn.sample "qiskit.opflow.state_fns.OperatorStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.opflow.state_fns.OperatorStateFn.tensor#qiskit.opflow.state_fns.OperatorStateFn.tensor "qiskit.opflow.state_fns.OperatorStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_circuit_op`](qiskit.opflow.state_fns.OperatorStateFn.to_circuit_op#qiskit.opflow.state_fns.OperatorStateFn.to_circuit_op "qiskit.opflow.state_fns.OperatorStateFn.to_circuit_op") | Return `StateFnCircuit` corresponding to this StateFn. | -| [`to_density_matrix`](qiskit.opflow.state_fns.OperatorStateFn.to_density_matrix#qiskit.opflow.state_fns.OperatorStateFn.to_density_matrix "qiskit.opflow.state_fns.OperatorStateFn.to_density_matrix") | 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. | -| [`to_matrix`](qiskit.opflow.state_fns.OperatorStateFn.to_matrix#qiskit.opflow.state_fns.OperatorStateFn.to_matrix "qiskit.opflow.state_fns.OperatorStateFn.to_matrix") | 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. | -| [`to_matrix_op`](qiskit.opflow.state_fns.OperatorStateFn.to_matrix_op#qiskit.opflow.state_fns.OperatorStateFn.to_matrix_op "qiskit.opflow.state_fns.OperatorStateFn.to_matrix_op") | Return a MatrixOp for this operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`Union`\[`OperatorStateFn`, `SummedOp`] + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorStateFn` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `dict`, `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`OperatorStateFn` + +**Returns** + +A new StateFn containing the permuted primitive. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### sample + + + +`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. + +**Parameters** +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`Union`\[`OperatorStateFn`, `TensoredOp`] + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit\_op + + + +`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. + +### to\_density\_matrix + + + +`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. + +**Return type** + +`ndarray` + +### to\_matrix + + + +`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. + +Return numpy vector of state vector, warn if more than 16 qubits to force the user to set massive=True if they want such a large vector. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Returns** + +Vector of state vector + +**Return type** + +np.ndarray + +**Raises** + +**ValueError** – Invalid parameters. + +### to\_matrix\_op + + + +`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. + +**Return type** + +`OperatorStateFn` + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -48,7 +236,7 @@ A coefficient by which the state function is multiplied. `Union`\[`complex`, `ParameterExpression`] - + ### instance\_id @@ -58,7 +246,7 @@ Return the unique instance id. `int` - + ### is\_measurement @@ -68,7 +256,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -76,11 +264,11 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive @@ -88,7 +276,7 @@ Whether the StateFn object is a measurement Operator. The primitive which defines the behavior of the underlying State function. - + ### settings @@ -97,3 +285,4 @@ Return settings. **Return type** `Dict` + 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 d07d6d2d06c..5e032defd82 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 @@ -1,8 +1,16 @@ -# SparseVectorStateFn +--- +title: SparseVectorStateFn +description: API reference for qiskit.opflow.state_fns.SparseVectorStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.state_fns.SparseVectorStateFn +--- +# SparseVectorStateFn + -`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)` +`SparseVectorStateFn(primitive, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/sparse_vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -23,29 +31,211 @@ This class uses `scipy.sparse.spmatrix` for the internal representation. ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.state_fns.SparseVectorStateFn.add#qiskit.opflow.state_fns.SparseVectorStateFn.add "qiskit.opflow.state_fns.SparseVectorStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.state_fns.SparseVectorStateFn.adjoint#qiskit.opflow.state_fns.SparseVectorStateFn.adjoint "qiskit.opflow.state_fns.SparseVectorStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`equals`](qiskit.opflow.state_fns.SparseVectorStateFn.equals#qiskit.opflow.state_fns.SparseVectorStateFn.equals "qiskit.opflow.state_fns.SparseVectorStateFn.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.state_fns.SparseVectorStateFn.eval#qiskit.opflow.state_fns.SparseVectorStateFn.eval "qiskit.opflow.state_fns.SparseVectorStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`primitive_strings`](qiskit.opflow.state_fns.SparseVectorStateFn.primitive_strings#qiskit.opflow.state_fns.SparseVectorStateFn.primitive_strings "qiskit.opflow.state_fns.SparseVectorStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`sample`](qiskit.opflow.state_fns.SparseVectorStateFn.sample#qiskit.opflow.state_fns.SparseVectorStateFn.sample "qiskit.opflow.state_fns.SparseVectorStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`to_circuit_op`](qiskit.opflow.state_fns.SparseVectorStateFn.to_circuit_op#qiskit.opflow.state_fns.SparseVectorStateFn.to_circuit_op "qiskit.opflow.state_fns.SparseVectorStateFn.to_circuit_op") | Convert this state function to a `CircuitStateFn`. | -| [`to_dict_fn`](qiskit.opflow.state_fns.SparseVectorStateFn.to_dict_fn#qiskit.opflow.state_fns.SparseVectorStateFn.to_dict_fn "qiskit.opflow.state_fns.SparseVectorStateFn.to_dict_fn") | Convert this state function to a `DictStateFn`. | -| [`to_matrix`](qiskit.opflow.state_fns.SparseVectorStateFn.to_matrix#qiskit.opflow.state_fns.SparseVectorStateFn.to_matrix "qiskit.opflow.state_fns.SparseVectorStateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.state_fns.SparseVectorStateFn.to_matrix_op#qiskit.opflow.state_fns.SparseVectorStateFn.to_matrix_op "qiskit.opflow.state_fns.SparseVectorStateFn.to_matrix_op") | Return a `VectorStateFn` for this `StateFn`. | -| [`to_spmatrix`](qiskit.opflow.state_fns.SparseVectorStateFn.to_spmatrix#qiskit.opflow.state_fns.SparseVectorStateFn.to_spmatrix "qiskit.opflow.state_fns.SparseVectorStateFn.to_spmatrix") | Return SciPy sparse matrix representation of the Operator. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`SparseVectorStateFn` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`dict` + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### to\_circuit\_op + + + +`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`. + +**Return type** + +`OperatorBase` + +### to\_dict\_fn + + + +`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`. + +**Return type** + +`StateFn` + +**Returns** + +A new DictStateFn equivalent to `self`. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** +The NumPy `ndarray` equivalent to this Operator. +### to\_matrix\_op + + + +`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`. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`OperatorBase` + +**Returns** + +A VectorStateFn equivalent to self. + +### to\_spmatrix + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The SciPy `spmatrix` equivalent to this Operator. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -55,7 +245,7 @@ A coefficient by which the state function is multiplied. `Union`\[`complex`, `ParameterExpression`] - + ### instance\_id @@ -65,7 +255,7 @@ Return the unique instance id. `int` - + ### is\_measurement @@ -75,7 +265,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -83,11 +273,11 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive @@ -95,7 +285,7 @@ Whether the StateFn object is a measurement Operator. The primitive which defines the behavior of the underlying State function. - + ### settings @@ -104,3 +294,4 @@ Return settings. **Return type** `Dict` + 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 71a942a0354..315df2f89ad 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 @@ -1,8 +1,16 @@ -# StateFn +--- +title: StateFn +description: API reference for qiskit.opflow.state_fns.StateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.state_fns.StateFn +--- +# StateFn + -`StateFn(primitive=None, coeff=1.0, is_measurement=False)` +`StateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/state_fn.py "view source code") Bases: `qiskit.opflow.operator_base.OperatorBase` @@ -22,37 +30,390 @@ NOTE: State functions here are not restricted to wave functions, as there is no ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.state_fns.StateFn.add#qiskit.opflow.state_fns.StateFn.add "qiskit.opflow.state_fns.StateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.state_fns.StateFn.adjoint#qiskit.opflow.state_fns.StateFn.adjoint "qiskit.opflow.state_fns.StateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`assign_parameters`](qiskit.opflow.state_fns.StateFn.assign_parameters#qiskit.opflow.state_fns.StateFn.assign_parameters "qiskit.opflow.state_fns.StateFn.assign_parameters") | Binds scalar values to any Terra `Parameters` in the coefficients or primitives of the Operator, or substitutes one `Parameter` for another. | -| [`compose`](qiskit.opflow.state_fns.StateFn.compose#qiskit.opflow.state_fns.StateFn.compose "qiskit.opflow.state_fns.StateFn.compose") | 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. | -| [`equals`](qiskit.opflow.state_fns.StateFn.equals#qiskit.opflow.state_fns.StateFn.equals "qiskit.opflow.state_fns.StateFn.equals") | Evaluate Equality between Operators, overloaded by `==`. | -| [`eval`](qiskit.opflow.state_fns.StateFn.eval#qiskit.opflow.state_fns.StateFn.eval "qiskit.opflow.state_fns.StateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`mul`](qiskit.opflow.state_fns.StateFn.mul#qiskit.opflow.state_fns.StateFn.mul "qiskit.opflow.state_fns.StateFn.mul") | Returns the scalar multiplication of the Operator, overloaded by `*`, including support for Terra’s `Parameters`, which can be bound to values later (via `bind_parameters`). | -| [`permute`](qiskit.opflow.state_fns.StateFn.permute#qiskit.opflow.state_fns.StateFn.permute "qiskit.opflow.state_fns.StateFn.permute") | Permute the qubits of the state function. | -| [`power`](qiskit.opflow.state_fns.StateFn.power#qiskit.opflow.state_fns.StateFn.power "qiskit.opflow.state_fns.StateFn.power") | Compose with Self Multiple Times, undefined for StateFns. | -| [`primitive_strings`](qiskit.opflow.state_fns.StateFn.primitive_strings#qiskit.opflow.state_fns.StateFn.primitive_strings "qiskit.opflow.state_fns.StateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`reduce`](qiskit.opflow.state_fns.StateFn.reduce#qiskit.opflow.state_fns.StateFn.reduce "qiskit.opflow.state_fns.StateFn.reduce") | Try collapsing the Operator structure, usually after some type of conversion, e.g. | -| [`sample`](qiskit.opflow.state_fns.StateFn.sample#qiskit.opflow.state_fns.StateFn.sample "qiskit.opflow.state_fns.StateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.opflow.state_fns.StateFn.tensor#qiskit.opflow.state_fns.StateFn.tensor "qiskit.opflow.state_fns.StateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`tensorpower`](qiskit.opflow.state_fns.StateFn.tensorpower#qiskit.opflow.state_fns.StateFn.tensorpower "qiskit.opflow.state_fns.StateFn.tensorpower") | Return tensor product with self multiple times, overloaded by `^`. | -| [`to_circuit_op`](qiskit.opflow.state_fns.StateFn.to_circuit_op#qiskit.opflow.state_fns.StateFn.to_circuit_op "qiskit.opflow.state_fns.StateFn.to_circuit_op") | Returns a `CircuitOp` equivalent to this Operator. | -| [`to_density_matrix`](qiskit.opflow.state_fns.StateFn.to_density_matrix#qiskit.opflow.state_fns.StateFn.to_density_matrix "qiskit.opflow.state_fns.StateFn.to_density_matrix") | Return matrix representing product of StateFn evaluated on pairs of basis states. | -| [`to_matrix`](qiskit.opflow.state_fns.StateFn.to_matrix#qiskit.opflow.state_fns.StateFn.to_matrix "qiskit.opflow.state_fns.StateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.state_fns.StateFn.to_matrix_op#qiskit.opflow.state_fns.StateFn.to_matrix_op "qiskit.opflow.state_fns.StateFn.to_matrix_op") | Return a `VectorStateFn` for this `StateFn`. | -| [`traverse`](qiskit.opflow.state_fns.StateFn.traverse#qiskit.opflow.state_fns.StateFn.traverse "qiskit.opflow.state_fns.StateFn.traverse") | Apply the convert\_fn to the internal primitive if the primitive is an Operator (as in the case of `OperatorStateFn`). | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### assign\_parameters + + + +`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. + +**Parameters** + +**param\_dict** (`dict`) – The dictionary of `Parameters` to replace, and values or lists of values by which to replace them. +**Return type** + +`OperatorBase` + +**Returns** + +The `OperatorBase` with the `Parameters` in self replaced by the values or `Parameters` in param\_dict. If param\_dict contains parameterization lists, this `OperatorBase` is an `OpList`. + +### compose + + + +`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. + +**Parameters** + +* **other** (`OperatorBase`) – The Operator to compose with self. +* **permutation** (`Optional`\[`List`\[`int`]]) – `List[int]` which defines permutation on other operator. +* **front** (`bool`) – If front==True, return `other.compose(self)`. + +**Return type** + +`OperatorBase` + +**Returns** + +An Operator equivalent to the function composition of self and other. + +**Raises** + +**ValueError** – If self is not a measurement, it cannot be composed from the right. + +### equals + + + +`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. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to compare to self. + +**Return type** + +`bool` + +**Returns** + +A bool equal to the equality of self and other. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### mul + + + +`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`). + +**Parameters** + +**scalar** (`Union`\[`complex`, `ParameterExpression`]) – The real or complex scalar by which to multiply the Operator, or the `ParameterExpression` to serve as a placeholder for a scalar factor. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to product of self and scalar. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`OperatorBase` + +**Returns** + +A new StateFn containing the permuted primitive. + +### power + + + +`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. + +**Parameters** + +**exponent** (`int`) – The number of times to compose self with self. + +**Raises** + +**ValueError** – This function is not defined for StateFns. + +**Return type** + +`OperatorBase` + +### primitive\_strings + + + +`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. + +**Return type** +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### reduce + + + +`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. + +**Return type** + +`OperatorBase` + +**Returns** + +The reduced `OperatorBase`. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`Dict`\[`str`, `float`] + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 + +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### tensorpower + + + +`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 `^`. + +**Parameters** + +**other** (`int`) – The int number of times to tensor product self with itself via `tensorpower`. + +**Return type** + +`Union`\[`OperatorBase`, `int`] + +**Returns** + +An `OperatorBase` equivalent to the tensorpower of self by other. + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy array representing the density matrix of the State function. + +**Raises** + +**ValueError** – If massive is set to False, and exponentially large computation is needed. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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`. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`OperatorBase` + +**Returns** + +A VectorStateFn equivalent to self. + +### traverse + + + +`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. + +**Parameters** + +* **convert\_fn** (`Callable`) – The function to apply to the internal OperatorBase. +* **coeff** (`Union`\[`complex`, `ParameterExpression`, `None`]) – A coefficient to multiply by after applying convert\_fn. If it is None, self.coeff is used instead. + +**Return type** + +`OperatorBase` + +**Returns** + +The converted StateFn. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -62,7 +423,7 @@ A coefficient by which the state function is multiplied. `Union`\[`complex`, `ParameterExpression`] - + ### instance\_id @@ -72,7 +433,7 @@ Return the unique instance id. `int` - + ### is\_measurement @@ -82,7 +443,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -90,17 +451,17 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive The primitive which defines the behavior of the underlying State function. - + ### settings @@ -109,3 +470,4 @@ Return settings. **Return type** `Dict` + 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 f0a2f3d3c91..5e6a01d2378 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 @@ -1,8 +1,16 @@ -# VectorStateFn +--- +title: VectorStateFn +description: API reference for qiskit.opflow.state_fns.VectorStateFn +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.opflow.state_fns.VectorStateFn +--- +# VectorStateFn + -`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)` +`VectorStateFn(primitive=None, coeff=1.0, is_measurement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/opflow/state_fns/vector_state_fn.py "view source code") Bases: `qiskit.opflow.state_fns.state_fn.StateFn` @@ -16,30 +24,243 @@ A class for state functions and measurements which are defined in vector represe ## Methods Defined Here -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | -| [`add`](qiskit.opflow.state_fns.VectorStateFn.add#qiskit.opflow.state_fns.VectorStateFn.add "qiskit.opflow.state_fns.VectorStateFn.add") | Return Operator addition of self and other, overloaded by `+`. | -| [`adjoint`](qiskit.opflow.state_fns.VectorStateFn.adjoint#qiskit.opflow.state_fns.VectorStateFn.adjoint "qiskit.opflow.state_fns.VectorStateFn.adjoint") | Return a new Operator equal to the Operator’s adjoint (conjugate transpose), overloaded by `~`. | -| [`eval`](qiskit.opflow.state_fns.VectorStateFn.eval#qiskit.opflow.state_fns.VectorStateFn.eval "qiskit.opflow.state_fns.VectorStateFn.eval") | Evaluate the Operator’s underlying function, either on a binary string or another Operator. | -| [`permute`](qiskit.opflow.state_fns.VectorStateFn.permute#qiskit.opflow.state_fns.VectorStateFn.permute "qiskit.opflow.state_fns.VectorStateFn.permute") | Permute the qubits of the state function. | -| [`primitive_strings`](qiskit.opflow.state_fns.VectorStateFn.primitive_strings#qiskit.opflow.state_fns.VectorStateFn.primitive_strings "qiskit.opflow.state_fns.VectorStateFn.primitive_strings") | Return a set of strings describing the primitives contained in the Operator. | -| [`sample`](qiskit.opflow.state_fns.VectorStateFn.sample#qiskit.opflow.state_fns.VectorStateFn.sample "qiskit.opflow.state_fns.VectorStateFn.sample") | Sample the state function as a normalized probability distribution. | -| [`tensor`](qiskit.opflow.state_fns.VectorStateFn.tensor#qiskit.opflow.state_fns.VectorStateFn.tensor "qiskit.opflow.state_fns.VectorStateFn.tensor") | Return tensor product between self and other, overloaded by `^`. | -| [`to_circuit_op`](qiskit.opflow.state_fns.VectorStateFn.to_circuit_op#qiskit.opflow.state_fns.VectorStateFn.to_circuit_op "qiskit.opflow.state_fns.VectorStateFn.to_circuit_op") | Return `StateFnCircuit` corresponding to this StateFn. | -| [`to_density_matrix`](qiskit.opflow.state_fns.VectorStateFn.to_density_matrix#qiskit.opflow.state_fns.VectorStateFn.to_density_matrix "qiskit.opflow.state_fns.VectorStateFn.to_density_matrix") | Return matrix representing product of StateFn evaluated on pairs of basis states. | -| [`to_dict_fn`](qiskit.opflow.state_fns.VectorStateFn.to_dict_fn#qiskit.opflow.state_fns.VectorStateFn.to_dict_fn "qiskit.opflow.state_fns.VectorStateFn.to_dict_fn") | Creates the equivalent state function of type DictStateFn. | -| [`to_matrix`](qiskit.opflow.state_fns.VectorStateFn.to_matrix#qiskit.opflow.state_fns.VectorStateFn.to_matrix "qiskit.opflow.state_fns.VectorStateFn.to_matrix") | Return NumPy representation of the Operator. | -| [`to_matrix_op`](qiskit.opflow.state_fns.VectorStateFn.to_matrix_op#qiskit.opflow.state_fns.VectorStateFn.to_matrix_op "qiskit.opflow.state_fns.VectorStateFn.to_matrix_op") | Return a `VectorStateFn` for this `StateFn`. | +### add -## Attributes + + +`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 `+`. + +**Parameters** + +**other** (`OperatorBase`) – An `OperatorBase` with the same number of qubits as self, and in the same ‘Operator’, ‘State function’, or ‘Measurement’ category as self (i.e. the same type of underlying function). + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the sum of self and other. + +### adjoint + + + +`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. + +**Return type** + +`VectorStateFn` + +**Returns** + +An `OperatorBase` equivalent to the adjoint of self. + +### eval + + + +`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). + +If `front` is None, the matrix-representation of the operator is returned. + +**Parameters** + +**front** (`Union`\[`str`, `Dict`\[`str`, `complex`], `ndarray`, `OperatorBase`, `Statevector`, `None`]) – The bitstring, dict of bitstrings (with values being coefficients), or StateFn to evaluated by the Operator’s underlying function, or None. + +**Return type** + +`Union`\[`OperatorBase`, `complex`] + +**Returns** + +The output of the Operator’s evaluation function. If self is a `StateFn`, the result is a float or complex. If self is an Operator (`PrimitiveOp, ComposedOp, SummedOp, EvolvedOp,` etc.), the result is a StateFn. If `front` is None, the matrix-representation of the operator is returned, which is a `MatrixOp` for the operators and a `VectorStateFn` for state-functions. If either self or front contain proper `ListOps` (not ListOp subclasses), the result is an n-dimensional list of complex or StateFn results, resulting from the recursive evaluation by each OperatorBase in the ListOps. + +### permute + + + +`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. + +**Parameters** + +**permutation** (`List`\[`int`]) – A list defining where each qubit should be permuted. The qubit at index j of the circuit should be permuted to position permutation\[j]. + +**Return type** + +`VectorStateFn` + +**Returns** + +A new StateFn containing the permuted primitive. + +### primitive\_strings + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +A set of strings describing the primitives contained within the Operator. + +### sample + + + +`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. + +**Parameters** + +* **shots** (`int`) – The number of samples to take to approximate the State function. +* **massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. +* **reverse\_endianness** (`bool`) – Whether to reverse the endianness of the bitstrings in the return dict to match Terra’s big-endianness. + +**Return type** + +`dict` + +**Returns** + +A dict containing pairs sampled strings from the State function and sampling frequency divided by shots. + +### tensor + + + +`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 +> |0⟩– |+⟩– + +Because Terra prints circuits and results with qubit 0 at the end of the string or circuit. + +**Parameters** + +**other** (`OperatorBase`) – The `OperatorBase` to tensor product with self. + +**Return type** + +`OperatorBase` + +**Returns** + +An `OperatorBase` equivalent to the tensor product of self and other. + +### to\_circuit\_op + + + +`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. + +**Return type** + +`OperatorBase` + +### to\_density\_matrix + + + +`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. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy array representing the density matrix of the State function. + +**Raises** + +**ValueError** – If massive is set to False, and exponentially large computation is needed. + +### to\_dict\_fn + + + +`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. + +**Return type** + +`StateFn` + +**Returns** + +A new DictStateFn equivalent to `self`. + +### to\_matrix + + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +The NumPy `ndarray` equivalent to this Operator. + +### to\_matrix\_op + + + +`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`. + +**Parameters** + +**massive** (`bool`) – Whether to allow large conversions, e.g. creating a matrix representing over 16 qubits. + +**Return type** + +`OperatorBase` + +**Returns** + +A VectorStateFn equivalent to self. + +## Attributes + + ### INDENTATION `= ' '` - + ### coeff @@ -49,7 +270,7 @@ A coefficient by which the state function is multiplied. `Union`\[`complex`, `ParameterExpression`] - + ### instance\_id @@ -59,7 +280,7 @@ Return the unique instance id. `int` - + ### is\_measurement @@ -69,7 +290,7 @@ Whether the StateFn object is a measurement Operator. `bool` - + ### num\_qubits @@ -77,11 +298,11 @@ Whether the StateFn object is a measurement Operator. `int` - + ### parameters - + ### primitive @@ -89,7 +310,7 @@ Whether the StateFn object is a measurement Operator. The primitive which defines the behavior of the underlying State function. - + ### settings @@ -98,3 +319,4 @@ Return settings. **Return type** `Dict` + diff --git a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md index b5a5f54f8e1..be5505d8a1f 100644 --- a/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md +++ b/docs/api/qiskit/0.32/qiskit.opflow.state_fns.md @@ -18,12 +18,12 @@ Measurements are defined to be functionals over StateFns, taking them to real va ### State Functions -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`StateFn`](qiskit.opflow.state_fns.StateFn#qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.StateFn")(\[primitive, coeff, is\_measurement]) | A class for representing state functions and measurements. | -| [`CircuitStateFn`](qiskit.opflow.state_fns.CircuitStateFn#qiskit.opflow.state_fns.CircuitStateFn "qiskit.opflow.state_fns.CircuitStateFn")(\[primitive, coeff, …]) | 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. | -| [`DictStateFn`](qiskit.opflow.state_fns.DictStateFn#qiskit.opflow.state_fns.DictStateFn "qiskit.opflow.state_fns.DictStateFn")(\[primitive, coeff, …]) | A class for state functions and measurements which are defined by a lookup table, stored in a dict. | -| [`VectorStateFn`](qiskit.opflow.state_fns.VectorStateFn#qiskit.opflow.state_fns.VectorStateFn "qiskit.opflow.state_fns.VectorStateFn")(\[primitive, coeff, is\_measurement]) | A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. | -| [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn#qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | -| [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn#qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | -| [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement#qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`StateFn`](qiskit.opflow.state_fns.StateFn "qiskit.opflow.state_fns.StateFn")(\[primitive, coeff, is\_measurement]) | A class for representing state functions and measurements. | +| [`CircuitStateFn`](qiskit.opflow.state_fns.CircuitStateFn "qiskit.opflow.state_fns.CircuitStateFn")(\[primitive, coeff, …]) | 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. | +| [`DictStateFn`](qiskit.opflow.state_fns.DictStateFn "qiskit.opflow.state_fns.DictStateFn")(\[primitive, coeff, …]) | A class for state functions and measurements which are defined by a lookup table, stored in a dict. | +| [`VectorStateFn`](qiskit.opflow.state_fns.VectorStateFn "qiskit.opflow.state_fns.VectorStateFn")(\[primitive, coeff, is\_measurement]) | A class for state functions and measurements which are defined in vector representation, and stored using Terra’s `Statevector` class. | +| [`SparseVectorStateFn`](qiskit.opflow.state_fns.SparseVectorStateFn "qiskit.opflow.state_fns.SparseVectorStateFn")(primitive\[, coeff, …]) | A class for sparse state functions and measurements in vector representation. | +| [`OperatorStateFn`](qiskit.opflow.state_fns.OperatorStateFn "qiskit.opflow.state_fns.OperatorStateFn")(primitive\[, coeff, …]) | A class for state functions and measurements which are defined by a density Operator, stored using an `OperatorBase`. | +| [`CVaRMeasurement`](qiskit.opflow.state_fns.CVaRMeasurement "qiskit.opflow.state_fns.CVaRMeasurement")(\[primitive, alpha, coeff]) | A specialized measurement class to compute CVaR expectation values. | diff --git a/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md b/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md index fad6e29ab03..9372d7fff09 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError.md @@ -1,9 +1,18 @@ -# qiskit.optimization.QiskitOptimizationError +--- +title: QiskitOptimizationError +description: API reference for qiskit.optimization.QiskitOptimizationError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.optimization.QiskitOptimizationError +--- +# qiskit.optimization.QiskitOptimizationError + -`QiskitOptimizationError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md b/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md index 355b8f82e82..bdaf05c904f 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.QuadraticProgram.md @@ -1,8 +1,16 @@ -# QuadraticProgram +--- +title: QuadraticProgram +description: API reference for qiskit.optimization.QuadraticProgram +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.QuadraticProgram +--- +# QuadraticProgram + -`QuadraticProgram(name='')` +`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` @@ -16,49 +24,826 @@ This representation supports inequality and equality constraints, as well as con ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| [`binary_var`](qiskit.optimization.QuadraticProgram.binary_var#qiskit.optimization.QuadraticProgram.binary_var "qiskit.optimization.QuadraticProgram.binary_var") | Adds a binary variable to the quadratic program. | -| [`binary_var_dict`](qiskit.optimization.QuadraticProgram.binary_var_dict#qiskit.optimization.QuadraticProgram.binary_var_dict "qiskit.optimization.QuadraticProgram.binary_var_dict") | Uses ‘var\_dict’ to construct a dictionary of binary variables | -| [`binary_var_list`](qiskit.optimization.QuadraticProgram.binary_var_list#qiskit.optimization.QuadraticProgram.binary_var_list "qiskit.optimization.QuadraticProgram.binary_var_list") | Uses ‘var\_list’ to construct a list of binary variables | -| [`clear`](qiskit.optimization.QuadraticProgram.clear#qiskit.optimization.QuadraticProgram.clear "qiskit.optimization.QuadraticProgram.clear") | Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. | -| [`continuous_var`](qiskit.optimization.QuadraticProgram.continuous_var#qiskit.optimization.QuadraticProgram.continuous_var "qiskit.optimization.QuadraticProgram.continuous_var") | Adds a continuous variable to the quadratic program. | -| [`continuous_var_dict`](qiskit.optimization.QuadraticProgram.continuous_var_dict#qiskit.optimization.QuadraticProgram.continuous_var_dict "qiskit.optimization.QuadraticProgram.continuous_var_dict") | Uses ‘var\_dict’ to construct a dictionary of continuous variables | -| [`continuous_var_list`](qiskit.optimization.QuadraticProgram.continuous_var_list#qiskit.optimization.QuadraticProgram.continuous_var_list "qiskit.optimization.QuadraticProgram.continuous_var_list") | Uses ‘var\_list’ to construct a list of continuous variables | -| [`export_as_lp_string`](qiskit.optimization.QuadraticProgram.export_as_lp_string#qiskit.optimization.QuadraticProgram.export_as_lp_string "qiskit.optimization.QuadraticProgram.export_as_lp_string") | Returns the quadratic program as a string of LP format. | -| [`from_docplex`](qiskit.optimization.QuadraticProgram.from_docplex#qiskit.optimization.QuadraticProgram.from_docplex "qiskit.optimization.QuadraticProgram.from_docplex") | Loads this quadratic program from a docplex model. | -| [`from_ising`](qiskit.optimization.QuadraticProgram.from_ising#qiskit.optimization.QuadraticProgram.from_ising "qiskit.optimization.QuadraticProgram.from_ising") | Create a quadratic program from a qubit operator and a shift value. | -| [`get_feasibility_info`](qiskit.optimization.QuadraticProgram.get_feasibility_info#qiskit.optimization.QuadraticProgram.get_feasibility_info "qiskit.optimization.QuadraticProgram.get_feasibility_info") | Returns whether a solution is feasible or not along with the violations. | -| [`get_linear_constraint`](qiskit.optimization.QuadraticProgram.get_linear_constraint#qiskit.optimization.QuadraticProgram.get_linear_constraint "qiskit.optimization.QuadraticProgram.get_linear_constraint") | Returns a linear constraint for a given name or index. | -| [`get_num_binary_vars`](qiskit.optimization.QuadraticProgram.get_num_binary_vars#qiskit.optimization.QuadraticProgram.get_num_binary_vars "qiskit.optimization.QuadraticProgram.get_num_binary_vars") | Returns the total number of binary variables. | -| [`get_num_continuous_vars`](qiskit.optimization.QuadraticProgram.get_num_continuous_vars#qiskit.optimization.QuadraticProgram.get_num_continuous_vars "qiskit.optimization.QuadraticProgram.get_num_continuous_vars") | Returns the total number of continuous variables. | -| [`get_num_integer_vars`](qiskit.optimization.QuadraticProgram.get_num_integer_vars#qiskit.optimization.QuadraticProgram.get_num_integer_vars "qiskit.optimization.QuadraticProgram.get_num_integer_vars") | Returns the total number of integer variables. | -| [`get_num_linear_constraints`](qiskit.optimization.QuadraticProgram.get_num_linear_constraints#qiskit.optimization.QuadraticProgram.get_num_linear_constraints "qiskit.optimization.QuadraticProgram.get_num_linear_constraints") | Returns the number of linear constraints. | -| [`get_num_quadratic_constraints`](qiskit.optimization.QuadraticProgram.get_num_quadratic_constraints#qiskit.optimization.QuadraticProgram.get_num_quadratic_constraints "qiskit.optimization.QuadraticProgram.get_num_quadratic_constraints") | Returns the number of quadratic constraints. | -| [`get_num_vars`](qiskit.optimization.QuadraticProgram.get_num_vars#qiskit.optimization.QuadraticProgram.get_num_vars "qiskit.optimization.QuadraticProgram.get_num_vars") | Returns the total number of variables or the number of variables of the specified type. | -| [`get_quadratic_constraint`](qiskit.optimization.QuadraticProgram.get_quadratic_constraint#qiskit.optimization.QuadraticProgram.get_quadratic_constraint "qiskit.optimization.QuadraticProgram.get_quadratic_constraint") | Returns a quadratic constraint for a given name or index. | -| [`get_variable`](qiskit.optimization.QuadraticProgram.get_variable#qiskit.optimization.QuadraticProgram.get_variable "qiskit.optimization.QuadraticProgram.get_variable") | Returns a variable for a given name or index. | -| [`integer_var`](qiskit.optimization.QuadraticProgram.integer_var#qiskit.optimization.QuadraticProgram.integer_var "qiskit.optimization.QuadraticProgram.integer_var") | Adds an integer variable to the quadratic program. | -| [`integer_var_dict`](qiskit.optimization.QuadraticProgram.integer_var_dict#qiskit.optimization.QuadraticProgram.integer_var_dict "qiskit.optimization.QuadraticProgram.integer_var_dict") | Uses ‘var\_dict’ to construct a dictionary of integer variables | -| [`integer_var_list`](qiskit.optimization.QuadraticProgram.integer_var_list#qiskit.optimization.QuadraticProgram.integer_var_list "qiskit.optimization.QuadraticProgram.integer_var_list") | Uses ‘var\_list’ to construct a dictionary of integer variables | -| [`is_feasible`](qiskit.optimization.QuadraticProgram.is_feasible#qiskit.optimization.QuadraticProgram.is_feasible "qiskit.optimization.QuadraticProgram.is_feasible") | Returns whether a solution is feasible or not. | -| [`linear_constraint`](qiskit.optimization.QuadraticProgram.linear_constraint#qiskit.optimization.QuadraticProgram.linear_constraint "qiskit.optimization.QuadraticProgram.linear_constraint") | Adds a linear equality constraint to the quadratic program of the form: | -| [`maximize`](qiskit.optimization.QuadraticProgram.maximize#qiskit.optimization.QuadraticProgram.maximize "qiskit.optimization.QuadraticProgram.maximize") | Sets a quadratic objective to be maximized. | -| [`minimize`](qiskit.optimization.QuadraticProgram.minimize#qiskit.optimization.QuadraticProgram.minimize "qiskit.optimization.QuadraticProgram.minimize") | Sets a quadratic objective to be minimized. | -| [`pprint_as_string`](qiskit.optimization.QuadraticProgram.pprint_as_string#qiskit.optimization.QuadraticProgram.pprint_as_string "qiskit.optimization.QuadraticProgram.pprint_as_string") | DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. | -| [`prettyprint`](qiskit.optimization.QuadraticProgram.prettyprint#qiskit.optimization.QuadraticProgram.prettyprint "qiskit.optimization.QuadraticProgram.prettyprint") | DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). | -| [`quadratic_constraint`](qiskit.optimization.QuadraticProgram.quadratic_constraint#qiskit.optimization.QuadraticProgram.quadratic_constraint "qiskit.optimization.QuadraticProgram.quadratic_constraint") | Adds a quadratic equality constraint to the quadratic program of the form: | -| [`read_from_lp_file`](qiskit.optimization.QuadraticProgram.read_from_lp_file#qiskit.optimization.QuadraticProgram.read_from_lp_file "qiskit.optimization.QuadraticProgram.read_from_lp_file") | Loads the quadratic program from a LP file. | -| [`remove_linear_constraint`](qiskit.optimization.QuadraticProgram.remove_linear_constraint#qiskit.optimization.QuadraticProgram.remove_linear_constraint "qiskit.optimization.QuadraticProgram.remove_linear_constraint") | Remove a linear constraint | -| [`remove_quadratic_constraint`](qiskit.optimization.QuadraticProgram.remove_quadratic_constraint#qiskit.optimization.QuadraticProgram.remove_quadratic_constraint "qiskit.optimization.QuadraticProgram.remove_quadratic_constraint") | Remove a quadratic constraint | -| [`substitute_variables`](qiskit.optimization.QuadraticProgram.substitute_variables#qiskit.optimization.QuadraticProgram.substitute_variables "qiskit.optimization.QuadraticProgram.substitute_variables") | Substitutes variables with constants or other variables. | -| [`to_docplex`](qiskit.optimization.QuadraticProgram.to_docplex#qiskit.optimization.QuadraticProgram.to_docplex "qiskit.optimization.QuadraticProgram.to_docplex") | Returns a docplex model corresponding to this quadratic program. | -| [`to_ising`](qiskit.optimization.QuadraticProgram.to_ising#qiskit.optimization.QuadraticProgram.to_ising "qiskit.optimization.QuadraticProgram.to_ising") | Return the Ising Hamiltonian of this problem. | -| [`write_to_lp_file`](qiskit.optimization.QuadraticProgram.write_to_lp_file#qiskit.optimization.QuadraticProgram.write_to_lp_file "qiskit.optimization.QuadraticProgram.write_to_lp_file") | Writes the quadratic program to an LP file. | +### binary\_var -## Attributes + + +`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. + +**Parameters** + +**name** (`Optional`\[`str`]) – The name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The added variable. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already occupied. + +### binary\_var\_dict + + + +`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 + +**Parameters** + +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`Dict`\[`str`, `Variable`] + +**Returns** + +A dictionary mapping the variable names to variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### binary\_var\_list + + + +`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 + +**Parameters** + +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`List`\[`Variable`] + +**Returns** + +A list of variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### clear + + + +`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. + +**Return type** + +`None` + +### continuous\_var + + + +`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. + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lowerbound of the variable. +* **upperbound** (`Union`\[`float`, `int`]) – The upperbound of the variable. +* **name** (`Optional`\[`str`]) – The name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The added variable. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already occupied. + +### continuous\_var\_dict + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`Dict`\[`str`, `Variable`] + +**Returns** + +A dictionary mapping the variable names to variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### continuous\_var\_list + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`List`\[`Variable`] + +**Returns** + +A list of variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### export\_as\_lp\_string + + + +`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. + +**Return type** + +`str` + +**Returns** + +A string representing the quadratic program. + +### from\_docplex + + + +`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. + +Note that this supports only basic functions of docplex as follows: - quadratic objective function - linear / quadratic constraints - binary / integer / continuous variables + +**Parameters** + +**model** (`Model`) – The docplex model to be loaded. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the model contains unsupported elements. + +**Return type** + +`None` + +### from\_ising + + + +`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. + +**Parameters** + +* **qubit\_op** (`Union`\[`OperatorBase`, `WeightedPauliOperator`]) – The qubit operator of the problem. +* **offset** (`float`) – The constant value in the Ising Hamiltonian. +* **linear** (`bool`) – If linear is True, $x^2$ is treated as a linear term since $x^2 = x$ for $x \in \{0,1\}$. Else, $x^2$ is treat as a quadratic term. The default value is False. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If there are Pauli Xs in any Pauli term +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If there are more than 2 Pauli Zs in any Pauli term +* **NotImplementedError** – If the input operator is a ListOp + +**Return type** + +`None` + +### get\_feasibility\_info + + + +`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. + +**Returns** + +Whether the solution provided is feasible or not. List\[Variable]: List of variables which are violated. List\[Constraint]: List of constraints which are violated. + +**Return type** + +feasible + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the input x is not same len as total vars + +### get\_linear\_constraint + + + +`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. + +**Parameters** + +**i** (`Union`\[`int`, `str`]) – the index or name of the constraint. + +**Return type** + +`LinearConstraint` + +**Returns** + +The corresponding constraint. + +**Raises** + +* **IndexError** – if the index is out of the list size +* **KeyError** – if the name does not exist + +### get\_num\_binary\_vars + + + +`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. + +**Return type** + +`int` + +**Returns** + +The total number of binary variables. + +### get\_num\_continuous\_vars + + + +`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. + +**Return type** + +`int` + +**Returns** + +The total number of continuous variables. + +### get\_num\_integer\_vars + + + +`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. + +**Return type** + +`int` + +**Returns** + +The total number of integer variables. + +### get\_num\_linear\_constraints + + + +`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. + +**Return type** + +`int` + +**Returns** + +The number of linear constraints. + +### get\_num\_quadratic\_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") + +Returns the number of quadratic constraints. + +**Return type** + +`int` + +**Returns** + +The number of quadratic constraints. + +### get\_num\_vars + + + +`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. + +**Parameters** + +**vartype** (`Optional`\[`VarType`]) – The type to be filtered on. All variables are counted if None. + +**Return type** + +`int` + +**Returns** + +The total number of variables. + +### get\_quadratic\_constraint + + + +`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. + +**Parameters** + +**i** (`Union`\[`int`, `str`]) – the index or name of the constraint. + +**Return type** + +`QuadraticConstraint` + +**Returns** + +The corresponding constraint. + +**Raises** + +* **IndexError** – if the index is out of the list size +* **KeyError** – if the name does not exist + +### get\_variable + +`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. + +**Parameters** + +**i** (`Union`\[`int`, `str`]) – the index or name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The corresponding variable. + +### integer\_var + + + +`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. + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lowerbound of the variable. +* **upperbound** (`Union`\[`float`, `int`]) – The upperbound of the variable. +* **name** (`Optional`\[`str`]) – The name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The added variable. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already occupied. + +### integer\_var\_dict + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`Dict`\[`str`, `Variable`] + +**Returns** + +A dictionary mapping the variable names to variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### integer\_var\_list + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`List`\[`Variable`] + +**Returns** + +A list of variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### is\_feasible + + + +`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. + +**Parameters** + +**x** (`Union`\[`List`\[`float`], `ndarray`]) – a solution value, such as returned in an optimizer result. + +**Return type** + +`bool` + +**Returns** + +`True` if the solution provided is feasible otherwise `False`. + +### linear\_constraint + + + +`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: + +linear \* x sense rhs. + +**Parameters** + +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – The linear coefficients of the left-hand-side of the constraint. +* **sense** (`Union`\[`str`, `ConstraintSense`]) – The sense of the constraint, - ‘==’, ‘=’, ‘E’, and ‘EQ’ denote ‘equal to’. - ‘>=’, ‘>’, ‘G’, and ‘GE’ denote ‘greater-than-or-equal-to’. - ‘\<=’, ‘\<’, ‘L’, and ‘LE’ denote ‘less-than-or-equal-to’. +* **rhs** (`float`) – The right hand side of the constraint. +* **name** (`Optional`\[`str`]) – The name of the constraint. + +**Return type** + +`LinearConstraint` + +**Returns** + +The added constraint. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the constraint name already exists or the sense is not valid. + +### maximize + + + +`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. + +**Parameters** + +* **constant** (`float`) – the constant offset of the objective. +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – the coefficients of the linear part of the objective. +* **quadratic** (`Union`\[`ndarray`, `spmatrix`, `List`\[`List`\[`float`]], `Dict`\[`Tuple`\[`Union`\[`int`, `str`], `Union`\[`int`, `str`]], `float`], `None`]) – the coefficients of the quadratic part of the objective. + +**Return type** + +`None` + +**Returns** + +The created quadratic objective. + +### minimize + + + +`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. + +**Parameters** + +* **constant** (`float`) – the constant offset of the objective. +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – the coefficients of the linear part of the objective. +* **quadratic** (`Union`\[`ndarray`, `spmatrix`, `List`\[`List`\[`float`]], `Dict`\[`Tuple`\[`Union`\[`int`, `str`], `Union`\[`int`, `str`]], `float`], `None`]) – the coefficients of the quadratic part of the objective. + +**Return type** + +`None` + +**Returns** + +The created quadratic objective. + +### pprint\_as\_string + + + +`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. + +### prettyprint + + + +`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). + +**Parameters** + +**out** (`Optional`\[`str`]) – The output stream or file name to print to. if you specify a file name, the output file name is has ‘.mod’ as suffix. + +**Return type** + +`None` + +### quadratic\_constraint + + + +`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: + +x \* Q \* x \<= rhs. + +**Parameters** + +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – The linear coefficients of the constraint. +* **quadratic** (`Union`\[`ndarray`, `spmatrix`, `List`\[`List`\[`float`]], `Dict`\[`Tuple`\[`Union`\[`int`, `str`], `Union`\[`int`, `str`]], `float`], `None`]) – The quadratic coefficients of the constraint. +* **sense** (`Union`\[`str`, `ConstraintSense`]) – The sense of the constraint, - ‘==’, ‘=’, ‘E’, and ‘EQ’ denote ‘equal to’. - ‘>=’, ‘>’, ‘G’, and ‘GE’ denote ‘greater-than-or-equal-to’. - ‘\<=’, ‘\<’, ‘L’, and ‘LE’ denote ‘less-than-or-equal-to’. +* **rhs** (`float`) – The right hand side of the constraint. +* **name** (`Optional`\[`str`]) – The name of the constraint. + +**Return type** + +`QuadraticConstraint` + +**Returns** + +The added constraint. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the constraint name already exists. + +### read\_from\_lp\_file + + + +`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. + +**Parameters** + +**filename** (`str`) – The filename of the file to be loaded. + +**Raises** + +* **FileNotFoundError** – If the file does not exist. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If CPLEX is not installed. + + + This method requires CPLEX to be installed and present in `PYTHONPATH`. + + +**Return type** + +`None` + +### remove\_linear\_constraint + + + +`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 + +**Parameters** + +**i** (`Union`\[`str`, `int`]) – an index or a name of a linear constraint + +**Raises** + +* **KeyError** – if name does not exist +* **IndexError** – if index is out of range + +**Return type** + +`None` + +### remove\_quadratic\_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") + +Remove a quadratic constraint + +**Parameters** + +**i** (`Union`\[`str`, `int`]) – an index or a name of a quadratic constraint + +**Raises** + +* **KeyError** – if name does not exist +* **IndexError** – if index is out of range + +**Return type** + +`None` + +### substitute\_variables + + + +`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. + +**Parameters** + +* **constants** (`Optional`\[`Dict`\[`Union`\[`int`, `str`], `float`]]) – replace variable by constant e.g., \{‘x’: 2} means ‘x’ is substituted with 2 +* **variables** (`Optional`\[`Dict`\[`Union`\[`str`, `int`], `Tuple`\[`Union`\[`str`, `int`], `float`]]]) – replace variables by weighted other variable need to copy everything using name reference to make sure that indices are matched correctly. The lower and upper bounds are updated accordingly. e.g., \{‘x’: (‘y’, 2)} means ‘x’ is substituted with ‘y’ \* 2 + +**Return type** + +`QuadraticProgram` + +**Returns** + +An optimization problem by substituting variables with constants or other variables. If the substitution is valid, QuadraticProgram.status is still QuadraticProgram.Status.VALIAD. Otherwise, it gets QuadraticProgram.Status.INFEASIBLE. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the substitution is invalid as follows. - Same variable is substituted multiple times. - Coefficient of variable substitution is zero. + +### to\_docplex + + + +`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. + +**Return type** + +`Model` + +**Returns** + +The docplex model corresponding to this quadratic program. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if non-supported elements (should never happen). + +### to\_ising + + + +`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. + +**Returns** + +The qubit operator for the problem offset: The constant value in the Ising Hamiltonian. + +**Return type** + +qubit\_op + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If a variable type is not binary. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If constraints exist in the problem. + +### write\_to\_lp\_file + + + +`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. + +**Parameters** + +**filename** (`str`) – The filename of the file the model is written to. If filename is a directory, file name ‘my\_problem.lp’ is appended. If filename does not end with ‘.lp’, suffix ‘.lp’ is appended. + +**Raises** + +* **OSError** – If this cannot open a file. +* **DOcplexException** – If filename is an empty string + +**Return type** + +`None` + +## Attributes + + ### linear\_constraints @@ -72,7 +857,7 @@ Returns the list of linear constraints of the quadratic program. List of linear constraints. - + ### linear\_constraints\_index @@ -86,7 +871,7 @@ Returns the dictionary that maps the name of a linear constraint to its index. The linear constraint index dictionary. - + ### name @@ -100,7 +885,7 @@ Returns the name of the quadratic program. The name of the quadratic program. - + ### objective @@ -114,7 +899,7 @@ Returns the quadratic objective. The quadratic objective. - + ### quadratic\_constraints @@ -128,7 +913,7 @@ Returns the list of quadratic constraints of the quadratic program. List of quadratic constraints. - + ### quadratic\_constraints\_index @@ -142,7 +927,7 @@ Returns the dictionary that maps the name of a quadratic constraint to its index The quadratic constraint index dictionary. - + ### status @@ -156,7 +941,7 @@ Status of the quadratic program. It can be infeasible due to variable substituti The status of the quadratic program - + ### variables @@ -170,7 +955,7 @@ Returns the list of variables of the quadratic program. List of variables. - + ### variables\_index @@ -183,3 +968,4 @@ Returns the dictionary that maps the name of a variable to its index. **Returns** The variable index dictionary. + 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 59408c41585..3c0ddee770b 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizationResult.md @@ -1,8 +1,16 @@ -# ADMMOptimizationResult +--- +title: ADMMOptimizationResult +description: API reference for qiskit.optimization.algorithms.ADMMOptimizationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.ADMMOptimizationResult +--- +# ADMMOptimizationResult + -`ADMMOptimizationResult(x, fval, variables, state, status)` +`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` @@ -18,7 +26,7 @@ ADMMOptimization Result. ## Attributes - + ### fval @@ -32,7 +40,7 @@ Returns the optimal function value. The function value corresponding to the optimal value found in the optimization. - + ### raw\_results @@ -48,7 +56,7 @@ Currently a dump for any leftovers. Additional result information of the optimization algorithm. - + ### samples @@ -62,7 +70,7 @@ Returns the list of solution samples The list of solution samples. - + ### state @@ -72,7 +80,7 @@ returns state `ADMMState` - + ### status @@ -86,7 +94,7 @@ Returns the termination status of the optimization algorithm. The termination status of the algorithm. - + ### variable\_names @@ -100,7 +108,7 @@ Returns the list of variable names of the optimization problem. The list of variable names of the optimization problem. - + ### variables @@ -114,7 +122,7 @@ Returns the list of variables of the optimization problem. The list of variables. - + ### variables\_dict @@ -128,7 +136,7 @@ Returns the optimal value as a dictionary of the variable name and corresponding The optimal value as a dictionary of the variable name and corresponding value. - + ### x @@ -141,3 +149,4 @@ Returns the optimal value found in the optimization or None in case of FAILURE. **Returns** The optimal value found in the optimization. + 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 750debfe14c..8c263ce4d89 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMOptimizer.md @@ -1,8 +1,16 @@ -# ADMMOptimizer +--- +title: ADMMOptimizer +description: API reference for qiskit.optimization.algorithms.ADMMOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.ADMMOptimizer +--- +# ADMMOptimizer + -`ADMMOptimizer(qubo_optimizer=None, continuous_optimizer=None, params=None)` +`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` @@ -18,21 +26,83 @@ Optimization on Classical and Quantum Computers. arXiv preprint arXiv:2001.02069 **Parameters** -* **qubo\_optimizer** (`Optional`\[`OptimizationAlgorithm`]) – An instance of OptimizationAlgorithm that can effectively solve QUBO problems. If not specified then [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer#qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") initialized with an instance of `NumPyMinimumEigensolver` will be used. -* **continuous\_optimizer** (`Optional`\[`OptimizationAlgorithm`]) – An instance of OptimizationAlgorithm that can solve continuous problems. If not specified then [`SlsqpOptimizer`](qiskit.optimization.algorithms.SlsqpOptimizer#qiskit.optimization.algorithms.SlsqpOptimizer "qiskit.optimization.algorithms.SlsqpOptimizer") will be used. +* **qubo\_optimizer** (`Optional`\[`OptimizationAlgorithm`]) – An instance of OptimizationAlgorithm that can effectively solve QUBO problems. If not specified then [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") initialized with an instance of `NumPyMinimumEigensolver` will be used. +* **continuous\_optimizer** (`Optional`\[`OptimizationAlgorithm`]) – An instance of OptimizationAlgorithm that can solve continuous problems. If not specified then [`SlsqpOptimizer`](qiskit.optimization.algorithms.SlsqpOptimizer "qiskit.optimization.algorithms.SlsqpOptimizer") will be used. * **params** (`Optional`\[`ADMMParameters`]) – An instance of ADMMParameters. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.ADMMOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.ADMMOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.ADMMOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`is_compatible`](qiskit.optimization.algorithms.ADMMOptimizer.is_compatible#qiskit.optimization.algorithms.ADMMOptimizer.is_compatible "qiskit.optimization.algorithms.ADMMOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`solve`](qiskit.optimization.algorithms.ADMMOptimizer.solve#qiskit.optimization.algorithms.ADMMOptimizer.solve "qiskit.optimization.algorithms.ADMMOptimizer.solve") | Tries to solves the given problem using ADMM algorithm. | +### get\_compatibility\_msg -## Attributes + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +Returns True if the problem is compatible, otherwise raises an error. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is not compatible with the ADMM optimizer. + +### is\_compatible + + + +`ADMMOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### solve + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`ADMMOptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is not compatible with the ADMM optimizer. + +## Attributes + + ### parameters @@ -45,3 +115,4 @@ Returns current parameters of the optimizer. **Returns** The parameters. + 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 5b6f6588f3c..023564a13d5 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMParameters.md @@ -1,8 +1,16 @@ -# ADMMParameters +--- +title: ADMMParameters +description: API reference for qiskit.optimization.algorithms.ADMMParameters +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.ADMMParameters +--- +# 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)` +`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` @@ -26,3 +34,4 @@ Defines parameters for ADMM optimizer and their default values. * **mu\_merit** (`float`) – Penalization for constraint residual. Used to compute the merit values. * **warm\_start** (`bool`) – Start ADMM with pre-initialized values for binary and continuous variables by solving a relaxed (all variables are continuous) problem first. This option does not guarantee the solution will optimal or even feasible. The option should be used when tuning other options does not help and should be considered as a hint to the optimizer where to start its iterative process. * **max\_iter** (`Optional`\[`int`]) – Deprecated, use maxiter. + 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 dd0527924e5..1ce1e212854 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.ADMMState.md @@ -1,8 +1,16 @@ -# ADMMState +--- +title: ADMMState +description: API reference for qiskit.optimization.algorithms.ADMMState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.ADMMState +--- +# ADMMState + -`ADMMState(op, rho_initial)` +`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` @@ -14,3 +22,4 @@ The state keeps track of various variables are stored that are being updated dur * **op** (`QuadraticProgram`) – The optimization problem being solved. * **rho\_initial** (`float`) – Initial value of the rho parameter. + 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 397cfed8111..3544bd90e64 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CobylaOptimizer.md @@ -1,12 +1,20 @@ -# CobylaOptimizer +--- +title: CobylaOptimizer +description: API reference for qiskit.optimization.algorithms.CobylaOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.CobylaOptimizer +--- +# CobylaOptimizer + -`CobylaOptimizer(rhobeg=1.0, rhoend=0.0001, maxfun=1000, disp=None, catol=0.0002, trials=1, clip=100.0)` +`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` -The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm#qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). +The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin\_cobyla.html](https://docs.scipy.org/doc/scipy-0.14.0/reference/generated/scipy.optimize.fmin_cobyla.html)) to be used within the optimization module. The arguments for `fmin_cobyla` are passed via the constructor. @@ -23,7 +31,7 @@ This class provides a wrapper for `scipy.optimize.fmin_cobyla` ([https://docs.sc Initializes the CobylaOptimizer. -This initializer takes the algorithmic parameters of COBYLA and stores them for later use of `fmin_cobyla` when [`solve()`](qiskit.optimization.algorithms.CobylaOptimizer.solve#qiskit.optimization.algorithms.CobylaOptimizer.solve "qiskit.optimization.algorithms.CobylaOptimizer.solve") is invoked. This optimizer can be applied to find a (local) optimum for problems consisting of only continuous variables. +This initializer takes the algorithmic parameters of COBYLA and stores them for later use of `fmin_cobyla` when [`solve()`](qiskit.optimization.algorithms.CobylaOptimizer#solve "qiskit.optimization.algorithms.CobylaOptimizer.solve") is invoked. This optimizer can be applied to find a (local) optimum for problems consisting of only continuous variables. **Parameters** @@ -37,16 +45,98 @@ This initializer takes the algorithmic parameters of COBYLA and stores them for ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.CobylaOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.CobylaOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.CobylaOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with this optimizer. | -| [`is_compatible`](qiskit.optimization.algorithms.CobylaOptimizer.is_compatible#qiskit.optimization.algorithms.CobylaOptimizer.is_compatible "qiskit.optimization.algorithms.CobylaOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`multi_start_solve`](qiskit.optimization.algorithms.CobylaOptimizer.multi_start_solve#qiskit.optimization.algorithms.CobylaOptimizer.multi_start_solve "qiskit.optimization.algorithms.CobylaOptimizer.multi_start_solve") | Applies a multi start method given a local optimizer. | -| [`solve`](qiskit.optimization.algorithms.CobylaOptimizer.solve#qiskit.optimization.algorithms.CobylaOptimizer.solve "qiskit.optimization.algorithms.CobylaOptimizer.solve") | Tries to solves the given problem using the optimizer. | +### get\_compatibility\_msg -## Attributes + + +`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. + +Checks whether the given problem is compatible, i.e., whether the problem contains only continuous variables, and otherwise, returns a message explaining the incompatibility. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** + +Returns a string describing the incompatibility. + +### is\_compatible + + + +`CobylaOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### multi\_start\_solve + + +`CobylaOptimizer.multi_start_solve(minimize, problem)` +Applies a multi start method given a local optimizer. + +**Parameters** + +* **minimize** (`Callable`\[\[`ndarray`], `Tuple`\[`ndarray`, `Any`]]) – A callable object that minimizes the problem specified +* **problem** (`QuadraticProgram`) – A problem to solve + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the multi start algorithm applied to the problem. + +### solve + + + +`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. + +Runs the optimizer to try to solve the optimization problem. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is incompatible with the optimizer. + +## Attributes + + ### clip @@ -60,7 +150,7 @@ Returns the clip value for this optimizer. The clip value. - + ### trials @@ -73,3 +163,4 @@ Returns the number of trials for this optimizer. **Returns** The number of trials. + 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 1310dbf20e9..323119b6d1f 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.CplexOptimizer.md @@ -1,12 +1,20 @@ -# CplexOptimizer +--- +title: CplexOptimizer +description: API reference for qiskit.optimization.algorithms.CplexOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.CplexOptimizer +--- +# CplexOptimizer + -`CplexOptimizer(disp=False)` +`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` -The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm#qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). +The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `cplex.Cplex` ([https://pypi.org/project/cplex/](https://pypi.org/project/cplex/)) to be used within the optimization module. @@ -29,20 +37,89 @@ Initializes the CplexOptimizer. **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – CPLEX is not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – CPLEX is not installed. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.CplexOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.CplexOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.CplexOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with this optimizer. | -| [`is_compatible`](qiskit.optimization.algorithms.CplexOptimizer.is_compatible#qiskit.optimization.algorithms.CplexOptimizer.is_compatible "qiskit.optimization.algorithms.CplexOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`is_cplex_installed`](qiskit.optimization.algorithms.CplexOptimizer.is_cplex_installed#qiskit.optimization.algorithms.CplexOptimizer.is_cplex_installed "qiskit.optimization.algorithms.CplexOptimizer.is_cplex_installed") | Returns True if cplex is installed | -| [`solve`](qiskit.optimization.algorithms.CplexOptimizer.solve#qiskit.optimization.algorithms.CplexOptimizer.solve "qiskit.optimization.algorithms.CplexOptimizer.solve") | Tries to solves the given problem using the optimizer. | +### get\_compatibility\_msg -## Attributes + + +`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. + +Returns `''` since CPLEX accepts all problems that can be modeled using the `QuadraticProgram`. CPLEX may throw an exception in case the problem is determined to be non-convex. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** + +An empty string. + +### is\_compatible + + + +`CplexOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### is\_cplex\_installed + + + +`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 + +### solve + + + +`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. + +Runs the optimizer to try to solve the optimization problem. If problem is not convex, this optimizer may raise an exception due to incompatibility, depending on the settings. + +**Parameters** +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is incompatible with the optimizer. + +## Attributes + + ### disp @@ -55,3 +132,4 @@ Returns the display setting. **Returns** Whether to print CPLEX information or not. + 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 66e3283e322..f8bec039b40 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizationResult.md @@ -1,8 +1,16 @@ -# GroverOptimizationResult +--- +title: GroverOptimizationResult +description: API reference for qiskit.optimization.algorithms.GroverOptimizationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.GroverOptimizationResult +--- +# GroverOptimizationResult + -`GroverOptimizationResult(x, fval, variables, operation_counts, n_input_qubits, n_output_qubits, intermediate_fval, threshold, status)` +`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` @@ -24,7 +32,7 @@ Constructs a result object with the specific Grover properties. ## Attributes - + ### fval @@ -38,7 +46,7 @@ Returns the optimal function value. The function value corresponding to the optimal value found in the optimization. - + ### intermediate\_fval @@ -52,7 +60,7 @@ Getter of the intermediate fval The intermediate value of fval before interpret. - + ### n\_input\_qubits @@ -66,7 +74,7 @@ Getter of n\_input\_qubits The number of qubits used to represent the input. - + ### n\_output\_qubits @@ -80,7 +88,7 @@ Getter of n\_output\_qubits The number of qubits used to represent the output. - + ### operation\_counts @@ -94,7 +102,7 @@ Get the operation counts. The counts of each operation performed per iteration. - + ### raw\_results @@ -110,7 +118,7 @@ Currently a dump for any leftovers. Additional result information of the optimization algorithm. - + ### samples @@ -124,7 +132,7 @@ Returns the list of solution samples The list of solution samples. - + ### status @@ -138,7 +146,7 @@ Returns the termination status of the optimization algorithm. The termination status of the algorithm. - + ### threshold @@ -152,7 +160,7 @@ Getter of the threshold of Grover algorithm. The threshold of Grover algorithm. - + ### variable\_names @@ -166,7 +174,7 @@ Returns the list of variable names of the optimization problem. The list of variable names of the optimization problem. - + ### variables @@ -180,7 +188,7 @@ Returns the list of variables of the optimization problem. The list of variables. - + ### variables\_dict @@ -194,7 +202,7 @@ Returns the optimal value as a dictionary of the variable name and corresponding The optimal value as a dictionary of the variable name and corresponding value. - + ### x @@ -207,3 +215,4 @@ Returns the optimal value found in the optimization or None in case of FAILURE. **Returns** The optimal value found in the optimization. + 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 827419e5296..fdf1e811782 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.GroverOptimizer.md @@ -1,8 +1,16 @@ -# GroverOptimizer +--- +title: GroverOptimizer +description: API reference for qiskit.optimization.algorithms.GroverOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.GroverOptimizer +--- +# GroverOptimizer + -`GroverOptimizer(num_value_qubits, num_iterations=3, quantum_instance=None, converters=None, penalty=None)` +`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` @@ -13,8 +21,8 @@ Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. * **num\_value\_qubits** (`int`) – The number of value qubits. * **num\_iterations** (`int`) – The number of iterations the algorithm will search with no improvement. * **quantum\_instance** (`Union`\[`BaseBackend`, `Backend`, `QuantumInstance`, `None`]) – Instance of selected backend, defaults to Aer’s statevector simulator. -* **converters** (`Union`\[`QuadraticProgramConverter`, `List`\[`QuadraticProgramConverter`], `None`]) – The converters to use for converting a problem into a different form. By default, when None is specified, an internally created instance of [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo#qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") will be used. -* **penalty** (`Optional`\[`float`]) – The penalty factor used in the default [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo#qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") converter +* **converters** (`Union`\[`QuadraticProgramConverter`, `List`\[`QuadraticProgramConverter`], `None`]) – The converters to use for converting a problem into a different form. By default, when None is specified, an internally created instance of [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") will be used. +* **penalty** (`Optional`\[`float`]) – The penalty factor used in the default [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") converter **Raises** @@ -22,15 +30,78 @@ Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.GroverOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.GroverOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.GroverOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with this optimizer. | -| [`is_compatible`](qiskit.optimization.algorithms.GroverOptimizer.is_compatible#qiskit.optimization.algorithms.GroverOptimizer.is_compatible "qiskit.optimization.algorithms.GroverOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`solve`](qiskit.optimization.algorithms.GroverOptimizer.solve#qiskit.optimization.algorithms.GroverOptimizer.solve "qiskit.optimization.algorithms.GroverOptimizer.solve") | Tries to solves the given problem using the grover optimizer. | +### get\_compatibility\_msg -## Attributes + + +`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. + +Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` +**Returns** + +A message describing the incompatibility. + +### is\_compatible + + + +`GroverOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### solve + + + +`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. + +Runs the optimizer to try to solve the optimization problem. If the problem cannot be, converted to a QUBO, this optimizer raises an exception due to incompatibility. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +* **AttributeError** – If the quantum instance has not been set. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is incompatible with the optimizer. + +## Attributes + + ### quantum\_instance @@ -43,3 +114,4 @@ The quantum instance to run the circuits. **Returns** The quantum instance used in the algorithm. + 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 1f12f560fe2..c3841732628 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.IntermediateResult.md @@ -1,16 +1,24 @@ -# IntermediateResult +--- +title: IntermediateResult +description: API reference for qiskit.optimization.algorithms.IntermediateResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.IntermediateResult +--- +# IntermediateResult + -`IntermediateResult(value)` +`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` -Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer#qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. +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. ## Attributes - + ### ALL\_ITERATIONS @@ -18,7 +26,7 @@ Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](q All intermediate results are stored. - + ### LAST\_ITERATION @@ -26,10 +34,11 @@ All intermediate results are stored. Only results from the last iteration are stored. - + ### NO\_ITERATIONS `= 0` No intermediate results are stored. + 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 b0585b7e98b..0c583aca782 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizationResult.md @@ -1,8 +1,16 @@ -# MinimumEigenOptimizationResult +--- +title: MinimumEigenOptimizationResult +description: API reference for qiskit.optimization.algorithms.MinimumEigenOptimizationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizationResult +--- +# MinimumEigenOptimizationResult + -`MinimumEigenOptimizationResult(x, fval, variables, status, samples=None, min_eigen_solver_result=None, raw_samples=None)` +`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` @@ -20,13 +28,21 @@ Minimum Eigen Optimizer Result. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| [`get_correlations`](qiskit.optimization.algorithms.MinimumEigenOptimizationResult.get_correlations#qiskit.optimization.algorithms.MinimumEigenOptimizationResult.get_correlations "qiskit.optimization.algorithms.MinimumEigenOptimizationResult.get_correlations") | Get \ correlation matrix from samples. | +### get\_correlations -## Attributes + + +`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. +**Return type** + +`ndarray` +## Attributes + + ### fval @@ -40,7 +56,7 @@ Returns the optimal function value. The function value corresponding to the optimal value found in the optimization. - + ### min\_eigen\_solver\_result @@ -50,7 +66,7 @@ Returns a result object obtained from the instance of `MinimumEigensolver`. `MinimumEigensolverResult` - + ### raw\_results @@ -66,7 +82,7 @@ Currently a dump for any leftovers. Additional result information of the optimization algorithm. - + ### raw\_samples @@ -80,7 +96,7 @@ Returns the list of raw solution samples of `MinimumEigensolver`. The list of raw solution samples of `MinimumEigensolver`. - + ### samples @@ -94,7 +110,7 @@ Returns the list of solution samples The list of solution samples. - + ### status @@ -108,7 +124,7 @@ Returns the termination status of the optimization algorithm. The termination status of the algorithm. - + ### variable\_names @@ -122,7 +138,7 @@ Returns the list of variable names of the optimization problem. The list of variable names of the optimization problem. - + ### variables @@ -136,7 +152,7 @@ Returns the list of variables of the optimization problem. The list of variables. - + ### variables\_dict @@ -150,7 +166,7 @@ Returns the optimal value as a dictionary of the variable name and corresponding The optimal value as a dictionary of the variable name and corresponding value. - + ### x @@ -163,3 +179,4 @@ Returns the optimal value found in the optimization or None in case of FAILURE. **Returns** The optimal value found in the optimization. + 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 c6e101888ae..908872eb984 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MinimumEigenOptimizer.md @@ -1,8 +1,16 @@ -# MinimumEigenOptimizer +--- +title: MinimumEigenOptimizer +description: API reference for qiskit.optimization.algorithms.MinimumEigenOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.MinimumEigenOptimizer +--- +# MinimumEigenOptimizer + -`MinimumEigenOptimizer(min_eigen_solver, penalty=None, converters=None)` +`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` @@ -32,24 +40,86 @@ This initializer takes the minimum eigen solver to be used to approximate the gr * **min\_eigen\_solver** (`MinimumEigensolver`) – The eigen solver to find the ground state of the Hamiltonian. * **penalty** (`Optional`\[`float`]) – The penalty factor to be used, or `None` for applying a default logic. -* **converters** (`Union`\[`QuadraticProgramConverter`, `List`\[`QuadraticProgramConverter`], `None`]) – The converters to use for converting a problem into a different form. By default, when None is specified, an internally created instance of [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo#qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") will be used. +* **converters** (`Union`\[`QuadraticProgramConverter`, `List`\[`QuadraticProgramConverter`], `None`]) – The converters to use for converting a problem into a different form. By default, when None is specified, an internally created instance of [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") will be used. **Raises** * **TypeError** – When one of converters has an invalid type. -* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError#qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – When the minimum eigensolver does not return an eigenstate. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – When the minimum eigensolver does not return an eigenstate. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.MinimumEigenOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.MinimumEigenOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.MinimumEigenOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with this optimizer. | -| [`is_compatible`](qiskit.optimization.algorithms.MinimumEigenOptimizer.is_compatible#qiskit.optimization.algorithms.MinimumEigenOptimizer.is_compatible "qiskit.optimization.algorithms.MinimumEigenOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`solve`](qiskit.optimization.algorithms.MinimumEigenOptimizer.solve#qiskit.optimization.algorithms.MinimumEigenOptimizer.solve "qiskit.optimization.algorithms.MinimumEigenOptimizer.solve") | Tries to solves the given problem using the optimizer. | +### get\_compatibility\_msg -## Attributes + + +`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. + +Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** + +A message describing the incompatibility. + +### is\_compatible + + + +`MinimumEigenOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### solve + + + +`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. + +Runs the optimizer to try to solve the optimization problem. + +**Parameters** +**problem** (`QuadraticProgram`) – The problem to be solved. +**Return type** + +`MinimumEigenOptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If problem not compatible. + +## Attributes + + ### min\_eigen\_solver @@ -58,3 +128,4 @@ Returns the minimum eigensolver. **Return type** `MinimumEigensolver` + 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 77041bf1c15..858b2d9f97a 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.MultiStartOptimizer.md @@ -1,8 +1,16 @@ -# MultiStartOptimizer +--- +title: MultiStartOptimizer +description: API reference for qiskit.optimization.algorithms.MultiStartOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.MultiStartOptimizer +--- +# MultiStartOptimizer + -`MultiStartOptimizer(trials=1, clip=100.0)` +`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` @@ -17,16 +25,96 @@ Constructs an instance of this optimizer. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.MultiStartOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.MultiStartOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.MultiStartOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`is_compatible`](qiskit.optimization.algorithms.MultiStartOptimizer.is_compatible#qiskit.optimization.algorithms.MultiStartOptimizer.is_compatible "qiskit.optimization.algorithms.MultiStartOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`multi_start_solve`](qiskit.optimization.algorithms.MultiStartOptimizer.multi_start_solve#qiskit.optimization.algorithms.MultiStartOptimizer.multi_start_solve "qiskit.optimization.algorithms.MultiStartOptimizer.multi_start_solve") | Applies a multi start method given a local optimizer. | -| [`solve`](qiskit.optimization.algorithms.MultiStartOptimizer.solve#qiskit.optimization.algorithms.MultiStartOptimizer.solve "qiskit.optimization.algorithms.MultiStartOptimizer.solve") | Tries to solves the given problem using the optimizer. | +### get\_compatibility\_msg -## Attributes + + +`abstract MultiStartOptimizer.get_compatibility_msg(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** + +Returns the incompatibility message. If the message is empty no issues were found. + +### is\_compatible + +`MultiStartOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### multi\_start\_solve + + + +`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. + +**Parameters** + +* **minimize** (`Callable`\[\[`ndarray`], `Tuple`\[`ndarray`, `Any`]]) – A callable object that minimizes the problem specified +* **problem** (`QuadraticProgram`) – A problem to solve + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the multi start algorithm applied to the problem. + +### solve + + + +`abstract MultiStartOptimizer.solve(problem)` + +Tries to solves the given problem using the optimizer. + +Runs the optimizer to try to solve the optimization problem. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is incompatible with the optimizer. + +## Attributes + + ### clip @@ -40,7 +128,7 @@ Returns the clip value for this optimizer. The clip value. - + ### trials @@ -53,3 +141,4 @@ Returns the number of trials for this optimizer. **Returns** The number of trials. + 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 9e58409a377..3a5a2cd46a1 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationAlgorithm.md @@ -1,8 +1,16 @@ -# OptimizationAlgorithm +--- +title: OptimizationAlgorithm +description: API reference for qiskit.optimization.algorithms.OptimizationAlgorithm +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.OptimizationAlgorithm +--- +# OptimizationAlgorithm + -`OptimizationAlgorithm` +`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` @@ -10,8 +18,69 @@ An abstract class for optimization algorithms in Qiskit’s optimization module. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.OptimizationAlgorithm.get_compatibility_msg#qiskit.optimization.algorithms.OptimizationAlgorithm.get_compatibility_msg "qiskit.optimization.algorithms.OptimizationAlgorithm.get_compatibility_msg") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`is_compatible`](qiskit.optimization.algorithms.OptimizationAlgorithm.is_compatible#qiskit.optimization.algorithms.OptimizationAlgorithm.is_compatible "qiskit.optimization.algorithms.OptimizationAlgorithm.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`solve`](qiskit.optimization.algorithms.OptimizationAlgorithm.solve#qiskit.optimization.algorithms.OptimizationAlgorithm.solve "qiskit.optimization.algorithms.OptimizationAlgorithm.solve") | Tries to solves the given problem using the optimizer. | +### get\_compatibility\_msg + + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** + +Returns the incompatibility message. If the message is empty no issues were found. + +### is\_compatible + + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### solve + + + +`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. + +Runs the optimizer to try to solve the optimization problem. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is incompatible with 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 13755c3493e..3f3f4d9db4f 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResult.md @@ -1,8 +1,16 @@ -# OptimizationResult +--- +title: OptimizationResult +description: API reference for qiskit.optimization.algorithms.OptimizationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.OptimizationResult +--- +# OptimizationResult + -`OptimizationResult(x, fval, variables, status, raw_results=None, samples=None)` +`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` @@ -55,11 +63,11 @@ The optimization algorithms return an object of the type `OptimizationResult` wi **Raises** -[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError#qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if sizes of `x` and `variables` do not match. +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if sizes of `x` and `variables` do not match. ## Attributes - + ### fval @@ -73,7 +81,7 @@ Returns the optimal function value. The function value corresponding to the optimal value found in the optimization. - + ### raw\_results @@ -89,7 +97,7 @@ Currently a dump for any leftovers. Additional result information of the optimization algorithm. - + ### samples @@ -103,7 +111,7 @@ Returns the list of solution samples The list of solution samples. - + ### status @@ -117,7 +125,7 @@ Returns the termination status of the optimization algorithm. The termination status of the algorithm. - + ### variable\_names @@ -131,7 +139,7 @@ Returns the list of variable names of the optimization problem. The list of variable names of the optimization problem. - + ### variables @@ -145,7 +153,7 @@ Returns the list of variables of the optimization problem. The list of variables. - + ### variables\_dict @@ -159,7 +167,7 @@ Returns the optimal value as a dictionary of the variable name and corresponding The optimal value as a dictionary of the variable name and corresponding value. - + ### x @@ -172,3 +180,4 @@ Returns the optimal value found in the optimization or None in case of FAILURE. **Returns** The optimal value found in the optimization. + 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 82ccd1e9c51..8bf9832d57f 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.OptimizationResultStatus.md @@ -1,8 +1,16 @@ -# OptimizationResultStatus +--- +title: OptimizationResultStatus +description: API reference for qiskit.optimization.algorithms.OptimizationResultStatus +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.OptimizationResultStatus +--- +# OptimizationResultStatus + -`OptimizationResultStatus(value)` +`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` @@ -10,7 +18,7 @@ Termination status of an optimization algorithm. ## Attributes - + ### FAILURE @@ -18,7 +26,7 @@ Termination status of an optimization algorithm. the optimization algorithm ended in a failure. - + ### INFEASIBLE @@ -26,10 +34,11 @@ the optimization algorithm ended in a failure. the optimization algorithm obtained an infeasible solution. - + ### SUCCESS `= 0` the optimization algorithm succeeded to find an optimal solution. + 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 3fce67e2612..24c7b4a162f 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult.md @@ -1,8 +1,16 @@ -# RecursiveMinimumEigenOptimizationResult +--- +title: RecursiveMinimumEigenOptimizationResult +description: API reference for qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult +--- +# RecursiveMinimumEigenOptimizationResult + -`RecursiveMinimumEigenOptimizationResult(x, fval, variables, status, replacements, history)` +`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` @@ -17,11 +25,11 @@ Constructs an instance of the result class. * **variables** (`List`\[`Variable`]) – the list of variables of the optimization problem. * **status** (`OptimizationResultStatus`) – the termination status of the optimization algorithm. * **replacements** (`Dict`\[`str`, `Tuple`\[`str`, `int`]]) – a dictionary of substituted variables. Key is a variable being substituted, value is a tuple of substituting variable and a weight, either 1 or -1. -* **history** (`Tuple`\[`List`\[`MinimumEigenOptimizationResult`], `OptimizationResult`]) – a tuple containing intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer#qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. +* **history** (`Tuple`\[`List`\[`MinimumEigenOptimizationResult`], `OptimizationResult`]) – a tuple containing intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. ## Attributes - + ### fval @@ -35,17 +43,17 @@ Returns the optimal function value. The function value corresponding to the optimal value found in the optimization. - + ### history -Returns intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer#qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. +Returns intermediate results. The first element is a list of `MinimumEigenOptimizerResult` obtained by invoking [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") iteratively, the second element is an instance of `OptimizationResult` obtained at the last step via min\_num\_vars\_optimizer. **Return type** `Tuple`\[`List`\[`MinimumEigenOptimizationResult`], `OptimizationResult`] - + ### raw\_results @@ -61,7 +69,7 @@ Currently a dump for any leftovers. Additional result information of the optimization algorithm. - + ### replacements @@ -71,7 +79,7 @@ Returns a dictionary of substituted variables. Key is a variable being substitut `Dict`\[`str`, `Tuple`\[`str`, `int`]] - + ### samples @@ -85,7 +93,7 @@ Returns the list of solution samples The list of solution samples. - + ### status @@ -99,7 +107,7 @@ Returns the termination status of the optimization algorithm. The termination status of the algorithm. - + ### variable\_names @@ -113,7 +121,7 @@ Returns the list of variable names of the optimization problem. The list of variable names of the optimization problem. - + ### variables @@ -127,7 +135,7 @@ Returns the list of variables of the optimization problem. The list of variables. - + ### variables\_dict @@ -141,7 +149,7 @@ Returns the optimal value as a dictionary of the variable name and corresponding The optimal value as a dictionary of the variable name and corresponding value. - + ### x @@ -154,3 +162,4 @@ Returns the optimal value found in the optimization or None in case of FAILURE. **Returns** The optimal value found in the optimization. + 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 bfe8179272b..c7b36ce3753 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.md @@ -1,14 +1,22 @@ -# RecursiveMinimumEigenOptimizer +--- +title: RecursiveMinimumEigenOptimizer +description: API reference for qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer +--- +# RecursiveMinimumEigenOptimizer + -`RecursiveMinimumEigenOptimizer(min_eigen_optimizer, min_num_vars=1, min_num_vars_optimizer=None, penalty=None, history=, converters=None)` +`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` A meta-algorithm that applies a recursive optimization. -The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer#qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. +The recursive minimum eigen optimizer applies a recursive optimization on top of [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer"). The algorithm is introduced in \[1]. ## Examples @@ -42,18 +50,82 @@ This initializer takes a `MinimumEigenOptimizer`, the parameters to specify unti * **min\_num\_vars** (`int`) – The minimum number of variables to apply the recursive scheme. If this threshold is reached, the min\_num\_vars\_optimizer is used. * **min\_num\_vars\_optimizer** (`Optional`\[`OptimizationAlgorithm`]) – This optimizer is used after the recursive scheme for the problem with the remaining variables. * **penalty** (`Optional`\[`float`]) – The factor that is used to scale the penalty terms corresponding to linear equality constraints. -* **history** (`Optional`\[`IntermediateResult`]) – Whether the intermediate results are stored. Default value is [`LAST_ITERATION`](qiskit.optimization.algorithms.IntermediateResult#qiskit.optimization.algorithms.IntermediateResult.LAST_ITERATION "qiskit.optimization.algorithms.IntermediateResult.LAST_ITERATION"). -* **converters** (`Union`\[`QuadraticProgramConverter`, `List`\[`QuadraticProgramConverter`], `None`]) – The converters to use for converting a problem into a different form. By default, when None is specified, an internally created instance of [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo#qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") will be used. +* **history** (`Optional`\[`IntermediateResult`]) – Whether the intermediate results are stored. Default value is [`LAST_ITERATION`](qiskit.optimization.algorithms.IntermediateResult#last_iteration "qiskit.optimization.algorithms.IntermediateResult.LAST_ITERATION"). +* **converters** (`Union`\[`QuadraticProgramConverter`, `List`\[`QuadraticProgramConverter`], `None`]) – The converters to use for converting a problem into a different form. By default, when None is specified, an internally created instance of [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") will be used. **Raises** -* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError#qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – In case of invalid parameters (num\_min\_vars \< 1). +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – In case of invalid parameters (num\_min\_vars \< 1). * **TypeError** – When there one of converters is an invalid type. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with this optimizer. | -| [`is_compatible`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.is_compatible#qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.is_compatible "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`solve`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.solve#qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.solve "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer.solve") | Tries to solve the given problem using the recursive optimizer. | +### get\_compatibility\_msg + + + +`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. + +Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** + +A message describing the incompatibility. + +### is\_compatible + + + +`RecursiveMinimumEigenOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### solve + + + +`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. + +Runs the optimizer to try to solve the optimization problem. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – Incompatible problem. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – Infeasible due to variable substitution + 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 bfd61a33c10..34ca60acc3c 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizationResult.md @@ -1,8 +1,16 @@ -# SlsqpOptimizationResult +--- +title: SlsqpOptimizationResult +description: API reference for qiskit.optimization.algorithms.SlsqpOptimizationResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.SlsqpOptimizationResult +--- +# SlsqpOptimizationResult + -`SlsqpOptimizationResult(x, fval, variables, status, fx=None, its=None, imode=None, smode=None)` +`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` @@ -23,7 +31,7 @@ Constructs a result object with properties specific to SLSQP. ## Attributes - + ### fval @@ -37,7 +45,7 @@ Returns the optimal function value. The function value corresponding to the optimal value found in the optimization. - + ### fx @@ -47,7 +55,7 @@ Returns the final value of the objective function being actually optimized. `Optional`\[`ndarray`] - + ### imode @@ -57,7 +65,7 @@ Returns the exit mode from the optimizer. `Optional`\[`int`] - + ### its @@ -67,7 +75,7 @@ Returns the number of iterations `Optional`\[`int`] - + ### raw\_results @@ -83,7 +91,7 @@ Currently a dump for any leftovers. Additional result information of the optimization algorithm. - + ### samples @@ -97,7 +105,7 @@ Returns the list of solution samples The list of solution samples. - + ### smode @@ -107,7 +115,7 @@ Returns message describing the exit mode from the optimizer. `Optional`\[`str`] - + ### status @@ -121,7 +129,7 @@ Returns the termination status of the optimization algorithm. The termination status of the algorithm. - + ### variable\_names @@ -135,7 +143,7 @@ Returns the list of variable names of the optimization problem. The list of variable names of the optimization problem. - + ### variables @@ -149,7 +157,7 @@ Returns the list of variables of the optimization problem. The list of variables. - + ### variables\_dict @@ -163,7 +171,7 @@ Returns the optimal value as a dictionary of the variable name and corresponding The optimal value as a dictionary of the variable name and corresponding value. - + ### x @@ -176,3 +184,4 @@ Returns the optimal value found in the optimization or None in case of FAILURE. **Returns** The optimal value found in the optimization. + 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 ec9dcada381..0f9f9b61ecd 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SlsqpOptimizer.md @@ -1,12 +1,20 @@ -# SlsqpOptimizer +--- +title: SlsqpOptimizer +description: API reference for qiskit.optimization.algorithms.SlsqpOptimizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.SlsqpOptimizer +--- +# SlsqpOptimizer + -`SlsqpOptimizer(iter=100, acc=1e-06, iprint=0, trials=1, clip=100.0, full_output=False)` +`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` -The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm#qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). +The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). This class provides a wrapper for `scipy.optimize.fmin_slsqp` ([https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin\_slsqp.html](https://docs.scipy.org/doc/scipy-0.13.0/reference/generated/scipy.optimize.fmin_slsqp.html)) to be used within the optimization module. The arguments for `fmin_slsqp` are passed via the constructor. @@ -26,7 +34,7 @@ This class provides a wrapper for `scipy.optimize.fmin_slsqp` ([https://docs.sci Initializes the SlsqpOptimizer. -This initializer takes the algorithmic parameters of SLSQP and stores them for later use of `fmin_slsqp` when [`solve()`](qiskit.optimization.algorithms.SlsqpOptimizer.solve#qiskit.optimization.algorithms.SlsqpOptimizer.solve "qiskit.optimization.algorithms.SlsqpOptimizer.solve") is invoked. This optimizer can be applied to find a (local) optimum for problems consisting of only continuous variables. +This initializer takes the algorithmic parameters of SLSQP and stores them for later use of `fmin_slsqp` when [`solve()`](qiskit.optimization.algorithms.SlsqpOptimizer#solve "qiskit.optimization.algorithms.SlsqpOptimizer.solve") is invoked. This optimizer can be applied to find a (local) optimum for problems consisting of only continuous variables. **Parameters** @@ -50,16 +58,98 @@ This initializer takes the algorithmic parameters of SLSQP and stores them for l ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`get_compatibility_msg`](qiskit.optimization.algorithms.SlsqpOptimizer.get_compatibility_msg#qiskit.optimization.algorithms.SlsqpOptimizer.get_compatibility_msg "qiskit.optimization.algorithms.SlsqpOptimizer.get_compatibility_msg") | Checks whether a given problem can be solved with this optimizer. | -| [`is_compatible`](qiskit.optimization.algorithms.SlsqpOptimizer.is_compatible#qiskit.optimization.algorithms.SlsqpOptimizer.is_compatible "qiskit.optimization.algorithms.SlsqpOptimizer.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | -| [`multi_start_solve`](qiskit.optimization.algorithms.SlsqpOptimizer.multi_start_solve#qiskit.optimization.algorithms.SlsqpOptimizer.multi_start_solve "qiskit.optimization.algorithms.SlsqpOptimizer.multi_start_solve") | Applies a multi start method given a local optimizer. | -| [`solve`](qiskit.optimization.algorithms.SlsqpOptimizer.solve#qiskit.optimization.algorithms.SlsqpOptimizer.solve "qiskit.optimization.algorithms.SlsqpOptimizer.solve") | Tries to solves the given problem using the optimizer. | +### get\_compatibility\_msg -## Attributes + + +`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. + +Checks whether the given problem is compatible, i.e., whether the problem contains only continuous variables, and otherwise, returns a message explaining the incompatibility. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** + +Returns a string describing the incompatibility. + +### is\_compatible + + + +`SlsqpOptimizer.is_compatible(problem)` + +Checks whether a given problem can be solved with the optimizer implementing this method. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +### multi\_start\_solve + + +`SlsqpOptimizer.multi_start_solve(minimize, problem)` +Applies a multi start method given a local optimizer. + +**Parameters** + +* **minimize** (`Callable`\[\[`ndarray`], `Tuple`\[`ndarray`, `Any`]]) – A callable object that minimizes the problem specified +* **problem** (`QuadraticProgram`) – A problem to solve + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the multi start algorithm applied to the problem. + +### solve + + + +`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. + +Runs the optimizer to try to solve the optimization problem. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved. + +**Return type** + +`OptimizationResult` + +**Returns** + +The result of the optimizer applied to the problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the problem is incompatible with the optimizer. + +## Attributes + + ### clip @@ -73,7 +163,7 @@ Returns the clip value for this optimizer. The clip value. - + ### trials @@ -86,3 +176,4 @@ Returns the number of trials for this optimizer. **Returns** The number of trials. + 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 eb794ac34fd..b4da60e7fe8 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.SolutionSample.md @@ -1,33 +1,42 @@ -# SolutionSample +--- +title: SolutionSample +description: API reference for qiskit.optimization.algorithms.SolutionSample +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.algorithms.SolutionSample +--- +# SolutionSample + -`SolutionSample(x, fval, probability, status)` +`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` A sample of an optimization solution - + ### x the values of variables - + ### fval the objective function value - + ### probability the probability of this sample - + ### status the status of this sample + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.md b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.md index 824c6be0343..99985c8c4cc 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.algorithms.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.algorithms.md @@ -20,31 +20,31 @@ Algorithms for optimization problems. # Base classes for algorithms and results -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm#qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm") | An abstract class for optimization algorithms in Qiskit’s optimization module. | -| [`MultiStartOptimizer`](qiskit.optimization.algorithms.MultiStartOptimizer#qiskit.optimization.algorithms.MultiStartOptimizer "qiskit.optimization.algorithms.MultiStartOptimizer") | An abstract class that implements multi start optimization and should be sub-classed by other optimizers. | -| [`OptimizationResult`](qiskit.optimization.algorithms.OptimizationResult#qiskit.optimization.algorithms.OptimizationResult "qiskit.optimization.algorithms.OptimizationResult") | A base class for optimization results. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm") | An abstract class for optimization algorithms in Qiskit’s optimization module. | +| [`MultiStartOptimizer`](qiskit.optimization.algorithms.MultiStartOptimizer "qiskit.optimization.algorithms.MultiStartOptimizer") | An abstract class that implements multi start optimization and should be sub-classed by other optimizers. | +| [`OptimizationResult`](qiskit.optimization.algorithms.OptimizationResult "qiskit.optimization.algorithms.OptimizationResult") | A base class for optimization results. | # Algorithms and results -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`ADMMOptimizationResult`](qiskit.optimization.algorithms.ADMMOptimizationResult#qiskit.optimization.algorithms.ADMMOptimizationResult "qiskit.optimization.algorithms.ADMMOptimizationResult") | ADMMOptimization Result. | -| [`ADMMOptimizer`](qiskit.optimization.algorithms.ADMMOptimizer#qiskit.optimization.algorithms.ADMMOptimizer "qiskit.optimization.algorithms.ADMMOptimizer") | An implementation of the ADMM-based heuristic. | -| [`ADMMParameters`](qiskit.optimization.algorithms.ADMMParameters#qiskit.optimization.algorithms.ADMMParameters "qiskit.optimization.algorithms.ADMMParameters") | Defines a set of parameters for ADMM optimizer. | -| [`ADMMState`](qiskit.optimization.algorithms.ADMMState#qiskit.optimization.algorithms.ADMMState "qiskit.optimization.algorithms.ADMMState") | Internal computation state of the ADMM implementation. | -| [`CobylaOptimizer`](qiskit.optimization.algorithms.CobylaOptimizer#qiskit.optimization.algorithms.CobylaOptimizer "qiskit.optimization.algorithms.CobylaOptimizer") | The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm#qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). | -| [`CplexOptimizer`](qiskit.optimization.algorithms.CplexOptimizer#qiskit.optimization.algorithms.CplexOptimizer "qiskit.optimization.algorithms.CplexOptimizer") | The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm#qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). | -| [`GroverOptimizationResult`](qiskit.optimization.algorithms.GroverOptimizationResult#qiskit.optimization.algorithms.GroverOptimizationResult "qiskit.optimization.algorithms.GroverOptimizationResult") | A result object for Grover Optimization methods. | -| [`GroverOptimizer`](qiskit.optimization.algorithms.GroverOptimizer#qiskit.optimization.algorithms.GroverOptimizer "qiskit.optimization.algorithms.GroverOptimizer") | Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. | -| [`IntermediateResult`](qiskit.optimization.algorithms.IntermediateResult#qiskit.optimization.algorithms.IntermediateResult "qiskit.optimization.algorithms.IntermediateResult") | Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer#qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. | -| [`MinimumEigenOptimizationResult`](qiskit.optimization.algorithms.MinimumEigenOptimizationResult#qiskit.optimization.algorithms.MinimumEigenOptimizationResult "qiskit.optimization.algorithms.MinimumEigenOptimizationResult") | Minimum Eigen Optimizer Result. | -| [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer#qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") | A wrapper for minimum eigen solvers from Qiskit Aqua. | -| [`OptimizationResultStatus`](qiskit.optimization.algorithms.OptimizationResultStatus#qiskit.optimization.algorithms.OptimizationResultStatus "qiskit.optimization.algorithms.OptimizationResultStatus") | Termination status of an optimization algorithm. | -| [`RecursiveMinimumEigenOptimizationResult`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult#qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult") | Recursive Eigen Optimizer Result. | -| [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer#qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") | A meta-algorithm that applies a recursive optimization. | -| [`SlsqpOptimizationResult`](qiskit.optimization.algorithms.SlsqpOptimizationResult#qiskit.optimization.algorithms.SlsqpOptimizationResult "qiskit.optimization.algorithms.SlsqpOptimizationResult") | SLSQP optimization result, defines additional properties that may be returned by the optimizer. | -| [`SlsqpOptimizer`](qiskit.optimization.algorithms.SlsqpOptimizer#qiskit.optimization.algorithms.SlsqpOptimizer "qiskit.optimization.algorithms.SlsqpOptimizer") | The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm#qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). | -| [`SolutionSample`](qiskit.optimization.algorithms.SolutionSample#qiskit.optimization.algorithms.SolutionSample "qiskit.optimization.algorithms.SolutionSample") | A sample of an optimization solution | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`ADMMOptimizationResult`](qiskit.optimization.algorithms.ADMMOptimizationResult "qiskit.optimization.algorithms.ADMMOptimizationResult") | ADMMOptimization Result. | +| [`ADMMOptimizer`](qiskit.optimization.algorithms.ADMMOptimizer "qiskit.optimization.algorithms.ADMMOptimizer") | An implementation of the ADMM-based heuristic. | +| [`ADMMParameters`](qiskit.optimization.algorithms.ADMMParameters "qiskit.optimization.algorithms.ADMMParameters") | Defines a set of parameters for ADMM optimizer. | +| [`ADMMState`](qiskit.optimization.algorithms.ADMMState "qiskit.optimization.algorithms.ADMMState") | Internal computation state of the ADMM implementation. | +| [`CobylaOptimizer`](qiskit.optimization.algorithms.CobylaOptimizer "qiskit.optimization.algorithms.CobylaOptimizer") | The SciPy COBYLA optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). | +| [`CplexOptimizer`](qiskit.optimization.algorithms.CplexOptimizer "qiskit.optimization.algorithms.CplexOptimizer") | The CPLEX optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). | +| [`GroverOptimizationResult`](qiskit.optimization.algorithms.GroverOptimizationResult "qiskit.optimization.algorithms.GroverOptimizationResult") | A result object for Grover Optimization methods. | +| [`GroverOptimizer`](qiskit.optimization.algorithms.GroverOptimizer "qiskit.optimization.algorithms.GroverOptimizer") | Uses Grover Adaptive Search (GAS) to find the minimum of a QUBO function. | +| [`IntermediateResult`](qiskit.optimization.algorithms.IntermediateResult "qiskit.optimization.algorithms.IntermediateResult") | Defines whether the intermediate results of [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") at each iteration should be stored and returned to the end user. | +| [`MinimumEigenOptimizationResult`](qiskit.optimization.algorithms.MinimumEigenOptimizationResult "qiskit.optimization.algorithms.MinimumEigenOptimizationResult") | Minimum Eigen Optimizer Result. | +| [`MinimumEigenOptimizer`](qiskit.optimization.algorithms.MinimumEigenOptimizer "qiskit.optimization.algorithms.MinimumEigenOptimizer") | A wrapper for minimum eigen solvers from Qiskit Aqua. | +| [`OptimizationResultStatus`](qiskit.optimization.algorithms.OptimizationResultStatus "qiskit.optimization.algorithms.OptimizationResultStatus") | Termination status of an optimization algorithm. | +| [`RecursiveMinimumEigenOptimizationResult`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizationResult") | Recursive Eigen Optimizer Result. | +| [`RecursiveMinimumEigenOptimizer`](qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer "qiskit.optimization.algorithms.RecursiveMinimumEigenOptimizer") | A meta-algorithm that applies a recursive optimization. | +| [`SlsqpOptimizationResult`](qiskit.optimization.algorithms.SlsqpOptimizationResult "qiskit.optimization.algorithms.SlsqpOptimizationResult") | SLSQP optimization result, defines additional properties that may be returned by the optimizer. | +| [`SlsqpOptimizer`](qiskit.optimization.algorithms.SlsqpOptimizer "qiskit.optimization.algorithms.SlsqpOptimizer") | The SciPy SLSQP optimizer wrapped as an Qiskit [`OptimizationAlgorithm`](qiskit.optimization.algorithms.OptimizationAlgorithm "qiskit.optimization.algorithms.OptimizationAlgorithm"). | +| [`SolutionSample`](qiskit.optimization.algorithms.SolutionSample "qiskit.optimization.algorithms.SolutionSample") | A sample of an optimization solution | 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 b72365db6ee..b1679debd8c 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.InequalityToEquality.md @@ -1,8 +1,16 @@ -# InequalityToEquality +--- +title: InequalityToEquality +description: API reference for qiskit.optimization.converters.InequalityToEquality +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.converters.InequalityToEquality +--- +# InequalityToEquality + -`InequalityToEquality(mode='auto')` +`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` @@ -35,14 +43,55 @@ To chose the type of slack variables. There are 3 options for mode. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| [`convert`](qiskit.optimization.converters.InequalityToEquality.convert#qiskit.optimization.converters.InequalityToEquality.convert "qiskit.optimization.converters.InequalityToEquality.convert") | Convert a problem with inequality constraints into one with only equality constraints. | -| [`interpret`](qiskit.optimization.converters.InequalityToEquality.interpret#qiskit.optimization.converters.InequalityToEquality.interpret "qiskit.optimization.converters.InequalityToEquality.interpret") | Convert a result of a converted problem into that of the original problem. | +### convert -## Attributes + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved, that may contain inequality constraints. + +**Return type** + +`QuadraticProgram` + +**Returns** + +The converted problem, that contain only equality constraints. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If a variable type is not supported. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If an unsupported mode is selected. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If an unsupported sense is specified. +### interpret + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`\[`float`]]) – The result of the converted problem or the given result in case of FAILURE. + +**Return type** + +`ndarray` + +**Returns** + +The result of the original problem. + +## Attributes + + ### mode @@ -55,3 +104,4 @@ Returns the mode of the converter **Returns** The mode of the converter used for additional slack variables + 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 3e1528ea39e..e51dfc24ad4 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.IntegerToBinary.md @@ -1,12 +1,20 @@ -# IntegerToBinary +--- +title: IntegerToBinary +description: API reference for qiskit.optimization.converters.IntegerToBinary +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.converters.IntegerToBinary +--- +# IntegerToBinary + -`IntegerToBinary` +`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` -Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram#qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. +Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. This bounded-coefficient encoding used in this converted is proposed in \[1], Eq. (5). @@ -29,7 +37,47 @@ Annealers. arxiv.org:1706.01945. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -| [`convert`](qiskit.optimization.converters.IntegerToBinary.convert#qiskit.optimization.converters.IntegerToBinary.convert "qiskit.optimization.converters.IntegerToBinary.convert") | Convert an integer problem into a new problem with binary variables. | -| [`interpret`](qiskit.optimization.converters.IntegerToBinary.interpret#qiskit.optimization.converters.IntegerToBinary.interpret "qiskit.optimization.converters.IntegerToBinary.interpret") | Convert back the converted problem (binary variables) to the original (integer variables). | +### convert + + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved, that may contain integer variables. + +**Return type** + +`QuadraticProgram` + +**Returns** + +The converted problem, that contains no integer variables. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if variable or constraint type is not supported. + +### interpret + + + +`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). + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`\[`float`]]) – The result of the converted problem or the given result in case of FAILURE. + +**Return type** + +`ndarray` + +**Returns** + +The result of the original problem. + 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 d7e28ed19e1..b71a8baad93 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.LinearEqualityToPenalty.md @@ -1,8 +1,16 @@ -# LinearEqualityToPenalty +--- +title: LinearEqualityToPenalty +description: API reference for qiskit.optimization.converters.LinearEqualityToPenalty +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.converters.LinearEqualityToPenalty +--- +# LinearEqualityToPenalty + -`LinearEqualityToPenalty(penalty=None)` +`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` @@ -14,14 +22,57 @@ Convert a problem with only equality constraints to unconstrained with penalty t ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| [`convert`](qiskit.optimization.converters.LinearEqualityToPenalty.convert#qiskit.optimization.converters.LinearEqualityToPenalty.convert "qiskit.optimization.converters.LinearEqualityToPenalty.convert") | Convert a problem with equality constraints into an unconstrained problem. | -| [`interpret`](qiskit.optimization.converters.LinearEqualityToPenalty.interpret#qiskit.optimization.converters.LinearEqualityToPenalty.interpret "qiskit.optimization.converters.LinearEqualityToPenalty.interpret") | Convert the result of the converted problem back to that of the original problem | +### convert -## Attributes + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem to be solved, that does not contain inequality constraints. + +**Return type** + +`QuadraticProgram` + +**Returns** + +The converted problem, that is an unconstrained problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If an inequality constraint exists. + +### interpret + +`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 + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`\[`float`]]) – The result of the converted problem or the given result in case of FAILURE. + +**Return type** + +`ndarray` + +**Returns** + +The result of the original problem. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the number of variables in the result differs from that of the original problem. + +## Attributes + + ### penalty @@ -34,3 +85,4 @@ Returns the penalty factor used in conversion. **Returns** The penalty factor used in conversion. + 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 561cc379189..7eda37a7c99 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramConverter.md @@ -1,8 +1,16 @@ -# QuadraticProgramConverter +--- +title: QuadraticProgramConverter +description: API reference for qiskit.optimization.converters.QuadraticProgramConverter +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.converters.QuadraticProgramConverter +--- +# QuadraticProgramConverter + -`QuadraticProgramConverter` +`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` @@ -10,7 +18,27 @@ An abstract class for converters of quadratic programs in Qiskit’s optimizatio ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| [`convert`](qiskit.optimization.converters.QuadraticProgramConverter.convert#qiskit.optimization.converters.QuadraticProgramConverter.convert "qiskit.optimization.converters.QuadraticProgramConverter.convert") | Convert a QuadraticProgram into another form and keep the information required to interpret the result. | -| [`interpret`](qiskit.optimization.converters.QuadraticProgramConverter.interpret#qiskit.optimization.converters.QuadraticProgramConverter.interpret "qiskit.optimization.converters.QuadraticProgramConverter.interpret") | Interpret a result into another form using the information of conversion | +### convert + + + +`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. + +**Return type** + +`QuadraticProgram` + +### interpret + + + +`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 + +**Return type** + +`ndarray` + 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 27a58d0b50b..817e1dfa7f9 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.QuadraticProgramToQubo.md @@ -1,8 +1,16 @@ -# QuadraticProgramToQubo +--- +title: QuadraticProgramToQubo +description: API reference for qiskit.optimization.converters.QuadraticProgramToQubo +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.converters.QuadraticProgramToQubo +--- +# QuadraticProgramToQubo + -`QuadraticProgramToQubo(penalty=None)` +`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` @@ -25,16 +33,95 @@ Convert a given optimization problem to a new problem that is a QUBO. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| [`convert`](qiskit.optimization.converters.QuadraticProgramToQubo.convert#qiskit.optimization.converters.QuadraticProgramToQubo.convert "qiskit.optimization.converters.QuadraticProgramToQubo.convert") | Convert a problem with linear equality constraints into new one with a QUBO form. | -| [`get_compatibility_msg`](qiskit.optimization.converters.QuadraticProgramToQubo.get_compatibility_msg#qiskit.optimization.converters.QuadraticProgramToQubo.get_compatibility_msg "qiskit.optimization.converters.QuadraticProgramToQubo.get_compatibility_msg") | Checks whether a given problem can be solved with this optimizer. | -| [`interpret`](qiskit.optimization.converters.QuadraticProgramToQubo.interpret#qiskit.optimization.converters.QuadraticProgramToQubo.interpret "qiskit.optimization.converters.QuadraticProgramToQubo.interpret") | Convert a result of a converted problem into that of the original problem. | -| [`is_compatible`](qiskit.optimization.converters.QuadraticProgramToQubo.is_compatible#qiskit.optimization.converters.QuadraticProgramToQubo.is_compatible "qiskit.optimization.converters.QuadraticProgramToQubo.is_compatible") | Checks whether a given problem can be solved with the optimizer implementing this method. | +### convert -## Attributes + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The problem with linear equality constraints to be solved. + +**Return type** + +`QuadraticProgram` + +**Returns** + +The problem converted in QUBO format. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – In case of an incompatible problem. + +### get\_compatibility\_msg + + + +`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. + +Checks whether the given problem is compatible, i.e., whether the problem can be converted to a QUBO, and otherwise, returns a message explaining the incompatibility. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`str` + +**Returns** +A message describing the incompatibility. +### interpret + + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`\[`float`]]) – The result of the converted problem. + +**Return type** + +`ndarray` + +**Returns** + +The result of the original problem. + +### is\_compatible + + + +`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. + +**Parameters** + +**problem** (`QuadraticProgram`) – The optimization problem to check compatibility. + +**Return type** + +`bool` + +**Returns** + +Returns True if the problem is compatible, False otherwise. + +## Attributes + + ### penalty @@ -47,3 +134,4 @@ Returns the penalty factor used in conversion. **Returns** The penalty factor used in conversion. + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.converters.md b/docs/api/qiskit/0.32/qiskit.optimization.converters.md index a8ba5f1eb40..8939c167379 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.converters.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.converters.md @@ -16,20 +16,20 @@ python_api_name: qiskit.optimization.converters `qiskit.optimization.converters` -This is a set of converters having convert functionality to go between different representations of a given [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram#qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") and to interpret a given result for the problem, based on the original problem before conversion, to return an appropriate [`OptimizationResult`](qiskit.optimization.algorithms.OptimizationResult#qiskit.optimization.algorithms.OptimizationResult "qiskit.optimization.algorithms.OptimizationResult"). +This is a set of converters having convert functionality to go between different representations of a given [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") and to interpret a given result for the problem, based on the original problem before conversion, to return an appropriate [`OptimizationResult`](qiskit.optimization.algorithms.OptimizationResult "qiskit.optimization.algorithms.OptimizationResult"). # Base class for converters -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| [`QuadraticProgramConverter`](qiskit.optimization.converters.QuadraticProgramConverter#qiskit.optimization.converters.QuadraticProgramConverter "qiskit.optimization.converters.QuadraticProgramConverter") | An abstract class for converters of quadratic programs in Qiskit’s optimization module. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| [`QuadraticProgramConverter`](qiskit.optimization.converters.QuadraticProgramConverter "qiskit.optimization.converters.QuadraticProgramConverter") | An abstract class for converters of quadratic programs in Qiskit’s optimization module. | # Converters -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`InequalityToEquality`](qiskit.optimization.converters.InequalityToEquality#qiskit.optimization.converters.InequalityToEquality "qiskit.optimization.converters.InequalityToEquality") | Convert inequality constraints into equality constraints by introducing slack variables. | -| [`IntegerToBinary`](qiskit.optimization.converters.IntegerToBinary#qiskit.optimization.converters.IntegerToBinary "qiskit.optimization.converters.IntegerToBinary") | Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram#qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. | -| [`LinearEqualityToPenalty`](qiskit.optimization.converters.LinearEqualityToPenalty#qiskit.optimization.converters.LinearEqualityToPenalty "qiskit.optimization.converters.LinearEqualityToPenalty") | Convert a problem with only equality constraints to unconstrained with penalty terms. | -| [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo#qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") | Convert a given optimization problem to a new problem that is a QUBO. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`InequalityToEquality`](qiskit.optimization.converters.InequalityToEquality "qiskit.optimization.converters.InequalityToEquality") | Convert inequality constraints into equality constraints by introducing slack variables. | +| [`IntegerToBinary`](qiskit.optimization.converters.IntegerToBinary "qiskit.optimization.converters.IntegerToBinary") | Convert a [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") into new one by encoding integer with binary variables. | +| [`LinearEqualityToPenalty`](qiskit.optimization.converters.LinearEqualityToPenalty "qiskit.optimization.converters.LinearEqualityToPenalty") | Convert a problem with only equality constraints to unconstrained with penalty terms. | +| [`QuadraticProgramToQubo`](qiskit.optimization.converters.QuadraticProgramToQubo "qiskit.optimization.converters.QuadraticProgramToQubo") | Convert a given optimization problem to a new problem that is a QUBO. | 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 8fc97902505..6aaa1e61bcd 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.Constraint.md @@ -1,8 +1,16 @@ -# Constraint +--- +title: Constraint +description: API reference for qiskit.optimization.problems.Constraint +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.Constraint +--- +# Constraint + -`Constraint(quadratic_program, name, sense, rhs)` +`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` @@ -19,13 +27,29 @@ Initializes the constraint. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- | -| [`evaluate`](qiskit.optimization.problems.Constraint.evaluate#qiskit.optimization.problems.Constraint.evaluate "qiskit.optimization.problems.Constraint.evaluate") | Evaluate left-hand-side of constraint for given values of variables. | +### evaluate -## Attributes + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values to be used for the variables. + +**Return type** +`float` + +**Returns** + +The left-hand-side of the constraint. + +## Attributes + ### name @@ -39,7 +63,7 @@ Returns the name of the constraint. The name of the constraint. - + ### quadratic\_program @@ -53,7 +77,7 @@ Returns the parent QuadraticProgram. The parent QuadraticProgram. - + ### rhs @@ -67,7 +91,7 @@ Returns the right-hand-side of the constraint. The right-hand-side of the constraint. - + ### sense @@ -80,3 +104,4 @@ Returns the sense of the constraint. **Returns** The sense of the constraint. + 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 589276d6301..b1fa58edc45 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearConstraint.md @@ -1,8 +1,16 @@ -# LinearConstraint +--- +title: LinearConstraint +description: API reference for qiskit.optimization.problems.LinearConstraint +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.LinearConstraint +--- +# LinearConstraint + -`LinearConstraint(quadratic_program, name, linear, sense, rhs)` +`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` @@ -18,13 +26,29 @@ Representation of a linear constraint. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- | -| [`evaluate`](qiskit.optimization.problems.LinearConstraint.evaluate#qiskit.optimization.problems.LinearConstraint.evaluate "qiskit.optimization.problems.LinearConstraint.evaluate") | Evaluate the left-hand-side of the constraint. | +### evaluate -## Attributes + +`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. + +**Parameters** +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`float` + +**Returns** + +The left-hand-side of the constraint given the variable values. + +## Attributes + + ### linear @@ -38,7 +62,7 @@ Returns the linear expression corresponding to the left-hand-side of the constra The left-hand-side linear expression. - + ### name @@ -52,7 +76,7 @@ Returns the name of the constraint. The name of the constraint. - + ### quadratic\_program @@ -66,7 +90,7 @@ Returns the parent QuadraticProgram. The parent QuadraticProgram. - + ### rhs @@ -80,7 +104,7 @@ Returns the right-hand-side of the constraint. The right-hand-side of the constraint. - + ### sense @@ -93,3 +117,4 @@ Returns the sense of the constraint. **Returns** The sense 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 d1fb829ee9d..c4afeea8ae0 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.LinearExpression.md @@ -1,8 +1,16 @@ -# LinearExpression +--- +title: LinearExpression +description: API reference for qiskit.optimization.problems.LinearExpression +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.LinearExpression +--- +# LinearExpression + -`LinearExpression(quadratic_program, coefficients)` +`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` @@ -19,16 +27,85 @@ The linear expression can be defined via an array, a list, a sparse matrix, or a ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- | -| [`evaluate`](qiskit.optimization.problems.LinearExpression.evaluate#qiskit.optimization.problems.LinearExpression.evaluate "qiskit.optimization.problems.LinearExpression.evaluate") | Evaluate the linear expression for given variables. | -| [`evaluate_gradient`](qiskit.optimization.problems.LinearExpression.evaluate_gradient#qiskit.optimization.problems.LinearExpression.evaluate_gradient "qiskit.optimization.problems.LinearExpression.evaluate_gradient") | Evaluate the gradient of the linear expression for given variables. | -| [`to_array`](qiskit.optimization.problems.LinearExpression.to_array#qiskit.optimization.problems.LinearExpression.to_array "qiskit.optimization.problems.LinearExpression.to_array") | Returns the coefficients of the linear expression as array. | -| [`to_dict`](qiskit.optimization.problems.LinearExpression.to_dict#qiskit.optimization.problems.LinearExpression.to_dict "qiskit.optimization.problems.LinearExpression.to_dict") | Returns the coefficients of the linear expression as dictionary, either using variable names or indices as keys. | +### evaluate -## Attributes + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`float` + +**Returns** + +The value of the linear expression given the variable values. + +### evaluate\_gradient + + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`ndarray` + +**Returns** + +The value of the gradient of the linear expression given the variable values. +### to\_array + + +`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. + +**Return type** + +`ndarray` + +**Returns** + +An array with the coefficients corresponding to the linear expression. + +### to\_dict + + + +`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. + +**Parameters** + +**use\_name** (`bool`) – Determines whether to use index or names to refer to variables. + +**Return type** + +`Dict`\[`Union`\[`int`, `str`], `float`] + +**Returns** + +An dictionary with the coefficients corresponding to the linear expression. + +## Attributes + + ### coefficients @@ -42,7 +119,7 @@ Returns the coefficients of the linear expression. The coefficients of the linear expression. - + ### quadratic\_program @@ -55,3 +132,4 @@ Returns the parent QuadraticProgram. **Returns** The parent QuadraticProgram. + 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 7da37c5ea5a..880f9867257 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticConstraint.md @@ -1,8 +1,16 @@ -# QuadraticConstraint +--- +title: QuadraticConstraint +description: API reference for qiskit.optimization.problems.QuadraticConstraint +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.QuadraticConstraint +--- +# QuadraticConstraint + -`QuadraticConstraint(quadratic_program, name, linear, quadratic, sense, rhs)` +`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` @@ -21,13 +29,29 @@ Constructs a quadratic constraint, consisting of a linear and a quadratic term. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| [`evaluate`](qiskit.optimization.problems.QuadraticConstraint.evaluate#qiskit.optimization.problems.QuadraticConstraint.evaluate "qiskit.optimization.problems.QuadraticConstraint.evaluate") | Evaluate the left-hand-side of the constraint. | +### evaluate -## Attributes + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`float` + +**Returns** +The left-hand-side of the constraint given the variable values. +## Attributes + + ### linear @@ -41,7 +65,7 @@ Returns the linear expression corresponding to the left-hand-side of the constra The left-hand-side linear expression. - + ### name @@ -55,7 +79,7 @@ Returns the name of the constraint. The name of the constraint. - + ### quadratic @@ -69,7 +93,7 @@ Returns the quadratic expression corresponding to the left-hand-side of the cons The left-hand-side quadratic expression. - + ### quadratic\_program @@ -83,7 +107,7 @@ Returns the parent QuadraticProgram. The parent QuadraticProgram. - + ### rhs @@ -97,7 +121,7 @@ Returns the right-hand-side of the constraint. The right-hand-side of the constraint. - + ### sense @@ -110,3 +134,4 @@ Returns the sense of the constraint. **Returns** The sense 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 e84e1b507ac..9ec54d30e0e 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticExpression.md @@ -1,8 +1,16 @@ -# QuadraticExpression +--- +title: QuadraticExpression +description: API reference for qiskit.optimization.problems.QuadraticExpression +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.QuadraticExpression +--- +# QuadraticExpression + -`QuadraticExpression(quadratic_program, coefficients)` +`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` @@ -19,16 +27,90 @@ The quadratic expression can be defined via an array, a list, a sparse matrix, o ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| [`evaluate`](qiskit.optimization.problems.QuadraticExpression.evaluate#qiskit.optimization.problems.QuadraticExpression.evaluate "qiskit.optimization.problems.QuadraticExpression.evaluate") | Evaluate the quadratic expression for given variables: x \* Q \* x. | -| [`evaluate_gradient`](qiskit.optimization.problems.QuadraticExpression.evaluate_gradient#qiskit.optimization.problems.QuadraticExpression.evaluate_gradient "qiskit.optimization.problems.QuadraticExpression.evaluate_gradient") | Evaluate the gradient of the quadratic expression for given variables. | -| [`to_array`](qiskit.optimization.problems.QuadraticExpression.to_array#qiskit.optimization.problems.QuadraticExpression.to_array "qiskit.optimization.problems.QuadraticExpression.to_array") | Returns the coefficients of the quadratic expression as array. | -| [`to_dict`](qiskit.optimization.problems.QuadraticExpression.to_dict#qiskit.optimization.problems.QuadraticExpression.to_dict "qiskit.optimization.problems.QuadraticExpression.to_dict") | Returns the coefficients of the quadratic expression as dictionary, either using tuples of variable names or indices as keys. | +### evaluate -## Attributes + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`float` + +**Returns** + +The value of the quadratic expression given the variable values. + +### evaluate\_gradient + + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`ndarray` + +**Returns** + +The value of the gradient quadratic expression given the variable values. + +### to\_array + +`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. + +**Parameters** + +**symmetric** (`bool`) – Determines whether the output is in a symmetric form or not. + +**Return type** + +`ndarray` + +**Returns** + +An array with the coefficients corresponding to the quadratic expression. + +### to\_dict + + + +`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. + +**Parameters** + +* **symmetric** (`bool`) – Determines whether the output is in a symmetric form or not. +* **use\_name** (`bool`) – Determines whether to use index or names to refer to variables. + +**Return type** + +`Dict`\[`Union`\[`Tuple`\[`int`, `int`], `Tuple`\[`str`, `str`]], `float`] + +**Returns** + +An dictionary with the coefficients corresponding to the quadratic expression. + +## Attributes + + ### coefficients @@ -42,7 +124,7 @@ Returns the coefficients of the quadratic expression. The coefficients of the quadratic expression. - + ### quadratic\_program @@ -55,3 +137,4 @@ Returns the parent QuadraticProgram. **Returns** The parent QuadraticProgram. + 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 7b8504e03c2..d572d67bf56 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticObjective.md @@ -1,8 +1,16 @@ -# QuadraticObjective +--- +title: QuadraticObjective +description: API reference for qiskit.optimization.problems.QuadraticObjective +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.QuadraticObjective +--- +# QuadraticObjective + -`QuadraticObjective(quadratic_program, constant=0.0, linear=None, quadratic=None, sense=)` +`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` @@ -20,14 +28,49 @@ Constructs a quadratic objective function. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- | -| [`evaluate`](qiskit.optimization.problems.QuadraticObjective.evaluate#qiskit.optimization.problems.QuadraticObjective.evaluate "qiskit.optimization.problems.QuadraticObjective.evaluate") | Evaluate the quadratic objective for given variable values. | -| [`evaluate_gradient`](qiskit.optimization.problems.QuadraticObjective.evaluate_gradient#qiskit.optimization.problems.QuadraticObjective.evaluate_gradient "qiskit.optimization.problems.QuadraticObjective.evaluate_gradient") | Evaluate the gradient of the quadratic objective for given variable values. | +### evaluate -## Attributes + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`float` + +**Returns** + +The value of the quadratic objective given the variable values. + +### evaluate\_gradient + + +`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. + +**Parameters** + +**x** (`Union`\[`ndarray`, `List`, `Dict`\[`Union`\[`int`, `str`], `float`]]) – The values of the variables to be evaluated. + +**Return type** + +`ndarray` + +**Returns** + +The value of the gradient of the quadratic objective given the variable values. + +## Attributes + + ### constant @@ -41,7 +84,7 @@ Returns the constant part of the objective function. The constant part of the objective function. - + ### linear @@ -55,7 +98,7 @@ Returns the linear part of the objective function. The linear part of the objective function. - + ### quadratic @@ -69,7 +112,7 @@ Returns the quadratic part of the objective function. The quadratic part of the objective function. - + ### quadratic\_program @@ -83,7 +126,7 @@ Returns the parent QuadraticProgram. The parent QuadraticProgram. - + ### sense @@ -96,3 +139,4 @@ Returns the sense of the objective function. **Returns** The sense of the objective function. + 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 547e9cb4eee..331b06a13ea 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgram.md @@ -1,8 +1,16 @@ -# QuadraticProgram +--- +title: QuadraticProgram +description: API reference for qiskit.optimization.problems.QuadraticProgram +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.QuadraticProgram +--- +# QuadraticProgram + -`QuadraticProgram(name='')` +`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` @@ -16,49 +24,826 @@ This representation supports inequality and equality constraints, as well as con ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -| [`binary_var`](qiskit.optimization.problems.QuadraticProgram.binary_var#qiskit.optimization.problems.QuadraticProgram.binary_var "qiskit.optimization.problems.QuadraticProgram.binary_var") | Adds a binary variable to the quadratic program. | -| [`binary_var_dict`](qiskit.optimization.problems.QuadraticProgram.binary_var_dict#qiskit.optimization.problems.QuadraticProgram.binary_var_dict "qiskit.optimization.problems.QuadraticProgram.binary_var_dict") | Uses ‘var\_dict’ to construct a dictionary of binary variables | -| [`binary_var_list`](qiskit.optimization.problems.QuadraticProgram.binary_var_list#qiskit.optimization.problems.QuadraticProgram.binary_var_list "qiskit.optimization.problems.QuadraticProgram.binary_var_list") | Uses ‘var\_list’ to construct a list of binary variables | -| [`clear`](qiskit.optimization.problems.QuadraticProgram.clear#qiskit.optimization.problems.QuadraticProgram.clear "qiskit.optimization.problems.QuadraticProgram.clear") | Clears the quadratic program, i.e., deletes all variables, constraints, the objective function as well as the name. | -| [`continuous_var`](qiskit.optimization.problems.QuadraticProgram.continuous_var#qiskit.optimization.problems.QuadraticProgram.continuous_var "qiskit.optimization.problems.QuadraticProgram.continuous_var") | Adds a continuous variable to the quadratic program. | -| [`continuous_var_dict`](qiskit.optimization.problems.QuadraticProgram.continuous_var_dict#qiskit.optimization.problems.QuadraticProgram.continuous_var_dict "qiskit.optimization.problems.QuadraticProgram.continuous_var_dict") | Uses ‘var\_dict’ to construct a dictionary of continuous variables | -| [`continuous_var_list`](qiskit.optimization.problems.QuadraticProgram.continuous_var_list#qiskit.optimization.problems.QuadraticProgram.continuous_var_list "qiskit.optimization.problems.QuadraticProgram.continuous_var_list") | Uses ‘var\_list’ to construct a list of continuous variables | -| [`export_as_lp_string`](qiskit.optimization.problems.QuadraticProgram.export_as_lp_string#qiskit.optimization.problems.QuadraticProgram.export_as_lp_string "qiskit.optimization.problems.QuadraticProgram.export_as_lp_string") | Returns the quadratic program as a string of LP format. | -| [`from_docplex`](qiskit.optimization.problems.QuadraticProgram.from_docplex#qiskit.optimization.problems.QuadraticProgram.from_docplex "qiskit.optimization.problems.QuadraticProgram.from_docplex") | Loads this quadratic program from a docplex model. | -| [`from_ising`](qiskit.optimization.problems.QuadraticProgram.from_ising#qiskit.optimization.problems.QuadraticProgram.from_ising "qiskit.optimization.problems.QuadraticProgram.from_ising") | Create a quadratic program from a qubit operator and a shift value. | -| [`get_feasibility_info`](qiskit.optimization.problems.QuadraticProgram.get_feasibility_info#qiskit.optimization.problems.QuadraticProgram.get_feasibility_info "qiskit.optimization.problems.QuadraticProgram.get_feasibility_info") | Returns whether a solution is feasible or not along with the violations. | -| [`get_linear_constraint`](qiskit.optimization.problems.QuadraticProgram.get_linear_constraint#qiskit.optimization.problems.QuadraticProgram.get_linear_constraint "qiskit.optimization.problems.QuadraticProgram.get_linear_constraint") | Returns a linear constraint for a given name or index. | -| [`get_num_binary_vars`](qiskit.optimization.problems.QuadraticProgram.get_num_binary_vars#qiskit.optimization.problems.QuadraticProgram.get_num_binary_vars "qiskit.optimization.problems.QuadraticProgram.get_num_binary_vars") | Returns the total number of binary variables. | -| [`get_num_continuous_vars`](qiskit.optimization.problems.QuadraticProgram.get_num_continuous_vars#qiskit.optimization.problems.QuadraticProgram.get_num_continuous_vars "qiskit.optimization.problems.QuadraticProgram.get_num_continuous_vars") | Returns the total number of continuous variables. | -| [`get_num_integer_vars`](qiskit.optimization.problems.QuadraticProgram.get_num_integer_vars#qiskit.optimization.problems.QuadraticProgram.get_num_integer_vars "qiskit.optimization.problems.QuadraticProgram.get_num_integer_vars") | Returns the total number of integer variables. | -| [`get_num_linear_constraints`](qiskit.optimization.problems.QuadraticProgram.get_num_linear_constraints#qiskit.optimization.problems.QuadraticProgram.get_num_linear_constraints "qiskit.optimization.problems.QuadraticProgram.get_num_linear_constraints") | Returns the number of linear constraints. | -| [`get_num_quadratic_constraints`](qiskit.optimization.problems.QuadraticProgram.get_num_quadratic_constraints#qiskit.optimization.problems.QuadraticProgram.get_num_quadratic_constraints "qiskit.optimization.problems.QuadraticProgram.get_num_quadratic_constraints") | Returns the number of quadratic constraints. | -| [`get_num_vars`](qiskit.optimization.problems.QuadraticProgram.get_num_vars#qiskit.optimization.problems.QuadraticProgram.get_num_vars "qiskit.optimization.problems.QuadraticProgram.get_num_vars") | Returns the total number of variables or the number of variables of the specified type. | -| [`get_quadratic_constraint`](qiskit.optimization.problems.QuadraticProgram.get_quadratic_constraint#qiskit.optimization.problems.QuadraticProgram.get_quadratic_constraint "qiskit.optimization.problems.QuadraticProgram.get_quadratic_constraint") | Returns a quadratic constraint for a given name or index. | -| [`get_variable`](qiskit.optimization.problems.QuadraticProgram.get_variable#qiskit.optimization.problems.QuadraticProgram.get_variable "qiskit.optimization.problems.QuadraticProgram.get_variable") | Returns a variable for a given name or index. | -| [`integer_var`](qiskit.optimization.problems.QuadraticProgram.integer_var#qiskit.optimization.problems.QuadraticProgram.integer_var "qiskit.optimization.problems.QuadraticProgram.integer_var") | Adds an integer variable to the quadratic program. | -| [`integer_var_dict`](qiskit.optimization.problems.QuadraticProgram.integer_var_dict#qiskit.optimization.problems.QuadraticProgram.integer_var_dict "qiskit.optimization.problems.QuadraticProgram.integer_var_dict") | Uses ‘var\_dict’ to construct a dictionary of integer variables | -| [`integer_var_list`](qiskit.optimization.problems.QuadraticProgram.integer_var_list#qiskit.optimization.problems.QuadraticProgram.integer_var_list "qiskit.optimization.problems.QuadraticProgram.integer_var_list") | Uses ‘var\_list’ to construct a dictionary of integer variables | -| [`is_feasible`](qiskit.optimization.problems.QuadraticProgram.is_feasible#qiskit.optimization.problems.QuadraticProgram.is_feasible "qiskit.optimization.problems.QuadraticProgram.is_feasible") | Returns whether a solution is feasible or not. | -| [`linear_constraint`](qiskit.optimization.problems.QuadraticProgram.linear_constraint#qiskit.optimization.problems.QuadraticProgram.linear_constraint "qiskit.optimization.problems.QuadraticProgram.linear_constraint") | Adds a linear equality constraint to the quadratic program of the form: | -| [`maximize`](qiskit.optimization.problems.QuadraticProgram.maximize#qiskit.optimization.problems.QuadraticProgram.maximize "qiskit.optimization.problems.QuadraticProgram.maximize") | Sets a quadratic objective to be maximized. | -| [`minimize`](qiskit.optimization.problems.QuadraticProgram.minimize#qiskit.optimization.problems.QuadraticProgram.minimize "qiskit.optimization.problems.QuadraticProgram.minimize") | Sets a quadratic objective to be minimized. | -| [`pprint_as_string`](qiskit.optimization.problems.QuadraticProgram.pprint_as_string#qiskit.optimization.problems.QuadraticProgram.pprint_as_string "qiskit.optimization.problems.QuadraticProgram.pprint_as_string") | DEPRECATED Returns the quadratic program as a string in Docplex’s pretty print format. | -| [`prettyprint`](qiskit.optimization.problems.QuadraticProgram.prettyprint#qiskit.optimization.problems.QuadraticProgram.prettyprint "qiskit.optimization.problems.QuadraticProgram.prettyprint") | DEPRECATED Pretty prints the quadratic program to a given output stream (None = default). | -| [`quadratic_constraint`](qiskit.optimization.problems.QuadraticProgram.quadratic_constraint#qiskit.optimization.problems.QuadraticProgram.quadratic_constraint "qiskit.optimization.problems.QuadraticProgram.quadratic_constraint") | Adds a quadratic equality constraint to the quadratic program of the form: | -| [`read_from_lp_file`](qiskit.optimization.problems.QuadraticProgram.read_from_lp_file#qiskit.optimization.problems.QuadraticProgram.read_from_lp_file "qiskit.optimization.problems.QuadraticProgram.read_from_lp_file") | Loads the quadratic program from a LP file. | -| [`remove_linear_constraint`](qiskit.optimization.problems.QuadraticProgram.remove_linear_constraint#qiskit.optimization.problems.QuadraticProgram.remove_linear_constraint "qiskit.optimization.problems.QuadraticProgram.remove_linear_constraint") | Remove a linear constraint | -| [`remove_quadratic_constraint`](qiskit.optimization.problems.QuadraticProgram.remove_quadratic_constraint#qiskit.optimization.problems.QuadraticProgram.remove_quadratic_constraint "qiskit.optimization.problems.QuadraticProgram.remove_quadratic_constraint") | Remove a quadratic constraint | -| [`substitute_variables`](qiskit.optimization.problems.QuadraticProgram.substitute_variables#qiskit.optimization.problems.QuadraticProgram.substitute_variables "qiskit.optimization.problems.QuadraticProgram.substitute_variables") | Substitutes variables with constants or other variables. | -| [`to_docplex`](qiskit.optimization.problems.QuadraticProgram.to_docplex#qiskit.optimization.problems.QuadraticProgram.to_docplex "qiskit.optimization.problems.QuadraticProgram.to_docplex") | Returns a docplex model corresponding to this quadratic program. | -| [`to_ising`](qiskit.optimization.problems.QuadraticProgram.to_ising#qiskit.optimization.problems.QuadraticProgram.to_ising "qiskit.optimization.problems.QuadraticProgram.to_ising") | Return the Ising Hamiltonian of this problem. | -| [`write_to_lp_file`](qiskit.optimization.problems.QuadraticProgram.write_to_lp_file#qiskit.optimization.problems.QuadraticProgram.write_to_lp_file "qiskit.optimization.problems.QuadraticProgram.write_to_lp_file") | Writes the quadratic program to an LP file. | +### binary\_var -## Attributes + + +`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. + +**Parameters** + +**name** (`Optional`\[`str`]) – The name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The added variable. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already occupied. + +### binary\_var\_dict + + + +`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 + +**Parameters** + +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`Dict`\[`str`, `Variable`] + +**Returns** + +A dictionary mapping the variable names to variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### binary\_var\_list + + + +`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 + +**Parameters** + +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`List`\[`Variable`] + +**Returns** + +A list of variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### clear + + + +`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. + +**Return type** + +`None` + +### continuous\_var + + + +`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. + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lowerbound of the variable. +* **upperbound** (`Union`\[`float`, `int`]) – The upperbound of the variable. +* **name** (`Optional`\[`str`]) – The name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The added variable. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already occupied. + +### continuous\_var\_dict + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`Dict`\[`str`, `Variable`] + +**Returns** + +A dictionary mapping the variable names to variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### continuous\_var\_list + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`List`\[`Variable`] + +**Returns** + +A list of variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### export\_as\_lp\_string + + + +`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. + +**Return type** + +`str` + +**Returns** + +A string representing the quadratic program. + +### from\_docplex + + + +`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. + +Note that this supports only basic functions of docplex as follows: - quadratic objective function - linear / quadratic constraints - binary / integer / continuous variables + +**Parameters** + +**model** (`Model`) – The docplex model to be loaded. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the model contains unsupported elements. + +**Return type** + +`None` + +### from\_ising + + + +`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. + +**Parameters** + +* **qubit\_op** (`Union`\[`OperatorBase`, `WeightedPauliOperator`]) – The qubit operator of the problem. +* **offset** (`float`) – The constant value in the Ising Hamiltonian. +* **linear** (`bool`) – If linear is True, $x^2$ is treated as a linear term since $x^2 = x$ for $x \in \{0,1\}$. Else, $x^2$ is treat as a quadratic term. The default value is False. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If there are Pauli Xs in any Pauli term +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If there are more than 2 Pauli Zs in any Pauli term +* **NotImplementedError** – If the input operator is a ListOp + +**Return type** + +`None` + +### get\_feasibility\_info + + + +`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. + +**Returns** + +Whether the solution provided is feasible or not. List\[Variable]: List of variables which are violated. List\[Constraint]: List of constraints which are violated. + +**Return type** + +feasible + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If the input x is not same len as total vars + +### get\_linear\_constraint + + + +`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. + +**Parameters** + +**i** (`Union`\[`int`, `str`]) – the index or name of the constraint. + +**Return type** + +`LinearConstraint` + +**Returns** + +The corresponding constraint. + +**Raises** + +* **IndexError** – if the index is out of the list size +* **KeyError** – if the name does not exist + +### get\_num\_binary\_vars + + + +`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. + +**Return type** + +`int` + +**Returns** + +The total number of binary variables. + +### get\_num\_continuous\_vars + + + +`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. + +**Return type** + +`int` + +**Returns** + +The total number of continuous variables. + +### get\_num\_integer\_vars + + + +`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. + +**Return type** + +`int` + +**Returns** + +The total number of integer variables. + +### get\_num\_linear\_constraints + + + +`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. + +**Return type** + +`int` + +**Returns** + +The number of linear constraints. + +### get\_num\_quadratic\_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") + +Returns the number of quadratic constraints. + +**Return type** + +`int` + +**Returns** + +The number of quadratic constraints. + +### get\_num\_vars + + + +`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. + +**Parameters** + +**vartype** (`Optional`\[`VarType`]) – The type to be filtered on. All variables are counted if None. + +**Return type** + +`int` + +**Returns** + +The total number of variables. + +### get\_quadratic\_constraint + + + +`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. + +**Parameters** + +**i** (`Union`\[`int`, `str`]) – the index or name of the constraint. + +**Return type** + +`QuadraticConstraint` + +**Returns** + +The corresponding constraint. + +**Raises** + +* **IndexError** – if the index is out of the list size +* **KeyError** – if the name does not exist + +### get\_variable + +`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. + +**Parameters** + +**i** (`Union`\[`int`, `str`]) – the index or name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The corresponding variable. + +### integer\_var + + + +`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. + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lowerbound of the variable. +* **upperbound** (`Union`\[`float`, `int`]) – The upperbound of the variable. +* **name** (`Optional`\[`str`]) – The name of the variable. + +**Return type** + +`Variable` + +**Returns** + +The added variable. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already occupied. + +### integer\_var\_dict + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`Dict`\[`str`, `Variable`] + +**Returns** + +A dictionary mapping the variable names to variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### integer\_var\_list + + + +`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 + +**Parameters** + +* **lowerbound** (`Union`\[`float`, `int`]) – The lower bound of the variable(s). +* **upperbound** (`Union`\[`float`, `int`]) – The upper bound of the variable(s). +* **name** (`Optional`\[`str`]) – The name(s) of the variable(s). +* **key\_format** (`str`) – The format used to name/index the variable(s). +* **keys** (`Union`\[`int`, `Sequence`]) – If keys: int, it is interpreted as the number of variables to construct. Otherwise, the elements of the sequence are converted to strings via ‘str’ and substituted into key\_format. + +**Return type** + +`List`\[`Variable`] + +**Returns** + +A list of variable instances. + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the variable name is already taken. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if less than one variable instantiation is attempted. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if key\_format has more than one substitution or a nested substitution. + +### is\_feasible + + + +`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. + +**Parameters** + +**x** (`Union`\[`List`\[`float`], `ndarray`]) – a solution value, such as returned in an optimizer result. + +**Return type** + +`bool` + +**Returns** + +`True` if the solution provided is feasible otherwise `False`. + +### linear\_constraint + + + +`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: + +linear \* x sense rhs. + +**Parameters** + +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – The linear coefficients of the left-hand-side of the constraint. +* **sense** (`Union`\[`str`, `ConstraintSense`]) – The sense of the constraint, - ‘==’, ‘=’, ‘E’, and ‘EQ’ denote ‘equal to’. - ‘>=’, ‘>’, ‘G’, and ‘GE’ denote ‘greater-than-or-equal-to’. - ‘\<=’, ‘\<’, ‘L’, and ‘LE’ denote ‘less-than-or-equal-to’. +* **rhs** (`float`) – The right hand side of the constraint. +* **name** (`Optional`\[`str`]) – The name of the constraint. + +**Return type** + +`LinearConstraint` + +**Returns** + +The added constraint. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the constraint name already exists or the sense is not valid. + +### maximize + + + +`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. + +**Parameters** + +* **constant** (`float`) – the constant offset of the objective. +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – the coefficients of the linear part of the objective. +* **quadratic** (`Union`\[`ndarray`, `spmatrix`, `List`\[`List`\[`float`]], `Dict`\[`Tuple`\[`Union`\[`int`, `str`], `Union`\[`int`, `str`]], `float`], `None`]) – the coefficients of the quadratic part of the objective. + +**Return type** + +`None` + +**Returns** + +The created quadratic objective. + +### minimize + + + +`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. + +**Parameters** + +* **constant** (`float`) – the constant offset of the objective. +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – the coefficients of the linear part of the objective. +* **quadratic** (`Union`\[`ndarray`, `spmatrix`, `List`\[`List`\[`float`]], `Dict`\[`Tuple`\[`Union`\[`int`, `str`], `Union`\[`int`, `str`]], `float`], `None`]) – the coefficients of the quadratic part of the objective. + +**Return type** + +`None` + +**Returns** + +The created quadratic objective. + +### pprint\_as\_string + + + +`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. + +### prettyprint + + + +`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). + +**Parameters** + +**out** (`Optional`\[`str`]) – The output stream or file name to print to. if you specify a file name, the output file name is has ‘.mod’ as suffix. + +**Return type** + +`None` + +### quadratic\_constraint + + + +`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: + +x \* Q \* x \<= rhs. + +**Parameters** + +* **linear** (`Union`\[`ndarray`, `spmatrix`, `List`\[`float`], `Dict`\[`Union`\[`int`, `str`], `float`], `None`]) – The linear coefficients of the constraint. +* **quadratic** (`Union`\[`ndarray`, `spmatrix`, `List`\[`List`\[`float`]], `Dict`\[`Tuple`\[`Union`\[`int`, `str`], `Union`\[`int`, `str`]], `float`], `None`]) – The quadratic coefficients of the constraint. +* **sense** (`Union`\[`str`, `ConstraintSense`]) – The sense of the constraint, - ‘==’, ‘=’, ‘E’, and ‘EQ’ denote ‘equal to’. - ‘>=’, ‘>’, ‘G’, and ‘GE’ denote ‘greater-than-or-equal-to’. - ‘\<=’, ‘\<’, ‘L’, and ‘LE’ denote ‘less-than-or-equal-to’. +* **rhs** (`float`) – The right hand side of the constraint. +* **name** (`Optional`\[`str`]) – The name of the constraint. + +**Return type** + +`QuadraticConstraint` + +**Returns** + +The added constraint. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the constraint name already exists. + +### read\_from\_lp\_file + + + +`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. + +**Parameters** + +**filename** (`str`) – The filename of the file to be loaded. + +**Raises** + +* **FileNotFoundError** – If the file does not exist. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If CPLEX is not installed. + + + This method requires CPLEX to be installed and present in `PYTHONPATH`. + + +**Return type** + +`None` + +### remove\_linear\_constraint + + + +`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 + +**Parameters** + +**i** (`Union`\[`str`, `int`]) – an index or a name of a linear constraint + +**Raises** + +* **KeyError** – if name does not exist +* **IndexError** – if index is out of range + +**Return type** + +`None` + +### remove\_quadratic\_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") + +Remove a quadratic constraint + +**Parameters** + +**i** (`Union`\[`str`, `int`]) – an index or a name of a quadratic constraint + +**Raises** + +* **KeyError** – if name does not exist +* **IndexError** – if index is out of range + +**Return type** + +`None` + +### substitute\_variables + + + +`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. + +**Parameters** + +* **constants** (`Optional`\[`Dict`\[`Union`\[`int`, `str`], `float`]]) – replace variable by constant e.g., \{‘x’: 2} means ‘x’ is substituted with 2 +* **variables** (`Optional`\[`Dict`\[`Union`\[`str`, `int`], `Tuple`\[`Union`\[`str`, `int`], `float`]]]) – replace variables by weighted other variable need to copy everything using name reference to make sure that indices are matched correctly. The lower and upper bounds are updated accordingly. e.g., \{‘x’: (‘y’, 2)} means ‘x’ is substituted with ‘y’ \* 2 + +**Return type** + +`QuadraticProgram` + +**Returns** + +An optimization problem by substituting variables with constants or other variables. If the substitution is valid, QuadraticProgram.status is still QuadraticProgram.Status.VALIAD. Otherwise, it gets QuadraticProgram.Status.INFEASIBLE. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if the substitution is invalid as follows. - Same variable is substituted multiple times. - Coefficient of variable substitution is zero. + +### to\_docplex + + + +`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. + +**Return type** + +`Model` + +**Returns** + +The docplex model corresponding to this quadratic program. + +**Raises** + +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if non-supported elements (should never happen). + +### to\_ising + + + +`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. + +**Returns** + +The qubit operator for the problem offset: The constant value in the Ising Hamiltonian. + +**Return type** + +qubit\_op + +**Raises** + +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If a variable type is not binary. +* [**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – If constraints exist in the problem. + +### write\_to\_lp\_file + + + +`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. + +**Parameters** + +**filename** (`str`) – The filename of the file the model is written to. If filename is a directory, file name ‘my\_problem.lp’ is appended. If filename does not end with ‘.lp’, suffix ‘.lp’ is appended. + +**Raises** + +* **OSError** – If this cannot open a file. +* **DOcplexException** – If filename is an empty string + +**Return type** + +`None` + +## Attributes + + ### linear\_constraints @@ -72,7 +857,7 @@ Returns the list of linear constraints of the quadratic program. List of linear constraints. - + ### linear\_constraints\_index @@ -86,7 +871,7 @@ Returns the dictionary that maps the name of a linear constraint to its index. The linear constraint index dictionary. - + ### name @@ -100,7 +885,7 @@ Returns the name of the quadratic program. The name of the quadratic program. - + ### objective @@ -114,7 +899,7 @@ Returns the quadratic objective. The quadratic objective. - + ### quadratic\_constraints @@ -128,7 +913,7 @@ Returns the list of quadratic constraints of the quadratic program. List of quadratic constraints. - + ### quadratic\_constraints\_index @@ -142,7 +927,7 @@ Returns the dictionary that maps the name of a quadratic constraint to its index The quadratic constraint index dictionary. - + ### status @@ -156,7 +941,7 @@ Status of the quadratic program. It can be infeasible due to variable substituti The status of the quadratic program - + ### variables @@ -170,7 +955,7 @@ Returns the list of variables of the quadratic program. List of variables. - + ### variables\_index @@ -183,3 +968,4 @@ Returns the dictionary that maps the name of a variable to its index. **Returns** The variable index dictionary. + 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 bd2fb3c65bb..f819786e881 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.QuadraticProgramElement.md @@ -1,8 +1,16 @@ -# QuadraticProgramElement +--- +title: QuadraticProgramElement +description: API reference for qiskit.optimization.problems.QuadraticProgramElement +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.QuadraticProgramElement +--- +# QuadraticProgramElement + -`QuadraticProgramElement(quadratic_program)` +`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` @@ -20,7 +28,7 @@ Initialize object with parent QuadraticProgram. ## Attributes - + ### quadratic\_program @@ -33,3 +41,4 @@ Returns the parent QuadraticProgram. **Returns** The parent QuadraticProgram. + 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 028a37f3e74..224ffcab330 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.Variable.md @@ -1,8 +1,16 @@ -# Variable +--- +title: Variable +description: API reference for qiskit.optimization.problems.Variable +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.optimization.problems.Variable +--- +# Variable + -`Variable(quadratic_program, name, lowerbound=0, upperbound=1e+20, vartype=)` +`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` @@ -22,17 +30,29 @@ The variables is exposed by the top-level QuadraticProgram class in QuadraticPro **Raises** -[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError#qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if lowerbound is greater than upperbound. +[**QiskitOptimizationError**](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") – if lowerbound is greater than upperbound. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | -| [`as_tuple`](qiskit.optimization.problems.Variable.as_tuple#qiskit.optimization.problems.Variable.as_tuple "qiskit.optimization.problems.Variable.as_tuple") | Returns a tuple corresponding to this variable. | +### as\_tuple -## Attributes + + +`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. +**Return type** + +`Tuple`\[`str`, `Union`\[`float`, `int`], `Union`\[`float`, `int`], `VarType`] + +**Returns** +A tuple corresponding to this variable consisting of name, lowerbound, upperbound and variable type. + +## Attributes + + ### lowerbound @@ -46,7 +66,7 @@ Returns the lowerbound of the variable. The lower bound of the variable. - + ### name @@ -60,7 +80,7 @@ Returns the name of the variable. The name of the variable. - + ### quadratic\_program @@ -74,7 +94,7 @@ Returns the parent QuadraticProgram. The parent QuadraticProgram. - + ### upperbound @@ -88,7 +108,7 @@ Returns the upperbound of the variable. The upperbound of the variable. - + ### vartype @@ -101,3 +121,4 @@ Returns the type of the variable. **Returns** The variable type. + diff --git a/docs/api/qiskit/0.32/qiskit.optimization.problems.md b/docs/api/qiskit/0.32/qiskit.optimization.problems.md index d49f9aa9e5b..0174cc85705 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.problems.md +++ b/docs/api/qiskit/0.32/qiskit.optimization.problems.md @@ -20,22 +20,22 @@ python_api_name: qiskit.optimization.problems Structures for defining an optimization problem. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram#qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") | Quadratically Constrained Quadratic Program representation. | +| | | +| ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram") | Quadratically Constrained Quadratic Program representation. | - The following classes are not intended to be instantiated directly. Objects of these types are available within an instantiated [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram#qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram"). + The following classes are not intended to be instantiated directly. Objects of these types are available within an instantiated [`QuadraticProgram`](qiskit.optimization.problems.QuadraticProgram "qiskit.optimization.problems.QuadraticProgram"). -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| [`Constraint`](qiskit.optimization.problems.Constraint#qiskit.optimization.problems.Constraint "qiskit.optimization.problems.Constraint") | Abstract Constraint Class. | -| [`LinearExpression`](qiskit.optimization.problems.LinearExpression#qiskit.optimization.problems.LinearExpression "qiskit.optimization.problems.LinearExpression") | Representation of a linear expression by its coefficients. | -| [`LinearConstraint`](qiskit.optimization.problems.LinearConstraint#qiskit.optimization.problems.LinearConstraint "qiskit.optimization.problems.LinearConstraint") | Representation of a linear constraint. | -| [`QuadraticExpression`](qiskit.optimization.problems.QuadraticExpression#qiskit.optimization.problems.QuadraticExpression "qiskit.optimization.problems.QuadraticExpression") | Representation of a quadratic expression by its coefficients. | -| [`QuadraticConstraint`](qiskit.optimization.problems.QuadraticConstraint#qiskit.optimization.problems.QuadraticConstraint "qiskit.optimization.problems.QuadraticConstraint") | Representation of a quadratic constraint. | -| [`QuadraticObjective`](qiskit.optimization.problems.QuadraticObjective#qiskit.optimization.problems.QuadraticObjective "qiskit.optimization.problems.QuadraticObjective") | Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. | -| [`QuadraticProgramElement`](qiskit.optimization.problems.QuadraticProgramElement#qiskit.optimization.problems.QuadraticProgramElement "qiskit.optimization.problems.QuadraticProgramElement") | Interface class for all objects that have a parent QuadraticProgram. | -| [`Variable`](qiskit.optimization.problems.Variable#qiskit.optimization.problems.Variable "qiskit.optimization.problems.Variable") | Representation of a variable. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | +| [`Constraint`](qiskit.optimization.problems.Constraint "qiskit.optimization.problems.Constraint") | Abstract Constraint Class. | +| [`LinearExpression`](qiskit.optimization.problems.LinearExpression "qiskit.optimization.problems.LinearExpression") | Representation of a linear expression by its coefficients. | +| [`LinearConstraint`](qiskit.optimization.problems.LinearConstraint "qiskit.optimization.problems.LinearConstraint") | Representation of a linear constraint. | +| [`QuadraticExpression`](qiskit.optimization.problems.QuadraticExpression "qiskit.optimization.problems.QuadraticExpression") | Representation of a quadratic expression by its coefficients. | +| [`QuadraticConstraint`](qiskit.optimization.problems.QuadraticConstraint "qiskit.optimization.problems.QuadraticConstraint") | Representation of a quadratic constraint. | +| [`QuadraticObjective`](qiskit.optimization.problems.QuadraticObjective "qiskit.optimization.problems.QuadraticObjective") | Representation of quadratic objective function of the form: constant + linear \* x + x \* quadratic \* x. | +| [`QuadraticProgramElement`](qiskit.optimization.problems.QuadraticProgramElement "qiskit.optimization.problems.QuadraticProgramElement") | Interface class for all objects that have a parent QuadraticProgram. | +| [`Variable`](qiskit.optimization.problems.Variable "qiskit.optimization.problems.Variable") | Representation of a variable. | diff --git a/docs/api/qiskit/0.32/qiskit.providers.Backend.md b/docs/api/qiskit/0.32/qiskit.providers.Backend.md index 4b4f9e8f206..8f8b2617abf 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Backend.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Backend.md @@ -1,8 +1,16 @@ -# Backend +--- +title: Backend +description: API reference for qiskit.providers.Backend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.Backend +--- +# Backend + -`Backend` +`Backend`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") Bases: `object` @@ -12,8 +20,9 @@ Note this class should not be inherited from directly, it is intended to be used ## Attributes - + ### version `= 0` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md b/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md index b7f124ca705..624c3efa4ac 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BackendPropertyError.md @@ -1,9 +1,18 @@ -# qiskit.providers.BackendPropertyError +--- +title: BackendPropertyError +description: API reference for qiskit.providers.BackendPropertyError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.BackendPropertyError +--- +# qiskit.providers.BackendPropertyError + -`BackendPropertyError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md b/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md index a53eba3f6ab..7982b298902 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BackendV1.md @@ -1,23 +1,31 @@ -# BackendV1 +--- +title: BackendV1 +description: API reference for qiskit.providers.BackendV1 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.BackendV1 +--- +# BackendV1 + -`BackendV1(configuration, provider=None, **fields)` +`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` Abstract class for Backends -This abstract class is to be used for all Backend objects created by a provider. There are several classes of information contained in a Backend. The first are the attributes of the class itself. These should be used to defined the immutable characteristics of the backend. The `options` attribute of the backend is used to contain the dynamic user configurable options of the backend. It should be used more for runtime options that configure how the backend is used. For example, something like a `shots` field for a backend that runs experiments which would contain an int for how many shots to execute. The `properties` attribute is optionally defined [`BackendProperties`](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object and is used to return measured properties, or properties of a backend that may change over time. The simplest example of this would be a version string, which will change as a backend is updated, but also could be something like noise parameters for backends that run experiments. +This abstract class is to be used for all Backend objects created by a provider. There are several classes of information contained in a Backend. The first are the attributes of the class itself. These should be used to defined the immutable characteristics of the backend. The `options` attribute of the backend is used to contain the dynamic user configurable options of the backend. It should be used more for runtime options that configure how the backend is used. For example, something like a `shots` field for a backend that runs experiments which would contain an int for how many shots to execute. The `properties` attribute is optionally defined [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") object and is used to return measured properties, or properties of a backend that may change over time. The simplest example of this would be a version string, which will change as a backend is updated, but also could be something like noise parameters for backends that run experiments. -This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This includes reusing the model objects [`BackendProperties`](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") and [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration"). This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface. +This first version of the Backend abstract class is written to be mostly backwards compatible with the legacy providers interface. This includes reusing the model objects [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") and [`BackendConfiguration`](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration"). This was done to ease the transition for users and provider maintainers to the new versioned providers. Expect, future versions of this abstract class to change the data model and interface. Initialize a backend class **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. -* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. +* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. * **fields** – kwargs for the values to use to override the default options. **Raises** @@ -26,13 +34,15 @@ Initialize a backend class In addition to the public abstract methods, subclasses should also implement the following private methods: +### \_default\_options + `abstract classmethod _default_options()` Return the default options -This method will return a [`qiskit.providers.Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. +This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. **Returns** @@ -42,32 +52,144 @@ default values set **Return type** -[qiskit.providers.Options](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") +[qiskit.providers.Options](qiskit.providers.Options "qiskit.providers.Options") ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`configuration`](qiskit.providers.BackendV1.configuration#qiskit.providers.BackendV1.configuration "qiskit.providers.BackendV1.configuration") | Return the backend configuration. | -| [`name`](qiskit.providers.BackendV1.name#qiskit.providers.BackendV1.name "qiskit.providers.BackendV1.name") | Return the backend name. | -| [`properties`](qiskit.providers.BackendV1.properties#qiskit.providers.BackendV1.properties "qiskit.providers.BackendV1.properties") | Return the backend properties. | -| [`provider`](qiskit.providers.BackendV1.provider#qiskit.providers.BackendV1.provider "qiskit.providers.BackendV1.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") | Run on the backend. | -| [`set_options`](qiskit.providers.BackendV1.set_options#qiskit.providers.BackendV1.set_options "qiskit.providers.BackendV1.set_options") | Set the options fields for the backend | -| [`status`](qiskit.providers.BackendV1.status#qiskit.providers.BackendV1.status "qiskit.providers.BackendV1.status") | Return the backend status. | +### configuration -## Attributes + + +`BackendV1.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### name + + + +`BackendV1.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`BackendV1.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") + +Return the backend properties. + +**Returns** + +the configuration for the backend. If the backend does not support properties, it returns `None`. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`BackendV1.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") +### run + + + +`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. + +This method that will return a [`Job`](qiskit.providers.Job "qiskit.providers.Job") object that run circuits. Depending on the backend this may be either an async or sync call. It is the discretion of the provider to decide whether running should block until the execution is finished or not. The Job class can handle either situation. + +**Parameters** + +* **run\_input** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or list*) – An individual or a list of `QuantumCircuit` or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects to run on the backend. For legacy providers migrating to the new versioned providers, provider interface a [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj") or [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj") objects should probably be supported too (but deprecated) for backwards compatibility. Be sure to update the docstrings of subclasses implementing this method to document that. New provider implementations should not do this though as [`qiskit.qobj`](qobj#module-qiskit.qobj "qiskit.qobj") will be deprecated and removed along with the legacy providers interface. +* **options** – Any kwarg options to pass to the backend for running the config. If a key is also present in the options attribute/object then the expectation is that the value specified will be used instead of what’s set in the options object. + +**Returns** + +The job object for the run + +**Return type** + +[Job](qiskit.providers.Job "qiskit.providers.Job") + +### set\_options + + + +`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 + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + +### status + + + +`BackendV1.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/backend.py "view source code") + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.BackendV1.run#qiskit.providers.BackendV1.run "qiskit.providers.BackendV1.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.BackendV1#run "qiskit.providers.BackendV1.run") method. + ### version `= 1` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md b/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md index 97d33ea481b..de4e1e24d13 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseBackend.md @@ -1,8 +1,16 @@ -# BaseBackend +--- +title: BaseBackend +description: API reference for qiskit.providers.BaseBackend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.BaseBackend +--- +# BaseBackend + -`BaseBackend(configuration, provider=None)` +`BaseBackend(configuration, provider=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") Bases: `abc.ABC` @@ -14,8 +22,8 @@ This method should initialize the module and its configuration, and raise an exc **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration -* **provider** ([*BaseProvider*](qiskit.providers.BaseProvider#qiskit.providers.BaseProvider "qiskit.providers.BaseProvider")) – provider responsible for this backend +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration +* **provider** ([*BaseProvider*](qiskit.providers.BaseProvider "qiskit.providers.BaseProvider")) – provider responsible for this backend **Raises** @@ -23,12 +31,111 @@ This method should initialize the module and its configuration, and raise an exc ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`configuration`](qiskit.providers.BaseBackend.configuration#qiskit.providers.BaseBackend.configuration "qiskit.providers.BaseBackend.configuration") | Return the backend configuration. | -| [`name`](qiskit.providers.BaseBackend.name#qiskit.providers.BaseBackend.name "qiskit.providers.BaseBackend.name") | Return the backend name. | -| [`properties`](qiskit.providers.BaseBackend.properties#qiskit.providers.BaseBackend.properties "qiskit.providers.BaseBackend.properties") | Return the backend properties. | -| [`provider`](qiskit.providers.BaseBackend.provider#qiskit.providers.BaseBackend.provider "qiskit.providers.BaseBackend.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.BaseBackend.run#qiskit.providers.BaseBackend.run "qiskit.providers.BaseBackend.run") | Run a Qobj on the the backend. | -| [`status`](qiskit.providers.BaseBackend.status#qiskit.providers.BaseBackend.status "qiskit.providers.BaseBackend.status") | Return the backend status. | -| [`version`](qiskit.providers.BaseBackend.version#qiskit.providers.BaseBackend.version "qiskit.providers.BaseBackend.version") | Return the backend version. | +### configuration + + + +`BaseBackend.configuration()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### name + + + +`BaseBackend.name()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`BaseBackend.properties()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") + +Return the backend properties. + +**Returns** + +the configuration for the backend. If the backend does not support properties, it returns `None`. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`BaseBackend.provider()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +[BaseProvider](qiskit.providers.BaseProvider "qiskit.providers.BaseProvider") + +### run + + + +`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. + +**Parameters** + +**qobj** ([*Qobj*](qiskit.qobj.Qobj "qiskit.qobj.Qobj")) – the Qobj to be executed. + +### status + + + +`BaseBackend.status()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +### version + + + +`BaseBackend.version()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basebackend.py "view source code") + +Return the backend version. + +**Returns** + +the X.X.X version of the backend. + +**Return type** + +str + diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md b/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md index d2e0bbe1a67..84da9924fa4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseJob.md @@ -1,8 +1,16 @@ -# BaseJob +--- +title: BaseJob +description: API reference for qiskit.providers.BaseJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.BaseJob +--- +# BaseJob + -`BaseJob(backend, job_id)` +`BaseJob(backend, job_id)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basejob.py "view source code") Bases: `abc.ABC` @@ -17,16 +25,139 @@ Initializes the asynchronous job. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`backend`](qiskit.providers.BaseJob.backend#qiskit.providers.BaseJob.backend "qiskit.providers.BaseJob.backend") | Return the backend where this job was executed. | -| [`cancel`](qiskit.providers.BaseJob.cancel#qiskit.providers.BaseJob.cancel "qiskit.providers.BaseJob.cancel") | Attempt to cancel the job. | -| [`cancelled`](qiskit.providers.BaseJob.cancelled#qiskit.providers.BaseJob.cancelled "qiskit.providers.BaseJob.cancelled") | Return whether the job has been cancelled. | -| [`done`](qiskit.providers.BaseJob.done#qiskit.providers.BaseJob.done "qiskit.providers.BaseJob.done") | Return whether the job has successfully run. | -| [`in_final_state`](qiskit.providers.BaseJob.in_final_state#qiskit.providers.BaseJob.in_final_state "qiskit.providers.BaseJob.in_final_state") | Return whether the job is in a final job state. | -| [`job_id`](qiskit.providers.BaseJob.job_id#qiskit.providers.BaseJob.job_id "qiskit.providers.BaseJob.job_id") | Return a unique id identifying the job. | -| [`result`](qiskit.providers.BaseJob.result#qiskit.providers.BaseJob.result "qiskit.providers.BaseJob.result") | Return the results of the job. | -| [`running`](qiskit.providers.BaseJob.running#qiskit.providers.BaseJob.running "qiskit.providers.BaseJob.running") | Return whether the job is actively running. | -| [`status`](qiskit.providers.BaseJob.status#qiskit.providers.BaseJob.status "qiskit.providers.BaseJob.status") | Return the status of the job, among the values of `JobStatus`. | -| [`submit`](qiskit.providers.BaseJob.submit#qiskit.providers.BaseJob.submit "qiskit.providers.BaseJob.submit") | Submit the job to the backend for execution. | -| [`wait_for_final_state`](qiskit.providers.BaseJob.wait_for_final_state#qiskit.providers.BaseJob.wait_for_final_state "qiskit.providers.BaseJob.wait_for_final_state") | Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. | +### backend + + + +`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. + +**Return type** + +`BaseBackend` + +### cancel + + + +`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. + +### cancelled + + + +`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. + +**Return type** + +`bool` + +### done + + + +`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. + +**Return type** + +`bool` + +### in\_final\_state + + + +`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. + +**Return type** + +`bool` + +### job\_id + + + +`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. + +**Return type** + +`str` + +### result + + + +`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. + +### running + + + +`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. + +**Return type** + +`bool` + +### status + + + +`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`. + +### submit + + + +`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. + +### wait\_for\_final\_state + + + +`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`. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + +* **wait** (`float`) – Seconds between queries. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function invoked after each query. The following positional arguments are provided to the callback function: + + * job\_id: Job ID + * job\_status: Status of the job from the last query + * job: This BaseJob instance + + Note: different subclass might provide different arguments to the callback function. + +**Raises** + +[**JobTimeoutError**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + +**Return type** + +`None` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md b/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md index 45c4790fd19..5a3be2cefee 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.BaseProvider.md @@ -1,8 +1,16 @@ -# BaseProvider +--- +title: BaseProvider +description: API reference for qiskit.providers.BaseProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.BaseProvider +--- +# BaseProvider + -`BaseProvider(*args, **kwargs)` +`BaseProvider(*args, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/baseprovider.py "view source code") Bases: `abc.ABC` @@ -10,7 +18,51 @@ Base class for a Backend Provider. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | -| [`backends`](qiskit.providers.BaseProvider.backends#qiskit.providers.BaseProvider.backends "qiskit.providers.BaseProvider.backends") | Return a list of backends matching the specified filtering. | -| [`get_backend`](qiskit.providers.BaseProvider.get_backend#qiskit.providers.BaseProvider.get_backend "qiskit.providers.BaseProvider.get_backend") | Return a single backend matching the specified filtering. | +### backends + + + +`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. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +**a list of Backends that match the filtering** + +criteria. + +**Return type** + +list\[[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")] + +### get\_backend + + + +`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. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +[BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend") + +**Raises** + +[**QiskitBackendNotFoundError**](qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError") – if no backend could be found or more than one backend matches the filtering criteria. + diff --git a/docs/api/qiskit/0.32/qiskit.providers.Job.md b/docs/api/qiskit/0.32/qiskit.providers.Job.md index 5ec7941772a..63659a6fffd 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Job.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Job.md @@ -1,8 +1,16 @@ -# Job +--- +title: Job +description: API reference for qiskit.providers.Job +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.Job +--- +# Job + -`Job` +`Job`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") Bases: `object` @@ -12,8 +20,9 @@ Note this class should not be inherited from directly, it is intended to be used ## Attributes - + ### version `= 0` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobError.md b/docs/api/qiskit/0.32/qiskit.providers.JobError.md index 01b5770de53..c451db25471 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobError.md @@ -1,9 +1,18 @@ -# qiskit.providers.JobError +--- +title: JobError +description: API reference for qiskit.providers.JobError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.JobError +--- +# qiskit.providers.JobError + -`JobError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md b/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md index 2acb8316d3a..5b2f11fd019 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobStatus.md @@ -1,8 +1,16 @@ -# JobStatus +--- +title: JobStatus +description: API reference for qiskit.providers.JobStatus +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.JobStatus +--- +# JobStatus + -`JobStatus(value)` +`JobStatus(value)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/jobstatus.py "view source code") Bases: `enum.Enum` @@ -10,44 +18,45 @@ Class for job status enumerated type. ## Attributes - + ### CANCELLED `= 'job has been cancelled'` - + ### DONE `= 'job has successfully run'` - + ### ERROR `= 'job incurred error'` - + ### INITIALIZING `= 'job is being initialized'` - + ### QUEUED `= 'job is queued'` - + ### RUNNING `= 'job is actively running'` - + ### VALIDATING `= 'job is being validated'` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md b/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md index 09dabaf8dbf..5cd9186bd93 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobTimeoutError.md @@ -1,9 +1,18 @@ -# qiskit.providers.JobTimeoutError +--- +title: JobTimeoutError +description: API reference for qiskit.providers.JobTimeoutError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.JobTimeoutError +--- +# qiskit.providers.JobTimeoutError + -`JobTimeoutError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.providers.JobV1.md b/docs/api/qiskit/0.32/qiskit.providers.JobV1.md index 8d8396c305a..8a10a273119 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.JobV1.md +++ b/docs/api/qiskit/0.32/qiskit.providers.JobV1.md @@ -1,8 +1,16 @@ -# JobV1 +--- +title: JobV1 +description: API reference for qiskit.providers.JobV1 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.JobV1 +--- +# JobV1 + -`JobV1(backend, job_id, **kwargs)` +`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` @@ -20,24 +28,147 @@ Initializes the asynchronous job. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`backend`](qiskit.providers.JobV1.backend#qiskit.providers.JobV1.backend "qiskit.providers.JobV1.backend") | Return the backend where this job was executed. | -| [`cancel`](qiskit.providers.JobV1.cancel#qiskit.providers.JobV1.cancel "qiskit.providers.JobV1.cancel") | Attempt to cancel the job. | -| [`cancelled`](qiskit.providers.JobV1.cancelled#qiskit.providers.JobV1.cancelled "qiskit.providers.JobV1.cancelled") | Return whether the job has been cancelled. | -| [`done`](qiskit.providers.JobV1.done#qiskit.providers.JobV1.done "qiskit.providers.JobV1.done") | Return whether the job has successfully run. | -| [`in_final_state`](qiskit.providers.JobV1.in_final_state#qiskit.providers.JobV1.in_final_state "qiskit.providers.JobV1.in_final_state") | Return whether the job is in a final job state such as `DONE` or `ERROR`. | -| [`job_id`](qiskit.providers.JobV1.job_id#qiskit.providers.JobV1.job_id "qiskit.providers.JobV1.job_id") | Return a unique id identifying the job. | -| [`result`](qiskit.providers.JobV1.result#qiskit.providers.JobV1.result "qiskit.providers.JobV1.result") | Return the results of the job. | -| [`running`](qiskit.providers.JobV1.running#qiskit.providers.JobV1.running "qiskit.providers.JobV1.running") | Return whether the job is actively running. | -| [`status`](qiskit.providers.JobV1.status#qiskit.providers.JobV1.status "qiskit.providers.JobV1.status") | Return the status of the job, among the values of `JobStatus`. | -| [`submit`](qiskit.providers.JobV1.submit#qiskit.providers.JobV1.submit "qiskit.providers.JobV1.submit") | Submit the job to the backend for execution. | -| [`wait_for_final_state`](qiskit.providers.JobV1.wait_for_final_state#qiskit.providers.JobV1.wait_for_final_state "qiskit.providers.JobV1.wait_for_final_state") | Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. | +### backend -## Attributes + + +`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. + +**Return type** + +`Backend` + +### cancel + + + +`JobV1.cancel()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/job.py "view source code") + +Attempt to cancel the job. + +### cancelled + + + +`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. + +**Return type** + +`bool` + +### done + + + +`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. + +**Return type** + +`bool` + +### in\_final\_state + + + +`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`. + +**Return type** + +`bool` + +### job\_id + + + +`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. + +**Return type** + +`str` + +### result + +`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. + +### running + + + +`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. + +**Return type** + +`bool` + +### status + + + +`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`. + +### submit + + + +`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. + +### wait\_for\_final\_state + + + +`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`. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + +* **wait** (`float`) – Seconds between queries. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function invoked after each query. The following positional arguments are provided to the callback function: + + * job\_id: Job ID + * job\_status: Status of the job from the last query + * job: This BaseJob instance + + Note: different subclass might provide different arguments to the callback function. + +**Raises** + +[**JobTimeoutError**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + +**Return type** + +`None` + +## Attributes + + ### version `= 1` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.Options.md b/docs/api/qiskit/0.32/qiskit.providers.Options.md index 03d9ad455c1..ac32ae67834 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Options.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Options.md @@ -1,8 +1,16 @@ -# Options +--- +title: Options +description: API reference for qiskit.providers.Options +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.Options +--- +# Options + -`Options` +`Options`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/options.py "view source code") Bases: `types.SimpleNamespace` @@ -12,7 +20,19 @@ This class is the abstract class that all backend options are based on. The prop ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`get`](qiskit.providers.Options.get#qiskit.providers.Options.get "qiskit.providers.Options.get") | Get an option value for a given key. | -| [`update_options`](qiskit.providers.Options.update_options#qiskit.providers.Options.update_options "qiskit.providers.Options.update_options") | Update options with kwargs | +### get + + + +`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. + +### update\_options + + + +`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 cbd1b5c2d19..968e515262f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.Provider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.Provider.md @@ -1,8 +1,16 @@ -# Provider +--- +title: Provider +description: API reference for qiskit.providers.Provider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.Provider +--- +# Provider + -`Provider` +`Provider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/provider.py "view source code") Bases: `object` @@ -12,8 +20,9 @@ Note this class should not be inherited from directly, it is intended to be used ## Attributes - + ### version `= 0` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md b/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md index 50a05edbd8b..2b87bbfd5ec 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ProviderV1.md @@ -1,8 +1,16 @@ -# ProviderV1 +--- +title: ProviderV1 +description: API reference for qiskit.providers.ProviderV1 +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ProviderV1 +--- +# ProviderV1 + -`ProviderV1` +`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` @@ -10,15 +18,59 @@ Base class for a Backend Provider. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------- | -| [`backends`](qiskit.providers.ProviderV1.backends#qiskit.providers.ProviderV1.backends "qiskit.providers.ProviderV1.backends") | Return a list of backends matching the specified filtering. | -| [`get_backend`](qiskit.providers.ProviderV1.get_backend#qiskit.providers.ProviderV1.get_backend "qiskit.providers.ProviderV1.get_backend") | Return a single backend matching the specified filtering. | +### backends -## Attributes + + +`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. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +**a list of Backends that match the filtering** + +criteria. + +**Return type** + +list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] + +### get\_backend + +`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. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +[Backend](qiskit.providers.Backend "qiskit.providers.Backend") + +**Raises** + +[**QiskitBackendNotFoundError**](qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError") – if no backend could be found or more than one backend matches the filtering criteria. + +## Attributes + + ### version `= 1` + diff --git a/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md b/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md index 5ded871daa5..ed7ccfe563b 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.QiskitBackendNotFoundError.md @@ -1,9 +1,18 @@ -# qiskit.providers.QiskitBackendNotFoundError +--- +title: QiskitBackendNotFoundError +description: API reference for qiskit.providers.QiskitBackendNotFoundError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.QiskitBackendNotFoundError +--- +# qiskit.providers.QiskitBackendNotFoundError + -`QiskitBackendNotFoundError(*message)` +`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. Set the error message. + 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 ca0b73723a2..e73f1efd60e 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerError.md @@ -1,9 +1,18 @@ -# qiskit.providers.aer.AerError +--- +title: AerError +description: API reference for qiskit.providers.aer.AerError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.aer.AerError +--- +# qiskit.providers.aer.AerError + -`AerError(*message)` +`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. Set the error message. + 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 f800e1da58a..26bfd13c4cc 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerProvider.md @@ -1,8 +1,16 @@ -# AerProvider +--- +title: AerProvider +description: API reference for qiskit.providers.aer.AerProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.AerProvider +--- +# AerProvider + -`AerProvider` +`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` @@ -10,15 +18,59 @@ Provider for Qiskit Aer backends. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`backends`](qiskit.providers.aer.AerProvider.backends#qiskit.providers.aer.AerProvider.backends "qiskit.providers.aer.AerProvider.backends") | Return a list of backends matching the specified filtering. | -| [`get_backend`](qiskit.providers.aer.AerProvider.get_backend#qiskit.providers.aer.AerProvider.get_backend "qiskit.providers.aer.AerProvider.get_backend") | Return a single backend matching the specified filtering. | +### backends -## Attributes + + +`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. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +**a list of Backends that match the filtering** + +criteria. + +**Return type** + +list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] + +### get\_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") + +Return a single backend matching the specified filtering. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +[Backend](qiskit.providers.Backend "qiskit.providers.Backend") + +**Raises** + +[**QiskitBackendNotFoundError**](qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError") – if no backend could be found or more than one backend matches the filtering criteria. + +## Attributes + + ### version `= 1` + 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 cd8b09f9e66..45c4620db2a 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.AerSimulator.md @@ -1,8 +1,16 @@ -# AerSimulator +--- +title: AerSimulator +description: API reference for qiskit.providers.aer.AerSimulator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.AerSimulator +--- +# AerSimulator + -`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)` +`AerSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/aer_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -10,9 +18,9 @@ Noisy quantum circuit simulator backend. **Configurable Options** -The AerSimulator supports multiple simulation methods and configurable options for each simulation method. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.AerSimulator.set_options#qiskit.providers.aer.AerSimulator.set_options "qiskit.providers.aer.AerSimulator.set_options") method. +The AerSimulator supports multiple simulation methods and configurable options for each simulation method. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.AerSimulator#set_options "qiskit.providers.aer.AerSimulator.set_options") method. -Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.AerSimulator.run#qiskit.providers.aer.AerSimulator.run "qiskit.providers.aer.AerSimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. +Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.AerSimulator#run "qiskit.providers.aer.AerSimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. For example, to configure a density matrix simulator with a custom noise model to use for every execution @@ -24,7 +32,7 @@ backend = AerSimulator(method='density_matrix', **Simulating an IBMQ Backend** -The simulator can be automatically configured to mimic an IBMQ backend using the [`from_backend()`](qiskit.providers.aer.AerSimulator.from_backend#qiskit.providers.aer.AerSimulator.from_backend "qiskit.providers.aer.AerSimulator.from_backend") method. This will configure the simulator to use the basic device `NoiseModel` for that backend, and the same basis gates and coupling map. +The simulator can be automatically configured to mimic an IBMQ backend using the [`from_backend()`](qiskit.providers.aer.AerSimulator#from_backend "qiskit.providers.aer.AerSimulator.from_backend") method. This will configure the simulator to use the basic device `NoiseModel` for that backend, and the same basis gates and coupling map. ```python backend = AerSimulator.from_backend(backend) @@ -32,11 +40,11 @@ backend = AerSimulator.from_backend(backend) **Returning the Final State** -The final state of the simulator can be saved to the returned `Result` object by appending the [`save_state()`](qiskit.providers.aer.library.save_state#qiskit.providers.aer.library.save_state "qiskit.providers.aer.library.save_state") instruction to a quantum circuit. The format of the final state will depend on the simulation method used. Additional simulation data may also be saved using the other save instructions in `qiskit.provider.aer.library`. +The final state of the simulator can be saved to the returned `Result` object by appending the [`save_state()`](qiskit.providers.aer.library.save_state "qiskit.providers.aer.library.save_state") instruction to a quantum circuit. The format of the final state will depend on the simulation method used. Additional simulation data may also be saved using the other save instructions in `qiskit.provider.aer.library`. **Simulation Method Option** -The simulation method is set using the `method` kwarg. A list supported simulation methods can be returned using [`available_methods()`](qiskit.providers.aer.AerSimulator.available_methods#qiskit.providers.aer.AerSimulator.available_methods "qiskit.providers.aer.AerSimulator.available_methods"), these are +The simulation method is set using the `method` kwarg. A list supported simulation methods can be returned using [`available_methods()`](qiskit.providers.aer.AerSimulator#available_methods "qiskit.providers.aer.AerSimulator.available_methods"), these are * `"automatic"`: Default simulation method. Select the simulation method automatically based on the circuit and noise model. * `"statevector"`: A dense statevector simulation that can sample measurement outcomes from *ideal* circuits with all measurements at end of the circuit. For noisy simulations each shot samples a randomly sampled noisy circuit from the noise model. @@ -62,14 +70,14 @@ By default all simulation methods run on the CPU, however select methods also su | `unitary` | Yes | | `superop` | No | -Running a GPU simulation is done using `device="GPU"` kwarg during initialization or with [`set_options()`](qiskit.providers.aer.AerSimulator.set_options#qiskit.providers.aer.AerSimulator.set_options "qiskit.providers.aer.AerSimulator.set_options"). The list of supported devices for the current system can be returned using [`available_devices()`](qiskit.providers.aer.AerSimulator.available_devices#qiskit.providers.aer.AerSimulator.available_devices "qiskit.providers.aer.AerSimulator.available_devices"). +Running a GPU simulation is done using `device="GPU"` kwarg during initialization or with [`set_options()`](qiskit.providers.aer.AerSimulator#set_options "qiskit.providers.aer.AerSimulator.set_options"). The list of supported devices for the current system can be returned using [`available_devices()`](qiskit.providers.aer.AerSimulator#available_devices "qiskit.providers.aer.AerSimulator.available_devices"). **Additional Backend Options** The following simulator specific backend options are supported -* `method` (str): Set the simulation method (Default: `"automatic"`). Use [`available_methods()`](qiskit.providers.aer.AerSimulator.available_methods#qiskit.providers.aer.AerSimulator.available_methods "qiskit.providers.aer.AerSimulator.available_methods") to return a list of all availabe methods. -* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.AerSimulator.available_devices#qiskit.providers.aer.AerSimulator.available_devices "qiskit.providers.aer.AerSimulator.available_devices") to return a list of devices supported on the current system. +* `method` (str): Set the simulation method (Default: `"automatic"`). Use [`available_methods()`](qiskit.providers.aer.AerSimulator#available_methods "qiskit.providers.aer.AerSimulator.available_methods") to return a list of all availabe methods. +* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.AerSimulator#available_devices "qiskit.providers.aer.AerSimulator.available_devices") to return a list of devices supported on the current system. * `precision` (str): Set the floating point precision for certain simulation methods to either `"single"` or `"double"` precision (default: `"double"`). * `executor` (futures.Executor or None): Set a custom executor for asynchronous running of simulation jobs (Default: None). * `max_job_size` (int or None): If the number of run circuits exceeds this value simulation will be run as a set of of sub-jobs on the executor. If `None` simulation of all circuits are submitted to the executor as a single job (Default: None). @@ -136,46 +144,228 @@ This method should initialize the module and its configuration, and raise an exc **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. -* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. -* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults#qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. -* **provider** ([*Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. +* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. +* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. +* **provider** ([*Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. * **backend\_options** (*dict or None*) – Optional set custom backend options. **Raises** -[**AerError**](qiskit.providers.aer.AerError#qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | -| [`available_devices`](qiskit.providers.aer.AerSimulator.available_devices#qiskit.providers.aer.AerSimulator.available_devices "qiskit.providers.aer.AerSimulator.available_devices") | Return the available simulation methods. | -| [`available_methods`](qiskit.providers.aer.AerSimulator.available_methods#qiskit.providers.aer.AerSimulator.available_methods "qiskit.providers.aer.AerSimulator.available_methods") | Return the available simulation methods. | -| [`clear_options`](qiskit.providers.aer.AerSimulator.clear_options#qiskit.providers.aer.AerSimulator.clear_options "qiskit.providers.aer.AerSimulator.clear_options") | Reset the simulator options to default values. | -| [`configuration`](qiskit.providers.aer.AerSimulator.configuration#qiskit.providers.aer.AerSimulator.configuration "qiskit.providers.aer.AerSimulator.configuration") | Return the simulator backend configuration. | -| [`defaults`](qiskit.providers.aer.AerSimulator.defaults#qiskit.providers.aer.AerSimulator.defaults "qiskit.providers.aer.AerSimulator.defaults") | Return the simulator backend pulse defaults. | -| [`from_backend`](qiskit.providers.aer.AerSimulator.from_backend#qiskit.providers.aer.AerSimulator.from_backend "qiskit.providers.aer.AerSimulator.from_backend") | Initialize simulator from backend. | -| [`name`](qiskit.providers.aer.AerSimulator.name#qiskit.providers.aer.AerSimulator.name "qiskit.providers.aer.AerSimulator.name") | Format backend name string for simulator | -| [`properties`](qiskit.providers.aer.AerSimulator.properties#qiskit.providers.aer.AerSimulator.properties "qiskit.providers.aer.AerSimulator.properties") | Return the simulator backend properties if set. | -| [`provider`](qiskit.providers.aer.AerSimulator.provider#qiskit.providers.aer.AerSimulator.provider "qiskit.providers.aer.AerSimulator.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.aer.AerSimulator.run#qiskit.providers.aer.AerSimulator.run "qiskit.providers.aer.AerSimulator.run") | Run a qobj on the backend. | -| [`set_option`](qiskit.providers.aer.AerSimulator.set_option#qiskit.providers.aer.AerSimulator.set_option "qiskit.providers.aer.AerSimulator.set_option") | Special handling for setting backend options. | -| [`set_options`](qiskit.providers.aer.AerSimulator.set_options#qiskit.providers.aer.AerSimulator.set_options "qiskit.providers.aer.AerSimulator.set_options") | Set the simulator options | -| [`status`](qiskit.providers.aer.AerSimulator.status#qiskit.providers.aer.AerSimulator.status "qiskit.providers.aer.AerSimulator.status") | Return backend status. | +### available\_devices -## Attributes + + +`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. + +### available\_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") + +Return the available simulation methods. + +### clear\_options + + + +`AerSimulator.clear_options()` + +Reset the simulator options to default values. + +### configuration + + + +`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. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### defaults + + + +`AerSimulator.defaults()` + +Return the simulator backend pulse defaults. + +**Returns** + +**The backend pulse defaults or `None` if the** + +backend does not support pulse. + +**Return type** + +[PulseDefaults](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") + +### from\_backend + + + +`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. + +### name + + + +`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 + +### properties + + + +`AerSimulator.properties()` + +Return the simulator backend properties if set. + +**Returns** + +**The backend properties or `None` if the** + +backend does not have properties set. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`AerSimulator.provider()` + +Return the backend Provider. + +**Returns** +the Provider responsible for the backend. +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + + +`AerSimulator.run(circuits, validate=False, parameter_binds=None, **run_options)` + +Run a qobj on the backend. + +**Parameters** + +* **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list*) – The QuantumCircuit (or list of QuantumCircuit objects) to run +* **validate** (*bool*) – validate the Qobj before running (default: False). +* **parameter\_binds** (*list*) – A list of parameter binding dictionaries. See additional information (default: None). +* **run\_options** (*kwargs*) – additional run time backend options. + +**Returns** + +The simulation job. + +**Return type** + +[AerJob](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – If `parameter_binds` is specified with a qobj input or has a length mismatch with the number of circuits. + +#### Additional Information: + +* Each parameter binding dictionary is of the form: + + ```python + { + param_a: [val_1, val_2], + param_b: [val_3, val_1], + } + ``` + + for all parameters in that circuit. The length of the value list must be the same for all parameters, and the number of parameter dictionaries in the list must match the length of `circuits` (if `circuits` is a single `QuantumCircuit` object it should a list of length 1). + +* kwarg options specified in `run_options` will temporarily override any set options of the same name for the current run. + +**Raises** + +**ValueError** – if run is not implemented + +### set\_option + + + +`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. + +This method should be extended by sub classes to update special option values. + +**Parameters** + +* **key** (*str*) – key to update +* **value** (*any*) – value to update. + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if key is ‘method’ and val isn’t in available methods. + +### set\_options + + + +`AerSimulator.set_options(**fields)` + +Set the simulator options + +### status + + + +`AerSimulator.status()` + +Return backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.AerSimulator.run#qiskit.providers.aer.AerSimulator.run "qiskit.providers.aer.AerSimulator.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.AerSimulator#run "qiskit.providers.aer.AerSimulator.run") method. + ### version `= 1` + 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 eca79b1294b..35c5903ba27 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.PulseSimulator.md @@ -1,18 +1,26 @@ -# PulseSimulator +--- +title: PulseSimulator +description: API reference for qiskit.providers.aer.PulseSimulator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.PulseSimulator +--- +# PulseSimulator + -`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)` +`PulseSimulator(configuration=None, properties=None, defaults=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/pulse_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` Pulse schedule simulator backend. -The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. +The `PulseSimulator` simulates continuous time Hamiltonian dynamics of a quantum system, with controls specified by pulse `Schedule` objects, and the model of the physical system specified by [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") objects. Results are returned in the same format as when jobs are submitted to actual devices. **Examples** -The minimal information a `PulseSimulator` needs to simulate is a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel"), which can be supplied either by setting the backend option before calling `run`, e.g.: +The minimal information a `PulseSimulator` needs to simulate is a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel"), which can be supplied either by setting the backend option before calling `run`, e.g.: ```python backend_sim = qiskit.providers.aer.PulseSimulator() @@ -47,11 +55,11 @@ pulse_qobj = assemble(schedules, backend=armonk_sim) armonk_sim.run(pulse_qobj) ``` -In the above example, the `PulseSimulator` copies all configuration and default data from `FakeArmonk()`, and as such has the same affect as `FakeArmonk()` when passed as an argument to `assemble`. Furthermore it constructs a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") from the model details in the supplied backend, which is then used in simulation. +In the above example, the `PulseSimulator` copies all configuration and default data from `FakeArmonk()`, and as such has the same affect as `FakeArmonk()` when passed as an argument to `assemble`. Furthermore it constructs a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") from the model details in the supplied backend, which is then used in simulation. **Supported PulseQobj parameters** -* `qubit_lo_freq`: Local oscillator frequencies for each `DriveChannel`. Defaults to either the value given in the [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel"), or is calculated directly from the Hamiltonian. +* `qubit_lo_freq`: Local oscillator frequencies for each `DriveChannel`. Defaults to either the value given in the [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel"), or is calculated directly from the Hamiltonian. * `meas_level`: Type of desired measurement output, in `[1, 2]`. `1` gives complex numbers (IQ values), and `2` gives discriminated states `|0>` and `|1>`. Defaults to `2`. @@ -67,7 +75,7 @@ In the above example, the `PulseSimulator` copies all configuration and default **Simulation details** -The simulator uses the `zvode` differential equation solver method through `scipy`. Simulation is performed in the rotating frame of the diagonal of the drift Hamiltonian contained in the [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel"). Measurements are performed in the dressed basis of the drift Hamiltonian. +The simulator uses the `zvode` differential equation solver method through `scipy`. Simulation is performed in the rotating frame of the diagonal of the drift Hamiltonian contained in the [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel"). Measurements are performed in the dressed basis of the drift Hamiltonian. **Other options** @@ -81,44 +89,189 @@ This method should initialize the module and its configuration, and raise an exc **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. -* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. -* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults#qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. -* **provider** ([*Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. +* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. +* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. +* **provider** ([*Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. * **backend\_options** (*dict or None*) – Optional set custom backend options. **Raises** -[**AerError**](qiskit.providers.aer.AerError#qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | -| [`clear_options`](qiskit.providers.aer.PulseSimulator.clear_options#qiskit.providers.aer.PulseSimulator.clear_options "qiskit.providers.aer.PulseSimulator.clear_options") | Reset the simulator options to default values. | -| [`configuration`](qiskit.providers.aer.PulseSimulator.configuration#qiskit.providers.aer.PulseSimulator.configuration "qiskit.providers.aer.PulseSimulator.configuration") | Return the simulator backend configuration. | -| [`defaults`](qiskit.providers.aer.PulseSimulator.defaults#qiskit.providers.aer.PulseSimulator.defaults "qiskit.providers.aer.PulseSimulator.defaults") | Return the simulator backend pulse defaults. | -| [`from_backend`](qiskit.providers.aer.PulseSimulator.from_backend#qiskit.providers.aer.PulseSimulator.from_backend "qiskit.providers.aer.PulseSimulator.from_backend") | Initialize simulator from backend. | -| [`name`](qiskit.providers.aer.PulseSimulator.name#qiskit.providers.aer.PulseSimulator.name "qiskit.providers.aer.PulseSimulator.name") | Return the backend name. | -| [`properties`](qiskit.providers.aer.PulseSimulator.properties#qiskit.providers.aer.PulseSimulator.properties "qiskit.providers.aer.PulseSimulator.properties") | Return the simulator backend properties if set. | -| [`provider`](qiskit.providers.aer.PulseSimulator.provider#qiskit.providers.aer.PulseSimulator.provider "qiskit.providers.aer.PulseSimulator.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.aer.PulseSimulator.run#qiskit.providers.aer.PulseSimulator.run "qiskit.providers.aer.PulseSimulator.run") | Run a qobj on the backend. | -| [`set_option`](qiskit.providers.aer.PulseSimulator.set_option#qiskit.providers.aer.PulseSimulator.set_option "qiskit.providers.aer.PulseSimulator.set_option") | Set pulse simulation options and update backend. | -| [`set_options`](qiskit.providers.aer.PulseSimulator.set_options#qiskit.providers.aer.PulseSimulator.set_options "qiskit.providers.aer.PulseSimulator.set_options") | Set the simulator options | -| [`status`](qiskit.providers.aer.PulseSimulator.status#qiskit.providers.aer.PulseSimulator.status "qiskit.providers.aer.PulseSimulator.status") | Return backend status. | +### clear\_options -## Attributes + + +`PulseSimulator.clear_options()` + +Reset the simulator options to default values. + +### configuration + + + +`PulseSimulator.configuration()` + +Return the simulator backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### defaults + + + +`PulseSimulator.defaults()` + +Return the simulator backend pulse defaults. + +**Returns** + +**The backend pulse defaults or `None` if the** + +backend does not support pulse. + +**Return type** + +[PulseDefaults](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") + +### from\_backend + + + +`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. + +### name + + + +`PulseSimulator.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`PulseSimulator.properties()` + +Return the simulator backend properties if set. + +**Returns** + +**The backend properties or `None` if the** + +backend does not have properties set. + +**Return type** +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") +### provider + + + +`PulseSimulator.provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + + +`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. + +**Parameters** + +* **schedules** ([*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or list*) – The pulse [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") (or list of `Schedule` objects) to be executed. +* **validate** (*bool*) – validate the Qobj before running (default: True). +* **run\_options** (*kwargs*) – additional run time backend options. + +**Returns** + +The simulation job. + +**Return type** + +[AerJob](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") + +#### Additional Information: + +* kwarg options specified in `run_options` will override options of the same kwarg specified in the simulator options, the `backend_options` and the `Qobj.config`. + +### set\_option + + + +`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. + +### set\_options + + + +`PulseSimulator.set_options(**fields)` + +Set the simulator options + +### status + + + +`PulseSimulator.status()` + +Return backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.PulseSimulator.run#qiskit.providers.aer.PulseSimulator.run "qiskit.providers.aer.PulseSimulator.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.PulseSimulator#run "qiskit.providers.aer.PulseSimulator.run") method. + ### version `= 1` + 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 1704ac320dc..9bccd150d8c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.QasmSimulator.md @@ -1,8 +1,16 @@ -# QasmSimulator +--- +title: QasmSimulator +description: API reference for qiskit.providers.aer.QasmSimulator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.QasmSimulator +--- +# QasmSimulator + -`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)` +`QasmSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/qasm_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -10,9 +18,9 @@ Noisy quantum circuit simulator backend. **Configurable Options** -The QasmSimulator supports multiple simulation methods and configurable options for each simulation method. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.QasmSimulator.set_options#qiskit.providers.aer.QasmSimulator.set_options "qiskit.providers.aer.QasmSimulator.set_options") method. +The QasmSimulator supports multiple simulation methods and configurable options for each simulation method. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.QasmSimulator#set_options "qiskit.providers.aer.QasmSimulator.set_options") method. -Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.QasmSimulator.run#qiskit.providers.aer.QasmSimulator.run "qiskit.providers.aer.QasmSimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. +Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.QasmSimulator#run "qiskit.providers.aer.QasmSimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. For example, to configure a density matrix simulator with a custom noise model to use for every execution @@ -24,7 +32,7 @@ backend = QasmSimulator(method='density_matrix', **Simulating an IBMQ Backend** -The simulator can be automatically configured to mimic an IBMQ backend using the [`from_backend()`](qiskit.providers.aer.QasmSimulator.from_backend#qiskit.providers.aer.QasmSimulator.from_backend "qiskit.providers.aer.QasmSimulator.from_backend") method. This will configure the simulator to use the basic device `NoiseModel` for that backend, and the same basis gates and coupling map. +The simulator can be automatically configured to mimic an IBMQ backend using the [`from_backend()`](qiskit.providers.aer.QasmSimulator#from_backend "qiskit.providers.aer.QasmSimulator.from_backend") method. This will configure the simulator to use the basic device `NoiseModel` for that backend, and the same basis gates and coupling map. ```python backend = QasmSimulator.from_backend(backend) @@ -47,8 +55,8 @@ The simulation method is set using the `method` kwarg. Supported simulation meth The following simulator specific backend options are supported -* `method` (str): Set the simulation method (Default: `"automatic"`). Use [`available_methods()`](qiskit.providers.aer.QasmSimulator.available_methods#qiskit.providers.aer.QasmSimulator.available_methods "qiskit.providers.aer.QasmSimulator.available_methods") to return a list of all availabe methods. -* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.QasmSimulator.available_devices#qiskit.providers.aer.QasmSimulator.available_devices "qiskit.providers.aer.QasmSimulator.available_devices") to return a list of devices supported on the current system. +* `method` (str): Set the simulation method (Default: `"automatic"`). Use [`available_methods()`](qiskit.providers.aer.QasmSimulator#available_methods "qiskit.providers.aer.QasmSimulator.available_methods") to return a list of all availabe methods. +* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.QasmSimulator#available_devices "qiskit.providers.aer.QasmSimulator.available_devices") to return a list of devices supported on the current system. * `precision` (str): Set the floating point precision for certain simulation methods to either `"single"` or `"double"` precision (default: `"double"`). * `executor` (futures.Executor): Set a custom executor for asynchronous running of simulation jobs (Default: None). * `max_job_size` (int or None): If the number of run circuits exceeds this value simulation will be run as a set of of sub-jobs on the executor. If `None` simulation of all circuits are submitted to the executor as a single job (Default: None). @@ -115,46 +123,236 @@ This method should initialize the module and its configuration, and raise an exc **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. -* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. -* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults#qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. -* **provider** ([*Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. +* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. +* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. +* **provider** ([*Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. * **backend\_options** (*dict or None*) – Optional set custom backend options. **Raises** -[**AerError**](qiskit.providers.aer.AerError#qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -| [`available_devices`](qiskit.providers.aer.QasmSimulator.available_devices#qiskit.providers.aer.QasmSimulator.available_devices "qiskit.providers.aer.QasmSimulator.available_devices") | Return the available simulation methods. | -| [`available_methods`](qiskit.providers.aer.QasmSimulator.available_methods#qiskit.providers.aer.QasmSimulator.available_methods "qiskit.providers.aer.QasmSimulator.available_methods") | Return the available simulation methods. | -| [`clear_options`](qiskit.providers.aer.QasmSimulator.clear_options#qiskit.providers.aer.QasmSimulator.clear_options "qiskit.providers.aer.QasmSimulator.clear_options") | Reset the simulator options to default values. | -| [`configuration`](qiskit.providers.aer.QasmSimulator.configuration#qiskit.providers.aer.QasmSimulator.configuration "qiskit.providers.aer.QasmSimulator.configuration") | Return the simulator backend configuration. | -| [`defaults`](qiskit.providers.aer.QasmSimulator.defaults#qiskit.providers.aer.QasmSimulator.defaults "qiskit.providers.aer.QasmSimulator.defaults") | Return the simulator backend pulse defaults. | -| [`from_backend`](qiskit.providers.aer.QasmSimulator.from_backend#qiskit.providers.aer.QasmSimulator.from_backend "qiskit.providers.aer.QasmSimulator.from_backend") | Initialize simulator from backend. | -| [`name`](qiskit.providers.aer.QasmSimulator.name#qiskit.providers.aer.QasmSimulator.name "qiskit.providers.aer.QasmSimulator.name") | Return the backend name. | -| [`properties`](qiskit.providers.aer.QasmSimulator.properties#qiskit.providers.aer.QasmSimulator.properties "qiskit.providers.aer.QasmSimulator.properties") | Return the simulator backend properties if set. | -| [`provider`](qiskit.providers.aer.QasmSimulator.provider#qiskit.providers.aer.QasmSimulator.provider "qiskit.providers.aer.QasmSimulator.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.aer.QasmSimulator.run#qiskit.providers.aer.QasmSimulator.run "qiskit.providers.aer.QasmSimulator.run") | Run a qobj on the backend. | -| [`set_option`](qiskit.providers.aer.QasmSimulator.set_option#qiskit.providers.aer.QasmSimulator.set_option "qiskit.providers.aer.QasmSimulator.set_option") | Special handling for setting backend options. | -| [`set_options`](qiskit.providers.aer.QasmSimulator.set_options#qiskit.providers.aer.QasmSimulator.set_options "qiskit.providers.aer.QasmSimulator.set_options") | Set the simulator options | -| [`status`](qiskit.providers.aer.QasmSimulator.status#qiskit.providers.aer.QasmSimulator.status "qiskit.providers.aer.QasmSimulator.status") | Return backend status. | +### available\_devices -## Attributes + + +`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. + +### available\_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") + +Return the available simulation methods. + +### clear\_options + + + +`QasmSimulator.clear_options()` + +Reset the simulator options to default values. + +### configuration + + + +`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. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### defaults + + + +`QasmSimulator.defaults()` + +Return the simulator backend pulse defaults. + +**Returns** + +**The backend pulse defaults or `None` if the** + +backend does not support pulse. + +**Return type** + +[PulseDefaults](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") + +### from\_backend + + + +`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. + +### name + + + +`QasmSimulator.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`QasmSimulator.properties()` + +Return the simulator backend properties if set. + +**Returns** + +**The backend properties or `None` if the** + +backend does not have properties set. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`QasmSimulator.provider()` +Return the backend Provider. +**Returns** + +the Provider responsible for the backend. + +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + + +`QasmSimulator.run(circuits, validate=False, parameter_binds=None, **run_options)` + +Run a qobj on the backend. + +**Parameters** + +* **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list*) – The QuantumCircuit (or list of QuantumCircuit objects) to run +* **validate** (*bool*) – validate the Qobj before running (default: False). +* **parameter\_binds** (*list*) – A list of parameter binding dictionaries. See additional information (default: None). +* **run\_options** (*kwargs*) – additional run time backend options. + +**Returns** + +The simulation job. + +**Return type** + +[AerJob](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – If `parameter_binds` is specified with a qobj input or has a length mismatch with the number of circuits. + +#### Additional Information: + +* Each parameter binding dictionary is of the form: + + ```python + { + param_a: [val_1, val_2], + param_b: [val_3, val_1], + } + ``` + + for all parameters in that circuit. The length of the value list must be the same for all parameters, and the number of parameter dictionaries in the list must match the length of `circuits` (if `circuits` is a single `QuantumCircuit` object it should a list of length 1). + +* kwarg options specified in `run_options` will temporarily override any set options of the same name for the current run. + +**Raises** + +**ValueError** – if run is not implemented + +### set\_option + + + +`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. + +This method should be extended by sub classes to update special option values. + +**Parameters** + +* **key** (*str*) – key to update +* **value** (*any*) – value to update. + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if key is ‘method’ and val isn’t in available methods. + +### set\_options + + + +`QasmSimulator.set_options(**fields)` + +Set the simulator options + +### status + + + +`QasmSimulator.status()` + +Return backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.QasmSimulator.run#qiskit.providers.aer.QasmSimulator.run "qiskit.providers.aer.QasmSimulator.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.QasmSimulator#run "qiskit.providers.aer.QasmSimulator.run") method. + ### version `= 1` + 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 5e4539ff5de..e0deb4d929b 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.StatevectorSimulator.md @@ -1,8 +1,16 @@ -# StatevectorSimulator +--- +title: StatevectorSimulator +description: API reference for qiskit.providers.aer.StatevectorSimulator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.StatevectorSimulator +--- +# StatevectorSimulator + -`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)` +`StatevectorSimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/statevector_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -10,9 +18,9 @@ Ideal quantum circuit statevector simulator **Configurable Options** -The StatevectorSimulator supports CPU and GPU simulation methods and additional configurable options. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.StatevectorSimulator.set_options#qiskit.providers.aer.StatevectorSimulator.set_options "qiskit.providers.aer.StatevectorSimulator.set_options") method. +The StatevectorSimulator supports CPU and GPU simulation methods and additional configurable options. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.StatevectorSimulator#set_options "qiskit.providers.aer.StatevectorSimulator.set_options") method. -Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.StatevectorSimulator.run#qiskit.providers.aer.StatevectorSimulator.run "qiskit.providers.aer.StatevectorSimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. +Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.StatevectorSimulator#run "qiskit.providers.aer.StatevectorSimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. For example, to configure a a single-precision simulator @@ -24,7 +32,7 @@ backend = StatevectorSimulator(precision='single') The following configurable backend options are supported -* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.StatevectorSimulator.available_devices#qiskit.providers.aer.StatevectorSimulator.available_devices "qiskit.providers.aer.StatevectorSimulator.available_devices") to return a list of devices supported on the current system. +* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.StatevectorSimulator#available_devices "qiskit.providers.aer.StatevectorSimulator.available_devices") to return a list of devices supported on the current system. * `method` (str): \[DEPRECATED] Set the simulation method supported methods are `"statevector"` for CPU simulation, and `"statevector_gpu"` for GPU simulation. This option has been deprecated, use the `device` option to set “CPU” or “GPU” simulation instead. * `precision` (str): Set the floating point precision for certain simulation methods to either `"single"` or `"double"` precision (default: `"double"`). * `executor` (futures.Executor): Set a custom executor for asynchronous running of simulation jobs (Default: None). @@ -49,45 +57,228 @@ This method should initialize the module and its configuration, and raise an exc **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. -* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. -* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults#qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. -* **provider** ([*Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. +* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. +* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. +* **provider** ([*Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. * **backend\_options** (*dict or None*) – Optional set custom backend options. **Raises** -[**AerError**](qiskit.providers.aer.AerError#qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | -| [`available_devices`](qiskit.providers.aer.StatevectorSimulator.available_devices#qiskit.providers.aer.StatevectorSimulator.available_devices "qiskit.providers.aer.StatevectorSimulator.available_devices") | Return the available simulation methods. | -| [`available_methods`](qiskit.providers.aer.StatevectorSimulator.available_methods#qiskit.providers.aer.StatevectorSimulator.available_methods "qiskit.providers.aer.StatevectorSimulator.available_methods") | Return the available simulation methods. | -| [`clear_options`](qiskit.providers.aer.StatevectorSimulator.clear_options#qiskit.providers.aer.StatevectorSimulator.clear_options "qiskit.providers.aer.StatevectorSimulator.clear_options") | Reset the simulator options to default values. | -| [`configuration`](qiskit.providers.aer.StatevectorSimulator.configuration#qiskit.providers.aer.StatevectorSimulator.configuration "qiskit.providers.aer.StatevectorSimulator.configuration") | Return the simulator backend configuration. | -| [`defaults`](qiskit.providers.aer.StatevectorSimulator.defaults#qiskit.providers.aer.StatevectorSimulator.defaults "qiskit.providers.aer.StatevectorSimulator.defaults") | Return the simulator backend pulse defaults. | -| [`name`](qiskit.providers.aer.StatevectorSimulator.name#qiskit.providers.aer.StatevectorSimulator.name "qiskit.providers.aer.StatevectorSimulator.name") | Return the backend name. | -| [`properties`](qiskit.providers.aer.StatevectorSimulator.properties#qiskit.providers.aer.StatevectorSimulator.properties "qiskit.providers.aer.StatevectorSimulator.properties") | Return the simulator backend properties if set. | -| [`provider`](qiskit.providers.aer.StatevectorSimulator.provider#qiskit.providers.aer.StatevectorSimulator.provider "qiskit.providers.aer.StatevectorSimulator.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.aer.StatevectorSimulator.run#qiskit.providers.aer.StatevectorSimulator.run "qiskit.providers.aer.StatevectorSimulator.run") | Run a qobj on the backend. | -| [`set_option`](qiskit.providers.aer.StatevectorSimulator.set_option#qiskit.providers.aer.StatevectorSimulator.set_option "qiskit.providers.aer.StatevectorSimulator.set_option") | Special handling for setting backend options. | -| [`set_options`](qiskit.providers.aer.StatevectorSimulator.set_options#qiskit.providers.aer.StatevectorSimulator.set_options "qiskit.providers.aer.StatevectorSimulator.set_options") | Set the simulator options | -| [`status`](qiskit.providers.aer.StatevectorSimulator.status#qiskit.providers.aer.StatevectorSimulator.status "qiskit.providers.aer.StatevectorSimulator.status") | Return backend status. | +### available\_devices -## Attributes + + +`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. + +### available\_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") + +Return the available simulation methods. + +### clear\_options + + + +`StatevectorSimulator.clear_options()` + +Reset the simulator options to default values. + +### configuration + + + +`StatevectorSimulator.configuration()` + +Return the simulator backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### defaults + + + +`StatevectorSimulator.defaults()` + +Return the simulator backend pulse defaults. + +**Returns** + +**The backend pulse defaults or `None` if the** + +backend does not support pulse. + +**Return type** + +[PulseDefaults](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") + +### name + + + +`StatevectorSimulator.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`StatevectorSimulator.properties()` + +Return the simulator backend properties if set. + +**Returns** + +**The backend properties or `None` if the** + +backend does not have properties set. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`StatevectorSimulator.provider()` + +Return the backend Provider. + +**Returns** +the Provider responsible for the backend. +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + + +`StatevectorSimulator.run(circuits, validate=False, parameter_binds=None, **run_options)` + +Run a qobj on the backend. + +**Parameters** + +* **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list*) – The QuantumCircuit (or list of QuantumCircuit objects) to run +* **validate** (*bool*) – validate the Qobj before running (default: False). +* **parameter\_binds** (*list*) – A list of parameter binding dictionaries. See additional information (default: None). +* **run\_options** (*kwargs*) – additional run time backend options. + +**Returns** + +The simulation job. + +**Return type** + +[AerJob](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – If `parameter_binds` is specified with a qobj input or has a length mismatch with the number of circuits. + +#### Additional Information: + +* Each parameter binding dictionary is of the form: + + ```python + { + param_a: [val_1, val_2], + param_b: [val_3, val_1], + } + ``` + + for all parameters in that circuit. The length of the value list must be the same for all parameters, and the number of parameter dictionaries in the list must match the length of `circuits` (if `circuits` is a single `QuantumCircuit` object it should a list of length 1). + +* kwarg options specified in `run_options` will temporarily override any set options of the same name for the current run. + +**Raises** + +**ValueError** – if run is not implemented + +### set\_option + + + +`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. + +This method should be extended by sub classes to update special option values. + +**Parameters** + +* **key** (*str*) – key to update +* **value** (*any*) – value to update. + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if key is ‘method’ and val isn’t in available methods. + +### set\_options + + + +`StatevectorSimulator.set_options(**fields)` + +Set the simulator options + +### status + + + +`StatevectorSimulator.status()` + +Return backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.StatevectorSimulator.run#qiskit.providers.aer.StatevectorSimulator.run "qiskit.providers.aer.StatevectorSimulator.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.StatevectorSimulator#run "qiskit.providers.aer.StatevectorSimulator.run") method. + ### version `= 1` + 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 c6819fda2c6..fe9fd1e7e12 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.md +++ b/docs/api/qiskit/0.32/qiskit.providers.aer.UnitarySimulator.md @@ -1,8 +1,16 @@ -# UnitarySimulator +--- +title: UnitarySimulator +description: API reference for qiskit.providers.aer.UnitarySimulator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.UnitarySimulator +--- +# UnitarySimulator + -`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)` +`UnitarySimulator(configuration=None, properties=None, provider=None, **backend_options)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/backends/unitary_simulator.py "view source code") Bases: `qiskit.providers.aer.backends.aerbackend.AerBackend` @@ -10,9 +18,9 @@ Ideal quantum circuit unitary simulator. **Configurable Options** -The UnitarySimulator supports CPU and GPU simulation methods and additional configurable options. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.UnitarySimulator.set_options#qiskit.providers.aer.UnitarySimulator.set_options "qiskit.providers.aer.UnitarySimulator.set_options") method. +The UnitarySimulator supports CPU and GPU simulation methods and additional configurable options. These may be set using the appropriate kwargs during initialization. They can also be set of updated using the [`set_options()`](qiskit.providers.aer.UnitarySimulator#set_options "qiskit.providers.aer.UnitarySimulator.set_options") method. -Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.UnitarySimulator.run#qiskit.providers.aer.UnitarySimulator.run "qiskit.providers.aer.UnitarySimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. +Run-time options may also be specified as kwargs using the [`run()`](qiskit.providers.aer.UnitarySimulator#run "qiskit.providers.aer.UnitarySimulator.run") method. These will not be stored in the backend and will only apply to that execution. They will also override any previously set options. For example, to configure a a single-precision simulator @@ -24,7 +32,7 @@ backend = UnitarySimulator(precision='single') The following configurable backend options are supported -* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.UnitarySimulator.available_devices#qiskit.providers.aer.UnitarySimulator.available_devices "qiskit.providers.aer.UnitarySimulator.available_devices") to return a list of devices supported on the current system. +* `device` (str): Set the simulation device (Default: `"CPU"`). Use [`available_devices()`](qiskit.providers.aer.UnitarySimulator#available_devices "qiskit.providers.aer.UnitarySimulator.available_devices") to return a list of devices supported on the current system. * `method` (str): \[DEPRECATED] Set the simulation method supported methods are `"unitary"` for CPU simulation, and `"unitary_gpu"` for GPU simulation. This option has been deprecated, use the `device` option to set “CPU” or “GPU” simulation instead. * `precision` (str): Set the floating point precision for certain simulation methods to either `"single"` or `"double"` precision (default: `"double"`). * `executor` (futures.Executor): Set a custom executor for asynchronous running of simulation jobs (Default: None). @@ -50,45 +58,228 @@ This method should initialize the module and its configuration, and raise an exc **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. -* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. -* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults#qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. -* **provider** ([*Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – backend configuration. +* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") *or None*) – Optional, backend properties. +* **defaults** ([*PulseDefaults*](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") *or None*) – Optional, backend pulse defaults. +* **provider** ([*Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optional, provider responsible for this backend. * **backend\_options** (*dict or None*) – Optional set custom backend options. **Raises** -[**AerError**](qiskit.providers.aer.AerError#qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if there is no name in the configuration ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- | -| [`available_devices`](qiskit.providers.aer.UnitarySimulator.available_devices#qiskit.providers.aer.UnitarySimulator.available_devices "qiskit.providers.aer.UnitarySimulator.available_devices") | Return the available simulation methods. | -| [`available_methods`](qiskit.providers.aer.UnitarySimulator.available_methods#qiskit.providers.aer.UnitarySimulator.available_methods "qiskit.providers.aer.UnitarySimulator.available_methods") | Return the available simulation methods. | -| [`clear_options`](qiskit.providers.aer.UnitarySimulator.clear_options#qiskit.providers.aer.UnitarySimulator.clear_options "qiskit.providers.aer.UnitarySimulator.clear_options") | Reset the simulator options to default values. | -| [`configuration`](qiskit.providers.aer.UnitarySimulator.configuration#qiskit.providers.aer.UnitarySimulator.configuration "qiskit.providers.aer.UnitarySimulator.configuration") | Return the simulator backend configuration. | -| [`defaults`](qiskit.providers.aer.UnitarySimulator.defaults#qiskit.providers.aer.UnitarySimulator.defaults "qiskit.providers.aer.UnitarySimulator.defaults") | Return the simulator backend pulse defaults. | -| [`name`](qiskit.providers.aer.UnitarySimulator.name#qiskit.providers.aer.UnitarySimulator.name "qiskit.providers.aer.UnitarySimulator.name") | Return the backend name. | -| [`properties`](qiskit.providers.aer.UnitarySimulator.properties#qiskit.providers.aer.UnitarySimulator.properties "qiskit.providers.aer.UnitarySimulator.properties") | Return the simulator backend properties if set. | -| [`provider`](qiskit.providers.aer.UnitarySimulator.provider#qiskit.providers.aer.UnitarySimulator.provider "qiskit.providers.aer.UnitarySimulator.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.aer.UnitarySimulator.run#qiskit.providers.aer.UnitarySimulator.run "qiskit.providers.aer.UnitarySimulator.run") | Run a qobj on the backend. | -| [`set_option`](qiskit.providers.aer.UnitarySimulator.set_option#qiskit.providers.aer.UnitarySimulator.set_option "qiskit.providers.aer.UnitarySimulator.set_option") | Special handling for setting backend options. | -| [`set_options`](qiskit.providers.aer.UnitarySimulator.set_options#qiskit.providers.aer.UnitarySimulator.set_options "qiskit.providers.aer.UnitarySimulator.set_options") | Set the simulator options | -| [`status`](qiskit.providers.aer.UnitarySimulator.status#qiskit.providers.aer.UnitarySimulator.status "qiskit.providers.aer.UnitarySimulator.status") | Return backend status. | +### available\_devices -## Attributes + + +`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. + +### available\_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") + +Return the available simulation methods. + +### clear\_options + + + +`UnitarySimulator.clear_options()` + +Reset the simulator options to default values. + +### configuration + + + +`UnitarySimulator.configuration()` + +Return the simulator backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### defaults + + + +`UnitarySimulator.defaults()` + +Return the simulator backend pulse defaults. + +**Returns** + +**The backend pulse defaults or `None` if the** + +backend does not support pulse. + +**Return type** + +[PulseDefaults](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") + +### name + + + +`UnitarySimulator.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`UnitarySimulator.properties()` + +Return the simulator backend properties if set. + +**Returns** + +**The backend properties or `None` if the** + +backend does not have properties set. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`UnitarySimulator.provider()` + +Return the backend Provider. + +**Returns** +the Provider responsible for the backend. +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + + +`UnitarySimulator.run(circuits, validate=False, parameter_binds=None, **run_options)` + +Run a qobj on the backend. + +**Parameters** + +* **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list*) – The QuantumCircuit (or list of QuantumCircuit objects) to run +* **validate** (*bool*) – validate the Qobj before running (default: False). +* **parameter\_binds** (*list*) – A list of parameter binding dictionaries. See additional information (default: None). +* **run\_options** (*kwargs*) – additional run time backend options. + +**Returns** + +The simulation job. + +**Return type** + +[AerJob](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – If `parameter_binds` is specified with a qobj input or has a length mismatch with the number of circuits. + +#### Additional Information: + +* Each parameter binding dictionary is of the form: + + ```python + { + param_a: [val_1, val_2], + param_b: [val_3, val_1], + } + ``` + + for all parameters in that circuit. The length of the value list must be the same for all parameters, and the number of parameter dictionaries in the list must match the length of `circuits` (if `circuits` is a single `QuantumCircuit` object it should a list of length 1). + +* kwarg options specified in `run_options` will temporarily override any set options of the same name for the current run. + +**Raises** + +**ValueError** – if run is not implemented + +### set\_option + + + +`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. + +This method should be extended by sub classes to update special option values. + +**Parameters** + +* **key** (*str*) – key to update +* **value** (*any*) – value to update. + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if key is ‘method’ and val isn’t in available methods. + +### set\_options + + + +`UnitarySimulator.set_options(**fields)` + +Set the simulator options + +### status + + + +`UnitarySimulator.status()` + +Return backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.UnitarySimulator.run#qiskit.providers.aer.UnitarySimulator.run "qiskit.providers.aer.UnitarySimulator.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.aer.UnitarySimulator#run "qiskit.providers.aer.UnitarySimulator.run") method. + ### version `= 1` + 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 2574c2cc5d8..bd09b928a2b 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 @@ -1,8 +1,16 @@ -# Snapshot +--- +title: Snapshot +description: API reference for qiskit.providers.aer.extensions.Snapshot +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.extensions.Snapshot +--- +# Snapshot + -`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)` +`Snapshot(label, snapshot_type='statevector', num_qubits=0, num_clbits=0, params=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/extensions/snapshot.py "view source code") Bases: `qiskit.circuit.instruction.Instruction` @@ -28,63 +36,238 @@ Create new snapshot instruction. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.extensions.Snapshot.add_decomposition#qiskit.providers.aer.extensions.Snapshot.add_decomposition "qiskit.providers.aer.extensions.Snapshot.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.extensions.Snapshot.assemble#qiskit.providers.aer.extensions.Snapshot.assemble "qiskit.providers.aer.extensions.Snapshot.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.extensions.Snapshot.broadcast_arguments#qiskit.providers.aer.extensions.Snapshot.broadcast_arguments "qiskit.providers.aer.extensions.Snapshot.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.extensions.Snapshot.c_if#qiskit.providers.aer.extensions.Snapshot.c_if "qiskit.providers.aer.extensions.Snapshot.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.extensions.Snapshot.copy#qiskit.providers.aer.extensions.Snapshot.copy "qiskit.providers.aer.extensions.Snapshot.copy") | Copy of the instruction. | -| [`define_snapshot_register`](qiskit.providers.aer.extensions.Snapshot.define_snapshot_register#qiskit.providers.aer.extensions.Snapshot.define_snapshot_register "qiskit.providers.aer.extensions.Snapshot.define_snapshot_register") | Defines qubits to snapshot for all snapshot methods | -| [`inverse`](qiskit.providers.aer.extensions.Snapshot.inverse#qiskit.providers.aer.extensions.Snapshot.inverse "qiskit.providers.aer.extensions.Snapshot.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.extensions.Snapshot.is_parameterized#qiskit.providers.aer.extensions.Snapshot.is_parameterized "qiskit.providers.aer.extensions.Snapshot.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.extensions.Snapshot.mirror#qiskit.providers.aer.extensions.Snapshot.mirror "qiskit.providers.aer.extensions.Snapshot.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.extensions.Snapshot.qasm#qiskit.providers.aer.extensions.Snapshot.qasm "qiskit.providers.aer.extensions.Snapshot.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.extensions.Snapshot.repeat#qiskit.providers.aer.extensions.Snapshot.repeat "qiskit.providers.aer.extensions.Snapshot.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.extensions.Snapshot.reverse_ops#qiskit.providers.aer.extensions.Snapshot.reverse_ops "qiskit.providers.aer.extensions.Snapshot.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.extensions.Snapshot.soft_compare#qiskit.providers.aer.extensions.Snapshot.soft_compare "qiskit.providers.aer.extensions.Snapshot.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.extensions.Snapshot.validate_parameter#qiskit.providers.aer.extensions.Snapshot.validate_parameter "qiskit.providers.aer.extensions.Snapshot.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`Snapshot.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`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 + +### broadcast\_arguments + + + +`Snapshot.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`Snapshot.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`Snapshot.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### define\_snapshot\_register + + + +`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 + +### inverse + + + +`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. + +### is\_parameterized + + + +`Snapshot.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`Snapshot.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** +reversed. +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`Snapshot.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`Snapshot.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`Snapshot.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`Snapshot.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`Snapshot.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label Return snapshot label - + ### params return instruction params. - + ### snapshot\_type Return snapshot type - + ### unit Get the time unit of duration. + 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 1decc164a58..79b02f0dd1c 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 @@ -1,8 +1,16 @@ -# SnapshotDensityMatrix +--- +title: SnapshotDensityMatrix +description: API reference for qiskit.providers.aer.extensions.SnapshotDensityMatrix +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.extensions.SnapshotDensityMatrix +--- +# SnapshotDensityMatrix + -`SnapshotDensityMatrix(label, num_qubits)` +`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` @@ -20,68 +28,243 @@ Create a density matrix state snapshot instruction. **ExtensionError** – if snapshot is invalid. - This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix#qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") instruction. + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveDensityMatrix`](qiskit.providers.aer.library.SaveDensityMatrix "qiskit.providers.aer.library.SaveDensityMatrix") instruction. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.add_decomposition#qiskit.providers.aer.extensions.SnapshotDensityMatrix.add_decomposition "qiskit.providers.aer.extensions.SnapshotDensityMatrix.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.assemble#qiskit.providers.aer.extensions.SnapshotDensityMatrix.assemble "qiskit.providers.aer.extensions.SnapshotDensityMatrix.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.broadcast_arguments#qiskit.providers.aer.extensions.SnapshotDensityMatrix.broadcast_arguments "qiskit.providers.aer.extensions.SnapshotDensityMatrix.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.c_if#qiskit.providers.aer.extensions.SnapshotDensityMatrix.c_if "qiskit.providers.aer.extensions.SnapshotDensityMatrix.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.copy#qiskit.providers.aer.extensions.SnapshotDensityMatrix.copy "qiskit.providers.aer.extensions.SnapshotDensityMatrix.copy") | Copy of the instruction. | -| [`define_snapshot_register`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.define_snapshot_register#qiskit.providers.aer.extensions.SnapshotDensityMatrix.define_snapshot_register "qiskit.providers.aer.extensions.SnapshotDensityMatrix.define_snapshot_register") | Defines qubits to snapshot for all snapshot methods | -| [`inverse`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.inverse#qiskit.providers.aer.extensions.SnapshotDensityMatrix.inverse "qiskit.providers.aer.extensions.SnapshotDensityMatrix.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.is_parameterized#qiskit.providers.aer.extensions.SnapshotDensityMatrix.is_parameterized "qiskit.providers.aer.extensions.SnapshotDensityMatrix.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.mirror#qiskit.providers.aer.extensions.SnapshotDensityMatrix.mirror "qiskit.providers.aer.extensions.SnapshotDensityMatrix.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.qasm#qiskit.providers.aer.extensions.SnapshotDensityMatrix.qasm "qiskit.providers.aer.extensions.SnapshotDensityMatrix.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.repeat#qiskit.providers.aer.extensions.SnapshotDensityMatrix.repeat "qiskit.providers.aer.extensions.SnapshotDensityMatrix.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.reverse_ops#qiskit.providers.aer.extensions.SnapshotDensityMatrix.reverse_ops "qiskit.providers.aer.extensions.SnapshotDensityMatrix.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.soft_compare#qiskit.providers.aer.extensions.SnapshotDensityMatrix.soft_compare "qiskit.providers.aer.extensions.SnapshotDensityMatrix.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.extensions.SnapshotDensityMatrix.validate_parameter#qiskit.providers.aer.extensions.SnapshotDensityMatrix.validate_parameter "qiskit.providers.aer.extensions.SnapshotDensityMatrix.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SnapshotDensityMatrix.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SnapshotDensityMatrix.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SnapshotDensityMatrix.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SnapshotDensityMatrix.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SnapshotDensityMatrix.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### define\_snapshot\_register + + + +`static SnapshotDensityMatrix.define_snapshot_register(circuit, label=None, qubits=None)` + +Defines qubits to snapshot for all snapshot methods + +### inverse + + + +`SnapshotDensityMatrix.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SnapshotDensityMatrix.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SnapshotDensityMatrix.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** +reversed. +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SnapshotDensityMatrix.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SnapshotDensityMatrix.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SnapshotDensityMatrix.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SnapshotDensityMatrix.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SnapshotDensityMatrix.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label Return snapshot label - + ### params return instruction params. - + ### snapshot\_type Return snapshot type - + ### unit Get the time unit of duration. + 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 69d5fbfbb2d..1677292f0f7 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 @@ -1,8 +1,16 @@ -# SnapshotExpectationValue +--- +title: SnapshotExpectationValue +description: API reference for qiskit.providers.aer.extensions.SnapshotExpectationValue +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.extensions.SnapshotExpectationValue +--- +# SnapshotExpectationValue + -`SnapshotExpectationValue(label, op, single_shot=False, variance=False)` +`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` @@ -13,7 +21,7 @@ Create an expectation value snapshot instruction. **Parameters** * **label** (*str*) – the snapshot label. -* **op** ([*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – operator to snapshot. +* **op** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – operator to snapshot. * **single\_shot** (*bool*) – return list for each shot rather than average \[Default: False] * **variance** (*bool*) – compute variance of values \[Default: False] @@ -22,68 +30,243 @@ Create an expectation value snapshot instruction. **ExtensionError** – if snapshot is invalid. - This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue#qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue") and [`qiskit.providers.aer.library.SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance#qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance") instructions. + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue") and [`qiskit.providers.aer.library.SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance") instructions. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.extensions.SnapshotExpectationValue.add_decomposition#qiskit.providers.aer.extensions.SnapshotExpectationValue.add_decomposition "qiskit.providers.aer.extensions.SnapshotExpectationValue.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.extensions.SnapshotExpectationValue.assemble#qiskit.providers.aer.extensions.SnapshotExpectationValue.assemble "qiskit.providers.aer.extensions.SnapshotExpectationValue.assemble") | Assemble a QasmQobjInstruction for snapshot\_expectation\_value. | -| [`broadcast_arguments`](qiskit.providers.aer.extensions.SnapshotExpectationValue.broadcast_arguments#qiskit.providers.aer.extensions.SnapshotExpectationValue.broadcast_arguments "qiskit.providers.aer.extensions.SnapshotExpectationValue.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.extensions.SnapshotExpectationValue.c_if#qiskit.providers.aer.extensions.SnapshotExpectationValue.c_if "qiskit.providers.aer.extensions.SnapshotExpectationValue.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.extensions.SnapshotExpectationValue.copy#qiskit.providers.aer.extensions.SnapshotExpectationValue.copy "qiskit.providers.aer.extensions.SnapshotExpectationValue.copy") | Copy of the instruction. | -| [`define_snapshot_register`](qiskit.providers.aer.extensions.SnapshotExpectationValue.define_snapshot_register#qiskit.providers.aer.extensions.SnapshotExpectationValue.define_snapshot_register "qiskit.providers.aer.extensions.SnapshotExpectationValue.define_snapshot_register") | Defines qubits to snapshot for all snapshot methods | -| [`inverse`](qiskit.providers.aer.extensions.SnapshotExpectationValue.inverse#qiskit.providers.aer.extensions.SnapshotExpectationValue.inverse "qiskit.providers.aer.extensions.SnapshotExpectationValue.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.extensions.SnapshotExpectationValue.is_parameterized#qiskit.providers.aer.extensions.SnapshotExpectationValue.is_parameterized "qiskit.providers.aer.extensions.SnapshotExpectationValue.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.extensions.SnapshotExpectationValue.mirror#qiskit.providers.aer.extensions.SnapshotExpectationValue.mirror "qiskit.providers.aer.extensions.SnapshotExpectationValue.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.extensions.SnapshotExpectationValue.qasm#qiskit.providers.aer.extensions.SnapshotExpectationValue.qasm "qiskit.providers.aer.extensions.SnapshotExpectationValue.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.extensions.SnapshotExpectationValue.repeat#qiskit.providers.aer.extensions.SnapshotExpectationValue.repeat "qiskit.providers.aer.extensions.SnapshotExpectationValue.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.extensions.SnapshotExpectationValue.reverse_ops#qiskit.providers.aer.extensions.SnapshotExpectationValue.reverse_ops "qiskit.providers.aer.extensions.SnapshotExpectationValue.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.extensions.SnapshotExpectationValue.soft_compare#qiskit.providers.aer.extensions.SnapshotExpectationValue.soft_compare "qiskit.providers.aer.extensions.SnapshotExpectationValue.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.extensions.SnapshotExpectationValue.validate_parameter#qiskit.providers.aer.extensions.SnapshotExpectationValue.validate_parameter "qiskit.providers.aer.extensions.SnapshotExpectationValue.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SnapshotExpectationValue.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`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. + +### broadcast\_arguments + + + +`SnapshotExpectationValue.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SnapshotExpectationValue.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SnapshotExpectationValue.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### define\_snapshot\_register + + + +`static SnapshotExpectationValue.define_snapshot_register(circuit, label=None, qubits=None)` + +Defines qubits to snapshot for all snapshot methods + +### inverse + + + +`SnapshotExpectationValue.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SnapshotExpectationValue.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SnapshotExpectationValue.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** +reversed. +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SnapshotExpectationValue.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SnapshotExpectationValue.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SnapshotExpectationValue.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SnapshotExpectationValue.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SnapshotExpectationValue.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label Return snapshot label - + ### params return instruction params. - + ### snapshot\_type Return snapshot type - + ### unit Get the time unit of duration. + 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 71d65268618..47dcb71f194 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 @@ -1,8 +1,16 @@ -# SnapshotProbabilities +--- +title: SnapshotProbabilities +description: API reference for qiskit.providers.aer.extensions.SnapshotProbabilities +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.extensions.SnapshotProbabilities +--- +# SnapshotProbabilities + -`SnapshotProbabilities(label, num_qubits, variance=False)` +`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` @@ -21,68 +29,243 @@ Create a probability snapshot instruction. **ExtensionError** – if snapshot is invalid. - This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveProbabilities`](qiskit.providers.aer.library.SaveProbabilities#qiskit.providers.aer.library.SaveProbabilities "qiskit.providers.aer.library.SaveProbabilities") and [`qiskit.providers.aer.library.SaveProbabilitiesDict`](qiskit.providers.aer.library.SaveProbabilitiesDict#qiskit.providers.aer.library.SaveProbabilitiesDict "qiskit.providers.aer.library.SaveProbabilitiesDict") instructions. + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveProbabilities`](qiskit.providers.aer.library.SaveProbabilities "qiskit.providers.aer.library.SaveProbabilities") and [`qiskit.providers.aer.library.SaveProbabilitiesDict`](qiskit.providers.aer.library.SaveProbabilitiesDict "qiskit.providers.aer.library.SaveProbabilitiesDict") instructions. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.extensions.SnapshotProbabilities.add_decomposition#qiskit.providers.aer.extensions.SnapshotProbabilities.add_decomposition "qiskit.providers.aer.extensions.SnapshotProbabilities.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.extensions.SnapshotProbabilities.assemble#qiskit.providers.aer.extensions.SnapshotProbabilities.assemble "qiskit.providers.aer.extensions.SnapshotProbabilities.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.extensions.SnapshotProbabilities.broadcast_arguments#qiskit.providers.aer.extensions.SnapshotProbabilities.broadcast_arguments "qiskit.providers.aer.extensions.SnapshotProbabilities.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.extensions.SnapshotProbabilities.c_if#qiskit.providers.aer.extensions.SnapshotProbabilities.c_if "qiskit.providers.aer.extensions.SnapshotProbabilities.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.extensions.SnapshotProbabilities.copy#qiskit.providers.aer.extensions.SnapshotProbabilities.copy "qiskit.providers.aer.extensions.SnapshotProbabilities.copy") | Copy of the instruction. | -| [`define_snapshot_register`](qiskit.providers.aer.extensions.SnapshotProbabilities.define_snapshot_register#qiskit.providers.aer.extensions.SnapshotProbabilities.define_snapshot_register "qiskit.providers.aer.extensions.SnapshotProbabilities.define_snapshot_register") | Defines qubits to snapshot for all snapshot methods | -| [`inverse`](qiskit.providers.aer.extensions.SnapshotProbabilities.inverse#qiskit.providers.aer.extensions.SnapshotProbabilities.inverse "qiskit.providers.aer.extensions.SnapshotProbabilities.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.extensions.SnapshotProbabilities.is_parameterized#qiskit.providers.aer.extensions.SnapshotProbabilities.is_parameterized "qiskit.providers.aer.extensions.SnapshotProbabilities.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.extensions.SnapshotProbabilities.mirror#qiskit.providers.aer.extensions.SnapshotProbabilities.mirror "qiskit.providers.aer.extensions.SnapshotProbabilities.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.extensions.SnapshotProbabilities.qasm#qiskit.providers.aer.extensions.SnapshotProbabilities.qasm "qiskit.providers.aer.extensions.SnapshotProbabilities.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.extensions.SnapshotProbabilities.repeat#qiskit.providers.aer.extensions.SnapshotProbabilities.repeat "qiskit.providers.aer.extensions.SnapshotProbabilities.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.extensions.SnapshotProbabilities.reverse_ops#qiskit.providers.aer.extensions.SnapshotProbabilities.reverse_ops "qiskit.providers.aer.extensions.SnapshotProbabilities.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.extensions.SnapshotProbabilities.soft_compare#qiskit.providers.aer.extensions.SnapshotProbabilities.soft_compare "qiskit.providers.aer.extensions.SnapshotProbabilities.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.extensions.SnapshotProbabilities.validate_parameter#qiskit.providers.aer.extensions.SnapshotProbabilities.validate_parameter "qiskit.providers.aer.extensions.SnapshotProbabilities.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SnapshotProbabilities.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SnapshotProbabilities.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SnapshotProbabilities.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SnapshotProbabilities.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SnapshotProbabilities.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### define\_snapshot\_register + + + +`static SnapshotProbabilities.define_snapshot_register(circuit, label=None, qubits=None)` + +Defines qubits to snapshot for all snapshot methods + +### inverse + + + +`SnapshotProbabilities.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SnapshotProbabilities.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SnapshotProbabilities.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** +reversed. +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SnapshotProbabilities.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SnapshotProbabilities.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SnapshotProbabilities.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SnapshotProbabilities.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SnapshotProbabilities.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label Return snapshot label - + ### params return instruction params. - + ### snapshot\_type Return snapshot type - + ### unit Get the time unit of duration. + 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 5045ab6df28..b91c0717c6f 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 @@ -1,8 +1,16 @@ -# SnapshotStabilizer +--- +title: SnapshotStabilizer +description: API reference for qiskit.providers.aer.extensions.SnapshotStabilizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.extensions.SnapshotStabilizer +--- +# SnapshotStabilizer + -`SnapshotStabilizer(label, num_qubits=0)` +`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` @@ -24,68 +32,243 @@ Create a stabilizer state snapshot instruction. This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit. - This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveStabilizer`](qiskit.providers.aer.library.SaveStabilizer#qiskit.providers.aer.library.SaveStabilizer "qiskit.providers.aer.library.SaveStabilizer") instruction. + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveStabilizer`](qiskit.providers.aer.library.SaveStabilizer "qiskit.providers.aer.library.SaveStabilizer") instruction. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.extensions.SnapshotStabilizer.add_decomposition#qiskit.providers.aer.extensions.SnapshotStabilizer.add_decomposition "qiskit.providers.aer.extensions.SnapshotStabilizer.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.extensions.SnapshotStabilizer.assemble#qiskit.providers.aer.extensions.SnapshotStabilizer.assemble "qiskit.providers.aer.extensions.SnapshotStabilizer.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.extensions.SnapshotStabilizer.broadcast_arguments#qiskit.providers.aer.extensions.SnapshotStabilizer.broadcast_arguments "qiskit.providers.aer.extensions.SnapshotStabilizer.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.extensions.SnapshotStabilizer.c_if#qiskit.providers.aer.extensions.SnapshotStabilizer.c_if "qiskit.providers.aer.extensions.SnapshotStabilizer.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.extensions.SnapshotStabilizer.copy#qiskit.providers.aer.extensions.SnapshotStabilizer.copy "qiskit.providers.aer.extensions.SnapshotStabilizer.copy") | Copy of the instruction. | -| [`define_snapshot_register`](qiskit.providers.aer.extensions.SnapshotStabilizer.define_snapshot_register#qiskit.providers.aer.extensions.SnapshotStabilizer.define_snapshot_register "qiskit.providers.aer.extensions.SnapshotStabilizer.define_snapshot_register") | Defines qubits to snapshot for all snapshot methods | -| [`inverse`](qiskit.providers.aer.extensions.SnapshotStabilizer.inverse#qiskit.providers.aer.extensions.SnapshotStabilizer.inverse "qiskit.providers.aer.extensions.SnapshotStabilizer.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.extensions.SnapshotStabilizer.is_parameterized#qiskit.providers.aer.extensions.SnapshotStabilizer.is_parameterized "qiskit.providers.aer.extensions.SnapshotStabilizer.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.extensions.SnapshotStabilizer.mirror#qiskit.providers.aer.extensions.SnapshotStabilizer.mirror "qiskit.providers.aer.extensions.SnapshotStabilizer.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.extensions.SnapshotStabilizer.qasm#qiskit.providers.aer.extensions.SnapshotStabilizer.qasm "qiskit.providers.aer.extensions.SnapshotStabilizer.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.extensions.SnapshotStabilizer.repeat#qiskit.providers.aer.extensions.SnapshotStabilizer.repeat "qiskit.providers.aer.extensions.SnapshotStabilizer.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.extensions.SnapshotStabilizer.reverse_ops#qiskit.providers.aer.extensions.SnapshotStabilizer.reverse_ops "qiskit.providers.aer.extensions.SnapshotStabilizer.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.extensions.SnapshotStabilizer.soft_compare#qiskit.providers.aer.extensions.SnapshotStabilizer.soft_compare "qiskit.providers.aer.extensions.SnapshotStabilizer.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.extensions.SnapshotStabilizer.validate_parameter#qiskit.providers.aer.extensions.SnapshotStabilizer.validate_parameter "qiskit.providers.aer.extensions.SnapshotStabilizer.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SnapshotStabilizer.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SnapshotStabilizer.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SnapshotStabilizer.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SnapshotStabilizer.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SnapshotStabilizer.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### define\_snapshot\_register + + + +`static SnapshotStabilizer.define_snapshot_register(circuit, label=None, qubits=None)` + +Defines qubits to snapshot for all snapshot methods + +### inverse + + + +`SnapshotStabilizer.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SnapshotStabilizer.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SnapshotStabilizer.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** +reversed. +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SnapshotStabilizer.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SnapshotStabilizer.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SnapshotStabilizer.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SnapshotStabilizer.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SnapshotStabilizer.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label Return snapshot label - + ### params return instruction params. - + ### snapshot\_type Return snapshot type - + ### unit Get the time unit of duration. + 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 eac5903127c..b82a02aae95 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 @@ -1,8 +1,16 @@ -# SnapshotStatevector +--- +title: SnapshotStatevector +description: API reference for qiskit.providers.aer.extensions.SnapshotStatevector +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.extensions.SnapshotStatevector +--- +# SnapshotStatevector + -`SnapshotStatevector(label, num_qubits=0)` +`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` @@ -24,68 +32,243 @@ Create a statevector state snapshot instruction. This snapshot is always performed on all qubits in a circuit. The number of qubits parameter specifies the size of the instruction as a barrier and should be set to the number of qubits in the circuit. - This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveStatevector`](qiskit.providers.aer.library.SaveStatevector#qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector") instruction. + This instruction has been deprecated and will be removed no earlier than 3 months from the 0.9.0 release date. It has been superseded by the [`qiskit.providers.aer.library.SaveStatevector`](qiskit.providers.aer.library.SaveStatevector "qiskit.providers.aer.library.SaveStatevector") instruction. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.extensions.SnapshotStatevector.add_decomposition#qiskit.providers.aer.extensions.SnapshotStatevector.add_decomposition "qiskit.providers.aer.extensions.SnapshotStatevector.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.extensions.SnapshotStatevector.assemble#qiskit.providers.aer.extensions.SnapshotStatevector.assemble "qiskit.providers.aer.extensions.SnapshotStatevector.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.extensions.SnapshotStatevector.broadcast_arguments#qiskit.providers.aer.extensions.SnapshotStatevector.broadcast_arguments "qiskit.providers.aer.extensions.SnapshotStatevector.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.extensions.SnapshotStatevector.c_if#qiskit.providers.aer.extensions.SnapshotStatevector.c_if "qiskit.providers.aer.extensions.SnapshotStatevector.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.extensions.SnapshotStatevector.copy#qiskit.providers.aer.extensions.SnapshotStatevector.copy "qiskit.providers.aer.extensions.SnapshotStatevector.copy") | Copy of the instruction. | -| [`define_snapshot_register`](qiskit.providers.aer.extensions.SnapshotStatevector.define_snapshot_register#qiskit.providers.aer.extensions.SnapshotStatevector.define_snapshot_register "qiskit.providers.aer.extensions.SnapshotStatevector.define_snapshot_register") | Defines qubits to snapshot for all snapshot methods | -| [`inverse`](qiskit.providers.aer.extensions.SnapshotStatevector.inverse#qiskit.providers.aer.extensions.SnapshotStatevector.inverse "qiskit.providers.aer.extensions.SnapshotStatevector.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.extensions.SnapshotStatevector.is_parameterized#qiskit.providers.aer.extensions.SnapshotStatevector.is_parameterized "qiskit.providers.aer.extensions.SnapshotStatevector.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.extensions.SnapshotStatevector.mirror#qiskit.providers.aer.extensions.SnapshotStatevector.mirror "qiskit.providers.aer.extensions.SnapshotStatevector.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.extensions.SnapshotStatevector.qasm#qiskit.providers.aer.extensions.SnapshotStatevector.qasm "qiskit.providers.aer.extensions.SnapshotStatevector.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.extensions.SnapshotStatevector.repeat#qiskit.providers.aer.extensions.SnapshotStatevector.repeat "qiskit.providers.aer.extensions.SnapshotStatevector.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.extensions.SnapshotStatevector.reverse_ops#qiskit.providers.aer.extensions.SnapshotStatevector.reverse_ops "qiskit.providers.aer.extensions.SnapshotStatevector.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.extensions.SnapshotStatevector.soft_compare#qiskit.providers.aer.extensions.SnapshotStatevector.soft_compare "qiskit.providers.aer.extensions.SnapshotStatevector.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.extensions.SnapshotStatevector.validate_parameter#qiskit.providers.aer.extensions.SnapshotStatevector.validate_parameter "qiskit.providers.aer.extensions.SnapshotStatevector.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SnapshotStatevector.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SnapshotStatevector.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SnapshotStatevector.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SnapshotStatevector.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SnapshotStatevector.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### define\_snapshot\_register + + + +`static SnapshotStatevector.define_snapshot_register(circuit, label=None, qubits=None)` + +Defines qubits to snapshot for all snapshot methods + +### inverse + + + +`SnapshotStatevector.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SnapshotStatevector.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SnapshotStatevector.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** +reversed. +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SnapshotStatevector.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SnapshotStatevector.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SnapshotStatevector.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SnapshotStatevector.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SnapshotStatevector.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label Return snapshot label - + ### params return instruction params. - + ### snapshot\_type Return snapshot type - + ### unit Get the time unit of duration. + 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 31ec939f62a..769df845673 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 @@ -1,8 +1,16 @@ -# AerJob +--- +title: AerJob +description: API reference for qiskit.providers.aer.jobs.AerJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.jobs.AerJob +--- +# AerJob + -`AerJob(backend, job_id, fn, qobj, executor=None)` +`AerJob(backend, job_id, fn, qobj, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -15,31 +23,210 @@ Initializes the asynchronous job. * **backend** (*AerBackend*) – the backend used to run the job. * **job\_id** (*str*) – a unique id in the context of the backend used to run the job. * **fn** (*function*) – a callable function to execute qobj on backend. This should usually be a bound `AerBackend._run()` method, with the signature (qobj: QasmQobj, job\_id: str) -> Result. -* **qobj** ([*QasmQobj*](qiskit.qobj.QasmQobj#qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")) – qobj to execute +* **qobj** ([*QasmQobj*](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")) – qobj to execute * **executor** (*ThreadPoolExecutor or dask.distributed.client*) – The executor to be used to submit the job. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`backend`](qiskit.providers.aer.jobs.AerJob.backend#qiskit.providers.aer.jobs.AerJob.backend "qiskit.providers.aer.jobs.AerJob.backend") | Return the instance of the backend used for this job. | -| [`cancel`](qiskit.providers.aer.jobs.AerJob.cancel#qiskit.providers.aer.jobs.AerJob.cancel "qiskit.providers.aer.jobs.AerJob.cancel") | Attempt to cancel the job. | -| [`cancelled`](qiskit.providers.aer.jobs.AerJob.cancelled#qiskit.providers.aer.jobs.AerJob.cancelled "qiskit.providers.aer.jobs.AerJob.cancelled") | Return whether the job has been cancelled. | -| [`done`](qiskit.providers.aer.jobs.AerJob.done#qiskit.providers.aer.jobs.AerJob.done "qiskit.providers.aer.jobs.AerJob.done") | Return whether the job has successfully run. | -| [`executor`](qiskit.providers.aer.jobs.AerJob.executor#qiskit.providers.aer.jobs.AerJob.executor "qiskit.providers.aer.jobs.AerJob.executor") | Return the executor for this job | -| [`in_final_state`](qiskit.providers.aer.jobs.AerJob.in_final_state#qiskit.providers.aer.jobs.AerJob.in_final_state "qiskit.providers.aer.jobs.AerJob.in_final_state") | Return whether the job is in a final job state such as `DONE` or `ERROR`. | -| [`job_id`](qiskit.providers.aer.jobs.AerJob.job_id#qiskit.providers.aer.jobs.AerJob.job_id "qiskit.providers.aer.jobs.AerJob.job_id") | Return a unique id identifying the job. | -| [`qobj`](qiskit.providers.aer.jobs.AerJob.qobj#qiskit.providers.aer.jobs.AerJob.qobj "qiskit.providers.aer.jobs.AerJob.qobj") | Return the Qobj submitted for this job. | -| [`result`](qiskit.providers.aer.jobs.AerJob.result#qiskit.providers.aer.jobs.AerJob.result "qiskit.providers.aer.jobs.AerJob.result") | Get job result. | -| [`running`](qiskit.providers.aer.jobs.AerJob.running#qiskit.providers.aer.jobs.AerJob.running "qiskit.providers.aer.jobs.AerJob.running") | Return whether the job is actively running. | -| [`status`](qiskit.providers.aer.jobs.AerJob.status#qiskit.providers.aer.jobs.AerJob.status "qiskit.providers.aer.jobs.AerJob.status") | Gets the status of the job by querying the Python’s future | -| [`submit`](qiskit.providers.aer.jobs.AerJob.submit#qiskit.providers.aer.jobs.AerJob.submit "qiskit.providers.aer.jobs.AerJob.submit") | Submit the job to the backend for execution. | -| [`wait_for_final_state`](qiskit.providers.aer.jobs.AerJob.wait_for_final_state#qiskit.providers.aer.jobs.AerJob.wait_for_final_state "qiskit.providers.aer.jobs.AerJob.wait_for_final_state") | Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. | +### backend -## Attributes + + +`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. + +### cancel + + + +`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. + +### cancelled + + + +`AerJob.cancelled()` + +Return whether the job has been cancelled. + +**Return type** + +`bool` + +### done + + + +`AerJob.done()` + +Return whether the job has successfully run. + +**Return type** + +`bool` + +### executor + + + +`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 +### in\_final\_state + + +`AerJob.in_final_state()` + +Return whether the job is in a final job state such as `DONE` or `ERROR`. + +**Return type** + +`bool` + +### job\_id + + + +`AerJob.job_id()` + +Return a unique id identifying the job. + +**Return type** + +`str` + +### qobj + + + +`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. + +**Returns** + +the Qobj submitted for this job. + +**Return type** + +[Qobj](qiskit.qobj.Qobj "qiskit.qobj.Qobj") + +### result + + + +`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, + +[https://docs.python.org/3/library/concurrent.futures.html#future-objects](https://docs.python.org/3/library/concurrent.futures.html#future-objects) + +**Parameters** + +**timeout** (*float*) – number of seconds to wait for results. + +**Returns** + +Result object + +**Return type** + +qiskit.Result + +**Raises** + +* **concurrent.futures.TimeoutError** – if timeout occurred. +* **concurrent.futures.CancelledError** – if job cancelled before completed. + +### running + + + +`AerJob.running()` + +Return whether the job is actively running. + +**Return type** + +`bool` + +### status + + + +`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 + +**Returns** + +The current JobStatus + +**Return type** + +[JobStatus](qiskit.providers.JobStatus "qiskit.providers.JobStatus") + +**Raises** + +* [**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – If the future is in unexpected state +* **concurrent.futures.TimeoutError** – if timeout occurred. + +### submit + + + +`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. + +**Raises** + +* **QobjValidationError** – if the JSON serialization of the Qobj passed +* **during construction does not validate against the Qobj schema.** – +* [**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – if trying to re-submit the job. + +### wait\_for\_final\_state + + + +`AerJob.wait_for_final_state(timeout=None, wait=5, callback=None)` + +Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + +* **wait** (`float`) – Seconds between queries. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function invoked after each query. The following positional arguments are provided to the callback function: + + * job\_id: Job ID + * job\_status: Status of the job from the last query + * job: This BaseJob instance + + Note: different subclass might provide different arguments to the callback function. + +**Raises** + +[**JobTimeoutError**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + +**Return type** + +`None` + +## Attributes + + ### version `= 1` + 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 1f861b5323e..354de533212 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 @@ -1,14 +1,22 @@ -# AerJobSet +--- +title: AerJobSet +description: API reference for qiskit.providers.aer.jobs.AerJobSet +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.jobs.AerJobSet +--- +# AerJobSet + -`AerJobSet(backend, job_id, fn, experiments, executor=None)` +`AerJobSet(backend, job_id, fn, experiments, executor=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/jobs/aerjobset.py "view source code") Bases: `qiskit.providers.job.JobV1` -A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob#qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. +A set of [`AerJob`](qiskit.providers.aer.jobs.AerJob "qiskit.providers.aer.jobs.AerJob") classes for Qiskit Aer simulators. -An instance of this class is returned when you submit experiments with executor option. It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`result()`](qiskit.providers.aer.jobs.AerJobSet.result#qiskit.providers.aer.jobs.AerJobSet.result "qiskit.providers.aer.jobs.AerJobSet.result") and cancel all jobs using [`cancel()`](qiskit.providers.aer.jobs.AerJobSet.cancel#qiskit.providers.aer.jobs.AerJobSet.cancel "qiskit.providers.aer.jobs.AerJobSet.cancel"). +An instance of this class is returned when you submit experiments with executor option. It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`result()`](qiskit.providers.aer.jobs.AerJobSet#result "qiskit.providers.aer.jobs.AerJobSet.result") and cancel all jobs using [`cancel()`](qiskit.providers.aer.jobs.AerJobSet#cancel "qiskit.providers.aer.jobs.AerJobSet.cancel"). AerJobSet constructor. @@ -17,34 +25,309 @@ AerJobSet constructor. * **backend** (*Aerbackend*) – Aerbackend. * **job\_id** (*int*) – Job Id. * **fn** (*function*) – a callable function to execute qobj on backend. This should usually be a bound `AerBackend._run()` method, with the signature (qobj: QasmQobj, job\_id: str) -> Result. -* **experiments** (*List\[*[*QasmQobj*](qiskit.qobj.QasmQobj#qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")*]*) – List\[QasmQobjs] to execute. +* **experiments** (*List\[*[*QasmQobj*](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")*]*) – List\[QasmQobjs] to execute. * **executor** (*ThreadPoolExecutor or dask.distributed.client*) – The executor to be used to submit the job. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | -| [`backend`](qiskit.providers.aer.jobs.AerJobSet.backend#qiskit.providers.aer.jobs.AerJobSet.backend "qiskit.providers.aer.jobs.AerJobSet.backend") | Return the backend where this job was executed. | -| [`cancel`](qiskit.providers.aer.jobs.AerJobSet.cancel#qiskit.providers.aer.jobs.AerJobSet.cancel "qiskit.providers.aer.jobs.AerJobSet.cancel") | Cancel all jobs in this job set. | -| [`cancelled`](qiskit.providers.aer.jobs.AerJobSet.cancelled#qiskit.providers.aer.jobs.AerJobSet.cancelled "qiskit.providers.aer.jobs.AerJobSet.cancelled") | Return whether the job has been cancelled. | -| [`done`](qiskit.providers.aer.jobs.AerJobSet.done#qiskit.providers.aer.jobs.AerJobSet.done "qiskit.providers.aer.jobs.AerJobSet.done") | Return whether the job has successfully run. | -| [`executor`](qiskit.providers.aer.jobs.AerJobSet.executor#qiskit.providers.aer.jobs.AerJobSet.executor "qiskit.providers.aer.jobs.AerJobSet.executor") | Return the executor for this job | -| [`in_final_state`](qiskit.providers.aer.jobs.AerJobSet.in_final_state#qiskit.providers.aer.jobs.AerJobSet.in_final_state "qiskit.providers.aer.jobs.AerJobSet.in_final_state") | Return whether the job is in a final job state such as `DONE` or `ERROR`. | -| [`job`](qiskit.providers.aer.jobs.AerJobSet.job#qiskit.providers.aer.jobs.AerJobSet.job "qiskit.providers.aer.jobs.AerJobSet.job") | Retrieve the job used to submit the specified experiment and its index. | -| [`job_id`](qiskit.providers.aer.jobs.AerJobSet.job_id#qiskit.providers.aer.jobs.AerJobSet.job_id "qiskit.providers.aer.jobs.AerJobSet.job_id") | Return a unique id identifying the job. | -| [`result`](qiskit.providers.aer.jobs.AerJobSet.result#qiskit.providers.aer.jobs.AerJobSet.result "qiskit.providers.aer.jobs.AerJobSet.result") | Return the results of the jobs as a single Result object. | -| [`running`](qiskit.providers.aer.jobs.AerJobSet.running#qiskit.providers.aer.jobs.AerJobSet.running "qiskit.providers.aer.jobs.AerJobSet.running") | Return whether the job is actively running. | -| [`status`](qiskit.providers.aer.jobs.AerJobSet.status#qiskit.providers.aer.jobs.AerJobSet.status "qiskit.providers.aer.jobs.AerJobSet.status") | Return the status of each job in this set. | -| [`submit`](qiskit.providers.aer.jobs.AerJobSet.submit#qiskit.providers.aer.jobs.AerJobSet.submit "qiskit.providers.aer.jobs.AerJobSet.submit") | Execute this set of jobs on an executor. | -| [`wait_for_final_state`](qiskit.providers.aer.jobs.AerJobSet.wait_for_final_state#qiskit.providers.aer.jobs.AerJobSet.wait_for_final_state "qiskit.providers.aer.jobs.AerJobSet.wait_for_final_state") | Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. | -| [`worker`](qiskit.providers.aer.jobs.AerJobSet.worker#qiskit.providers.aer.jobs.AerJobSet.worker "qiskit.providers.aer.jobs.AerJobSet.worker") | Retrieve the index of job. | -| [`worker_job`](qiskit.providers.aer.jobs.AerJobSet.worker_job#qiskit.providers.aer.jobs.AerJobSet.worker_job "qiskit.providers.aer.jobs.AerJobSet.worker_job") | Retrieve the job specified with job’s id | -| [`worker_results`](qiskit.providers.aer.jobs.AerJobSet.worker_results#qiskit.providers.aer.jobs.AerJobSet.worker_results "qiskit.providers.aer.jobs.AerJobSet.worker_results") | Return the result of the jobs specified with worker\_id. | +### backend -## Attributes + + +`AerJobSet.backend()` + +Return the backend where this job was executed. + +**Return type** + +`Backend` + +### cancel + + + +`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. + +**Return type** + +`None` + +### cancelled + + + +`AerJobSet.cancelled()` + +Return whether the job has been cancelled. + +**Return type** + +`bool` + +### done + + + +`AerJobSet.done()` + +Return whether the job has successfully run. + +**Return type** + +`bool` + +### executor + + + +`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 + +### in\_final\_state + + + +`AerJobSet.in_final_state()` + +Return whether the job is in a final job state such as `DONE` or `ERROR`. + +**Return type** + +`bool` + +### job + + + +`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. + +**Parameters** + +**experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`]) – + +Retrieve the job used to submit this experiment. Several types are accepted for convenience: + +> * str: The name of the experiment. +> * QuantumCircuit: The name of the circuit instance will be used. +> * Schedule: The name of the schedule instance will be used. + +**Return type** + +`Tuple`\[`AerJob`, `int`] + +**Returns** + +A tuple of the job used to submit the experiment and the experiment index. + +**Raises** + +[**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – If the job for the experiment could not be found. + +### job\_id + + + +`AerJobSet.job_id()` + +Return a unique id identifying the job. + +**Return type** + +`str` + +### result + + + +`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. + +This call will block until all job results become available or the timeout is reached. + +**Parameters** + +**timeout** (`Optional`\[`float`]) – Number of seconds to wait for job results. + +**Returns** + +Result object + +**Return type** + +qiskit.Result + +**Raises** + +[**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – if unable to retrieve all job results before the specified timeout. + +### running + + + +`AerJobSet.running()` + +Return whether the job is actively running. + +**Return type** + +`bool` +### status + + +`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. + +#### Args + +worker: Worker id. When None, all workers’ statuses are returned. + +**Return type** + +`Union`\[`JobStatus`, `List`\[`JobStatus`]] + +**Returns** + +A list of job statuses. + +### submit + + + +`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. + +**Raises** + +**RuntimeError** – If the jobs were already submitted. + +### wait\_for\_final\_state + + + +`AerJobSet.wait_for_final_state(timeout=None, wait=5, callback=None)` + +Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + +* **wait** (`float`) – Seconds between queries. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function invoked after each query. The following positional arguments are provided to the callback function: + + * job\_id: Job ID + * job\_status: Status of the job from the last query + * job: This BaseJob instance + + Note: different subclass might provide different arguments to the callback function. + +**Raises** + +[**JobTimeoutError**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + +**Return type** + +`None` + +### worker + + + +`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. + +**Parameters** + +**experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`]) – + +Retrieve the job used to submit this experiment. Several types are accepted for convenience: + +> * str: The name of the experiment. +> * QuantumCircuit: The name of the circuit instance will be used. +> * Schedule: The name of the schedule instance will be used. + +**Return type** + +`Union`\[`int`, `List`\[`int`]] + +**Returns** + +list or integer value of the job id + +**Raises** + +[**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – If the job for the experiment could not be found. + +### worker\_job + + + +`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 + +**Parameters** + +**worker** (`Union`\[`None`, `int`, `Iterable`\[`int`]]) – retrive job used to submit with this job id. + +**Return type** + +`Union`\[`AerJob`, `List`\[`AerJob`]] + +**Returns** + +A list of `AerJob` instances that represents the submitted jobs. + +**Raises** + +[**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – If the job for the experiment could not be found. + +### worker\_results + + + +`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. + +When the worker is None, this call return all worker’s result. + +**Parameters** + +* **worker** (`Union`\[`None`, `int`, `Iterable`\[`int`]]) – Worker id to wait for job result. +* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job results. + +**Returns** + +Result object instance that can be used to retrieve results for individual experiments. + +**Return type** + +qiskit.Result + +**Raises** + +[**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – if unable to retrieve all job results before the specified timeout. + +## Attributes + + ### version `= 1` + 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 4f6b09ad5ca..2f084af6024 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 @@ -1,8 +1,16 @@ -# SaveAmplitudes +--- +title: SaveAmplitudes +description: API reference for qiskit.providers.aer.library.SaveAmplitudes +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveAmplitudes +--- +# SaveAmplitudes + -`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)` +`SaveAmplitudes(num_qubits, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` @@ -24,43 +32,210 @@ Instruction to save complex statevector amplitudes. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveAmplitudes.add_decomposition#qiskit.providers.aer.library.SaveAmplitudes.add_decomposition "qiskit.providers.aer.library.SaveAmplitudes.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveAmplitudes.assemble#qiskit.providers.aer.library.SaveAmplitudes.assemble "qiskit.providers.aer.library.SaveAmplitudes.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveAmplitudes.broadcast_arguments#qiskit.providers.aer.library.SaveAmplitudes.broadcast_arguments "qiskit.providers.aer.library.SaveAmplitudes.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveAmplitudes.c_if#qiskit.providers.aer.library.SaveAmplitudes.c_if "qiskit.providers.aer.library.SaveAmplitudes.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveAmplitudes.copy#qiskit.providers.aer.library.SaveAmplitudes.copy "qiskit.providers.aer.library.SaveAmplitudes.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveAmplitudes.inverse#qiskit.providers.aer.library.SaveAmplitudes.inverse "qiskit.providers.aer.library.SaveAmplitudes.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveAmplitudes.is_parameterized#qiskit.providers.aer.library.SaveAmplitudes.is_parameterized "qiskit.providers.aer.library.SaveAmplitudes.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveAmplitudes.mirror#qiskit.providers.aer.library.SaveAmplitudes.mirror "qiskit.providers.aer.library.SaveAmplitudes.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveAmplitudes.qasm#qiskit.providers.aer.library.SaveAmplitudes.qasm "qiskit.providers.aer.library.SaveAmplitudes.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveAmplitudes.repeat#qiskit.providers.aer.library.SaveAmplitudes.repeat "qiskit.providers.aer.library.SaveAmplitudes.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveAmplitudes.reverse_ops#qiskit.providers.aer.library.SaveAmplitudes.reverse_ops "qiskit.providers.aer.library.SaveAmplitudes.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveAmplitudes.soft_compare#qiskit.providers.aer.library.SaveAmplitudes.soft_compare "qiskit.providers.aer.library.SaveAmplitudes.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveAmplitudes.validate_parameter#qiskit.providers.aer.library.SaveAmplitudes.validate_parameter "qiskit.providers.aer.library.SaveAmplitudes.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveAmplitudes.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveAmplitudes.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveAmplitudes.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveAmplitudes.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveAmplitudes.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveAmplitudes.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveAmplitudes.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveAmplitudes.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveAmplitudes.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveAmplitudes.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveAmplitudes.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveAmplitudes.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveAmplitudes.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -70,14 +245,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 63d3b136f78..e20f410d2b8 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 @@ -1,8 +1,16 @@ -# SaveAmplitudesSquared +--- +title: SaveAmplitudesSquared +description: API reference for qiskit.providers.aer.library.SaveAmplitudesSquared +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveAmplitudesSquared +--- +# SaveAmplitudesSquared + -`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` +`SaveAmplitudesSquared(num_qubits, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` @@ -25,43 +33,210 @@ Instruction to save squared statevector amplitudes (probabilities). ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveAmplitudesSquared.add_decomposition#qiskit.providers.aer.library.SaveAmplitudesSquared.add_decomposition "qiskit.providers.aer.library.SaveAmplitudesSquared.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveAmplitudesSquared.assemble#qiskit.providers.aer.library.SaveAmplitudesSquared.assemble "qiskit.providers.aer.library.SaveAmplitudesSquared.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveAmplitudesSquared.broadcast_arguments#qiskit.providers.aer.library.SaveAmplitudesSquared.broadcast_arguments "qiskit.providers.aer.library.SaveAmplitudesSquared.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveAmplitudesSquared.c_if#qiskit.providers.aer.library.SaveAmplitudesSquared.c_if "qiskit.providers.aer.library.SaveAmplitudesSquared.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveAmplitudesSquared.copy#qiskit.providers.aer.library.SaveAmplitudesSquared.copy "qiskit.providers.aer.library.SaveAmplitudesSquared.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveAmplitudesSquared.inverse#qiskit.providers.aer.library.SaveAmplitudesSquared.inverse "qiskit.providers.aer.library.SaveAmplitudesSquared.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveAmplitudesSquared.is_parameterized#qiskit.providers.aer.library.SaveAmplitudesSquared.is_parameterized "qiskit.providers.aer.library.SaveAmplitudesSquared.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveAmplitudesSquared.mirror#qiskit.providers.aer.library.SaveAmplitudesSquared.mirror "qiskit.providers.aer.library.SaveAmplitudesSquared.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveAmplitudesSquared.qasm#qiskit.providers.aer.library.SaveAmplitudesSquared.qasm "qiskit.providers.aer.library.SaveAmplitudesSquared.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveAmplitudesSquared.repeat#qiskit.providers.aer.library.SaveAmplitudesSquared.repeat "qiskit.providers.aer.library.SaveAmplitudesSquared.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveAmplitudesSquared.reverse_ops#qiskit.providers.aer.library.SaveAmplitudesSquared.reverse_ops "qiskit.providers.aer.library.SaveAmplitudesSquared.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveAmplitudesSquared.soft_compare#qiskit.providers.aer.library.SaveAmplitudesSquared.soft_compare "qiskit.providers.aer.library.SaveAmplitudesSquared.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveAmplitudesSquared.validate_parameter#qiskit.providers.aer.library.SaveAmplitudesSquared.validate_parameter "qiskit.providers.aer.library.SaveAmplitudesSquared.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveAmplitudesSquared.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveAmplitudesSquared.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveAmplitudesSquared.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveAmplitudesSquared.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveAmplitudesSquared.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveAmplitudesSquared.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveAmplitudesSquared.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveAmplitudesSquared.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveAmplitudesSquared.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveAmplitudesSquared.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveAmplitudesSquared.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveAmplitudesSquared.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveAmplitudesSquared.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -71,14 +246,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 91fdee56192..ff1c118b222 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 @@ -1,8 +1,16 @@ -# SaveDensityMatrix +--- +title: SaveDensityMatrix +description: API reference for qiskit.providers.aer.library.SaveDensityMatrix +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveDensityMatrix +--- +# SaveDensityMatrix + -`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` +`SaveDensityMatrix(num_qubits, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` @@ -20,43 +28,210 @@ Create new instruction to save the simulator reduced density matrix. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveDensityMatrix.add_decomposition#qiskit.providers.aer.library.SaveDensityMatrix.add_decomposition "qiskit.providers.aer.library.SaveDensityMatrix.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveDensityMatrix.assemble#qiskit.providers.aer.library.SaveDensityMatrix.assemble "qiskit.providers.aer.library.SaveDensityMatrix.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveDensityMatrix.broadcast_arguments#qiskit.providers.aer.library.SaveDensityMatrix.broadcast_arguments "qiskit.providers.aer.library.SaveDensityMatrix.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveDensityMatrix.c_if#qiskit.providers.aer.library.SaveDensityMatrix.c_if "qiskit.providers.aer.library.SaveDensityMatrix.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveDensityMatrix.copy#qiskit.providers.aer.library.SaveDensityMatrix.copy "qiskit.providers.aer.library.SaveDensityMatrix.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveDensityMatrix.inverse#qiskit.providers.aer.library.SaveDensityMatrix.inverse "qiskit.providers.aer.library.SaveDensityMatrix.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveDensityMatrix.is_parameterized#qiskit.providers.aer.library.SaveDensityMatrix.is_parameterized "qiskit.providers.aer.library.SaveDensityMatrix.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveDensityMatrix.mirror#qiskit.providers.aer.library.SaveDensityMatrix.mirror "qiskit.providers.aer.library.SaveDensityMatrix.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveDensityMatrix.qasm#qiskit.providers.aer.library.SaveDensityMatrix.qasm "qiskit.providers.aer.library.SaveDensityMatrix.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveDensityMatrix.repeat#qiskit.providers.aer.library.SaveDensityMatrix.repeat "qiskit.providers.aer.library.SaveDensityMatrix.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveDensityMatrix.reverse_ops#qiskit.providers.aer.library.SaveDensityMatrix.reverse_ops "qiskit.providers.aer.library.SaveDensityMatrix.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveDensityMatrix.soft_compare#qiskit.providers.aer.library.SaveDensityMatrix.soft_compare "qiskit.providers.aer.library.SaveDensityMatrix.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveDensityMatrix.validate_parameter#qiskit.providers.aer.library.SaveDensityMatrix.validate_parameter "qiskit.providers.aer.library.SaveDensityMatrix.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveDensityMatrix.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveDensityMatrix.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveDensityMatrix.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveDensityMatrix.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveDensityMatrix.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveDensityMatrix.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveDensityMatrix.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveDensityMatrix.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveDensityMatrix.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveDensityMatrix.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveDensityMatrix.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveDensityMatrix.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveDensityMatrix.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -66,14 +241,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 37543cab5ca..e7d38aafa3d 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 @@ -1,8 +1,16 @@ -# SaveExpectationValue +--- +title: SaveExpectationValue +description: API reference for qiskit.providers.aer.library.SaveExpectationValue +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveExpectationValue +--- +# SaveExpectationValue + -`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` +`SaveExpectationValue(operator, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` @@ -14,7 +22,7 @@ The expectation value of a Hermitian operator $H$ for a simulator in quantum sta **Parameters** -* **operator** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. * **label** (*str*) – the key for retrieving saved data from results. * **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value over all shot \[Default: False]. * **pershot** (*bool*) – if True save a list of expectation values for each shot of the simulation rather than the average over all shots \[Default: False]. @@ -25,48 +33,215 @@ The expectation value of a Hermitian operator $H$ for a simulator in quantum sta **ExtensionError** – if the input operator is invalid or not Hermitian. - This instruction can be directly appended to a circuit using the [`save_expectation_value()`](qiskit.providers.aer.library.save_expectation_value#qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value") circuit method. + This instruction can be directly appended to a circuit using the [`save_expectation_value()`](qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value") circuit method. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveExpectationValue.add_decomposition#qiskit.providers.aer.library.SaveExpectationValue.add_decomposition "qiskit.providers.aer.library.SaveExpectationValue.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveExpectationValue.assemble#qiskit.providers.aer.library.SaveExpectationValue.assemble "qiskit.providers.aer.library.SaveExpectationValue.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveExpectationValue.broadcast_arguments#qiskit.providers.aer.library.SaveExpectationValue.broadcast_arguments "qiskit.providers.aer.library.SaveExpectationValue.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveExpectationValue.c_if#qiskit.providers.aer.library.SaveExpectationValue.c_if "qiskit.providers.aer.library.SaveExpectationValue.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveExpectationValue.copy#qiskit.providers.aer.library.SaveExpectationValue.copy "qiskit.providers.aer.library.SaveExpectationValue.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveExpectationValue.inverse#qiskit.providers.aer.library.SaveExpectationValue.inverse "qiskit.providers.aer.library.SaveExpectationValue.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveExpectationValue.is_parameterized#qiskit.providers.aer.library.SaveExpectationValue.is_parameterized "qiskit.providers.aer.library.SaveExpectationValue.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveExpectationValue.mirror#qiskit.providers.aer.library.SaveExpectationValue.mirror "qiskit.providers.aer.library.SaveExpectationValue.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveExpectationValue.qasm#qiskit.providers.aer.library.SaveExpectationValue.qasm "qiskit.providers.aer.library.SaveExpectationValue.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveExpectationValue.repeat#qiskit.providers.aer.library.SaveExpectationValue.repeat "qiskit.providers.aer.library.SaveExpectationValue.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveExpectationValue.reverse_ops#qiskit.providers.aer.library.SaveExpectationValue.reverse_ops "qiskit.providers.aer.library.SaveExpectationValue.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveExpectationValue.soft_compare#qiskit.providers.aer.library.SaveExpectationValue.soft_compare "qiskit.providers.aer.library.SaveExpectationValue.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveExpectationValue.validate_parameter#qiskit.providers.aer.library.SaveExpectationValue.validate_parameter "qiskit.providers.aer.library.SaveExpectationValue.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveExpectationValue.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveExpectationValue.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveExpectationValue.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveExpectationValue.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveExpectationValue.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveExpectationValue.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveExpectationValue.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveExpectationValue.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveExpectationValue.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveExpectationValue.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveExpectationValue.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveExpectationValue.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveExpectationValue.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -76,14 +251,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 fbc82120f08..30a2d26ecec 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 @@ -1,8 +1,16 @@ -# SaveExpectationValueVariance +--- +title: SaveExpectationValueVariance +description: API reference for qiskit.providers.aer.library.SaveExpectationValueVariance +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveExpectationValueVariance +--- +# SaveExpectationValueVariance + -`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)` +`SaveExpectationValueVariance(operator, label='expectation_value_variance', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` @@ -14,7 +22,7 @@ The expectation value of a Hermitian operator $H$ for a simulator in quantum sta **Parameters** -* **operator** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. * **label** (*str*) – the key for retrieving saved data from results. * **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value over all shot \[Default: False]. * **pershot** (*bool*) – if True save a list of expectation values for each shot of the simulation rather than the average over all shots \[Default: False]. @@ -25,48 +33,215 @@ The expectation value of a Hermitian operator $H$ for a simulator in quantum sta **ExtensionError** – if the input operator is invalid or not Hermitian. - This instruction can be directly appended to a circuit using the [`save_expectation_value()`](qiskit.providers.aer.library.save_expectation_value#qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value") circuit method. + This instruction can be directly appended to a circuit using the [`save_expectation_value()`](qiskit.providers.aer.library.save_expectation_value "qiskit.providers.aer.library.save_expectation_value") circuit method. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveExpectationValueVariance.add_decomposition#qiskit.providers.aer.library.SaveExpectationValueVariance.add_decomposition "qiskit.providers.aer.library.SaveExpectationValueVariance.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveExpectationValueVariance.assemble#qiskit.providers.aer.library.SaveExpectationValueVariance.assemble "qiskit.providers.aer.library.SaveExpectationValueVariance.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveExpectationValueVariance.broadcast_arguments#qiskit.providers.aer.library.SaveExpectationValueVariance.broadcast_arguments "qiskit.providers.aer.library.SaveExpectationValueVariance.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveExpectationValueVariance.c_if#qiskit.providers.aer.library.SaveExpectationValueVariance.c_if "qiskit.providers.aer.library.SaveExpectationValueVariance.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveExpectationValueVariance.copy#qiskit.providers.aer.library.SaveExpectationValueVariance.copy "qiskit.providers.aer.library.SaveExpectationValueVariance.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveExpectationValueVariance.inverse#qiskit.providers.aer.library.SaveExpectationValueVariance.inverse "qiskit.providers.aer.library.SaveExpectationValueVariance.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveExpectationValueVariance.is_parameterized#qiskit.providers.aer.library.SaveExpectationValueVariance.is_parameterized "qiskit.providers.aer.library.SaveExpectationValueVariance.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveExpectationValueVariance.mirror#qiskit.providers.aer.library.SaveExpectationValueVariance.mirror "qiskit.providers.aer.library.SaveExpectationValueVariance.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveExpectationValueVariance.qasm#qiskit.providers.aer.library.SaveExpectationValueVariance.qasm "qiskit.providers.aer.library.SaveExpectationValueVariance.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveExpectationValueVariance.repeat#qiskit.providers.aer.library.SaveExpectationValueVariance.repeat "qiskit.providers.aer.library.SaveExpectationValueVariance.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveExpectationValueVariance.reverse_ops#qiskit.providers.aer.library.SaveExpectationValueVariance.reverse_ops "qiskit.providers.aer.library.SaveExpectationValueVariance.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveExpectationValueVariance.soft_compare#qiskit.providers.aer.library.SaveExpectationValueVariance.soft_compare "qiskit.providers.aer.library.SaveExpectationValueVariance.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveExpectationValueVariance.validate_parameter#qiskit.providers.aer.library.SaveExpectationValueVariance.validate_parameter "qiskit.providers.aer.library.SaveExpectationValueVariance.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveExpectationValueVariance.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveExpectationValueVariance.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveExpectationValueVariance.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveExpectationValueVariance.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveExpectationValueVariance.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveExpectationValueVariance.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveExpectationValueVariance.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveExpectationValueVariance.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveExpectationValueVariance.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveExpectationValueVariance.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveExpectationValueVariance.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveExpectationValueVariance.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveExpectationValueVariance.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -76,14 +251,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 428a55bab6c..db64cb57ee9 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 @@ -1,8 +1,16 @@ -# SaveMatrixProductState +--- +title: SaveMatrixProductState +description: API reference for qiskit.providers.aer.library.SaveMatrixProductState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveMatrixProductState +--- +# SaveMatrixProductState + -`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)` +`SaveMatrixProductState(num_qubits, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.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` @@ -23,43 +31,210 @@ Create new instruction to save the matrix product state. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveMatrixProductState.add_decomposition#qiskit.providers.aer.library.SaveMatrixProductState.add_decomposition "qiskit.providers.aer.library.SaveMatrixProductState.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveMatrixProductState.assemble#qiskit.providers.aer.library.SaveMatrixProductState.assemble "qiskit.providers.aer.library.SaveMatrixProductState.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveMatrixProductState.broadcast_arguments#qiskit.providers.aer.library.SaveMatrixProductState.broadcast_arguments "qiskit.providers.aer.library.SaveMatrixProductState.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveMatrixProductState.c_if#qiskit.providers.aer.library.SaveMatrixProductState.c_if "qiskit.providers.aer.library.SaveMatrixProductState.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveMatrixProductState.copy#qiskit.providers.aer.library.SaveMatrixProductState.copy "qiskit.providers.aer.library.SaveMatrixProductState.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveMatrixProductState.inverse#qiskit.providers.aer.library.SaveMatrixProductState.inverse "qiskit.providers.aer.library.SaveMatrixProductState.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveMatrixProductState.is_parameterized#qiskit.providers.aer.library.SaveMatrixProductState.is_parameterized "qiskit.providers.aer.library.SaveMatrixProductState.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveMatrixProductState.mirror#qiskit.providers.aer.library.SaveMatrixProductState.mirror "qiskit.providers.aer.library.SaveMatrixProductState.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveMatrixProductState.qasm#qiskit.providers.aer.library.SaveMatrixProductState.qasm "qiskit.providers.aer.library.SaveMatrixProductState.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveMatrixProductState.repeat#qiskit.providers.aer.library.SaveMatrixProductState.repeat "qiskit.providers.aer.library.SaveMatrixProductState.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveMatrixProductState.reverse_ops#qiskit.providers.aer.library.SaveMatrixProductState.reverse_ops "qiskit.providers.aer.library.SaveMatrixProductState.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveMatrixProductState.soft_compare#qiskit.providers.aer.library.SaveMatrixProductState.soft_compare "qiskit.providers.aer.library.SaveMatrixProductState.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveMatrixProductState.validate_parameter#qiskit.providers.aer.library.SaveMatrixProductState.validate_parameter "qiskit.providers.aer.library.SaveMatrixProductState.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveMatrixProductState.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveMatrixProductState.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveMatrixProductState.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveMatrixProductState.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveMatrixProductState.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveMatrixProductState.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveMatrixProductState.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveMatrixProductState.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveMatrixProductState.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveMatrixProductState.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveMatrixProductState.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveMatrixProductState.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveMatrixProductState.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +244,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 cc353cd658f..18382603f71 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 @@ -1,8 +1,16 @@ -# SaveProbabilities +--- +title: SaveProbabilities +description: API reference for qiskit.providers.aer.library.SaveProbabilities +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveProbabilities +--- +# SaveProbabilities + -`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)` +`SaveProbabilities(num_qubits, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` @@ -20,43 +28,210 @@ Instruction to save measurement probabilities vector. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveProbabilities.add_decomposition#qiskit.providers.aer.library.SaveProbabilities.add_decomposition "qiskit.providers.aer.library.SaveProbabilities.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveProbabilities.assemble#qiskit.providers.aer.library.SaveProbabilities.assemble "qiskit.providers.aer.library.SaveProbabilities.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveProbabilities.broadcast_arguments#qiskit.providers.aer.library.SaveProbabilities.broadcast_arguments "qiskit.providers.aer.library.SaveProbabilities.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveProbabilities.c_if#qiskit.providers.aer.library.SaveProbabilities.c_if "qiskit.providers.aer.library.SaveProbabilities.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveProbabilities.copy#qiskit.providers.aer.library.SaveProbabilities.copy "qiskit.providers.aer.library.SaveProbabilities.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveProbabilities.inverse#qiskit.providers.aer.library.SaveProbabilities.inverse "qiskit.providers.aer.library.SaveProbabilities.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveProbabilities.is_parameterized#qiskit.providers.aer.library.SaveProbabilities.is_parameterized "qiskit.providers.aer.library.SaveProbabilities.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveProbabilities.mirror#qiskit.providers.aer.library.SaveProbabilities.mirror "qiskit.providers.aer.library.SaveProbabilities.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveProbabilities.qasm#qiskit.providers.aer.library.SaveProbabilities.qasm "qiskit.providers.aer.library.SaveProbabilities.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveProbabilities.repeat#qiskit.providers.aer.library.SaveProbabilities.repeat "qiskit.providers.aer.library.SaveProbabilities.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveProbabilities.reverse_ops#qiskit.providers.aer.library.SaveProbabilities.reverse_ops "qiskit.providers.aer.library.SaveProbabilities.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveProbabilities.soft_compare#qiskit.providers.aer.library.SaveProbabilities.soft_compare "qiskit.providers.aer.library.SaveProbabilities.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveProbabilities.validate_parameter#qiskit.providers.aer.library.SaveProbabilities.validate_parameter "qiskit.providers.aer.library.SaveProbabilities.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveProbabilities.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveProbabilities.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveProbabilities.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveProbabilities.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveProbabilities.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveProbabilities.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveProbabilities.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveProbabilities.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveProbabilities.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveProbabilities.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveProbabilities.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveProbabilities.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveProbabilities.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -66,14 +241,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 4b1be86d743..22b425d8341 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 @@ -1,8 +1,16 @@ -# SaveProbabilitiesDict +--- +title: SaveProbabilitiesDict +description: API reference for qiskit.providers.aer.library.SaveProbabilitiesDict +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveProbabilitiesDict +--- +# SaveProbabilitiesDict + -`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)` +`SaveProbabilitiesDict(num_qubits, label='probabilities_dict', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveAverageData` @@ -20,43 +28,210 @@ Instruction to save measurement probabilities dict. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveProbabilitiesDict.add_decomposition#qiskit.providers.aer.library.SaveProbabilitiesDict.add_decomposition "qiskit.providers.aer.library.SaveProbabilitiesDict.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveProbabilitiesDict.assemble#qiskit.providers.aer.library.SaveProbabilitiesDict.assemble "qiskit.providers.aer.library.SaveProbabilitiesDict.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveProbabilitiesDict.broadcast_arguments#qiskit.providers.aer.library.SaveProbabilitiesDict.broadcast_arguments "qiskit.providers.aer.library.SaveProbabilitiesDict.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveProbabilitiesDict.c_if#qiskit.providers.aer.library.SaveProbabilitiesDict.c_if "qiskit.providers.aer.library.SaveProbabilitiesDict.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveProbabilitiesDict.copy#qiskit.providers.aer.library.SaveProbabilitiesDict.copy "qiskit.providers.aer.library.SaveProbabilitiesDict.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveProbabilitiesDict.inverse#qiskit.providers.aer.library.SaveProbabilitiesDict.inverse "qiskit.providers.aer.library.SaveProbabilitiesDict.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveProbabilitiesDict.is_parameterized#qiskit.providers.aer.library.SaveProbabilitiesDict.is_parameterized "qiskit.providers.aer.library.SaveProbabilitiesDict.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveProbabilitiesDict.mirror#qiskit.providers.aer.library.SaveProbabilitiesDict.mirror "qiskit.providers.aer.library.SaveProbabilitiesDict.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveProbabilitiesDict.qasm#qiskit.providers.aer.library.SaveProbabilitiesDict.qasm "qiskit.providers.aer.library.SaveProbabilitiesDict.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveProbabilitiesDict.repeat#qiskit.providers.aer.library.SaveProbabilitiesDict.repeat "qiskit.providers.aer.library.SaveProbabilitiesDict.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveProbabilitiesDict.reverse_ops#qiskit.providers.aer.library.SaveProbabilitiesDict.reverse_ops "qiskit.providers.aer.library.SaveProbabilitiesDict.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveProbabilitiesDict.soft_compare#qiskit.providers.aer.library.SaveProbabilitiesDict.soft_compare "qiskit.providers.aer.library.SaveProbabilitiesDict.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveProbabilitiesDict.validate_parameter#qiskit.providers.aer.library.SaveProbabilitiesDict.validate_parameter "qiskit.providers.aer.library.SaveProbabilitiesDict.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveProbabilitiesDict.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveProbabilitiesDict.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveProbabilitiesDict.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveProbabilitiesDict.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveProbabilitiesDict.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveProbabilitiesDict.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveProbabilitiesDict.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveProbabilitiesDict.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveProbabilitiesDict.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveProbabilitiesDict.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveProbabilitiesDict.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveProbabilitiesDict.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveProbabilitiesDict.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -66,14 +241,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 29ca28e84db..9c77eba94d7 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 @@ -1,8 +1,16 @@ -# SaveStabilizer +--- +title: SaveStabilizer +description: API reference for qiskit.providers.aer.library.SaveStabilizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveStabilizer +--- +# SaveStabilizer + -`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)` +`SaveStabilizer(num_qubits, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` @@ -23,43 +31,210 @@ Create new instruction to save the stabilizer simulator state. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveStabilizer.add_decomposition#qiskit.providers.aer.library.SaveStabilizer.add_decomposition "qiskit.providers.aer.library.SaveStabilizer.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveStabilizer.assemble#qiskit.providers.aer.library.SaveStabilizer.assemble "qiskit.providers.aer.library.SaveStabilizer.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveStabilizer.broadcast_arguments#qiskit.providers.aer.library.SaveStabilizer.broadcast_arguments "qiskit.providers.aer.library.SaveStabilizer.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveStabilizer.c_if#qiskit.providers.aer.library.SaveStabilizer.c_if "qiskit.providers.aer.library.SaveStabilizer.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveStabilizer.copy#qiskit.providers.aer.library.SaveStabilizer.copy "qiskit.providers.aer.library.SaveStabilizer.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveStabilizer.inverse#qiskit.providers.aer.library.SaveStabilizer.inverse "qiskit.providers.aer.library.SaveStabilizer.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveStabilizer.is_parameterized#qiskit.providers.aer.library.SaveStabilizer.is_parameterized "qiskit.providers.aer.library.SaveStabilizer.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveStabilizer.mirror#qiskit.providers.aer.library.SaveStabilizer.mirror "qiskit.providers.aer.library.SaveStabilizer.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveStabilizer.qasm#qiskit.providers.aer.library.SaveStabilizer.qasm "qiskit.providers.aer.library.SaveStabilizer.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveStabilizer.repeat#qiskit.providers.aer.library.SaveStabilizer.repeat "qiskit.providers.aer.library.SaveStabilizer.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveStabilizer.reverse_ops#qiskit.providers.aer.library.SaveStabilizer.reverse_ops "qiskit.providers.aer.library.SaveStabilizer.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveStabilizer.soft_compare#qiskit.providers.aer.library.SaveStabilizer.soft_compare "qiskit.providers.aer.library.SaveStabilizer.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveStabilizer.validate_parameter#qiskit.providers.aer.library.SaveStabilizer.validate_parameter "qiskit.providers.aer.library.SaveStabilizer.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveStabilizer.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveStabilizer.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveStabilizer.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveStabilizer.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveStabilizer.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveStabilizer.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveStabilizer.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveStabilizer.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveStabilizer.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveStabilizer.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveStabilizer.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveStabilizer.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveStabilizer.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +244,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 502836ca05f..b8b38a17639 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 @@ -1,8 +1,16 @@ -# SaveState +--- +title: SaveState +description: API reference for qiskit.providers.aer.library.SaveState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveState +--- +# SaveState + -`SaveState(num_qubits, label=None, pershot=False, conditional=False)` +`SaveState(num_qubits, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` @@ -27,43 +35,210 @@ The format of the saved state depends on the simulation method used. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveState.add_decomposition#qiskit.providers.aer.library.SaveState.add_decomposition "qiskit.providers.aer.library.SaveState.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveState.assemble#qiskit.providers.aer.library.SaveState.assemble "qiskit.providers.aer.library.SaveState.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveState.broadcast_arguments#qiskit.providers.aer.library.SaveState.broadcast_arguments "qiskit.providers.aer.library.SaveState.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveState.c_if#qiskit.providers.aer.library.SaveState.c_if "qiskit.providers.aer.library.SaveState.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveState.copy#qiskit.providers.aer.library.SaveState.copy "qiskit.providers.aer.library.SaveState.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveState.inverse#qiskit.providers.aer.library.SaveState.inverse "qiskit.providers.aer.library.SaveState.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveState.is_parameterized#qiskit.providers.aer.library.SaveState.is_parameterized "qiskit.providers.aer.library.SaveState.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveState.mirror#qiskit.providers.aer.library.SaveState.mirror "qiskit.providers.aer.library.SaveState.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveState.qasm#qiskit.providers.aer.library.SaveState.qasm "qiskit.providers.aer.library.SaveState.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveState.repeat#qiskit.providers.aer.library.SaveState.repeat "qiskit.providers.aer.library.SaveState.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveState.reverse_ops#qiskit.providers.aer.library.SaveState.reverse_ops "qiskit.providers.aer.library.SaveState.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveState.soft_compare#qiskit.providers.aer.library.SaveState.soft_compare "qiskit.providers.aer.library.SaveState.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveState.validate_parameter#qiskit.providers.aer.library.SaveState.validate_parameter "qiskit.providers.aer.library.SaveState.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveState.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveState.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveState.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveState.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveState.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveState.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveState.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveState.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveState.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveState.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveState.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveState.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveState.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -73,14 +248,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 68bacd001fc..0d4023041c8 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 @@ -1,8 +1,16 @@ -# SaveStatevector +--- +title: SaveStatevector +description: API reference for qiskit.providers.aer.library.SaveStatevector +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveStatevector +--- +# SaveStatevector + -`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)` +`SaveStatevector(num_qubits, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` @@ -23,43 +31,210 @@ Create new instruction to save the simulator statevector. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveStatevector.add_decomposition#qiskit.providers.aer.library.SaveStatevector.add_decomposition "qiskit.providers.aer.library.SaveStatevector.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveStatevector.assemble#qiskit.providers.aer.library.SaveStatevector.assemble "qiskit.providers.aer.library.SaveStatevector.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveStatevector.broadcast_arguments#qiskit.providers.aer.library.SaveStatevector.broadcast_arguments "qiskit.providers.aer.library.SaveStatevector.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveStatevector.c_if#qiskit.providers.aer.library.SaveStatevector.c_if "qiskit.providers.aer.library.SaveStatevector.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveStatevector.copy#qiskit.providers.aer.library.SaveStatevector.copy "qiskit.providers.aer.library.SaveStatevector.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveStatevector.inverse#qiskit.providers.aer.library.SaveStatevector.inverse "qiskit.providers.aer.library.SaveStatevector.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveStatevector.is_parameterized#qiskit.providers.aer.library.SaveStatevector.is_parameterized "qiskit.providers.aer.library.SaveStatevector.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveStatevector.mirror#qiskit.providers.aer.library.SaveStatevector.mirror "qiskit.providers.aer.library.SaveStatevector.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveStatevector.qasm#qiskit.providers.aer.library.SaveStatevector.qasm "qiskit.providers.aer.library.SaveStatevector.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveStatevector.repeat#qiskit.providers.aer.library.SaveStatevector.repeat "qiskit.providers.aer.library.SaveStatevector.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveStatevector.reverse_ops#qiskit.providers.aer.library.SaveStatevector.reverse_ops "qiskit.providers.aer.library.SaveStatevector.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveStatevector.soft_compare#qiskit.providers.aer.library.SaveStatevector.soft_compare "qiskit.providers.aer.library.SaveStatevector.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveStatevector.validate_parameter#qiskit.providers.aer.library.SaveStatevector.validate_parameter "qiskit.providers.aer.library.SaveStatevector.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveStatevector.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveStatevector.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveStatevector.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveStatevector.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveStatevector.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveStatevector.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveStatevector.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveStatevector.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveStatevector.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveStatevector.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveStatevector.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveStatevector.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveStatevector.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +244,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 a0c81f9ed20..e759602c281 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 @@ -1,8 +1,16 @@ -# SaveStatevectorDict +--- +title: SaveStatevectorDict +description: API reference for qiskit.providers.aer.library.SaveStatevectorDict +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveStatevectorDict +--- +# SaveStatevectorDict + -`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)` +`SaveStatevectorDict(num_qubits, label='statevector_dict', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` @@ -23,43 +31,210 @@ Create new instruction to save the simulator statevector as a dict. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveStatevectorDict.add_decomposition#qiskit.providers.aer.library.SaveStatevectorDict.add_decomposition "qiskit.providers.aer.library.SaveStatevectorDict.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveStatevectorDict.assemble#qiskit.providers.aer.library.SaveStatevectorDict.assemble "qiskit.providers.aer.library.SaveStatevectorDict.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveStatevectorDict.broadcast_arguments#qiskit.providers.aer.library.SaveStatevectorDict.broadcast_arguments "qiskit.providers.aer.library.SaveStatevectorDict.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveStatevectorDict.c_if#qiskit.providers.aer.library.SaveStatevectorDict.c_if "qiskit.providers.aer.library.SaveStatevectorDict.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveStatevectorDict.copy#qiskit.providers.aer.library.SaveStatevectorDict.copy "qiskit.providers.aer.library.SaveStatevectorDict.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveStatevectorDict.inverse#qiskit.providers.aer.library.SaveStatevectorDict.inverse "qiskit.providers.aer.library.SaveStatevectorDict.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveStatevectorDict.is_parameterized#qiskit.providers.aer.library.SaveStatevectorDict.is_parameterized "qiskit.providers.aer.library.SaveStatevectorDict.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveStatevectorDict.mirror#qiskit.providers.aer.library.SaveStatevectorDict.mirror "qiskit.providers.aer.library.SaveStatevectorDict.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveStatevectorDict.qasm#qiskit.providers.aer.library.SaveStatevectorDict.qasm "qiskit.providers.aer.library.SaveStatevectorDict.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveStatevectorDict.repeat#qiskit.providers.aer.library.SaveStatevectorDict.repeat "qiskit.providers.aer.library.SaveStatevectorDict.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveStatevectorDict.reverse_ops#qiskit.providers.aer.library.SaveStatevectorDict.reverse_ops "qiskit.providers.aer.library.SaveStatevectorDict.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveStatevectorDict.soft_compare#qiskit.providers.aer.library.SaveStatevectorDict.soft_compare "qiskit.providers.aer.library.SaveStatevectorDict.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveStatevectorDict.validate_parameter#qiskit.providers.aer.library.SaveStatevectorDict.validate_parameter "qiskit.providers.aer.library.SaveStatevectorDict.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveStatevectorDict.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveStatevectorDict.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveStatevectorDict.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveStatevectorDict.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveStatevectorDict.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveStatevectorDict.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveStatevectorDict.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveStatevectorDict.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveStatevectorDict.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveStatevectorDict.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveStatevectorDict.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveStatevectorDict.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveStatevectorDict.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -69,14 +244,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 2435a7ec424..0d8ad8e8c82 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 @@ -1,8 +1,16 @@ -# SaveSuperOp +--- +title: SaveSuperOp +description: API reference for qiskit.providers.aer.library.SaveSuperOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveSuperOp +--- +# SaveSuperOp + -`SaveSuperOp(num_qubits, label='superop', pershot=False)` +`SaveSuperOp(num_qubits, label='superop', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_superop.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` @@ -22,43 +30,210 @@ Create new instruction to save the superop simulator state. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveSuperOp.add_decomposition#qiskit.providers.aer.library.SaveSuperOp.add_decomposition "qiskit.providers.aer.library.SaveSuperOp.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveSuperOp.assemble#qiskit.providers.aer.library.SaveSuperOp.assemble "qiskit.providers.aer.library.SaveSuperOp.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveSuperOp.broadcast_arguments#qiskit.providers.aer.library.SaveSuperOp.broadcast_arguments "qiskit.providers.aer.library.SaveSuperOp.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveSuperOp.c_if#qiskit.providers.aer.library.SaveSuperOp.c_if "qiskit.providers.aer.library.SaveSuperOp.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveSuperOp.copy#qiskit.providers.aer.library.SaveSuperOp.copy "qiskit.providers.aer.library.SaveSuperOp.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveSuperOp.inverse#qiskit.providers.aer.library.SaveSuperOp.inverse "qiskit.providers.aer.library.SaveSuperOp.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveSuperOp.is_parameterized#qiskit.providers.aer.library.SaveSuperOp.is_parameterized "qiskit.providers.aer.library.SaveSuperOp.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveSuperOp.mirror#qiskit.providers.aer.library.SaveSuperOp.mirror "qiskit.providers.aer.library.SaveSuperOp.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveSuperOp.qasm#qiskit.providers.aer.library.SaveSuperOp.qasm "qiskit.providers.aer.library.SaveSuperOp.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveSuperOp.repeat#qiskit.providers.aer.library.SaveSuperOp.repeat "qiskit.providers.aer.library.SaveSuperOp.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveSuperOp.reverse_ops#qiskit.providers.aer.library.SaveSuperOp.reverse_ops "qiskit.providers.aer.library.SaveSuperOp.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveSuperOp.soft_compare#qiskit.providers.aer.library.SaveSuperOp.soft_compare "qiskit.providers.aer.library.SaveSuperOp.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveSuperOp.validate_parameter#qiskit.providers.aer.library.SaveSuperOp.validate_parameter "qiskit.providers.aer.library.SaveSuperOp.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveSuperOp.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveSuperOp.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveSuperOp.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveSuperOp.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveSuperOp.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveSuperOp.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveSuperOp.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveSuperOp.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveSuperOp.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveSuperOp.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveSuperOp.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveSuperOp.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveSuperOp.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -68,14 +243,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 24c6f650351..020d0728ea7 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 @@ -1,8 +1,16 @@ -# SaveUnitary +--- +title: SaveUnitary +description: API reference for qiskit.providers.aer.library.SaveUnitary +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SaveUnitary +--- +# SaveUnitary + -`SaveUnitary(num_qubits, label='unitary', pershot=False)` +`SaveUnitary(num_qubits, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Bases: `qiskit.providers.aer.library.save_instructions.save_data.SaveSingleData` @@ -22,43 +30,210 @@ Create new instruction to save the unitary simulator state. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SaveUnitary.add_decomposition#qiskit.providers.aer.library.SaveUnitary.add_decomposition "qiskit.providers.aer.library.SaveUnitary.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SaveUnitary.assemble#qiskit.providers.aer.library.SaveUnitary.assemble "qiskit.providers.aer.library.SaveUnitary.assemble") | Return the QasmQobjInstruction for the intructions. | -| [`broadcast_arguments`](qiskit.providers.aer.library.SaveUnitary.broadcast_arguments#qiskit.providers.aer.library.SaveUnitary.broadcast_arguments "qiskit.providers.aer.library.SaveUnitary.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SaveUnitary.c_if#qiskit.providers.aer.library.SaveUnitary.c_if "qiskit.providers.aer.library.SaveUnitary.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SaveUnitary.copy#qiskit.providers.aer.library.SaveUnitary.copy "qiskit.providers.aer.library.SaveUnitary.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SaveUnitary.inverse#qiskit.providers.aer.library.SaveUnitary.inverse "qiskit.providers.aer.library.SaveUnitary.inverse") | Special case. | -| [`is_parameterized`](qiskit.providers.aer.library.SaveUnitary.is_parameterized#qiskit.providers.aer.library.SaveUnitary.is_parameterized "qiskit.providers.aer.library.SaveUnitary.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SaveUnitary.mirror#qiskit.providers.aer.library.SaveUnitary.mirror "qiskit.providers.aer.library.SaveUnitary.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SaveUnitary.qasm#qiskit.providers.aer.library.SaveUnitary.qasm "qiskit.providers.aer.library.SaveUnitary.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SaveUnitary.repeat#qiskit.providers.aer.library.SaveUnitary.repeat "qiskit.providers.aer.library.SaveUnitary.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SaveUnitary.reverse_ops#qiskit.providers.aer.library.SaveUnitary.reverse_ops "qiskit.providers.aer.library.SaveUnitary.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SaveUnitary.soft_compare#qiskit.providers.aer.library.SaveUnitary.soft_compare "qiskit.providers.aer.library.SaveUnitary.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SaveUnitary.validate_parameter#qiskit.providers.aer.library.SaveUnitary.validate_parameter "qiskit.providers.aer.library.SaveUnitary.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SaveUnitary.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SaveUnitary.assemble()` + +Return the QasmQobjInstruction for the intructions. + +### broadcast\_arguments + + + +`SaveUnitary.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SaveUnitary.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SaveUnitary.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SaveUnitary.inverse()` + +Special case. Return self. + +### is\_parameterized + + + +`SaveUnitary.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SaveUnitary.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** + +**a new instruction with sub-instructions** + +reversed. + +**Return type** +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") +### qasm + + + +`SaveUnitary.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SaveUnitary.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SaveUnitary.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SaveUnitary.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SaveUnitary.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -68,14 +243,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 f2bc1c63a4a..1e490ce4ef7 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 @@ -1,8 +1,16 @@ -# SetDensityMatrix +--- +title: SetDensityMatrix +description: API reference for qiskit.providers.aer.library.SetDensityMatrix +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SetDensityMatrix +--- +# SetDensityMatrix + -`SetDensityMatrix(state)` +`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` @@ -12,7 +20,7 @@ Create new instruction to set the density matrix state of the simulator. **Parameters** -**state** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a density matrix. +**state** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a density matrix. **Raises** @@ -24,43 +32,226 @@ Create new instruction to set the density matrix state of the simulator. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SetDensityMatrix.add_decomposition#qiskit.providers.aer.library.SetDensityMatrix.add_decomposition "qiskit.providers.aer.library.SetDensityMatrix.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SetDensityMatrix.assemble#qiskit.providers.aer.library.SetDensityMatrix.assemble "qiskit.providers.aer.library.SetDensityMatrix.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.library.SetDensityMatrix.broadcast_arguments#qiskit.providers.aer.library.SetDensityMatrix.broadcast_arguments "qiskit.providers.aer.library.SetDensityMatrix.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SetDensityMatrix.c_if#qiskit.providers.aer.library.SetDensityMatrix.c_if "qiskit.providers.aer.library.SetDensityMatrix.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SetDensityMatrix.copy#qiskit.providers.aer.library.SetDensityMatrix.copy "qiskit.providers.aer.library.SetDensityMatrix.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SetDensityMatrix.inverse#qiskit.providers.aer.library.SetDensityMatrix.inverse "qiskit.providers.aer.library.SetDensityMatrix.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.providers.aer.library.SetDensityMatrix.is_parameterized#qiskit.providers.aer.library.SetDensityMatrix.is_parameterized "qiskit.providers.aer.library.SetDensityMatrix.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SetDensityMatrix.mirror#qiskit.providers.aer.library.SetDensityMatrix.mirror "qiskit.providers.aer.library.SetDensityMatrix.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SetDensityMatrix.qasm#qiskit.providers.aer.library.SetDensityMatrix.qasm "qiskit.providers.aer.library.SetDensityMatrix.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SetDensityMatrix.repeat#qiskit.providers.aer.library.SetDensityMatrix.repeat "qiskit.providers.aer.library.SetDensityMatrix.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SetDensityMatrix.reverse_ops#qiskit.providers.aer.library.SetDensityMatrix.reverse_ops "qiskit.providers.aer.library.SetDensityMatrix.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SetDensityMatrix.soft_compare#qiskit.providers.aer.library.SetDensityMatrix.soft_compare "qiskit.providers.aer.library.SetDensityMatrix.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SetDensityMatrix.validate_parameter#qiskit.providers.aer.library.SetDensityMatrix.validate_parameter "qiskit.providers.aer.library.SetDensityMatrix.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SetDensityMatrix.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SetDensityMatrix.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SetDensityMatrix.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SetDensityMatrix.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SetDensityMatrix.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SetDensityMatrix.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`SetDensityMatrix.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SetDensityMatrix.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). +**Returns** +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SetDensityMatrix.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SetDensityMatrix.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SetDensityMatrix.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SetDensityMatrix.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SetDensityMatrix.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -70,14 +261,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 42f9b3dbe79..2ba6b03db6e 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 @@ -1,8 +1,16 @@ -# SetMatrixProductState +--- +title: SetMatrixProductState +description: API reference for qiskit.providers.aer.library.SetMatrixProductState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SetMatrixProductState +--- +# SetMatrixProductState + -`SetMatrixProductState(state)` +`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` @@ -20,43 +28,226 @@ Create new instruction to set the matrix product state of the simulator. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SetMatrixProductState.add_decomposition#qiskit.providers.aer.library.SetMatrixProductState.add_decomposition "qiskit.providers.aer.library.SetMatrixProductState.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SetMatrixProductState.assemble#qiskit.providers.aer.library.SetMatrixProductState.assemble "qiskit.providers.aer.library.SetMatrixProductState.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.library.SetMatrixProductState.broadcast_arguments#qiskit.providers.aer.library.SetMatrixProductState.broadcast_arguments "qiskit.providers.aer.library.SetMatrixProductState.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SetMatrixProductState.c_if#qiskit.providers.aer.library.SetMatrixProductState.c_if "qiskit.providers.aer.library.SetMatrixProductState.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SetMatrixProductState.copy#qiskit.providers.aer.library.SetMatrixProductState.copy "qiskit.providers.aer.library.SetMatrixProductState.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SetMatrixProductState.inverse#qiskit.providers.aer.library.SetMatrixProductState.inverse "qiskit.providers.aer.library.SetMatrixProductState.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.providers.aer.library.SetMatrixProductState.is_parameterized#qiskit.providers.aer.library.SetMatrixProductState.is_parameterized "qiskit.providers.aer.library.SetMatrixProductState.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SetMatrixProductState.mirror#qiskit.providers.aer.library.SetMatrixProductState.mirror "qiskit.providers.aer.library.SetMatrixProductState.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SetMatrixProductState.qasm#qiskit.providers.aer.library.SetMatrixProductState.qasm "qiskit.providers.aer.library.SetMatrixProductState.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SetMatrixProductState.repeat#qiskit.providers.aer.library.SetMatrixProductState.repeat "qiskit.providers.aer.library.SetMatrixProductState.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SetMatrixProductState.reverse_ops#qiskit.providers.aer.library.SetMatrixProductState.reverse_ops "qiskit.providers.aer.library.SetMatrixProductState.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SetMatrixProductState.soft_compare#qiskit.providers.aer.library.SetMatrixProductState.soft_compare "qiskit.providers.aer.library.SetMatrixProductState.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SetMatrixProductState.validate_parameter#qiskit.providers.aer.library.SetMatrixProductState.validate_parameter "qiskit.providers.aer.library.SetMatrixProductState.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SetMatrixProductState.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SetMatrixProductState.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SetMatrixProductState.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SetMatrixProductState.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SetMatrixProductState.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SetMatrixProductState.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`SetMatrixProductState.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SetMatrixProductState.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** +**a new instruction with sub-instructions** +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SetMatrixProductState.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SetMatrixProductState.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SetMatrixProductState.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SetMatrixProductState.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SetMatrixProductState.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -66,14 +257,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 45b3f5cbb52..b0582a7713b 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 @@ -1,8 +1,16 @@ -# SetStabilizer +--- +title: SetStabilizer +description: API reference for qiskit.providers.aer.library.SetStabilizer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SetStabilizer +--- +# SetStabilizer + -`SetStabilizer(state)` +`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` @@ -12,7 +20,7 @@ Create new instruction to set the Clifford stabilizer state of the simulator. **Parameters** -**state** ([*Clifford*](qiskit.quantum_info.Clifford#qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – A clifford operator. +**state** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – A clifford operator. This set instruction must always be performed on the full width of qubits in a circuit, otherwise an exception will be raised during simulation. @@ -20,43 +28,226 @@ Create new instruction to set the Clifford stabilizer state of the simulator. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SetStabilizer.add_decomposition#qiskit.providers.aer.library.SetStabilizer.add_decomposition "qiskit.providers.aer.library.SetStabilizer.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SetStabilizer.assemble#qiskit.providers.aer.library.SetStabilizer.assemble "qiskit.providers.aer.library.SetStabilizer.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.library.SetStabilizer.broadcast_arguments#qiskit.providers.aer.library.SetStabilizer.broadcast_arguments "qiskit.providers.aer.library.SetStabilizer.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SetStabilizer.c_if#qiskit.providers.aer.library.SetStabilizer.c_if "qiskit.providers.aer.library.SetStabilizer.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SetStabilizer.copy#qiskit.providers.aer.library.SetStabilizer.copy "qiskit.providers.aer.library.SetStabilizer.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SetStabilizer.inverse#qiskit.providers.aer.library.SetStabilizer.inverse "qiskit.providers.aer.library.SetStabilizer.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.providers.aer.library.SetStabilizer.is_parameterized#qiskit.providers.aer.library.SetStabilizer.is_parameterized "qiskit.providers.aer.library.SetStabilizer.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SetStabilizer.mirror#qiskit.providers.aer.library.SetStabilizer.mirror "qiskit.providers.aer.library.SetStabilizer.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SetStabilizer.qasm#qiskit.providers.aer.library.SetStabilizer.qasm "qiskit.providers.aer.library.SetStabilizer.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SetStabilizer.repeat#qiskit.providers.aer.library.SetStabilizer.repeat "qiskit.providers.aer.library.SetStabilizer.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SetStabilizer.reverse_ops#qiskit.providers.aer.library.SetStabilizer.reverse_ops "qiskit.providers.aer.library.SetStabilizer.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SetStabilizer.soft_compare#qiskit.providers.aer.library.SetStabilizer.soft_compare "qiskit.providers.aer.library.SetStabilizer.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SetStabilizer.validate_parameter#qiskit.providers.aer.library.SetStabilizer.validate_parameter "qiskit.providers.aer.library.SetStabilizer.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SetStabilizer.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SetStabilizer.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SetStabilizer.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SetStabilizer.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SetStabilizer.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SetStabilizer.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`SetStabilizer.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SetStabilizer.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). + +**Returns** +**a new instruction with sub-instructions** +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SetStabilizer.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SetStabilizer.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SetStabilizer.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SetStabilizer.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SetStabilizer.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -66,14 +257,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 284022c1c27..79d105c1369 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 @@ -1,8 +1,16 @@ -# SetStatevector +--- +title: SetStatevector +description: API reference for qiskit.providers.aer.library.SetStatevector +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SetStatevector +--- +# SetStatevector + -`SetStatevector(state)` +`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` @@ -12,7 +20,7 @@ Create new instruction to set the statevector state of the simulator. **Parameters** -**state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – a statevector. +**state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – a statevector. **Raises** @@ -24,43 +32,226 @@ Create new instruction to set the statevector state of the simulator. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SetStatevector.add_decomposition#qiskit.providers.aer.library.SetStatevector.add_decomposition "qiskit.providers.aer.library.SetStatevector.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SetStatevector.assemble#qiskit.providers.aer.library.SetStatevector.assemble "qiskit.providers.aer.library.SetStatevector.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.library.SetStatevector.broadcast_arguments#qiskit.providers.aer.library.SetStatevector.broadcast_arguments "qiskit.providers.aer.library.SetStatevector.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SetStatevector.c_if#qiskit.providers.aer.library.SetStatevector.c_if "qiskit.providers.aer.library.SetStatevector.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SetStatevector.copy#qiskit.providers.aer.library.SetStatevector.copy "qiskit.providers.aer.library.SetStatevector.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SetStatevector.inverse#qiskit.providers.aer.library.SetStatevector.inverse "qiskit.providers.aer.library.SetStatevector.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.providers.aer.library.SetStatevector.is_parameterized#qiskit.providers.aer.library.SetStatevector.is_parameterized "qiskit.providers.aer.library.SetStatevector.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SetStatevector.mirror#qiskit.providers.aer.library.SetStatevector.mirror "qiskit.providers.aer.library.SetStatevector.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SetStatevector.qasm#qiskit.providers.aer.library.SetStatevector.qasm "qiskit.providers.aer.library.SetStatevector.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SetStatevector.repeat#qiskit.providers.aer.library.SetStatevector.repeat "qiskit.providers.aer.library.SetStatevector.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SetStatevector.reverse_ops#qiskit.providers.aer.library.SetStatevector.reverse_ops "qiskit.providers.aer.library.SetStatevector.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SetStatevector.soft_compare#qiskit.providers.aer.library.SetStatevector.soft_compare "qiskit.providers.aer.library.SetStatevector.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SetStatevector.validate_parameter#qiskit.providers.aer.library.SetStatevector.validate_parameter "qiskit.providers.aer.library.SetStatevector.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SetStatevector.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SetStatevector.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SetStatevector.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SetStatevector.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SetStatevector.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SetStatevector.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`SetStatevector.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SetStatevector.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). +**Returns** +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SetStatevector.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SetStatevector.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SetStatevector.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SetStatevector.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SetStatevector.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -70,14 +261,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 0d97bb1106e..22e1e4de639 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 @@ -1,8 +1,16 @@ -# SetSuperOp +--- +title: SetSuperOp +description: API reference for qiskit.providers.aer.library.SetSuperOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SetSuperOp +--- +# SetSuperOp + -`SetSuperOp(state)` +`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` @@ -24,43 +32,226 @@ Create new instruction to set the superop simulator state. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SetSuperOp.add_decomposition#qiskit.providers.aer.library.SetSuperOp.add_decomposition "qiskit.providers.aer.library.SetSuperOp.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SetSuperOp.assemble#qiskit.providers.aer.library.SetSuperOp.assemble "qiskit.providers.aer.library.SetSuperOp.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.library.SetSuperOp.broadcast_arguments#qiskit.providers.aer.library.SetSuperOp.broadcast_arguments "qiskit.providers.aer.library.SetSuperOp.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SetSuperOp.c_if#qiskit.providers.aer.library.SetSuperOp.c_if "qiskit.providers.aer.library.SetSuperOp.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SetSuperOp.copy#qiskit.providers.aer.library.SetSuperOp.copy "qiskit.providers.aer.library.SetSuperOp.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SetSuperOp.inverse#qiskit.providers.aer.library.SetSuperOp.inverse "qiskit.providers.aer.library.SetSuperOp.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.providers.aer.library.SetSuperOp.is_parameterized#qiskit.providers.aer.library.SetSuperOp.is_parameterized "qiskit.providers.aer.library.SetSuperOp.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SetSuperOp.mirror#qiskit.providers.aer.library.SetSuperOp.mirror "qiskit.providers.aer.library.SetSuperOp.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SetSuperOp.qasm#qiskit.providers.aer.library.SetSuperOp.qasm "qiskit.providers.aer.library.SetSuperOp.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SetSuperOp.repeat#qiskit.providers.aer.library.SetSuperOp.repeat "qiskit.providers.aer.library.SetSuperOp.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SetSuperOp.reverse_ops#qiskit.providers.aer.library.SetSuperOp.reverse_ops "qiskit.providers.aer.library.SetSuperOp.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SetSuperOp.soft_compare#qiskit.providers.aer.library.SetSuperOp.soft_compare "qiskit.providers.aer.library.SetSuperOp.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SetSuperOp.validate_parameter#qiskit.providers.aer.library.SetSuperOp.validate_parameter "qiskit.providers.aer.library.SetSuperOp.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SetSuperOp.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SetSuperOp.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SetSuperOp.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SetSuperOp.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SetSuperOp.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SetSuperOp.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`SetSuperOp.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SetSuperOp.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). +**Returns** +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SetSuperOp.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SetSuperOp.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SetSuperOp.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SetSuperOp.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SetSuperOp.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -70,14 +261,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 aa9f79780ff..35c61148419 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 @@ -1,8 +1,16 @@ -# SetUnitary +--- +title: SetUnitary +description: API reference for qiskit.providers.aer.library.SetUnitary +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.library.SetUnitary +--- +# SetUnitary + -`SetUnitary(state)` +`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` @@ -12,7 +20,7 @@ Create new instruction to set the unitary simulator state. **Parameters** -**state** ([*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – A unitary matrix. +**state** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – A unitary matrix. **Raises** @@ -24,43 +32,226 @@ Create new instruction to set the unitary simulator state. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | -| [`add_decomposition`](qiskit.providers.aer.library.SetUnitary.add_decomposition#qiskit.providers.aer.library.SetUnitary.add_decomposition "qiskit.providers.aer.library.SetUnitary.add_decomposition") | Add a decomposition of the instruction to the SessionEquivalenceLibrary. | -| [`assemble`](qiskit.providers.aer.library.SetUnitary.assemble#qiskit.providers.aer.library.SetUnitary.assemble "qiskit.providers.aer.library.SetUnitary.assemble") | Assemble a QasmQobjInstruction | -| [`broadcast_arguments`](qiskit.providers.aer.library.SetUnitary.broadcast_arguments#qiskit.providers.aer.library.SetUnitary.broadcast_arguments "qiskit.providers.aer.library.SetUnitary.broadcast_arguments") | Validation of the arguments. | -| [`c_if`](qiskit.providers.aer.library.SetUnitary.c_if#qiskit.providers.aer.library.SetUnitary.c_if "qiskit.providers.aer.library.SetUnitary.c_if") | Add classical condition on register or cbit classical and value val. | -| [`copy`](qiskit.providers.aer.library.SetUnitary.copy#qiskit.providers.aer.library.SetUnitary.copy "qiskit.providers.aer.library.SetUnitary.copy") | Copy of the instruction. | -| [`inverse`](qiskit.providers.aer.library.SetUnitary.inverse#qiskit.providers.aer.library.SetUnitary.inverse "qiskit.providers.aer.library.SetUnitary.inverse") | Invert this instruction. | -| [`is_parameterized`](qiskit.providers.aer.library.SetUnitary.is_parameterized#qiskit.providers.aer.library.SetUnitary.is_parameterized "qiskit.providers.aer.library.SetUnitary.is_parameterized") | Return True .IFF. | -| [`mirror`](qiskit.providers.aer.library.SetUnitary.mirror#qiskit.providers.aer.library.SetUnitary.mirror "qiskit.providers.aer.library.SetUnitary.mirror") | DEPRECATED: use instruction.reverse\_ops(). | -| [`qasm`](qiskit.providers.aer.library.SetUnitary.qasm#qiskit.providers.aer.library.SetUnitary.qasm "qiskit.providers.aer.library.SetUnitary.qasm") | Return a default OpenQASM string for the instruction. | -| [`repeat`](qiskit.providers.aer.library.SetUnitary.repeat#qiskit.providers.aer.library.SetUnitary.repeat "qiskit.providers.aer.library.SetUnitary.repeat") | Creates an instruction with gate repeated n amount of times. | -| [`reverse_ops`](qiskit.providers.aer.library.SetUnitary.reverse_ops#qiskit.providers.aer.library.SetUnitary.reverse_ops "qiskit.providers.aer.library.SetUnitary.reverse_ops") | For a composite instruction, reverse the order of sub-instructions. | -| [`soft_compare`](qiskit.providers.aer.library.SetUnitary.soft_compare#qiskit.providers.aer.library.SetUnitary.soft_compare "qiskit.providers.aer.library.SetUnitary.soft_compare") | Soft comparison between gates. | -| [`validate_parameter`](qiskit.providers.aer.library.SetUnitary.validate_parameter#qiskit.providers.aer.library.SetUnitary.validate_parameter "qiskit.providers.aer.library.SetUnitary.validate_parameter") | Instruction parameters has no validation or normalization. | +### add\_decomposition -## Attributes + + +`SetUnitary.add_decomposition(decomposition)` + +Add a decomposition of the instruction to the SessionEquivalenceLibrary. + +### assemble + + + +`SetUnitary.assemble()` + +Assemble a QasmQobjInstruction + +### broadcast\_arguments + + + +`SetUnitary.broadcast_arguments(qargs, cargs)` + +Validation of the arguments. + +**Parameters** + +* **qargs** (*List*) – List of quantum bit arguments. +* **cargs** (*List*) – List of classical bit arguments. + +**Yields** + +*Tuple(List, List)* – A tuple with single arguments. + +**Raises** + +**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation. + +### c\_if + + + +`SetUnitary.c_if(classical, val)` + +Add classical condition on register or cbit classical and value val. + +### copy + + + +`SetUnitary.copy(name=None)` + +Copy of the instruction. + +**Parameters** + +**name** (*str*) – name to be given to the copied circuit, if None then the name stays the same. + +**Returns** + +**a copy of the current instruction, with the name** + +updated if it was provided + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### inverse + + + +`SetUnitary.inverse()` + +Invert this instruction. + +If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted. + +Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.) + +**Returns** + +a fresh instruction for the inverse + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – if the instruction is not composite and an inverse has not been implemented for it. + +### is\_parameterized + + + +`SetUnitary.is_parameterized()` + +Return True .IFF. instruction is parameterized else False + +### mirror + + + +`SetUnitary.mirror()` + +DEPRECATED: use instruction.reverse\_ops(). +**Returns** +**a new instruction with sub-instructions** + +reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### qasm + + + +`SetUnitary.qasm()` + +Return a default OpenQASM string for the instruction. + +Derived instructions may override this to print in a different format (e.g. measure q\[0] -> c\[0];). + +### repeat + + + +`SetUnitary.repeat(n)` + +Creates an instruction with gate repeated n amount of times. + +**Parameters** + +**n** (*int*) – Number of times to repeat the instruction + +**Returns** + +Containing the definition. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**CircuitError** – If n \< 1. + +### reverse\_ops + + + +`SetUnitary.reverse_ops()` + +For a composite instruction, reverse the order of sub-instructions. + +This is done by recursively reversing all sub-instructions. It does not invert any gate. + +**Returns** + +**a new instruction with** + +sub-instructions reversed. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +### soft\_compare + + + +`SetUnitary.soft_compare(other)` + +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. + +**Parameters** + +**other** (*instruction*) – other instruction. + +**Returns** + +are self and other equal up to parameter expressions. + +**Return type** + +bool + +### validate\_parameter + + + +`SetUnitary.validate_parameter(parameter)` + +Instruction parameters has no validation or normalization. + +## Attributes + + ### decompositions Get the decompositions of the instruction from the SessionEquivalenceLibrary. - + ### definition Return definition in terms of other basic gates. - + ### duration Get the duration. - + ### label @@ -70,14 +261,15 @@ Return instruction label `str` - + ### params return instruction params. - + ### unit Get the time unit of duration. + 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 ea79a97a90b..d0fd751daa9 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_amplitudes +--- +title: save_amplitudes +description: API reference for qiskit.providers.aer.library.save_amplitudes +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_amplitudes +--- +# qiskit.providers.aer.library.save\_amplitudes + -`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)` +`save_amplitudes(self, params, label='amplitudes', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save complex statevector amplitudes. @@ -19,8 +27,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – if params is invalid for the specified number of qubits. + 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 f8fc0606a6d..c8e82191ee3 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_amplitudes\_squared +--- +title: save_amplitudes_squared +description: API reference for qiskit.providers.aer.library.save_amplitudes_squared +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_amplitudes_squared +--- +# qiskit.providers.aer.library.save\_amplitudes\_squared + -`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)` +`save_amplitudes_squared(self, params, label='amplitudes_squared', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_amplitudes.py "view source code") Save squared statevector amplitudes (probabilities). @@ -20,8 +28,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – if params is invalid for the specified number of qubits. + 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 40e8e153c6a..c292865e173 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_density\_matrix +--- +title: save_density_matrix +description: API reference for qiskit.providers.aer.library.save_density_matrix +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_density_matrix +--- +# qiskit.providers.aer.library.save\_density\_matrix + -`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)` +`save_density_matrix(self, qubits=None, label='density_matrix', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_density_matrix.py "view source code") Save the current simulator quantum state as a density matrix. @@ -20,4 +28,5 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 bba7144ba37..afb0aa6b5cd 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.library.save\_expectation\_value +--- +title: save_expectation_value +description: API reference for qiskit.providers.aer.library.save_expectation_value +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_expectation_value +--- +# qiskit.providers.aer.library.save\_expectation\_value + -`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)` +`save_expectation_value(self, operator, qubits, label='expectation_value', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_expectation_value.py "view source code") Save the expectation value of a Hermitian operator. **Parameters** -* **operator** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. * **qubits** (*list*) – circuit qubits to apply instruction. * **label** (*str*) – the key for retrieving saved data from results. * **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value over all shot \[Default: False]. @@ -21,12 +29,13 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – if the input operator is invalid or not Hermitian. - This method appends a [`SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue#qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue") instruction to the quantum circuit. + This method appends a [`SaveExpectationValue`](qiskit.providers.aer.library.SaveExpectationValue "qiskit.providers.aer.library.SaveExpectationValue") instruction to the quantum circuit. + 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 d265acb4234..cad935698d1 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.library.save\_expectation\_value\_variance +--- +title: save_expectation_value_variance +description: API reference for qiskit.providers.aer.library.save_expectation_value_variance +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_expectation_value_variance +--- +# 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)` +`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. **Parameters** -* **operator** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. +* **operator** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") *or*[*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Hermitian operator. * **qubits** (*list*) – circuit qubits to apply instruction. * **label** (*str*) – the key for retrieving saved data from results. * **unnormalized** (*bool*) – If True return save the unnormalized accumulated or conditional accumulated expectation value and variance over all shot \[Default: False]. @@ -21,12 +29,13 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – if the input operator is invalid or not Hermitian. - This method appends a [`SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance#qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance") instruction to the quantum circuit. + This method appends a [`SaveExpectationValueVariance`](qiskit.providers.aer.library.SaveExpectationValueVariance "qiskit.providers.aer.library.SaveExpectationValueVariance") instruction to the quantum circuit. + 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 f4c2c5b16e7..ad9329fb5b6 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_matrix\_product\_state +--- +title: save_matrix_product_state +description: API reference for qiskit.providers.aer.library.save_matrix_product_state +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_matrix_product_state +--- +# qiskit.providers.aer.library.save\_matrix\_product\_state + -`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)` +`save_matrix_product_state(self, label='matrix_product_state', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.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. @@ -18,4 +26,5 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 732218e7cbd..98709e41a00 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_probabilities +--- +title: save_probabilities +description: API reference for qiskit.providers.aer.library.save_probabilities +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_probabilities +--- +# qiskit.providers.aer.library.save\_probabilities + -`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` +`save_probabilities(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. @@ -20,4 +28,5 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 985ecacf15b..232f5123a85 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_probabilities\_dict +--- +title: save_probabilities_dict +description: API reference for qiskit.providers.aer.library.save_probabilities_dict +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_probabilities_dict +--- +# qiskit.providers.aer.library.save\_probabilities\_dict + -`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)` +`save_probabilities_dict(self, qubits=None, label='probabilities', unnormalized=False, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_probabilities.py "view source code") Save measurement outcome probabilities vector. @@ -20,4 +28,5 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 83c7cbd7b30..caa96c0dad7 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_stabilizer +--- +title: save_stabilizer +description: API reference for qiskit.providers.aer.library.save_stabilizer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_stabilizer +--- +# qiskit.providers.aer.library.save\_stabilizer + -`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)` +`save_stabilizer(self, label='stabilizer', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_stabilizer.py "view source code") Save the current stabilizer simulator quantum state as a Clifford. @@ -18,8 +26,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") This instruction is always defined across all qubits in a circuit. + 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 3bb5548e355..5b43901211e 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_state +--- +title: save_state +description: API reference for qiskit.providers.aer.library.save_state +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_state +--- +# qiskit.providers.aer.library.save\_state + -`save_state(self, label=None, pershot=False, conditional=False)` +`save_state(self, label=None, pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_state.py "view source code") Save the current simulator quantum state. @@ -18,4 +26,5 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + 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 8946adb6ae9..910688c4069 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_statevector +--- +title: save_statevector +description: API reference for qiskit.providers.aer.library.save_statevector +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_statevector +--- +# qiskit.providers.aer.library.save\_statevector + -`save_statevector(self, label='statevector', pershot=False, conditional=False)` +`save_statevector(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_statevector.py "view source code") Save the current simulator quantum state as a statevector. @@ -18,8 +26,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") This instruction is always defined across all qubits in a circuit. + 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 b06e8871c2b..3e042263bd0 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_statevector\_dict +--- +title: save_statevector_dict +description: API reference for qiskit.providers.aer.library.save_statevector_dict +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_statevector_dict +--- +# qiskit.providers.aer.library.save\_statevector\_dict + -`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)` +`save_statevector_dict(self, label='statevector', pershot=False, conditional=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.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. @@ -18,8 +26,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") This instruction is always defined across all qubits in a circuit. + 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 b3eb49c3577..3900cf9ef44 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.save\_unitary +--- +title: save_unitary +description: API reference for qiskit.providers.aer.library.save_unitary +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.save_unitary +--- +# qiskit.providers.aer.library.save\_unitary + -`save_unitary(self, label='unitary', pershot=False)` +`save_unitary(self, label='unitary', pershot=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/save_instructions/save_unitary.py "view source code") Save the current state of the unitary simulator. @@ -17,8 +25,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") This instruction is always defined across all qubits in a circuit. + 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 34a2ae2615a..62f93bfba5c 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.library.set\_density\_matrix +--- +title: set_density_matrix +description: API reference for qiskit.providers.aer.library.set_density_matrix +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.set_density_matrix +--- +# qiskit.providers.aer.library.set\_density\_matrix + -`set_density_matrix(self, state)` +`set_density_matrix(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_density_matrix.py "view source code") Set the density matrix state of the simulator. **Parameters** -**state** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a density matrix. +**state** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a density matrix. **Returns** @@ -16,8 +24,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – If the density matrix is the incorrect size for the current circuit. + 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 7e9587ef7de..07cb9ac48f9 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.set\_matrix\_product\_state +--- +title: set_matrix_product_state +description: API reference for qiskit.providers.aer.library.set_matrix_product_state +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.set_matrix_product_state +--- +# qiskit.providers.aer.library.set\_matrix\_product\_state + -`set_matrix_product_state(self, state)` +`set_matrix_product_state(self, state)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/library/set_instructions/set_matrix_product_state.py "view source code") Set the matrix product state of the simulator. @@ -16,8 +24,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – If the structure of the state is incorrect + 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 21c71d69de7..47ce108bc7f 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.library.set\_stabilizer +--- +title: set_stabilizer +description: API reference for qiskit.providers.aer.library.set_stabilizer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.set_stabilizer +--- +# qiskit.providers.aer.library.set\_stabilizer + -`set_stabilizer(self, state)` +`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. **Parameters** -**state** ([*Clifford*](qiskit.quantum_info.Clifford#qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – A clifford operator. +**state** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – A clifford operator. **Returns** @@ -16,8 +24,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – If the state is the incorrect size for the current circuit. + 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 40831c22fc9..caf2c8ae80d 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.library.set\_statevector +--- +title: set_statevector +description: API reference for qiskit.providers.aer.library.set_statevector +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.set_statevector +--- +# qiskit.providers.aer.library.set\_statevector + -`set_statevector(self, state)` +`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. **Parameters** -**state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – A state matrix. +**state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – A state matrix. **Returns** @@ -16,8 +24,9 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** **ExtensionError** – If the state is the incorrect size for the current circuit. + 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 d2619713a27..a71d2be2b79 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.library.set\_superop +--- +title: set_superop +description: API reference for qiskit.providers.aer.library.set_superop +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.set_superop +--- +# qiskit.providers.aer.library.set\_superop + -`set_superop(self, state)` +`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. @@ -16,9 +24,10 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** * **ExtensionError** – If the state is the incorrect size for the current circuit. * **ExtensionError** – if the input QuantumChannel is not CPTP. + 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 746feb48d6f..318fc9eccab 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.library.set\_unitary +--- +title: set_unitary +description: API reference for qiskit.providers.aer.library.set_unitary +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.library.set_unitary +--- +# qiskit.providers.aer.library.set\_unitary + -`set_unitary(self, state)` +`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. **Parameters** -**state** ([*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – A state matrix. +**state** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – A state matrix. **Returns** @@ -16,9 +24,10 @@ with attached instruction. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") **Raises** * **ExtensionError** – If the state is the incorrect size for the current circuit. * **ExtensionError** – if the input matrix is not unitary. + 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 a22e820a85f..b7e7e1dd885 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 @@ -1,18 +1,26 @@ -# NoiseModel +--- +title: NoiseModel +description: API reference for qiskit.providers.aer.noise.NoiseModel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.noise.NoiseModel +--- +# NoiseModel + -`NoiseModel(basis_gates=None)` +`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` Noise model class for Qiskit Aer simulators. -This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator#qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. +This class is used to represent noise model for the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). It can be used to construct custom noise models for simulator, or to automatically generate a basic device noise model for an IBMQ backend. See the [`noise`](aer_noise#module-qiskit.providers.aer.noise "qiskit.providers.aer.noise") module documentation for additional information. **Example: Basic device noise model** -An approximate [`NoiseModel`](#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") can be generated automatically from the properties of real device backends from the IBMQ provider using the [`from_backend()`](qiskit.providers.aer.noise.NoiseModel.from_backend#qiskit.providers.aer.noise.NoiseModel.from_backend "qiskit.providers.aer.noise.NoiseModel.from_backend") method. +An approximate [`NoiseModel`](#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") can be generated automatically from the properties of real device backends from the IBMQ provider using the [`from_backend()`](qiskit.providers.aer.noise.NoiseModel#from_backend "qiskit.providers.aer.noise.NoiseModel.from_backend") method. ```python from qiskit import IBMQ, Aer @@ -26,7 +34,7 @@ print(noise_model) **Example: Custom noise model** -Custom noise models can be used by adding [`QuantumError`](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") to circuit gate, reset or measure instructions, and [`ReadoutError`](qiskit.providers.aer.noise.ReadoutError#qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") to measure instructions. +Custom noise models can be used by adding [`QuantumError`](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") to circuit gate, reset or measure instructions, and [`ReadoutError`](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") to measure instructions. ```python import qiskit.providers.aer.noise as noise @@ -52,40 +60,282 @@ Initialize an empty noise model. **basis\_gates** (*list\[str] or None*) – Specify an initial basis\_gates for the noise model. If None a default value of \[‘id’, ‘rz’, ‘sx’, ‘cx’] is used (Default: None). -Additional Information: Errors added to the noise model will have their instruction appended to the noise model basis\_gates if the instruction is in the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator#qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator") basis\_gates. If the instruction is not in the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator#qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator") basis\_gates it is assumed to be a label for a standard gate, and that gate should be added to the NoiseModel basis\_gates either using the init method, or the [`add_basis_gates()`](qiskit.providers.aer.noise.NoiseModel.add_basis_gates#qiskit.providers.aer.noise.NoiseModel.add_basis_gates "qiskit.providers.aer.noise.NoiseModel.add_basis_gates") method. +Additional Information: Errors added to the noise model will have their instruction appended to the noise model basis\_gates if the instruction is in the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator") basis\_gates. If the instruction is not in the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator") basis\_gates it is assumed to be a label for a standard gate, and that gate should be added to the NoiseModel basis\_gates either using the init method, or the [`add_basis_gates()`](qiskit.providers.aer.noise.NoiseModel#add_basis_gates "qiskit.providers.aer.noise.NoiseModel.add_basis_gates") method. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`add_all_qubit_quantum_error`](qiskit.providers.aer.noise.NoiseModel.add_all_qubit_quantum_error#qiskit.providers.aer.noise.NoiseModel.add_all_qubit_quantum_error "qiskit.providers.aer.noise.NoiseModel.add_all_qubit_quantum_error") | Add a quantum error to the noise model that applies to all qubits. | -| [`add_all_qubit_readout_error`](qiskit.providers.aer.noise.NoiseModel.add_all_qubit_readout_error#qiskit.providers.aer.noise.NoiseModel.add_all_qubit_readout_error "qiskit.providers.aer.noise.NoiseModel.add_all_qubit_readout_error") | Add a single-qubit readout error that applies measure on all qubits. | -| [`add_basis_gates`](qiskit.providers.aer.noise.NoiseModel.add_basis_gates#qiskit.providers.aer.noise.NoiseModel.add_basis_gates "qiskit.providers.aer.noise.NoiseModel.add_basis_gates") | Add additional gates to the noise model basis\_gates. | -| [`add_nonlocal_quantum_error`](qiskit.providers.aer.noise.NoiseModel.add_nonlocal_quantum_error#qiskit.providers.aer.noise.NoiseModel.add_nonlocal_quantum_error "qiskit.providers.aer.noise.NoiseModel.add_nonlocal_quantum_error") | Add a non-local quantum error to the noise model (DEPRECATED). | -| [`add_quantum_error`](qiskit.providers.aer.noise.NoiseModel.add_quantum_error#qiskit.providers.aer.noise.NoiseModel.add_quantum_error "qiskit.providers.aer.noise.NoiseModel.add_quantum_error") | Add a quantum error to the noise model. | -| [`add_readout_error`](qiskit.providers.aer.noise.NoiseModel.add_readout_error#qiskit.providers.aer.noise.NoiseModel.add_readout_error "qiskit.providers.aer.noise.NoiseModel.add_readout_error") | Add a readout error to the noise model. | -| [`from_backend`](qiskit.providers.aer.noise.NoiseModel.from_backend#qiskit.providers.aer.noise.NoiseModel.from_backend "qiskit.providers.aer.noise.NoiseModel.from_backend") | Return a noise model derived from a devices backend properties. | -| [`from_dict`](qiskit.providers.aer.noise.NoiseModel.from_dict#qiskit.providers.aer.noise.NoiseModel.from_dict "qiskit.providers.aer.noise.NoiseModel.from_dict") | Load NoiseModel from a dictionary. | -| [`is_ideal`](qiskit.providers.aer.noise.NoiseModel.is_ideal#qiskit.providers.aer.noise.NoiseModel.is_ideal "qiskit.providers.aer.noise.NoiseModel.is_ideal") | Return True if the noise model has no noise terms. | -| [`reset`](qiskit.providers.aer.noise.NoiseModel.reset#qiskit.providers.aer.noise.NoiseModel.reset "qiskit.providers.aer.noise.NoiseModel.reset") | Reset the noise model. | -| [`to_dict`](qiskit.providers.aer.noise.NoiseModel.to_dict#qiskit.providers.aer.noise.NoiseModel.to_dict "qiskit.providers.aer.noise.NoiseModel.to_dict") | Return the noise model as a dictionary. | +### add\_all\_qubit\_quantum\_error -## Attributes + + +`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. + +**Parameters** + +* **error** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – the quantum error object. +* \*\*(****str**** or ****list****\[****str****] \*\***or** (*instructions*) – Instruction or list\[Instruction]): the instructions error applies to. +* **warnings** (*bool*) – Display warning if appending to an instruction that already has an error (Default: True). + +**Raises** + +**NoiseError** – if the input parameters are invalid. + +#### Additional Information: + +If the error object is ideal it will not be added to the model. + +### add\_all\_qubit\_readout\_error + + + +`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. + +**Parameters** + +* **error** ([*ReadoutError*](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")) – the quantum error object. +* **warnings** (*bool*) – Display warning if appending to an instruction that already has an error (Default: True) + +**Raises** + +**NoiseError** – if the input parameters are invalid. + +#### Additional Information: + +If the error object is ideal it will not be added to the model. + +### add\_basis\_gates + + + +`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. + +This should be used to add any gates that are identified by a custom gate label in the noise model. + +**Parameters** + +* \*\*(****list****\[****str****] \*\***or** (*instructions*) – list\[Instruction]): the instructions error applies to. +* **warnings** (*bool*) – display warning if instruction is not in QasmSimulator basis\_gates (Default: True). + +### add\_nonlocal\_quantum\_error + + + +`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). + + + Adding nonlocal noise to a noise model is deprecated and will be removed no earlier than 3 months from the qiskit-aer 0.9.0 release date. To add non-local noise to a circuit you should write a custom qiskit transpiler pass. + + +**Parameters** + +* **error** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – the quantum error object. +* \*\*(****str**** or ****list****\[****str****] \*\***or** (*instructions*) – Instruction or list\[Instruction]): the instructions error applies to. +* **qubits** (*list\[int]*) – qubits instruction error applies to. +* **noise\_qubits** (*list\[int]*) – Specify the exact qubits the error should be applied to if different to the instruction qubits. +* **warnings** (*bool*) – Display warning if appending to an instruction that already has an error (Default: True). + +**Raises** + +**NoiseError** – if the input parameters are invalid. + +#### Additional Information: + +If the error object is ideal it will not be added to the model. + +### add\_quantum\_error + + + +`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. + +**Parameters** + +* **error** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – the quantum error object. +* \*\*(****str**** or ****list****\[****str****] \*\***or** (*instructions*) – Instruction or list\[Instruction]): the instructions error applies to. +* **qubits** (*list\[int]*) – qubits instruction error applies to. +* **warnings** (*bool*) – Display warning if appending to an instruction that already has an error (Default: True). + +**Raises** + +**NoiseError** – if the input parameters are invalid. + +#### Additional Information: + +If the error object is ideal it will not be added to the model. + +### add\_readout\_error + + + +`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. + +**Parameters** + +* **error** ([*ReadoutError*](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")) – the quantum error object. +* **qubits** (*list\[int]*) – qubits instruction error applies to. +* **warnings** (*bool*) – Display warning if appending to an instruction that already has an error \[Default: True] + +**Raises** + +**NoiseError** – if the input parameters are invalid. + +#### Additional Information: + +If the error object is ideal it will not be added to the model. +### from\_backend + + +`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. + +This function generates a noise model based on: + +* 1 and 2 qubit gate errors consisting of a [`depolarizing_error()`](qiskit.providers.aer.noise.depolarizing_error "qiskit.providers.aer.noise.depolarizing_error") followed by a [`thermal_relaxation_error()`](qiskit.providers.aer.noise.thermal_relaxation_error "qiskit.providers.aer.noise.thermal_relaxation_error"). +* Single qubit [`ReadoutError`](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") on all measurements. + +The Error error parameters are tuned for each individual qubit based on the $T_1$, $T_2$, frequency and readout error parameters for each qubit, and the gate error and gate time parameters for each gate obtained from the device backend properties. + +**Additional Information** + +The noise model includes the following errors: + +* If `readout_error=True` include single qubit readout errors on measurements. + +* If `gate_error=True` and `thermal_relaxation=True` include: + + > * Single-qubit gate errors consisting of a [`depolarizing_error()`](qiskit.providers.aer.noise.depolarizing_error "qiskit.providers.aer.noise.depolarizing_error") followed by a [`thermal_relaxation_error()`](qiskit.providers.aer.noise.thermal_relaxation_error "qiskit.providers.aer.noise.thermal_relaxation_error") for the qubit the gate acts on. + > * Two-qubit gate errors consisting of a 2-qubit [`depolarizing_error()`](qiskit.providers.aer.noise.depolarizing_error "qiskit.providers.aer.noise.depolarizing_error") followed by single qubit [`thermal_relaxation_error()`](qiskit.providers.aer.noise.thermal_relaxation_error "qiskit.providers.aer.noise.thermal_relaxation_error") on each qubit participating in the gate. + +* If `gate_error=True` is `True` and `thermal_relaxation=False`: + + > * An N-qubit [`depolarizing_error()`](qiskit.providers.aer.noise.depolarizing_error "qiskit.providers.aer.noise.depolarizing_error") on each N-qubit gate. + +* If `gate_error=False` and `thermal_relaxation=True` include single-qubit `thermal_relaxation_errors()` on each qubits participating in a multi-qubit gate. + +For best practice in simulating a backend make sure that the circuit is compiled using the set of basis gates in the noise module by setting `basis_gates=noise_model.basis_gates` and using the device coupling map with `coupling_map=backend.configuration().coupling_map` + +**Specifying custom gate times** + +The `gate_lengths` kwarg can be used to specify custom gate times to add gate errors using the $T_1$ and $T_2$ values from the backend properties. This should be passed as a list of tuples `gate_lengths=[(name, value), ...]` where `name` is the gate name string, and `value` is the gate time in nanoseconds. + +If a custom gate is specified that already exists in the backend properties, the `gate_lengths` value will override the gate time value from the backend properties. If non-default values are used gate\_lengths should be a list + +**Parameters** + +* **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.Backend") *or*[*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – backend properties. +* **gate\_error** (*bool*) – Include depolarizing gate errors (Default: True). +* **readout\_error** (*Bool*) – Include readout errors in model (Default: True). +* **thermal\_relaxation** (*Bool*) – Include thermal relaxation errors (Default: True). +* **temperature** (*double*) – qubit temperature in milli-Kelvin (mK) for thermal relaxation errors (Default: 0). +* **gate\_lengths** (*list*) – Custom gate times for thermal relaxation errors. Used to extend or override the gate times in the backend properties (Default: None)) +* **gate\_length\_units** (*str*) – Time units for gate length values in gate\_lengths. Can be ‘ns’, ‘ms’, ‘us’, or ‘s’ (Default: ‘ns’). +* **standard\_gates** (*bool*) – If true return errors as standard qobj gates. If false return as unitary qobj instructions (Default: True) +* **warnings** (*bool*) – Display warnings (Default: True). + +**Returns** + +An approximate noise model for the device backend. + +**Return type** + +[NoiseModel](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") + +**Raises** + +**NoiseError** – If the input backend is not valid. + +### from\_dict + + + +`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. + +**Parameters** + +**noise\_dict** (*dict*) – A serialized noise model. + +**Returns** + +the noise model. + +**Return type** + +[NoiseModel](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") + +**Raises** + +**NoiseError** – if dict cannot be converted to NoiseModel. + +### is\_ideal + + + +`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. + +### reset + + + +`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. + +### to\_dict + + + +`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. + +**Parameters** + +**serializable** (*bool*) – if True, return a dict containing only types that can be serializable by the stdlib json module. + +**Returns** + +a dictionary for a noise model. + +**Return type** + +dict + +## Attributes + + ### basis\_gates Return basis\_gates for compiling to the noise model. - + ### noise\_instructions Return the set of noisy instructions for this noise model. - + ### noise\_qubits Return the set of noisy qubits for this noise model. + diff --git a/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.md b/docs/api/qiskit/0.32/qiskit.providers.aer.noise.QuantumError.md index f3884b018c1..be262c84116 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 @@ -1,8 +1,16 @@ -# QuantumError +--- +title: QuantumError +description: API reference for qiskit.providers.aer.noise.QuantumError +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.noise.QuantumError +--- +# QuantumError + -`QuantumError(noise_ops, number_of_qubits=None, standard_gates=True, atol=1e-08)` +`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` @@ -45,56 +53,247 @@ noise_ops = [np.sqrt(0.9) * np.array([[1, 0], [0, 1]]), ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | -| [`compose`](qiskit.providers.aer.noise.QuantumError.compose#qiskit.providers.aer.noise.QuantumError.compose "qiskit.providers.aer.noise.QuantumError.compose") | Return the composition error channel other \* self. | -| [`copy`](qiskit.providers.aer.noise.QuantumError.copy#qiskit.providers.aer.noise.QuantumError.copy "qiskit.providers.aer.noise.QuantumError.copy") | Make a copy of current QuantumError. | -| [`dot`](qiskit.providers.aer.noise.QuantumError.dot#qiskit.providers.aer.noise.QuantumError.dot "qiskit.providers.aer.noise.QuantumError.dot") | Return the composition error channel self \* other. | -| [`error_term`](qiskit.providers.aer.noise.QuantumError.error_term#qiskit.providers.aer.noise.QuantumError.error_term "qiskit.providers.aer.noise.QuantumError.error_term") | Return a single term from the error. | -| [`expand`](qiskit.providers.aer.noise.QuantumError.expand#qiskit.providers.aer.noise.QuantumError.expand "qiskit.providers.aer.noise.QuantumError.expand") | Return the tensor product quantum error channel self ⊗ other. | -| [`ideal`](qiskit.providers.aer.noise.QuantumError.ideal#qiskit.providers.aer.noise.QuantumError.ideal "qiskit.providers.aer.noise.QuantumError.ideal") | Return True if current error object is an identity | -| [`power`](qiskit.providers.aer.noise.QuantumError.power#qiskit.providers.aer.noise.QuantumError.power "qiskit.providers.aer.noise.QuantumError.power") | Return the compose of a error channel with itself n times. | -| [`set_atol`](qiskit.providers.aer.noise.QuantumError.set_atol#qiskit.providers.aer.noise.QuantumError.set_atol "qiskit.providers.aer.noise.QuantumError.set_atol") | Set the class default absolute tolerance parameter for float comparisons. | -| [`set_rtol`](qiskit.providers.aer.noise.QuantumError.set_rtol#qiskit.providers.aer.noise.QuantumError.set_rtol "qiskit.providers.aer.noise.QuantumError.set_rtol") | Set the class default relative tolerance parameter for float comparisons. | -| [`tensor`](qiskit.providers.aer.noise.QuantumError.tensor#qiskit.providers.aer.noise.QuantumError.tensor "qiskit.providers.aer.noise.QuantumError.tensor") | Return the tensor product quantum error channel self ⊗ other. | -| [`to_dict`](qiskit.providers.aer.noise.QuantumError.to_dict#qiskit.providers.aer.noise.QuantumError.to_dict "qiskit.providers.aer.noise.QuantumError.to_dict") | Return the current error as a dictionary. | -| [`to_instruction`](qiskit.providers.aer.noise.QuantumError.to_instruction#qiskit.providers.aer.noise.QuantumError.to_instruction "qiskit.providers.aer.noise.QuantumError.to_instruction") | Convert the QuantumError to a circuit Instruction. | -| [`to_quantumchannel`](qiskit.providers.aer.noise.QuantumError.to_quantumchannel#qiskit.providers.aer.noise.QuantumError.to_quantumchannel "qiskit.providers.aer.noise.QuantumError.to_quantumchannel") | Convert the QuantumError to a SuperOp quantum channel. | +### compose -## Attributes + + +`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. + +Note that for front=True this is equivalent to the [`QuantumError.dot()`](qiskit.providers.aer.noise.QuantumError#dot "qiskit.providers.aer.noise.QuantumError.dot") method. + +**Parameters** + +* **other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel. +* **front** (*bool*) – If True return the reverse order composation self \* other instead \[default: False]. + +**Returns** + +The composition error channel. + +**Return type** + +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + +**Raises** + +* **NoiseError** – if other cannot be converted into a QuantumError, +* **or has incompatible dimensions.** – + +### copy + + + +`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. + +### dot + + + +`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. + +**Parameters** + +**other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel. + +**Returns** + +The composition error channel. + +**Return type** + +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + +**Raises** + +* **NoiseError** – if other cannot be converted into a QuantumError, +* **or has incompatible dimensions.** – + +### error\_term + + + +`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. + +**Parameters** + +**position** (*int*) – the position of the error term. + +**Returns** + +A pair (circuit, p) for error term at position \< size where p is the probability of the error term, and circuit is the list of qobj instructions for the error term. + +**Return type** + +tuple + +**Raises** + +* **NoiseError** – If the position is greater than the size of +* **the quantum error.** – + +### expand + + + +`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. + +**Parameters** + +**other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel. + +**Returns** + +the tensor product error channel other ⊗ self. + +**Return type** + +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + +**Raises** +**NoiseError** – if other cannot be converted to a QuantumError. +### ideal + + + +`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 + +### power + + + +`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. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composition error channel. + +**Return type** + +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + +**Raises** + +**NoiseError** – if the power is not a positive integer. + +### set\_atol + + + +`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. + +### set\_rtol + + + +`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. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – a quantum error channel. + +**Returns** + +the tensor product error channel self ⊗ other. + +**Return type** + +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + +**Raises** + +**NoiseError** – if other cannot be converted to a QuantumError. + +### to\_dict + + + +`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. + +### to\_instruction + + + +`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. + +### to\_quantumchannel + + + +`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. + +## Attributes + + ### atol The default absolute tolerance parameter for float comparisons. - + ### circuits Return the list of error circuits. - + ### number\_of\_qubits Return the number of qubits for the error. - + ### probabilities Return the list of error probabilities. - + ### rtol The relative tolerance parameter for float comparisons. - + ### size Return the number of error circuit. + 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 8774a93e48a..b2ceb8ec9cd 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 @@ -1,8 +1,16 @@ -# ReadoutError +--- +title: ReadoutError +description: API reference for qiskit.providers.aer.noise.ReadoutError +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.noise.ReadoutError +--- +# ReadoutError + -`ReadoutError(probabilities, atol=1e-08)` +`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` @@ -41,42 +49,202 @@ probabilities[3] = [P("00"|"11"), P("01"|"11"), P("10"|"11"), P("11"|"11")] ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | -| [`compose`](qiskit.providers.aer.noise.ReadoutError.compose#qiskit.providers.aer.noise.ReadoutError.compose "qiskit.providers.aer.noise.ReadoutError.compose") | Return the composition readout error other \* self. | -| [`copy`](qiskit.providers.aer.noise.ReadoutError.copy#qiskit.providers.aer.noise.ReadoutError.copy "qiskit.providers.aer.noise.ReadoutError.copy") | Make a copy of current ReadoutError. | -| [`dot`](qiskit.providers.aer.noise.ReadoutError.dot#qiskit.providers.aer.noise.ReadoutError.dot "qiskit.providers.aer.noise.ReadoutError.dot") | Return the composition readout error self \* other. | -| [`expand`](qiskit.providers.aer.noise.ReadoutError.expand#qiskit.providers.aer.noise.ReadoutError.expand "qiskit.providers.aer.noise.ReadoutError.expand") | Return the tensor product readout error self ⊗ other. | -| [`ideal`](qiskit.providers.aer.noise.ReadoutError.ideal#qiskit.providers.aer.noise.ReadoutError.ideal "qiskit.providers.aer.noise.ReadoutError.ideal") | Return True if current error object is an identity | -| [`power`](qiskit.providers.aer.noise.ReadoutError.power#qiskit.providers.aer.noise.ReadoutError.power "qiskit.providers.aer.noise.ReadoutError.power") | Return the compose of the readout error with itself n times. | -| [`set_atol`](qiskit.providers.aer.noise.ReadoutError.set_atol#qiskit.providers.aer.noise.ReadoutError.set_atol "qiskit.providers.aer.noise.ReadoutError.set_atol") | Set the class default absolute tolerance parameter for float comparisons. | -| [`set_rtol`](qiskit.providers.aer.noise.ReadoutError.set_rtol#qiskit.providers.aer.noise.ReadoutError.set_rtol "qiskit.providers.aer.noise.ReadoutError.set_rtol") | Set the class default relative tolerance parameter for float comparisons. | -| [`tensor`](qiskit.providers.aer.noise.ReadoutError.tensor#qiskit.providers.aer.noise.ReadoutError.tensor "qiskit.providers.aer.noise.ReadoutError.tensor") | Return the tensor product readout error self ⊗ other. | -| [`to_dict`](qiskit.providers.aer.noise.ReadoutError.to_dict#qiskit.providers.aer.noise.ReadoutError.to_dict "qiskit.providers.aer.noise.ReadoutError.to_dict") | Return the current error as a dictionary. | -| [`to_instruction`](qiskit.providers.aer.noise.ReadoutError.to_instruction#qiskit.providers.aer.noise.ReadoutError.to_instruction "qiskit.providers.aer.noise.ReadoutError.to_instruction") | Convert the ReadoutError to a circuit Instruction. | +### compose -## Attributes + + +`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. + +Note that for front=True this is equivalent to the [`ReadoutError.dot()`](qiskit.providers.aer.noise.ReadoutError#dot "qiskit.providers.aer.noise.ReadoutError.dot") method. + +**Parameters** + +* **other** ([*ReadoutError*](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")) – a readout error. +* **front** (*bool*) – If True return the reverse order composation self \* other instead \[default: False]. + +**Returns** + +The composition readout error. + +**Return type** + +[ReadoutError](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") + +**Raises** + +* **NoiseError** – if other is not a ReadoutError or has incompatible +* **dimensions.** – + +### copy + + + +`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. + +### dot + + + +`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. + +**Parameters** + +**other** ([*ReadoutError*](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")) – a readout error. + +**Returns** + +The composition readout error. + +**Return type** + +[ReadoutError](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") + +**Raises** + +* **NoiseError** – if other is not a ReadoutError or has incompatible +* **dimensions.** – + +### expand + + + +`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. + +**Parameters** + +**other** ([*ReadoutError*](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")) – a readout error. + +**Returns** + +the tensor product readout error other ⊗ self. + +**Return type** + +[ReadoutError](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") + +**Raises** + +**NoiseError** – if other is not a ReadoutError. + +### ideal + + + +`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 +### power + + + +`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. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composition channel. + +**Return type** + +[ReadoutError](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") + +**Raises** + +**NoiseError** – if the power is not a positive integer. + +### set\_atol + + + +`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. + +### set\_rtol + + + +`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. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*ReadoutError*](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError")) – a readout error. + +**Returns** + +the tensor product readout error self ⊗ other. + +**Return type** + +[ReadoutError](qiskit.providers.aer.noise.ReadoutError "qiskit.providers.aer.noise.ReadoutError") + +**Raises** + +**NoiseError** – if other is not a ReadoutError. + +### to\_dict + + + +`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. + +### to\_instruction + + + +`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. + +## Attributes + + ### atol The default absolute tolerance parameter for float comparisons. - + ### number\_of\_qubits Return the number of qubits for the error. - + ### probabilities Return the readout error probabilities matrix. - + ### rtol The relative tolerance parameter for float comparisons. + 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 12c09535aff..8e9e6295d9e 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.amplitude\_damping\_error +--- +title: amplitude_damping_error +description: API reference for qiskit.providers.aer.noise.amplitude_damping_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.amplitude_damping_error +--- +# qiskit.providers.aer.noise.amplitude\_damping\_error + -`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)` +`amplitude_damping_error(param_amp, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized amplitude damping quantum error channel. @@ -33,4 +41,5 @@ a quantum error object for a noise model. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + 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 2bc3dc1ae7e..75525914a49 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.coherent\_unitary\_error +--- +title: coherent_unitary_error +description: API reference for qiskit.providers.aer.noise.coherent_unitary_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.coherent_unitary_error +--- +# qiskit.providers.aer.noise.coherent\_unitary\_error + -`coherent_unitary_error(unitary)` +`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. @@ -16,4 +24,5 @@ The quantum error object. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + 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 b1dba7f0daf..85a1d7c9498 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.depolarizing\_error +--- +title: depolarizing_error +description: API reference for qiskit.providers.aer.noise.depolarizing_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.depolarizing_error +--- +# qiskit.providers.aer.noise.depolarizing\_error + -`depolarizing_error(param, num_qubits, standard_gates=True)` +`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. @@ -32,8 +40,9 @@ The quantum error object. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** **NoiseError** – If noise parameters are invalid. + 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 c621af6b83a..ee7da332025 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.device.basic\_device\_gate\_errors +--- +title: basic_device_gate_errors +description: API reference for qiskit.providers.aer.noise.device.basic_device_gate_errors +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.device.basic_device_gate_errors +--- +# 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)` +`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. @@ -10,7 +18,7 @@ If non-default values are used gate\_lengths should be a list of tuples `(name, **Parameters** -* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties +* **properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties * **gate\_error** (*bool*) – Include depolarizing gate errors (Default: True). * **thermal\_relaxation** (*Bool*) – Include thermal relaxation errors (Default: True). * **gate\_lengths** (*list*) – Override device gate times with custom values. If None use gate times from backend properties. (Default: None). @@ -26,3 +34,4 @@ A list of tuples `(label, qubits, QuantumError)`, for gates with non-zero quantu **Return type** list + 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 9a51604278f..f364dd25f2d 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.noise.device.basic\_device\_readout\_errors +--- +title: basic_device_readout_errors +description: API reference for qiskit.providers.aer.noise.device.basic_device_readout_errors +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.device.basic_device_readout_errors +--- +# qiskit.providers.aer.noise.device.basic\_device\_readout\_errors + -`basic_device_readout_errors(properties)` +`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. **Parameters** -**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties +**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties **Returns** @@ -17,3 +25,4 @@ A list of pairs `(qubits, ReadoutError)` for qubits with non-zero readout error **Return type** list + 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 9607fdf495a..3ae2a2ff174 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.noise.device.gate\_error\_values +--- +title: gate_error_values +description: API reference for qiskit.providers.aer.noise.device.gate_error_values +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.device.gate_error_values +--- +# qiskit.providers.aer.noise.device.gate\_error\_values + -`gate_error_values(properties)` +`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. **Parameters** -**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties +**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties **Returns** @@ -17,3 +25,4 @@ A list of tuples `(name, qubits, value)`. If gate error information is not avail **Return type** list + 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 af896d74f81..1b13b72489b 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.noise.device.gate\_length\_values +--- +title: gate_length_values +description: API reference for qiskit.providers.aer.noise.device.gate_length_values +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.device.gate_length_values +--- +# qiskit.providers.aer.noise.device.gate\_length\_values + -`gate_length_values(properties)` +`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. **Parameters** -**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties +**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties **Returns** @@ -21,3 +29,4 @@ list ## Additional Information: Gate length values are returned in nanosecond (ns) units. + 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 33f60241dd6..918d4b8a054 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.noise.device.gate\_param\_values +--- +title: gate_param_values +description: API reference for qiskit.providers.aer.noise.device.gate_param_values +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.device.gate_param_values +--- +# qiskit.providers.aer.noise.device.gate\_param\_values + -`gate_param_values(properties)` +`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. **Parameters** -**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties +**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties **Returns** @@ -17,3 +25,4 @@ A list of tuples `(name, qubits, time, error)`. If gate error or gate\_length in **Return type** list + 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 0adbcdd433e..e59808902fb 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.noise.device.readout\_error\_values +--- +title: readout_error_values +description: API reference for qiskit.providers.aer.noise.device.readout_error_values +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.device.readout_error_values +--- +# qiskit.providers.aer.noise.device.readout\_error\_values + -`readout_error_values(properties)` +`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. **Parameters** -**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties +**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties **Returns** @@ -17,3 +25,4 @@ A list of readout error values for qubits. If readout error information is not a **Return type** list + 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 d668ab1eb22..0bacf85f54f 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.noise.device.thermal\_relaxation\_values +--- +title: thermal_relaxation_values +description: API reference for qiskit.providers.aer.noise.device.thermal_relaxation_values +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.device.thermal_relaxation_values +--- +# qiskit.providers.aer.noise.device.thermal\_relaxation\_values + -`thermal_relaxation_values(properties)` +`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. **Parameters** -**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties +**properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – device backend properties **Returns** @@ -21,3 +29,4 @@ list ## Additional Information: $T_1$ and $T_2$ values are returned in microsecond (µs) units. Frequency is returned in gigahertz (GHz) units. + 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 7a3f2309d90..44ca93fb5ca 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.kraus\_error +--- +title: kraus_error +description: API reference for qiskit.providers.aer.noise.kraus_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.kraus_error +--- +# qiskit.providers.aer.noise.kraus\_error + -`kraus_error(noise_ops, standard_gates=True, canonical_kraus=False)` +`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. @@ -18,8 +26,9 @@ The quantum error object. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** **NoiseError** – if error parameters are invalid. + 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 8d06235321f..3d5c9582a90 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.mixed\_unitary\_error +--- +title: mixed_unitary_error +description: API reference for qiskit.providers.aer.noise.mixed_unitary_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.mixed_unitary_error +--- +# qiskit.providers.aer.noise.mixed\_unitary\_error + -`mixed_unitary_error(noise_ops, standard_gates=True)` +`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. @@ -19,8 +27,9 @@ The quantum error object. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** **NoiseError** – if error parameters are invalid. + 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 f651016f101..6d368a98133 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.pauli\_error +--- +title: pauli_error +description: API reference for qiskit.providers.aer.noise.pauli_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.pauli_error +--- +# qiskit.providers.aer.noise.pauli\_error + -`pauli_error(noise_ops, standard_gates=True)` +`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. @@ -10,7 +18,7 @@ The input should be a list of pairs `(P[j], p[j])`, where `P[j]` is a `Pauli` ob **Parameters** -* **noise\_ops** (*list\[pair\[*[*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*, double]]*) – Pauli error terms. +* **noise\_ops** (*list\[pair\[*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")*, double]]*) – Pauli error terms. * **standard\_gates** (*bool*) – if True return the operators as standard qobj Pauli gate instructions. If false return as unitary matrix qobj instructions. (Default: True) **Returns** @@ -19,8 +27,9 @@ The quantum error object. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** **NoiseError** – If depolarizing probability is less than 0 or greater than 1. + 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 b2b9a8b5744..1e5fd78c8b6 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.phase\_amplitude\_damping\_error +--- +title: phase_amplitude_damping_error +description: API reference for qiskit.providers.aer.noise.phase_amplitude_damping_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.phase_amplitude_damping_error +--- +# qiskit.providers.aer.noise.phase\_amplitude\_damping\_error + -`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)` +`phase_amplitude_damping_error(param_amp, param_phase, excited_state_population=0, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit combined phase and amplitude damping quantum error channel. @@ -36,8 +44,9 @@ a quantum error object for a noise model. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** **NoiseError** – If noise parameters are invalid. + 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 233517e1fbf..ef2fd39829e 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.phase\_damping\_error +--- +title: phase_damping_error +description: API reference for qiskit.providers.aer.noise.phase_damping_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.phase_damping_error +--- +# qiskit.providers.aer.noise.phase\_damping\_error + -`phase_damping_error(param_phase, canonical_kraus=True)` +`phase_damping_error(param_phase, canonical_kraus=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit generalized phase damping quantum error channel. @@ -32,4 +40,5 @@ a quantum error object for a noise model. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") + 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 822cc212ecf..a254e39f831 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.reset\_error +--- +title: reset_error +description: API reference for qiskit.providers.aer.noise.reset_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.reset_error +--- +# qiskit.providers.aer.noise.reset\_error + -`reset_error(prob0, prob1=0)` +`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. @@ -27,8 +35,9 @@ the quantum error object. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** **NoiseError** – If noise parameters are invalid. + 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 7cc2818d1f6..677c791119f 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.noise.thermal\_relaxation\_error +--- +title: thermal_relaxation_error +description: API reference for qiskit.providers.aer.noise.thermal_relaxation_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.noise.thermal_relaxation_error +--- +# qiskit.providers.aer.noise.thermal\_relaxation\_error + -`thermal_relaxation_error(t1, t2, time, excited_state_population=0)` +`thermal_relaxation_error(t1, t2, time, excited_state_population=0)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/noise/errors/standard_errors.py "view source code") Return a single-qubit thermal relaxation quantum error channel. @@ -19,7 +27,7 @@ a quantum error object for a noise model. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** @@ -30,3 +38,4 @@ a quantum error object for a noise model. * For parameters to be valid $T_1$ and $T_2$ must satisfy $T_2 \le 2 T_1$. * If $T_2 \le T_1$ the error can be expressed as a mixed reset and unitary error channel. * If $T_1 < T_2 \le 2 T_1$ the error must be expressed as a general non-unitary Kraus 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 3ebe624b917..f80a4e6e134 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 @@ -1,14 +1,22 @@ -# PulseSystemModel +--- +title: PulseSystemModel +description: API reference for qiskit.providers.aer.pulse.PulseSystemModel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.pulse.PulseSystemModel +--- +# PulseSystemModel + -`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)` +`PulseSystemModel(hamiltonian=None, u_channel_lo=None, control_channel_labels=None, subsystem_list=None, dt=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/pulse/system_models/pulse_system_model.py "view source code") Bases: `object` Physical model object for pulse simulator. -This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator#qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: +This class contains model information required by the [`PulseSimulator`](qiskit.providers.aer.PulseSimulator "qiskit.providers.aer.PulseSimulator"). It contains: > * `"hamiltonian"`: a `HamiltonianModel` object representing the Hamiltonian of the system. > * `"u_channel_lo"`: A description of `ControlChannel` local oscillator frequencies in terms of qubit local oscillator frequencies. @@ -16,7 +24,7 @@ This class contains model information required by the [`PulseSimulator`](qiskit. > * `"subsystem_list"`: List of subsystems in the model. > * `"dt"`: Sample width size for OpenPulse instructions. -A model can be instantiated from the helper function [`duffing_system_model()`](qiskit.providers.aer.pulse.duffing_system_model#qiskit.providers.aer.pulse.duffing_system_model "qiskit.providers.aer.pulse.duffing_system_model"), or using the [`PulseSystemModel.from_backend()`](qiskit.providers.aer.pulse.PulseSystemModel.from_backend#qiskit.providers.aer.pulse.PulseSystemModel.from_backend "qiskit.providers.aer.pulse.PulseSystemModel.from_backend") constructor. +A model can be instantiated from the helper function [`duffing_system_model()`](qiskit.providers.aer.pulse.duffing_system_model "qiskit.providers.aer.pulse.duffing_system_model"), or using the [`PulseSystemModel.from_backend()`](qiskit.providers.aer.pulse.PulseSystemModel#from_backend "qiskit.providers.aer.pulse.PulseSystemModel.from_backend") constructor. **Example** @@ -34,13 +42,84 @@ Initialize a PulseSystemModel. **Raises** -[**AerError**](qiskit.providers.aer.AerError#qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if hamiltonian is not None or a HamiltonianModel +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – if hamiltonian is not None or a HamiltonianModel ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | -| [`calculate_channel_frequencies`](qiskit.providers.aer.pulse.PulseSystemModel.calculate_channel_frequencies#qiskit.providers.aer.pulse.PulseSystemModel.calculate_channel_frequencies "qiskit.providers.aer.pulse.PulseSystemModel.calculate_channel_frequencies") | Calculate frequencies for each channel given qubit\_lo\_freq. | -| [`control_channel_index`](qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index#qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index "qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index") | Return the index of the control channel with identifying label. | -| [`from_backend`](qiskit.providers.aer.pulse.PulseSystemModel.from_backend#qiskit.providers.aer.pulse.PulseSystemModel.from_backend "qiskit.providers.aer.pulse.PulseSystemModel.from_backend") | Returns a PulseSystemModel constructed from an OpenPulse enabled backend object. | -| [`from_config`](qiskit.providers.aer.pulse.PulseSystemModel.from_config#qiskit.providers.aer.pulse.PulseSystemModel.from_config "qiskit.providers.aer.pulse.PulseSystemModel.from_config") | Construct a model from configuration and defaults. | +### calculate\_channel\_frequencies + + + +`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. + +**Parameters** + +**qubit\_lo\_freq** (*list or None*) – list of qubit linear oscillator drive frequencies. + +**Returns** + +a dictionary of channel frequencies. + +**Return type** + +OrderedDict + +**Raises** + +**ValueError** – If channel or u\_channel\_lo are invalid. + +### control\_channel\_index + + + +`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. + +**Parameters** + +**label** (*Any*) – label that identifies a control channel + +**Returns** + +index of the ControlChannel + +**Return type** + +int or None + +### from\_backend + + + +`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. + +**Parameters** + +* **backend** ([*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")) – backend object to draw information from. +* **subsystem\_list** (*list*) – a list of ints for which qubits to include in the model. + +**Returns** + +the PulseSystemModel constructed from the backend. + +**Return type** + +[PulseSystemModel](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") + +**Raises** + +[**AerError**](qiskit.providers.aer.AerError "qiskit.providers.aer.AerError") – If channel or u\_channel\_lo are invalid. + +### from\_config + + + +`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 da0ceb16ac3..24d251b1714 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 @@ -1,10 +1,18 @@ -# qiskit.providers.aer.pulse.duffing\_system\_model +--- +title: duffing_system_model +description: API reference for qiskit.providers.aer.pulse.duffing_system_model +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.pulse.duffing_system_model +--- +# qiskit.providers.aer.pulse.duffing\_system\_model + -`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)` +`duffing_system_model(dim_oscillators, oscillator_freqs, anharm_freqs, drive_strengths, coupling_dict, dt)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.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 "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. +Returns a [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") representing a physical model for a collection of Duffing oscillators. In the model, each individual oscillator is specified by the parameters: @@ -32,7 +40,7 @@ $$ 2 \pi j (a_i^\dagger a_k + a_i a_k^\dagger). $$ -Finally, the returned [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") is setup for performing cross-resonance drives between coupled qubits. The index for the `ControlChannel` corresponding to a particular cross-resonance drive channel is retreived by calling [`PulseSystemModel.control_channel_index()`](qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index#qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index "qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index") with the tuple `(drive_idx, target_idx)`, where `drive_idx` is the index of the oscillator being driven, and `target_idx` is the target oscillator (see example below). +Finally, the returned [`PulseSystemModel`](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") is setup for performing cross-resonance drives between coupled qubits. The index for the `ControlChannel` corresponding to a particular cross-resonance drive channel is retreived by calling [`PulseSystemModel.control_channel_index()`](qiskit.providers.aer.pulse.PulseSystemModel#control_channel_index "qiskit.providers.aer.pulse.PulseSystemModel.control_channel_index") with the tuple `(drive_idx, target_idx)`, where `drive_idx` is the index of the oscillator being driven, and `target_idx` is the target oscillator (see example below). Note: In this model, all frequencies are in frequency units (as opposed to radial). @@ -88,4 +96,5 @@ The generated Duffing system model **Return type** -[PulseSystemModel](qiskit.providers.aer.pulse.PulseSystemModel#qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") +[PulseSystemModel](qiskit.providers.aer.pulse.PulseSystemModel "qiskit.providers.aer.pulse.PulseSystemModel") + 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 800397702ef..a79f3f36e95 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 @@ -1,8 +1,16 @@ -# NoiseTransformer +--- +title: NoiseTransformer +description: API reference for qiskit.providers.aer.utils.NoiseTransformer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.aer.utils.NoiseTransformer +--- +# NoiseTransformer + -`NoiseTransformer` +`NoiseTransformer`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Bases: `object` @@ -10,22 +18,372 @@ Transforms one quantum channel to another based on a specified criteria. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`channel_matrix_representation`](qiskit.providers.aer.utils.NoiseTransformer.channel_matrix_representation#qiskit.providers.aer.utils.NoiseTransformer.channel_matrix_representation "qiskit.providers.aer.utils.NoiseTransformer.channel_matrix_representation") | 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 | -| [`compute_P`](qiskit.providers.aer.utils.NoiseTransformer.compute_P#qiskit.providers.aer.utils.NoiseTransformer.compute_P "qiskit.providers.aer.utils.NoiseTransformer.compute_P") | 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 | -| [`compute_channel_operation`](qiskit.providers.aer.utils.NoiseTransformer.compute_channel_operation#qiskit.providers.aer.utils.NoiseTransformer.compute_channel_operation "qiskit.providers.aer.utils.NoiseTransformer.compute_channel_operation") | Given a quantum state’s density function rho, the effect of the channel on this state is: rho -> sum\_\{i=1}^n E\_i \* rho \* E\_i^dagger | -| [`compute_q`](qiskit.providers.aer.utils.NoiseTransformer.compute_q#qiskit.providers.aer.utils.NoiseTransformer.compute_q "qiskit.providers.aer.utils.NoiseTransformer.compute_q") | 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 | -| [`fidelity`](qiskit.providers.aer.utils.NoiseTransformer.fidelity#qiskit.providers.aer.utils.NoiseTransformer.fidelity "qiskit.providers.aer.utils.NoiseTransformer.fidelity") | Calculates channel fidelity | -| [`flatten_matrix`](qiskit.providers.aer.utils.NoiseTransformer.flatten_matrix#qiskit.providers.aer.utils.NoiseTransformer.flatten_matrix "qiskit.providers.aer.utils.NoiseTransformer.flatten_matrix") | **param m**The matrix to flatten | -| [`generate_channel_matrices`](qiskit.providers.aer.utils.NoiseTransformer.generate_channel_matrices#qiskit.providers.aer.utils.NoiseTransformer.generate_channel_matrices "qiskit.providers.aer.utils.NoiseTransformer.generate_channel_matrices") | Generate symbolic channel matrices. | -| [`generate_channel_quadratic_programming_matrices`](qiskit.providers.aer.utils.NoiseTransformer.generate_channel_quadratic_programming_matrices#qiskit.providers.aer.utils.NoiseTransformer.generate_channel_quadratic_programming_matrices "qiskit.providers.aer.utils.NoiseTransformer.generate_channel_quadratic_programming_matrices") | Generate matrices for quadratic program. | -| [`get_const_matrix_from_channel`](qiskit.providers.aer.utils.NoiseTransformer.get_const_matrix_from_channel#qiskit.providers.aer.utils.NoiseTransformer.get_const_matrix_from_channel "qiskit.providers.aer.utils.NoiseTransformer.get_const_matrix_from_channel") | Extract the numeric constant matrix. | -| [`get_matrix_from_channel`](qiskit.providers.aer.utils.NoiseTransformer.get_matrix_from_channel#qiskit.providers.aer.utils.NoiseTransformer.get_matrix_from_channel "qiskit.providers.aer.utils.NoiseTransformer.get_matrix_from_channel") | Extract the numeric parameter matrix. | -| [`operator_circuit`](qiskit.providers.aer.utils.NoiseTransformer.operator_circuit#qiskit.providers.aer.utils.NoiseTransformer.operator_circuit "qiskit.providers.aer.utils.NoiseTransformer.operator_circuit") | Converts an operator representation to noise circuit. | -| [`operator_matrix`](qiskit.providers.aer.utils.NoiseTransformer.operator_matrix#qiskit.providers.aer.utils.NoiseTransformer.operator_matrix "qiskit.providers.aer.utils.NoiseTransformer.operator_matrix") | Converts an operator representation to Kraus matrix representation | -| [`prepare_channel_operator_list`](qiskit.providers.aer.utils.NoiseTransformer.prepare_channel_operator_list#qiskit.providers.aer.utils.NoiseTransformer.prepare_channel_operator_list "qiskit.providers.aer.utils.NoiseTransformer.prepare_channel_operator_list") | Prepares a list of channel operators. | -| [`prepare_honesty_constraint`](qiskit.providers.aer.utils.NoiseTransformer.prepare_honesty_constraint#qiskit.providers.aer.utils.NoiseTransformer.prepare_honesty_constraint "qiskit.providers.aer.utils.NoiseTransformer.prepare_honesty_constraint") | Prepares the honesty constraint. | -| [`solve_quadratic_program`](qiskit.providers.aer.utils.NoiseTransformer.solve_quadratic_program#qiskit.providers.aer.utils.NoiseTransformer.solve_quadratic_program "qiskit.providers.aer.utils.NoiseTransformer.solve_quadratic_program") | Solve the quadratic program optimization problem. | -| [`transform_by_given_channel`](qiskit.providers.aer.utils.NoiseTransformer.transform_by_given_channel#qiskit.providers.aer.utils.NoiseTransformer.transform_by_given_channel "qiskit.providers.aer.utils.NoiseTransformer.transform_by_given_channel") | Transform by by quantum channels. | -| [`transform_by_operator_list`](qiskit.providers.aer.utils.NoiseTransformer.transform_by_operator_list#qiskit.providers.aer.utils.NoiseTransformer.transform_by_operator_list "qiskit.providers.aer.utils.NoiseTransformer.transform_by_operator_list") | Transform input Kraus operators. | +### channel\_matrix\_representation + + + +`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 + +**Parameters** + +**operators** (*list*) – The list of operators to transform into a Matrix + +**Returns** + +The matrx representation of the operators + +**Return type** + +sympy.Matrix + +### compute\_P + + + +`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 + +**Returns** + +The matrix P for the description of the quadaric program + +**Return type** + +matrix + +### compute\_channel\_operation + + + +`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 + +**Parameters** + +* **rho** (*number*) – Density function +* **operators** (*list*) – List of operators + +**Returns** + +The result of applying the list of operators + +**Return type** + +number + +### compute\_q + + + +`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 + +**Returns** + +The vector q for the description of the quadaric program + +**Return type** + +list + +### fidelity + + + +`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 + +### flatten\_matrix + + + +`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** + +**m** (*Matrix*) – The matrix to flatten + +**Returns** + +A row vector repesenting the flattened matrix + +**Return type** + +list + +### generate\_channel\_matrices + + + +`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. + +Generates a list of 4x4 symbolic matrices describing the channel defined from the given operators. The identity matrix is assumed to be the first element in the list: + +```python +[(I, ), (A1, B1, ...), (A2, B2, ...), ..., (An, Bn, ...)] +``` + +E.g. for a Pauli channel, the matrices are: + +```python +[(I,), (X,), (Y,), (Z,)] +``` + +For relaxation they are: + +```python +[(I, ), (|0><0|, |0><1|), |1><0|, |1><1|)] +``` + +We consider this input to symbolically represent a channel in the following manner: define indeterminates $x_0, x_1, ..., x_n$ which are meant to represent probabilities such that $x_i \ge 0$ and $x0 = 1-(x_1 + ... + x_n)$. + +Now consider the quantum channel defined via the Kraus operators ${\sqrt(x_0)I, \sqrt(x_1) A_1, \sqrt(x1) B_1, ..., \sqrt(x_m)A_n, \sqrt(x_n) B_n, ...}$ This is the channel C symbolically represented by the operators. + +**Parameters** + +**transform\_channel\_operators\_list** (*list*) – A list of tuples of matrices which represent Kraus operators. + +**Returns** + +A list of 4x4 complex matrices `([D1, D2, ..., Dn], E)` such that the matrix $x_1 D_1 + ... + x_n D_n + E$ represents the operation of the channel C on the density operator. we find it easier to work with this representation of C when performing the combinatorial optimization. + +**Return type** + +list + +### generate\_channel\_quadratic\_programming\_matrices + + + +`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. + +**Parameters** + +* **channel** (*Matrix*) – a 4x4 symbolic matrix +* **symbols** (*list*) – the symbols x1, …, xn which may occur in the matrix + +**Returns** + +A list of 4x4 complex matrices (\[D1, D2, …, Dn], E) such that: channel == x1\*D1 + … + xn\*Dn + E + +**Return type** + +list + +### get\_const\_matrix\_from\_channel + + + +`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. + +**Parameters** + +* **channel** (*matrix*) – a 4x4 symbolic matrix. +* **symbols** (*list*) – The full list \[x1, …, xn] of symbols used in the matrix. + +**Returns** + +a 4x4 numeric matrix. + +**Return type** + +matrix + +#### Additional Information: + +Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomial of the form a1x1 + … + anxn + c. The corresponding entry in the output numeric matrix is c. + +### get\_matrix\_from\_channel + + + +`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. + +**Parameters** + +* **channel** (*matrix*) – a 4x4 symbolic matrix. +* **symbol** (*list*) – a symbol xi + +**Returns** + +a 4x4 numeric matrix. + +**Return type** + +matrix + +#### Additional Information: + +Each entry of the 4x4 symbolic input channel matrix is assumed to be a polynomial of the form a1x1 + … + anxn + c. The corresponding entry in the output numeric matrix is ai. + +### operator\_circuit + + + +`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. + +**Parameters** + +**operator** (*operator*) – operator representation. Can be a noise circuit or a matrix or a list of matrices. + +**Returns** + +The operator, converted to noise circuit representation. + +**Return type** + +List + +### operator\_matrix + + + +`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 + +**Parameters** + +**operator** (*operator*) – operator representation. Can be a noise circuit or a matrix or a list of matrices. + +**Returns** + +the operator, converted to Kraus representation. + +**Return type** + +[Kraus](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus") + +### prepare\_channel\_operator\_list + + + +`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. + +**Parameters** + +**ops\_list** (*List*) – The list of operators to prepare + +**Returns** + +The channel operator list + +**Return type** + +List + +### prepare\_honesty\_constraint + + + +`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. + +**Parameters** + +* **transform\_channel\_operators\_list** (*list*) – A list of tuples of matrices which represent +* **operators.** ([*Kraus*](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")) – + +### solve\_quadratic\_program + + + +`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. + +This function solved the quadratic program to minimize the objective function f(x) = 1/2(x\*P\*x)+q\*x subject to the additional constraints Gx \<= h + +Where P, q are given and G,h are computed to ensure that x represents a probability vector and subject to honesty constraints if required :param P: A matrix representing the P component of the objective function :type P: matrix :param q: A vector representing the q component of the objective function :type q: list + +**Returns** + +The solution of the quadratic program (represents probabilities) + +**Return type** + +list + +#### Additional information: + +This method is the only place in the code where we rely on the cvxpy library should we consider another library, only this method needs to change. + +### transform\_by\_given\_channel + + + +`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. + +This method creates objective function representing the Hilbert-Schmidt norm of the matrix (A-B) obtained as the difference of the input noise channel and the output channel we wish to determine. + +This function is represented by a matrix P and a vector q, such that f(x) = 1/2(x\*P\*x)+q\*x where x is the vector we wish to minimize, where x represents probabilities for the noise operators that construct the output channel + +**Parameters** + +* **channel\_matrices** (*list*) – A list of 4x4 symbolic matrices +* **const\_channel\_matrix** (*matrix*) – a 4x4 constant matrix + +**Returns** + +a list of the optimal probabilities for the channel matrices, determined by the quadratic program solver + +**Return type** + +list + +### transform\_by\_operator\_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") + +Transform input Kraus operators. + +Allows approximating a set of input Kraus operators as in terms of a different set of Kraus matrices. + +For example, setting $[X, Y, Z]$ allows approximating by a Pauli channel, and $[(|0 \langle\rangle 0|, |0\langle\rangle 1|), |1\langle\rangle 0|, |1 \langle\rangle 1|)]$ represents the relaxation channel + +In the case the input is a list $[A_1, A_2, ..., A_n]$ of transform matrices and $[E_0, E_1, ..., E_m]$ of noise Kraus operators, the output is a list $[p_1, p_2, ..., p_n]$ of probabilities such that: + +1. $p_i \ge 0$ +2. $p_1 + ... + p_n \le 1$ +3. $[\sqrt(p_1) A_1, \sqrt(p_2) A_2, ..., \sqrt(p_n) A_n, \sqrt(1-(p_1 + ... + p_n))I]$ is a list of Kraus operators that define the output channel (which is “close” to the input channel given by $[E_0, ..., E_m]$.) + +This channel can be thought of as choosing the operator $A_i$ in probability $p_i$ and applying this operator to the quantum state. + +More generally, if the input is a list of tuples (not necessarily of the same size): $[(A_1, B_1, ...), (A_2, B_2, ...), ..., (A_n, B_n, ...)]$ then the output is still a list $[p_1, p_2, ..., p_n]$ and now the output channel is defined by the operators: $[\sqrt(p_1)A1, \sqrt(p_1)B_1, ..., \sqrt(p_n)A_n, \sqrt(p_n)B_n, ..., \sqrt(1-(p_1 + ... + p_n))I]$ + +**Parameters** + +* **noise\_kraus\_operators** (*List*) – a list of matrices (Kraus operators) for the input channel. +* **transform\_channel\_operators** (*List*) – a list of matrices or tuples of matrices representing Kraus operators that can construct the output channel. + +**Returns** + +A list of amplitudes that define the output channel. + +**Return type** + +List + 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 139da24b5ca..6ac6827b3e9 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 @@ -1,14 +1,22 @@ -# qiskit.providers.aer.utils.approximate\_noise\_model +--- +title: approximate_noise_model +description: API reference for qiskit.providers.aer.utils.approximate_noise_model +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.utils.approximate_noise_model +--- +# qiskit.providers.aer.utils.approximate\_noise\_model + -`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)` +`approximate_noise_model(model, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate noise model. **Parameters** -* **model** ([*NoiseModel*](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")) – the noise model to be approximated. +* **model** ([*NoiseModel*](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")) – the noise model to be approximated. * **operator\_string** (*string or None*) – a name for a pre-made set of building blocks for the output channel (Default: None). * **operator\_dict** (*dict or None*) – a dictionary whose values are the building blocks for the output channel (Default: None). * **operator\_list** (*dict or None*) – list of building blocks for the output channel (Default: None). @@ -19,7 +27,7 @@ the approximate noise model. **Return type** -[NoiseModel](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") +[NoiseModel](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") **Raises** @@ -29,3 +37,4 @@ the approximate noise model. ## Additional Information: The operator input precedence is: `list` \< `dict` \< `str`. If a string is given, dict is overwritten; if a dict is given, list is overwritten. Oossible values for string are `'pauli'`, `'reset'`, `'clifford'`. For further information see `NoiseTransformer.named_operators()`. + 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 9f575c4916c..cd5acf0deb7 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.utils.approximate\_quantum\_error +--- +title: approximate_quantum_error +description: API reference for qiskit.providers.aer.utils.approximate_quantum_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.utils.approximate_quantum_error +--- +# qiskit.providers.aer.utils.approximate\_quantum\_error + -`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)` +`approximate_quantum_error(error, *, operator_string=None, operator_dict=None, operator_list=None)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_transformation.py "view source code") Return an approximate QuantumError bases on the Hilbert-Schmidt metric. @@ -10,7 +18,7 @@ Currently this is only implemented for 1-qubit QuantumErrors. **Parameters** -* **error** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – the error to be approximated. +* **error** ([*QuantumError*](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError")) – the error to be approximated. * **operator\_string** (*string or None*) – a name for a pre-made set of building blocks for the output channel (Default: None). * **operator\_dict** (*dict or None*) – a dictionary whose values are the building blocks for the output channel (Default: None). * **operator\_list** (*dict or None*) – list of building blocks for the output channel (Default: None). @@ -21,7 +29,7 @@ the approximate quantum error. **Return type** -[QuantumError](qiskit.providers.aer.noise.QuantumError#qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") +[QuantumError](qiskit.providers.aer.noise.QuantumError "qiskit.providers.aer.noise.QuantumError") **Raises** @@ -31,3 +39,4 @@ the approximate quantum error. ## Additional Information: The operator input precedence is: `list` \< `dict` \< `str`. If a string is given, dict is overwritten; if a dict is given, list is overwritten. Oossible values for string are `'pauli'`, `'reset'`, `'clifford'`. For further information see `NoiseTransformer.named_operators()`. + 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 42156a2885a..c9c0300ea59 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 @@ -1,15 +1,23 @@ -# qiskit.providers.aer.utils.insert\_noise +--- +title: insert_noise +description: API reference for qiskit.providers.aer.utils.insert_noise +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.utils.insert_noise +--- +# qiskit.providers.aer.utils.insert\_noise + -`insert_noise(circuits, noise_model, transpile=False)` +`insert_noise(circuits, noise_model, transpile=False)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_model_inserter.py "view source code") Return a noisy version of a QuantumCircuit. **Parameters** -* **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – Input noise-free circuits. -* **noise\_model** ([*NoiseModel*](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")) – The noise model containing the errors to add +* **circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or list\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – Input noise-free circuits. +* **noise\_model** ([*NoiseModel*](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")) – The noise model containing the errors to add * **transpile** (*Boolean*) – Should the circuit be transpiled into the noise model basis gates **Returns** @@ -18,8 +26,9 @@ The new circuit with the Kraus noise instructions inserted. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") ## Additional Information: -The noisy circuit return by this function will consist of the original circuit with `Kraus` instructions inserted after all instructions referenced in the `noise_model`. The resulting circuit cannot be ran on a quantum computer but can be executed on the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator#qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). +The noisy circuit return by this function will consist of the original circuit with `Kraus` instructions inserted after all instructions referenced in the `noise_model`. The resulting circuit cannot be ran on a quantum computer but can be executed on the [`QasmSimulator`](qiskit.providers.aer.QasmSimulator "qiskit.providers.aer.QasmSimulator"). + 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 fb11da526c6..64a6012ca37 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 @@ -1,8 +1,16 @@ -# qiskit.providers.aer.utils.remap\_noise\_model +--- +title: remap_noise_model +description: API reference for qiskit.providers.aer.utils.remap_noise_model +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.aer.utils.remap_noise_model +--- +# qiskit.providers.aer.utils.remap\_noise\_model + -`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)` +`remap_noise_model(noise_model, remapping, discard_qubits=False, warnings=True)`[GitHub](https://github.com/qiskit/qiskit-aer/tree/stable/0.9/qiskit/providers/aer/utils/noise_remapper.py "view source code") Remap qubits in a noise model. @@ -10,7 +18,7 @@ This remaps the specified gate qubits for local quantum errors, the gate and noi **Parameters** -* **noise\_model** ([*NoiseModel*](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")) – a noise model to remap qubits. +* **noise\_model** ([*NoiseModel*](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel")) – a noise model to remap qubits. * **remapping** (*list*) – list or remappings of old qubit to new qubit. See Additional Information. * **discard\_qubits** (*bool*) – if True discard qubits not in remapping keys, if False an identity mapping wil be assumed for unnamed qubits (Default: False). * **warnings** (*bool*) – display warnings if qubits being remapped are not in the input noise model (Default: True). @@ -21,7 +29,7 @@ a new noise model with the same errors but remapped gate and noise qubits for lo **Return type** -[NoiseModel](qiskit.providers.aer.noise.NoiseModel#qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") +[NoiseModel](qiskit.providers.aer.noise.NoiseModel "qiskit.providers.aer.noise.NoiseModel") **Raises** @@ -31,3 +39,4 @@ a new noise model with the same errors but remapped gate and noise qubits for lo * The remapping map be specified as either a list of pairs: `[(old, new), ...]`, or a list of old qubits where the new qubit is inferred from the position: `[old0, old1, ...]` is treated as `[(old0, 0), (old1, 1), ...]`. * If `discard_qubits` is `False`, any qubits in the noise model not specified in the list of old qubits will be added to the remapping as a trivial mapping `(qubit, qubit)`. + 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 3b124ff3067..1a9600d9787 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerError.md @@ -1,9 +1,18 @@ -# qiskit.providers.basicaer.BasicAerError +--- +title: BasicAerError +description: API reference for qiskit.providers.basicaer.BasicAerError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.basicaer.BasicAerError +--- +# qiskit.providers.basicaer.BasicAerError + -`BasicAerError(*message)` +`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. Set the error message. + 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 2db2e9fcaac..6b901b10024 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerJob.md @@ -1,8 +1,16 @@ -# BasicAerJob +--- +title: BasicAerJob +description: API reference for qiskit.providers.basicaer.BasicAerJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.basicaer.BasicAerJob +--- +# BasicAerJob + -`BasicAerJob(backend, job_id, result)` +`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` @@ -18,24 +26,163 @@ Initializes the asynchronous job. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | -| [`backend`](qiskit.providers.basicaer.BasicAerJob.backend#qiskit.providers.basicaer.BasicAerJob.backend "qiskit.providers.basicaer.BasicAerJob.backend") | Return the instance of the backend used for this job. | -| [`cancel`](qiskit.providers.basicaer.BasicAerJob.cancel#qiskit.providers.basicaer.BasicAerJob.cancel "qiskit.providers.basicaer.BasicAerJob.cancel") | Attempt to cancel the job. | -| [`cancelled`](qiskit.providers.basicaer.BasicAerJob.cancelled#qiskit.providers.basicaer.BasicAerJob.cancelled "qiskit.providers.basicaer.BasicAerJob.cancelled") | Return whether the job has been cancelled. | -| [`done`](qiskit.providers.basicaer.BasicAerJob.done#qiskit.providers.basicaer.BasicAerJob.done "qiskit.providers.basicaer.BasicAerJob.done") | Return whether the job has successfully run. | -| [`in_final_state`](qiskit.providers.basicaer.BasicAerJob.in_final_state#qiskit.providers.basicaer.BasicAerJob.in_final_state "qiskit.providers.basicaer.BasicAerJob.in_final_state") | Return whether the job is in a final job state such as `DONE` or `ERROR`. | -| [`job_id`](qiskit.providers.basicaer.BasicAerJob.job_id#qiskit.providers.basicaer.BasicAerJob.job_id "qiskit.providers.basicaer.BasicAerJob.job_id") | Return a unique id identifying the job. | -| [`result`](qiskit.providers.basicaer.BasicAerJob.result#qiskit.providers.basicaer.BasicAerJob.result "qiskit.providers.basicaer.BasicAerJob.result") | Get job result . | -| [`running`](qiskit.providers.basicaer.BasicAerJob.running#qiskit.providers.basicaer.BasicAerJob.running "qiskit.providers.basicaer.BasicAerJob.running") | Return whether the job is actively running. | -| [`status`](qiskit.providers.basicaer.BasicAerJob.status#qiskit.providers.basicaer.BasicAerJob.status "qiskit.providers.basicaer.BasicAerJob.status") | Gets the status of the job by querying the Python’s future | -| [`submit`](qiskit.providers.basicaer.BasicAerJob.submit#qiskit.providers.basicaer.BasicAerJob.submit "qiskit.providers.basicaer.BasicAerJob.submit") | Submit the job to the backend for execution. | -| [`wait_for_final_state`](qiskit.providers.basicaer.BasicAerJob.wait_for_final_state#qiskit.providers.basicaer.BasicAerJob.wait_for_final_state "qiskit.providers.basicaer.BasicAerJob.wait_for_final_state") | Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. | +### backend -## Attributes + + +`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. + +### cancel + + + +`BasicAerJob.cancel()` + +Attempt to cancel the job. + +### cancelled + + + +`BasicAerJob.cancelled()` + +Return whether the job has been cancelled. + +**Return type** + +`bool` + +### done + + + +`BasicAerJob.done()` + +Return whether the job has successfully run. + +**Return type** + +`bool` + +### in\_final\_state + + + +`BasicAerJob.in_final_state()` + +Return whether the job is in a final job state such as `DONE` or `ERROR`. + +**Return type** + +`bool` + +### job\_id + + + +`BasicAerJob.job_id()` + +Return a unique id identifying the job. + +**Return type** + +`str` + +### result + + + +`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 . + +**Returns** + +Result object + +**Return type** +qiskit.Result +### running + + + +`BasicAerJob.running()` + +Return whether the job is actively running. + +**Return type** + +`bool` + +### status + + + +`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 + +**Returns** + +The current JobStatus + +**Return type** + +[qiskit.providers.JobStatus](qiskit.providers.JobStatus "qiskit.providers.JobStatus") + +### submit + + + +`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. + +**Raises** + +[**JobError**](qiskit.providers.JobError "qiskit.providers.JobError") – if trying to re-submit the job. + +### wait\_for\_final\_state + + + +`BasicAerJob.wait_for_final_state(timeout=None, wait=5, callback=None)` + +Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + +* **wait** (`float`) – Seconds between queries. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function invoked after each query. The following positional arguments are provided to the callback function: + + * job\_id: Job ID + * job\_status: Status of the job from the last query + * job: This BaseJob instance + + Note: different subclass might provide different arguments to the callback function. + +**Raises** + +[**JobTimeoutError**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + +**Return type** + +`None` + +## Attributes + + ### version `= 1` + 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 40ed524df7a..dbdc2b1476c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.BasicAerProvider.md @@ -1,8 +1,16 @@ -# BasicAerProvider +--- +title: BasicAerProvider +description: API reference for qiskit.providers.basicaer.BasicAerProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.basicaer.BasicAerProvider +--- +# BasicAerProvider + -`BasicAerProvider` +`BasicAerProvider`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/basicaer/basicaerprovider.py "view source code") Bases: `qiskit.providers.provider.ProviderV1` @@ -10,15 +18,59 @@ Provider for Basic Aer backends. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`backends`](qiskit.providers.basicaer.BasicAerProvider.backends#qiskit.providers.basicaer.BasicAerProvider.backends "qiskit.providers.basicaer.BasicAerProvider.backends") | Return a list of backends matching the specified filtering. | -| [`get_backend`](qiskit.providers.basicaer.BasicAerProvider.get_backend#qiskit.providers.basicaer.BasicAerProvider.get_backend "qiskit.providers.basicaer.BasicAerProvider.get_backend") | Return a single backend matching the specified filtering. | +### backends -## Attributes + + +`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. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +**a list of Backends that match the filtering** + +criteria. + +**Return type** + +list\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend")] + +### get\_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") + +Return a single backend matching the specified filtering. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +[Backend](qiskit.providers.Backend "qiskit.providers.Backend") + +**Raises** + +[**QiskitBackendNotFoundError**](qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError") – if no backend could be found or more than one backend matches the filtering criteria. + +## Attributes + + ### version `= 1` + 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 2f38996588d..756e07eb322 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.QasmSimulatorPy.md @@ -1,8 +1,16 @@ -# QasmSimulatorPy +--- +title: QasmSimulatorPy +description: API reference for qiskit.providers.basicaer.QasmSimulatorPy +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.basicaer.QasmSimulatorPy +--- +# QasmSimulatorPy + -`QasmSimulatorPy(configuration=None, provider=None, **fields)` +`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` @@ -12,8 +20,8 @@ Initialize a backend class **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. -* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. +* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. * **fields** – kwargs for the values to use to override the default options. **Raises** @@ -22,13 +30,15 @@ Initialize a backend class In addition to the public abstract methods, subclasses should also implement the following private methods: +### \_default\_options + `classmethod _default_options()` Return the default options -This method will return a [`qiskit.providers.Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. +This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. **Returns** @@ -38,24 +48,188 @@ default values set **Return type** -[qiskit.providers.Options](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") +[qiskit.providers.Options](qiskit.providers.Options "qiskit.providers.Options") ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | -| [`configuration`](qiskit.providers.basicaer.QasmSimulatorPy.configuration#qiskit.providers.basicaer.QasmSimulatorPy.configuration "qiskit.providers.basicaer.QasmSimulatorPy.configuration") | Return the backend configuration. | -| [`name`](qiskit.providers.basicaer.QasmSimulatorPy.name#qiskit.providers.basicaer.QasmSimulatorPy.name "qiskit.providers.basicaer.QasmSimulatorPy.name") | Return the backend name. | -| [`properties`](qiskit.providers.basicaer.QasmSimulatorPy.properties#qiskit.providers.basicaer.QasmSimulatorPy.properties "qiskit.providers.basicaer.QasmSimulatorPy.properties") | Return the backend properties. | -| [`provider`](qiskit.providers.basicaer.QasmSimulatorPy.provider#qiskit.providers.basicaer.QasmSimulatorPy.provider "qiskit.providers.basicaer.QasmSimulatorPy.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.basicaer.QasmSimulatorPy.run#qiskit.providers.basicaer.QasmSimulatorPy.run "qiskit.providers.basicaer.QasmSimulatorPy.run") | Run qobj asynchronously. | -| [`run_experiment`](qiskit.providers.basicaer.QasmSimulatorPy.run_experiment#qiskit.providers.basicaer.QasmSimulatorPy.run_experiment "qiskit.providers.basicaer.QasmSimulatorPy.run_experiment") | Run an experiment (circuit) and return a single experiment result. | -| [`set_options`](qiskit.providers.basicaer.QasmSimulatorPy.set_options#qiskit.providers.basicaer.QasmSimulatorPy.set_options "qiskit.providers.basicaer.QasmSimulatorPy.set_options") | Set the options fields for the backend | -| [`status`](qiskit.providers.basicaer.QasmSimulatorPy.status#qiskit.providers.basicaer.QasmSimulatorPy.status "qiskit.providers.basicaer.QasmSimulatorPy.status") | Return the backend status. | +### configuration -## Attributes + + +`QasmSimulatorPy.configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### name + + + +`QasmSimulatorPy.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`QasmSimulatorPy.properties()` + +Return the backend properties. + +**Returns** + +the configuration for the backend. If the backend does not support properties, it returns `None`. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`QasmSimulatorPy.provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + + +`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. + +**Parameters** + +* **qobj** ([*Qobj*](qiskit.qobj.Qobj "qiskit.qobj.Qobj")) – payload of the experiment +* **backend\_options** (*dict*) – backend options + +**Returns** + +derived from BaseJob + +**Return type** + +[BasicAerJob](qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob") + +#### Additional Information: + +#### backend\_options: Is a dict of options for the backend. It may contain + +* “initial\_statevector”: vector\_like + +The “initial\_statevector” option specifies a custom initial initial statevector for the simulator to be used instead of the all zero state. This size of this vector must be correct for the number of qubits in all experiments in the qobj. + +Example: + +```python +backend_options = { + "initial_statevector": np.array([1, 0, 0, 1j]) / np.sqrt(2), +} +``` + +### run\_experiment + + + +`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. + +**Parameters** + +**experiment** (*QobjExperiment*) – experiment from qobj experiments list + +**Returns** + +A result dictionary which looks something like: + +```python +{ +"name": name of this experiment (obtained from qobj.experiment header) +"seed": random seed used for simulation +"shots": number of shots used in the simulation +"data": + { + "counts": {'0x9: 5, ...}, + "memory": ['0x9', '0xF', '0x1D', ..., '0x9'] + }, +"status": status string for the simulation +"success": boolean +"time_taken": simulation time of this single experiment +} +``` + +**Return type** + +dict + +**Raises** + +[**BasicAerError**](qiskit.providers.basicaer.BasicAerError "qiskit.providers.basicaer.BasicAerError") – if an error occurred. + +### set\_options + + +`QasmSimulatorPy.set_options(**fields)` +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + +### status + + + +`QasmSimulatorPy.status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### DEFAULT\_CONFIGURATION = \{'backend\_name' @@ -63,7 +237,7 @@ default values set `= {'backend_name': 'qasm_simulator', 'backend_version': '2.1.0', 'basis_gates': ['u1', 'u2', 'u3', 'rz', 'sx', 'x', 'cx', 'id', 'unitary'], 'conditional': True, 'coupling_map': None, 'description': 'A python simulator for qasm experiments', 'gates': [{'name': 'u1', 'parameters': ['lambda'], 'qasm_def': 'gate u1(lambda) q { U(0,0,lambda) q; }'}, {'name': 'u2', 'parameters': ['phi', 'lambda'], 'qasm_def': 'gate u2(phi,lambda) q { U(pi/2,phi,lambda) q; }'}, {'name': 'u3', 'parameters': ['theta', 'phi', 'lambda'], 'qasm_def': 'gate u3(theta,phi,lambda) q { U(theta,phi,lambda) q; }'}, {'name': 'rz', 'parameters': ['phi'], 'qasm_def': 'gate rz(phi) q { U(0,0,phi) q; }'}, {'name': 'sx', 'parameters': [], 'qasm_def': 'gate sx(phi) q { U(pi/2,7*pi/2,pi/2) q; }'}, {'name': 'x', 'parameters': [], 'qasm_def': 'gate x q { U(pi,7*pi/2,pi/2) q; }'}, {'name': 'cx', 'parameters': [], 'qasm_def': 'gate cx c,t { CX c,t; }'}, {'name': 'id', 'parameters': [], 'qasm_def': 'gate id a { U(0,0,0) a; }'}, {'name': 'unitary', 'parameters': ['matrix'], 'qasm_def': 'unitary(matrix) q1, q2,...'}], 'local': True, 'max_shots': 65536, 'memory': True, 'n_qubits': 24, 'open_pulse': False, 'simulator': True, 'url': 'https://github.com/Qiskit/qiskit-terra'}` - + ### DEFAULT\_OPTIONS = \{'chop\_threshold' @@ -71,28 +245,29 @@ default values set `= {'chop_threshold': 1e-15, 'initial_statevector': None}` - + ### MAX\_QUBITS\_MEMORY `= 32` - + ### SHOW\_FINAL\_STATE `= False` - + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.basicaer.QasmSimulatorPy.run#qiskit.providers.basicaer.QasmSimulatorPy.run "qiskit.providers.basicaer.QasmSimulatorPy.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.basicaer.QasmSimulatorPy#run "qiskit.providers.basicaer.QasmSimulatorPy.run") method. + ### version `= 1` + 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 1e78acc0ed3..6bd139db4e5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.StatevectorSimulatorPy.md @@ -1,8 +1,16 @@ -# StatevectorSimulatorPy +--- +title: StatevectorSimulatorPy +description: API reference for qiskit.providers.basicaer.StatevectorSimulatorPy +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.basicaer.StatevectorSimulatorPy +--- +# StatevectorSimulatorPy + -`StatevectorSimulatorPy(configuration=None, provider=None, **fields)` +`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` @@ -12,8 +20,8 @@ Initialize a backend class **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. -* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. +* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. * **fields** – kwargs for the values to use to override the default options. **Raises** @@ -22,13 +30,15 @@ Initialize a backend class In addition to the public abstract methods, subclasses should also implement the following private methods: +### \_default\_options + `classmethod _default_options()` Return the default options -This method will return a [`qiskit.providers.Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. +This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. **Returns** @@ -38,24 +48,188 @@ default values set **Return type** -[qiskit.providers.Options](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") +[qiskit.providers.Options](qiskit.providers.Options "qiskit.providers.Options") ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`configuration`](qiskit.providers.basicaer.StatevectorSimulatorPy.configuration#qiskit.providers.basicaer.StatevectorSimulatorPy.configuration "qiskit.providers.basicaer.StatevectorSimulatorPy.configuration") | Return the backend configuration. | -| [`name`](qiskit.providers.basicaer.StatevectorSimulatorPy.name#qiskit.providers.basicaer.StatevectorSimulatorPy.name "qiskit.providers.basicaer.StatevectorSimulatorPy.name") | Return the backend name. | -| [`properties`](qiskit.providers.basicaer.StatevectorSimulatorPy.properties#qiskit.providers.basicaer.StatevectorSimulatorPy.properties "qiskit.providers.basicaer.StatevectorSimulatorPy.properties") | Return the backend properties. | -| [`provider`](qiskit.providers.basicaer.StatevectorSimulatorPy.provider#qiskit.providers.basicaer.StatevectorSimulatorPy.provider "qiskit.providers.basicaer.StatevectorSimulatorPy.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.basicaer.StatevectorSimulatorPy.run#qiskit.providers.basicaer.StatevectorSimulatorPy.run "qiskit.providers.basicaer.StatevectorSimulatorPy.run") | Run qobj asynchronously. | -| [`run_experiment`](qiskit.providers.basicaer.StatevectorSimulatorPy.run_experiment#qiskit.providers.basicaer.StatevectorSimulatorPy.run_experiment "qiskit.providers.basicaer.StatevectorSimulatorPy.run_experiment") | Run an experiment (circuit) and return a single experiment result. | -| [`set_options`](qiskit.providers.basicaer.StatevectorSimulatorPy.set_options#qiskit.providers.basicaer.StatevectorSimulatorPy.set_options "qiskit.providers.basicaer.StatevectorSimulatorPy.set_options") | Set the options fields for the backend | -| [`status`](qiskit.providers.basicaer.StatevectorSimulatorPy.status#qiskit.providers.basicaer.StatevectorSimulatorPy.status "qiskit.providers.basicaer.StatevectorSimulatorPy.status") | Return the backend status. | +### configuration -## Attributes + + +`StatevectorSimulatorPy.configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### name + + + +`StatevectorSimulatorPy.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`StatevectorSimulatorPy.properties()` + +Return the backend properties. + +**Returns** + +the configuration for the backend. If the backend does not support properties, it returns `None`. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`StatevectorSimulatorPy.provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + + +`StatevectorSimulatorPy.run(qobj, **backend_options)` + +Run qobj asynchronously. + +**Parameters** + +* **qobj** ([*Qobj*](qiskit.qobj.Qobj "qiskit.qobj.Qobj")) – payload of the experiment +* **backend\_options** (*dict*) – backend options + +**Returns** + +derived from BaseJob + +**Return type** + +[BasicAerJob](qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob") + +#### Additional Information: + +#### backend\_options: Is a dict of options for the backend. It may contain + +* “initial\_statevector”: vector\_like + +The “initial\_statevector” option specifies a custom initial initial statevector for the simulator to be used instead of the all zero state. This size of this vector must be correct for the number of qubits in all experiments in the qobj. + +Example: + +```python +backend_options = { + "initial_statevector": np.array([1, 0, 0, 1j]) / np.sqrt(2), +} +``` + +### run\_experiment + + + +`StatevectorSimulatorPy.run_experiment(experiment)` + +Run an experiment (circuit) and return a single experiment result. + +**Parameters** + +**experiment** (*QobjExperiment*) – experiment from qobj experiments list + +**Returns** + +A result dictionary which looks something like: + +```python +{ +"name": name of this experiment (obtained from qobj.experiment header) +"seed": random seed used for simulation +"shots": number of shots used in the simulation +"data": + { + "counts": {'0x9: 5, ...}, + "memory": ['0x9', '0xF', '0x1D', ..., '0x9'] + }, +"status": status string for the simulation +"success": boolean +"time_taken": simulation time of this single experiment +} +``` + +**Return type** + +dict + +**Raises** + +[**BasicAerError**](qiskit.providers.basicaer.BasicAerError "qiskit.providers.basicaer.BasicAerError") – if an error occurred. + +### set\_options + + +`StatevectorSimulatorPy.set_options(**fields)` +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + +### status + + + +`StatevectorSimulatorPy.status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### DEFAULT\_CONFIGURATION = \{'backend\_name' @@ -63,7 +237,7 @@ default values set `= {'backend_name': 'statevector_simulator', 'backend_version': '1.1.0', 'basis_gates': ['u1', 'u2', 'u3', 'rz', 'sx', 'x', 'cx', 'id', 'unitary'], 'conditional': True, 'coupling_map': None, 'description': 'A Python statevector simulator for qobj files', 'gates': [{'name': 'u1', 'parameters': ['lambda'], 'qasm_def': 'gate u1(lambda) q { U(0,0,lambda) q; }'}, {'name': 'u2', 'parameters': ['phi', 'lambda'], 'qasm_def': 'gate u2(phi,lambda) q { U(pi/2,phi,lambda) q; }'}, {'name': 'u3', 'parameters': ['theta', 'phi', 'lambda'], 'qasm_def': 'gate u3(theta,phi,lambda) q { U(theta,phi,lambda) q; }'}, {'name': 'rz', 'parameters': ['phi'], 'qasm_def': 'gate rz(phi) q { U(0,0,phi) q; }'}, {'name': 'sx', 'parameters': [], 'qasm_def': 'gate sx(phi) q { U(pi/2,7*pi/2,pi/2) q; }'}, {'name': 'x', 'parameters': [], 'qasm_def': 'gate x q { U(pi,7*pi/2,pi/2) q; }'}, {'name': 'cx', 'parameters': [], 'qasm_def': 'gate cx c,t { CX c,t; }'}, {'name': 'id', 'parameters': [], 'qasm_def': 'gate id a { U(0,0,0) a; }'}, {'name': 'unitary', 'parameters': ['matrix'], 'qasm_def': 'unitary(matrix) q1, q2,...'}], 'local': True, 'max_shots': 65536, 'memory': True, 'n_qubits': 24, 'open_pulse': False, 'simulator': True, 'url': 'https://github.com/Qiskit/qiskit-terra'}` - + ### DEFAULT\_OPTIONS = \{'chop\_threshold' @@ -71,28 +245,29 @@ default values set `= {'chop_threshold': 1e-15, 'initial_statevector': None}` - + ### MAX\_QUBITS\_MEMORY `= 32` - + ### SHOW\_FINAL\_STATE `= True` - + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.basicaer.StatevectorSimulatorPy.run#qiskit.providers.basicaer.StatevectorSimulatorPy.run "qiskit.providers.basicaer.StatevectorSimulatorPy.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.basicaer.StatevectorSimulatorPy#run "qiskit.providers.basicaer.StatevectorSimulatorPy.run") method. + ### version `= 1` + 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 ff6cab36c92..5982f0ec5ac 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.md +++ b/docs/api/qiskit/0.32/qiskit.providers.basicaer.UnitarySimulatorPy.md @@ -1,8 +1,16 @@ -# UnitarySimulatorPy +--- +title: UnitarySimulatorPy +description: API reference for qiskit.providers.basicaer.UnitarySimulatorPy +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.basicaer.UnitarySimulatorPy +--- +# UnitarySimulatorPy + -`UnitarySimulatorPy(configuration=None, provider=None, **fields)` +`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` @@ -12,8 +20,8 @@ Initialize a backend class **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. -* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. +* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. * **fields** – kwargs for the values to use to override the default options. **Raises** @@ -22,13 +30,15 @@ Initialize a backend class In addition to the public abstract methods, subclasses should also implement the following private methods: +### \_default\_options + `classmethod _default_options()` Return the default options -This method will return a [`qiskit.providers.Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. +This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. **Returns** @@ -38,24 +48,200 @@ default values set **Return type** -[qiskit.providers.Options](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") +[qiskit.providers.Options](qiskit.providers.Options "qiskit.providers.Options") ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`configuration`](qiskit.providers.basicaer.UnitarySimulatorPy.configuration#qiskit.providers.basicaer.UnitarySimulatorPy.configuration "qiskit.providers.basicaer.UnitarySimulatorPy.configuration") | Return the backend configuration. | -| [`name`](qiskit.providers.basicaer.UnitarySimulatorPy.name#qiskit.providers.basicaer.UnitarySimulatorPy.name "qiskit.providers.basicaer.UnitarySimulatorPy.name") | Return the backend name. | -| [`properties`](qiskit.providers.basicaer.UnitarySimulatorPy.properties#qiskit.providers.basicaer.UnitarySimulatorPy.properties "qiskit.providers.basicaer.UnitarySimulatorPy.properties") | Return the backend properties. | -| [`provider`](qiskit.providers.basicaer.UnitarySimulatorPy.provider#qiskit.providers.basicaer.UnitarySimulatorPy.provider "qiskit.providers.basicaer.UnitarySimulatorPy.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.basicaer.UnitarySimulatorPy.run#qiskit.providers.basicaer.UnitarySimulatorPy.run "qiskit.providers.basicaer.UnitarySimulatorPy.run") | Run qobj asynchronously. | -| [`run_experiment`](qiskit.providers.basicaer.UnitarySimulatorPy.run_experiment#qiskit.providers.basicaer.UnitarySimulatorPy.run_experiment "qiskit.providers.basicaer.UnitarySimulatorPy.run_experiment") | Run an experiment (circuit) and return a single experiment result. | -| [`set_options`](qiskit.providers.basicaer.UnitarySimulatorPy.set_options#qiskit.providers.basicaer.UnitarySimulatorPy.set_options "qiskit.providers.basicaer.UnitarySimulatorPy.set_options") | Set the options fields for the backend | -| [`status`](qiskit.providers.basicaer.UnitarySimulatorPy.status#qiskit.providers.basicaer.UnitarySimulatorPy.status "qiskit.providers.basicaer.UnitarySimulatorPy.status") | Return the backend status. | +### configuration -## Attributes + + +`UnitarySimulatorPy.configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### name + + + +`UnitarySimulatorPy.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`UnitarySimulatorPy.properties()` + +Return the backend properties. + +**Returns** + +the configuration for the backend. If the backend does not support properties, it returns `None`. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`UnitarySimulatorPy.provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### run + + +`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. + +**Parameters** + +* **qobj** ([*Qobj*](qiskit.qobj.Qobj "qiskit.qobj.Qobj")) – payload of the experiment +* **backend\_options** (*dict*) – backend options + +**Returns** + +derived from BaseJob + +**Return type** +[BasicAerJob](qiskit.providers.basicaer.BasicAerJob "qiskit.providers.basicaer.BasicAerJob") + +Additional Information: + +```python +backend_options: Is a dict of options for the backend. It may contain + * "initial_unitary": matrix_like + * "chop_threshold": double + +The "initial_unitary" option specifies a custom initial unitary +matrix for the simulator to be used instead of the identity +matrix. This size of this matrix must be correct for the number +of qubits inall experiments in the qobj. + +The "chop_threshold" option specifies a truncation value for +setting small values to zero in the output unitary. The default +value is 1e-15. + +Example:: + + backend_options = { + "initial_unitary": np.array([[1, 0, 0, 0], + [0, 0, 0, 1], + [0, 0, 1, 0], + [0, 1, 0, 0]]) + "chop_threshold": 1e-15 + } +``` + +### run\_experiment + + + +`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. + +**Parameters** + +**experiment** (*QobjExperiment*) – experiment from qobj experiments list + +**Returns** + +A result dictionary which looks something like: + +```python +{ +"name": name of this experiment (obtained from qobj.experiment header) +"seed": random seed used for simulation +"shots": number of shots used in the simulation +"data": + { + "unitary": [[[0.0, 0.0], [1.0, 0.0]], + [[1.0, 0.0], [0.0, 0.0]]] + }, +"status": status string for the simulation +"success": boolean +"time taken": simulation time of this single experiment +} +``` + +**Return type** + +dict + +**Raises** + +* [**BasicAerError**](qiskit.providers.basicaer.BasicAerError "qiskit.providers.basicaer.BasicAerError") – if the number of qubits in the circuit is greater than 24. +* **Note that the practical qubit limit is much lower than 24.** – + +### set\_options + + + +`UnitarySimulatorPy.set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + +### status + + + +`UnitarySimulatorPy.status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### DEFAULT\_CONFIGURATION = \{'backend\_name' @@ -63,7 +249,7 @@ default values set `= {'backend_name': 'unitary_simulator', 'backend_version': '1.1.0', 'basis_gates': ['u1', 'u2', 'u3', 'rz', 'sx', 'x', 'cx', 'id', 'unitary'], 'conditional': False, 'coupling_map': None, 'description': 'A python simulator for unitary matrix corresponding to a circuit', 'gates': [{'name': 'u1', 'parameters': ['lambda'], 'qasm_def': 'gate u1(lambda) q { U(0,0,lambda) q; }'}, {'name': 'u2', 'parameters': ['phi', 'lambda'], 'qasm_def': 'gate u2(phi,lambda) q { U(pi/2,phi,lambda) q; }'}, {'name': 'u3', 'parameters': ['theta', 'phi', 'lambda'], 'qasm_def': 'gate u3(theta,phi,lambda) q { U(theta,phi,lambda) q; }'}, {'name': 'rz', 'parameters': ['phi'], 'qasm_def': 'gate rz(phi) q { U(0,0,phi) q; }'}, {'name': 'sx', 'parameters': [], 'qasm_def': 'gate sx(phi) q { U(pi/2,7*pi/2,pi/2) q; }'}, {'name': 'x', 'parameters': [], 'qasm_def': 'gate x q { U(pi,7*pi/2,pi/2) q; }'}, {'name': 'cx', 'parameters': [], 'qasm_def': 'gate cx c,t { CX c,t; }'}, {'name': 'id', 'parameters': [], 'qasm_def': 'gate id a { U(0,0,0) a; }'}, {'name': 'unitary', 'parameters': ['matrix'], 'qasm_def': 'unitary(matrix) q1, q2,...'}], 'local': True, 'max_shots': 65536, 'memory': False, 'n_qubits': 16, 'open_pulse': False, 'simulator': True, 'url': 'https://github.com/Qiskit/qiskit-terra'}` - + ### DEFAULT\_OPTIONS = \{'chop\_threshold' @@ -71,22 +257,23 @@ default values set `= {'chop_threshold': 1e-15, 'initial_unitary': None}` - + ### MAX\_QUBITS\_MEMORY `= 16` - + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.basicaer.UnitarySimulatorPy.run#qiskit.providers.basicaer.UnitarySimulatorPy.run "qiskit.providers.basicaer.UnitarySimulatorPy.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.basicaer.UnitarySimulatorPy#run "qiskit.providers.basicaer.UnitarySimulatorPy.run") method. + ### version `= 1` + 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 0be8b66861b..ee377ff4552 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.AccountProvider.md @@ -1,8 +1,16 @@ -# AccountProvider +--- +title: AccountProvider +description: API reference for qiskit.providers.ibmq.AccountProvider +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.AccountProvider +--- +# AccountProvider + -`AccountProvider(credentials, factory)` +`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` @@ -10,18 +18,18 @@ Provider for a single IBM Quantum Experience account. The account provider class provides access to the IBM Quantum Experience services available to this account. -You can access a provider by enabling an account with the [`IBMQ.enable_account()`](qiskit.providers.ibmq.IBMQFactory.enable_account#qiskit.providers.ibmq.IBMQFactory.enable_account "qiskit.providers.ibmq.IBMQFactory.enable_account") method, which returns the default provider you have access to: +You can access a provider by enabling an account with the [`IBMQ.enable_account()`](qiskit.providers.ibmq.IBMQFactory#enable_account "qiskit.providers.ibmq.IBMQFactory.enable_account") method, which returns the default provider you have access to: ```python from qiskit import IBMQ provider = IBMQ.enable_account() ``` -To select a different provider, use the [`IBMQ.get_provider()`](qiskit.providers.ibmq.IBMQFactory.get_provider#qiskit.providers.ibmq.IBMQFactory.get_provider "qiskit.providers.ibmq.IBMQFactory.get_provider") method and specify the hub, group, or project name of the desired provider. +To select a different provider, use the [`IBMQ.get_provider()`](qiskit.providers.ibmq.IBMQFactory#get_provider "qiskit.providers.ibmq.IBMQFactory.get_provider") method and specify the hub, group, or project name of the desired provider. Each provider may offer different services. The main service, `IBMQBackendService`, is available to all providers and gives access to IBM Quantum Experience devices and simulators. -You can obtain an instance of a service using the [`service()`](qiskit.providers.ibmq.AccountProvider.service#qiskit.providers.ibmq.AccountProvider.service "qiskit.providers.ibmq.AccountProvider.service") method or as an attribute of this `AccountProvider` instance. For example: +You can obtain an instance of a service using the [`service()`](qiskit.providers.ibmq.AccountProvider#service "qiskit.providers.ibmq.AccountProvider.service") method or as an attribute of this `AccountProvider` instance. For example: ```python backend_service = provider.service('backend') @@ -30,13 +38,13 @@ backend_service = provider.service.backend Since `IBMQBackendService` is the main service, some of the backend-related methods are available through this class for convenience. -The [`backends()`](qiskit.providers.ibmq.AccountProvider.backends#qiskit.providers.ibmq.AccountProvider.backends "qiskit.providers.ibmq.AccountProvider.backends") method returns all the backends available to this account: +The [`backends()`](qiskit.providers.ibmq.AccountProvider#backends "qiskit.providers.ibmq.AccountProvider.backends") method returns all the backends available to this account: ```python backends = provider.backends() ``` -The [`get_backend()`](qiskit.providers.ibmq.AccountProvider.get_backend#qiskit.providers.ibmq.AccountProvider.get_backend "qiskit.providers.ibmq.AccountProvider.get_backend") method returns a backend that matches the filters passed as argument. An example of retrieving a backend that matches a specified name: +The [`get_backend()`](qiskit.providers.ibmq.AccountProvider#get_backend "qiskit.providers.ibmq.AccountProvider.get_backend") method returns a backend that matches the filters passed as argument. An example of retrieving a backend that matches a specified name: ```python simulator_backend = provider.get_backend('ibmq_qasm_simulator') @@ -61,18 +69,173 @@ AccountProvider constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| [`backends`](qiskit.providers.ibmq.AccountProvider.backends#qiskit.providers.ibmq.AccountProvider.backends "qiskit.providers.ibmq.AccountProvider.backends") | Return all backends accessible via this provider, subject to optional filtering. | -| [`get_backend`](qiskit.providers.ibmq.AccountProvider.get_backend#qiskit.providers.ibmq.AccountProvider.get_backend "qiskit.providers.ibmq.AccountProvider.get_backend") | Return a single backend matching the specified filtering. | -| [`has_service`](qiskit.providers.ibmq.AccountProvider.has_service#qiskit.providers.ibmq.AccountProvider.has_service "qiskit.providers.ibmq.AccountProvider.has_service") | Check if this provider has access to the service. | -| [`run_circuits`](qiskit.providers.ibmq.AccountProvider.run_circuits#qiskit.providers.ibmq.AccountProvider.run_circuits "qiskit.providers.ibmq.AccountProvider.run_circuits") | Execute the input circuit(s) on a backend using the runtime service. | -| [`service`](qiskit.providers.ibmq.AccountProvider.service#qiskit.providers.ibmq.AccountProvider.service "qiskit.providers.ibmq.AccountProvider.service") | Return the specified service. | -| [`services`](qiskit.providers.ibmq.AccountProvider.services#qiskit.providers.ibmq.AccountProvider.services "qiskit.providers.ibmq.AccountProvider.services") | Return all available services. | +### backends -## Attributes + + +`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. + +**Parameters** + +* **name** (`Optional`\[`str`]) – Backend name to filter by. + +* **filters** (`Optional`\[`Callable`\[\[`List`\[`IBMQBackend`]], `bool`]]) – + + More complex filters, such as lambda functions. For example: + + ```python + AccountProvider.backends(filters=lambda b: b.configuration().n_qubits > 5) + ``` + +* **kwargs** (`Any`) – + + Simple filters that specify a `True`/`False` criteria in the backend configuration, backends status, or provider credentials. An example to get the operational backends with 5 qubits: + + ```python + AccountProvider.backends(n_qubits=5, operational=True) + ``` + +**Return type** + +`List`\[`IBMQBackend`] + +**Returns** + +The list of available backends that match the filter. + +### get\_backend + + + +`AccountProvider.get_backend(name=None, **kwargs)` + +Return a single backend matching the specified filtering. + +**Parameters** + +* **name** (*str*) – name of the backend. +* **\*\*kwargs** – dict used for filtering. + +**Returns** + +a backend matching the filtering. + +**Return type** + +[Backend](qiskit.providers.Backend "qiskit.providers.Backend") + +**Raises** + +[**QiskitBackendNotFoundError**](qiskit.providers.QiskitBackendNotFoundError "qiskit.providers.QiskitBackendNotFoundError") – if no backend could be found or more than one backend matches the filtering criteria. + +### has\_service + + + +`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. + +**Parameters** + +**name** (`str`) – Name of the service. + +**Return type** + +`bool` + +**Returns** + +Whether the provider has access to the service. + +**Raises** + +**IBMQInputValueError** – If an unknown service name is specified. + +### run\_circuits + + + +`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. + + + This method uses the IBM Quantum runtime service which is not available to all accounts. + + +**Parameters** + +* **circuits** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]]) – Circuit(s) to execute. +* **backend\_name** (`str`) – Name of the backend to execute circuits on. Transpiler options are automatically grabbed from backend configuration and properties unless otherwise specified. +* **shots** (`Optional`\[`int`]) – Number of repetitions of each circuit, for sampling. If not specified, the backend default is used. +* **initial\_layout** (`Union`\[`Layout`, `Dict`, `List`, `None`]) – Initial position of virtual qubits on physical qubits. +* **layout\_method** (`Optional`\[`str`]) – Name of layout selection pass (‘trivial’, ‘dense’, ‘noise\_adaptive’, ‘sabre’). Sometimes a perfect layout can be available in which case the layout\_method may not run. +* **routing\_method** (`Optional`\[`str`]) – Name of routing pass (‘basic’, ‘lookahead’, ‘stochastic’, ‘sabre’) +* **translation\_method** (`Optional`\[`str`]) – Name of translation pass (‘unroller’, ‘translator’, ‘synthesis’) +* **seed\_transpiler** (`Optional`\[`int`]) – Sets random seed for the stochastic parts of the transpiler. +* **optimization\_level** (`int`) – How much optimization to perform on the circuits. Higher levels generate more optimized circuits, at the expense of longer transpilation time. If None, level 1 will be chosen as default. +* **init\_qubits** (`bool`) – Whether to reset the qubits to the ground state for each shot. +* **rep\_delay** (`Optional`\[`float`]) – Delay between programs in seconds. Only supported on certain backends (`backend.configuration().dynamic_reprate_enabled` ). If supported, `rep_delay` will be used instead of `rep_time` and must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is given by `backend.configuration().default_rep_delay`. +* **transpiler\_options** (`Optional`\[`dict`]) – Additional transpiler options. +* **measurement\_error\_mitigation** (`bool`) – Whether to apply measurement error mitigation. +* **use\_measure\_esp** (`Optional`\[`bool`]) – Whether to use excited state promoted (ESP) readout for measurements which are the final instruction on a qubit. ESP readout can offer higher fidelity than standard measurement sequences. See [here](https://arxiv.org/pdf/2008.08571.pdf). +* **\*\*run\_config** – Extra arguments used to configure the circuit execution. + +**Return type** + +`RuntimeJob` + +**Returns** + +Runtime job. + +### service + + + +`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. + +**Parameters** + +**name** (`str`) – Name of the service. +**Return type** + +`Any` + +**Returns** + +The specified service. + +**Raises** +* **IBMQInputValueError** – If an unknown service name is specified. +* **IBMQNotAuthorizedError** – If the account is not authorized to use the service. + +### services + + + +`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. + +**Return type** + +`Dict` + +**Returns** + +All services available to this provider. + +## Attributes + + ### backend @@ -86,7 +249,7 @@ Return the backend service. The backend service instance. - + ### experiment @@ -104,7 +267,7 @@ The experiment service instance. **IBMQNotAuthorizedError** – If the account is not authorized to use the experiment service. - + ### random @@ -122,7 +285,7 @@ The random number service instance. **IBMQNotAuthorizedError** – If the account is not authorized to use the service. - + ### runtime @@ -140,8 +303,9 @@ The runtime service instance. **IBMQNotAuthorizedError** – If the account is not authorized to use the service. - + ### version `= 1` + 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 4c41a30c911..85016b461db 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.BackendJobLimit.md @@ -1,22 +1,30 @@ -# BackendJobLimit +--- +title: BackendJobLimit +description: API reference for qiskit.providers.ibmq.BackendJobLimit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.BackendJobLimit +--- +# BackendJobLimit + -`BackendJobLimit(maximum_jobs, running_jobs, **kwargs)` +`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` Job limit for a backend. -Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend.job_limit#qiskit.providers.ibmq.IBMQBackend.job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. - +Represent the job limit for a backend on a specific provider. This instance is returned by the [`IBMQBackend.job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method. + ### maximum\_jobs The maximum number of concurrent jobs this account is allowed to submit to this backend, with this provider. - + ### running\_jobs @@ -29,3 +37,4 @@ BackendJobLimit constructor. * **maximum\_jobs** (`int`) – The maximum number of concurrent jobs this account is allowed to submit to this backend, with this provider. * **running\_jobs** (`int`) – The current number of active jobs on this backend, with this provider. * **kwargs** (`Any`) – Additional attributes that will be added as instance members. + 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 73ca1836f5f..f32e6661621 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat +--- +title: IBMQAccountCredentialsInvalidFormat +description: API reference for qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat +--- +# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat + -`IBMQAccountCredentialsInvalidFormat(*message)` +`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. Set the error message. + 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 8a5d785a329..4f297b21f45 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken +--- +title: IBMQAccountCredentialsInvalidToken +description: API reference for qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken +--- +# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken + -`IBMQAccountCredentialsInvalidToken(*message)` +`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. Set the error message. + 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 a8f13b6faa4..d5033de02b1 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl +--- +title: IBMQAccountCredentialsInvalidUrl +description: API reference for qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl +--- +# qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl + -`IBMQAccountCredentialsInvalidUrl(*message)` +`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. Set the error message. + 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 6c7331408ae..657ec0e7086 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountCredentialsNotFound.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQAccountCredentialsNotFound +--- +title: IBMQAccountCredentialsNotFound +description: API reference for qiskit.providers.ibmq.IBMQAccountCredentialsNotFound +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQAccountCredentialsNotFound +--- +# qiskit.providers.ibmq.IBMQAccountCredentialsNotFound + -`IBMQAccountCredentialsNotFound(*message)` +`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. Set the error message. + 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 bd5f7389496..24aff3b033d 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountError.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQAccountError +--- +title: IBMQAccountError +description: API reference for qiskit.providers.ibmq.IBMQAccountError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQAccountError +--- +# qiskit.providers.ibmq.IBMQAccountError + -`IBMQAccountError(*message)` +`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. Set the error message. + 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 54db9f76260..eed050ae3bd 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound +--- +title: IBMQAccountMultipleCredentialsFound +description: API reference for qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound +--- +# qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound + -`IBMQAccountMultipleCredentialsFound(*message)` +`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. Set the error message. + 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 5d465bf5f34..0d53acc2879 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackend.md @@ -1,14 +1,22 @@ -# IBMQBackend +--- +title: IBMQBackend +description: API reference for qiskit.providers.ibmq.IBMQBackend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.IBMQBackend +--- +# IBMQBackend + -`IBMQBackend(configuration, provider, credentials, api_client)` +`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` Backend class interfacing with an IBM Quantum Experience device. -You can run experiments on a backend using the [`run()`](qiskit.providers.ibmq.IBMQBackend.run#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. The [`run()`](qiskit.providers.ibmq.IBMQBackend.run#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method takes one or more [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") and returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob#qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: +You can run experiments on a backend using the [`run()`](qiskit.providers.ibmq.IBMQBackend#run "qiskit.providers.ibmq.IBMQBackend.run") method. The [`run()`](qiskit.providers.ibmq.IBMQBackend#run "qiskit.providers.ibmq.IBMQBackend.run") method takes one or more [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") and returns an [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instance that represents the submitted job. Each job has a unique job ID, which can later be used to retrieve the job. An example of this flow: ```python from qiskit import IBMQ, assemble, transpile @@ -23,11 +31,11 @@ retrieved_job = backend.retrieve_job(job.job_id()) ``` - * Unlike `qiskit.execute()`, the [`run()`](qiskit.providers.ibmq.IBMQBackend.run#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method does not transpile the circuits/schedules for you, so be sure to do so before submitting them. - * You should not instantiate the `IBMQBackend` class directly. Instead, use the methods provided by an [`AccountProvider`](qiskit.providers.ibmq.AccountProvider#qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") instance to retrieve and handle backends. + * Unlike `qiskit.execute()`, the [`run()`](qiskit.providers.ibmq.IBMQBackend#run "qiskit.providers.ibmq.IBMQBackend.run") method does not transpile the circuits/schedules for you, so be sure to do so before submitting them. + * You should not instantiate the `IBMQBackend` class directly. Instead, use the methods provided by an [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") instance to retrieve and handle backends. -Other methods return information about the backend. For example, the [`status()`](qiskit.providers.ibmq.IBMQBackend.status#qiskit.providers.ibmq.IBMQBackend.status "qiskit.providers.ibmq.IBMQBackend.status") method returns a [`BackendStatus`](qiskit.providers.models.BackendStatus#qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: +Other methods return information about the backend. For example, the [`status()`](qiskit.providers.ibmq.IBMQBackend#status "qiskit.providers.ibmq.IBMQBackend.status") method returns a [`BackendStatus`](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") instance. The instance contains the `operational` and `pending_jobs` attributes, which state whether the backend is operational and also the number of jobs in the server queue for the backend, respectively: ```python status = backend.status() @@ -35,7 +43,7 @@ is_operational = status.operational jobs_in_queue = status.pending_jobs ``` -It is also possible to see the number of remaining jobs you are able to submit to the backend with the [`job_limit()`](qiskit.providers.ibmq.IBMQBackend.job_limit#qiskit.providers.ibmq.IBMQBackend.job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method, which returns a [`BackendJobLimit`](qiskit.providers.ibmq.BackendJobLimit#qiskit.providers.ibmq.BackendJobLimit "qiskit.providers.ibmq.BackendJobLimit") instance: +It is also possible to see the number of remaining jobs you are able to submit to the backend with the [`job_limit()`](qiskit.providers.ibmq.IBMQBackend#job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") method, which returns a [`BackendJobLimit`](qiskit.providers.ibmq.BackendJobLimit "qiskit.providers.ibmq.BackendJobLimit") instance: ```python job_limit = backend.job_limit() @@ -52,47 +60,466 @@ IBMQBackend constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------- | -| [`active_jobs`](qiskit.providers.ibmq.IBMQBackend.active_jobs#qiskit.providers.ibmq.IBMQBackend.active_jobs "qiskit.providers.ibmq.IBMQBackend.active_jobs") | Return the unfinished jobs submitted to this backend. | -| [`configuration`](qiskit.providers.ibmq.IBMQBackend.configuration#qiskit.providers.ibmq.IBMQBackend.configuration "qiskit.providers.ibmq.IBMQBackend.configuration") | Return the backend configuration. | -| [`defaults`](qiskit.providers.ibmq.IBMQBackend.defaults#qiskit.providers.ibmq.IBMQBackend.defaults "qiskit.providers.ibmq.IBMQBackend.defaults") | Return the pulse defaults for the backend. | -| [`job_limit`](qiskit.providers.ibmq.IBMQBackend.job_limit#qiskit.providers.ibmq.IBMQBackend.job_limit "qiskit.providers.ibmq.IBMQBackend.job_limit") | Return the job limit for the backend. | -| [`jobs`](qiskit.providers.ibmq.IBMQBackend.jobs#qiskit.providers.ibmq.IBMQBackend.jobs "qiskit.providers.ibmq.IBMQBackend.jobs") | Return the jobs submitted to this backend, subject to optional filtering. | -| [`name`](qiskit.providers.ibmq.IBMQBackend.name#qiskit.providers.ibmq.IBMQBackend.name "qiskit.providers.ibmq.IBMQBackend.name") | Return the backend name. | -| [`properties`](qiskit.providers.ibmq.IBMQBackend.properties#qiskit.providers.ibmq.IBMQBackend.properties "qiskit.providers.ibmq.IBMQBackend.properties") | Return the backend properties, subject to optional filtering. | -| [`provider`](qiskit.providers.ibmq.IBMQBackend.provider#qiskit.providers.ibmq.IBMQBackend.provider "qiskit.providers.ibmq.IBMQBackend.provider") | Return the backend Provider. | -| [`remaining_jobs_count`](qiskit.providers.ibmq.IBMQBackend.remaining_jobs_count#qiskit.providers.ibmq.IBMQBackend.remaining_jobs_count "qiskit.providers.ibmq.IBMQBackend.remaining_jobs_count") | Return the number of remaining jobs that could be submitted to the backend. | -| [`reservations`](qiskit.providers.ibmq.IBMQBackend.reservations#qiskit.providers.ibmq.IBMQBackend.reservations "qiskit.providers.ibmq.IBMQBackend.reservations") | Return backend reservations. | -| [`retrieve_job`](qiskit.providers.ibmq.IBMQBackend.retrieve_job#qiskit.providers.ibmq.IBMQBackend.retrieve_job "qiskit.providers.ibmq.IBMQBackend.retrieve_job") | Return a single job submitted to this backend. | -| [`run`](qiskit.providers.ibmq.IBMQBackend.run#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") | Run on the backend. | -| [`set_options`](qiskit.providers.ibmq.IBMQBackend.set_options#qiskit.providers.ibmq.IBMQBackend.set_options "qiskit.providers.ibmq.IBMQBackend.set_options") | Set the options fields for the backend | -| [`status`](qiskit.providers.ibmq.IBMQBackend.status#qiskit.providers.ibmq.IBMQBackend.status "qiskit.providers.ibmq.IBMQBackend.status") | Return the backend status. | +### active\_jobs -## Attributes + + +`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. + +Return the jobs submitted to this backend, with this provider, that are currently in an unfinished job status state. The unfinished `JobStatus` states include: `INITIALIZING`, `VALIDATING`, `QUEUED`, and `RUNNING`. + +**Parameters** + +**limit** (`int`) – Number of jobs to retrieve. + +**Return type** + +`List`\[`IBMQJob`] + +**Returns** + +A list of the unfinished jobs for this backend on this provider. + +### configuration + + + +`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. + +Backend configuration contains fixed information about the backend, such as its name, number of qubits, basis gates, coupling map, quantum volume, etc. + +The schema for backend configuration can be found in [Qiskit/ibm-quantum-schemas](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_configuration_schema.json). + +**Return type** + +`Union`\[`QasmBackendConfiguration`, `PulseBackendConfiguration`] + +**Returns** + +The configuration for the backend. + +### defaults + + + +`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. + +The schema for default pulse configuration can be found in [Qiskit/ibm-quantum-schemas](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/default_pulse_configuration_schema.json). + +**Parameters** + +**refresh** (`bool`) – If `True`, re-query the server for the backend pulse defaults. Otherwise, return a cached version. + +**Return type** + +`Optional`\[`PulseDefaults`] + +**Returns** + +The backend pulse defaults or `None` if the backend does not support pulse. + +### job\_limit + + + +`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. + +The job limit information includes the current number of active jobs you have on the backend and the maximum number of active jobs you can have on it. + + + Job limit information for a backend is provider specific. For example, if you have access to the same backend via different providers, the job limit information might be different for each provider. + + +If the method call was successful, you can inspect the job limit for the backend by accessing the `maximum_jobs` and `active_jobs` attributes of the [`BackendJobLimit`](qiskit.providers.ibmq.BackendJobLimit "qiskit.providers.ibmq.BackendJobLimit") instance returned. For example: + +```python +backend_job_limit = backend.job_limit() +maximum_jobs = backend_job_limit.maximum_jobs +active_jobs = backend_job_limit.active_jobs +``` + +If `maximum_jobs` is equal to `None`, then there is no limit to the maximum number of active jobs you could have on the backend. + +**Return type** + +`BackendJobLimit` + +**Returns** + +The job limit for the backend, with this provider. + +**Raises** + +[**IBMQBackendApiProtocolError**](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError") – If an unexpected value is received from the server. + +### jobs + + + +`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. + +Retrieve jobs submitted to this backend that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server. See also the skip parameter for more control over pagination. + +**Parameters** + +* **limit** (`int`) – Number of jobs to retrieve. + +* **skip** (`int`) – Starting index for the job retrieval. + +* **status** (`Union`\[`JobStatus`, `str`, `List`\[`Union`\[`JobStatus`, `str`]], `None`]) – Only get jobs with this status or one of the statuses. For example, you can specify status=JobStatus.RUNNING or status=”RUNNING” or status=\[“RUNNING”, “ERROR”] + +* **job\_name** (`Optional`\[`str`]) – Filter by job name. The job\_name is matched partially and [regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) can be used. + +* **start\_datetime** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time. + +* **end\_datetime** (`Optional`\[`datetime`]) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time. + +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to jobs. + +* **job\_tags\_operator** (`Optional`\[`str`]) – + + Logical operator to use when filtering by job tags. Valid values are “AND” and “OR”: + + > * If “AND” is specified, then a job must have all of the tags specified in `job_tags` to be included. + > * If “OR” is specified, then a job only needs to have any of the tags specified in `job_tags` to be included. + +* **experiment\_id** (`Optional`\[`str`]) – Filter by job experiment ID. + +* **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (newest first). If `False`, return in ascending order. + +* **db\_filter** (`Optional`\[`Dict`\[`str`, `Any`]]) – + + A [loopback-based filter](https://loopback.io/doc/en/lb2/Querying-data.html). This is an interface to a database `where` filter. Some examples of its usage are: + + Filter last five jobs with errors: + + ```python + job_list = backend.jobs(limit=5, status=JobStatus.ERROR) + ``` + + Filter last five jobs with hub name `ibm-q`: + + ```python + filter = {'hubInfo.hub.name': 'ibm-q'} + job_list = backend.jobs(limit=5, db_filter=filter) + ``` + +**Return type** + +`List`\[`IBMQJob`] + +**Returns** + +A list of jobs that match the criteria. + +**Raises** + +[**IBMQBackendValueError**](qiskit.providers.ibmq.IBMQBackendValueError "qiskit.providers.ibmq.IBMQBackendValueError") – If a keyword value is not recognized. + +### name + + + +`IBMQBackend.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`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. + +This data describes qubits properties (such as T1 and T2), gates properties (such as gate length and error), and other general properties of the backend. + +The schema for backend properties can be found in [Qiskit/ibm-quantum-schemas](https://github.com/Qiskit/ibm-quantum-schemas/blob/main/schemas/backend_properties_schema.json). + +**Parameters** + +* **refresh** (`bool`) – If `True`, re-query the server for the backend properties. Otherwise, return a cached version. +* **datetime** (`Optional`\[`datetime`]) – By specifying datetime, this function returns an instance of the [`BackendProperties`](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") whose timestamp is closest to, but older than, the specified datetime. + +**Return type** + +`Optional`\[`BackendProperties`] + +**Returns** + +The backend properties or `None` if the backend properties are not currently available. + +**Raises** + +**TypeError** – If an input argument is not of the correct type. + +### provider + + + +`IBMQBackend.provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. +**Return type** +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") + +### remaining\_jobs\_count + + + +`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. + + + The number of remaining jobs for a backend is provider specific. For example, if you have access to the same backend via different providers, the number of remaining jobs might be different for each. See [`BackendJobLimit`](qiskit.providers.ibmq.BackendJobLimit "qiskit.providers.ibmq.BackendJobLimit") for the job limit information of a backend. + + +If `None` is returned, there are no limits to the maximum number of active jobs you could have on the backend. + +**Return type** + +`Optional`\[`int`] + +**Returns** + +The remaining number of jobs a user could submit to the backend, with this provider, before the maximum limit on active jobs is reached. + +**Raises** + +[**IBMQBackendApiProtocolError**](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError") – If an unexpected value is received from the server. + +### reservations + + + +`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. + +If start\_datetime and/or end\_datetime is specified, reservations with time slots that overlap with the specified time window will be returned. + +Some of the reservation information is only available if you are the owner of the reservation. + +**Parameters** + +* **start\_datetime** (`Optional`\[`datetime`]) – Filter by the given start date/time, in local timezone. +* **end\_datetime** (`Optional`\[`datetime`]) – Filter by the given end date/time, in local timezone. + +**Return type** + +`List`\[`BackendReservation`] + +**Returns** + +A list of reservations that match the criteria. + +### retrieve\_job + + + +`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. + +**Parameters** + +**job\_id** (`str`) – The ID of the job to retrieve. + +**Return type** + +`IBMQJob` + +**Returns** + +The job with the given ID. + +**Raises** + +[**IBMQBackendError**](qiskit.providers.ibmq.IBMQBackendError "qiskit.providers.ibmq.IBMQBackendError") – If job retrieval failed. + +### run + + + +`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. + +If a keyword specified here is also present in the `options` attribute/object, the value specified here will be used for this run. + +**Parameters** + +* **circuits** (`Union`\[`QasmQobj`, `PulseQobj`, `QuantumCircuit`, `Schedule`, `List`\[`Union`\[`QuantumCircuit`, `Schedule`]]]) – An individual or a list of `QuantumCircuit` or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects to run on the backend. A [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj") or a [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj") object is also supported but is deprecated. + +* **job\_name** (`Optional`\[`str`]) – Custom name to be assigned to the job. This job name can subsequently be used as a filter in the [`jobs()`](qiskit.providers.ibmq.IBMQBackend#jobs "qiskit.providers.ibmq.IBMQBackend.jobs") method. Job names do not need to be unique. + +* **job\_share\_level** (`Optional`\[`str`]) – + + Allows sharing a job at the hub, group, project, or global level. The possible job share levels are: `global`, `hub`, `group`, `project`, and `none`. + + > * global: The job is public to any user. + > * hub: The job is shared between the users in the same hub. + > * group: The job is shared between the users in the same group. + > * project: The job is shared between the users in the same project. + > * none: The job is not shared at any level. + + If the job share level is not specified, the job is not shared at any level. + +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. The tags can subsequently be used as a filter in the [`jobs()`](qiskit.providers.ibmq.IBMQBackend#jobs "qiskit.providers.ibmq.IBMQBackend.jobs") function call. + +* **experiment\_id** (`Optional`\[`str`]) – Used to add a job to an “experiment”, which is a collection of jobs and additional metadata. + +* **following arguments are NOT applicable if a Qobj is passed in.** (*The*) – + +* **header** (`Optional`\[`Dict`]) – User input that will be attached to the job and will be copied to the corresponding result header. Headers do not affect the run. This replaces the old `Qobj` header. + +* **shots** (`Optional`\[`int`]) – Number of repetitions of each circuit, for sampling. Default: 4000 or `max_shots` from the backend configuration, whichever is smaller. + +* **memory** (`Optional`\[`bool`]) – If `True`, per-shot measurement bitstrings are returned as well (provided the backend supports it). For OpenPulse jobs, only measurement level 2 supports this option. + +* **qubit\_lo\_freq** (`Optional`\[`List`\[`int`]]) – List of default qubit LO frequencies in Hz. Will be overridden by `schedule_los` if set. + +* **meas\_lo\_freq** (`Optional`\[`List`\[`int`]]) – List of default measurement LO frequencies in Hz. Will be overridden by `schedule_los` if set. + +* **schedule\_los** (`Union`\[`List`\[`Union`\[`Dict`\[`PulseChannel`, `float`], `LoConfig`]], `Dict`\[`PulseChannel`, `float`], `LoConfig`, `None`]) – Experiment LO configurations, frequencies are given in Hz. + +* **meas\_level** (`Union`\[`int`, `MeasLevel`, `None`]) – Set the appropriate level of the measurement output for pulse experiments. + +* **meas\_return** (`Union`\[`str`, `MeasReturnType`, `None`]) – + + Level of measurement data for the backend to return. + + **For `meas_level` 0 and 1:** + + * `single` returns information from every shot. + * `avg` returns average measurement output (averaged over number of shots). + +* **memory\_slots** (`Optional`\[`int`]) – Number of classical memory slots to use. + +* **memory\_slot\_size** (`Optional`\[`int`]) – Size of each memory slot if the output is Level 0. + +* **rep\_time** (`Optional`\[`int`]) – Time per program execution in seconds. Must be from the list provided by the backend (`backend.configuration().rep_times`). Defaults to the first entry. + +* **rep\_delay** (`Optional`\[`float`]) – Delay between programs in seconds. Only supported on certain backends (if `backend.configuration().dynamic_reprate_enabled=True`). If supported, `rep_delay` will be used instead of `rep_time` and must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is given by `backend.configuration().default_rep_delay`. + +* **init\_qubits** (`Optional`\[`bool`]) – Whether to reset the qubits to the ground state for each shot. Default: `True`. + +* **parameter\_binds** (`Optional`\[`List`\[`Dict`\[`Parameter`, `float`]]]) – List of Parameter bindings over which the set of experiments will be executed. Each list element (bind) should be of the form \{Parameter1: value1, Parameter2: value2, …}. All binds will be executed across all experiments; e.g., if parameter\_binds is a length-n list, and there are m experiments, a total of m x n experiments will be run (one for each experiment/bind pair). + +* **use\_measure\_esp** (`Optional`\[`bool`]) – Whether to use excited state promoted (ESP) readout for measurements which are the terminal instruction to a qubit. ESP readout can offer higher fidelity than standard measurement sequences. See [here](https://arxiv.org/pdf/2008.08571.pdf). Default: `True` if backend supports ESP readout, else `False`. Backend support for ESP readout is determined by the flag `measure_esp_enabled` in `backend.configuration()`. + +* **\*\*run\_config** – Extra arguments used to configure the run. + +**Return type** + +`IBMQJob` + +**Returns** + +The job to be executed. + +**Raises** + +* [**IBMQBackendApiError**](qiskit.providers.ibmq.IBMQBackendApiError "qiskit.providers.ibmq.IBMQBackendApiError") – If an unexpected error occurred while submitting the job. + +* [**IBMQBackendApiProtocolError**](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError") – If an unexpected value received from the server. + +* [**IBMQBackendValueError**](qiskit.providers.ibmq.IBMQBackendValueError "qiskit.providers.ibmq.IBMQBackendValueError") – + + * If an input parameter value is not valid. - If ESP readout is used and the backend does not support this. + +### set\_options + + + +`IBMQBackend.set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + +### status + + + +`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. + + + If the returned [`BackendStatus`](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") instance has `operational=True` but `status_msg="internal"`, then the backend is accepting jobs but not processing them. + + +**Return type** + +`BackendStatus` + +**Returns** + +The status of the backend. + +**Raises** + +[**IBMQBackendApiProtocolError**](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError") – If the status for the backend cannot be formatted properly. + +## Attributes + + ### id\_warning\_issued `= False` - + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.ibmq.IBMQBackend.run#qiskit.providers.ibmq.IBMQBackend.run "qiskit.providers.ibmq.IBMQBackend.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.ibmq.IBMQBackend#run "qiskit.providers.ibmq.IBMQBackend.run") method. + ### qobj\_warning\_issued `= False` - + ### version `= 1` + 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 05f402a3d0d..4bdd0f2a060 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiError.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQBackendApiError +--- +title: IBMQBackendApiError +description: API reference for qiskit.providers.ibmq.IBMQBackendApiError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQBackendApiError +--- +# qiskit.providers.ibmq.IBMQBackendApiError + -`IBMQBackendApiError(*message)` +`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. Set the error message. + 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 cb1bf9ff973..c041bbf3bf6 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendApiProtocolError.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQBackendApiProtocolError +--- +title: IBMQBackendApiProtocolError +description: API reference for qiskit.providers.ibmq.IBMQBackendApiProtocolError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQBackendApiProtocolError +--- +# qiskit.providers.ibmq.IBMQBackendApiProtocolError + -`IBMQBackendApiProtocolError(*message)` +`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. Set the error message. + 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 3fa84267309..6dc463b2421 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendError.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQBackendError +--- +title: IBMQBackendError +description: API reference for qiskit.providers.ibmq.IBMQBackendError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQBackendError +--- +# qiskit.providers.ibmq.IBMQBackendError + -`IBMQBackendError(*message)` +`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. Set the error message. + 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 3cafe72cb0f..eb24ee9f625 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendService.md @@ -1,14 +1,22 @@ -# IBMQBackendService +--- +title: IBMQBackendService +description: API reference for qiskit.providers.ibmq.IBMQBackendService +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.IBMQBackendService +--- +# IBMQBackendService + -`IBMQBackendService(provider)` +`IBMQBackendService(provider)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqbackendservice.py "view source code") Bases: `object` Backend namespace for an IBM Quantum Experience account provider. -Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider#qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: +Represent a namespace that provides backend related services for the IBM Quantum Experience backends available to this provider. An instance of this class is used as a callable attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all backends or to access a specific backend: ```python backends = provider.backends() # Invoke backends() to get the backends. @@ -35,9 +43,156 @@ IBMQBackendService constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| [`backends`](qiskit.providers.ibmq.IBMQBackendService.backends#qiskit.providers.ibmq.IBMQBackendService.backends "qiskit.providers.ibmq.IBMQBackendService.backends") | Return all backends accessible via this provider, subject to optional filtering. | -| [`jobs`](qiskit.providers.ibmq.IBMQBackendService.jobs#qiskit.providers.ibmq.IBMQBackendService.jobs "qiskit.providers.ibmq.IBMQBackendService.jobs") | Return a list of jobs, subject to optional filtering. | -| [`my_reservations`](qiskit.providers.ibmq.IBMQBackendService.my_reservations#qiskit.providers.ibmq.IBMQBackendService.my_reservations "qiskit.providers.ibmq.IBMQBackendService.my_reservations") | Return your upcoming reservations. | -| [`retrieve_job`](qiskit.providers.ibmq.IBMQBackendService.retrieve_job#qiskit.providers.ibmq.IBMQBackendService.retrieve_job "qiskit.providers.ibmq.IBMQBackendService.retrieve_job") | Return a single job. | +### backends + + + +`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. + +**Parameters** + +* **name** (`Optional`\[`str`]) – Backend name to filter by. + +* **filters** (`Optional`\[`Callable`\[\[`List`\[`IBMQBackend`]], `bool`]]) – + + More complex filters, such as lambda functions. For example: + + ```python + AccountProvider.backends( + filters=lambda b: b.configuration().quantum_volume > 16) + ``` + +* **timeout** (`Optional`\[`float`]) – Maximum number of seconds to wait for the discovery of remote backends. + +* **min\_num\_qubits** (`Optional`\[`int`]) – Minimum number of qubits the backend has to have. + +* **input\_allowed** (`Union`\[`str`, `List`\[`str`], `None`]) – Filter by the types of input the backend supports. Valid input types are `job` (circuit job) and `runtime` (Qiskit Runtime). For example, `inputs_allowed='runtime'` will return all backends that support Qiskit Runtime. If a list is given, the backend must support all types specified in the list. + +* **kwargs** (`Any`) – + + Simple filters that specify a `True`/`False` criteria in the backend configuration, backends status, or provider credentials. An example to get the operational backends with 5 qubits: + + ```python + AccountProvider.backends(n_qubits=5, operational=True) + ``` + +**Return type** + +`List`\[`IBMQBackend`] + +**Returns** + +The list of available backends that match the filter. + +### jobs + + + +`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. + +Retrieve jobs that match the given filters and paginate the results if desired. Note that the server has a limit for the number of jobs returned in a single call. As a result, this function might involve making several calls to the server. + +**Parameters** + +* **limit** (`int`) – Number of jobs to retrieve. + +* **skip** (`int`) – Starting index for the job retrieval. + +* **backend\_name** (`Optional`\[`str`]) – Name of the backend to retrieve jobs from. + +* **status** (`Union`\[`JobStatus`, `str`, `List`\[`Union`\[`JobStatus`, `str`]], `None`]) – Only get jobs with this status or one of the statuses. For example, you can specify status=JobStatus.RUNNING or status=”RUNNING” or status=\[“RUNNING”, “ERROR”] + +* **job\_name** (`Optional`\[`str`]) – Filter by job name. The job\_name is matched partially and [regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) can be used. + +* **start\_datetime** (`Optional`\[`datetime`]) – Filter by the given start date, in local time. This is used to find jobs whose creation dates are after (greater than or equal to) this local date/time. + +* **end\_datetime** (`Optional`\[`datetime`]) – Filter by the given end date, in local time. This is used to find jobs whose creation dates are before (less than or equal to) this local date/time. + +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to jobs. + +* **job\_tags\_operator** (`Optional`\[`str`]) – + + Logical operator to use when filtering by job tags. Valid values are “AND” and “OR”: + + > * If “AND” is specified, then a job must have all of the tags specified in `job_tags` to be included. + > * If “OR” is specified, then a job only needs to have any of the tags specified in `job_tags` to be included. + +* **experiment\_id** (`Optional`\[`str`]) – Filter by job experiment ID. + +* **descending** (`bool`) – If `True`, return the jobs in descending order of the job creation date (i.e. newest first) until the limit is reached. + +* **db\_filter** (`Optional`\[`Dict`\[`str`, `Any`]]) – + + A [loopback-based filter](https://loopback.io/doc/en/lb2/Querying-data.html). This is an interface to a database `where` filter. Some examples of its usage are: + + Filter last five jobs with errors: + + ```python + job_list = backend.jobs(limit=5, status=JobStatus.ERROR) + ``` + + Filter last five jobs with hub name `ibm-q`: + + ```python + filter = {'hubInfo.hub.name': 'ibm-q'} + job_list = backend.jobs(limit=5, db_filter=filter) + ``` + +**Return type** + +`List`\[`IBMQJob`] + +**Returns** + +A list of `IBMQJob` instances. + +**Raises** + +* [**IBMQBackendValueError**](qiskit.providers.ibmq.IBMQBackendValueError "qiskit.providers.ibmq.IBMQBackendValueError") – If a keyword value is not recognized. +* **TypeError** – If the input start\_datetime or end\_datetime parameter value is not valid. + +### my\_reservations + + + +`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. + +**Return type** + +`List`\[`BackendReservation`] + +**Returns** + +A list of your upcoming reservations. + +### retrieve\_job + + + +`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. + +**Parameters** + +**job\_id** (`str`) – The ID of the job to retrieve. + +**Return type** + +`IBMQJob` + +**Returns** + +The job with the given id. + +**Raises** + +* [**IBMQBackendApiError**](qiskit.providers.ibmq.IBMQBackendApiError "qiskit.providers.ibmq.IBMQBackendApiError") – If an unexpected error occurred when retrieving the job. +* [**IBMQBackendApiProtocolError**](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError") – If unexpected return value received from the server. + 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 2c26db92247..86f9c45a3d5 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQBackendValueError.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQBackendValueError +--- +title: IBMQBackendValueError +description: API reference for qiskit.providers.ibmq.IBMQBackendValueError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQBackendValueError +--- +# qiskit.providers.ibmq.IBMQBackendValueError + -`IBMQBackendValueError(*message)` +`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. Set the error message. + 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 4fe8f3ae10f..41652141dc8 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQError.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQError +--- +title: IBMQError +description: API reference for qiskit.providers.ibmq.IBMQError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQError +--- +# qiskit.providers.ibmq.IBMQError + -`IBMQError(*message)` +`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. Set the error message. + 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 aaa67083cfc..6e647420f52 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQFactory.md @@ -1,8 +1,16 @@ -# IBMQFactory +--- +title: IBMQFactory +description: API reference for qiskit.providers.ibmq.IBMQFactory +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.IBMQFactory +--- +# IBMQFactory + -`IBMQFactory` +`IBMQFactory`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/ibmqfactory.py "view source code") Bases: `object` @@ -12,15 +20,252 @@ IBMQFactory constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| [`active_account`](qiskit.providers.ibmq.IBMQFactory.active_account#qiskit.providers.ibmq.IBMQFactory.active_account "qiskit.providers.ibmq.IBMQFactory.active_account") | Return the IBM Quantum Experience account currently in use for the session. | -| [`delete_account`](qiskit.providers.ibmq.IBMQFactory.delete_account#qiskit.providers.ibmq.IBMQFactory.delete_account "qiskit.providers.ibmq.IBMQFactory.delete_account") | Delete the saved account from disk. | -| [`disable_account`](qiskit.providers.ibmq.IBMQFactory.disable_account#qiskit.providers.ibmq.IBMQFactory.disable_account "qiskit.providers.ibmq.IBMQFactory.disable_account") | Disable the account currently in use for the session. | -| [`enable_account`](qiskit.providers.ibmq.IBMQFactory.enable_account#qiskit.providers.ibmq.IBMQFactory.enable_account "qiskit.providers.ibmq.IBMQFactory.enable_account") | Authenticate against IBM Quantum Experience for use during the session. | -| [`get_provider`](qiskit.providers.ibmq.IBMQFactory.get_provider#qiskit.providers.ibmq.IBMQFactory.get_provider "qiskit.providers.ibmq.IBMQFactory.get_provider") | Return a provider for a single hub/group/project combination. | -| [`load_account`](qiskit.providers.ibmq.IBMQFactory.load_account#qiskit.providers.ibmq.IBMQFactory.load_account "qiskit.providers.ibmq.IBMQFactory.load_account") | Authenticate against IBM Quantum Experience from stored credentials. | -| [`providers`](qiskit.providers.ibmq.IBMQFactory.providers#qiskit.providers.ibmq.IBMQFactory.providers "qiskit.providers.ibmq.IBMQFactory.providers") | Return a list of providers, subject to optional filtering. | -| [`save_account`](qiskit.providers.ibmq.IBMQFactory.save_account#qiskit.providers.ibmq.IBMQFactory.save_account "qiskit.providers.ibmq.IBMQFactory.save_account") | Save the account to disk for future use. | -| [`stored_account`](qiskit.providers.ibmq.IBMQFactory.stored_account#qiskit.providers.ibmq.IBMQFactory.stored_account "qiskit.providers.ibmq.IBMQFactory.stored_account") | List the account stored on disk. | -| [`update_account`](qiskit.providers.ibmq.IBMQFactory.update_account#qiskit.providers.ibmq.IBMQFactory.update_account "qiskit.providers.ibmq.IBMQFactory.update_account") | Interactive helper for migrating stored credentials to IBM Quantum Experience v2. | +### active\_account + + + +`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. + +**Return type** + +`Optional`\[`Dict`\[`str`, `str`]] + +**Returns** + +Information about the account currently in the session. + +### delete\_account + + + +`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. + +**Raises** + +* [**IBMQAccountCredentialsNotFound**](qiskit.providers.ibmq.IBMQAccountCredentialsNotFound "qiskit.providers.ibmq.IBMQAccountCredentialsNotFound") – If no valid IBM Quantum Experience credentials can be found on disk. +* [**IBMQAccountMultipleCredentialsFound**](qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound "qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound") – If multiple IBM Quantum Experience credentials are found on disk. +* [**IBMQAccountCredentialsInvalidUrl**](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl") – If invalid IBM Quantum Experience credentials are found on disk. + +**Return type** + +`None` + +### disable\_account + + + +`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. + +**Raises** + +[**IBMQAccountCredentialsNotFound**](qiskit.providers.ibmq.IBMQAccountCredentialsNotFound "qiskit.providers.ibmq.IBMQAccountCredentialsNotFound") – If no account is in use for the session. + +**Return type** + +`None` + +### enable\_account + + + +`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. + + + With version 0.4 of this `qiskit-ibmq-provider` package, use of the legacy Quantum Experience and Qconsole (also known as the IBM Quantum Experience v1) credentials is no longer supported. + + +**Parameters** + +* **token** (`str`) – IBM Quantum Experience token. + +* **url** (`str`) – URL for the IBM Quantum Experience authentication server. + +* **hub** (`Optional`\[`str`]) – Name of the hub to use. + +* **group** (`Optional`\[`str`]) – Name of the group to use. + +* **project** (`Optional`\[`str`]) – Name of the project to use. + +* **\*\*kwargs** – + + Additional settings for the connection: + + * proxies (dict): proxy configuration. + * verify (bool): verify the server’s TLS certificate. + +**Return type** + +`Optional`\[`AccountProvider`] + +**Returns** + +If hub, group, and project are specified, the corresponding provider is returned. Otherwise the provider for the open access project is returned. + +**Raises** + +* [**IBMQAccountError**](qiskit.providers.ibmq.IBMQAccountError "qiskit.providers.ibmq.IBMQAccountError") – If an IBM Quantum Experience account is already in use for the session. +* [**IBMQAccountCredentialsInvalidUrl**](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl") – If the URL specified is not a valid IBM Quantum Experience authentication URL. +* [**IBMQProviderError**](qiskit.providers.ibmq.IBMQProviderError "qiskit.providers.ibmq.IBMQProviderError") – If no provider matches the specified criteria, or more than one provider matches the specified criteria. + +### get\_provider + + + +`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. + +**Parameters** + +* **hub** (`Optional`\[`str`]) – Name of the hub. +* **group** (`Optional`\[`str`]) – Name of the group. +* **project** (`Optional`\[`str`]) – Name of the project. + +**Return type** + +`AccountProvider` + +**Returns** + +A provider that matches the specified criteria. + +**Raises** + +[**IBMQProviderError**](qiskit.providers.ibmq.IBMQProviderError "qiskit.providers.ibmq.IBMQProviderError") – If no provider matches the specified criteria, or more than one provider matches the specified criteria. + +### load\_account + + + +`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. + +**Return type** + +`Optional`\[`AccountProvider`] + +**Returns** + +If the configuration file specifies a default provider, it is returned. Otherwise the provider for the open access project is returned. + +**Raises** + +* [**IBMQAccountCredentialsInvalidFormat**](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidFormat") – If the default provider stored on disk could not be parsed. +* [**IBMQAccountCredentialsNotFound**](qiskit.providers.ibmq.IBMQAccountCredentialsNotFound "qiskit.providers.ibmq.IBMQAccountCredentialsNotFound") – If no IBM Quantum Experience credentials can be found. +* [**IBMQAccountMultipleCredentialsFound**](qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound "qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound") – If multiple IBM Quantum Experience credentials are found. +* [**IBMQAccountCredentialsInvalidUrl**](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl") – If invalid IBM Quantum Experience credentials are found. +* [**IBMQProviderError**](qiskit.providers.ibmq.IBMQProviderError "qiskit.providers.ibmq.IBMQProviderError") – If the default provider stored on disk could not be found. + +### providers + + + +`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. + +**Parameters** + +* **hub** (`Optional`\[`str`]) – Name of the hub. +* **group** (`Optional`\[`str`]) – Name of the group. +* **project** (`Optional`\[`str`]) – Name of the project. + +**Return type** + +`List`\[`AccountProvider`] + +**Returns** + +A list of providers that match the specified criteria. + +### save\_account + + + +`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. + + + If storing a default provider to disk, all three parameters hub, group, project must be specified. + + +**Parameters** + +* **token** (`str`) – IBM Quantum Experience token. + +* **url** (`str`) – URL for the IBM Quantum Experience authentication server. + +* **hub** (`Optional`\[`str`]) – Name of the hub for the default provider to store on disk. + +* **group** (`Optional`\[`str`]) – Name of the group for the default provider to store on disk. + +* **project** (`Optional`\[`str`]) – Name of the project for the default provider to store on disk. + +* **overwrite** (`bool`) – Overwrite existing credentials. + +* **\*\*kwargs** – + + * proxies (dict): Proxy configuration for the server. + * verify (bool): If False, ignores SSL certificates errors + +**Raises** + +* [**IBMQAccountCredentialsInvalidUrl**](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl") – If the url is not a valid IBM Quantum Experience authentication URL. +* [**IBMQAccountCredentialsInvalidToken**](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidToken") – If the token is not a valid IBM Quantum Experience token. +* **IBMQAccountValueError** – If only one or two parameters from hub, group, project are specified. + +**Return type** + +`None` + +### stored\_account + + + +`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. + +**Return type** + +`Dict`\[`str`, `str`] + +**Returns** + +A dictionary with information about the account stored on disk. + +**Raises** + +* [**IBMQAccountMultipleCredentialsFound**](qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound "qiskit.providers.ibmq.IBMQAccountMultipleCredentialsFound") – If multiple IBM Quantum Experience credentials are found on disk. +* [**IBMQAccountCredentialsInvalidUrl**](qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl "qiskit.providers.ibmq.IBMQAccountCredentialsInvalidUrl") – If invalid IBM Quantum Experience credentials are found on disk. + +### update\_account + + + +`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. + +**Parameters** + +**force** (`bool`) – If `True`, disable interactive prompts and perform the changes. + +**Return type** + +`Optional`\[`Credentials`] + +**Returns** + +The credentials for IBM Quantum Experience v2 if updating is successful or `None` otherwise. + 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 d560e7705fd..eb4cebba7e4 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.IBMQProviderError.md @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.IBMQProviderError +--- +title: IBMQProviderError +description: API reference for qiskit.providers.ibmq.IBMQProviderError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.IBMQProviderError +--- +# qiskit.providers.ibmq.IBMQProviderError + -`IBMQProviderError(*message)` +`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. Set the error message. + 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 5b175e749ec..71d9c42f83f 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.md +++ b/docs/api/qiskit/0.32/qiskit.providers.ibmq.RunnerResult.md @@ -1,8 +1,16 @@ -# RunnerResult +--- +title: RunnerResult +description: API reference for qiskit.providers.ibmq.RunnerResult +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.RunnerResult +--- +# RunnerResult + -`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` +`RunnerResult(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runner_result.py "view source code") Bases: `qiskit.result.result.Result`, `qiskit.providers.ibmq.runtime.program.result_decoder.ResultDecoder` @@ -10,14 +18,217 @@ Result class for Qiskit Runtime program circuit-runner. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`data`](qiskit.providers.ibmq.RunnerResult.data#qiskit.providers.ibmq.RunnerResult.data "qiskit.providers.ibmq.RunnerResult.data") | Get the raw data for an experiment. | -| [`decode`](qiskit.providers.ibmq.RunnerResult.decode#qiskit.providers.ibmq.RunnerResult.decode "qiskit.providers.ibmq.RunnerResult.decode") | Decoding for results from Qiskit runtime jobs. | -| [`from_dict`](qiskit.providers.ibmq.RunnerResult.from_dict#qiskit.providers.ibmq.RunnerResult.from_dict "qiskit.providers.ibmq.RunnerResult.from_dict") | Create a new ExperimentResultData object from a dictionary. | -| [`get_counts`](qiskit.providers.ibmq.RunnerResult.get_counts#qiskit.providers.ibmq.RunnerResult.get_counts "qiskit.providers.ibmq.RunnerResult.get_counts") | Get the histogram data of an experiment. | -| [`get_memory`](qiskit.providers.ibmq.RunnerResult.get_memory#qiskit.providers.ibmq.RunnerResult.get_memory "qiskit.providers.ibmq.RunnerResult.get_memory") | 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’] | -| [`get_quasiprobabilities`](qiskit.providers.ibmq.RunnerResult.get_quasiprobabilities#qiskit.providers.ibmq.RunnerResult.get_quasiprobabilities "qiskit.providers.ibmq.RunnerResult.get_quasiprobabilities") | Get quasiprobabilites associated with one or more experiments. | -| [`get_statevector`](qiskit.providers.ibmq.RunnerResult.get_statevector#qiskit.providers.ibmq.RunnerResult.get_statevector "qiskit.providers.ibmq.RunnerResult.get_statevector") | Get the final statevector of an experiment. | -| [`get_unitary`](qiskit.providers.ibmq.RunnerResult.get_unitary#qiskit.providers.ibmq.RunnerResult.get_unitary "qiskit.providers.ibmq.RunnerResult.get_unitary") | Get the final unitary of an experiment. | -| [`to_dict`](qiskit.providers.ibmq.RunnerResult.to_dict#qiskit.providers.ibmq.RunnerResult.to_dict "qiskit.providers.ibmq.RunnerResult.to_dict") | Return a dictionary format representation of the Result | +### data + + + +`RunnerResult.data(experiment=None)` + +Get the raw data for an experiment. + +Note this data will be a single classical and quantum register and in a format required by the results schema. We recommend that most users use the get\_xxx method, and the data will be post-processed for the data type. + +**Parameters** + +**experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment. Several types are accepted for convenience:: \* str: the name of the experiment. \* QuantumCircuit: the name of the circuit instance will be used. \* Schedule: the name of the schedule instance will be used. \* int: the position of the experiment. \* None: if there is only one experiment, returns it. + +**Returns** + +A dictionary of results data for an experiment. The data depends on the backend it ran on and the settings of meas\_level, meas\_return and memory. + +QASM backends return a dictionary of dictionary with the key ‘counts’ and with the counts, with the second dictionary keys containing a string in hex format (`0x123`) and values equal to the number of times this outcome was measured. + +Statevector backends return a dictionary with key ‘statevector’ and values being a list\[list\[complex components]] list of 2^num\_qubits complex amplitudes. Where each complex number is represented as a 2 entry list for each component. For example, a list of \[0.5+1j, 0-1j] would be represented as \[\[0.5, 1], \[0, -1]]. + +Unitary backends return a dictionary with key ‘unitary’ and values being a list\[list\[list\[complex components]]] list of 2^num\_qubits x 2^num\_qubits complex amplitudes in a two entry list for each component. For example if the amplitude is \[\[0.5+0j, 0-1j], …] the value returned will be \[\[\[0.5, 0], \[0, -1]], …]. + +The simulator backends also have an optional key ‘snapshots’ which returns a dict of snapshots specified by the simulator backend. The value is of the form dict\[slot: dict\[str: array]] where the keys are the requested snapshot slots, and the values are a dictionary of the snapshots. + +**Return type** + +dict + +**Raises** + +**QiskitError** – if data for the experiment could not be retrieved. + +### decode + + + +`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. + +**Return type** + +`RunnerResult` + +### from\_dict + + + +`classmethod RunnerResult.from_dict(data)` + +Create a new ExperimentResultData object from a dictionary. + +**Parameters** + +**data** (*dict*) – A dictionary representing the Result to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.ibmq.RunnerResult#to_dict "qiskit.providers.ibmq.RunnerResult.to_dict"). + +**Returns** + +The `Result` object from the input dictionary. + +**Return type** + +[Result](qiskit.result.Result "qiskit.result.Result") + +### get\_counts + + + +`RunnerResult.get_counts(experiment=None)` + +Get the histogram data of an experiment. + +**Parameters** + +**experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data([experiment])`. + +**Returns** + +a dictionary or a list of dictionaries. A dictionary has the counts for each qubit with the keys containing a string in binary format and separated according to the registers in circuit (e.g. `0100 1110`). The string is little-endian (cr\[0] on the right hand side). + +**Return type** + +dict\[str, int] or list\[dict\[str, int]] + +**Raises** + +**QiskitError** – if there are no counts for the experiment. + +### get\_memory + + + +`RunnerResult.get_memory(experiment=None)` + +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’] + +**Parameters** + +**experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data()`. + +**Returns** + +Either the list of each outcome, formatted according to registers in circuit or a complex numpy np.ndarray with shape: + +> | meas\_level | meas\_return | shape | +> | ----------- | ------------ | ----------------------------------------------------- | +> | 0 | single | np.ndarray\[shots, memory\_slots, memory\_slot\_size] | +> | 0 | avg | np.ndarray\[memory\_slots, memory\_slot\_size] | +> | 1 | single | np.ndarray\[shots, memory\_slots] | +> | 1 | avg | np.ndarray\[memory\_slots] | +> | 2 | memory=True | list | + +**Return type** + +List\[str] or np.ndarray + +**Raises** + +**QiskitError** – if there is no memory data for the circuit. + +### get\_quasiprobabilities + + + +`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. + +**Parameters** + +**experiment** (`Union`\[`int`, `List`, `None`]) – Indices of experiments to grab quasiprobabilities from. + +**Return type** + +`Union`\[`QuasiDistribution`, `List`\[`QuasiDistribution`]] + +**Returns** + +A single distribution or a list of distributions. + +**Raises** + +**QiskitError** – If experiment result doesn’t contain quasiprobabilities. + +### get\_statevector + + + +`RunnerResult.get_statevector(experiment=None, decimals=None)` + +Get the final statevector of an experiment. + +**Parameters** + +* **experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data()`. +* **decimals** (*int*) – the number of decimals in the statevector. If None, does not round. + +**Returns** + +list of 2^num\_qubits complex amplitudes. + +**Return type** + +list\[complex] + +**Raises** + +**QiskitError** – if there is no statevector for the experiment. + +### get\_unitary + + + +`RunnerResult.get_unitary(experiment=None, decimals=None)` + +Get the final unitary of an experiment. + +**Parameters** + +* **experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data()`. +* **decimals** (*int*) – the number of decimals in the unitary. If None, does not round. + +**Returns** + +**list of 2^num\_qubits x 2^num\_qubits complex** + +amplitudes. + +**Return type** + +list\[list\[complex]] + +**Raises** + +**QiskitError** – if there is no unitary for the experiment. + +### to\_dict + + + +`RunnerResult.to_dict()` + +Return a dictionary format representation of the Result + +**Returns** + +The dictionary form of the Result + +**Return type** + +dict + 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 124b7e5cfd7..78ec3d1dfb1 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 @@ -1,8 +1,16 @@ -# Credentials +--- +title: Credentials +description: API reference for qiskit.providers.ibmq.credentials.Credentials +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.credentials.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)` +`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` @@ -31,8 +39,49 @@ Credentials constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -| [`connection_parameters`](qiskit.providers.ibmq.credentials.Credentials.connection_parameters#qiskit.providers.ibmq.credentials.Credentials.connection_parameters "qiskit.providers.ibmq.credentials.Credentials.connection_parameters") | Construct connection related parameters. | -| [`is_ibmq`](qiskit.providers.ibmq.credentials.Credentials.is_ibmq#qiskit.providers.ibmq.credentials.Credentials.is_ibmq "qiskit.providers.ibmq.credentials.Credentials.is_ibmq") | Return whether the credentials represent an IBM Quantum Experience account. | -| [`unique_id`](qiskit.providers.ibmq.credentials.Credentials.unique_id#qiskit.providers.ibmq.credentials.Credentials.unique_id "qiskit.providers.ibmq.credentials.Credentials.unique_id") | Return a value that uniquely identifies these credentials. | +### connection\_parameters + + + +`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. + +**Return type** + +`Dict`\[`str`, `Any`] + +**Returns** + +A dictionary with connection-related parameters in the format expected by `requests`. The following keys can be present: `proxies`, `verify`, and `auth`. + +### is\_ibmq + + + +`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. + +**Return type** + +`bool` + +### unique\_id + + + +`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. + +By convention, two credentials that have the same hub, group, and project are considered equivalent. + +**Return type** + +`HubGroupProject` + +**Returns** + +A `HubGroupProject` instance. + 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 ed3009c8cab..04f279e0cd1 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.credentials.CredentialsError +--- +title: CredentialsError +description: API reference for qiskit.providers.ibmq.credentials.CredentialsError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.credentials.CredentialsError +--- +# qiskit.providers.ibmq.credentials.CredentialsError + -`CredentialsError(*message)` +`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. Set the error message. + 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 9a5b3205d6b..4f851752dc3 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.credentials.CredentialsNotFoundError +--- +title: CredentialsNotFoundError +description: API reference for qiskit.providers.ibmq.credentials.CredentialsNotFoundError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.credentials.CredentialsNotFoundError +--- +# qiskit.providers.ibmq.credentials.CredentialsNotFoundError + -`CredentialsNotFoundError(*message)` +`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. Set the error message. + 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 67dd5ead0d1..08f3dd7e2c4 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError +--- +title: InvalidCredentialsFormatError +description: API reference for qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError +--- +# qiskit.providers.ibmq.credentials.InvalidCredentialsFormatError + -`InvalidCredentialsFormatError(*message)` +`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. Set the error message. + 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 fedf8daeb9f..f954c886cda 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 @@ -1,9 +1,18 @@ -# DeviceComponent +--- +title: DeviceComponent +description: API reference for qiskit.providers.ibmq.experiment.DeviceComponent +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.experiment.DeviceComponent +--- +# DeviceComponent + -`DeviceComponent` +`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` Class representing a device component. + 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 73d74801214..53f323ab1ab 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.experiment.IBMExperimentEntryExists +--- +title: IBMExperimentEntryExists +description: API reference for qiskit.providers.ibmq.experiment.IBMExperimentEntryExists +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryExists +--- +# qiskit.providers.ibmq.experiment.IBMExperimentEntryExists + -`IBMExperimentEntryExists(*message)` +`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. Set the error message. + 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 0276cd14f7f..c2b7202cfc0 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound +--- +title: IBMExperimentEntryNotFound +description: API reference for qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound +--- +# qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound + -`IBMExperimentEntryNotFound(*message)` +`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. Set the error message. + 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 714d4618140..b160d6165e9 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.experiment.IBMExperimentError +--- +title: IBMExperimentError +description: API reference for qiskit.providers.ibmq.experiment.IBMExperimentError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentError +--- +# qiskit.providers.ibmq.experiment.IBMExperimentError + -`IBMExperimentError(*message)` +`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. Set the error message. + 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 492097ace41..1dc23cd056c 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 @@ -1,8 +1,16 @@ -# IBMExperimentService +--- +title: IBMExperimentService +description: API reference for qiskit.providers.ibmq.experiment.IBMExperimentService +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.experiment.IBMExperimentService +--- +# IBMExperimentService + -`IBMExperimentService(provider)` +`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` @@ -50,29 +58,594 @@ IBMExperimentService constructor. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`analysis_result`](qiskit.providers.ibmq.experiment.IBMExperimentService.analysis_result#qiskit.providers.ibmq.experiment.IBMExperimentService.analysis_result "qiskit.providers.ibmq.experiment.IBMExperimentService.analysis_result") | Retrieve a previously stored experiment. | -| [`analysis_results`](qiskit.providers.ibmq.experiment.IBMExperimentService.analysis_results#qiskit.providers.ibmq.experiment.IBMExperimentService.analysis_results "qiskit.providers.ibmq.experiment.IBMExperimentService.analysis_results") | Retrieve all analysis results, with optional filtering. | -| [`backends`](qiskit.providers.ibmq.experiment.IBMExperimentService.backends#qiskit.providers.ibmq.experiment.IBMExperimentService.backends "qiskit.providers.ibmq.experiment.IBMExperimentService.backends") | Return a list of backends that can be used for experiments. | -| [`create_analysis_result`](qiskit.providers.ibmq.experiment.IBMExperimentService.create_analysis_result#qiskit.providers.ibmq.experiment.IBMExperimentService.create_analysis_result "qiskit.providers.ibmq.experiment.IBMExperimentService.create_analysis_result") | Create a new analysis result in the database. | -| [`create_experiment`](qiskit.providers.ibmq.experiment.IBMExperimentService.create_experiment#qiskit.providers.ibmq.experiment.IBMExperimentService.create_experiment "qiskit.providers.ibmq.experiment.IBMExperimentService.create_experiment") | Create a new experiment in the database. | -| [`create_figure`](qiskit.providers.ibmq.experiment.IBMExperimentService.create_figure#qiskit.providers.ibmq.experiment.IBMExperimentService.create_figure "qiskit.providers.ibmq.experiment.IBMExperimentService.create_figure") | Store a new figure in the database. | -| [`delete_analysis_result`](qiskit.providers.ibmq.experiment.IBMExperimentService.delete_analysis_result#qiskit.providers.ibmq.experiment.IBMExperimentService.delete_analysis_result "qiskit.providers.ibmq.experiment.IBMExperimentService.delete_analysis_result") | Delete an analysis result. | -| [`delete_experiment`](qiskit.providers.ibmq.experiment.IBMExperimentService.delete_experiment#qiskit.providers.ibmq.experiment.IBMExperimentService.delete_experiment "qiskit.providers.ibmq.experiment.IBMExperimentService.delete_experiment") | Delete an experiment. | -| [`delete_figure`](qiskit.providers.ibmq.experiment.IBMExperimentService.delete_figure#qiskit.providers.ibmq.experiment.IBMExperimentService.delete_figure "qiskit.providers.ibmq.experiment.IBMExperimentService.delete_figure") | Delete an experiment plot. | -| [`device_components`](qiskit.providers.ibmq.experiment.IBMExperimentService.device_components#qiskit.providers.ibmq.experiment.IBMExperimentService.device_components "qiskit.providers.ibmq.experiment.IBMExperimentService.device_components") | Return the device components. | -| [`experiment`](qiskit.providers.ibmq.experiment.IBMExperimentService.experiment#qiskit.providers.ibmq.experiment.IBMExperimentService.experiment "qiskit.providers.ibmq.experiment.IBMExperimentService.experiment") | Retrieve a previously stored experiment. | -| [`experiments`](qiskit.providers.ibmq.experiment.IBMExperimentService.experiments#qiskit.providers.ibmq.experiment.IBMExperimentService.experiments "qiskit.providers.ibmq.experiment.IBMExperimentService.experiments") | Retrieve all experiments, with optional filtering. | -| [`figure`](qiskit.providers.ibmq.experiment.IBMExperimentService.figure#qiskit.providers.ibmq.experiment.IBMExperimentService.figure "qiskit.providers.ibmq.experiment.IBMExperimentService.figure") | Retrieve an existing figure. | -| [`save_preferences`](qiskit.providers.ibmq.experiment.IBMExperimentService.save_preferences#qiskit.providers.ibmq.experiment.IBMExperimentService.save_preferences "qiskit.providers.ibmq.experiment.IBMExperimentService.save_preferences") | Stores experiment preferences on disk. | -| [`update_analysis_result`](qiskit.providers.ibmq.experiment.IBMExperimentService.update_analysis_result#qiskit.providers.ibmq.experiment.IBMExperimentService.update_analysis_result "qiskit.providers.ibmq.experiment.IBMExperimentService.update_analysis_result") | Update an existing analysis result. | -| [`update_experiment`](qiskit.providers.ibmq.experiment.IBMExperimentService.update_experiment#qiskit.providers.ibmq.experiment.IBMExperimentService.update_experiment "qiskit.providers.ibmq.experiment.IBMExperimentService.update_experiment") | Update an existing experiment. | -| [`update_figure`](qiskit.providers.ibmq.experiment.IBMExperimentService.update_figure#qiskit.providers.ibmq.experiment.IBMExperimentService.update_figure "qiskit.providers.ibmq.experiment.IBMExperimentService.update_figure") | Update an existing figure. | +### analysis\_result -## Attributes + + +`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. + +**Parameters** + +* **result\_id** (`str`) – Analysis result ID. +* **json\_decoder** (`Type`\[`JSONDecoder`]) – Custom JSON decoder to use to decode the retrieved analysis result. + +**Return type** + +`Dict` + +**Returns** + +Retrieved analysis result. + +**Raises** + +* [**IBMExperimentEntryNotFound**](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound") – If the analysis result does not exist. +* **IBMQApiError** – If the request to the server failed. + +### analysis\_results + + + +`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. + +**Parameters** + +* **limit** (`Optional`\[`int`]) – Number of analysis results to retrieve. + +* **json\_decoder** (`Type`\[`JSONDecoder`]) – Custom JSON decoder to use to decode the retrieved analysis results. + +* **device\_components** (`Optional`\[`List`\[`Union`\[`str`, `DeviceComponent`]]]) – Filter by device components. + +* **device\_components\_operator** (`Optional`\[`str`]) – + + Operator used when filtering by device components. Valid values are `None` and “contains”: + + > * If `None`, an analysis result’s device components must match exactly for it to be included. + > * If “contains” is specified, an analysis result’s device components must contain at least the values specified by the device\_components filter. + +* **experiment\_id** (`Optional`\[`str`]) – Experiment ID used for filtering. + +* **result\_type** (`Optional`\[`str`]) – Analysis result type used for filtering. + +* **result\_type\_operator** (`Optional`\[`str`]) – + + Operator used when filtering by result type. Valid values are `None` and “like”: + + * If `None` is specified, an analysis result’s type value must match exactly for it to be included. + * If “like” is specified, an analysis result’s type value must contain the value specified by result\_type. For example, `result_type="foo", result_type_operator="like"` will match both `foo1` and `1foo`. + +* **backend\_name** (`Optional`\[`str`]) – Backend name used for filtering. + +* **quality** (`Union`\[`List`\[`Union`\[`ResultQuality`, `str`]], `ResultQuality`, `str`, `None`]) – Quality value used for filtering. If a list is given, analysis results whose quality value is in the list will be included. + +* **verified** (`Optional`\[`bool`]) – Indicates whether this result has been verified.. + +* **tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to analysis results. This can be used with tags\_operator for granular filtering. + +* **tags\_operator** (`Optional`\[`str`]) – + + Logical operator to use when filtering by tags. Valid values are “AND” and “OR”: + + > * If “AND” is specified, then an analysis result must have all of the tags specified in tags to be included. + > * If “OR” is specified, then an analysis result only needs to have any of the tags specified in tags to be included. + +* **sort\_by** (`Union`\[`str`, `List`\[`str`], `None`]) – Specifies how the output should be sorted. This can be a single sorting option or a list of options. Each option should contain a sort key and a direction. Valid sort keys are “creation\_datetime”, “device\_components”, and “result\_type”. Valid directions are “asc” for ascending or “desc” for descending. For example, `sort_by=["result_type: asc", "creation_datetime:desc"]` will return an output list that is first sorted by result type in ascending order, then by creation datetime by descending order. By default, analysis results are sorted by `creation_datetime` descending and `result_id` ascending. + +* **\*\*filters** – Additional filtering keywords that are not supported and will be ignored. + +**Return type** + +`List`\[`Dict`] + +**Returns** + +A list of analysis results. Each analysis result is a dictionary containing the retrieved analysis result. + +**Raises** + +* **ValueError** – If an invalid parameter value is specified. +* **IBMQApiError** – If the request to the server failed. + +### backends + + + +`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. + +**Return type** + +`List`\[`Dict`] + +**Returns** + +A list of backends. + +### create\_analysis\_result + + + +`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. + +**Parameters** + +* **experiment\_id** (`str`) – ID of the experiment this result is for. +* **result\_data** (`Dict`) – Result data to be stored. +* **result\_type** (`str`) – Analysis result type. +* **device\_components** (`Union`\[`List`\[`Union`\[`str`, `DeviceComponent`]], `str`, `DeviceComponent`, `None`]) – Target device components, such as qubits. +* **tags** (`Optional`\[`List`\[`str`]]) – Tags to be associated with the analysis result. +* **quality** (`Union`\[`ResultQuality`, `str`]) – Quality of this analysis. +* **verified** (`bool`) – Whether the result quality has been verified. +* **result\_id** (`Optional`\[`str`]) – Analysis result ID. It must be in the `uuid4` format. One will be generated if not supplied. +* **chisq** (`Optional`\[`float`]) – chi^2 decimal value of the fit. +* **json\_encoder** (`Type`\[`JSONEncoder`]) – Custom JSON encoder to use to encode the analysis result. +* **kwargs** (`Any`) – Additional analysis result attributes that are not supported and will be ignored. + +**Return type** + +`str` + +**Returns** + +Analysis result ID. + +**Raises** + +* [**IBMExperimentEntryExists**](qiskit.providers.ibmq.experiment.IBMExperimentEntryExists "qiskit.providers.ibmq.experiment.IBMExperimentEntryExists") – If the analysis result already exits. +* **IBMQApiError** – If the request to the server failed. + +### create\_experiment + + + +`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. + +**Parameters** + +* **experiment\_type** (`str`) – Experiment type. + +* **backend\_name** (`str`) – Name of the backend the experiment ran on. + +* **metadata** (`Optional`\[`Dict`]) – Experiment metadata. + +* **experiment\_id** (`Optional`\[`str`]) – Experiment ID. It must be in the `uuid4` format. One will be generated if not supplied. + +* **parent\_id** (`Optional`\[`str`]) – The experiment ID of the parent experiment. The parent experiment must exist, must be on the same backend as the child, and an experiment cannot be its own parent. + +* **job\_ids** (`Optional`\[`List`\[`str`]]) – IDs of experiment jobs. + +* **tags** (`Optional`\[`List`\[`str`]]) – Tags to be associated with the experiment. + +* **notes** (`Optional`\[`str`]) – Freeform notes about the experiment. + +* **share\_level** (`Union`\[`str`, `ExperimentShareLevel`, `None`]) – + + The level at which the experiment is shared. This determines who can view the experiment (but not update it). This defaults to “private” for new experiments. Possible values include: + + * private: The experiment is only visible to its owner (default) + * project: The experiment is shared within its project + * group: The experiment is shared within its group + * hub: The experiment is shared within its hub + * public: The experiment is shared publicly regardless of provider + +* **start\_datetime** (`Union`\[`str`, `datetime`, `None`]) – Timestamp when the experiment started, in local time zone. + +* **json\_encoder** (`Type`\[`JSONEncoder`]) – Custom JSON encoder to use to encode the experiment. + +* **kwargs** (`Any`) – Additional experiment attributes that are not supported and will be ignored. + +**Return type** + +`str` + +**Returns** + +Experiment ID. + +**Raises** + +* [**IBMExperimentEntryExists**](qiskit.providers.ibmq.experiment.IBMExperimentEntryExists "qiskit.providers.ibmq.experiment.IBMExperimentEntryExists") – If the experiment already exits. +* **IBMQApiError** – If the request to the server failed. + +### create\_figure + + + +`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. + + + Currently only SVG figures are supported. + + +**Parameters** + +* **experiment\_id** (`str`) – ID of the experiment this figure is for. +* **figure** (`Union`\[`str`, `bytes`]) – Name of the figure file or figure data to store. +* **figure\_name** (`Optional`\[`str`]) – Name of the figure. If `None`, the figure file name, if given, or a generated name is used. +* **sync\_upload** (`bool`) – If `True`, the plot will be uploaded synchronously. Otherwise the upload will be asynchronous. + +**Return type** + +`Tuple`\[`str`, `int`] + +**Returns** + +A tuple of the name and size of the saved figure. + +**Raises** + +* [**IBMExperimentEntryExists**](qiskit.providers.ibmq.experiment.IBMExperimentEntryExists "qiskit.providers.ibmq.experiment.IBMExperimentEntryExists") – If the figure already exits. +* **IBMQApiError** – If the request to the server failed. + +### delete\_analysis\_result + + + +`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. + +**Parameters** + +**result\_id** (`str`) – Analysis result ID. + + + This method prompts for confirmation and requires a response before proceeding. + + +**Raises** + +**IBMQApiError** – If the request to the server failed. + +**Return type** + +`None` + +### delete\_experiment + + + +`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. + +**Parameters** + +**experiment\_id** (`str`) – Experiment ID. + + + This method prompts for confirmation and requires a response before proceeding. + + +**Raises** + +**IBMQApiError** – If the request to the server failed. + +**Return type** + +`None` + +### delete\_figure + + + +`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. + + + This method prompts for confirmation and requires a response before proceeding. + + +**Parameters** + +* **experiment\_id** (`str`) – Experiment ID. +* **figure\_name** (`str`) – Name of the figure. + +**Raises** + +**IBMQApiError** – If the request to the server failed. + +**Return type** + +`None` + +### device\_components + + + +`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. + +**Parameters** + +**backend\_name** (`Optional`\[`str`]) – Name of the backend whose components are to be retrieved. + +**Return type** + +`Union`\[`Dict`\[`str`, `List`], `List`] + +**Returns** + +A list of device components if backend\_name is specified. Otherwise a dictionary whose keys are backend names the values are lists of device components for the backends. + +**Raises** + +**IBMQApiError** – If the request to the server failed. + +### experiment + + + +`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. + +**Parameters** + +* **experiment\_id** (`str`) – Experiment ID. +* **json\_decoder** (`Type`\[`JSONDecoder`]) – Custom JSON decoder to use to decode the retrieved experiment. + +**Return type** + +`Dict` + +**Returns** + +Retrieved experiment data. + +**Raises** + +* [**IBMExperimentEntryNotFound**](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound") – If the experiment does not exist. +* **IBMQApiError** – If the request to the server failed. + +### experiments + + + +`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. + +By default, results returned are as inclusive as possible. For example, if you don’t specify any filters, all experiments visible to you are returned. This includes your own experiments as well as those shared with you, from all providers you have access to (not just from the provider you used to invoke this experiment service). + +**Parameters** + +* **limit** (`Optional`\[`int`]) – Number of experiments to retrieve. `None` indicates no limit. + +* **json\_decoder** (`Type`\[`JSONDecoder`]) – Custom JSON decoder to use to decode the retrieved experiments. + +* **device\_components** (`Optional`\[`List`\[`Union`\[`str`, `DeviceComponent`]]]) – Filter by device components. + +* **device\_components\_operator** (`Optional`\[`str`]) – + + Operator used when filtering by device components. Valid values are `None` and “contains”: + + > * If `None`, an analysis result’s device components must match exactly for it to be included. + > * If “contains” is specified, an analysis result’s device components must contain at least the values specified by the device\_components filter. + +* **experiment\_type** (`Optional`\[`str`]) – Experiment type used for filtering. + +* **experiment\_type\_operator** (`Optional`\[`str`]) – + + Operator used when filtering by experiment type. Valid values are `None` and “like”: + + * If `None` is specified, an experiment’s type value must match exactly for it to be included. + * If “like” is specified, an experiment’s type value must contain the value specified by experiment\_type. For example, `experiment_type="foo", experiment_type_operator="like"` will match both `foo1` and `1foo`. + +* **backend\_name** (`Optional`\[`str`]) – Backend name used for filtering. + +* **tags** (`Optional`\[`List`\[`str`]]) – Filter by tags assigned to experiments. + +* **tags\_operator** (`Optional`\[`str`]) – + + Logical operator to use when filtering by job tags. Valid values are “AND” and “OR”: + + > * If “AND” is specified, then an experiment must have all of the tags specified in tags to be included. + > * If “OR” is specified, then an experiment only needs to have any of the tags specified in tags to be included. + +* **start\_datetime\_after** (`Optional`\[`datetime`]) – Filter by the given start timestamp, in local time. This is used to find experiments whose start date/time is after (greater than or equal to) this local timestamp. + +* **start\_datetime\_before** (`Optional`\[`datetime`]) – Filter by the given start timestamp, in local time. This is used to find experiments whose start date/time is before (less than or equal to) this local timestamp. + +* **hub** (`Optional`\[`str`]) – Filter by hub. + +* **group** (`Optional`\[`str`]) – Filter by hub and group. hub must also be specified if group is. + +* **project** (`Optional`\[`str`]) – Filter by hub, group, and project. hub and group must also be specified if project is. + +* **exclude\_public** (`Optional`\[`bool`]) – If `True`, experiments with `share_level=public` (that is, experiments visible to all users) will not be returned. Cannot be `True` if public\_only is `True`. + +* **public\_only** (`Optional`\[`bool`]) – If `True`, only experiments with `share_level=public` (that is, experiments visible to all users) will be returned. Cannot be `True` if exclude\_public is `True`. + +* **exclude\_mine** (`Optional`\[`bool`]) – If `True`, experiments where I am the owner will not be returned. Cannot be `True` if mine\_only is `True`. + +* **mine\_only** (`Optional`\[`bool`]) – If `True`, only experiments where I am the owner will be returned. Cannot be `True` if exclude\_mine is `True`. + +* **parent\_id** (`Optional`\[`str`]) – Filter experiments by this parent experiment ID. + +* **sort\_by** (`Union`\[`str`, `List`\[`str`], `None`]) – Specifies how the output should be sorted. This can be a single sorting option or a list of options. Each option should contain a sort key and a direction, separated by a semicolon. Valid sort keys are “start\_datetime” and “experiment\_type”. Valid directions are “asc” for ascending or “desc” for descending. For example, `sort_by=["experiment_type:asc", "start_datetime:desc"]` will return an output list that is first sorted by experiment type in ascending order, then by start datetime by descending order. By default, experiments are sorted by `start_datetime` descending and `experiment_id` ascending. + +* **\*\*filters** – Additional filtering keywords that are not supported and will be ignored. + +**Return type** + +`List`\[`Dict`] + +**Returns** + +A list of experiments. Each experiment is a dictionary containing the retrieved experiment data. + +**Raises** + +* **ValueError** – If an invalid parameter value is specified. +* **IBMQApiError** – If the request to the server failed. + +### figure + +`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. + +**Parameters** + +* **experiment\_id** (`str`) – Experiment ID. +* **figure\_name** (`str`) – Name of the figure. +* **file\_name** (`Optional`\[`str`]) – Name of the local file to save the figure to. If `None`, the content of the figure is returned instead. + +**Return type** + +`Union`\[`int`, `bytes`] + +**Returns** + +The size of the figure if file\_name is specified. Otherwise the content of the figure in bytes. + +**Raises** + +* [**IBMExperimentEntryNotFound**](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound") – If the figure does not exist. +* **IBMQApiError** – If the request to the server failed. + +### save\_preferences + + + +`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. + + + These are preferences passed to the applications that use this service and have no effect on the service itself. + + For example, if `auto_save` is set to `True`, it tells the application, such as `qiskit-experiments`, that you prefer changes to be automatically saved. It is up to the application to implement the preferences. + + +**Parameters** + +**auto\_save** (`Optional`\[`bool`]) – Automatically save the experiment. + +**Return type** + +`None` + +### update\_analysis\_result + + + +`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. + +**Parameters** + +* **result\_id** (`str`) – Analysis result ID. +* **result\_data** (`Optional`\[`Dict`]) – Result data to be stored. +* **quality** (`Union`\[`ResultQuality`, `str`, `None`]) – Quality of this analysis. +* **verified** (`Optional`\[`bool`]) – Whether the result quality has been verified. +* **tags** (`Optional`\[`List`\[`str`]]) – Tags to be associated with the analysis result. +* **chisq** (`Optional`\[`float`]) – chi^2 decimal value of the fit. +* **json\_encoder** (`Type`\[`JSONEncoder`]) – Custom JSON encoder to use to encode the analysis result. +* **kwargs** (`Any`) – Additional analysis result attributes that are not supported and will be ignored. + +**Raises** + +* [**IBMExperimentEntryNotFound**](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound") – If the analysis result does not exist. +* **IBMQApiError** – If the request to the server failed. + +**Return type** + +`None` + +### update\_experiment + + + +`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. + +**Parameters** + +* **experiment\_id** (`str`) – Experiment ID. + +* **metadata** (`Optional`\[`Dict`]) – Experiment metadata. + +* **job\_ids** (`Optional`\[`List`\[`str`]]) – IDs of experiment jobs. + +* **notes** (`Optional`\[`str`]) – Freeform notes about the experiment. + +* **tags** (`Optional`\[`List`\[`str`]]) – Tags to be associated with the experiment. + +* **share\_level** (`Union`\[`str`, `ExperimentShareLevel`, `None`]) – + + The level at which the experiment is shared. This determines who can view the experiment (but not update it). This defaults to “private” for new experiments. Possible values include: + + * private: The experiment is only visible to its owner (default) + * project: The experiment is shared within its project + * group: The experiment is shared within its group + * hub: The experiment is shared within its hub + * public: The experiment is shared publicly regardless of provider + +* **end\_datetime** (`Union`\[`str`, `datetime`, `None`]) – Timestamp for when the experiment ended, in local time. + +* **json\_encoder** (`Type`\[`JSONEncoder`]) – Custom JSON encoder to use to encode the experiment. + +* **kwargs** (`Any`) – Additional experiment attributes that are not supported and will be ignored. + +**Raises** + +* [**IBMExperimentEntryNotFound**](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound") – If the experiment does not exist. +* **IBMQApiError** – If the request to the server failed. + +**Return type** + +`None` + +### update\_figure + + + +`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. + +**Parameters** + +* **experiment\_id** (`str`) – Experiment ID. +* **figure** (`Union`\[`str`, `bytes`]) – Name of the figure file or figure data to store. +* **figure\_name** (`str`) – Name of the figure. +* **sync\_upload** (`bool`) – If `True`, the plot will be uploaded synchronously. Otherwise the upload will be asynchronous. + +**Return type** + +`Tuple`\[`str`, `int`] + +**Returns** + +A tuple of the name and size of the saved figure. + +**Raises** + +* [**IBMExperimentEntryNotFound**](qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound "qiskit.providers.ibmq.experiment.IBMExperimentEntryNotFound") – If the figure does not exist. +* **IBMQApiError** – If the request to the server failed. + +## Attributes + + ### preferences @@ -89,3 +662,4 @@ The experiment preferences. **Return type** Dict + 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 108d0079c91..3d88360d8d8 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 @@ -1,8 +1,16 @@ -# ResultQuality +--- +title: ResultQuality +description: API reference for qiskit.providers.ibmq.experiment.ResultQuality +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.experiment.ResultQuality +--- +# ResultQuality + -`ResultQuality(value)` +`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` @@ -10,20 +18,21 @@ Possible values for analysis result quality. ## Attributes - + ### BAD `= 'BAD'` - + ### GOOD `= 'GOOD'` - + ### UNKNOWN `= 'UNKNOWN'` + 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 cfb2f17bc74..7d91f3308c2 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 @@ -1,8 +1,16 @@ -# IBMQJob +--- +title: IBMQJob +description: API reference for qiskit.providers.ibmq.job.IBMQJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.job.IBMQJob +--- +# IBMQJob + -`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)` +`IBMQJob(backend, api_client, job_id, creation_date, status, kind=None, name=None, time_per_step=None, result=None, qobj=None, error=None, tags=None, run_mode=None, share_level=None, client_info=None, experiment_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/ibmqjob.py "view source code") Bases: `qiskit.providers.job.JobV1` @@ -10,7 +18,7 @@ Representation of a job that executes on an IBM Quantum Experience backend. The job may be executed on a simulator or a real device. A new `IBMQJob` instance is returned when you call `IBMQBackend.run()` to submit a job to a particular backend. -If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](qiskit.providers.ibmq.job.IBMQJob.status#qiskit.providers.ibmq.job.IBMQJob.status "qiskit.providers.ibmq.job.IBMQJob.status"). Job status can be one of the [`JobStatus`](qiskit.providers.JobStatus#qiskit.providers.JobStatus "qiskit.providers.JobStatus") members. For example: +If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](qiskit.providers.ibmq.job.IBMQJob#status "qiskit.providers.ibmq.job.IBMQJob.status"). Job status can be one of the [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.JobStatus") members. For example: ```python from qiskit.providers.jobstatus import JobStatus @@ -26,10 +34,10 @@ except IBMQJobApiError as ex: ``` - An error may occur when querying the remote server to get job information. The most common errors are temporary network failures and server errors, in which case an [`IBMQJobApiError`](qiskit.providers.ibmq.job.IBMQJobApiError#qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") is raised. These errors usually clear quickly, so retrying the operation is likely to succeed. + An error may occur when querying the remote server to get job information. The most common errors are temporary network failures and server errors, in which case an [`IBMQJobApiError`](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") is raised. These errors usually clear quickly, so retrying the operation is likely to succeed. -Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](qiskit.providers.ibmq.job.IBMQJob.result#qiskit.providers.ibmq.job.IBMQJob.result "qiskit.providers.ibmq.job.IBMQJob.result") is an example of a blocking method: +Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](qiskit.providers.ibmq.job.IBMQJob#result "qiskit.providers.ibmq.job.IBMQJob.result") is an example of a blocking method: ```python job = backend.run(...) @@ -41,7 +49,7 @@ except JobError as ex: print("Something wrong happened!: {}".format(ex)) ``` -Job information retrieved from the server is attached to the `IBMQJob` instance as attributes. Given that Qiskit and the server can be updated independently, some of these attributes might be deprecated or experimental. Supported attributes can be retrieved via methods. For example, you can use [`creation_date()`](qiskit.providers.ibmq.job.IBMQJob.creation_date#qiskit.providers.ibmq.job.IBMQJob.creation_date "qiskit.providers.ibmq.job.IBMQJob.creation_date") to retrieve the job creation date, which is a supported attribute. +Job information retrieved from the server is attached to the `IBMQJob` instance as attributes. Given that Qiskit and the server can be updated independently, some of these attributes might be deprecated or experimental. Supported attributes can be retrieved via methods. For example, you can use [`creation_date()`](qiskit.providers.ibmq.job.IBMQJob#creation_date "qiskit.providers.ibmq.job.IBMQJob.creation_date") to retrieve the job creation date, which is a supported attribute. IBMQJob constructor. @@ -67,40 +75,586 @@ IBMQJob constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | -| [`backend`](qiskit.providers.ibmq.job.IBMQJob.backend#qiskit.providers.ibmq.job.IBMQJob.backend "qiskit.providers.ibmq.job.IBMQJob.backend") | Return the backend where this job was executed. | -| [`backend_options`](qiskit.providers.ibmq.job.IBMQJob.backend_options#qiskit.providers.ibmq.job.IBMQJob.backend_options "qiskit.providers.ibmq.job.IBMQJob.backend_options") | Return the backend configuration options used for this job. | -| [`cancel`](qiskit.providers.ibmq.job.IBMQJob.cancel#qiskit.providers.ibmq.job.IBMQJob.cancel "qiskit.providers.ibmq.job.IBMQJob.cancel") | Attempt to cancel the job. | -| [`cancelled`](qiskit.providers.ibmq.job.IBMQJob.cancelled#qiskit.providers.ibmq.job.IBMQJob.cancelled "qiskit.providers.ibmq.job.IBMQJob.cancelled") | Return whether the job has been cancelled. | -| [`circuits`](qiskit.providers.ibmq.job.IBMQJob.circuits#qiskit.providers.ibmq.job.IBMQJob.circuits "qiskit.providers.ibmq.job.IBMQJob.circuits") | Return the circuits or pulse schedules for this job. | -| [`creation_date`](qiskit.providers.ibmq.job.IBMQJob.creation_date#qiskit.providers.ibmq.job.IBMQJob.creation_date "qiskit.providers.ibmq.job.IBMQJob.creation_date") | Return job creation date, in local time. | -| [`done`](qiskit.providers.ibmq.job.IBMQJob.done#qiskit.providers.ibmq.job.IBMQJob.done "qiskit.providers.ibmq.job.IBMQJob.done") | Return whether the job has successfully run. | -| [`error_message`](qiskit.providers.ibmq.job.IBMQJob.error_message#qiskit.providers.ibmq.job.IBMQJob.error_message "qiskit.providers.ibmq.job.IBMQJob.error_message") | Provide details about the reason of failure. | -| [`header`](qiskit.providers.ibmq.job.IBMQJob.header#qiskit.providers.ibmq.job.IBMQJob.header "qiskit.providers.ibmq.job.IBMQJob.header") | Return the user header specified for this job. | -| [`in_final_state`](qiskit.providers.ibmq.job.IBMQJob.in_final_state#qiskit.providers.ibmq.job.IBMQJob.in_final_state "qiskit.providers.ibmq.job.IBMQJob.in_final_state") | Return whether the job is in a final job state such as `DONE` or `ERROR`. | -| [`job_id`](qiskit.providers.ibmq.job.IBMQJob.job_id#qiskit.providers.ibmq.job.IBMQJob.job_id "qiskit.providers.ibmq.job.IBMQJob.job_id") | Return the job ID assigned by the server. | -| [`name`](qiskit.providers.ibmq.job.IBMQJob.name#qiskit.providers.ibmq.job.IBMQJob.name "qiskit.providers.ibmq.job.IBMQJob.name") | Return the name assigned to this job. | -| [`properties`](qiskit.providers.ibmq.job.IBMQJob.properties#qiskit.providers.ibmq.job.IBMQJob.properties "qiskit.providers.ibmq.job.IBMQJob.properties") | Return the backend properties for this job. | -| [`qobj`](qiskit.providers.ibmq.job.IBMQJob.qobj#qiskit.providers.ibmq.job.IBMQJob.qobj "qiskit.providers.ibmq.job.IBMQJob.qobj") | Return the Qobj for this job. | -| [`queue_info`](qiskit.providers.ibmq.job.IBMQJob.queue_info#qiskit.providers.ibmq.job.IBMQJob.queue_info "qiskit.providers.ibmq.job.IBMQJob.queue_info") | Return queue information for this job. | -| [`queue_position`](qiskit.providers.ibmq.job.IBMQJob.queue_position#qiskit.providers.ibmq.job.IBMQJob.queue_position "qiskit.providers.ibmq.job.IBMQJob.queue_position") | Return the position of the job in the server queue. | -| [`refresh`](qiskit.providers.ibmq.job.IBMQJob.refresh#qiskit.providers.ibmq.job.IBMQJob.refresh "qiskit.providers.ibmq.job.IBMQJob.refresh") | Obtain the latest job information from the server. | -| [`result`](qiskit.providers.ibmq.job.IBMQJob.result#qiskit.providers.ibmq.job.IBMQJob.result "qiskit.providers.ibmq.job.IBMQJob.result") | Return the result of the job. | -| [`running`](qiskit.providers.ibmq.job.IBMQJob.running#qiskit.providers.ibmq.job.IBMQJob.running "qiskit.providers.ibmq.job.IBMQJob.running") | Return whether the job is actively running. | -| [`scheduling_mode`](qiskit.providers.ibmq.job.IBMQJob.scheduling_mode#qiskit.providers.ibmq.job.IBMQJob.scheduling_mode "qiskit.providers.ibmq.job.IBMQJob.scheduling_mode") | Return the scheduling mode the job is in. | -| [`share_level`](qiskit.providers.ibmq.job.IBMQJob.share_level#qiskit.providers.ibmq.job.IBMQJob.share_level "qiskit.providers.ibmq.job.IBMQJob.share_level") | Return the share level of the job. | -| [`status`](qiskit.providers.ibmq.job.IBMQJob.status#qiskit.providers.ibmq.job.IBMQJob.status "qiskit.providers.ibmq.job.IBMQJob.status") | Query the server for the latest job status. | -| [`submit`](qiskit.providers.ibmq.job.IBMQJob.submit#qiskit.providers.ibmq.job.IBMQJob.submit "qiskit.providers.ibmq.job.IBMQJob.submit") | Unsupported method. | -| [`tags`](qiskit.providers.ibmq.job.IBMQJob.tags#qiskit.providers.ibmq.job.IBMQJob.tags "qiskit.providers.ibmq.job.IBMQJob.tags") | Return the tags assigned to this job. | -| [`time_per_step`](qiskit.providers.ibmq.job.IBMQJob.time_per_step#qiskit.providers.ibmq.job.IBMQJob.time_per_step "qiskit.providers.ibmq.job.IBMQJob.time_per_step") | Return the date and time information on each step of the job processing. | -| [`update_name`](qiskit.providers.ibmq.job.IBMQJob.update_name#qiskit.providers.ibmq.job.IBMQJob.update_name "qiskit.providers.ibmq.job.IBMQJob.update_name") | Update the name associated with this job. | -| [`update_tags`](qiskit.providers.ibmq.job.IBMQJob.update_tags#qiskit.providers.ibmq.job.IBMQJob.update_tags "qiskit.providers.ibmq.job.IBMQJob.update_tags") | Update the tags associated with this job. | -| [`wait_for_final_state`](qiskit.providers.ibmq.job.IBMQJob.wait_for_final_state#qiskit.providers.ibmq.job.IBMQJob.wait_for_final_state "qiskit.providers.ibmq.job.IBMQJob.wait_for_final_state") | Wait until the job progresses to a final state such as `DONE` or `ERROR`. | +### backend -## Attributes + + +`IBMQJob.backend()` + +Return the backend where this job was executed. + +**Return type** + +`Backend` + +### backend\_options + + + +`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. + +Options that are not applicable to the job execution are not returned. Some but not all of the options with default values are returned. You can use [`qiskit.providers.ibmq.IBMQBackend.options`](qiskit.providers.ibmq.IBMQBackend#options "qiskit.providers.ibmq.IBMQBackend.options") to see all backend options. + +**Return type** + +`Dict`\[`str`, `Any`] + +**Returns** + +Backend options used for this job. An empty dictionary is returned if the options cannot be retrieved. + +### cancel + + + +`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. + + + Depending on the state the job is in, it might be impossible to cancel the job. + + +**Return type** + +`bool` + +**Returns** + +`True` if the job is cancelled, else `False`. + +**Raises** + +[**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when communicating with the server. + +### cancelled + + + +`IBMQJob.cancelled()` + +Return whether the job has been cancelled. + +**Return type** + +`bool` + +### circuits + + + +`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. + +**Return type** + +`List`\[`Union`\[`QuantumCircuit`, `Schedule`]] + +**Returns** + +The circuits or pulse schedules for this job. An empty list is returned if the circuits cannot be retrieved (for example, if the job uses an old format that is no longer supported). + +### creation\_date + + + +`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. + +**Return type** + +`datetime` + +**Returns** + +The job creation date as a datetime object, in local time. + +### done + + + +`IBMQJob.done()` + +Return whether the job has successfully run. + +**Return type** + +`bool` + +### error\_message + + + +`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. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +An error report if the job failed or `None` otherwise. + +### header + + + +`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. + +**Return type** + +`Dict` + +**Returns** + +User header specified for this job. An empty dictionary is returned if the header cannot be retrieved. + +### in\_final\_state + + + +`IBMQJob.in_final_state()` + +Return whether the job is in a final job state such as `DONE` or `ERROR`. + +**Return type** + +`bool` + +### job\_id + + + +`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. + +**Return type** + +`str` + +**Returns** + +Job ID. + +### name + + + +`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. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +Job name or `None` if no name was assigned to this job. + +### properties + + + +`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. + +**Return type** + +`Optional`\[`BackendProperties`] + +**Returns** + +The backend properties used for this job, or `None` if properties are not available. + +**Raises** + +[**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when communicating with the server. + +### qobj + + + +`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. + +**Return type** + +`Union`\[`QasmQobj`, `PulseQobj`, `None`] + +**Returns** + +The Qobj for this job, or `None` if the job does not have a Qobj. + +**Raises** + +[**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when retrieving job information from the server. + +### queue\_info + + + +`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. + +The queue information may include queue position, estimated start and end time, and dynamic priorities for the hub, group, and project. See [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.QueueInfo") for more information. + + + The queue information is calculated after the job enters the queue. Therefore, some or all of the information may not be immediately available, and this method may return `None`. + + +**Return type** + +`Optional`\[`QueueInfo`] + +**Returns** + +A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.QueueInfo") instance that contains queue information for this job, or `None` if queue information is unknown or not applicable. + +### queue\_position + + + +`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. + + + The position returned is within the scope of the provider and may differ from the global queue position. + + +**Parameters** + +**refresh** (`bool`) – If `True`, re-query the server to get the latest value. Otherwise return the cached value. + +**Return type** + +`Optional`\[`int`] + +**Returns** + +Position in the queue or `None` if position is unknown or not applicable. + +### refresh + + + +`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. + +This method may add additional attributes to this job instance, if new information becomes available. +**Raises** +[**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when communicating with the server. + +**Return type** + +`None` + +### result + + + +`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. + + + Some IBM Quantum Experience job results can only be read once. A second attempt to query the server for the same job will fail, since the job has already been “consumed”. + + The first call to this method in an `IBMQJob` instance will query the server and consume any available job results. Subsequent calls to that instance’s `result()` will also return the results, since they are cached. However, attempting to retrieve the results again in another instance or session might fail due to the job results having been consumed. + + + + When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`Result`](qiskit.result.Result "qiskit.result.Result") instance can be used to verify whether it contains partial results. + + For example, if one of the experiments in the job failed, trying to get the counts of the unsuccessful experiment would raise an exception since there are no counts to return: + + ```python + try: + counts = result.get_counts("failed_experiment") + except QiskitError: + print("Experiment failed!") + ``` + + +If the job failed, you can use [`error_message()`](qiskit.providers.ibmq.job.IBMQJob#error_message "qiskit.providers.ibmq.job.IBMQJob.error_message") to get more information. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job. +* **wait** (`float`) – Time in seconds between queries. +* **partial** (`bool`) – If `True`, return partial results if possible. +* **refresh** (`bool`) – If `True`, re-query the server for the result. Otherwise return the cached value. + +**Return type** + +`Result` + +**Returns** + +Job result. + +**Raises** + +* [**IBMQJobInvalidStateError**](qiskit.providers.ibmq.job.IBMQJobInvalidStateError "qiskit.providers.ibmq.job.IBMQJobInvalidStateError") – If the job was cancelled. +* [**IBMQJobFailureError**](qiskit.providers.ibmq.job.IBMQJobFailureError "qiskit.providers.ibmq.job.IBMQJobFailureError") – If the job failed. +* [**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when communicating with the server. + +### running + + + +`IBMQJob.running()` + +Return whether the job is actively running. + +**Return type** + +`bool` + +### scheduling\_mode + + + +`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. + +The scheduling mode indicates how the job is scheduled to run. For example, `fairshare` indicates the job is scheduled using a fairshare algorithm. + +This information is only available if the job status is `RUNNING` or `DONE`. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +The scheduling mode the job is in or `None` if the information is not available. + +### share\_level + + + +`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. + +The share level is one of `global`, `hub`, `group`, `project`, and `none`. + +**Return type** + +`str` + +**Returns** + +The share level of the job. + +### status + + + +`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. + + + This method is not designed to be invoked repeatedly in a loop for an extended period of time. Doing so may cause the server to reject your request. Use [`wait_for_final_state()`](qiskit.providers.ibmq.job.IBMQJob#wait_for_final_state "qiskit.providers.ibmq.job.IBMQJob.wait_for_final_state") if you want to wait for the job to finish. + + + + If the job failed, you can use [`error_message()`](qiskit.providers.ibmq.job.IBMQJob#error_message "qiskit.providers.ibmq.job.IBMQJob.error_message") to get more information. + + +**Return type** + +`JobStatus` + +**Returns** + +The status of the job. + +**Raises** + +[**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when communicating with the server. + +### submit + + + +`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. + + + This method is not supported, please use `run()` to submit a job. + + +**Raises** + +**NotImplementedError** – Upon invocation. + +**Return type** + +`None` + +### tags + + + +`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. + +**Return type** + +`List`\[`str`] + +**Returns** + +Tags assigned to this job. + +### time\_per\_step + + + +`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. + +The output dictionary contains the date and time information on each step of the job processing, in local time. The keys of the dictionary are the names of the steps, and the values are the date and time data, as a datetime object with local timezone info. For example: + +```python +{'CREATING': datetime(2020, 2, 13, 15, 19, 25, 717000, tzinfo=tzlocal(), + 'CREATED': datetime(2020, 2, 13, 15, 19, 26, 467000, tzinfo=tzlocal(), + 'VALIDATING': datetime(2020, 2, 13, 15, 19, 26, 527000, tzinfo=tzlocal()} +``` + +**Return type** + +`Optional`\[`Dict`] + +**Returns** + +Date and time information on job processing steps, in local time, or `None` if the information is not yet available. + +### update\_name + + + +`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. + +**Parameters** + +**name** (`str`) – The new name for this job. + +**Return type** + +`str` + +**Returns** + +The new name associated with this job. + +**Raises** + +* [**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when communicating with the server or updating the job name. +* [**IBMQJobInvalidStateError**](qiskit.providers.ibmq.job.IBMQJobInvalidStateError "qiskit.providers.ibmq.job.IBMQJobInvalidStateError") – If the input job name is not a string. + +### update\_tags + + + +`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. + +When multiple parameters are specified, the parameters are processed in the following order: + +> 1. replacement\_tags +> 2. additional\_tags +> 3. removal\_tags + +For example, if ‘new\_tag’ is specified for both additional\_tags and removal\_tags, then it is added and subsequently removed from the tags list, making it a “do nothing” operation. + + + * Some tags, such as those starting with `ibmq_jobset`, are used internally by ibmq-provider and therefore cannot be modified. + * When removing tags, if the job does not have a specified tag, it will be ignored. + + +**Parameters** + +* **replacement\_tags** (`Optional`\[`List`\[`str`]]) – The tags that should replace the current tags associated with this job. +* **additional\_tags** (`Optional`\[`List`\[`str`]]) – The new tags that should be added to the current tags associated with this job. +* **removal\_tags** (`Optional`\[`List`\[`str`]]) – The tags that should be removed from the current tags associated with this job. + +**Return type** + +`List`\[`str`] + +**Returns** + +The new tags associated with this job. + +**Raises** + +* [**IBMQJobApiError**](qiskit.providers.ibmq.job.IBMQJobApiError "qiskit.providers.ibmq.job.IBMQJobApiError") – If an unexpected error occurred when communicating with the server or updating the job tags. +* [**IBMQJobInvalidStateError**](qiskit.providers.ibmq.job.IBMQJobInvalidStateError "qiskit.providers.ibmq.job.IBMQJobInvalidStateError") – If none of the input parameters are specified or if any of the input parameters are invalid. + +### wait\_for\_final\_state + + + +`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`. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. + +* **wait** (`Optional`\[`float`]) – Seconds to wait between invoking the callback function. If `None`, the callback function is invoked only if job status or queue position has changed. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function invoked after each querying iteration. The following positional arguments are provided to the callback function: + + > * job\_id: Job ID + > * job\_status: Status of the job from the last query. + > * job: This `IBMQJob` instance. + + In addition, the following keyword arguments are also provided: + + > * queue\_info: A [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.QueueInfo") instance with job queue information, or `None` if queue information is unknown or not applicable. You can use the `to_dict()` method to convert the [`QueueInfo`](qiskit.providers.ibmq.job.QueueInfo "qiskit.providers.ibmq.job.QueueInfo") instance to a dictionary, if desired. + +**Raises** + +[**IBMQJobTimeoutError**](qiskit.providers.ibmq.job.IBMQJobTimeoutError "qiskit.providers.ibmq.job.IBMQJobTimeoutError") – if the job does not reach a final state before the specified timeout. + +**Return type** + +`None` + +## Attributes + + ### client\_version @@ -116,7 +670,7 @@ Return version of the client used for this job. of the client and the value is the version. - + ### experiment\_id @@ -130,8 +684,9 @@ Return the experiment ID. ID of the experiment this job is part of. - + ### version `= 1` + 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 a78ef7c5a89..dbf01e8af0b 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.job.IBMQJobApiError +--- +title: IBMQJobApiError +description: API reference for qiskit.providers.ibmq.job.IBMQJobApiError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.job.IBMQJobApiError +--- +# qiskit.providers.ibmq.job.IBMQJobApiError + -`IBMQJobApiError(*message)` +`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. Set the error message. + 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 fe3882af0c4..1da1f4b7bfe 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.job.IBMQJobError +--- +title: IBMQJobError +description: API reference for qiskit.providers.ibmq.job.IBMQJobError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.job.IBMQJobError +--- +# qiskit.providers.ibmq.job.IBMQJobError + -`IBMQJobError(*message)` +`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. Set the error message. + 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 47aebf19357..48bafa04842 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.job.IBMQJobFailureError +--- +title: IBMQJobFailureError +description: API reference for qiskit.providers.ibmq.job.IBMQJobFailureError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.job.IBMQJobFailureError +--- +# qiskit.providers.ibmq.job.IBMQJobFailureError + -`IBMQJobFailureError(*message)` +`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. Set the error message. + 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 55a5825f6d0..740582bb1ce 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.job.IBMQJobInvalidStateError +--- +title: IBMQJobInvalidStateError +description: API reference for qiskit.providers.ibmq.job.IBMQJobInvalidStateError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.job.IBMQJobInvalidStateError +--- +# qiskit.providers.ibmq.job.IBMQJobInvalidStateError + -`IBMQJobInvalidStateError(*message)` +`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. Set the error message. + 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 006b997c5d1..9078ea34ddf 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.job.IBMQJobTimeoutError +--- +title: IBMQJobTimeoutError +description: API reference for qiskit.providers.ibmq.job.IBMQJobTimeoutError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.job.IBMQJobTimeoutError +--- +# qiskit.providers.ibmq.job.IBMQJobTimeoutError + -`IBMQJobTimeoutError(*message)` +`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. Set the error message. + 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 b30b10f4f5d..dddd6edda94 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 @@ -1,8 +1,16 @@ -# QueueInfo +--- +title: QueueInfo +description: API reference for qiskit.providers.ibmq.job.QueueInfo +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.job.QueueInfo +--- +# QueueInfo + -`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)` +`QueueInfo(position=None, status=None, estimated_start_time=None, estimated_complete_time=None, hub_priority=None, group_priority=None, project_priority=None, job_id=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/queueinfo.py "view source code") Bases: `object` @@ -24,13 +32,25 @@ QueueInfo constructor. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`format`](qiskit.providers.ibmq.job.QueueInfo.format#qiskit.providers.ibmq.job.QueueInfo.format "qiskit.providers.ibmq.job.QueueInfo.format") | Build a user-friendly report for the job queue information. | +### format -## Attributes + + +`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. + +**Return type** +`str` +**Returns** + +The job queue information report. + +## Attributes + + ### estimated\_complete\_time @@ -40,7 +60,7 @@ Return estimated complete time in local time. `Optional`\[`datetime`] - + ### estimated\_start\_time @@ -49,3 +69,4 @@ Return estimated start time in local time. **Return type** `Optional`\[`datetime`] + 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 6dc8b08f587..56ec96af801 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 @@ -1,8 +1,16 @@ -# qiskit.providers.ibmq.job.job\_monitor +--- +title: job_monitor +description: API reference for qiskit.providers.ibmq.job.job_monitor +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.ibmq.job.job_monitor +--- +# qiskit.providers.ibmq.job.job\_monitor + -`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)` +`job_monitor(job, interval=None, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/job/job_monitor.py "view source code") Monitor the status of an `IBMQJob` instance. @@ -15,3 +23,4 @@ Monitor the status of an `IBMQJob` instance. **Return type** `None` + 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 93d4e911a66..60d12dd3e3c 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 @@ -1,8 +1,16 @@ -# qiskit.providers.ibmq.least\_busy +--- +title: least_busy +description: API reference for qiskit.providers.ibmq.least_busy +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.ibmq.least_busy +--- +# qiskit.providers.ibmq.least\_busy + -`least_busy(backends, reservation_lookahead=60)` +`least_busy(backends, reservation_lookahead=60)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/__init__.py "view source code") Return the least busy backend from a list. @@ -23,4 +31,5 @@ The backend with the fewest number of pending jobs. **Raises** -[**IBMQError**](qiskit.providers.ibmq.IBMQError#qiskit.providers.ibmq.IBMQError "qiskit.providers.ibmq.IBMQError") – If the backends list is empty, or if none of the backends is available, or if a backend in the list does not have the `pending_jobs` attribute in its status. +[**IBMQError**](qiskit.providers.ibmq.IBMQError "qiskit.providers.ibmq.IBMQError") – If the backends list is empty, or if none of the backends is available, or if a backend in the list does not have the `pending_jobs` attribute in its status. + 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 cd075847f06..0888b9afcd2 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 @@ -1,16 +1,24 @@ -# IBMQJobManager +--- +title: IBMQJobManager +description: API reference for qiskit.providers.ibmq.managed.IBMQJobManager +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.managed.IBMQJobManager +--- +# IBMQJobManager + -`IBMQJobManager` +`IBMQJobManager`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/ibmqjobmanager.py "view source code") Bases: `object` Job Manager for IBM Quantum Experience. -The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob#qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. +The Job Manager is a higher level mechanism for handling [`jobs`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") composed of multiple circuits or pulse schedules. It splits the experiments into multiple jobs based on backend restrictions. When the jobs are finished, it collects and presents the results in a unified view. -You can use the [`run()`](qiskit.providers.ibmq.managed.IBMQJobManager.run#qiskit.providers.ibmq.managed.IBMQJobManager.run "qiskit.providers.ibmq.managed.IBMQJobManager.run") method to submit multiple experiments with the Job Manager: +You can use the [`run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run") method to submit multiple experiments with the Job Manager: ```python from qiskit import IBMQ, transpile @@ -33,14 +41,14 @@ job_manager = IBMQJobManager() job_set_foo = job_manager.run(circs, backend=backend, name='foo') ``` -The [`run()`](qiskit.providers.ibmq.managed.IBMQJobManager.run#qiskit.providers.ibmq.managed.IBMQJobManager.run "qiskit.providers.ibmq.managed.IBMQJobManager.run") method returns a [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet#qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet") instance, which represents the set of jobs for the experiments. You can use the [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet#qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet") methods, such as [`statuses()`](qiskit.providers.ibmq.managed.ManagedJobSet.statuses#qiskit.providers.ibmq.managed.ManagedJobSet.statuses "qiskit.providers.ibmq.managed.ManagedJobSet.statuses"), [`results()`](qiskit.providers.ibmq.managed.ManagedJobSet.results#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results"), and [`error_messages()`](qiskit.providers.ibmq.managed.ManagedJobSet.error_messages#qiskit.providers.ibmq.managed.ManagedJobSet.error_messages "qiskit.providers.ibmq.managed.ManagedJobSet.error_messages") to get a combined view of the jobs in the set. For example: +The [`run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run") method returns a [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet") instance, which represents the set of jobs for the experiments. You can use the [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet") methods, such as [`statuses()`](qiskit.providers.ibmq.managed.ManagedJobSet#statuses "qiskit.providers.ibmq.managed.ManagedJobSet.statuses"), [`results()`](qiskit.providers.ibmq.managed.ManagedJobSet#results "qiskit.providers.ibmq.managed.ManagedJobSet.results"), and [`error_messages()`](qiskit.providers.ibmq.managed.ManagedJobSet#error_messages "qiskit.providers.ibmq.managed.ManagedJobSet.error_messages") to get a combined view of the jobs in the set. For example: ```python results = job_set_foo.results() results.get_counts(5) # Counts for experiment 5. ``` -The [`job_set_id()`](qiskit.providers.ibmq.managed.ManagedJobSet.job_set_id#qiskit.providers.ibmq.managed.ManagedJobSet.job_set_id "qiskit.providers.ibmq.managed.ManagedJobSet.job_set_id") method of [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet#qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet") returns the job set ID, which can be used to retrieve the job set later: +The [`job_set_id()`](qiskit.providers.ibmq.managed.ManagedJobSet#job_set_id "qiskit.providers.ibmq.managed.ManagedJobSet.job_set_id") method of [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet") returns the job set ID, which can be used to retrieve the job set later: ```python job_set_id = job_set_foo.job_set_id() @@ -51,9 +59,112 @@ IBMQJobManager constructor. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| [`job_sets`](qiskit.providers.ibmq.managed.IBMQJobManager.job_sets#qiskit.providers.ibmq.managed.IBMQJobManager.job_sets "qiskit.providers.ibmq.managed.IBMQJobManager.job_sets") | Return job sets being managed in this session, subject to optional filtering. | -| [`report`](qiskit.providers.ibmq.managed.IBMQJobManager.report#qiskit.providers.ibmq.managed.IBMQJobManager.report "qiskit.providers.ibmq.managed.IBMQJobManager.report") | Return a report on the statuses of all jobs managed by this Job Manager. | -| [`retrieve_job_set`](qiskit.providers.ibmq.managed.IBMQJobManager.retrieve_job_set#qiskit.providers.ibmq.managed.IBMQJobManager.retrieve_job_set "qiskit.providers.ibmq.managed.IBMQJobManager.retrieve_job_set") | Retrieve a previously submitted job set. | -| [`run`](qiskit.providers.ibmq.managed.IBMQJobManager.run#qiskit.providers.ibmq.managed.IBMQJobManager.run "qiskit.providers.ibmq.managed.IBMQJobManager.run") | Execute a set of circuits or pulse schedules on a backend. | +### job\_sets + + + +`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. + +**Parameters** + +**name** (`Optional`\[`str`]) – Name of the managed job sets. + +**Return type** + +`List`\[`ManagedJobSet`] + +**Returns** + +A list of managed job sets that match the filter. + +### report + + + +`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. + +**Parameters** + +**detailed** (`bool`) – `True` if a detailed report is to be returned. `False` if a summary report is to be returned. + +**Return type** + +`str` + +**Returns** + +A report on job statuses. + +### retrieve\_job\_set + + + +`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. + +**Parameters** + +* **job\_set\_id** (`str`) – Job set ID. +* **provider** (`AccountProvider`) – Provider used for this job set. +* **refresh** (`bool`) – If `True`, re-query the server for the job set information. Otherwise return the cached value. + +**Return type** + +`ManagedJobSet` + +**Returns** + +Retrieved job set. + +**Raises** + +* [**IBMQJobManagerUnknownJobSet**](qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet "qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet") – If the job set cannot be found. +* [**IBMQJobManagerInvalidStateError**](qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError "qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError") – If jobs for this job set are found but have unexpected attributes. + +### run + + + +`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. + +The circuits or schedules will be split into multiple jobs. Circuits or schedules in a job will be executed together in each shot. + +**Parameters** + +* **experiments** (`Union`\[`QuantumCircuit`, `Schedule`, `List`\[`QuantumCircuit`], `List`\[`Schedule`]]) – Circuit(s) or pulse schedule(s) to execute. + +* **backend** (`IBMQBackend`) – Backend to execute the experiments on. + +* **name** (`Optional`\[`str`]) – Name for this set of jobs. Each job within the set will have a job name that consists of the set name followed by a suffix. If not specified, the current date and time is used. + +* **max\_experiments\_per\_job** (`Optional`\[`int`]) – Maximum number of experiments to run in each job. If not specified, the default is to use the maximum allowed by the backend. If the specified value is greater the maximum allowed by the backend, the default is used. + +* **job\_share\_level** (`Optional`\[`str`]) – Allow sharing the jobs at the hub, group, project, or global level. The level can be one of: `global`, `hub`, `group`, `project`, and `none`. + +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the jobs. The tags can subsequently be used as a filter in the `IBMQBackend.jobs()` function call. + +* **run\_config** (`Any`) – + + Configuration of the runtime environment. Some examples of these configuration parameters include: `qobj_id`, `qobj_header`, `shots`, `memory`, `seed_simulator`, `qubit_lo_freq`, `meas_lo_freq`, `qubit_lo_range`, `meas_lo_range`, `schedule_los`, `meas_level`, `meas_return`, `meas_map`, `memory_slot_size`, `rep_time`, and `parameter_binds`. + + Refer to the documentation on [`qiskit.compiler.assemble()`](qiskit.compiler.assemble "qiskit.compiler.assemble") for details on these arguments. + +**Return type** + +`ManagedJobSet` + +**Returns** + +A [`ManagedJobSet`](qiskit.providers.ibmq.managed.ManagedJobSet "qiskit.providers.ibmq.managed.ManagedJobSet") instance representing the set of jobs for the experiments. + +**Raises** + +[**IBMQJobManagerInvalidStateError**](qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError "qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError") – If an input parameter value is not valid. + 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 40c2b71c092..d89c8d9ca6b 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.managed.IBMQJobManagerError +--- +title: IBMQJobManagerError +description: API reference for qiskit.providers.ibmq.managed.IBMQJobManagerError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerError +--- +# qiskit.providers.ibmq.managed.IBMQJobManagerError + -`IBMQJobManagerError(*message)` +`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. Set the error message. + 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 0538ccf510a..8ce6b93b8f5 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError +--- +title: IBMQJobManagerInvalidStateError +description: API reference for qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError +--- +# qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError + -`IBMQJobManagerInvalidStateError(*message)` +`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. Set the error message. + 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 9b4b09b63a3..83cc49d15fa 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound +--- +title: IBMQJobManagerJobNotFound +description: API reference for qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound +--- +# qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound + -`IBMQJobManagerJobNotFound(*message)` +`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. Set the error message. + 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 42ccd234885..2d51d9d9f15 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError +--- +title: IBMQJobManagerTimeoutError +description: API reference for qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError +--- +# qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError + -`IBMQJobManagerTimeoutError(*message)` +`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. Set the error message. + 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 66a13e6eb29..944b4b473e9 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet +--- +title: IBMQJobManagerUnknownJobSet +description: API reference for qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet +--- +# qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet + -`IBMQJobManagerUnknownJobSet(*message)` +`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. Set the error message. + 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 e6e805bbb5d..c3dbd53a191 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 @@ -1,9 +1,18 @@ -# qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable +--- +title: IBMQManagedResultDataNotAvailable +description: API reference for qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable +--- +# qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable + -`IBMQManagedResultDataNotAvailable(*message)` +`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. Set the error message. + 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 ce96f7e9488..bb0c317e8c0 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 @@ -1,8 +1,16 @@ -# ManagedJob +--- +title: ManagedJob +description: API reference for qiskit.providers.ibmq.managed.ManagedJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.managed.ManagedJob +--- +# ManagedJob + -`ManagedJob(start_index, experiments_count, job=None)` +`ManagedJob(start_index, experiments_count, job=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/managed/managedjob.py "view source code") Bases: `object` @@ -18,11 +26,112 @@ ManagedJob constructor. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`cancel`](qiskit.providers.ibmq.managed.ManagedJob.cancel#qiskit.providers.ibmq.managed.ManagedJob.cancel "qiskit.providers.ibmq.managed.ManagedJob.cancel") | Attempt to cancel the job. | -| [`error_message`](qiskit.providers.ibmq.managed.ManagedJob.error_message#qiskit.providers.ibmq.managed.ManagedJob.error_message "qiskit.providers.ibmq.managed.ManagedJob.error_message") | Provide details about the reason of failure. | -| [`qobj`](qiskit.providers.ibmq.managed.ManagedJob.qobj#qiskit.providers.ibmq.managed.ManagedJob.qobj "qiskit.providers.ibmq.managed.ManagedJob.qobj") | Return the Qobj for this job. | -| [`result`](qiskit.providers.ibmq.managed.ManagedJob.result#qiskit.providers.ibmq.managed.ManagedJob.result "qiskit.providers.ibmq.managed.ManagedJob.result") | Return the result of the job. | -| [`status`](qiskit.providers.ibmq.managed.ManagedJob.status#qiskit.providers.ibmq.managed.ManagedJob.status "qiskit.providers.ibmq.managed.ManagedJob.status") | Query the server for job status. | -| [`submit`](qiskit.providers.ibmq.managed.ManagedJob.submit#qiskit.providers.ibmq.managed.ManagedJob.submit "qiskit.providers.ibmq.managed.ManagedJob.submit") | Submit the job. | +### cancel + + + +`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. + +**Return type** + +`None` + +### error\_message + + + +`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. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +An error report if the job failed or `None` otherwise. + +### qobj + + + +`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. + +**Return type** + +`Union`\[`QasmQobj`, `PulseQobj`, `None`] + +**Returns** + +The Qobj for this job or `None` if the Qobj could not be retrieved. + +### result + + + +`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. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job. +* **partial** (`bool`) – If `True`, attempt to retrieve partial job results. +* **refresh** (`bool`) – If `True`, re-query the server for the result. Otherwise return the cached value. + +**Return type** + +`Optional`\[`Result`] + +**Returns** + +Job result or `None` if result could not be retrieved. + +**Raises** + +[**IBMQJobTimeoutError**](qiskit.providers.ibmq.job.IBMQJobTimeoutError "qiskit.providers.ibmq.job.IBMQJobTimeoutError") – If the job does not return results before a specified timeout. + +### status + + + +`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. + +**Return type** + +`Optional`\[`JobStatus`] + +**Returns** + +Current job status, or `None` if an error occurred. + +### submit + + + +`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. + +**Parameters** + +* **circuits** (`Union`\[`QuantumCircuit`, `Schedule`, `List`\[`Union`\[`QuantumCircuit`, `Schedule`]]]) – Circuits to run. +* **job\_name** (`str`) – Name of the job. +* **backend** (`IBMQBackend`) – Backend to execute the experiments on. +* **executor** (`ThreadPoolExecutor`) – The thread pool used to submit the job. +* **submit\_lock** (`allocate_lock`) – Lock used to synchronize job submission. +* **job\_share\_level** (`Optional`\[`ApiJobShareLevel`]) – Job share level. +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. +* **\*\*run\_config** – Extra arguments used to configure the run. + +**Return type** + +`None` + 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 cb8cdac9b1b..80baee65fb7 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 @@ -1,14 +1,22 @@ -# ManagedJobSet +--- +title: ManagedJobSet +description: API reference for qiskit.providers.ibmq.managed.ManagedJobSet +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.managed.ManagedJobSet +--- +# ManagedJobSet + -`ManagedJobSet(name=None, short_id=None)` +`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` A set of managed jobs. -An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager.run#qiskit.providers.ibmq.managed.IBMQJobManager.run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](qiskit.providers.ibmq.managed.ManagedJobSet.results#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](qiskit.providers.ibmq.managed.ManagedJobSet.cancel#qiskit.providers.ibmq.managed.ManagedJobSet.cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). +An instance of this class is returned when you submit experiments using [`IBMQJobManager.run()`](qiskit.providers.ibmq.managed.IBMQJobManager#run "qiskit.providers.ibmq.managed.IBMQJobManager.run"). It provides methods that allow you to interact with the jobs as a single entity. For example, you can retrieve the results for all of the jobs using [`results()`](qiskit.providers.ibmq.managed.ManagedJobSet#results "qiskit.providers.ibmq.managed.ManagedJobSet.results") and cancel all jobs using [`cancel()`](qiskit.providers.ibmq.managed.ManagedJobSet#cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel"). ManagedJobSet constructor. @@ -19,21 +27,351 @@ ManagedJobSet constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------- | -| [`cancel`](qiskit.providers.ibmq.managed.ManagedJobSet.cancel#qiskit.providers.ibmq.managed.ManagedJobSet.cancel "qiskit.providers.ibmq.managed.ManagedJobSet.cancel") | Cancel all jobs in this job set. | -| [`error_messages`](qiskit.providers.ibmq.managed.ManagedJobSet.error_messages#qiskit.providers.ibmq.managed.ManagedJobSet.error_messages "qiskit.providers.ibmq.managed.ManagedJobSet.error_messages") | Provide details about job failures. | -| [`job`](qiskit.providers.ibmq.managed.ManagedJobSet.job#qiskit.providers.ibmq.managed.ManagedJobSet.job "qiskit.providers.ibmq.managed.ManagedJobSet.job") | Retrieve the job used to submit the specified experiment and its index. | -| [`job_set_id`](qiskit.providers.ibmq.managed.ManagedJobSet.job_set_id#qiskit.providers.ibmq.managed.ManagedJobSet.job_set_id "qiskit.providers.ibmq.managed.ManagedJobSet.job_set_id") | Return the ID of this job set. | -| [`jobs`](qiskit.providers.ibmq.managed.ManagedJobSet.jobs#qiskit.providers.ibmq.managed.ManagedJobSet.jobs "qiskit.providers.ibmq.managed.ManagedJobSet.jobs") | Return jobs in this job set. | -| [`managed_jobs`](qiskit.providers.ibmq.managed.ManagedJobSet.managed_jobs#qiskit.providers.ibmq.managed.ManagedJobSet.managed_jobs "qiskit.providers.ibmq.managed.ManagedJobSet.managed_jobs") | Return the managed jobs in this set. | -| [`name`](qiskit.providers.ibmq.managed.ManagedJobSet.name#qiskit.providers.ibmq.managed.ManagedJobSet.name "qiskit.providers.ibmq.managed.ManagedJobSet.name") | Return the name of this job set. | -| [`qobjs`](qiskit.providers.ibmq.managed.ManagedJobSet.qobjs#qiskit.providers.ibmq.managed.ManagedJobSet.qobjs "qiskit.providers.ibmq.managed.ManagedJobSet.qobjs") | Return the Qobjs for the jobs in this set. | -| [`report`](qiskit.providers.ibmq.managed.ManagedJobSet.report#qiskit.providers.ibmq.managed.ManagedJobSet.report "qiskit.providers.ibmq.managed.ManagedJobSet.report") | Return a report on current job statuses. | -| [`results`](qiskit.providers.ibmq.managed.ManagedJobSet.results#qiskit.providers.ibmq.managed.ManagedJobSet.results "qiskit.providers.ibmq.managed.ManagedJobSet.results") | Return the results of the jobs. | -| [`retrieve_jobs`](qiskit.providers.ibmq.managed.ManagedJobSet.retrieve_jobs#qiskit.providers.ibmq.managed.ManagedJobSet.retrieve_jobs "qiskit.providers.ibmq.managed.ManagedJobSet.retrieve_jobs") | Retrieve previously submitted jobs in this set. | -| [`run`](qiskit.providers.ibmq.managed.ManagedJobSet.run#qiskit.providers.ibmq.managed.ManagedJobSet.run "qiskit.providers.ibmq.managed.ManagedJobSet.run") | Execute a list of circuits or pulse schedules on a backend. | -| [`statuses`](qiskit.providers.ibmq.managed.ManagedJobSet.statuses#qiskit.providers.ibmq.managed.ManagedJobSet.statuses "qiskit.providers.ibmq.managed.ManagedJobSet.statuses") | Return the status of each job in this set. | -| [`tags`](qiskit.providers.ibmq.managed.ManagedJobSet.tags#qiskit.providers.ibmq.managed.ManagedJobSet.tags "qiskit.providers.ibmq.managed.ManagedJobSet.tags") | Return the tags assigned to this job set. | -| [`update_name`](qiskit.providers.ibmq.managed.ManagedJobSet.update_name#qiskit.providers.ibmq.managed.ManagedJobSet.update_name "qiskit.providers.ibmq.managed.ManagedJobSet.update_name") | Update the name of this job set. | -| [`update_tags`](qiskit.providers.ibmq.managed.ManagedJobSet.update_tags#qiskit.providers.ibmq.managed.ManagedJobSet.update_tags "qiskit.providers.ibmq.managed.ManagedJobSet.update_tags") | Update the tags assigned to this job set. | +### cancel + + + +`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. + +**Return type** + +`None` + +### error\_messages + + + +`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. + +This call will block until all jobs finish. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +An error report if one or more jobs failed or `None` otherwise. + +### job + + + +`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. + +For example, if [`IBMQJobManager`](qiskit.providers.ibmq.managed.IBMQJobManager "qiskit.providers.ibmq.managed.IBMQJobManager") is used to submit 1000 experiments, and [`IBMQJobManager`](qiskit.providers.ibmq.managed.IBMQJobManager "qiskit.providers.ibmq.managed.IBMQJobManager") divides them into 2 jobs: job 1 has experiments 0-499, and job 2 has experiments 500-999. In this case `job_set.job(501)` will return `(job2, 1)`. + +**Parameters** + +**experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`, `int`]) – + +Retrieve the job used to submit this experiment. Several types are accepted for convenience: + +> * str: The name of the experiment. +> * QuantumCircuit: The name of the circuit instance will be used. +> * Schedule: The name of the schedule instance will be used. +> * int: The position of the experiment. + +**Return type** + +`Tuple`\[`Optional`\[`IBMQJob`], `int`] + +**Returns** + +A tuple of the job used to submit the experiment, or `None` if the job submit failed, and the experiment index. + +**Raises** + +[**IBMQJobManagerJobNotFound**](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound") – If the job for the experiment could not be found. + +### job\_set\_id + + + +`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. + +**Return type** + +`str` + +**Returns** + +ID of this job set. + +### jobs + + + +`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. + +**Return type** + +`List`\[`Optional`\[`IBMQJob`]] + +**Returns** + +A list of [`IBMQJob`](qiskit.providers.ibmq.job.IBMQJob "qiskit.providers.ibmq.job.IBMQJob") instances that represents the submitted jobs. An entry in the list is `None` if the job failed to be submitted. + +### managed\_jobs + + + +`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. + +**Return type** + +`List`\[`ManagedJob`] + +**Returns** + +A list of managed jobs. + +### name + + + +`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. + +**Return type** + +`str` + +**Returns** + +Name of this job set. + +### qobjs + + + +`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. + +**Return type** + +`List`\[`Union`\[`QasmQobj`, `PulseQobj`]] + +**Returns** + +A list of Qobjs for the jobs. An entry in the list is `None` if the Qobj could not be retrieved. + +### report + + + +`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. + +**Parameters** + +**detailed** (`bool`) – If `True`, return a detailed report. Otherwise return a summary report. + +**Return type** + +`str` + +**Returns** + +A report on job statuses. + +### results + + + +`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. + +This call will block until all job results become available or the timeout is reached. + + + Some IBM Quantum Experience job results can only be read once. A second attempt to query the server for the same job will fail, since the job has already been “consumed”. + + The first call to this method in a `ManagedJobSet` instance will query the server and consume any available job results. Subsequent calls to that instance’s method will also return the results, since they are cached. However, attempting to retrieve the results again in another instance or session might fail due to the job results having been consumed. + + + + When partial=True, this method will attempt to retrieve partial results of failed jobs. In this case, precaution should be taken when accessing individual experiments, as doing so might cause an exception. The `success` attribute of the returned [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.providers.ibmq.managed.ManagedResults") instance can be used to verify whether it contains partial results. + + For example, if one of the experiments failed, trying to get the counts of the unsuccessful experiment would raise an exception since there are no counts to return: + + ```python + try: + counts = managed_results.get_counts("failed_experiment") + except QiskitError: + print("Experiment failed!") + ``` + + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job results. +* **partial** (`bool`) – If `True`, attempt to retrieve partial job results. +* **refresh** (`bool`) – If `True`, re-query the server for the result. Otherwise return the cached value. + +**Return type** + +`ManagedResults` + +**Returns** + +A [`ManagedResults`](qiskit.providers.ibmq.managed.ManagedResults "qiskit.providers.ibmq.managed.ManagedResults") instance that can be used to retrieve results for individual experiments. + +**Raises** + +[**IBMQJobManagerTimeoutError**](qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError "qiskit.providers.ibmq.managed.IBMQJobManagerTimeoutError") – if unable to retrieve all job results before the specified timeout. + +### retrieve\_jobs + + + +`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. + +**Parameters** + +* **provider** (`AccountProvider`) – Provider used for this job set. +* **refresh** (`bool`) – If `True`, re-query the server for the job set. Otherwise return the cached value. + +**Raises** + +* [**IBMQJobManagerUnknownJobSet**](qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet "qiskit.providers.ibmq.managed.IBMQJobManagerUnknownJobSet") – If the job set cannot be found. +* [**IBMQJobManagerInvalidStateError**](qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError "qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError") – If jobs for this job set are found but have unexpected attributes. + +**Return type** + +`None` + +### run + + + +`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. + +**Parameters** + +* **experiment\_list** (`Union`\[`List`\[`List`\[`QuantumCircuit`]], `List`\[`List`\[`Schedule`]]]) – Circuit(s) or pulse schedule(s) to execute. +* **backend** (`IBMQBackend`) – Backend to execute the experiments on. +* **executor** (`ThreadPoolExecutor`) – The thread pool used to submit jobs asynchronously. +* **job\_share\_level** (`Optional`\[`ApiJobShareLevel`]) – Job share level. +* **job\_tags** (`Optional`\[`List`\[`str`]]) – Tags to be assigned to the job. +* **run\_config** (`Any`) – Additional arguments used to configure the Qobj assembly. Refer to the [`qiskit.compiler.assemble()`](qiskit.compiler.assemble "qiskit.compiler.assemble") documentation for details on these arguments. + +**Raises** + +[**IBMQJobManagerInvalidStateError**](qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError "qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError") – If the jobs were already submitted. + +**Return type** + +`None` + +### statuses + + + +`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. + +**Return type** + +`List`\[`Optional`\[`JobStatus`]] + +**Returns** + +A list of job statuses. An entry in the list is `None` if the job status could not be retrieved due to a server error. + +### tags + + + +`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. + +**Return type** + +`List`\[`str`] + +**Returns** + +Tags assigned to this job set. + +### update\_name + + + +`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. + +**Parameters** + +**name** (`str`) – The new name for this job set. + +**Return type** + +`str` + +**Returns** + +The new name associated with this job set. + +### update\_tags + + + +`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. + +When multiple parameters are specified, the parameters are processed in the following order: + +> 1. replacement\_tags +> 2. additional\_tags +> 3. removal\_tags + +For example, if ‘new\_tag’ is specified for both additional\_tags and removal\_tags, then it is added and subsequently removed from the tags list, making it a “do nothing” operation. + + + * Some tags, such as those starting with `ibmq_jobset`, are used internally by ibmq-provider and therefore cannot be modified. + * When removing tags, if the job does not have a specified tag, it will be ignored. + + +**Parameters** + +* **replacement\_tags** (`Optional`\[`List`\[`str`]]) – The tags that should replace the current tags associated with this job set. +* **additional\_tags** (`Optional`\[`List`\[`str`]]) – The new tags that should be added to the current tags associated with this job set. +* **removal\_tags** (`Optional`\[`List`\[`str`]]) – The tags that should be removed from the current tags associated with this job set. + +**Return type** + +`List`\[`str`] + +**Returns** + +The new tags associated with this job set. + +**Raises** + +[**IBMQJobManagerInvalidStateError**](qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError "qiskit.providers.ibmq.managed.IBMQJobManagerInvalidStateError") – If none of the input parameters are specified. + 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 979e000ca45..3591537cc7a 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 @@ -1,14 +1,22 @@ -# ManagedResults +--- +title: ManagedResults +description: API reference for qiskit.providers.ibmq.managed.ManagedResults +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.managed.ManagedResults +--- +# ManagedResults + -`ManagedResults(job_set, backend_name, success)` +`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` Results managed by the Job Manager. -This class is a wrapper around the [`Result`](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result") class for more information on the methods. +This class is a wrapper around the [`Result`](qiskit.result.Result "qiskit.result.Result") class and provides the same methods. Please refer to the [`Result`](qiskit.result.Result "qiskit.result.Result") class for more information on the methods. ManagedResults constructor. @@ -18,13 +26,13 @@ ManagedResults constructor. * **backend\_name** (`str`) – Name of the backend used to run the experiments. * **success** (`bool`) – `True` if all experiments were successful and results available. `False` otherwise. - + ### backend\_name Name of the backend used to run the experiments. - + ### success @@ -32,11 +40,163 @@ Whether all experiments were successful. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`combine_results`](qiskit.providers.ibmq.managed.ManagedResults.combine_results#qiskit.providers.ibmq.managed.ManagedResults.combine_results "qiskit.providers.ibmq.managed.ManagedResults.combine_results") | Combine results from all jobs into a single Result. | -| [`data`](qiskit.providers.ibmq.managed.ManagedResults.data#qiskit.providers.ibmq.managed.ManagedResults.data "qiskit.providers.ibmq.managed.ManagedResults.data") | Get the raw data for an experiment. | -| [`get_counts`](qiskit.providers.ibmq.managed.ManagedResults.get_counts#qiskit.providers.ibmq.managed.ManagedResults.get_counts "qiskit.providers.ibmq.managed.ManagedResults.get_counts") | Get the histogram data of an experiment. | -| [`get_memory`](qiskit.providers.ibmq.managed.ManagedResults.get_memory#qiskit.providers.ibmq.managed.ManagedResults.get_memory "qiskit.providers.ibmq.managed.ManagedResults.get_memory") | Get the sequence of memory states (readouts) for each shot. | -| [`get_statevector`](qiskit.providers.ibmq.managed.ManagedResults.get_statevector#qiskit.providers.ibmq.managed.ManagedResults.get_statevector "qiskit.providers.ibmq.managed.ManagedResults.get_statevector") | Get the final statevector of an experiment. | -| [`get_unitary`](qiskit.providers.ibmq.managed.ManagedResults.get_unitary#qiskit.providers.ibmq.managed.ManagedResults.get_unitary "qiskit.providers.ibmq.managed.ManagedResults.get_unitary") | Get the final unitary of an experiment. | +### combine\_results + + + +`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. + + + Since the order of the results must match the order of the initial experiments, job results can only be combined if all jobs succeeded. + + +**Return type** + +`Result` + +**Returns** + +**A [`Result`](qiskit.result.Result "qiskit.result.Result") object that contains results from** + +all jobs. + +**Raises** + +[**IBMQManagedResultDataNotAvailable**](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable") – If results cannot be combined because some jobs failed. + +### data + + + +`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. + +**Parameters** + +**experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`, `int`]) – + +Retrieve result for this experiment. Several types are accepted for convenience: + +> * str: The name of the experiment. +> * QuantumCircuit: The name of the circuit instance will be used. +> * Schedule: The name of the schedule instance will be used. +> * int: The position of the experiment. + +**Return type** + +`Dict` + +**Returns** + +Refer to the [`Result.data()`](qiskit.result.Result#data "qiskit.result.Result.data") for information on return data. + +**Raises** + +* [**IBMQManagedResultDataNotAvailable**](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable") – If data for the experiment could not be retrieved. +* [**IBMQJobManagerJobNotFound**](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound") – If the job for the experiment could not be found. + +### get\_counts + + + +`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. + +**Parameters** + +**experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`, `int`]) – Retrieve result for this experiment, as specified by [`data()`](qiskit.providers.ibmq.managed.ManagedResults#data "qiskit.providers.ibmq.managed.ManagedResults.data"). + +**Return type** + +`Dict`\[`str`, `int`] + +**Returns** + +Refer to the [`Result.get_counts()`](qiskit.result.Result#get_counts "qiskit.result.Result.get_counts") for information on return data. + +**Raises** + +* [**IBMQManagedResultDataNotAvailable**](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable") – If data for the experiment could not be retrieved. +* [**IBMQJobManagerJobNotFound**](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound") – If the job for the experiment could not be found. + +### get\_memory + + + +`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’] + +**Parameters** + +**experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`, `int`]) – Retrieve result for this experiment, as specified by [`data()`](qiskit.providers.ibmq.managed.ManagedResults#data "qiskit.providers.ibmq.managed.ManagedResults.data"). + +**Return type** + +`Union`\[`list`, `ndarray`] + +**Returns** + +Refer to the [`Result.get_memory()`](qiskit.result.Result#get_memory "qiskit.result.Result.get_memory") for information on return data. + +**Raises** + +* [**IBMQManagedResultDataNotAvailable**](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable") – If data for the experiment could not be retrieved. +* [**IBMQJobManagerJobNotFound**](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound") – If the job for the experiment could not be found. + +### get\_statevector + + + +`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. + +**Parameters** + +* **experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`, `int`]) – Retrieve result for this experiment, as specified by [`data()`](qiskit.providers.ibmq.managed.ManagedResults#data "qiskit.providers.ibmq.managed.ManagedResults.data"). +* **decimals** (`Optional`\[`int`]) – The number of decimals in the statevector. If `None`, skip rounding. + +**Return type** + +`List`\[`complex`] + +**Returns** + +Refer to the [`Result.get_statevector()`](qiskit.result.Result#get_statevector "qiskit.result.Result.get_statevector") for information on return data. + +**Raises** + +* [**IBMQManagedResultDataNotAvailable**](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable") – If data for the experiment could not be retrieved. +* [**IBMQJobManagerJobNotFound**](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound") – If the job for the experiment could not be found. + +### get\_unitary + + + +`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. + +**Parameters** + +* **experiment** (`Union`\[`str`, `QuantumCircuit`, `Schedule`, `int`]) – Retrieve result for this experiment, as specified by [`data()`](qiskit.providers.ibmq.managed.ManagedResults#data "qiskit.providers.ibmq.managed.ManagedResults.data"). +* **decimals** (`Optional`\[`int`]) – The number of decimals in the unitary. If `None`, skip rounding. + +**Return type** + +`List`\[`List`\[`complex`]] + +**Returns** + +Refer to the [`Result.get_unitary()`](qiskit.result.Result#get_unitary "qiskit.result.Result.get_unitary") for information on return data. + +**Raises** + +* [**IBMQManagedResultDataNotAvailable**](qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable "qiskit.providers.ibmq.managed.IBMQManagedResultDataNotAvailable") – If data for the experiment could not be retrieved. +* [**IBMQJobManagerJobNotFound**](qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound "qiskit.providers.ibmq.managed.IBMQJobManagerJobNotFound") – If the job for the experiment could not be found. + 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 36e9832432a..5298496e3cb 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 @@ -1,8 +1,16 @@ -# CQCExtractor +--- +title: CQCExtractor +description: API reference for qiskit.providers.ibmq.random.CQCExtractor +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.random.CQCExtractor +--- +# CQCExtractor + -`CQCExtractor(name, provider, client, methods)` +`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` @@ -37,9 +45,103 @@ BaseRandomService constructor. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------- | -| [`retrieve_job`](qiskit.providers.ibmq.random.CQCExtractor.retrieve_job#qiskit.providers.ibmq.random.CQCExtractor.retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") | Retrieve a previously submitted job. | -| [`run`](qiskit.providers.ibmq.random.CQCExtractor.run#qiskit.providers.ibmq.random.CQCExtractor.run "qiskit.providers.ibmq.random.CQCExtractor.run") | Process input data synchronously. | -| [`run_async_ext1`](qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1#qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1") | Run the first extractor asynchronously. | -| [`run_async_ext2`](qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2#qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2") | Run the second extractor asynchronously. | +### retrieve\_job + + + +`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. + +**Parameters** + +**job\_id** (`str`) – Job ID. + +**Return type** + +`CQCExtractorJob` + +**Returns** + +A `CQCExtractorJob` instance. + +### run + + + +`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. + +**Parameters** + +* **ext1\_input\_num\_bits** (`int`) – Number of input bits, for extractor 1. +* **ext1\_output\_num\_bits** (`int`) – Number of output bits, for extractor 1. +* **ext1\_raw\_bytes** (`bytes`) – Initial random numbers, in bytes, for extractor 1. +* **ext1\_wsr\_bytes** (`bytes`) – Initial WSRs, in bytes, for extractor 1. +* **ext2\_seed\_num\_bits** (`int`) – Number of bits in the seed, for extractor 2. +* **ext2\_wsr\_multiplier** (`int`) – WSR multiplier, for extractor 2. The number of bits used by extractor 2 is ext2\_seed\_num\_bits\*ext2\_wsr\_multiplier. +* **ext2\_wsr\_generator** (`Optional`\[`Callable`]) – WSR generator used for extractor 2. It must take the number of bits as the input and a list of random bits (0s and 1s) as the output. If `None`, :func:`generate_wsr` is used. + +**Return type** + +`List`\[`int`] + +**Returns** + +An instance of `CQCExtractorJob` which can be used to retrieve the results later. + +### run\_async\_ext1 + + + +`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. + +**Parameters** + +* **ext1\_input\_num\_bits** (`int`) – Number of input bits, for extractor 1. +* **ext1\_output\_num\_bits** (`int`) – Number of output bits, for extractor 1. +* **ext1\_raw\_bytes** (`bytes`) – Initial random numbers, in bytes, for extractor 1. +* **ext1\_wsr\_bytes** (`bytes`) – Initial WSRs, in bytes, for extractor 1. + +**Return type** + +`CQCExtractorJob` + +**Returns** + +An instance of `CQCExtractorJob` which can be used to retrieve the results later. + +**Raises** + +**ValueError** – If an invalid argument values are specified. + +### run\_async\_ext2 + + + +`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. + +**Parameters** + +* **ext2\_seed** (`List`\[`int`]) – Seed used for extractor 2, such as the output of extractor 1. +* **ext2\_seed\_num\_bits** (`int`) – Number of bits in the seed, for extractor 2. +* **ext2\_wsr\_multiplier** (`int`) – WSR multiplier, for extractor 2. The number of bits used by extractor 2 is ext2\_seed\_num\_bits\*ext2\_wsr\_multiplier. +* **ext2\_wsr\_generator** (`Optional`\[`Callable`]) – WSR generator used for extractor 2. It must take the number of bits as the input and a list of random bits (0s and 1s) as the output. If `None`, :func:`generate_wsr` is used. + +**Return type** + +`CQCExtractorJob` + +**Returns** + +An instance of `CQCExtractorJob` which can be used to retrieve the results later. + +**Raises** + +**ValueError** – If an invalid argument values are specified. + 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 77e4f6c657c..1641499d8ce 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 @@ -1,18 +1,26 @@ -# CQCExtractorJob +--- +title: CQCExtractorJob +description: API reference for qiskit.providers.ibmq.random.CQCExtractorJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.random.CQCExtractorJob +--- +# CQCExtractorJob + -`CQCExtractorJob(job_id, client, parameters=None)` +`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` Representation of an asynchronous call to the CQC extractor. -An instance of this class is returned when you call [`run_async_ext1()`](qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1#qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1"), [`run_async_ext2()`](qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2#qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2"), or [`retrieve_job()`](qiskit.providers.ibmq.random.CQCExtractor.retrieve_job#qiskit.providers.ibmq.random.CQCExtractor.retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") method of the [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor#qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor") class. +An instance of this class is returned when you call [`run_async_ext1()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext1 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext1"), [`run_async_ext2()`](qiskit.providers.ibmq.random.CQCExtractor#run_async_ext2 "qiskit.providers.ibmq.random.CQCExtractor.run_async_ext2"), or [`retrieve_job()`](qiskit.providers.ibmq.random.CQCExtractor#retrieve_job "qiskit.providers.ibmq.random.CQCExtractor.retrieve_job") method of the [`CQCExtractor`](qiskit.providers.ibmq.random.CQCExtractor "qiskit.providers.ibmq.random.CQCExtractor") class. -If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](qiskit.providers.ibmq.random.CQCExtractorJob.status#qiskit.providers.ibmq.random.CQCExtractorJob.status "qiskit.providers.ibmq.random.CQCExtractorJob.status"). +If the job is successfully submitted, you can inspect the job’s status by calling [`status()`](qiskit.providers.ibmq.random.CQCExtractorJob#status "qiskit.providers.ibmq.random.CQCExtractorJob.status"). -Some of the methods in this class are blocking, which means control may not be returned immediately. [`block_until_ready()`](qiskit.providers.ibmq.random.CQCExtractorJob.block_until_ready#qiskit.providers.ibmq.random.CQCExtractorJob.block_until_ready "qiskit.providers.ibmq.random.CQCExtractorJob.block_until_ready") is an example of a blocking method, which waits until the job completes: +Some of the methods in this class are blocking, which means control may not be returned immediately. [`block_until_ready()`](qiskit.providers.ibmq.random.CQCExtractorJob#block_until_ready "qiskit.providers.ibmq.random.CQCExtractorJob.block_until_ready") is an example of a blocking method, which waits until the job completes: ```python job = extractor.run_async_ext1(...) @@ -33,14 +41,50 @@ CQCExtractorJob constructor. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| [`block_until_ready`](qiskit.providers.ibmq.random.CQCExtractorJob.block_until_ready#qiskit.providers.ibmq.random.CQCExtractorJob.block_until_ready "qiskit.providers.ibmq.random.CQCExtractorJob.block_until_ready") | Wait for the job to finish and return the result. | -| [`status`](qiskit.providers.ibmq.random.CQCExtractorJob.status#qiskit.providers.ibmq.random.CQCExtractorJob.status "qiskit.providers.ibmq.random.CQCExtractorJob.status") | Query the server for the latest job status. | +### block\_until\_ready -## Attributes + + +`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. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. +* **wait** (`float`) – Seconds between queries. Use a larger number if the job is expected to run for a long time. + +**Return type** + +`List`\[`int`] + +**Returns** + +Extractor output. + +**Raises** +[**JobTimeoutError**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not finish before the specified timeout. +### status + + + +`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. + +**Return type** + +`JobStatus` + +**Returns** + +The status of the job. + +## Attributes + + ### extractor\_method @@ -54,7 +98,7 @@ Return the extractor method used. Extractor method used. - + ### parameters @@ -67,3 +111,4 @@ Return the parameters passed to the extractor. **Returns** Parameters passed to the extractor. + 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 959cfcbef42..abc92c11bae 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 @@ -1,14 +1,22 @@ -# IBMQRandomService +--- +title: IBMQRandomService +description: API reference for qiskit.providers.ibmq.random.IBMQRandomService +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.random.IBMQRandomService +--- +# IBMQRandomService + -`IBMQRandomService(provider)` +`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` Random number services for an IBM Quantum Experience account provider. -Represent a namespace for random number services available to this provider. An instance of this class is used as an attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider#qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all services or to access a specific one: +Represent a namespace for random number services available to this provider. An instance of this class is used as an attribute to the [`AccountProvider`](qiskit.providers.ibmq.AccountProvider "qiskit.providers.ibmq.AccountProvider") class. This allows a convenient way to query for all services or to access a specific one: ```python random_services = provider.random.services() @@ -24,7 +32,39 @@ IBMQRandomService constructor. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`get_service`](qiskit.providers.ibmq.random.IBMQRandomService.get_service#qiskit.providers.ibmq.random.IBMQRandomService.get_service "qiskit.providers.ibmq.random.IBMQRandomService.get_service") | Return the random number service with the given name. | -| [`services`](qiskit.providers.ibmq.random.IBMQRandomService.services#qiskit.providers.ibmq.random.IBMQRandomService.services "qiskit.providers.ibmq.random.IBMQRandomService.services") | Return all random number services available to this account. | +### get\_service + + + +`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. + +**Parameters** + +**name** (`str`) – Name of the service. + +**Return type** + +`BaseRandomService` + +**Returns** + +Service with the given name. + +**Raises** + +[**IBMQError**](qiskit.providers.ibmq.IBMQError "qiskit.providers.ibmq.IBMQError") – If the service cannot be found. + +### services + + + +`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. + +**Return type** + +`List`\[`BaseRandomService`] + 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 4fee2de6535..0cb641d0679 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 @@ -1,8 +1,16 @@ -# IBMRuntimeService +--- +title: IBMRuntimeService +description: API reference for qiskit.providers.ibmq.runtime.IBMRuntimeService +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.IBMRuntimeService +--- +# IBMRuntimeService + -`IBMRuntimeService(provider)` +`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` @@ -47,9 +55,9 @@ job = provider.runtime.run(program_id="circuit-runner", result = job.result(decoder=RunnerResult) ``` -If the program has any interim results, you can use the `callback` parameter of the [`run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to stream the interim results. Alternatively, you can use the [`RuntimeJob.stream_results()`](qiskit.providers.ibmq.runtime.RuntimeJob.stream_results#qiskit.providers.ibmq.runtime.RuntimeJob.stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. +If the program has any interim results, you can use the `callback` parameter of the [`run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to stream the interim results. Alternatively, you can use the [`RuntimeJob.stream_results()`](qiskit.providers.ibmq.runtime.RuntimeJob#stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. -The [`run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method returns a [`RuntimeJob`](qiskit.providers.ibmq.runtime.RuntimeJob#qiskit.providers.ibmq.runtime.RuntimeJob "qiskit.providers.ibmq.runtime.RuntimeJob") object. You can use its methods to perform tasks like checking job status, getting job result, and canceling job. +The [`run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method returns a [`RuntimeJob`](qiskit.providers.ibmq.runtime.RuntimeJob "qiskit.providers.ibmq.runtime.RuntimeJob") object. You can use its methods to perform tasks like checking job status, getting job result, and canceling job. IBMRuntimeService constructor. @@ -59,17 +67,338 @@ IBMRuntimeService constructor. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -| [`delete_job`](qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_job#qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_job "qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_job") | Delete a runtime job. | -| [`delete_program`](qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_program#qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.delete_program") | Delete a runtime program. | -| [`job`](qiskit.providers.ibmq.runtime.IBMRuntimeService.job#qiskit.providers.ibmq.runtime.IBMRuntimeService.job "qiskit.providers.ibmq.runtime.IBMRuntimeService.job") | Retrieve a runtime job. | -| [`jobs`](qiskit.providers.ibmq.runtime.IBMRuntimeService.jobs#qiskit.providers.ibmq.runtime.IBMRuntimeService.jobs "qiskit.providers.ibmq.runtime.IBMRuntimeService.jobs") | Retrieve all runtime jobs, subject to optional filtering. | -| [`logout`](qiskit.providers.ibmq.runtime.IBMRuntimeService.logout#qiskit.providers.ibmq.runtime.IBMRuntimeService.logout "qiskit.providers.ibmq.runtime.IBMRuntimeService.logout") | Clears authorization cache on the server. | -| [`pprint_programs`](qiskit.providers.ibmq.runtime.IBMRuntimeService.pprint_programs#qiskit.providers.ibmq.runtime.IBMRuntimeService.pprint_programs "qiskit.providers.ibmq.runtime.IBMRuntimeService.pprint_programs") | Pretty print information about available runtime programs. | -| [`program`](qiskit.providers.ibmq.runtime.IBMRuntimeService.program#qiskit.providers.ibmq.runtime.IBMRuntimeService.program "qiskit.providers.ibmq.runtime.IBMRuntimeService.program") | Retrieve a runtime program. | -| [`programs`](qiskit.providers.ibmq.runtime.IBMRuntimeService.programs#qiskit.providers.ibmq.runtime.IBMRuntimeService.programs "qiskit.providers.ibmq.runtime.IBMRuntimeService.programs") | Return available runtime programs. | -| [`run`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") | Execute the runtime program. | -| [`set_program_visibility`](qiskit.providers.ibmq.runtime.IBMRuntimeService.set_program_visibility#qiskit.providers.ibmq.runtime.IBMRuntimeService.set_program_visibility "qiskit.providers.ibmq.runtime.IBMRuntimeService.set_program_visibility") | Sets a program’s visibility. | -| [`update_program`](qiskit.providers.ibmq.runtime.IBMRuntimeService.update_program#qiskit.providers.ibmq.runtime.IBMRuntimeService.update_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.update_program") | Update a runtime program. | -| [`upload_program`](qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program#qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program "qiskit.providers.ibmq.runtime.IBMRuntimeService.upload_program") | Upload a runtime program. | +### delete\_job + + + +`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. + +Note that this operation cannot be reversed. + +**Parameters** + +**job\_id** (`str`) – ID of the job to delete. + +**Raises** + +* **RuntimeJobNotFound** – If the job doesn’t exist. +* **QiskitRuntimeError** – If the request failed. + +**Return type** + +`None` + +### delete\_program + + + +`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. + +**Parameters** + +**program\_id** (`str`) – Program ID. + +**Raises** + +* **RuntimeProgramNotFound** – If the program doesn’t exist. +* **QiskitRuntimeError** – If the request failed. + +**Return type** + +`None` + +### job + + + +`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. + +**Parameters** + +**job\_id** (`str`) – Job ID. + +**Return type** + +`RuntimeJob` + +**Returns** + +Runtime job retrieved. + +**Raises** + +* **RuntimeJobNotFound** – If the job doesn’t exist. +* **QiskitRuntimeError** – If the request failed. + +### jobs + + + +`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. + +**Parameters** + +* **limit** (`Optional`\[`int`]) – Number of jobs to retrieve. `None` means no limit. +* **skip** (`int`) – Starting index for the job retrieval. +* **pending** (`Optional`\[`bool`]) – Filter by job pending state. If `True`, ‘QUEUED’ and ‘RUNNING’ jobs are included. If `False`, ‘DONE’, ‘CANCELLED’ and ‘ERROR’ jobs are included. +* **program\_id** (`Optional`\[`str`]) – Filter by Program ID. + +**Return type** + +`List`\[`RuntimeJob`] + +**Returns** + +A list of runtime jobs. + +### logout + + + +`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. + +For better performance, the runtime server caches each user’s authorization information. This method is used to force the server to clear its cache. + + + Invoke this method ONLY when your access level to the runtime service has changed - for example, the first time your account is given the authority to upload a program. + + +**Return type** + +`None` + +### pprint\_programs + + + +`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. + +**Parameters** + +* **refresh** (`bool`) – If `True`, re-query the server for the programs. Otherwise return the cached value. +* **detailed** (`bool`) – If `True` print all details about available runtime programs. +* **limit** (`int`) – The number of programs returned at a time. Default and maximum value of 20. +* **skip** (`int`) – The number of programs to skip. + +**Return type** + +`None` + +### program + + + +`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. + +Currently only program metadata is returned. + +**Parameters** + +* **program\_id** (`str`) – Program ID. +* **refresh** (`bool`) – If `True`, re-query the server for the program. Otherwise return the cached value. + +**Return type** + +`RuntimeProgram` + +**Returns** + +Runtime program. + +**Raises** + +* **RuntimeProgramNotFound** – If the program does not exist. +* **QiskitRuntimeError** – If the request failed. + +### programs + + + +`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. + +Currently only program metadata is returned. + +**Parameters** + +* **refresh** (`bool`) – If `True`, re-query the server for the programs. Otherwise return the cached value. +* **limit** (`int`) – The number of programs returned at a time. `None` means no limit. +* **skip** (`int`) – The number of programs to skip. + +**Return type** + +`List`\[`RuntimeProgram`] + +**Returns** + +A list of runtime programs. + +### run + + + +`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. + +**Parameters** + +* **program\_id** (`str`) – Program ID. + +* **options** (`Dict`) – Runtime options that control the execution environment. Currently the only available option is `backend_name`, which is required. + +* **inputs** (`Union`\[`Dict`, `ParameterNamespace`]) – Program input parameters. These input values are passed to the runtime program. + +* **callback** (`Optional`\[`Callable`]) – + + Callback function to be invoked for any interim results. The callback function will receive 2 positional parameters: + + > 1. Job ID + > 2. Job interim result. + +* **result\_decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A [`ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.ResultDecoder") subclass used to decode job results. `ResultDecoder` is used if not specified. + +* **image** (`Optional`\[`str`]) – The runtime image used to execute the program, specified in the form of image\_name:tag. Not all accounts are authorized to select a different image. + +**Return type** + +`RuntimeJob` + +**Returns** + +A `RuntimeJob` instance representing the execution. + +**Raises** + +**IBMQInputValueError** – If input is invalid. + +### set\_program\_visibility + + + +`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. + +**Parameters** + +* **program\_id** (`str`) – Program ID. +* **public** (`bool`) – If `True`, make the program visible to all. If `False`, make the program visible to just your account. + +**Raises** + +* **RuntimeJobNotFound** – if program not found (404) +* **QiskitRuntimeError** – if update failed (401, 403) + +**Return type** + +`None` + +### update\_program + + + +`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. + +Program metadata can be specified using the metadata parameter or individual parameters, such as name and description. If the same metadata field is specified in both places, the individual parameter takes precedence. + +**Parameters** + +* **program\_id** (`str`) – Program ID. +* **data** (`Optional`\[`str`]) – Program data or path of the file containing program data to upload. +* **metadata** (`Union`\[`Dict`, `str`, `None`]) – Name of the program metadata file or metadata dictionary. +* **name** (`Optional`\[`str`]) – New program name. +* **description** (`Optional`\[`str`]) – New program description. +* **max\_execution\_time** (`Optional`\[`int`]) – New maximum execution time. +* **spec** (`Optional`\[`Dict`]) – New specifications for backend characteristics, input parameters, interim results and final result. + +**Raises** + +* **RuntimeProgramNotFound** – If the program doesn’t exist. +* **QiskitRuntimeError** – If the request failed. + +**Return type** + +`None` + +### upload\_program + + + +`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. + +In addition to program data, the following program metadata is also required: + +> * name +> * max\_execution\_time +> * description + +Program metadata can be specified using the metadata parameter or individual parameter (for example, name and description). If the same metadata field is specified in both places, the individual parameter takes precedence. For example, if you specify: + +```python +upload_program(metadata={"name": "name1"}, name="name2") +``` + +`name2` will be used as the program name. + +**Parameters** + +* **data** (`str`) – Program data or path of the file containing program data to upload. + +* **metadata** (`Union`\[`Dict`, `str`, `None`]) – + + Name of the program metadata file or metadata dictionary. A metadata file needs to be in the JSON format. The `parameters`, `return_values`, and `interim_results` should be defined as JSON Schema. See `program/program_metadata_sample.json` for an example. The fields in metadata are explained below. + + * name: Name of the program. Required. + + * max\_execution\_time: Maximum execution time in seconds. Required. + + * description: Program description. Required. + + * **is\_public: Whether the runtime program should be visible to the public.** + + The default is `False`. + + * **spec: Specifications for backend characteristics and input parameters** + + required to run the program, interim results and final result. + + * backend\_requirements: Backend requirements. + * parameters: Program input parameters in JSON schema format. + * return\_values: Program return values in JSON schema format. + * interim\_results: Program interim results in JSON schema format. + +**Return type** + +`str` + +**Returns** + +Program ID. + +**Raises** + +* **IBMQInputValueError** – If required metadata is missing. +* **RuntimeDuplicateProgramError** – If a program with the same name already exists. +* **IBMQNotAuthorizedError** – If you are not authorized to upload programs. +* **QiskitRuntimeError** – If the upload failed. + 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 7cc58148ebf..f7097ba33fc 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 @@ -1,8 +1,16 @@ -# ParameterNamespace +--- +title: ParameterNamespace +description: API reference for qiskit.providers.ibmq.runtime.ParameterNamespace +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.ParameterNamespace +--- +# ParameterNamespace + -`ParameterNamespace(parameters)` +`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` @@ -18,13 +26,29 @@ ParameterNamespace constructor. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`validate`](qiskit.providers.ibmq.runtime.ParameterNamespace.validate#qiskit.providers.ibmq.runtime.ParameterNamespace.validate "qiskit.providers.ibmq.runtime.ParameterNamespace.validate") | Validate program input values. | +### validate -## Attributes + + +`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. + + This method only verifies that required parameters have values. It does not fail the validation if the namespace has extraneous parameters. + + +**Raises** + +**IBMQInputValueError** – if validation fails + +**Return type** + +`None` + +## Attributes + + ### metadata @@ -33,3 +57,4 @@ Returns the parameter metadata **Return type** `Dict` + 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 4bad787bee6..5a29db09af8 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 @@ -1,21 +1,29 @@ -# ProgramBackend +--- +title: ProgramBackend +description: API reference for qiskit.providers.ibmq.runtime.ProgramBackend +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.ProgramBackend +--- +# ProgramBackend + -`ProgramBackend(configuration, provider=None, **fields)` +`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` Base class for a program backend. -This is a [`Backend`](qiskit.providers.Backend#qiskit.providers.Backend "qiskit.providers.Backend") class for runtime programs to submit circuits. +This is a [`Backend`](qiskit.providers.Backend "qiskit.providers.Backend") class for runtime programs to submit circuits. Initialize a backend class **Parameters** -* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration#qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. -* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider#qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. +* **configuration** ([*BackendConfiguration*](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration")) – A backend configuration object for the backend object. +* **provider** ([*qiskit.providers.Provider*](qiskit.providers.Provider "qiskit.providers.Provider")) – Optionally, the provider object that this Backend comes from. * **fields** – kwargs for the values to use to override the default options. **Raises** @@ -24,13 +32,15 @@ Initialize a backend class In addition to the public abstract methods, subclasses should also implement the following private methods: +### \_default\_options + `abstract classmethod _default_options()` Return the default options -This method will return a [`qiskit.providers.Options`](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. +This method will return a [`qiskit.providers.Options`](qiskit.providers.Options "qiskit.providers.Options") subclass object that will be used for the default options. These should be the default parameters to use for the options of the backend. **Returns** @@ -40,32 +50,151 @@ default values set **Return type** -[qiskit.providers.Options](qiskit.providers.Options#qiskit.providers.Options "qiskit.providers.Options") +[qiskit.providers.Options](qiskit.providers.Options "qiskit.providers.Options") ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`configuration`](qiskit.providers.ibmq.runtime.ProgramBackend.configuration#qiskit.providers.ibmq.runtime.ProgramBackend.configuration "qiskit.providers.ibmq.runtime.ProgramBackend.configuration") | Return the backend configuration. | -| [`name`](qiskit.providers.ibmq.runtime.ProgramBackend.name#qiskit.providers.ibmq.runtime.ProgramBackend.name "qiskit.providers.ibmq.runtime.ProgramBackend.name") | Return the backend name. | -| [`properties`](qiskit.providers.ibmq.runtime.ProgramBackend.properties#qiskit.providers.ibmq.runtime.ProgramBackend.properties "qiskit.providers.ibmq.runtime.ProgramBackend.properties") | Return the backend properties. | -| [`provider`](qiskit.providers.ibmq.runtime.ProgramBackend.provider#qiskit.providers.ibmq.runtime.ProgramBackend.provider "qiskit.providers.ibmq.runtime.ProgramBackend.provider") | Return the backend Provider. | -| [`run`](qiskit.providers.ibmq.runtime.ProgramBackend.run#qiskit.providers.ibmq.runtime.ProgramBackend.run "qiskit.providers.ibmq.runtime.ProgramBackend.run") | Run on the backend. | -| [`set_options`](qiskit.providers.ibmq.runtime.ProgramBackend.set_options#qiskit.providers.ibmq.runtime.ProgramBackend.set_options "qiskit.providers.ibmq.runtime.ProgramBackend.set_options") | Set the options fields for the backend | -| [`status`](qiskit.providers.ibmq.runtime.ProgramBackend.status#qiskit.providers.ibmq.runtime.ProgramBackend.status "qiskit.providers.ibmq.runtime.ProgramBackend.status") | Return the backend status. | +### configuration -## Attributes + + +`ProgramBackend.configuration()` + +Return the backend configuration. + +**Returns** + +the configuration for the backend. + +**Return type** + +[BackendConfiguration](qiskit.providers.models.BackendConfiguration "qiskit.providers.models.BackendConfiguration") + +### name + + + +`ProgramBackend.name()` + +Return the backend name. + +**Returns** + +the name of the backend. + +**Return type** + +str + +### properties + + + +`ProgramBackend.properties()` + +Return the backend properties. + +**Returns** + +the configuration for the backend. If the backend does not support properties, it returns `None`. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### provider + + + +`ProgramBackend.provider()` + +Return the backend Provider. + +**Returns** + +the Provider responsible for the backend. + +**Return type** + +[Provider](qiskit.providers.Provider "qiskit.providers.Provider") +### run + + +`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. + +Runtime circuit execution is synchronous, and control will not go back until the execution finishes. You can use the timeout parameter to set a timeout value to wait for the execution to finish. Note that if the execution times out, circuit execution results will not be available. + +**Parameters** + +* **circuits** (`Union`\[`QasmQobj`, `PulseQobj`, `QuantumCircuit`, `Schedule`, `List`\[`Union`\[`QuantumCircuit`, `Schedule`]]]) – An individual or a list of `QuantumCircuit` or [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") objects to run on the backend. A [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj") or a [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj") object is also supported but is deprecated. +* **timeout** (`Optional`\[`int`]) – Seconds to wait for circuit execution to finish. +* **\*\*run\_config** – Extra arguments used to configure the run. + +**Return type** + +`JobV1` + +**Returns** + +The job to be executed. + +**Raises** + +* [**IBMQBackendApiError**](qiskit.providers.ibmq.IBMQBackendApiError "qiskit.providers.ibmq.IBMQBackendApiError") – If an unexpected error occurred while submitting the job. +* [**IBMQBackendApiProtocolError**](qiskit.providers.ibmq.IBMQBackendApiProtocolError "qiskit.providers.ibmq.IBMQBackendApiProtocolError") – If an unexpected value received from the server. +* [**IBMQBackendValueError**](qiskit.providers.ibmq.IBMQBackendValueError "qiskit.providers.ibmq.IBMQBackendValueError") – If an input parameter value is not valid. + +### set\_options + + + +`ProgramBackend.set_options(**fields)` + +Set the options fields for the backend + +This method is used to update the options of a backend. If you need to change any of the options prior to running just pass in the kwarg with the new value for the options. + +**Parameters** + +**fields** – The fields to update the options + +**Raises** + +**AttributeError** – If the field passed in is not part of the options + +### status + + + +`ProgramBackend.status()` + +Return the backend status. + +**Returns** + +the status of the backend. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +## Attributes + + ### options Return the options for the backend -The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.ibmq.runtime.ProgramBackend.run#qiskit.providers.ibmq.runtime.ProgramBackend.run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method. - +The options of a backend are the dynamic parameters defining how the backend is used. These are used to control the [`run()`](qiskit.providers.ibmq.runtime.ProgramBackend#run "qiskit.providers.ibmq.runtime.ProgramBackend.run") method. + ### version `= 1` + 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 e0fc40d527d..9cdaa136c33 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 @@ -1,14 +1,22 @@ -# ResultDecoder +--- +title: ResultDecoder +description: API reference for qiskit.providers.ibmq.runtime.ResultDecoder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.ResultDecoder +--- +# ResultDecoder + -`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") Bases: `object` Runtime job result decoder. -You can subclass this class and overwrite the [`decode()`](qiskit.providers.ibmq.runtime.ResultDecoder.decode#qiskit.providers.ibmq.runtime.ResultDecoder.decode "qiskit.providers.ibmq.runtime.ResultDecoder.decode") method to create a custom result decoder for the results of your runtime program. For example: +You can subclass this class and overwrite the [`decode()`](qiskit.providers.ibmq.runtime.ResultDecoder#decode "qiskit.providers.ibmq.runtime.ResultDecoder.decode") method to create a custom result decoder for the results of your runtime program. For example: ```python class MyResultDecoder(ResultDecoder): @@ -19,10 +27,27 @@ class MyResultDecoder(ResultDecoder): custom_processing(decoded) # perform custom processing ``` -Users of your program will need to pass in the subclass when invoking [`qiskit.providers.ibmq.runtime.RuntimeJob.result()`](qiskit.providers.ibmq.runtime.RuntimeJob.result#qiskit.providers.ibmq.runtime.RuntimeJob.result "qiskit.providers.ibmq.runtime.RuntimeJob.result") or [`qiskit.providers.ibmq.runtime.IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run"). +Users of your program will need to pass in the subclass when invoking [`qiskit.providers.ibmq.runtime.RuntimeJob.result()`](qiskit.providers.ibmq.runtime.RuntimeJob#result "qiskit.providers.ibmq.runtime.RuntimeJob.result") or [`qiskit.providers.ibmq.runtime.IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run"). ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -| [`decode`](qiskit.providers.ibmq.runtime.ResultDecoder.decode#qiskit.providers.ibmq.runtime.ResultDecoder.decode "qiskit.providers.ibmq.runtime.ResultDecoder.decode") | Decode the result data. | +### decode + + + +`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. + +**Parameters** + +**data** (`str`) – Result data to be decoded. + +**Return type** + +`Any` + +**Returns** + +Decoded 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 4888a8a7daa..a2dd9a65d86 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 @@ -1,8 +1,16 @@ -# RuntimeDecoder +--- +title: RuntimeDecoder +description: API reference for qiskit.providers.ibmq.runtime.RuntimeDecoder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.RuntimeDecoder +--- +# RuntimeDecoder + -`RuntimeDecoder(*args, **kwargs)` +`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` @@ -22,8 +30,33 @@ If `strict` is false (true is the default), then control characters will be allo ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`decode`](qiskit.providers.ibmq.runtime.RuntimeDecoder.decode#qiskit.providers.ibmq.runtime.RuntimeDecoder.decode "qiskit.providers.ibmq.runtime.RuntimeDecoder.decode") | Return the Python representation of `s` (a `str` instance containing a JSON document). | -| [`object_hook`](qiskit.providers.ibmq.runtime.RuntimeDecoder.object_hook#qiskit.providers.ibmq.runtime.RuntimeDecoder.object_hook "qiskit.providers.ibmq.runtime.RuntimeDecoder.object_hook") | Called to decode object. | -| [`raw_decode`](qiskit.providers.ibmq.runtime.RuntimeDecoder.raw_decode#qiskit.providers.ibmq.runtime.RuntimeDecoder.raw_decode "qiskit.providers.ibmq.runtime.RuntimeDecoder.raw_decode") | Decode a JSON document from `s` (a `str` beginning with a JSON document) and return a 2-tuple of the Python representation and the index in `s` where the document ended. | +### decode + + + +`RuntimeDecoder.decode(s, _w=)` + +Return the Python representation of `s` (a `str` instance containing a JSON document). + +### object\_hook + + + +`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. + +**Return type** + +`Any` + +### raw\_decode + + + +`RuntimeDecoder.raw_decode(s, idx=0)` + +Decode a JSON document from `s` (a `str` beginning with a JSON document) and return a 2-tuple of the Python representation and the index in `s` where the document ended. + +This can be used to decode a JSON document from a string that may have extraneous data at the end. + 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 c36021e7c1b..3d72c67da6c 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 @@ -1,8 +1,16 @@ -# RuntimeEncoder +--- +title: RuntimeEncoder +description: API reference for qiskit.providers.ibmq.runtime.RuntimeEncoder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.RuntimeEncoder +--- +# RuntimeEncoder + -`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)` +`RuntimeEncoder(*, skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/utils.py "view source code") Bases: `json.encoder.JSONEncoder` @@ -28,24 +36,74 @@ If specified, default is a function that gets called for objects that can’t ot ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`default`](qiskit.providers.ibmq.runtime.RuntimeEncoder.default#qiskit.providers.ibmq.runtime.RuntimeEncoder.default "qiskit.providers.ibmq.runtime.RuntimeEncoder.default") | Implement this method in a subclass such that it returns a serializable object for `o`, or calls the base implementation (to raise a `TypeError`). | -| [`encode`](qiskit.providers.ibmq.runtime.RuntimeEncoder.encode#qiskit.providers.ibmq.runtime.RuntimeEncoder.encode "qiskit.providers.ibmq.runtime.RuntimeEncoder.encode") | Return a JSON string representation of a Python data structure. | -| [`iterencode`](qiskit.providers.ibmq.runtime.RuntimeEncoder.iterencode#qiskit.providers.ibmq.runtime.RuntimeEncoder.iterencode "qiskit.providers.ibmq.runtime.RuntimeEncoder.iterencode") | Encode the given object and yield each string representation as available. | +### default -## Attributes + + +`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`). + +For example, to support arbitrary iterators, you could implement default like this: + +```python +def default(self, o): + try: + iterable = iter(o) + except TypeError: + pass + else: + return list(iterable) + # Let the base class default method raise the TypeError + return JSONEncoder.default(self, o) +``` + +**Return type** + +`Any` + +### encode + + + +`RuntimeEncoder.encode(o)` +Return a JSON string representation of a Python data structure. +```python +>>> from json.encoder import JSONEncoder +>>> JSONEncoder().encode({"foo": ["bar", "baz"]}) +'{"foo": ["bar", "baz"]}' +``` + +### iterencode + + + +`RuntimeEncoder.iterencode(o, _one_shot=False)` + +Encode the given object and yield each string representation as available. + +For example: + +```python +for chunk in JSONEncoder().iterencode(bigobject): + mysocket.write(chunk) +``` + +## Attributes + + ### item\_separator `= ', '` - + ### key\_separator = ' `= ':` `= ': '` + 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 8d0faf95600..98706a664ff 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 @@ -1,18 +1,26 @@ -# RuntimeJob +--- +title: RuntimeJob +description: API reference for qiskit.providers.ibmq.runtime.RuntimeJob +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.RuntimeJob +--- +# RuntimeJob + -`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')` +`RuntimeJob(backend, api_client, credentials, job_id, program_id, params=None, creation_date=None, user_callback=None, result_decoder=, image='')`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_job.py "view source code") Bases: `object` Representation of a runtime program execution. -A new `RuntimeJob` instance is returned when you call [`IBMRuntimeService.run`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") to execute a runtime program, or [`IBMRuntimeService.job`](qiskit.providers.ibmq.runtime.IBMRuntimeService.job#qiskit.providers.ibmq.runtime.IBMRuntimeService.job "qiskit.providers.ibmq.runtime.IBMRuntimeService.job") to retrieve a previously executed job. +A new `RuntimeJob` instance is returned when you call [`IBMRuntimeService.run`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") to execute a runtime program, or [`IBMRuntimeService.job`](qiskit.providers.ibmq.runtime.IBMRuntimeService#job "qiskit.providers.ibmq.runtime.IBMRuntimeService.job") to retrieve a previously executed job. -If the program execution is successful, you can inspect the job’s status by calling [`status()`](qiskit.providers.ibmq.runtime.RuntimeJob.status#qiskit.providers.ibmq.runtime.RuntimeJob.status "qiskit.providers.ibmq.runtime.RuntimeJob.status"). Job status can be one of the [`JobStatus`](qiskit.providers.JobStatus#qiskit.providers.JobStatus "qiskit.providers.JobStatus") members. +If the program execution is successful, you can inspect the job’s status by calling [`status()`](qiskit.providers.ibmq.runtime.RuntimeJob#status "qiskit.providers.ibmq.runtime.RuntimeJob.status"). Job status can be one of the [`JobStatus`](qiskit.providers.JobStatus "qiskit.providers.JobStatus") members. -Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](qiskit.providers.ibmq.runtime.RuntimeJob.result#qiskit.providers.ibmq.runtime.RuntimeJob.result "qiskit.providers.ibmq.runtime.RuntimeJob.result") is an example of a blocking method: +Some of the methods in this class are blocking, which means control may not be returned immediately. [`result()`](qiskit.providers.ibmq.runtime.RuntimeJob#result "qiskit.providers.ibmq.runtime.RuntimeJob.result") is an example of a blocking method: ```python job = provider.runtime.run(...) @@ -24,7 +32,7 @@ except RuntimeJobFailureError as ex: print("Job failed!: {}".format(ex)) ``` -If the program has any interim results, you can use the `callback` parameter of the [`run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService.run#qiskit.providers.ibmq.runtime.IBMRuntimeService.run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to stream the interim results. Alternatively, you can use the [`stream_results()`](qiskit.providers.ibmq.runtime.RuntimeJob.stream_results#qiskit.providers.ibmq.runtime.RuntimeJob.stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. +If the program has any interim results, you can use the `callback` parameter of the [`run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run") method to stream the interim results. Alternatively, you can use the [`stream_results()`](qiskit.providers.ibmq.runtime.RuntimeJob#stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") method to stream the results at a later time, but before the job finishes. RuntimeJob constructor. @@ -38,27 +46,205 @@ RuntimeJob constructor. * **params** (`Optional`\[`Dict`]) – Job parameters. * **creation\_date** (`Optional`\[`str`]) – Job creation date, in UTC. * **user\_callback** (`Optional`\[`Callable`]) – User callback function. -* **result\_decoder** (`Type`\[`ResultDecoder`]) – A [`ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder#qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.ResultDecoder") subclass used to decode job results. +* **result\_decoder** (`Type`\[`ResultDecoder`]) – A [`ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.ResultDecoder") subclass used to decode job results. * **image** (`Optional`\[`str`]) – Runtime image used for this job: image\_name:tag. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`backend`](qiskit.providers.ibmq.runtime.RuntimeJob.backend#qiskit.providers.ibmq.runtime.RuntimeJob.backend "qiskit.providers.ibmq.runtime.RuntimeJob.backend") | Return the backend where this job was executed. | -| [`cancel`](qiskit.providers.ibmq.runtime.RuntimeJob.cancel#qiskit.providers.ibmq.runtime.RuntimeJob.cancel "qiskit.providers.ibmq.runtime.RuntimeJob.cancel") | Cancel the job. | -| [`cancel_result_streaming`](qiskit.providers.ibmq.runtime.RuntimeJob.cancel_result_streaming#qiskit.providers.ibmq.runtime.RuntimeJob.cancel_result_streaming "qiskit.providers.ibmq.runtime.RuntimeJob.cancel_result_streaming") | Cancel result streaming. | -| [`error_message`](qiskit.providers.ibmq.runtime.RuntimeJob.error_message#qiskit.providers.ibmq.runtime.RuntimeJob.error_message "qiskit.providers.ibmq.runtime.RuntimeJob.error_message") | Returns the reason if the job failed. | -| [`job_id`](qiskit.providers.ibmq.runtime.RuntimeJob.job_id#qiskit.providers.ibmq.runtime.RuntimeJob.job_id "qiskit.providers.ibmq.runtime.RuntimeJob.job_id") | Return a unique ID identifying the job. | -| [`logs`](qiskit.providers.ibmq.runtime.RuntimeJob.logs#qiskit.providers.ibmq.runtime.RuntimeJob.logs "qiskit.providers.ibmq.runtime.RuntimeJob.logs") | Return job logs. | -| [`result`](qiskit.providers.ibmq.runtime.RuntimeJob.result#qiskit.providers.ibmq.runtime.RuntimeJob.result "qiskit.providers.ibmq.runtime.RuntimeJob.result") | Return the results of the job. | -| [`status`](qiskit.providers.ibmq.runtime.RuntimeJob.status#qiskit.providers.ibmq.runtime.RuntimeJob.status "qiskit.providers.ibmq.runtime.RuntimeJob.status") | Return the status of the job. | -| [`stream_results`](qiskit.providers.ibmq.runtime.RuntimeJob.stream_results#qiskit.providers.ibmq.runtime.RuntimeJob.stream_results "qiskit.providers.ibmq.runtime.RuntimeJob.stream_results") | Start streaming job results. | -| [`wait_for_final_state`](qiskit.providers.ibmq.runtime.RuntimeJob.wait_for_final_state#qiskit.providers.ibmq.runtime.RuntimeJob.wait_for_final_state "qiskit.providers.ibmq.runtime.RuntimeJob.wait_for_final_state") | Poll the job status until it progresses to a final state such as `DONE` or `ERROR`. | +### backend -## Attributes + + +`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. + +**Return type** + +`Backend` + +**Returns** + +Backend used for the job. + +### cancel + + + +`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. + +**Raises** + +* **RuntimeInvalidStateError** – If the job is in a state that cannot be cancelled. +* **QiskitRuntimeError** – If unable to cancel job. + +**Return type** + +`None` + +### cancel\_result\_streaming + + + +`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. + +**Return type** + +`None` + +### error\_message + + + +`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. + +**Return type** + +`Optional`\[`str`] + +**Returns** + +Error message string or `None`. + +### job\_id + + + +`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. + +**Return type** + +`str` + +**Returns** + +Job ID. + +### logs + + + +`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. + + + Job logs are only available after the job finishes. + + +**Return type** + +`str` + +**Returns** + +Job logs, including standard output and error. +**Raises** +**QiskitRuntimeError** – If a network error occurred. + +### result + + + +`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. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Number of seconds to wait for job. +* **wait** (`float`) – Seconds between queries. +* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A [`ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.ResultDecoder") subclass used to decode job results. + +**Return type** + +`Any` + +**Returns** + +Runtime job result. + +**Raises** + +**RuntimeJobFailureError** – If the job failed. + +### status + + + +`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. + +**Return type** + +`JobStatus` + +**Returns** + +Status of this job. + +### stream\_results + + + +`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. + +**Parameters** + +* **callback** (`Callable`) – + + Callback function to be invoked for any interim results. The callback function will receive 2 positional parameters: + + > 1. Job ID + > 2. Job interim result. + +* **decoder** (`Optional`\[`Type`\[`ResultDecoder`]]) – A [`ResultDecoder`](qiskit.providers.ibmq.runtime.ResultDecoder "qiskit.providers.ibmq.runtime.ResultDecoder") subclass used to decode job results. + +**Raises** + +**RuntimeInvalidStateError** – If a callback function is already streaming results or if the job already finished. + +**Return type** + +`None` + +### wait\_for\_final\_state + + + +`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`. + +**Parameters** + +* **timeout** (`Optional`\[`float`]) – Seconds to wait for the job. If `None`, wait indefinitely. +* **wait** (`float`) – Seconds between queries. + +**Raises** + +[**JobTimeoutError**](qiskit.providers.JobTimeoutError "qiskit.providers.JobTimeoutError") – If the job does not reach a final state before the specified timeout. + +**Return type** + +`None` + +## Attributes + + ### creation\_date @@ -72,7 +258,7 @@ Job creation date in local time. The job creation date as a datetime object, in local time, or `None` if creation date is not available. - + ### image @@ -86,7 +272,7 @@ image\_name:tag or “” if the default image is used. Runtime image - + ### inputs @@ -100,7 +286,7 @@ Job input parameters. Input parameters used in this job. - + ### program\_id @@ -113,3 +299,4 @@ Program ID. **Returns** ID of the program this job is for. + 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 e2dc9a1f1c8..373af1cfb82 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 @@ -1,8 +1,16 @@ -# RuntimeProgram +--- +title: RuntimeProgram +description: API reference for qiskit.providers.ibmq.runtime.RuntimeProgram +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.RuntimeProgram +--- +# RuntimeProgram + -`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)` +`RuntimeProgram(program_name, program_id, description, parameters=None, return_values=None, interim_results=None, max_execution_time=0, backend_requirements=None, creation_date='', update_date='', is_public=False, data='', api_client=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/runtime/runtime_program.py "view source code") Bases: `object` @@ -10,7 +18,7 @@ Class representing program metadata. This class contains the metadata describing a program, such as its name, ID, description, etc. -You can use the [`IBMRuntimeService`](qiskit.providers.ibmq.runtime.IBMRuntimeService#qiskit.providers.ibmq.runtime.IBMRuntimeService "qiskit.providers.ibmq.runtime.IBMRuntimeService") to retrieve the metadata of a specific program or all programs. For example: +You can use the [`IBMRuntimeService`](qiskit.providers.ibmq.runtime.IBMRuntimeService "qiskit.providers.ibmq.runtime.IBMRuntimeService") to retrieve the metadata of a specific program or all programs. For example: ```python from qiskit import IBMQ @@ -45,14 +53,45 @@ RuntimeProgram constructor. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | -| [`parameters`](qiskit.providers.ibmq.runtime.RuntimeProgram.parameters#qiskit.providers.ibmq.runtime.RuntimeProgram.parameters "qiskit.providers.ibmq.runtime.RuntimeProgram.parameters") | Program parameter namespace. | -| [`to_dict`](qiskit.providers.ibmq.runtime.RuntimeProgram.to_dict#qiskit.providers.ibmq.runtime.RuntimeProgram.to_dict "qiskit.providers.ibmq.runtime.RuntimeProgram.to_dict") | Convert program metadata to dictionary format. | +### parameters -## Attributes + + +`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. + +You can use the returned namespace to assign parameter values and pass the namespace to [`qiskit.providers.ibmq.runtime.IBMRuntimeService.run()`](qiskit.providers.ibmq.runtime.IBMRuntimeService#run "qiskit.providers.ibmq.runtime.IBMRuntimeService.run"). The namespace allows you to use auto-completion to find program parameters. + +Note that each call to this method returns a new namespace instance and does not include any modification to the previous instance. + +**Return type** + +`ParameterNamespace` + +**Returns** + +Program parameter namespace. + +### to\_dict + + + +`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. + +**Return type** +`Dict` +**Returns** + +Program metadata in dictionary format. + +## Attributes + + ### backend\_requirements @@ -66,7 +105,7 @@ Backend requirements. Backend requirements for this program. - + ### creation\_date @@ -80,7 +119,7 @@ Program creation date. Program creation date. - + ### data @@ -98,7 +137,7 @@ Program data. **IBMQNotAuthorizedError** – if user is not the program author. - + ### description @@ -112,7 +151,7 @@ Program description. Program description. - + ### interim\_results @@ -126,7 +165,7 @@ Program interim result definitions. Interim result definitions for this program. - + ### is\_public @@ -140,7 +179,7 @@ Whether the program is visible to all. Whether the program is public. - + ### max\_execution\_time @@ -156,7 +195,7 @@ A program execution exceeding this time will be forcibly terminated. Maximum execution time. - + ### name @@ -170,7 +209,7 @@ Program name. Program name. - + ### program\_id @@ -184,7 +223,7 @@ Program ID. Program ID. - + ### return\_values @@ -198,7 +237,7 @@ Program return value definitions. Return value definitions for this program. - + ### update\_date @@ -211,3 +250,4 @@ Program last updated date. **Returns** Program last updated date. + 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 2bd82d38212..9b54f2fc279 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 @@ -1,8 +1,16 @@ -# UserMessenger +--- +title: UserMessenger +description: API reference for qiskit.providers.ibmq.runtime.UserMessenger +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.ibmq.runtime.UserMessenger +--- +# UserMessenger + -`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") Bases: `object` @@ -12,6 +20,25 @@ This class can be used when writing a new Qiskit Runtime program. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | -| [`publish`](qiskit.providers.ibmq.runtime.UserMessenger.publish#qiskit.providers.ibmq.runtime.UserMessenger.publish "qiskit.providers.ibmq.runtime.UserMessenger.publish") | Publish message. | +### publish + + + +`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. + +You can use this method to publish messages, such as interim and final results, to the program user. The messages will be made immediately available to the user, but they may choose not to receive the messages. + +The final parameter is used to indicate whether the message is the final result of the program. Final results may be processed differently from interim results. + +**Parameters** + +* **message** (`Any`) – Message to be published. Can be any type. +* **encoder** (`Type`\[`JSONEncoder`]) – An optional JSON encoder for serializing +* **final** (`bool`) – Whether the message being published is the final result. + +**Return type** + +`None` + 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 471317d08fd..8d21231dabf 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 @@ -1,8 +1,16 @@ -# qiskit.providers.ibmq.utils.seconds\_to\_duration +--- +title: seconds_to_duration +description: API reference for qiskit.providers.ibmq.utils.seconds_to_duration +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.ibmq.utils.seconds_to_duration +--- +# qiskit.providers.ibmq.utils.seconds\_to\_duration + -`seconds_to_duration(seconds)` +`seconds_to_duration(seconds)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Converts seconds in a datetime delta to a duration. @@ -17,3 +25,4 @@ Converts seconds in a datetime delta to a duration. **Returns** A tuple containing the duration in terms of days, hours, minutes, seconds, and milliseconds. + 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 2c3390e4c1a..44ab31ee0c5 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 @@ -1,8 +1,16 @@ -# qiskit.providers.ibmq.utils.to\_python\_identifier +--- +title: to_python_identifier +description: API reference for qiskit.providers.ibmq.utils.to_python_identifier +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.ibmq.utils.to_python_identifier +--- +# qiskit.providers.ibmq.utils.to\_python\_identifier + -`to_python_identifier(name)` +`to_python_identifier(name)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Convert a name to a valid Python identifier. @@ -17,3 +25,4 @@ Convert a name to a valid Python identifier. **Returns** Name that is 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 96fb799c12f..c126d25f613 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 @@ -1,8 +1,16 @@ -# qiskit.providers.ibmq.utils.update\_qobj\_config +--- +title: update_qobj_config +description: API reference for qiskit.providers.ibmq.utils.update_qobj_config +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.ibmq.utils.update_qobj_config +--- +# qiskit.providers.ibmq.utils.update\_qobj\_config + -`update_qobj_config(qobj, backend_options=None, noise_model=None)` +`update_qobj_config(qobj, backend_options=None, noise_model=None)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/qobj_utils.py "view source code") Update a `Qobj` configuration from backend options and a noise model. @@ -19,3 +27,4 @@ Update a `Qobj` configuration from backend options and a noise model. **Returns** The updated `Qobj`. + 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 7816d6d7b25..2ad496aa570 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 @@ -1,8 +1,16 @@ -# qiskit.providers.ibmq.utils.utc\_to\_local +--- +title: utc_to_local +description: API reference for qiskit.providers.ibmq.utils.utc_to_local +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.ibmq.utils.utc_to_local +--- +# qiskit.providers.ibmq.utils.utc\_to\_local + -`utc_to_local(utc_dt)` +`utc_to_local(utc_dt)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/converters.py "view source code") Convert a UTC `datetime` object or string to a local timezone `datetime`. @@ -21,3 +29,4 @@ A `datetime` with the local timezone. **Raises** **TypeError** – If the input parameter value is not valid. + 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 798e41b5b3b..b96de6d5ac2 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 @@ -1,8 +1,16 @@ -# qiskit.providers.ibmq.utils.validate\_job\_tags +--- +title: validate_job_tags +description: API reference for qiskit.providers.ibmq.utils.validate_job_tags +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.providers.ibmq.utils.validate_job_tags +--- +# qiskit.providers.ibmq.utils.validate\_job\_tags + -`validate_job_tags(job_tags, exception)` +`validate_job_tags(job_tags, exception)`[GitHub](https://github.com/qiskit/qiskit-ibmq-provider/tree/stable/0.18/qiskit/providers/ibmq/utils/utils.py "view source code") Validates input job tags. @@ -18,3 +26,4 @@ Validates input job tags. **Return type** `None` + 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 c7b565207c2..1194041a160 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendConfiguration.md @@ -1,8 +1,16 @@ -# BackendConfiguration +--- +title: BackendConfiguration +description: API reference for qiskit.providers.models.BackendConfiguration +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.BackendConfiguration +--- +# BackendConfiguration + -`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` +`BackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -82,17 +90,49 @@ Initialize a QasmBackendConfiguration Object ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`from_dict`](qiskit.providers.models.BackendConfiguration.from_dict#qiskit.providers.models.BackendConfiguration.from_dict "qiskit.providers.models.BackendConfiguration.from_dict") | Create a new GateConfig object from a dictionary. | -| [`to_dict`](qiskit.providers.models.BackendConfiguration.to_dict#qiskit.providers.models.BackendConfiguration.to_dict "qiskit.providers.models.BackendConfiguration.to_dict") | Return a dictionary format representation of the GateConfig. | +### from\_dict -## Attributes + + +`classmethod BackendConfiguration.from_dict(data)` + +Create a new GateConfig object from a dictionary. + +**Parameters** + +**data** (*dict*) – A dictionary representing the GateConfig to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.BackendConfiguration#to_dict "qiskit.providers.models.BackendConfiguration.to_dict"). + +**Returns** + +The GateConfig from the input dictionary. + +**Return type** +[GateConfig](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig") +### to\_dict + + + +`BackendConfiguration.to_dict()` + +Return a dictionary format representation of the GateConfig. + +**Returns** + +The dictionary form of the GateConfig. + +**Return type** + +dict + +## Attributes + + ### num\_qubits Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. + diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md b/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md index fb4bcfdbf51..95a5a196fdd 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendProperties.md @@ -1,8 +1,16 @@ -# BackendProperties +--- +title: BackendProperties +description: API reference for qiskit.providers.models.BackendProperties +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.BackendProperties +--- +# BackendProperties + -`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)` +`BackendProperties(backend_name, backend_version, last_update_date, qubits, gates, general, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendproperties.py "view source code") Bases: `object` @@ -24,20 +32,291 @@ Initialize a BackendProperties instance. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`faulty_gates`](qiskit.providers.models.BackendProperties.faulty_gates#qiskit.providers.models.BackendProperties.faulty_gates "qiskit.providers.models.BackendProperties.faulty_gates") | Return a list of faulty gates. | -| [`faulty_qubits`](qiskit.providers.models.BackendProperties.faulty_qubits#qiskit.providers.models.BackendProperties.faulty_qubits "qiskit.providers.models.BackendProperties.faulty_qubits") | Return a list of faulty qubits. | -| [`frequency`](qiskit.providers.models.BackendProperties.frequency#qiskit.providers.models.BackendProperties.frequency "qiskit.providers.models.BackendProperties.frequency") | Return the frequency of the given qubit. | -| [`from_dict`](qiskit.providers.models.BackendProperties.from_dict#qiskit.providers.models.BackendProperties.from_dict "qiskit.providers.models.BackendProperties.from_dict") | Create a new Gate object from a dictionary. | -| [`gate_error`](qiskit.providers.models.BackendProperties.gate_error#qiskit.providers.models.BackendProperties.gate_error "qiskit.providers.models.BackendProperties.gate_error") | Return gate error estimates from backend properties. | -| [`gate_length`](qiskit.providers.models.BackendProperties.gate_length#qiskit.providers.models.BackendProperties.gate_length "qiskit.providers.models.BackendProperties.gate_length") | Return the duration of the gate in units of seconds. | -| [`gate_property`](qiskit.providers.models.BackendProperties.gate_property#qiskit.providers.models.BackendProperties.gate_property "qiskit.providers.models.BackendProperties.gate_property") | Return the property of the given gate. | -| [`is_gate_operational`](qiskit.providers.models.BackendProperties.is_gate_operational#qiskit.providers.models.BackendProperties.is_gate_operational "qiskit.providers.models.BackendProperties.is_gate_operational") | Return the operational status of the given gate. | -| [`is_qubit_operational`](qiskit.providers.models.BackendProperties.is_qubit_operational#qiskit.providers.models.BackendProperties.is_qubit_operational "qiskit.providers.models.BackendProperties.is_qubit_operational") | Return the operational status of the given qubit. | -| [`qubit_property`](qiskit.providers.models.BackendProperties.qubit_property#qiskit.providers.models.BackendProperties.qubit_property "qiskit.providers.models.BackendProperties.qubit_property") | Return the property of the given qubit. | -| [`readout_error`](qiskit.providers.models.BackendProperties.readout_error#qiskit.providers.models.BackendProperties.readout_error "qiskit.providers.models.BackendProperties.readout_error") | Return the readout error of the given qubit. | -| [`readout_length`](qiskit.providers.models.BackendProperties.readout_length#qiskit.providers.models.BackendProperties.readout_length "qiskit.providers.models.BackendProperties.readout_length") | Return the readout length \[sec] of the given qubit. | -| [`t1`](qiskit.providers.models.BackendProperties.t1#qiskit.providers.models.BackendProperties.t1 "qiskit.providers.models.BackendProperties.t1") | Return the T1 time of the given qubit. | -| [`t2`](qiskit.providers.models.BackendProperties.t2#qiskit.providers.models.BackendProperties.t2 "qiskit.providers.models.BackendProperties.t2") | Return the T2 time of the given qubit. | -| [`to_dict`](qiskit.providers.models.BackendProperties.to_dict#qiskit.providers.models.BackendProperties.to_dict "qiskit.providers.models.BackendProperties.to_dict") | Return a dictionary format representation of the BackendProperties. | +### faulty\_gates + + + +`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. + +### faulty\_qubits + + + +`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. + +### frequency + + + +`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. + +**Parameters** + +**qubit** (`int`) – Qubit for which to return frequency of. + +**Return type** + +`float` + +**Returns** + +Frequency of the given qubit. + +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the Gate to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.BackendProperties#to_dict "qiskit.providers.models.BackendProperties.to_dict"). + +**Returns** + +**The BackendProperties from the input** + +dictionary. + +**Return type** + +[BackendProperties](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties") + +### gate\_error + + + +`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. + +**Parameters** + +* **gate** (`str`) – The gate for which to get the error. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The specific qubits for the gate. + +**Return type** + +`float` + +**Returns** + +Gate error of the given gate and qubit(s). + +### gate\_length + + + +`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. + +**Parameters** + +* **gate** (`str`) – The gate for which to get the duration. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The specific qubits for the gate. + +**Return type** + +`float` + +**Returns** + +Gate length of the given gate and qubit(s). + +### gate\_property + + + +`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. + +**Parameters** + +* **gate** (`str`) – Name of the gate. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`], `None`]) – The qubit to find the property for. +* **name** (`Optional`\[`str`]) – Optionally used to specify which gate property to return. + +**Return type** + +`Tuple`\[`Any`, `datetime`] + +**Returns** + +Gate property as a tuple of the value and the time it was measured. + +**Raises** + +[**BackendPropertyError**](qiskit.providers.BackendPropertyError "qiskit.providers.BackendPropertyError") – If the property is not found or name is specified but qubit is not. + +### is\_gate\_operational + + + +`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. + +**Parameters** + +* **gate** (`str`) – Name of the gate. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`], `None`]) – The qubit to find the operational status for. + +**Returns** + +Operational status of the given gate. True if the gate is operational, False otherwise. + +**Return type** + +bool + +### is\_qubit\_operational + + + +`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. + +**Parameters** + +**qubit** (`int`) – Qubit for which to return operational status of. + +**Return type** + +`bool` + +**Returns** + +Operational status of the given qubit. + +### qubit\_property + + + +`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. + +**Parameters** + +* **qubit** (`int`) – The property to look for. +* **name** (`Optional`\[`str`]) – Optionally used to specify within the hierarchy which property to return. + +**Return type** + +`Tuple`\[`Any`, `datetime`] + +**Returns** + +Qubit property as a tuple of the value and the time it was measured. + +**Raises** + +[**BackendPropertyError**](qiskit.providers.BackendPropertyError "qiskit.providers.BackendPropertyError") – If the property is not found. + +### readout\_error + + + +`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. + +**Parameters** + +**qubit** (`int`) – Qubit for which to return the readout error of. + +**Return type** + +`float` + +**Returns** + +Readout error of the given qubit. + +### readout\_length + + + +`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. + +**Parameters** + +**qubit** (`int`) – Qubit for which to return the readout length of. + +**Return type** + +`float` + +**Returns** + +Readout length of the given qubit. + +### t1 + + + +`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. + +**Parameters** + +**qubit** (`int`) – Qubit for which to return the T1 time of. + +**Return type** + +`float` + +**Returns** + +T1 time of the given qubit. + +### t2 + + + +`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. + +**Parameters** + +**qubit** (`int`) – Qubit for which to return the T2 time of. + +**Return type** + +`float` + +**Returns** + +T2 time of the given qubit. + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the BackendProperties. + +**Return type** + +dict + 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 bf7612ff6a9..2a77cb0018c 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.BackendStatus.md @@ -1,8 +1,16 @@ -# BackendStatus +--- +title: BackendStatus +description: API reference for qiskit.providers.models.BackendStatus +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.BackendStatus +--- +# BackendStatus + -`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)` +`BackendStatus(backend_name, backend_version, operational, pending_jobs, status_msg)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendstatus.py "view source code") Bases: `object` @@ -24,7 +32,39 @@ Initialize a BackendStatus object ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| [`from_dict`](qiskit.providers.models.BackendStatus.from_dict#qiskit.providers.models.BackendStatus.from_dict "qiskit.providers.models.BackendStatus.from_dict") | Create a new BackendStatus object from a dictionary. | -| [`to_dict`](qiskit.providers.models.BackendStatus.to_dict#qiskit.providers.models.BackendStatus.to_dict "qiskit.providers.models.BackendStatus.to_dict") | Return a dictionary format representation of the BackendStatus. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the BaseBakend to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.BackendStatus#to_dict "qiskit.providers.models.BackendStatus.to_dict"). + +**Returns** + +The BackendStatus from the input dictionary. + +**Return type** + +[BackendStatus](qiskit.providers.models.BackendStatus "qiskit.providers.models.BackendStatus") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the QobjHeader. + +**Return type** + +dict + 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 27076d1c109..d59f62fa357 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.Command.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.Command.md @@ -1,14 +1,22 @@ -# Command +--- +title: Command +description: API reference for qiskit.providers.models.Command +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.Command +--- +# Command + -`Command(name, qubits=None, sequence=None, **kwargs)` +`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` Class representing a Command. - + ### name @@ -20,12 +28,46 @@ Initialize a Command object * **name** (*str*) – The name of the command * **qubits** – The qubits for the command -* **sequence** ([*PulseQobjInstruction*](qiskit.qobj.PulseQobjInstruction#qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")) – The sequence for the Command +* **sequence** ([*PulseQobjInstruction*](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")) – The sequence for the Command * **kwargs** – Optional additional fields ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | -| [`from_dict`](qiskit.providers.models.Command.from_dict#qiskit.providers.models.Command.from_dict "qiskit.providers.models.Command.from_dict") | Create a new Command object from a dictionary. | -| [`to_dict`](qiskit.providers.models.Command.to_dict#qiskit.providers.models.Command.to_dict "qiskit.providers.models.Command.to_dict") | Return a dictionary format representation of the Command. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the `Command` to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.Command#to_dict "qiskit.providers.models.Command.to_dict"). + +**Returns** + +**The `Command` from the input** + +dictionary. + +**Return type** + +qiskit.providers.model.Command + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the Command. + +**Return type** + +dict + 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 bfe03762a03..f2567400f56 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.GateConfig.md @@ -1,26 +1,34 @@ -# GateConfig +--- +title: GateConfig +description: API reference for qiskit.providers.models.GateConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.GateConfig +--- +# GateConfig + -`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)` +`GateConfig(name, parameters, qasm_def, coupling_map=None, latency_map=None, conditional=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` Class representing a Gate Configuration - + ### name the gate name as it will be referred to in Qasm. - + ### parameters variable names for the gate parameters (if any). - + ### qasm\_def @@ -40,7 +48,39 @@ Initialize a GateConfig object ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`from_dict`](qiskit.providers.models.GateConfig.from_dict#qiskit.providers.models.GateConfig.from_dict "qiskit.providers.models.GateConfig.from_dict") | Create a new GateConfig object from a dictionary. | -| [`to_dict`](qiskit.providers.models.GateConfig.to_dict#qiskit.providers.models.GateConfig.to_dict "qiskit.providers.models.GateConfig.to_dict") | Return a dictionary format representation of the GateConfig. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the GateConfig to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.GateConfig#to_dict "qiskit.providers.models.GateConfig.to_dict"). + +**Returns** + +The GateConfig from the input dictionary. + +**Return type** + +[GateConfig](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the GateConfig. + +**Return type** + +dict + 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 f09d0a39740..fec2e864f50 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.JobStatus.md @@ -1,14 +1,22 @@ -# JobStatus +--- +title: JobStatus +description: API reference for qiskit.providers.models.JobStatus +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.JobStatus +--- +# JobStatus + -`JobStatus(job_id, status, status_msg, **kwargs)` +`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` Model for JobStatus. - + ### job\_id @@ -18,7 +26,7 @@ backend job\_id. str - + ### status @@ -28,7 +36,7 @@ status of the job. str - + ### status\_msg @@ -40,7 +48,41 @@ str ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`from_dict`](qiskit.providers.models.JobStatus.from_dict#qiskit.providers.models.JobStatus.from_dict "qiskit.providers.models.JobStatus.from_dict") | Create a new JobStatus object from a dictionary. | -| [`to_dict`](qiskit.providers.models.JobStatus.to_dict#qiskit.providers.models.JobStatus.to_dict "qiskit.providers.models.JobStatus.to_dict") | Return a dictionary format representation of the JobStatus. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the JobStatus to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.JobStatus#to_dict "qiskit.providers.models.JobStatus.to_dict"). + +**Returns** + +**The `JobStatus` from the input** + +dictionary. + +**Return type** + +qiskit.providers.model.JobStatus + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the JobStatus. + +**Return type** + +dict + 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 d38d8d0467f..6c8cbdaf67b 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.PulseBackendConfiguration.md @@ -1,8 +1,16 @@ -# PulseBackendConfiguration +--- +title: PulseBackendConfiguration +description: API reference for qiskit.providers.models.PulseBackendConfiguration +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.PulseBackendConfiguration +--- +# PulseBackendConfiguration + -`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)` +`PulseBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, n_uchannels, u_channel_lo, meas_levels, qubit_lo_range, meas_lo_range, dt, dtm, rep_times, meas_kernels, discriminators, hamiltonian=None, channel_bandwidth=None, acquisition_latency=None, conditional_latency=None, meas_map=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, channels=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `qiskit.providers.models.backendconfiguration.QasmBackendConfiguration` @@ -54,21 +62,208 @@ Initialize a backend configuration that contains all the extra configuration tha ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`acquire`](qiskit.providers.models.PulseBackendConfiguration.acquire#qiskit.providers.models.PulseBackendConfiguration.acquire "qiskit.providers.models.PulseBackendConfiguration.acquire") | Return the acquisition channel for the given qubit. | -| [`control`](qiskit.providers.models.PulseBackendConfiguration.control#qiskit.providers.models.PulseBackendConfiguration.control "qiskit.providers.models.PulseBackendConfiguration.control") | Return the secondary drive channel for the given qubit – typically utilized for controlling multiqubit interactions. | -| [`describe`](qiskit.providers.models.PulseBackendConfiguration.describe#qiskit.providers.models.PulseBackendConfiguration.describe "qiskit.providers.models.PulseBackendConfiguration.describe") | 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::. | -| [`drive`](qiskit.providers.models.PulseBackendConfiguration.drive#qiskit.providers.models.PulseBackendConfiguration.drive "qiskit.providers.models.PulseBackendConfiguration.drive") | Return the drive channel for the given qubit. | -| [`from_dict`](qiskit.providers.models.PulseBackendConfiguration.from_dict#qiskit.providers.models.PulseBackendConfiguration.from_dict "qiskit.providers.models.PulseBackendConfiguration.from_dict") | Create a new GateConfig object from a dictionary. | -| [`get_channel_qubits`](qiskit.providers.models.PulseBackendConfiguration.get_channel_qubits#qiskit.providers.models.PulseBackendConfiguration.get_channel_qubits "qiskit.providers.models.PulseBackendConfiguration.get_channel_qubits") | Return a list of indices for qubits which are operated on directly by the given `channel`. | -| [`get_qubit_channels`](qiskit.providers.models.PulseBackendConfiguration.get_qubit_channels#qiskit.providers.models.PulseBackendConfiguration.get_qubit_channels "qiskit.providers.models.PulseBackendConfiguration.get_qubit_channels") | Return a list of channels which operate on the given `qubit`. | -| [`measure`](qiskit.providers.models.PulseBackendConfiguration.measure#qiskit.providers.models.PulseBackendConfiguration.measure "qiskit.providers.models.PulseBackendConfiguration.measure") | Return the measure stimulus channel for the given qubit. | -| [`to_dict`](qiskit.providers.models.PulseBackendConfiguration.to_dict#qiskit.providers.models.PulseBackendConfiguration.to_dict "qiskit.providers.models.PulseBackendConfiguration.to_dict") | Return a dictionary format representation of the GateConfig. | +### acquire -## Attributes + + +`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. + +**Raises** + +**BackendConfigurationError** – If the qubit is not a part of the system. + +**Return type** + +`AcquireChannel` + +**Returns** + +Qubit measurement acquisition line. + +### control + + + +`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. + +**Parameters** + +* **qubits** (`Optional`\[`Iterable`\[`int`]]) – Tuple or list of qubits of the form (control\_qubit, target\_qubit). +* **channel** (`Optional`\[`int`]) – Deprecated. + +**Raises** + +**BackendConfigurationError** – If the `qubits` is not a part of the system or if the backend does not provide channels information in its configuration. + +**Return type** + +`List`\[`ControlChannel`] + +**Returns** + +List of control channels. + +### describe + + + +`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: + +```python +u_channel_lo = [ + [UchannelLO(q=0, scale=1. + 0.j)], + [UchannelLO(q=0, scale=-1. + 0.j), UchannelLO(q=1, scale=1. + 0.j)] +] +``` + +Then, this method can be used as follows: + +```python +backend.configuration().describe(ControlChannel(1)) +>>> {DriveChannel(0): -1, DriveChannel(1): 1} +``` + +**Parameters** + +**channel** (`ControlChannel`) – The derived channel to describe. + +**Raises** + +**BackendConfigurationError** – If channel is not a ControlChannel. + +**Return type** + +`Dict`\[`DriveChannel`, `complex`] + +**Returns** + +Control channel derivations. + +### drive + + + +`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. + +**Raises** + +**BackendConfigurationError** – If the qubit is not a part of the system. + +**Return type** + +`DriveChannel` + +**Returns** + +Qubit drive channel. + +### from\_dict + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the GateConfig to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.PulseBackendConfiguration#to_dict "qiskit.providers.models.PulseBackendConfiguration.to_dict"). + +**Returns** + +The GateConfig from the input dictionary. + +**Return type** + +[GateConfig](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig") + +### get\_channel\_qubits + + + +`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`. + +**Raises** + +**BackendConfigurationError** – If `channel` is not a found or if the backend does not provide channels information in its configuration. + +**Return type** + +`List`\[`int`] + +**Returns** + +List of qubits operated on my the given `channel`. + +### get\_qubit\_channels + + + +`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`. + +**Raises** + +**BackendConfigurationError** – If `qubit` is not a found or if the backend does not provide channels information in its configuration. + +**Return type** + +`List`\[`Channel`] + +**Returns** + +List of `Channel`s operated on my the given `qubit`. + +### measure + + + +`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. + +**Raises** + +**BackendConfigurationError** – If the qubit is not a part of the system. + +**Return type** + +`MeasureChannel` + +**Returns** + +Qubit measurement stimulus line. + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the GateConfig. + +**Return type** + +dict + +## Attributes + + ### control\_channels @@ -78,7 +273,7 @@ Return the control channels `Dict`\[`Tuple`\[`int`, …], `List`] - + ### num\_qubits @@ -86,7 +281,7 @@ Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. - + ### sample\_rate @@ -95,3 +290,4 @@ Sample rate of the signal channels in Hz (1/dt). **Return type** `float` + 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 88f7676fba9..5b451249c5b 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.PulseDefaults.md @@ -1,8 +1,16 @@ -# PulseDefaults +--- +title: PulseDefaults +description: API reference for qiskit.providers.models.PulseDefaults +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.PulseDefaults +--- +# PulseDefaults + -`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)` +`PulseDefaults(qubit_freq_est, meas_freq_est, buffer, pulse_library, cmd_def, meas_kernel=None, discriminator=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/pulsedefaults.py "view source code") Bases: `object` @@ -12,7 +20,31 @@ Validate and reformat transport layer inputs to initialize. :type qubit\_freq\_e ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| [`from_dict`](qiskit.providers.models.PulseDefaults.from_dict#qiskit.providers.models.PulseDefaults.from_dict "qiskit.providers.models.PulseDefaults.from_dict") | Create a new PulseDefaults object from a dictionary. | -| [`to_dict`](qiskit.providers.models.PulseDefaults.to_dict#qiskit.providers.models.PulseDefaults.to_dict "qiskit.providers.models.PulseDefaults.to_dict") | Return a dictionary format representation of the PulseDefaults. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the PulseDefaults to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.PulseDefaults#to_dict "qiskit.providers.models.PulseDefaults.to_dict"). + +**Returns** + +The PulseDefaults from the input dictionary. + +**Return type** + +[PulseDefaults](qiskit.providers.models.PulseDefaults "qiskit.providers.models.PulseDefaults") + +### to\_dict + + + +`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 98553bfabbe..03a572c07fa 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.QasmBackendConfiguration.md @@ -1,74 +1,82 @@ -# QasmBackendConfiguration +--- +title: QasmBackendConfiguration +description: API reference for qiskit.providers.models.QasmBackendConfiguration +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.QasmBackendConfiguration +--- +# QasmBackendConfiguration + -`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)` +`QasmBackendConfiguration(backend_name, backend_version, n_qubits, basis_gates, gates, local, simulator, conditional, open_pulse, memory, max_shots, coupling_map, supported_instructions=None, dynamic_reprate_enabled=False, rep_delay_range=None, default_rep_delay=None, max_experiments=None, sample_name=None, n_registers=None, register_map=None, configurable=None, credits_required=None, online_date=None, display_name=None, description=None, tags=None, dt=None, dtm=None, processor_type=None, parametric_pulses=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` Class representing a Qasm Backend Configuration. - + ### backend\_name backend name. - + ### backend\_version backend version in the form X.Y.Z. - + ### n\_qubits number of qubits. - + ### basis\_gates list of basis gates names on the backend. - + ### gates list of basis gates on the backend. - + ### local backend is local or remote. - + ### simulator backend is a simulator. - + ### conditional backend supports conditional operations. - + ### open\_pulse backend supports open pulse. - + ### memory backend supports memory. - + ### max\_shots @@ -148,17 +156,49 @@ Initialize a QasmBackendConfiguration Object ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`from_dict`](qiskit.providers.models.QasmBackendConfiguration.from_dict#qiskit.providers.models.QasmBackendConfiguration.from_dict "qiskit.providers.models.QasmBackendConfiguration.from_dict") | Create a new GateConfig object from a dictionary. | -| [`to_dict`](qiskit.providers.models.QasmBackendConfiguration.to_dict#qiskit.providers.models.QasmBackendConfiguration.to_dict "qiskit.providers.models.QasmBackendConfiguration.to_dict") | Return a dictionary format representation of the GateConfig. | +### from\_dict -## Attributes + + +`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. + +**Parameters** +**data** (*dict*) – A dictionary representing the GateConfig to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.QasmBackendConfiguration#to_dict "qiskit.providers.models.QasmBackendConfiguration.to_dict"). + +**Returns** + +The GateConfig from the input dictionary. + +**Return type** + +[GateConfig](qiskit.providers.models.GateConfig "qiskit.providers.models.GateConfig") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the GateConfig. + +**Return type** + +dict + +## Attributes + + ### num\_qubits Returns the number of qubits. In future, n\_qubits should be replaced in favor of num\_qubits for consistent use throughout Qiskit. Until this is properly refactored, this property serves as intermediate solution. + diff --git a/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md b/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md index c5d624632a8..c5e76ea2756 100644 --- a/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md +++ b/docs/api/qiskit/0.32/qiskit.providers.models.UchannelLO.md @@ -1,20 +1,28 @@ -# UchannelLO +--- +title: UchannelLO +description: API reference for qiskit.providers.models.UchannelLO +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.providers.models.UchannelLO +--- +# UchannelLO + -`UchannelLO(q, scale)` +`UchannelLO(q, scale)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/providers/models/backendconfiguration.py "view source code") Bases: `object` Class representing a U Channel LO - + ### q Qubit that scale corresponds too. - + ### scale @@ -33,7 +41,39 @@ Initialize a UchannelLOSchema object ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`from_dict`](qiskit.providers.models.UchannelLO.from_dict#qiskit.providers.models.UchannelLO.from_dict "qiskit.providers.models.UchannelLO.from_dict") | Create a new UchannelLO object from a dictionary. | -| [`to_dict`](qiskit.providers.models.UchannelLO.to_dict#qiskit.providers.models.UchannelLO.to_dict "qiskit.providers.models.UchannelLO.to_dict") | Return a dictionary format representation of the UChannelLO. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the UChannelLO to create. It will be in the same format as output by [`to_dict()`](qiskit.providers.models.UchannelLO#to_dict "qiskit.providers.models.UchannelLO.to_dict"). + +**Returns** + +The UchannelLO from the input dictionary. + +**Return type** + +[UchannelLO](qiskit.providers.models.UchannelLO "qiskit.providers.models.UchannelLO") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the UChannelLO. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md b/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md index 5cc330fc2aa..e81c9ad04e6 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Acquire.md @@ -1,8 +1,16 @@ -# Acquire +--- +title: Acquire +description: API reference for qiskit.pulse.Acquire +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Acquire +--- +# Acquire + -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -28,26 +36,200 @@ Create a new Acquire instruction. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If channels are supplied, and the number of register and/or memory slots does not equal the number of channels. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If channels are supplied, and the number of register and/or memory slots does not equal the number of channels. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.Acquire.append#qiskit.pulse.Acquire.append "qiskit.pulse.Acquire.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.Acquire.assign_parameters#qiskit.pulse.Acquire.assign_parameters "qiskit.pulse.Acquire.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.Acquire.ch_duration#qiskit.pulse.Acquire.ch_duration "qiskit.pulse.Acquire.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.Acquire.ch_start_time#qiskit.pulse.Acquire.ch_start_time "qiskit.pulse.Acquire.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.Acquire.ch_stop_time#qiskit.pulse.Acquire.ch_stop_time "qiskit.pulse.Acquire.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.Acquire.draw#qiskit.pulse.Acquire.draw "qiskit.pulse.Acquire.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.Acquire.flatten#qiskit.pulse.Acquire.flatten "qiskit.pulse.Acquire.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.Acquire.insert#qiskit.pulse.Acquire.insert "qiskit.pulse.Acquire.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.Acquire.is_parameterized#qiskit.pulse.Acquire.is_parameterized "qiskit.pulse.Acquire.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.Acquire.shift#qiskit.pulse.Acquire.shift "qiskit.pulse.Acquire.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Acquire.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`Acquire.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Acquire.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Acquire.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Acquire.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + + +`Acquire.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)` + +Plot the instruction. +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Acquire.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Acquire.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Acquire.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + ### acquire @@ -57,7 +239,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu `AcquireChannel` - + ### channel @@ -67,7 +249,7 @@ Return the `Channel` that this instruction is scheduled on. `AcquireChannel` - + ### channels @@ -77,7 +259,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Union`\[`AcquireChannel`, `MemorySlot`, `RegisterSlot`]] - + ### discriminator @@ -87,7 +269,7 @@ Return discrimination settings. `Discriminator` - + ### duration @@ -97,7 +279,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -107,7 +289,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -117,7 +299,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### kernel @@ -127,7 +309,7 @@ Return kernel settings. `Kernel` - + ### mem\_slot @@ -137,7 +319,7 @@ The classical memory slot which will store the classified readout result. `MemorySlot` - + ### name @@ -147,7 +329,7 @@ Name of this instruction. `str` - + ### operands @@ -157,7 +339,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -167,7 +349,7 @@ Parameters which determine the instruction behavior. `Set` - + ### reg\_slot @@ -177,7 +359,7 @@ The fast-access register slot which will store the classified readout result for `RegisterSlot` - + ### start\_time @@ -187,7 +369,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -196,3 +378,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md index 85ebabe55c8..c0c426ea242 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.AcquireChannel.md @@ -1,8 +1,16 @@ -# AcquireChannel +--- +title: AcquireChannel +description: API reference for qiskit.pulse.AcquireChannel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.AcquireChannel +--- +# AcquireChannel + -`AcquireChannel(index)` +`AcquireChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` @@ -16,14 +24,46 @@ Channel class. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`assign`](qiskit.pulse.AcquireChannel.assign#qiskit.pulse.AcquireChannel.assign "qiskit.pulse.AcquireChannel.assign") | Return a new channel with the input Parameter assigned to value. | -| [`is_parameterized`](qiskit.pulse.AcquireChannel.is_parameterized#qiskit.pulse.AcquireChannel.is_parameterized "qiskit.pulse.AcquireChannel.is_parameterized") | Return True iff the channel is parameterized. | +### assign -## Attributes + + +`AcquireChannel.assign(parameter, value)` + +Return a new channel with the input Parameter assigned to value. + +**Parameters** + +* **parameter** (`Parameter`) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`Channel` + +**Returns** + +A new channel with updated parameters. + +**Raises** +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameter is not present in the channel. +### is\_parameterized + + + +`AcquireChannel.is_parameterized()` + +Return True iff the channel is parameterized. + +**Return type** + +`bool` + +## Attributes + + ### index @@ -33,7 +73,7 @@ Return the index of this channel. The index is a label for a control signal line `Union`\[`int`, `ParameterExpression`] - + ### name @@ -43,7 +83,7 @@ Return the shorthand alias for this channel, which is based on its type and inde `str` - + ### parameters @@ -53,8 +93,9 @@ Parameters which determine the channel index. `Set` - + ### prefix `= 'a'` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Call.md b/docs/api/qiskit/0.32/qiskit.pulse.Call.md index e1dd0297f76..7799d85e74d 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Call.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Call.md @@ -1,8 +1,16 @@ -# Call +--- +title: Call +description: API reference for qiskit.pulse.Call +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Call +--- +# Call + -`Call(subroutine, value_dict=None, name=None)` +`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` @@ -18,33 +26,228 @@ Define new subroutine. **Parameters** -* **subroutine** (*Union\[*[*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")*,* [*ScheduleBlock*](qiskit.pulse.ScheduleBlock#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")*]*) – A program subroutine to be referred to. +* **subroutine** (*Union\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*,* [*ScheduleBlock*](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")*]*) – A program subroutine to be referred to. * **value\_dict** (`Optional`\[`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]]) – Mapping of parameter object to assigned value. * **name** (`Optional`\[`str`]) – Unique ID of this subroutine. If not provided, this is generated based on the subroutine name. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If subroutine is not valid data format. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If subroutine is not valid data format. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.Call.append#qiskit.pulse.Call.append "qiskit.pulse.Call.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.Call.assign_parameters#qiskit.pulse.Call.assign_parameters "qiskit.pulse.Call.assign_parameters") | Store parameters which will be later assigned to the subroutine. | -| [`assigned_subroutine`](qiskit.pulse.Call.assigned_subroutine#qiskit.pulse.Call.assigned_subroutine "qiskit.pulse.Call.assigned_subroutine") | Returns this subroutine with the parameters assigned. | -| [`ch_duration`](qiskit.pulse.Call.ch_duration#qiskit.pulse.Call.ch_duration "qiskit.pulse.Call.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.Call.ch_start_time#qiskit.pulse.Call.ch_start_time "qiskit.pulse.Call.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.Call.ch_stop_time#qiskit.pulse.Call.ch_stop_time "qiskit.pulse.Call.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.Call.draw#qiskit.pulse.Call.draw "qiskit.pulse.Call.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.Call.flatten#qiskit.pulse.Call.flatten "qiskit.pulse.Call.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.Call.insert#qiskit.pulse.Call.insert "qiskit.pulse.Call.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.Call.is_parameterized#qiskit.pulse.Call.is_parameterized "qiskit.pulse.Call.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.Call.shift#qiskit.pulse.Call.shift "qiskit.pulse.Call.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Call.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`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. + +Parameter values are not immediately assigned. The subroutine with parameters assigned according to the populated parameter table will be generated only when `inline_subroutines()` function is applied to this instruction. Note that parameter assignment logic creates a copy of subroutine to avoid the mutation problem. This function is usually applied by the Qiskit compiler when the program is submitted to the backend. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Call` + +**Returns** + +Self with updated parameters. + +### assigned\_subroutine + + + +`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. + + + This function may be often called internally for class equality check despite its overhead of parameter assignment. The subroutine with parameter assigned is cached based on `.argument` hash. Once this argument is updated, new assigned instance will be returned. Note that this update is not mutable operation. + + +**Returns** + +Attached program. + +**Return type** + +program (Union\[[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), [ScheduleBlock](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")]) + +### ch\_duration + + + +`Call.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Call.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Call.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels +**Return type** + +`int` + +### draw + + + +`Call.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)` + +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Call.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Call.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Call.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### arguments @@ -54,7 +257,7 @@ Parameters dictionary to be assigned to subroutine. `Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]] - + ### channels @@ -64,7 +267,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Channel`] - + ### duration @@ -74,7 +277,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -84,7 +287,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -94,7 +297,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -104,7 +307,7 @@ Name of this instruction. `str` - + ### operands @@ -114,7 +317,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -124,13 +327,13 @@ Unassigned parameters which determine the instruction behavior. `Set` - + ### prefix `= 'call'` - + ### start\_time @@ -140,7 +343,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -150,7 +353,7 @@ Relative end time of this instruction. `int` - + ### subroutine @@ -162,4 +365,5 @@ The program referenced by the call. **Return type** -program (Union\[[Schedule](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule"), [ScheduleBlock](qiskit.pulse.ScheduleBlock#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")]) +program (Union\[[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), [ScheduleBlock](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")]) + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Constant.md b/docs/api/qiskit/0.32/qiskit.pulse.Constant.md index bd8059b3950..4d938607047 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Constant.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Constant.md @@ -1,8 +1,16 @@ -# Constant +--- +title: Constant +description: API reference for qiskit.pulse.Constant +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Constant +--- +# Constant + -`Constant(duration, amp, name=None)` +`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` @@ -23,18 +31,131 @@ Initialize the constant-valued pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.Constant.assign#qiskit.pulse.Constant.assign "qiskit.pulse.Constant.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.Constant.assign_parameters#qiskit.pulse.Constant.assign_parameters "qiskit.pulse.Constant.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.Constant.draw#qiskit.pulse.Constant.draw "qiskit.pulse.Constant.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.Constant.get_waveform#qiskit.pulse.Constant.get_waveform "qiskit.pulse.Constant.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.Constant.is_parameterized#qiskit.pulse.Constant.is_parameterized "qiskit.pulse.Constant.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.Constant.validate_parameters#qiskit.pulse.Constant.validate_parameters "qiskit.pulse.Constant.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`Constant.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`Constant.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Constant.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. + +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`Constant.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -44,7 +165,7 @@ The constant value amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### id @@ -54,16 +175,17 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters **Return type** `Dict`\[`str`, `Any`] + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md index 2670deea83b..b4dba6f160f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ControlChannel.md @@ -1,8 +1,16 @@ -# ControlChannel +--- +title: ControlChannel +description: API reference for qiskit.pulse.ControlChannel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.ControlChannel +--- +# ControlChannel + -`ControlChannel(index)` +`ControlChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` @@ -16,14 +24,46 @@ Channel class. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`assign`](qiskit.pulse.ControlChannel.assign#qiskit.pulse.ControlChannel.assign "qiskit.pulse.ControlChannel.assign") | Return a new channel with the input Parameter assigned to value. | -| [`is_parameterized`](qiskit.pulse.ControlChannel.is_parameterized#qiskit.pulse.ControlChannel.is_parameterized "qiskit.pulse.ControlChannel.is_parameterized") | Return True iff the channel is parameterized. | +### assign -## Attributes + + +`ControlChannel.assign(parameter, value)` + +Return a new channel with the input Parameter assigned to value. + +**Parameters** + +* **parameter** (`Parameter`) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`Channel` + +**Returns** + +A new channel with updated parameters. + +**Raises** +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameter is not present in the channel. +### is\_parameterized + + + +`ControlChannel.is_parameterized()` + +Return True iff the channel is parameterized. + +**Return type** + +`bool` + +## Attributes + + ### index @@ -33,7 +73,7 @@ Return the index of this channel. The index is a label for a control signal line `Union`\[`int`, `ParameterExpression`] - + ### name @@ -43,7 +83,7 @@ Return the shorthand alias for this channel, which is based on its type and inde `str` - + ### parameters @@ -53,8 +93,9 @@ Parameters which determine the channel index. `Set` - + ### prefix `= 'u'` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Delay.md b/docs/api/qiskit/0.32/qiskit.pulse.Delay.md index ddd96a7e0eb..988a77b246f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Delay.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Delay.md @@ -1,8 +1,16 @@ -# Delay +--- +title: Delay +description: API reference for qiskit.pulse.Delay +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Delay +--- +# Delay + -`Delay(duration, channel, name=None)` +`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` @@ -32,22 +40,196 @@ No other instruction may be scheduled within a `Delay`. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.Delay.append#qiskit.pulse.Delay.append "qiskit.pulse.Delay.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.Delay.assign_parameters#qiskit.pulse.Delay.assign_parameters "qiskit.pulse.Delay.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.Delay.ch_duration#qiskit.pulse.Delay.ch_duration "qiskit.pulse.Delay.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.Delay.ch_start_time#qiskit.pulse.Delay.ch_start_time "qiskit.pulse.Delay.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.Delay.ch_stop_time#qiskit.pulse.Delay.ch_stop_time "qiskit.pulse.Delay.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.Delay.draw#qiskit.pulse.Delay.draw "qiskit.pulse.Delay.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.Delay.flatten#qiskit.pulse.Delay.flatten "qiskit.pulse.Delay.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.Delay.insert#qiskit.pulse.Delay.insert "qiskit.pulse.Delay.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.Delay.is_parameterized#qiskit.pulse.Delay.is_parameterized "qiskit.pulse.Delay.is_parameterized") | Return `True` iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.Delay.shift#qiskit.pulse.Delay.shift "qiskit.pulse.Delay.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Delay.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`Delay.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Delay.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Delay.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Delay.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`Delay.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Delay.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Delay.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Delay.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -57,7 +239,7 @@ Return the `Channel` that this instruction is scheduled on. `Channel` - + ### channels @@ -67,7 +249,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Channel`] - + ### duration @@ -77,7 +259,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -87,7 +269,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -97,7 +279,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -107,7 +289,7 @@ Name of this instruction. `str` - + ### operands @@ -117,7 +299,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -127,7 +309,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -137,7 +319,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -146,3 +328,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Drag.md b/docs/api/qiskit/0.32/qiskit.pulse.Drag.md index f53eda3183c..87d4e525b5f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Drag.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Drag.md @@ -1,8 +1,16 @@ -# Drag +--- +title: Drag +description: API reference for qiskit.pulse.Drag +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Drag +--- +# Drag + -`Drag(duration, amp, sigma, beta, name=None)` +`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` @@ -37,18 +45,131 @@ Initialize the drag pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.Drag.assign#qiskit.pulse.Drag.assign "qiskit.pulse.Drag.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.Drag.assign_parameters#qiskit.pulse.Drag.assign_parameters "qiskit.pulse.Drag.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.Drag.draw#qiskit.pulse.Drag.draw "qiskit.pulse.Drag.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.Drag.get_waveform#qiskit.pulse.Drag.get_waveform "qiskit.pulse.Drag.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.Drag.is_parameterized#qiskit.pulse.Drag.is_parameterized "qiskit.pulse.Drag.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.Drag.validate_parameters#qiskit.pulse.Drag.validate_parameters "qiskit.pulse.Drag.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`Drag.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`Drag.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Drag.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`Drag.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -58,7 +179,7 @@ The Gaussian amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### beta @@ -68,7 +189,7 @@ The weighing factor for the Gaussian derivative component of the waveform. `Union`\[`float`, `ParameterExpression`] - + ### id @@ -78,13 +199,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -92,7 +213,7 @@ Unique identifier for this pulse. `Dict`\[`str`, `Any`] - + ### sigma @@ -101,3 +222,4 @@ The Gaussian standard deviation of the pulse width. **Return type** `Union`\[`float`, `ParameterExpression`] + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md index c893bdbaf5e..e76436c993a 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.DriveChannel.md @@ -1,8 +1,16 @@ -# DriveChannel +--- +title: DriveChannel +description: API reference for qiskit.pulse.DriveChannel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.DriveChannel +--- +# DriveChannel + -`DriveChannel(index)` +`DriveChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` @@ -16,14 +24,46 @@ Channel class. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`assign`](qiskit.pulse.DriveChannel.assign#qiskit.pulse.DriveChannel.assign "qiskit.pulse.DriveChannel.assign") | Return a new channel with the input Parameter assigned to value. | -| [`is_parameterized`](qiskit.pulse.DriveChannel.is_parameterized#qiskit.pulse.DriveChannel.is_parameterized "qiskit.pulse.DriveChannel.is_parameterized") | Return True iff the channel is parameterized. | +### assign -## Attributes + + +`DriveChannel.assign(parameter, value)` + +Return a new channel with the input Parameter assigned to value. + +**Parameters** + +* **parameter** (`Parameter`) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`Channel` + +**Returns** + +A new channel with updated parameters. + +**Raises** +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameter is not present in the channel. +### is\_parameterized + + + +`DriveChannel.is_parameterized()` + +Return True iff the channel is parameterized. + +**Return type** + +`bool` + +## Attributes + + ### index @@ -33,7 +73,7 @@ Return the index of this channel. The index is a label for a control signal line `Union`\[`int`, `ParameterExpression`] - + ### name @@ -43,7 +83,7 @@ Return the shorthand alias for this channel, which is based on its type and inde `str` - + ### parameters @@ -53,8 +93,9 @@ Parameters which determine the channel index. `Set` - + ### prefix `= 'd'` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md b/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md index 6cf084f512b..e702d836cdd 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Gaussian.md @@ -1,8 +1,16 @@ -# Gaussian +--- +title: Gaussian +description: API reference for qiskit.pulse.Gaussian +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Gaussian +--- +# Gaussian + -`Gaussian(duration, amp, sigma, name=None)` +`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` @@ -23,18 +31,131 @@ Initialize the gaussian pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.Gaussian.assign#qiskit.pulse.Gaussian.assign "qiskit.pulse.Gaussian.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.Gaussian.assign_parameters#qiskit.pulse.Gaussian.assign_parameters "qiskit.pulse.Gaussian.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.Gaussian.draw#qiskit.pulse.Gaussian.draw "qiskit.pulse.Gaussian.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.Gaussian.get_waveform#qiskit.pulse.Gaussian.get_waveform "qiskit.pulse.Gaussian.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.Gaussian.is_parameterized#qiskit.pulse.Gaussian.is_parameterized "qiskit.pulse.Gaussian.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.Gaussian.validate_parameters#qiskit.pulse.Gaussian.validate_parameters "qiskit.pulse.Gaussian.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`Gaussian.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`Gaussian.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Gaussian.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`Gaussian.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -44,7 +165,7 @@ The Gaussian amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### id @@ -54,13 +175,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -68,7 +189,7 @@ Unique identifier for this pulse. `Dict`\[`str`, `Any`] - + ### sigma @@ -77,3 +198,4 @@ The Gaussian standard deviation of the pulse width. **Return type** `Union`\[`float`, `ParameterExpression`] + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md b/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md index 23016916473..7f8a3a3f7fd 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.GaussianSquare.md @@ -1,8 +1,16 @@ -# GaussianSquare +--- +title: GaussianSquare +description: API reference for qiskit.pulse.GaussianSquare +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.GaussianSquare +--- +# GaussianSquare + -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` +`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` @@ -41,18 +49,131 @@ Initialize the gaussian square pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.GaussianSquare.assign#qiskit.pulse.GaussianSquare.assign "qiskit.pulse.GaussianSquare.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.GaussianSquare.assign_parameters#qiskit.pulse.GaussianSquare.assign_parameters "qiskit.pulse.GaussianSquare.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.GaussianSquare.draw#qiskit.pulse.GaussianSquare.draw "qiskit.pulse.GaussianSquare.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.GaussianSquare.get_waveform#qiskit.pulse.GaussianSquare.get_waveform "qiskit.pulse.GaussianSquare.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.GaussianSquare.is_parameterized#qiskit.pulse.GaussianSquare.is_parameterized "qiskit.pulse.GaussianSquare.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.GaussianSquare.validate_parameters#qiskit.pulse.GaussianSquare.validate_parameters "qiskit.pulse.GaussianSquare.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`GaussianSquare.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`GaussianSquare.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`GaussianSquare.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`GaussianSquare.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -62,7 +183,7 @@ The Gaussian amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### id @@ -72,13 +193,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -86,7 +207,7 @@ Unique identifier for this pulse. `Dict`\[`str`, `Any`] - + ### risefall\_sigma\_ratio @@ -96,7 +217,7 @@ The duration of each risefall in terms of sigma. `Union`\[`float`, `ParameterExpression`] - + ### sigma @@ -106,7 +227,7 @@ The Gaussian standard deviation of the pulse width. `Union`\[`float`, `ParameterExpression`] - + ### width @@ -115,3 +236,4 @@ The width of the square portion of the pulse. **Return type** `Union`\[`float`, `ParameterExpression`] + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md b/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md index 030a7fd9344..ed76521b1e2 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Instruction.md @@ -1,8 +1,16 @@ -# Instruction +--- +title: Instruction +description: API reference for qiskit.pulse.Instruction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Instruction +--- +# Instruction + -`Instruction(operands, duration=None, channels=None, name=None)` +`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` @@ -19,27 +27,201 @@ Instruction initializer. **Raises** -* [**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If duration is negative. -* [**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the input `channels` are not all of type `Channel`. +* [**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If duration is negative. +* [**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the input `channels` are not all of type `Channel`. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.Instruction.append#qiskit.pulse.Instruction.append "qiskit.pulse.Instruction.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.Instruction.assign_parameters#qiskit.pulse.Instruction.assign_parameters "qiskit.pulse.Instruction.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.Instruction.ch_duration#qiskit.pulse.Instruction.ch_duration "qiskit.pulse.Instruction.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.Instruction.ch_start_time#qiskit.pulse.Instruction.ch_start_time "qiskit.pulse.Instruction.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.Instruction.ch_stop_time#qiskit.pulse.Instruction.ch_stop_time "qiskit.pulse.Instruction.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.Instruction.draw#qiskit.pulse.Instruction.draw "qiskit.pulse.Instruction.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.Instruction.flatten#qiskit.pulse.Instruction.flatten "qiskit.pulse.Instruction.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.Instruction.insert#qiskit.pulse.Instruction.insert "qiskit.pulse.Instruction.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.Instruction.is_parameterized#qiskit.pulse.Instruction.is_parameterized "qiskit.pulse.Instruction.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.Instruction.shift#qiskit.pulse.Instruction.shift "qiskit.pulse.Instruction.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`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. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`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. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`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. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`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. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + +`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. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`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. + +**Return type** + +`Instruction` + +### insert + + + +`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`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`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. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channels @@ -49,7 +231,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Channel`] - + ### duration @@ -59,7 +241,7 @@ Duration of this instruction. `int` - + ### id @@ -69,7 +251,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -79,7 +261,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -89,7 +271,7 @@ Name of this instruction. `str` - + ### operands @@ -99,7 +281,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -109,7 +291,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -119,7 +301,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -128,3 +310,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md b/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md index 749d335c2d3..1151ecd4dfb 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.InstructionScheduleMap.md @@ -1,12 +1,20 @@ -# InstructionScheduleMap +--- +title: InstructionScheduleMap +description: API reference for qiskit.pulse.InstructionScheduleMap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.InstructionScheduleMap +--- +# InstructionScheduleMap + -`InstructionScheduleMap` +`InstructionScheduleMap`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instruction_schedule_map.py "view source code") Bases: `object` -Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction#qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: +Mapping from [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") [`qiskit.circuit.Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction") names and qubits to [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") s. In particular, the mapping is formatted as type: ```python Dict[str, Dict[Tuple[int], Schedule]] @@ -20,21 +28,210 @@ Initialize a circuit instruction to schedule mapper instance. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`add`](qiskit.pulse.InstructionScheduleMap.add#qiskit.pulse.InstructionScheduleMap.add "qiskit.pulse.InstructionScheduleMap.add") | Add a new known instruction for the given qubits and its mapping to a pulse schedule. | -| [`assert_has`](qiskit.pulse.InstructionScheduleMap.assert_has#qiskit.pulse.InstructionScheduleMap.assert_has "qiskit.pulse.InstructionScheduleMap.assert_has") | Error if the given instruction is not defined. | -| [`get`](qiskit.pulse.InstructionScheduleMap.get#qiskit.pulse.InstructionScheduleMap.get "qiskit.pulse.InstructionScheduleMap.get") | Return the defined [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") or [`ScheduleBlock`](qiskit.pulse.ScheduleBlock#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") for the given instruction on the given qubits. | -| [`get_parameters`](qiskit.pulse.InstructionScheduleMap.get_parameters#qiskit.pulse.InstructionScheduleMap.get_parameters "qiskit.pulse.InstructionScheduleMap.get_parameters") | Return the list of parameters taken by the given instruction on the given qubits. | -| [`has`](qiskit.pulse.InstructionScheduleMap.has#qiskit.pulse.InstructionScheduleMap.has "qiskit.pulse.InstructionScheduleMap.has") | Is the instruction defined for the given qubits? | -| [`pop`](qiskit.pulse.InstructionScheduleMap.pop#qiskit.pulse.InstructionScheduleMap.pop "qiskit.pulse.InstructionScheduleMap.pop") | Remove and return the defined schedule for the given instruction on the given qubits. | -| [`qubit_instructions`](qiskit.pulse.InstructionScheduleMap.qubit_instructions#qiskit.pulse.InstructionScheduleMap.qubit_instructions "qiskit.pulse.InstructionScheduleMap.qubit_instructions") | Return a list of the instruction names that are defined by the backend for the given qubit or qubits. | -| [`qubits_with_instruction`](qiskit.pulse.InstructionScheduleMap.qubits_with_instruction#qiskit.pulse.InstructionScheduleMap.qubits_with_instruction "qiskit.pulse.InstructionScheduleMap.qubits_with_instruction") | Return a list of the qubits for which the given instruction is defined. | -| [`remove`](qiskit.pulse.InstructionScheduleMap.remove#qiskit.pulse.InstructionScheduleMap.remove "qiskit.pulse.InstructionScheduleMap.remove") | Remove the given instruction from the listing of instructions defined in self. | +### add -## Attributes + + +`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. + +**Parameters** + +* **instruction** (`Union`\[`str`, `Instruction`]) – The name of the instruction to add. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The qubits which the instruction applies to. +* **schedule** (`Union`\[`Schedule`, `ScheduleBlock`, `Callable`\[…, `Union`\[`Schedule`, `ScheduleBlock`]]]) – The Schedule that implements the given instruction. +* **arguments** (`Optional`\[`List`\[`str`]]) – List of parameter names to create a parameter-bound schedule from the associated gate instruction. If [`get()`](qiskit.pulse.InstructionScheduleMap#get "qiskit.pulse.InstructionScheduleMap.get") is called with arguments rather than keyword arguments, this parameter list is used to map the input arguments to parameter objects stored in the target schedule. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the qubits are provided as an empty iterable. + +**Return type** + +`None` + +### assert\_has + + + +`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. + +**Parameters** + +* **instruction** (`Union`\[`str`, `Instruction`]) – The instruction for which to look. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The specific qubits for the instruction. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the instruction is not defined on the qubits. + +**Return type** + +`None` + +### get + + + +`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. + +If all keys are not specified this method returns schedule with unbound parameters. + +**Parameters** +* **instruction** (`Union`\[`str`, `Instruction`]) – Name of the instruction or the instruction itself. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The qubits for the instruction. +* **\*params** – Command parameters for generating the output schedule. +* **\*\*kwparams** – Keyworded command parameters for generating the schedule. + +**Return type** + +`Union`\[`Schedule`, `ScheduleBlock`] + +**Returns** + +The Schedule defined for the input. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When invalid parameters are specified. + +### get\_parameters + + + +`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. + +**Parameters** + +* **instruction** (`Union`\[`str`, `Instruction`]) – Name of the instruction. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The qubits for the instruction. + +**Return type** + +`Tuple`\[`str`] + +**Returns** + +The names of the parameters required by the instruction. + +### has + + + +`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? + +**Parameters** + +* **instruction** (`Union`\[`str`, `Instruction`]) – The instruction for which to look. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The specific qubits for the instruction. + +**Return type** +`bool` + +**Returns** + +True iff the instruction is defined. + +### pop + + + +`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. + +**Parameters** + +* **instruction** (`Union`\[`str`, `Instruction`]) – Name of the instruction. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The qubits for the instruction. +* **\*params** – Command parameters for generating the output schedule. +* **\*\*kwparams** – Keyworded command parameters for generating the schedule. + +**Return type** + +`Union`\[`Schedule`, `ScheduleBlock`] + +**Returns** + +The Schedule defined for the input. + +### qubit\_instructions + + + +`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. + +**Parameters** + +**qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – A qubit index, or a list or tuple of indices. + +**Return type** + +`List`\[`str`] + +**Returns** + +All the instructions which are defined on the qubits. + +For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instructions which apply to that whole set of qubits (e.g. `qubits=[0, 1]` may return `['cx']`). + +### qubits\_with\_instruction + + + +`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. + +**Parameters** + +**instruction** (`Union`\[`str`, `Instruction`]) – The name of the circuit instruction. + +**Return type** + +`List`\[`Union`\[`int`, `Tuple`\[`int`]]] + +**Returns** + +Qubit indices which have the given instruction defined. This is a list of tuples if the instruction has an arity greater than 1, or a flat list of ints otherwise. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the instruction is not found. + +### remove + + + +`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. + +**Parameters** + +* **instruction** (`Union`\[`str`, `Instruction`]) – The name of the instruction to add. +* **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – The qubits which the instruction applies to. + +**Return type** + +`None` + +## Attributes + + ### instructions @@ -49,3 +246,4 @@ By default, these are typically the basis gates along with other instructions su **Returns** The names of all the circuit instructions which have Schedule definitions in this. + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md b/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md index 52d27784768..37f7f62aa03 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.MeasureChannel.md @@ -1,8 +1,16 @@ -# MeasureChannel +--- +title: MeasureChannel +description: API reference for qiskit.pulse.MeasureChannel +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.MeasureChannel +--- +# MeasureChannel + -`MeasureChannel(index)` +`MeasureChannel(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.PulseChannel` @@ -16,14 +24,46 @@ Channel class. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`assign`](qiskit.pulse.MeasureChannel.assign#qiskit.pulse.MeasureChannel.assign "qiskit.pulse.MeasureChannel.assign") | Return a new channel with the input Parameter assigned to value. | -| [`is_parameterized`](qiskit.pulse.MeasureChannel.is_parameterized#qiskit.pulse.MeasureChannel.is_parameterized "qiskit.pulse.MeasureChannel.is_parameterized") | Return True iff the channel is parameterized. | +### assign -## Attributes + + +`MeasureChannel.assign(parameter, value)` + +Return a new channel with the input Parameter assigned to value. + +**Parameters** + +* **parameter** (`Parameter`) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`Channel` + +**Returns** + +A new channel with updated parameters. + +**Raises** +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameter is not present in the channel. +### is\_parameterized + + + +`MeasureChannel.is_parameterized()` + +Return True iff the channel is parameterized. + +**Return type** + +`bool` + +## Attributes + + ### index @@ -33,7 +73,7 @@ Return the index of this channel. The index is a label for a control signal line `Union`\[`int`, `ParameterExpression`] - + ### name @@ -43,7 +83,7 @@ Return the shorthand alias for this channel, which is based on its type and inde `str` - + ### parameters @@ -53,8 +93,9 @@ Parameters which determine the channel index. `Set` - + ### prefix `= 'm'` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md b/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md index 60d9b344e18..9ac277595cf 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.MemorySlot.md @@ -1,8 +1,16 @@ -# MemorySlot +--- +title: MemorySlot +description: API reference for qiskit.pulse.MemorySlot +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.MemorySlot +--- +# MemorySlot + -`MemorySlot(index)` +`MemorySlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` @@ -16,14 +24,46 @@ Channel class. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`assign`](qiskit.pulse.MemorySlot.assign#qiskit.pulse.MemorySlot.assign "qiskit.pulse.MemorySlot.assign") | Return a new channel with the input Parameter assigned to value. | -| [`is_parameterized`](qiskit.pulse.MemorySlot.is_parameterized#qiskit.pulse.MemorySlot.is_parameterized "qiskit.pulse.MemorySlot.is_parameterized") | Return True iff the channel is parameterized. | +### assign -## Attributes + + +`MemorySlot.assign(parameter, value)` + +Return a new channel with the input Parameter assigned to value. + +**Parameters** + +* **parameter** (`Parameter`) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`Channel` + +**Returns** + +A new channel with updated parameters. + +**Raises** +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameter is not present in the channel. +### is\_parameterized + + + +`MemorySlot.is_parameterized()` + +Return True iff the channel is parameterized. + +**Return type** + +`bool` + +## Attributes + + ### index @@ -33,7 +73,7 @@ Return the index of this channel. The index is a label for a control signal line `Union`\[`int`, `ParameterExpression`] - + ### name @@ -43,7 +83,7 @@ Return the shorthand alias for this channel, which is based on its type and inde `str` - + ### parameters @@ -53,8 +93,9 @@ Parameters which determine the channel index. `Set` - + ### prefix `= 'm'` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Play.md b/docs/api/qiskit/0.32/qiskit.pulse.Play.md index 52fe1331e8c..da5ab8a6b88 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Play.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Play.md @@ -1,8 +1,16 @@ -# Play +--- +title: Play +description: API reference for qiskit.pulse.Play +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Play +--- +# Play + -`Play(pulse, channel, name=None)` +`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` @@ -14,32 +22,206 @@ Create a new pulse instruction. **Parameters** -* **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform#qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). +* **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). * **channel** (`PulseChannel`) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If pulse is not a Pulse type. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If pulse is not a Pulse type. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.Play.append#qiskit.pulse.Play.append "qiskit.pulse.Play.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.Play.assign_parameters#qiskit.pulse.Play.assign_parameters "qiskit.pulse.Play.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.Play.ch_duration#qiskit.pulse.Play.ch_duration "qiskit.pulse.Play.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.Play.ch_start_time#qiskit.pulse.Play.ch_start_time "qiskit.pulse.Play.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.Play.ch_stop_time#qiskit.pulse.Play.ch_stop_time "qiskit.pulse.Play.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.Play.draw#qiskit.pulse.Play.draw "qiskit.pulse.Play.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.Play.flatten#qiskit.pulse.Play.flatten "qiskit.pulse.Play.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.Play.insert#qiskit.pulse.Play.insert "qiskit.pulse.Play.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.Play.is_parameterized#qiskit.pulse.Play.is_parameterized "qiskit.pulse.Play.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.Play.shift#qiskit.pulse.Play.shift "qiskit.pulse.Play.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Play.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`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. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Play` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Play.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Play.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Play.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`Play.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Play.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Play.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Play.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -49,7 +231,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -59,7 +241,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -69,7 +251,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -79,7 +261,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -89,7 +271,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -99,7 +281,7 @@ Name of this instruction. `str` - + ### operands @@ -109,7 +291,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -119,7 +301,7 @@ Parameters which determine the instruction behavior. `Set` - + ### pulse @@ -129,7 +311,7 @@ A description of the samples that will be played. `Pulse` - + ### start\_time @@ -139,7 +321,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -148,3 +330,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md b/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md index 69cd77ae28b..4a3cdeb7c7e 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.PulseError.md @@ -1,9 +1,18 @@ -# qiskit.pulse.PulseError +--- +title: PulseError +description: API reference for qiskit.pulse.PulseError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.pulse.PulseError +--- +# qiskit.pulse.PulseError + -`PulseError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md b/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md index 7473db26b59..09a49766530 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.RegisterSlot.md @@ -1,8 +1,16 @@ -# RegisterSlot +--- +title: RegisterSlot +description: API reference for qiskit.pulse.RegisterSlot +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.RegisterSlot +--- +# RegisterSlot + -`RegisterSlot(index)` +`RegisterSlot(index)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/channels.py "view source code") Bases: `qiskit.pulse.channels.Channel` @@ -16,14 +24,46 @@ Channel class. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`assign`](qiskit.pulse.RegisterSlot.assign#qiskit.pulse.RegisterSlot.assign "qiskit.pulse.RegisterSlot.assign") | Return a new channel with the input Parameter assigned to value. | -| [`is_parameterized`](qiskit.pulse.RegisterSlot.is_parameterized#qiskit.pulse.RegisterSlot.is_parameterized "qiskit.pulse.RegisterSlot.is_parameterized") | Return True iff the channel is parameterized. | +### assign -## Attributes + + +`RegisterSlot.assign(parameter, value)` + +Return a new channel with the input Parameter assigned to value. + +**Parameters** + +* **parameter** (`Parameter`) – A parameter in this expression whose value will be updated. +* **value** (`Union`\[`ParameterExpression`, `float`]) – The new value to bind to. + +**Return type** + +`Channel` + +**Returns** + +A new channel with updated parameters. + +**Raises** +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameter is not present in the channel. +### is\_parameterized + + + +`RegisterSlot.is_parameterized()` + +Return True iff the channel is parameterized. + +**Return type** + +`bool` + +## Attributes + + ### index @@ -33,7 +73,7 @@ Return the index of this channel. The index is a label for a control signal line `Union`\[`int`, `ParameterExpression`] - + ### name @@ -43,7 +83,7 @@ Return the shorthand alias for this channel, which is based on its type and inde `str` - + ### parameters @@ -53,8 +93,9 @@ Parameters which determine the channel index. `Set` - + ### prefix `= 'c'` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md b/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md index 003bf8ab4c1..acae5066917 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Schedule.md @@ -1,8 +1,16 @@ -# Schedule +--- +title: Schedule +description: API reference for qiskit.pulse.Schedule +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Schedule +--- +# Schedule + -`Schedule(*schedules, name=None, metadata=None)` +`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` @@ -41,7 +49,7 @@ sched2 = sched1 | sched2 A `PulseError` is immediately raised when the overlap constraint is violated. -In the schedule representation, we cannot parametrize the duration of instructions. Thus we need to create a new schedule object for each duration. To parametrize an instruction’s duration, the [`ScheduleBlock`](qiskit.pulse.ScheduleBlock#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") representation may be used instead. +In the schedule representation, we cannot parametrize the duration of instructions. Thus we need to create a new schedule object for each duration. To parametrize an instruction’s duration, the [`ScheduleBlock`](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock") representation may be used instead. ## References @@ -61,27 +69,392 @@ Create an empty schedule. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.Schedule.append#qiskit.pulse.Schedule.append "qiskit.pulse.Schedule.append") | Return a new schedule with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.Schedule.assign_parameters#qiskit.pulse.Schedule.assign_parameters "qiskit.pulse.Schedule.assign_parameters") | Assign the parameters in this schedule according to the input. | -| [`ch_duration`](qiskit.pulse.Schedule.ch_duration#qiskit.pulse.Schedule.ch_duration "qiskit.pulse.Schedule.ch_duration") | Return the time of the end of the last instruction over the supplied channels. | -| [`ch_start_time`](qiskit.pulse.Schedule.ch_start_time#qiskit.pulse.Schedule.ch_start_time "qiskit.pulse.Schedule.ch_start_time") | Return the time of the start of the first instruction over the supplied channels. | -| [`ch_stop_time`](qiskit.pulse.Schedule.ch_stop_time#qiskit.pulse.Schedule.ch_stop_time "qiskit.pulse.Schedule.ch_stop_time") | Return maximum start time over supplied channels. | -| [`draw`](qiskit.pulse.Schedule.draw#qiskit.pulse.Schedule.draw "qiskit.pulse.Schedule.draw") | Plot the schedule. | -| [`exclude`](qiskit.pulse.Schedule.exclude#qiskit.pulse.Schedule.exclude "qiskit.pulse.Schedule.exclude") | 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::. | -| [`filter`](qiskit.pulse.Schedule.filter#qiskit.pulse.Schedule.filter "qiskit.pulse.Schedule.filter") | 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`. | -| [`flatten`](qiskit.pulse.Schedule.flatten#qiskit.pulse.Schedule.flatten "qiskit.pulse.Schedule.flatten") | Deprecated. | -| [`get_parameters`](qiskit.pulse.Schedule.get_parameters#qiskit.pulse.Schedule.get_parameters "qiskit.pulse.Schedule.get_parameters") | Get parameter object bound to this schedule by string name. | -| [`initialize_from`](qiskit.pulse.Schedule.initialize_from#qiskit.pulse.Schedule.initialize_from "qiskit.pulse.Schedule.initialize_from") | Create new schedule object with metadata of another schedule object. | -| [`insert`](qiskit.pulse.Schedule.insert#qiskit.pulse.Schedule.insert "qiskit.pulse.Schedule.insert") | Return a new schedule with `schedule` inserted into `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.Schedule.is_parameterized#qiskit.pulse.Schedule.is_parameterized "qiskit.pulse.Schedule.is_parameterized") | Return True iff the instruction is parameterized. | -| [`replace`](qiskit.pulse.Schedule.replace#qiskit.pulse.Schedule.replace "qiskit.pulse.Schedule.replace") | Return a `Schedule` with the `old` instruction replaced with a `new` instruction. | -| [`shift`](qiskit.pulse.Schedule.shift#qiskit.pulse.Schedule.shift "qiskit.pulse.Schedule.shift") | Return a schedule shifted forward by `time`. | +### append -## Attributes + + +`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`. + +$$ +t = \textrm{max}(\texttt{x.stop_time} |\texttt{x} \in + \texttt{self.channels} \cap \texttt{schedule.channels}) +$$ + +**Parameters** + +* **schedule** (`Union`\[`Schedule`, `Instruction`]) – Schedule to be appended. +* **name** (`Optional`\[`str`]) – Name of the new `Schedule`. Defaults to name of `self`. +* **inplace** (`bool`) – Perform operation inplace on this schedule. Otherwise return a new `Schedule`. + +**Return type** + +`Schedule` + +### assign\_parameters + + + +`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. + +**Parameters** + +* **value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. +* **inplace** (`bool`) – Set `True` to override this instance with new parameter. + +**Return type** + +`Schedule` + +**Returns** + +Schedule with updated parameters. + +### ch\_duration + + + +`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. + +**Parameters** + +**\*channels** – Channels within `self` to include. + +**Return type** + +`int` + +### ch\_start\_time + + + +`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. + +**Parameters** + +**\*channels** – Channels within `self` to include. + +**Return type** + +`int` + +### ch\_stop\_time + + + +`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. + +**Parameters** + +**\*channels** – Channels within `self` to include. + +**Return type** + +`int` + +### draw + + + +`Schedule.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, plot_all=None, plot_range=None, interactive=None, table=None, label=None, framechange=None, channels=None, show_framechange_channels=None, draw_title=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)` + +Plot the schedule. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See `IQXStandard`, `IQXSimple`, and `IQXDebugging` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple (tmin, tmax). + +* **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. + +* **disable\_channels** (`Optional`\[`List`\[`Channel`]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. + +* **show\_snapshot** (`bool`) – Show snapshot instructions. + +* **show\_framechange** (`bool`) – Show frame change instructions. The frame change represents instructions that modulate phase or frequency of pulse channels. + +* **show\_waveform\_info** (`bool`) – Show additional information about waveforms such as their name. + +* **show\_barrier** (`bool`) – Show barrier lines. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as ``axis`` input. + ``` + + `axis` and `style` kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call `.savefig` method with returned Matplotlib Figure object. + +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **channel\_scales** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **plot\_all** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **plot\_range** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **table** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **label** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **framechange** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **channels** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **show\_framechange\_channels** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### exclude + + + +`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: + +```python +self.filter(args) | self.exclude(args) == self +``` + +**Parameters** + +* **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. +* **channels** (`Optional`\[`Iterable`\[`Channel`]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. +* **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **check\_subroutine** (`bool`) – Set True to individually filter instructions inside of a subroutine defined by the [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") instruction. + +**Return type** + +`Schedule` + +### filter + + + +`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`. + +If no arguments are provided, `self` is returned. + +**Parameters** +* **filter\_funcs** (`Callable`) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. +* **channels** (`Optional`\[`Iterable`\[`Channel`]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. +* **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **check\_subroutine** (`bool`) – Set True to individually filter instructions inside of a subroutine defined by the [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") instruction. + +**Return type** + +`Schedule` + +### flatten + + + +`Schedule.flatten()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") + +Deprecated. + +**Return type** + +`Schedule` + +### get\_parameters + + + +`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. + +Because different `Parameter` objects can have the same name, this method returns a list of `Parameter` s for the provided name. + +**Parameters** + +**parameter\_name** (`str`) – Name of parameter. + +**Return type** + +`List`\[`Parameter`] + +**Returns** + +Parameter objects that have corresponding name. + +### initialize\_from + + + +`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. + +**Parameters** + +* **other\_program** (`Any`) – Qiskit program that provides metadata to new object. +* **name** (`Optional`\[`str`]) – Name of new schedule. Name of `schedule` is used by default. + +**Return type** + +`Schedule` + +**Returns** + +New schedule object with name and metadata. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When other\_program does not provide necessary information. + +### insert + + + +`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`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule. +* **schedule** (`Union`\[`Schedule`, `Instruction`]) – Schedule to insert. +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to the name of self. +* **inplace** (`bool`) – Perform operation inplace on this schedule. Otherwise return a new `Schedule`. + +**Return type** + +`Schedule` + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### replace + + + +`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. + +The replacement matching is based on an instruction equality check. + +```python +from qiskit import pulse + +d0 = pulse.DriveChannel(0) + +sched = pulse.Schedule() + +old = pulse.Play(pulse.Constant(100, 1.0), d0) +new = pulse.Play(pulse.Constant(100, 0.1), d0) + +sched += old + +sched = sched.replace(old, new) + +assert sched == pulse.Schedule(new) +``` + +Only matches at the top-level of the schedule tree. If you wish to perform this replacement over all instructions in the schedule tree. Flatten the schedule prior to running: + +```python +.. jupyter-execute:: +``` + +> sched = pulse.Schedule() +> +> sched += pulse.Schedule(old) +> +> sched = sched.flatten() +> +> sched = sched.replace(old, new) +> +> assert sched == pulse.Schedule(new) + +**Parameters** + +* **old** (`Union`\[`Schedule`, `Instruction`]) – Instruction to replace. +* **new** (`Union`\[`Schedule`, `Instruction`]) – Instruction to replace with. +* **inplace** (`bool`) – Replace instruction by mutably modifying this `Schedule`. + +**Return type** + +`Schedule` + +**Returns** + +The modified schedule with `old` replaced by `new`. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the `Schedule` after replacements will has a timing overlap. + +### shift + + + +`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`. + +**Parameters** + +* **time** (`int`) – Time to shift by. +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to the name of self. +* **inplace** (`bool`) – Perform operation inplace on this schedule. Otherwise return a new `Schedule`. + +**Return type** + +`Schedule` + +## Attributes + + ### channels @@ -91,7 +464,7 @@ Returns channels that this schedule uses. `Tuple`\[`Channel`] - + ### children @@ -109,7 +482,7 @@ Nested schedules are returned as-is. If you want to collect only instructions, u A tuple, where each element is a two-tuple containing the initial scheduled time of each `NamedValue` and the component itself. - + ### duration @@ -119,13 +492,13 @@ Duration of this schedule. `int` - + ### instances\_counter `= count(0)` - + ### instructions @@ -135,7 +508,7 @@ Get the time-ordered instructions from self. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### metadata @@ -147,7 +520,7 @@ User provided `dict` of metadata for the schedule. The metadata contents do not `Dict`\[`str`, `Any`] - + ### name @@ -157,7 +530,7 @@ Name of this Schedule `str` - + ### parameters @@ -167,13 +540,13 @@ Parameters which determine the schedule behavior. `Set` - + ### prefix `= 'sched'` - + ### start\_time @@ -183,7 +556,7 @@ Starting time of this schedule. `int` - + ### stop\_time @@ -193,7 +566,7 @@ Stopping time of this schedule. `int` - + ### timeslots @@ -202,3 +575,4 @@ Time keeping attribute. **Return type** `Dict`\[`Channel`, `List`\[`Tuple`\[`int`, `int`]]] + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md b/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md index 97b382c932b..6be4597cd35 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ScheduleBlock.md @@ -1,8 +1,16 @@ -# ScheduleBlock +--- +title: ScheduleBlock +description: API reference for qiskit.pulse.ScheduleBlock +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.ScheduleBlock +--- +# ScheduleBlock + -`ScheduleBlock(name=None, metadata=None, alignment_context=None)` +`ScheduleBlock(name=None, metadata=None, alignment_context=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/schedule.py "view source code") Bases: `object` @@ -18,7 +26,7 @@ A `ScheduleBlock` is a time-ordered sequence of instructions and transform macro The `ScheduleBlock` defaults to the `AlignLeft` alignment. The timing overlap constraint of instructions is not immediately evaluated, and thus we can assign a parameter object to the instruction duration. Instructions are implicitly scheduled at optimum time when the program is executed. -Note that `ScheduleBlock` can contain [`Instruction`](qiskit.pulse.instructions.Instruction#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction") and other `ScheduleBlock` to build an experimental program, but `Schedule` is not supported. This should be added as a [`Call`](qiskit.pulse.instructions.Call#qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") instruction. This conversion is automatically performed with the pulse builder. +Note that `ScheduleBlock` can contain [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction") and other `ScheduleBlock` to build an experimental program, but `Schedule` is not supported. This should be added as a [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") instruction. This conversion is automatically performed with the pulse builder. By using `ScheduleBlock` representation we can fully parametrize pulse waveforms. For example, Rabi schedule generator can be defined as @@ -51,33 +59,386 @@ Create an empty schedule block. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.ScheduleBlock.append#qiskit.pulse.ScheduleBlock.append "qiskit.pulse.ScheduleBlock.append") | Return a new schedule block with `block` appended to the context block. | -| [`assign_parameters`](qiskit.pulse.ScheduleBlock.assign_parameters#qiskit.pulse.ScheduleBlock.assign_parameters "qiskit.pulse.ScheduleBlock.assign_parameters") | Assign the parameters in this schedule according to the input. | -| [`ch_duration`](qiskit.pulse.ScheduleBlock.ch_duration#qiskit.pulse.ScheduleBlock.ch_duration "qiskit.pulse.ScheduleBlock.ch_duration") | Return the time of the end of the last instruction over the supplied channels. | -| [`ch_start_time`](qiskit.pulse.ScheduleBlock.ch_start_time#qiskit.pulse.ScheduleBlock.ch_start_time "qiskit.pulse.ScheduleBlock.ch_start_time") | Return the time of the start of the first instruction over the supplied channels. | -| [`ch_stop_time`](qiskit.pulse.ScheduleBlock.ch_stop_time#qiskit.pulse.ScheduleBlock.ch_stop_time "qiskit.pulse.ScheduleBlock.ch_stop_time") | Return maximum start time over supplied channels. | -| [`draw`](qiskit.pulse.ScheduleBlock.draw#qiskit.pulse.ScheduleBlock.draw "qiskit.pulse.ScheduleBlock.draw") | Plot the schedule. | -| [`exclude`](qiskit.pulse.ScheduleBlock.exclude#qiskit.pulse.ScheduleBlock.exclude "qiskit.pulse.ScheduleBlock.exclude") | 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::. | -| [`filter`](qiskit.pulse.ScheduleBlock.filter#qiskit.pulse.ScheduleBlock.filter "qiskit.pulse.ScheduleBlock.filter") | 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`. | -| [`get_parameters`](qiskit.pulse.ScheduleBlock.get_parameters#qiskit.pulse.ScheduleBlock.get_parameters "qiskit.pulse.ScheduleBlock.get_parameters") | Get parameter object bound to this schedule by string name. | -| [`initialize_from`](qiskit.pulse.ScheduleBlock.initialize_from#qiskit.pulse.ScheduleBlock.initialize_from "qiskit.pulse.ScheduleBlock.initialize_from") | Create new schedule object with metadata of another schedule object. | -| [`insert`](qiskit.pulse.ScheduleBlock.insert#qiskit.pulse.ScheduleBlock.insert "qiskit.pulse.ScheduleBlock.insert") | This method will be removed. | -| [`is_parameterized`](qiskit.pulse.ScheduleBlock.is_parameterized#qiskit.pulse.ScheduleBlock.is_parameterized "qiskit.pulse.ScheduleBlock.is_parameterized") | Return True iff the instruction is parameterized. | -| [`is_schedulable`](qiskit.pulse.ScheduleBlock.is_schedulable#qiskit.pulse.ScheduleBlock.is_schedulable "qiskit.pulse.ScheduleBlock.is_schedulable") | Return `True` if all durations are assigned. | -| [`replace`](qiskit.pulse.ScheduleBlock.replace#qiskit.pulse.ScheduleBlock.replace "qiskit.pulse.ScheduleBlock.replace") | Return a `ScheduleBlock` with the `old` component replaced with a `new` component. | -| [`shift`](qiskit.pulse.ScheduleBlock.shift#qiskit.pulse.ScheduleBlock.shift "qiskit.pulse.ScheduleBlock.shift") | This method will be removed. | +### append -## Attributes + + +`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. + +**Parameters** + +* **block** (`Union`\[`ScheduleBlock`, `Instruction`]) – ScheduleBlock to be appended. +* **name** (`Optional`\[`str`]) – Name of the new `Schedule`. Defaults to name of `self`. +* **inplace** (`bool`) – Perform operation inplace on this schedule. Otherwise return a new `Schedule`. + +**Return type** + +`ScheduleBlock` + +**Returns** + +Schedule block with appended schedule. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When invalid schedule type is specified. + +### assign\_parameters + + + +`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. + +**Parameters** + +* **value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. +* **inplace** (`bool`) – Set `True` to override this instance with new parameter. + +**Return type** + +`ScheduleBlock` + +**Returns** + +Schedule with updated parameters. +### ch\_duration + + + +`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. + +**Parameters** + +**\*channels** – Channels within `self` to include. + +**Return type** + +`int` + +### ch\_start\_time + + + +`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. + +**Parameters** + +**\*channels** – Channels within `self` to include. + +**Return type** + +`int` + +### ch\_stop\_time + + + +`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. + +**Parameters** +**\*channels** – Channels within `self` to include. + +**Return type** + +`int` + +### draw + + + +`ScheduleBlock.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, channel_scales=None, plot_all=None, plot_range=None, interactive=None, table=None, label=None, framechange=None, channels=None, show_framechange_channels=None, draw_title=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)` + +Plot the schedule. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See `IQXStandard`, `IQXSimple`, and `IQXDebugging` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple (tmin, tmax). + +* **time\_unit** (`str`) – The unit of specified time range either dt or ns. The unit of ns is available only when backend object is provided. + +* **disable\_channels** (`Optional`\[`List`\[`Channel`]]) – A control property to show specific pulse channel. Pulse channel instances provided as a list are not shown in the output image. + +* **show\_snapshot** (`bool`) – Show snapshot instructions. + +* **show\_framechange** (`bool`) – Show frame change instructions. The frame change represents instructions that modulate phase or frequency of pulse channels. + +* **show\_waveform\_info** (`bool`) – Show additional information about waveforms such as their name. + +* **show\_barrier** (`bool`) – Show barrier lines. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as ``axis`` input. + ``` + + `axis` and `style` kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call `.savefig` method with returned Matplotlib Figure object. + +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **channel\_scales** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **plot\_all** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **plot\_range** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **table** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **label** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **framechange** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **channels** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **show\_framechange\_channels** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### exclude + + + +`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: + +```python +self.filter(args) | self.exclude(args) == self +``` + + + This method is currently not supported. Support will be soon added please create an issue if you believe this must be prioritized. + + +**Parameters** + +* **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. +* **channels** (`Optional`\[`Iterable`\[`Channel`]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. +* **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **check\_subroutine** (`bool`) – Set True to individually filter instructions inside of a subroutine defined by the [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") instruction. + +**Returns** + +`Schedule` consisting of instructions that are not match with filtering condition. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When this method is called. This method will be supported soon. + +### filter + + + +`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`. + +If no arguments are provided, `self` is returned. + + + This method is currently not supported. Support will be soon added please create an issue if you believe this must be prioritized. + + +**Parameters** + +* **filter\_funcs** (`List`\[`Callable`]) – A list of Callables which take a (int, Union\[‘Schedule’, Instruction]) tuple and return a bool. +* **channels** (`Optional`\[`Iterable`\[`Channel`]]) – For example, `[DriveChannel(0), AcquireChannel(0)]`. +* **instruction\_types** (`Union`\[`Iterable`\[`ABCMeta`], `ABCMeta`, `None`]) – For example, `[PulseInstruction, AcquireInstruction]`. +* **time\_ranges** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **intervals** (`Optional`\[`Iterable`\[`Tuple`\[`int`, `int`]]]) – For example, `[(0, 5), (6, 10)]`. +* **check\_subroutine** (`bool`) – Set True to individually filter instructions inside of a subroutine defined by the [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") instruction. + +**Returns** + +`Schedule` consisting of instructions that matches with filtering condition. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When this method is called. This method will be supported soon. + +### get\_parameters + + + +`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. + +Because different `Parameter` objects can have the same name, this method returns a list of `Parameter` s for the provided name. + +**Parameters** + +**parameter\_name** (`str`) – Name of parameter. + +**Return type** + +`List`\[`Parameter`] + +**Returns** + +Parameter objects that have corresponding name. + +### initialize\_from + + + +`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. + +**Parameters** + +* **other\_program** (`Any`) – Qiskit program that provides metadata to new object. +* **name** (`Optional`\[`str`]) – Name of new schedule. Name of `block` is used by default. + +**Return type** + +`ScheduleBlock` + +**Returns** + +New block object with name and metadata. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When other\_program does not provide necessary information. + +### insert + + + +`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. + + + This method is not supported and being deprecated. + + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule. +* **block** (`Union`\[`Schedule`, `Instruction`]) – Schedule to insert. +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to the name of self. +* **inplace** (`bool`) – Perform operation inplace on this schedule. Otherwise return a new `Schedule`. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When this method is called. This method is not supported. + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### is\_schedulable + + + +`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. + +**Return type** + +`bool` + +### replace + + + +`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. + +**Parameters** + +* **old** (`Union`\[`ScheduleBlock`, `Instruction`]) – Schedule block component to replace. +* **new** (`Union`\[`ScheduleBlock`, `Instruction`]) – Schedule block component to replace with. +* **inplace** (`bool`) – Replace instruction by mutably modifying this `ScheduleBlock`. + +**Return type** + +`ScheduleBlock` + +**Returns** + +The modified schedule block with `old` replaced by `new`. + +### shift + + + +`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. + + + This method is not supported and being deprecated. + + +**Parameters** + +* **time** (`int`) – Time to shift by. +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to the name of self. +* **inplace** (`bool`) – Perform operation inplace on this schedule. Otherwise return a new `Schedule`. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – When this method is called. This method is not supported. + +## Attributes + + ### alignment\_context Return alignment instance that allocates block component to generate schedule. - + ### blocks @@ -87,7 +448,7 @@ Get the time-ordered instructions from self. `Tuple`\[`Union`\[`ScheduleBlock`, `Instruction`]] - + ### channels @@ -97,7 +458,7 @@ Returns channels that this schedule clock uses. `Tuple`\[`Channel`] - + ### duration @@ -107,13 +468,13 @@ Duration of this schedule block. `int` - + ### instances\_counter `= count(0)` - + ### instructions @@ -123,7 +484,7 @@ Get the time-ordered instructions from self. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### metadata @@ -135,7 +496,7 @@ User provided `dict` of metadata for the schedule. The metadata contents do not `Dict`\[`str`, `Any`] - + ### name @@ -145,7 +506,7 @@ Name of this Schedule `str` - + ### parameters @@ -155,13 +516,13 @@ Parameters which determine the schedule behavior. `Set` - + ### prefix `= 'block'` - + ### start\_time @@ -171,7 +532,7 @@ Starting time of this schedule block. `int` - + ### stop\_time @@ -181,7 +542,7 @@ Stopping time of this schedule block. `int` - + ### timeslots @@ -190,3 +551,4 @@ Time keeping attribute. **Return type** `Dict`\[`Channel`, `List`\[`Tuple`\[`int`, `int`]]] + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md b/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md index 7aa71e6e3de..70e4017f765 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.SetFrequency.md @@ -1,8 +1,16 @@ -# SetFrequency +--- +title: SetFrequency +description: API reference for qiskit.pulse.SetFrequency +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.SetFrequency +--- +# SetFrequency + -`SetFrequency(frequency, channel, name=None)` +`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` @@ -26,22 +34,196 @@ Creates a new set channel frequency instruction. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.SetFrequency.append#qiskit.pulse.SetFrequency.append "qiskit.pulse.SetFrequency.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.SetFrequency.assign_parameters#qiskit.pulse.SetFrequency.assign_parameters "qiskit.pulse.SetFrequency.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.SetFrequency.ch_duration#qiskit.pulse.SetFrequency.ch_duration "qiskit.pulse.SetFrequency.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.SetFrequency.ch_start_time#qiskit.pulse.SetFrequency.ch_start_time "qiskit.pulse.SetFrequency.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.SetFrequency.ch_stop_time#qiskit.pulse.SetFrequency.ch_stop_time "qiskit.pulse.SetFrequency.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.SetFrequency.draw#qiskit.pulse.SetFrequency.draw "qiskit.pulse.SetFrequency.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.SetFrequency.flatten#qiskit.pulse.SetFrequency.flatten "qiskit.pulse.SetFrequency.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.SetFrequency.insert#qiskit.pulse.SetFrequency.insert "qiskit.pulse.SetFrequency.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.SetFrequency.is_parameterized#qiskit.pulse.SetFrequency.is_parameterized "qiskit.pulse.SetFrequency.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.SetFrequency.shift#qiskit.pulse.SetFrequency.shift "qiskit.pulse.SetFrequency.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`SetFrequency.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`SetFrequency.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`SetFrequency.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`SetFrequency.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`SetFrequency.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`SetFrequency.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`SetFrequency.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`SetFrequency.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`SetFrequency.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -51,7 +233,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -61,7 +243,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -71,7 +253,7 @@ Duration of this instruction. `int` - + ### frequency @@ -81,7 +263,7 @@ New frequency. `Union`\[`float`, `ParameterExpression`] - + ### id @@ -91,7 +273,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -101,7 +283,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -111,7 +293,7 @@ Name of this instruction. `str` - + ### operands @@ -121,7 +303,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -131,7 +313,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -141,7 +323,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -150,3 +332,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md b/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md index 218b13d585e..62054c398c0 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.SetPhase.md @@ -1,8 +1,16 @@ -# SetPhase +--- +title: SetPhase +description: API reference for qiskit.pulse.SetPhase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.SetPhase +--- +# SetPhase + -`SetPhase(phase, channel, name=None)` +`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` @@ -26,22 +34,196 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.SetPhase.append#qiskit.pulse.SetPhase.append "qiskit.pulse.SetPhase.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.SetPhase.assign_parameters#qiskit.pulse.SetPhase.assign_parameters "qiskit.pulse.SetPhase.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.SetPhase.ch_duration#qiskit.pulse.SetPhase.ch_duration "qiskit.pulse.SetPhase.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.SetPhase.ch_start_time#qiskit.pulse.SetPhase.ch_start_time "qiskit.pulse.SetPhase.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.SetPhase.ch_stop_time#qiskit.pulse.SetPhase.ch_stop_time "qiskit.pulse.SetPhase.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.SetPhase.draw#qiskit.pulse.SetPhase.draw "qiskit.pulse.SetPhase.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.SetPhase.flatten#qiskit.pulse.SetPhase.flatten "qiskit.pulse.SetPhase.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.SetPhase.insert#qiskit.pulse.SetPhase.insert "qiskit.pulse.SetPhase.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.SetPhase.is_parameterized#qiskit.pulse.SetPhase.is_parameterized "qiskit.pulse.SetPhase.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.SetPhase.shift#qiskit.pulse.SetPhase.shift "qiskit.pulse.SetPhase.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`SetPhase.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`SetPhase.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`SetPhase.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`SetPhase.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`SetPhase.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`SetPhase.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`SetPhase.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`SetPhase.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`SetPhase.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -51,7 +233,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -61,7 +243,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -71,7 +253,7 @@ Duration of this instruction. `int` - + ### id @@ -81,7 +263,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -91,7 +273,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -101,7 +283,7 @@ Name of this instruction. `str` - + ### operands @@ -111,7 +293,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -121,7 +303,7 @@ Parameters which determine the instruction behavior. `Set` - + ### phase @@ -131,7 +313,7 @@ Return the rotation angle enacted by this instruction in radians. `Union`\[`complex`, `ParameterExpression`] - + ### start\_time @@ -141,7 +323,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -150,3 +332,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md b/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md index 92833518a3d..ccb0461c3b8 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ShiftFrequency.md @@ -1,8 +1,16 @@ -# ShiftFrequency +--- +title: ShiftFrequency +description: API reference for qiskit.pulse.ShiftFrequency +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.ShiftFrequency +--- +# ShiftFrequency + -`ShiftFrequency(frequency, channel, name=None)` +`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` @@ -18,22 +26,196 @@ Creates a new shift frequency instruction. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.ShiftFrequency.append#qiskit.pulse.ShiftFrequency.append "qiskit.pulse.ShiftFrequency.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.ShiftFrequency.assign_parameters#qiskit.pulse.ShiftFrequency.assign_parameters "qiskit.pulse.ShiftFrequency.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.ShiftFrequency.ch_duration#qiskit.pulse.ShiftFrequency.ch_duration "qiskit.pulse.ShiftFrequency.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.ShiftFrequency.ch_start_time#qiskit.pulse.ShiftFrequency.ch_start_time "qiskit.pulse.ShiftFrequency.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.ShiftFrequency.ch_stop_time#qiskit.pulse.ShiftFrequency.ch_stop_time "qiskit.pulse.ShiftFrequency.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.ShiftFrequency.draw#qiskit.pulse.ShiftFrequency.draw "qiskit.pulse.ShiftFrequency.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.ShiftFrequency.flatten#qiskit.pulse.ShiftFrequency.flatten "qiskit.pulse.ShiftFrequency.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.ShiftFrequency.insert#qiskit.pulse.ShiftFrequency.insert "qiskit.pulse.ShiftFrequency.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.ShiftFrequency.is_parameterized#qiskit.pulse.ShiftFrequency.is_parameterized "qiskit.pulse.ShiftFrequency.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.ShiftFrequency.shift#qiskit.pulse.ShiftFrequency.shift "qiskit.pulse.ShiftFrequency.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`ShiftFrequency.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`ShiftFrequency.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`ShiftFrequency.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`ShiftFrequency.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`ShiftFrequency.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`ShiftFrequency.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`ShiftFrequency.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`ShiftFrequency.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`ShiftFrequency.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -43,7 +225,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -53,7 +235,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -63,7 +245,7 @@ Duration of this instruction. `int` - + ### frequency @@ -73,7 +255,7 @@ Frequency shift from the set frequency. `Union`\[`float`, `ParameterExpression`] - + ### id @@ -83,7 +265,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -93,7 +275,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -103,7 +285,7 @@ Name of this instruction. `str` - + ### operands @@ -113,7 +295,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -123,7 +305,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -133,7 +315,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -142,3 +324,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md b/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md index 66c16a333bc..b212bcf03ae 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.ShiftPhase.md @@ -1,8 +1,16 @@ -# ShiftPhase +--- +title: ShiftPhase +description: API reference for qiskit.pulse.ShiftPhase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.ShiftPhase +--- +# ShiftPhase + -`ShiftPhase(phase, channel, name=None)` +`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` @@ -28,22 +36,196 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.ShiftPhase.append#qiskit.pulse.ShiftPhase.append "qiskit.pulse.ShiftPhase.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.ShiftPhase.assign_parameters#qiskit.pulse.ShiftPhase.assign_parameters "qiskit.pulse.ShiftPhase.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.ShiftPhase.ch_duration#qiskit.pulse.ShiftPhase.ch_duration "qiskit.pulse.ShiftPhase.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.ShiftPhase.ch_start_time#qiskit.pulse.ShiftPhase.ch_start_time "qiskit.pulse.ShiftPhase.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.ShiftPhase.ch_stop_time#qiskit.pulse.ShiftPhase.ch_stop_time "qiskit.pulse.ShiftPhase.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.ShiftPhase.draw#qiskit.pulse.ShiftPhase.draw "qiskit.pulse.ShiftPhase.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.ShiftPhase.flatten#qiskit.pulse.ShiftPhase.flatten "qiskit.pulse.ShiftPhase.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.ShiftPhase.insert#qiskit.pulse.ShiftPhase.insert "qiskit.pulse.ShiftPhase.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.ShiftPhase.is_parameterized#qiskit.pulse.ShiftPhase.is_parameterized "qiskit.pulse.ShiftPhase.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.ShiftPhase.shift#qiskit.pulse.ShiftPhase.shift "qiskit.pulse.ShiftPhase.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`ShiftPhase.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`ShiftPhase.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`ShiftPhase.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`ShiftPhase.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`ShiftPhase.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`ShiftPhase.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`ShiftPhase.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`ShiftPhase.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`ShiftPhase.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -53,7 +235,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -63,7 +245,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -73,7 +255,7 @@ Duration of this instruction. `int` - + ### id @@ -83,7 +265,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -93,7 +275,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -103,7 +285,7 @@ Name of this instruction. `str` - + ### operands @@ -113,7 +295,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -123,7 +305,7 @@ Parameters which determine the instruction behavior. `Set` - + ### phase @@ -133,7 +315,7 @@ Return the rotation angle enacted by this instruction in radians. `Union`\[`complex`, `ParameterExpression`] - + ### start\_time @@ -143,7 +325,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -152,3 +334,4 @@ Relative end time of this instruction. **Return type** `int` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md b/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md index 2a3247d8e24..0b35a9e071b 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Snapshot.md @@ -1,8 +1,16 @@ -# Snapshot +--- +title: Snapshot +description: API reference for qiskit.pulse.Snapshot +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Snapshot +--- +# Snapshot + -`Snapshot(label, snapshot_type='statevector', name=None)` +`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` @@ -18,26 +26,200 @@ Create new snapshot. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If snapshot label is invalid. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If snapshot label is invalid. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.Snapshot.append#qiskit.pulse.Snapshot.append "qiskit.pulse.Snapshot.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.Snapshot.assign_parameters#qiskit.pulse.Snapshot.assign_parameters "qiskit.pulse.Snapshot.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.Snapshot.ch_duration#qiskit.pulse.Snapshot.ch_duration "qiskit.pulse.Snapshot.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.Snapshot.ch_start_time#qiskit.pulse.Snapshot.ch_start_time "qiskit.pulse.Snapshot.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.Snapshot.ch_stop_time#qiskit.pulse.Snapshot.ch_stop_time "qiskit.pulse.Snapshot.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.Snapshot.draw#qiskit.pulse.Snapshot.draw "qiskit.pulse.Snapshot.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.Snapshot.flatten#qiskit.pulse.Snapshot.flatten "qiskit.pulse.Snapshot.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.Snapshot.insert#qiskit.pulse.Snapshot.insert "qiskit.pulse.Snapshot.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.Snapshot.is_parameterized#qiskit.pulse.Snapshot.is_parameterized "qiskit.pulse.Snapshot.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.Snapshot.shift#qiskit.pulse.Snapshot.shift "qiskit.pulse.Snapshot.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Snapshot.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self +**Returns** +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`Snapshot.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Snapshot.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Snapshot.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Snapshot.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + + +`Snapshot.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)` + +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Snapshot.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Snapshot.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Snapshot.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -47,7 +229,7 @@ Return the `Channel` that this instruction is scheduled on; trivially, a `Snapsh `SnapshotChannel` - + ### channels @@ -57,7 +239,7 @@ Returns the channels that this schedule uses. `Tuple`\[`SnapshotChannel`] - + ### duration @@ -67,7 +249,7 @@ Duration of this instruction. `int` - + ### id @@ -77,7 +259,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -87,7 +269,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### label @@ -97,7 +279,7 @@ Label of snapshot. `str` - + ### name @@ -107,7 +289,7 @@ Name of this instruction. `str` - + ### operands @@ -117,7 +299,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -127,7 +309,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -137,7 +319,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -147,7 +329,7 @@ Relative end time of this instruction. `int` - + ### type @@ -156,3 +338,4 @@ Type of snapshot. **Return type** `str` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md b/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md index b9ced852eb4..64ae0355b64 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.Waveform.md @@ -1,8 +1,16 @@ -# Waveform +--- +title: Waveform +description: API reference for qiskit.pulse.Waveform +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.Waveform +--- +# Waveform + -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -19,15 +27,91 @@ Create new sample pulse command. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- | -| [`assign_parameters`](qiskit.pulse.Waveform.assign_parameters#qiskit.pulse.Waveform.assign_parameters "qiskit.pulse.Waveform.assign_parameters") | Return a new pulse with parameters assigned. | -| [`draw`](qiskit.pulse.Waveform.draw#qiskit.pulse.Waveform.draw "qiskit.pulse.Waveform.draw") | Plot the interpolated envelope of pulse. | -| [`is_parameterized`](qiskit.pulse.Waveform.is_parameterized#qiskit.pulse.Waveform.is_parameterized "qiskit.pulse.Waveform.is_parameterized") | Return True iff the instruction is parameterized. | +### assign\_parameters -## Attributes + + +`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. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Waveform` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Waveform.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + Name of plotter API to generate an output image. One of following APIs should be specified: + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. + +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +## Attributes + + ### id @@ -37,13 +121,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -53,7 +137,7 @@ Return a dictionary containing the pulse’s parameters. `Dict`\[`str`, `Any`] - + ### samples @@ -62,3 +146,4 @@ Return sample values. **Return type** `ndarray` + 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 4ac5419ab7a..7fb6b0c1c63 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.acquire.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.acquire +--- +title: acquire +description: API reference for qiskit.pulse.builder.acquire +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.acquire +--- +# qiskit.pulse.builder.acquire + -`acquire(duration, qubit_or_channel, register, **metadata)` +`acquire(duration, qubit_or_channel, register, **metadata)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Acquire for a `duration` on a `channel` and store the result in a `register`. @@ -31,8 +39,9 @@ with pulse.build() as pulse_prog: * **duration** (`int`) – Duration to acquire data for * **qubit\_or\_channel** (`Union`\[`int`, `AcquireChannel`]) – Either the qubit to acquire data for or the specific `AcquireChannel` to acquire on. * **register** (`NewType()`(`StorageLocation`, `Union`\[`MemorySlot`, `RegisterSlot`])) – Location to store measured result. -* **metadata** (`Union`\[`Kernel`, `Discriminator`]) – Additional metadata for measurement. See [`Acquire`](qiskit.pulse.instructions.Acquire#qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") for more information. +* **metadata** (`Union`\[`Kernel`, `Discriminator`]) – Additional metadata for measurement. See [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire") for more information. **Raises** **exceptions.PulseError** – If the register type is not supported. + 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 24bb13aa4cd..98b8ed75896 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.acquire\_channel +--- +title: acquire_channel +description: API reference for qiskit.pulse.builder.acquire_channel +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.acquire_channel +--- +# qiskit.pulse.builder.acquire\_channel + -`acquire_channel(qubit)` +`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. @@ -25,3 +33,4 @@ with pulse.build(backend): **Return type** `AcquireChannel` + 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 ed4b3cc0f3b..29546869ebf 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.active\_backend +--- +title: active_backend +description: API reference for qiskit.pulse.builder.active_backend +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.active_backend +--- +# qiskit.pulse.builder.active\_backend + -`active_backend()` +`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. @@ -14,8 +22,9 @@ builder context. **Return type** -Union\[[Backend](qiskit.providers.Backend#qiskit.providers.Backend "qiskit.providers.Backend"), [BaseBackend](qiskit.providers.BaseBackend#qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")] +Union\[[Backend](qiskit.providers.Backend "qiskit.providers.Backend"), [BaseBackend](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")] **Raises** **exceptions.BackendNotSet** – If the builder does not have a backend set. + 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 cbfdaf0edf0..4e74842ec4f 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.active\_circuit\_scheduler\_settings +--- +title: active_circuit_scheduler_settings +description: API reference for qiskit.pulse.builder.active_circuit_scheduler_settings +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.active_circuit_scheduler_settings +--- +# qiskit.pulse.builder.active\_circuit\_scheduler\_settings + -`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") Return the current active builder context’s circuit scheduler settings. @@ -29,3 +37,4 @@ with pulse.build( **Return type** `Dict`\[`str`, `Any`] + 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 9d1584960d7..f3a15baa159 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.active\_transpiler\_settings +--- +title: active_transpiler_settings +description: API reference for qiskit.pulse.builder.active_transpiler_settings +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.active_transpiler_settings +--- +# qiskit.pulse.builder.active\_transpiler\_settings + -`active_transpiler_settings()` +`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. @@ -28,3 +36,4 @@ with pulse.build(backend, **Return type** `Dict`\[`str`, `Any`] + 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 306560f8fe0..59efe2a125c 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.align\_equispaced +--- +title: align_equispaced +description: API reference for qiskit.pulse.builder.align_equispaced +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.align_equispaced +--- +# qiskit.pulse.builder.align\_equispaced + -`align_equispaced(duration)` +`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. @@ -45,3 +53,4 @@ The scheduling is performed for sub-schedules within the context rather than cha **Return type** `AlignmentKind` + 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 557f5ef6f9d..2cf41f4c8a4 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.align\_func +--- +title: align_func +description: API reference for qiskit.pulse.builder.align_func +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.align_func +--- +# qiskit.pulse.builder.align\_func + -`align_func(duration, func)` +`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. @@ -51,3 +59,4 @@ The scheduling is performed for sub-schedules within the context rather than cha **Return type** `AlignmentKind` + 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 f628b57b377..cbbb71aac73 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.align\_left +--- +title: align_left +description: API reference for qiskit.pulse.builder.align_left +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.align_left +--- +# qiskit.pulse.builder.align\_left + -`align_left()` +`align_left()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Left alignment pulse scheduling context. @@ -34,3 +42,4 @@ None **Return type** `AbstractContextManager`\[`None`] + 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 e29dd2af13d..572951819b6 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.align\_right +--- +title: align_right +description: API reference for qiskit.pulse.builder.align_right +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.align_right +--- +# qiskit.pulse.builder.align\_right + -`align_right()` +`align_right()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Right alignment pulse scheduling context. @@ -34,3 +42,4 @@ None **Return type** `AlignmentKind` + 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 2744629bfa7..0b1585565a3 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.align\_sequential +--- +title: align_sequential +description: API reference for qiskit.pulse.builder.align_sequential +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.align_sequential +--- +# qiskit.pulse.builder.align\_sequential + -`align_sequential()` +`align_sequential()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Sequential alignment pulse scheduling context. @@ -34,3 +42,4 @@ None **Return type** `AlignmentKind` + 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 cb4b96d2a05..339e1e01b0a 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.barrier.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.barrier.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.barrier +--- +title: barrier +description: API reference for qiskit.pulse.builder.barrier +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.barrier +--- +# qiskit.pulse.builder.barrier + -`barrier(*channels_or_qubits, name=None)` +`barrier(*channels_or_qubits, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Barrier directive for a set of channels and qubits. @@ -66,3 +74,4 @@ with pulse.build(backend) as pulse_prog: * **channels\_or\_qubits** (`Union`\[`Channel`, `int`]) – Channels or qubits to barrier. * **name** (`Optional`\[`str`]) – Name for the barrier + 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 95e9005bdf9..6e9fef84af6 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.build.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.build.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.build +--- +title: build +description: API reference for qiskit.pulse.builder.build +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.build +--- +# qiskit.pulse.builder.build + -`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)` +`build(backend=None, schedule=None, name=None, default_alignment='left', default_transpiler_settings=None, default_circuit_scheduler_settings=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Create a context manager for launching the imperative pulse builder DSL. @@ -28,7 +36,7 @@ qiskit.execute(pulse_prog, backend) **Parameters** -* **backend** (*Union\[*[*Backend*](qiskit.providers.Backend#qiskit.providers.Backend "qiskit.providers.Backend")*,* [*BaseBackend*](qiskit.providers.BaseBackend#qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – A Qiskit backend. If not supplied certain builder functionality will be unavailable. +* **backend** (*Union\[*[*Backend*](qiskit.providers.Backend "qiskit.providers.Backend")*,* [*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – A Qiskit backend. If not supplied certain builder functionality will be unavailable. * **schedule** (`Optional`\[`ScheduleBlock`]) – A pulse `ScheduleBlock` in which your pulse program will be built. * **name** (`Optional`\[`str`]) – Name of pulse program to be built. * **default\_alignment** (`Union`\[`str`, `AlignmentKind`, `None`]) – Default scheduling alignment for builder. One of `left`, `right`, `sequential` or an alignment context. @@ -42,3 +50,4 @@ qiskit.execute(pulse_prog, backend) **Returns** A new builder context which has the active builder initialized. + 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 6ae4667208f..d69592c6a61 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.call.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.call.md @@ -1,13 +1,21 @@ -# qiskit.pulse.builder.call +--- +title: call +description: API reference for qiskit.pulse.builder.call +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.call +--- +# qiskit.pulse.builder.call + -`call(target, name=None, value_dict=None, **kw_params)` +`call(target, name=None, value_dict=None, **kw_params)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.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. - The `target` program is inserted as a `Call` instruction. This instruction defines a subroutine. See [`Call`](qiskit.pulse.instructions.Call#qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") for more details. + The `target` program is inserted as a `Call` instruction. This instruction defines a subroutine. See [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call") for more details. Examples: @@ -69,3 +77,4 @@ with pulse.build() as main_prog: **Raises** **exceptions.PulseError** – If the input `target` type is not supported. + 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 df050f3ad2b..657d3302d88 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.circuit\_scheduler\_settings +--- +title: circuit_scheduler_settings +description: API reference for qiskit.pulse.builder.circuit_scheduler_settings +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.circuit_scheduler_settings +--- +# qiskit.pulse.builder.circuit\_scheduler\_settings + -`circuit_scheduler_settings(**settings)` +`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. @@ -28,3 +36,4 @@ with pulse.build(backend): **Return type** `AbstractContextManager`\[`None`] + 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 13af2b5f02a..762939f242c 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.control\_channels +--- +title: control_channels +description: API reference for qiskit.pulse.builder.control_channels +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.control_channels +--- +# qiskit.pulse.builder.control\_channels + -`control_channels(*qubits)` +`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. @@ -34,3 +42,4 @@ with pulse.build(backend): **Returns** List of control channels associated with the supplied ordered list of qubits. + 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 95e8260b44e..7e02b9e1bb7 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.cx.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.cx.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.cx +--- +title: cx +description: API reference for qiskit.pulse.builder.cx +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.cx +--- +# qiskit.pulse.builder.cx + -`cx(control, target)` +`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. @@ -21,3 +29,4 @@ backend = FakeOpenPulse2Q() with pulse.build(backend) as pulse_prog: pulse.cx(0, 1) ``` + 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 77dd2175076..4f71e962d27 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.delay.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.delay.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.delay +--- +title: delay +description: API reference for qiskit.pulse.builder.delay +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.delay +--- +# qiskit.pulse.builder.delay + -`delay(duration, channel, name=None)` +`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`. @@ -22,3 +30,4 @@ with pulse.build() as pulse_prog: * **duration** (`int`) – Number of cycles to delay for on `channel`. * **channel** (`Channel`) – Channel to delay on. * **name** (`Optional`\[`str`]) – Name of the instruction. + 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 8ec777085b2..b0f847d24e3 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.delay\_qubits +--- +title: delay_qubits +description: API reference for qiskit.pulse.builder.delay_qubits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.delay_qubits +--- +# qiskit.pulse.builder.delay\_qubits + -`delay_qubits(duration, *qubits)` +`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. @@ -27,3 +35,4 @@ with pulse.build(backend) as pulse_prog: * **duration** (`int`) – Duration to delay for. * **qubits** (`Union`\[`int`, `Iterable`\[`int`]]) – Physical qubits to delay on. Delays will be inserted based on the channels returned by `pulse.qubit_channels()`. + 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 8920fa21df3..ff0cf2a08e9 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.drive\_channel +--- +title: drive_channel +description: API reference for qiskit.pulse.builder.drive_channel +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.drive_channel +--- +# qiskit.pulse.builder.drive\_channel + -`drive_channel(qubit)` +`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. @@ -25,3 +33,4 @@ with pulse.build(backend): **Return type** `DriveChannel` + 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 c0e81629adb..e1a747dba9a 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.frequency\_offset +--- +title: frequency_offset +description: API reference for qiskit.pulse.builder.frequency_offset +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.frequency_offset +--- +# qiskit.pulse.builder.frequency\_offset + -`frequency_offset(frequency, *channels, compensate_phase=False)` +`frequency_offset(frequency, *channels, compensate_phase=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the frequency of inputs channels on entry into context and undo on exit. @@ -43,3 +51,4 @@ None **Return type** `AbstractContextManager`\[`None`] + 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 3c063ae5cfe..5f57428166d 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.inline.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.inline.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.inline +--- +title: inline +description: API reference for qiskit.pulse.builder.inline +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.inline +--- +# qiskit.pulse.builder.inline + -`inline()` +`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. @@ -13,3 +21,4 @@ Deprecated. Inline all instructions within this context into the parent context, **Return type** `AbstractContextManager`\[`None`] + 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 28323a19220..cc5ba4115b9 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.measure.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.measure.md @@ -1,12 +1,20 @@ -# qiskit.pulse.builder.measure +--- +title: measure +description: API reference for qiskit.pulse.builder.measure +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.measure +--- +# qiskit.pulse.builder.measure + -`measure(qubits, registers=None)` +`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. -At the pulse level a measurement is composed of both a stimulus pulse and an acquisition instruction which tells the systems measurement unit to acquire data and process it. We provide this measurement macro to automate the process for you, but if desired full control is still available with [`acquire()`](qiskit.pulse.builder.acquire#qiskit.pulse.builder.acquire "qiskit.pulse.builder.acquire") and [`play()`](qiskit.pulse.builder.play#qiskit.pulse.builder.play "qiskit.pulse.builder.play"). +At the pulse level a measurement is composed of both a stimulus pulse and an acquisition instruction which tells the systems measurement unit to acquire data and process it. We provide this measurement macro to automate the process for you, but if desired full control is still available with [`acquire()`](qiskit.pulse.builder.acquire "qiskit.pulse.builder.acquire") and [`play()`](qiskit.pulse.builder.play "qiskit.pulse.builder.play"). To use the measurement it is as simple as specifying the qubit you wish to measure: @@ -54,3 +62,4 @@ assert reg == mem0 **Returns** The `register` the qubit measurement result will be stored in. + 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 ec4214f1bf4..51e42b44561 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.measure\_all +--- +title: measure_all +description: API reference for qiskit.pulse.builder.measure_all +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.measure_all +--- +# qiskit.pulse.builder.measure\_all + -`measure_all()` +`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. @@ -32,3 +40,4 @@ with pulse.build(backend) as pulse_prog: **Returns** The `register`s the qubit measurement results will be stored in. + 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 4d637784bbf..81f11f99879 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.measure\_channel +--- +title: measure_channel +description: API reference for qiskit.pulse.builder.measure_channel +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.measure_channel +--- +# qiskit.pulse.builder.measure\_channel + -`measure_channel(qubit)` +`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. @@ -25,3 +33,4 @@ with pulse.build(backend): **Return type** `MeasureChannel` + 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 6687ada17cb..676d2ed6d40 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.num\_qubits +--- +title: num_qubits +description: API reference for qiskit.pulse.builder.num_qubits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.num_qubits +--- +# qiskit.pulse.builder.num\_qubits + -`num_qubits()` +`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. @@ -29,3 +37,4 @@ with pulse.build(backend): **Return type** `int` + 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 9f18f79c8a3..43e967fc609 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.pad.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.pad.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.pad +--- +title: pad +description: API reference for qiskit.pulse.builder.pad +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.pad +--- +# qiskit.pulse.builder.pad + -`pad(*chs)` +`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. @@ -17,3 +25,4 @@ None **Return type** `AbstractContextManager`\[`None`] + 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 b9f4c292184..62ba68346f5 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.phase\_offset +--- +title: phase_offset +description: API reference for qiskit.pulse.builder.phase_offset +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.phase_offset +--- +# qiskit.pulse.builder.phase\_offset + -`phase_offset(phase, *channels)` +`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. @@ -34,3 +42,4 @@ None **Return type** `AbstractContextManager`\[`None`] + 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 0a72727263b..18c6de4b90e 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.play.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.play.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.play +--- +title: play +description: API reference for qiskit.pulse.builder.play +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.play +--- +# qiskit.pulse.builder.play + -`play(pulse, channel, name=None)` +`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`. @@ -22,3 +30,4 @@ with pulse.build() as pulse_prog: * **pulse** (`Union`\[`Pulse`, `ndarray`]) – Pulse to play. * **channel** (`PulseChannel`) – Channel to play pulse on. * **name** (`Optional`\[`str`]) – Name of the pulse. + 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 7e9e92dbe10..5d240a5c0ed 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.qubit\_channels +--- +title: qubit_channels +description: API reference for qiskit.pulse.builder.qubit_channels +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.qubit_channels +--- +# qiskit.pulse.builder.qubit\_channels + -`qubit_channels(qubit)` +`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. @@ -33,3 +41,4 @@ with pulse.build(backend): **Return type** `Set`\[`Channel`] + 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 32f4234e025..b6d7fcda54f 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.samples\_to\_seconds +--- +title: samples_to_seconds +description: API reference for qiskit.pulse.builder.samples_to_seconds +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.samples_to_seconds +--- +# qiskit.pulse.builder.samples\_to\_seconds + -`samples_to_seconds(samples)` +`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. @@ -17,3 +25,4 @@ Obtain the time in seconds that will elapse for the input number of samples on t **Returns** The time that elapses in `samples`. + 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 9e3a9df8796..d93f52c4470 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.seconds\_to\_samples +--- +title: seconds_to_samples +description: API reference for qiskit.pulse.builder.seconds_to_samples +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.seconds_to_samples +--- +# qiskit.pulse.builder.seconds\_to\_samples + -`seconds_to_samples(seconds)` +`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. @@ -19,3 +27,4 @@ Rounds down. **Returns** The number of samples for the time to elapse + 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 a49cd736367..d85f6e4ca0e 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.set\_frequency +--- +title: set_frequency +description: API reference for qiskit.pulse.builder.set_frequency +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.set_frequency +--- +# qiskit.pulse.builder.set\_frequency + -`set_frequency(frequency, channel, name=None)` +`set_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `frequency` of a pulse `channel`. @@ -22,3 +30,4 @@ with pulse.build() as pulse_prog: * **frequency** (`float`) – Frequency in Hz to set channel to. * **channel** (`PulseChannel`) – Channel to set frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. + 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 f7ef297e2bc..b41660ee5ad 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.set\_phase +--- +title: set_phase +description: API reference for qiskit.pulse.builder.set_phase +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.set_phase +--- +# qiskit.pulse.builder.set\_phase + -`set_phase(phase, channel, name=None)` +`set_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Set the `phase` of a pulse `channel`. @@ -24,3 +32,4 @@ with pulse.build() as pulse_prog: * **phase** (`float`) – Phase in radians to set channel carrier signal to. * **channel** (`PulseChannel`) – Channel to set phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. + 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 2ffae70cd94..2544b9eb704 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.shift\_frequency +--- +title: shift_frequency +description: API reference for qiskit.pulse.builder.shift_frequency +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.shift_frequency +--- +# qiskit.pulse.builder.shift\_frequency + -`shift_frequency(frequency, channel, name=None)` +`shift_frequency(frequency, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `frequency` of a pulse `channel`. @@ -22,3 +30,4 @@ with pulse.build() as pulse_prog: * **frequency** (`float`) – Frequency in Hz to shift channel frequency by. * **channel** (`PulseChannel`) – Channel to shift frequency of. * **name** (`Optional`\[`str`]) – Name of the instruction. + 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 7408a52f9d0..94e436785ef 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.shift\_phase +--- +title: shift_phase +description: API reference for qiskit.pulse.builder.shift_phase +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.shift_phase +--- +# qiskit.pulse.builder.shift\_phase + -`shift_phase(phase, channel, name=None)` +`shift_phase(phase, channel, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Shift the `phase` of a pulse `channel`. @@ -24,3 +32,4 @@ with pulse.build() as pulse_prog: * **phase** (`float`) – Phase in radians to shift channel carrier signal by. * **channel** (`PulseChannel`) – Channel to shift phase of. * **name** (`Optional`\[`str`]) – Name of the instruction. + 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 d9c09d7522d..e983009dc0b 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.snapshot.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.snapshot +--- +title: snapshot +description: API reference for qiskit.pulse.builder.snapshot +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.snapshot +--- +# qiskit.pulse.builder.snapshot + -`snapshot(label, snapshot_type='statevector')` +`snapshot(label, snapshot_type='statevector')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/builder.py "view source code") Simulator snapshot. @@ -19,3 +27,4 @@ with pulse.build() as pulse_prog: * **label** (`str`) – Label for snapshot. * **snapshot\_type** (`str`) – Type of 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 120b7201ce4..f5fbba68e32 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.transpiler\_settings +--- +title: transpiler_settings +description: API reference for qiskit.pulse.builder.transpiler_settings +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.transpiler_settings +--- +# qiskit.pulse.builder.transpiler\_settings + -`transpiler_settings(**settings)` +`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. @@ -28,3 +36,4 @@ with pulse.build(backend): **Return type** `AbstractContextManager`\[`None`] + 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 8adc1906029..9941efd5892 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.u1.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.u1.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.u1 +--- +title: u1 +description: API reference for qiskit.pulse.builder.u1 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.u1 +--- +# qiskit.pulse.builder.u1 + -`u1(theta, qubit)` +`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. @@ -23,3 +31,4 @@ backend = FakeOpenPulse2Q() with pulse.build(backend) as pulse_prog: pulse.u1(math.pi, 1) ``` + 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 8dd0df8d6df..593b6b26057 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.u2.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.u2.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.u2 +--- +title: u2 +description: API reference for qiskit.pulse.builder.u2 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.u2 +--- +# qiskit.pulse.builder.u2 + -`u2(phi, lam, qubit)` +`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. @@ -23,3 +31,4 @@ backend = FakeOpenPulse2Q() with pulse.build(backend) as pulse_prog: pulse.u2(0, math.pi, 1) ``` + 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 7a878be0481..ec7e467dae9 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.u3.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.u3.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.u3 +--- +title: u3 +description: API reference for qiskit.pulse.builder.u3 +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.u3 +--- +# qiskit.pulse.builder.u3 + -`u3(theta, phi, lam, qubit)` +`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. @@ -23,3 +31,4 @@ backend = FakeOpenPulse2Q() with pulse.build(backend) as pulse_prog: pulse.u3(math.pi, 0, math.pi, 1) ``` + 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 c0148942175..0a4e7cc7f76 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.builder.x.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.builder.x.md @@ -1,8 +1,16 @@ -# qiskit.pulse.builder.x +--- +title: x +description: API reference for qiskit.pulse.builder.x +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.builder.x +--- +# qiskit.pulse.builder.x + -`x(qubit)` +`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. @@ -21,3 +29,4 @@ backend = FakeOpenPulse2Q() with pulse.build(backend) as pulse_prog: pulse.x(0) ``` + 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 08d19fb116a..b4d3e2cd393 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Acquire.md @@ -1,8 +1,16 @@ -# Acquire +--- +title: Acquire +description: API reference for qiskit.pulse.instructions.Acquire +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.Acquire +--- +# Acquire + -`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)` +`Acquire(duration, channel, mem_slot=None, reg_slot=None, kernel=None, discriminator=None, name=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/instructions/acquire.py "view source code") Bases: `qiskit.pulse.instructions.instruction.Instruction` @@ -28,26 +36,200 @@ Create a new Acquire instruction. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If channels are supplied, and the number of register and/or memory slots does not equal the number of channels. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If channels are supplied, and the number of register and/or memory slots does not equal the number of channels. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.Acquire.append#qiskit.pulse.instructions.Acquire.append "qiskit.pulse.instructions.Acquire.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.Acquire.assign_parameters#qiskit.pulse.instructions.Acquire.assign_parameters "qiskit.pulse.instructions.Acquire.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.Acquire.ch_duration#qiskit.pulse.instructions.Acquire.ch_duration "qiskit.pulse.instructions.Acquire.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.Acquire.ch_start_time#qiskit.pulse.instructions.Acquire.ch_start_time "qiskit.pulse.instructions.Acquire.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.Acquire.ch_stop_time#qiskit.pulse.instructions.Acquire.ch_stop_time "qiskit.pulse.instructions.Acquire.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.Acquire.draw#qiskit.pulse.instructions.Acquire.draw "qiskit.pulse.instructions.Acquire.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.Acquire.flatten#qiskit.pulse.instructions.Acquire.flatten "qiskit.pulse.instructions.Acquire.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.Acquire.insert#qiskit.pulse.instructions.Acquire.insert "qiskit.pulse.instructions.Acquire.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.Acquire.is_parameterized#qiskit.pulse.instructions.Acquire.is_parameterized "qiskit.pulse.instructions.Acquire.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.Acquire.shift#qiskit.pulse.instructions.Acquire.shift "qiskit.pulse.instructions.Acquire.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Acquire.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`Acquire.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Acquire.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Acquire.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Acquire.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + + +`Acquire.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)` + +Plot the instruction. +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Acquire.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Acquire.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Acquire.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + ### acquire @@ -57,7 +239,7 @@ Acquire channel to acquire data. The `AcquireChannel` index maps trivially to qu `AcquireChannel` - + ### channel @@ -67,7 +249,7 @@ Return the `Channel` that this instruction is scheduled on. `AcquireChannel` - + ### channels @@ -77,7 +259,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Union`\[`AcquireChannel`, `MemorySlot`, `RegisterSlot`]] - + ### discriminator @@ -87,7 +269,7 @@ Return discrimination settings. `Discriminator` - + ### duration @@ -97,7 +279,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -107,7 +289,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -117,7 +299,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### kernel @@ -127,7 +309,7 @@ Return kernel settings. `Kernel` - + ### mem\_slot @@ -137,7 +319,7 @@ The classical memory slot which will store the classified readout result. `MemorySlot` - + ### name @@ -147,7 +329,7 @@ Name of this instruction. `str` - + ### operands @@ -157,7 +339,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -167,7 +349,7 @@ Parameters which determine the instruction behavior. `Set` - + ### reg\_slot @@ -177,7 +359,7 @@ The fast-access register slot which will store the classified readout result for `RegisterSlot` - + ### start\_time @@ -187,7 +369,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -196,3 +378,4 @@ Relative end time of this instruction. **Return type** `int` + 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 017ed9c2f87..81e6a62715f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Call.md @@ -1,8 +1,16 @@ -# Call +--- +title: Call +description: API reference for qiskit.pulse.instructions.Call +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.Call +--- +# Call + -`Call(subroutine, value_dict=None, name=None)` +`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` @@ -18,33 +26,228 @@ Define new subroutine. **Parameters** -* **subroutine** (*Union\[*[*Schedule*](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule")*,* [*ScheduleBlock*](qiskit.pulse.ScheduleBlock#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")*]*) – A program subroutine to be referred to. +* **subroutine** (*Union\[*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule")*,* [*ScheduleBlock*](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")*]*) – A program subroutine to be referred to. * **value\_dict** (`Optional`\[`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]]) – Mapping of parameter object to assigned value. * **name** (`Optional`\[`str`]) – Unique ID of this subroutine. If not provided, this is generated based on the subroutine name. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If subroutine is not valid data format. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If subroutine is not valid data format. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.Call.append#qiskit.pulse.instructions.Call.append "qiskit.pulse.instructions.Call.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.Call.assign_parameters#qiskit.pulse.instructions.Call.assign_parameters "qiskit.pulse.instructions.Call.assign_parameters") | Store parameters which will be later assigned to the subroutine. | -| [`assigned_subroutine`](qiskit.pulse.instructions.Call.assigned_subroutine#qiskit.pulse.instructions.Call.assigned_subroutine "qiskit.pulse.instructions.Call.assigned_subroutine") | Returns this subroutine with the parameters assigned. | -| [`ch_duration`](qiskit.pulse.instructions.Call.ch_duration#qiskit.pulse.instructions.Call.ch_duration "qiskit.pulse.instructions.Call.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.Call.ch_start_time#qiskit.pulse.instructions.Call.ch_start_time "qiskit.pulse.instructions.Call.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.Call.ch_stop_time#qiskit.pulse.instructions.Call.ch_stop_time "qiskit.pulse.instructions.Call.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.Call.draw#qiskit.pulse.instructions.Call.draw "qiskit.pulse.instructions.Call.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.Call.flatten#qiskit.pulse.instructions.Call.flatten "qiskit.pulse.instructions.Call.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.Call.insert#qiskit.pulse.instructions.Call.insert "qiskit.pulse.instructions.Call.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.Call.is_parameterized#qiskit.pulse.instructions.Call.is_parameterized "qiskit.pulse.instructions.Call.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.Call.shift#qiskit.pulse.instructions.Call.shift "qiskit.pulse.instructions.Call.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Call.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`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. + +Parameter values are not immediately assigned. The subroutine with parameters assigned according to the populated parameter table will be generated only when `inline_subroutines()` function is applied to this instruction. Note that parameter assignment logic creates a copy of subroutine to avoid the mutation problem. This function is usually applied by the Qiskit compiler when the program is submitted to the backend. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Call` + +**Returns** + +Self with updated parameters. + +### assigned\_subroutine + + + +`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. + + + This function may be often called internally for class equality check despite its overhead of parameter assignment. The subroutine with parameter assigned is cached based on `.argument` hash. Once this argument is updated, new assigned instance will be returned. Note that this update is not mutable operation. + + +**Returns** + +Attached program. + +**Return type** + +program (Union\[[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), [ScheduleBlock](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")]) + +### ch\_duration + + + +`Call.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Call.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Call.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels +**Return type** + +`int` + +### draw + + + +`Call.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)` + +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Call.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Call.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Call.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### arguments @@ -54,7 +257,7 @@ Parameters dictionary to be assigned to subroutine. `Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]] - + ### channels @@ -64,7 +267,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Channel`] - + ### duration @@ -74,7 +277,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -84,7 +287,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -94,7 +297,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -104,7 +307,7 @@ Name of this instruction. `str` - + ### operands @@ -114,7 +317,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -124,13 +327,13 @@ Unassigned parameters which determine the instruction behavior. `Set` - + ### prefix `= 'call'` - + ### start\_time @@ -140,7 +343,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -150,7 +353,7 @@ Relative end time of this instruction. `int` - + ### subroutine @@ -162,4 +365,5 @@ The program referenced by the call. **Return type** -program (Union\[[Schedule](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule"), [ScheduleBlock](qiskit.pulse.ScheduleBlock#qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")]) +program (Union\[[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), [ScheduleBlock](qiskit.pulse.ScheduleBlock "qiskit.pulse.ScheduleBlock")]) + 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 f514f42a7a4..38303f34a80 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Delay.md @@ -1,8 +1,16 @@ -# Delay +--- +title: Delay +description: API reference for qiskit.pulse.instructions.Delay +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.Delay +--- +# Delay + -`Delay(duration, channel, name=None)` +`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` @@ -32,22 +40,196 @@ No other instruction may be scheduled within a `Delay`. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.Delay.append#qiskit.pulse.instructions.Delay.append "qiskit.pulse.instructions.Delay.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.Delay.assign_parameters#qiskit.pulse.instructions.Delay.assign_parameters "qiskit.pulse.instructions.Delay.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.Delay.ch_duration#qiskit.pulse.instructions.Delay.ch_duration "qiskit.pulse.instructions.Delay.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.Delay.ch_start_time#qiskit.pulse.instructions.Delay.ch_start_time "qiskit.pulse.instructions.Delay.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.Delay.ch_stop_time#qiskit.pulse.instructions.Delay.ch_stop_time "qiskit.pulse.instructions.Delay.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.Delay.draw#qiskit.pulse.instructions.Delay.draw "qiskit.pulse.instructions.Delay.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.Delay.flatten#qiskit.pulse.instructions.Delay.flatten "qiskit.pulse.instructions.Delay.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.Delay.insert#qiskit.pulse.instructions.Delay.insert "qiskit.pulse.instructions.Delay.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.Delay.is_parameterized#qiskit.pulse.instructions.Delay.is_parameterized "qiskit.pulse.instructions.Delay.is_parameterized") | Return `True` iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.Delay.shift#qiskit.pulse.instructions.Delay.shift "qiskit.pulse.instructions.Delay.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Delay.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`Delay.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Delay.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Delay.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Delay.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`Delay.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Delay.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Delay.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Delay.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -57,7 +239,7 @@ Return the `Channel` that this instruction is scheduled on. `Channel` - + ### channels @@ -67,7 +249,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Channel`] - + ### duration @@ -77,7 +259,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -87,7 +269,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -97,7 +279,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -107,7 +289,7 @@ Name of this instruction. `str` - + ### operands @@ -117,7 +299,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -127,7 +309,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -137,7 +319,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -146,3 +328,4 @@ Relative end time of this instruction. **Return type** `int` + 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 bbf84aa6541..2669c0e7e33 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Instruction.md @@ -1,8 +1,16 @@ -# Instruction +--- +title: Instruction +description: API reference for qiskit.pulse.instructions.Instruction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.Instruction +--- +# Instruction + -`Instruction(operands, duration=None, channels=None, name=None)` +`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` @@ -19,27 +27,201 @@ Instruction initializer. **Raises** -* [**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If duration is negative. -* [**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the input `channels` are not all of type `Channel`. +* [**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If duration is negative. +* [**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the input `channels` are not all of type `Channel`. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.Instruction.append#qiskit.pulse.instructions.Instruction.append "qiskit.pulse.instructions.Instruction.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.Instruction.assign_parameters#qiskit.pulse.instructions.Instruction.assign_parameters "qiskit.pulse.instructions.Instruction.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.Instruction.ch_duration#qiskit.pulse.instructions.Instruction.ch_duration "qiskit.pulse.instructions.Instruction.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.Instruction.ch_start_time#qiskit.pulse.instructions.Instruction.ch_start_time "qiskit.pulse.instructions.Instruction.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.Instruction.ch_stop_time#qiskit.pulse.instructions.Instruction.ch_stop_time "qiskit.pulse.instructions.Instruction.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.Instruction.draw#qiskit.pulse.instructions.Instruction.draw "qiskit.pulse.instructions.Instruction.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.Instruction.flatten#qiskit.pulse.instructions.Instruction.flatten "qiskit.pulse.instructions.Instruction.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.Instruction.insert#qiskit.pulse.instructions.Instruction.insert "qiskit.pulse.instructions.Instruction.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.Instruction.is_parameterized#qiskit.pulse.instructions.Instruction.is_parameterized "qiskit.pulse.instructions.Instruction.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.Instruction.shift#qiskit.pulse.instructions.Instruction.shift "qiskit.pulse.instructions.Instruction.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`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. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`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. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`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. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`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. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + +`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. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`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. + +**Return type** + +`Instruction` + +### insert + + + +`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`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`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. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channels @@ -49,7 +231,7 @@ Returns the channels that this schedule uses. `Tuple`\[`Channel`] - + ### duration @@ -59,7 +241,7 @@ Duration of this instruction. `int` - + ### id @@ -69,7 +251,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -79,7 +261,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -89,7 +271,7 @@ Name of this instruction. `str` - + ### operands @@ -99,7 +281,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -109,7 +291,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -119,7 +301,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -128,3 +310,4 @@ Relative end time of this instruction. **Return type** `int` + 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 5ad2caf5605..867a3a2f0f2 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Play.md @@ -1,8 +1,16 @@ -# Play +--- +title: Play +description: API reference for qiskit.pulse.instructions.Play +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.Play +--- +# Play + -`Play(pulse, channel, name=None)` +`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` @@ -14,32 +22,206 @@ Create a new pulse instruction. **Parameters** -* **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform#qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). +* **pulse** (`Pulse`) – A pulse waveform description, such as [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform"). * **channel** (`PulseChannel`) – The channel to which the pulse is applied. * **name** (`Optional`\[`str`]) – Name of the instruction for display purposes. Defaults to `pulse.name`. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If pulse is not a Pulse type. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If pulse is not a Pulse type. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.Play.append#qiskit.pulse.instructions.Play.append "qiskit.pulse.instructions.Play.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.Play.assign_parameters#qiskit.pulse.instructions.Play.assign_parameters "qiskit.pulse.instructions.Play.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.Play.ch_duration#qiskit.pulse.instructions.Play.ch_duration "qiskit.pulse.instructions.Play.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.Play.ch_start_time#qiskit.pulse.instructions.Play.ch_start_time "qiskit.pulse.instructions.Play.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.Play.ch_stop_time#qiskit.pulse.instructions.Play.ch_stop_time "qiskit.pulse.instructions.Play.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.Play.draw#qiskit.pulse.instructions.Play.draw "qiskit.pulse.instructions.Play.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.Play.flatten#qiskit.pulse.instructions.Play.flatten "qiskit.pulse.instructions.Play.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.Play.insert#qiskit.pulse.instructions.Play.insert "qiskit.pulse.instructions.Play.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.Play.is_parameterized#qiskit.pulse.instructions.Play.is_parameterized "qiskit.pulse.instructions.Play.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.Play.shift#qiskit.pulse.instructions.Play.shift "qiskit.pulse.instructions.Play.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Play.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`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. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Play` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Play.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Play.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Play.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`Play.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Play.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Play.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Play.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -49,7 +231,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -59,7 +241,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -69,7 +251,7 @@ Duration of this instruction. `Union`\[`int`, `ParameterExpression`] - + ### id @@ -79,7 +261,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -89,7 +271,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -99,7 +281,7 @@ Name of this instruction. `str` - + ### operands @@ -109,7 +291,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -119,7 +301,7 @@ Parameters which determine the instruction behavior. `Set` - + ### pulse @@ -129,7 +311,7 @@ A description of the samples that will be played. `Pulse` - + ### start\_time @@ -139,7 +321,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -148,3 +330,4 @@ Relative end time of this instruction. **Return type** `int` + 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 01944d4e52c..145fda8c30a 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetFrequency.md @@ -1,8 +1,16 @@ -# SetFrequency +--- +title: SetFrequency +description: API reference for qiskit.pulse.instructions.SetFrequency +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.SetFrequency +--- +# SetFrequency + -`SetFrequency(frequency, channel, name=None)` +`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` @@ -26,22 +34,196 @@ Creates a new set channel frequency instruction. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.SetFrequency.append#qiskit.pulse.instructions.SetFrequency.append "qiskit.pulse.instructions.SetFrequency.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.SetFrequency.assign_parameters#qiskit.pulse.instructions.SetFrequency.assign_parameters "qiskit.pulse.instructions.SetFrequency.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.SetFrequency.ch_duration#qiskit.pulse.instructions.SetFrequency.ch_duration "qiskit.pulse.instructions.SetFrequency.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.SetFrequency.ch_start_time#qiskit.pulse.instructions.SetFrequency.ch_start_time "qiskit.pulse.instructions.SetFrequency.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.SetFrequency.ch_stop_time#qiskit.pulse.instructions.SetFrequency.ch_stop_time "qiskit.pulse.instructions.SetFrequency.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.SetFrequency.draw#qiskit.pulse.instructions.SetFrequency.draw "qiskit.pulse.instructions.SetFrequency.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.SetFrequency.flatten#qiskit.pulse.instructions.SetFrequency.flatten "qiskit.pulse.instructions.SetFrequency.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.SetFrequency.insert#qiskit.pulse.instructions.SetFrequency.insert "qiskit.pulse.instructions.SetFrequency.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.SetFrequency.is_parameterized#qiskit.pulse.instructions.SetFrequency.is_parameterized "qiskit.pulse.instructions.SetFrequency.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.SetFrequency.shift#qiskit.pulse.instructions.SetFrequency.shift "qiskit.pulse.instructions.SetFrequency.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`SetFrequency.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`SetFrequency.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`SetFrequency.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`SetFrequency.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`SetFrequency.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`SetFrequency.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`SetFrequency.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`SetFrequency.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`SetFrequency.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -51,7 +233,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -61,7 +243,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -71,7 +253,7 @@ Duration of this instruction. `int` - + ### frequency @@ -81,7 +263,7 @@ New frequency. `Union`\[`float`, `ParameterExpression`] - + ### id @@ -91,7 +273,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -101,7 +283,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -111,7 +293,7 @@ Name of this instruction. `str` - + ### operands @@ -121,7 +303,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -131,7 +313,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -141,7 +323,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -150,3 +332,4 @@ Relative end time of this instruction. **Return type** `int` + 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 20e7073f95f..9cb4acecad2 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.SetPhase.md @@ -1,8 +1,16 @@ -# SetPhase +--- +title: SetPhase +description: API reference for qiskit.pulse.instructions.SetPhase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.SetPhase +--- +# SetPhase + -`SetPhase(phase, channel, name=None)` +`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` @@ -26,22 +34,196 @@ Instantiate a set phase instruction, setting the output signal phase on `channel ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.SetPhase.append#qiskit.pulse.instructions.SetPhase.append "qiskit.pulse.instructions.SetPhase.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.SetPhase.assign_parameters#qiskit.pulse.instructions.SetPhase.assign_parameters "qiskit.pulse.instructions.SetPhase.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.SetPhase.ch_duration#qiskit.pulse.instructions.SetPhase.ch_duration "qiskit.pulse.instructions.SetPhase.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.SetPhase.ch_start_time#qiskit.pulse.instructions.SetPhase.ch_start_time "qiskit.pulse.instructions.SetPhase.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.SetPhase.ch_stop_time#qiskit.pulse.instructions.SetPhase.ch_stop_time "qiskit.pulse.instructions.SetPhase.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.SetPhase.draw#qiskit.pulse.instructions.SetPhase.draw "qiskit.pulse.instructions.SetPhase.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.SetPhase.flatten#qiskit.pulse.instructions.SetPhase.flatten "qiskit.pulse.instructions.SetPhase.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.SetPhase.insert#qiskit.pulse.instructions.SetPhase.insert "qiskit.pulse.instructions.SetPhase.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.SetPhase.is_parameterized#qiskit.pulse.instructions.SetPhase.is_parameterized "qiskit.pulse.instructions.SetPhase.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.SetPhase.shift#qiskit.pulse.instructions.SetPhase.shift "qiskit.pulse.instructions.SetPhase.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`SetPhase.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`SetPhase.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`SetPhase.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`SetPhase.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`SetPhase.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`SetPhase.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`SetPhase.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`SetPhase.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`SetPhase.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -51,7 +233,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -61,7 +243,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -71,7 +253,7 @@ Duration of this instruction. `int` - + ### id @@ -81,7 +263,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -91,7 +273,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -101,7 +283,7 @@ Name of this instruction. `str` - + ### operands @@ -111,7 +293,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -121,7 +303,7 @@ Parameters which determine the instruction behavior. `Set` - + ### phase @@ -131,7 +313,7 @@ Return the rotation angle enacted by this instruction in radians. `Union`\[`complex`, `ParameterExpression`] - + ### start\_time @@ -141,7 +323,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -150,3 +332,4 @@ Relative end time of this instruction. **Return type** `int` + 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 7b8d009d9ec..23fc954ed82 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftFrequency.md @@ -1,8 +1,16 @@ -# ShiftFrequency +--- +title: ShiftFrequency +description: API reference for qiskit.pulse.instructions.ShiftFrequency +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.ShiftFrequency +--- +# ShiftFrequency + -`ShiftFrequency(frequency, channel, name=None)` +`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` @@ -18,22 +26,196 @@ Creates a new shift frequency instruction. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.ShiftFrequency.append#qiskit.pulse.instructions.ShiftFrequency.append "qiskit.pulse.instructions.ShiftFrequency.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.ShiftFrequency.assign_parameters#qiskit.pulse.instructions.ShiftFrequency.assign_parameters "qiskit.pulse.instructions.ShiftFrequency.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.ShiftFrequency.ch_duration#qiskit.pulse.instructions.ShiftFrequency.ch_duration "qiskit.pulse.instructions.ShiftFrequency.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.ShiftFrequency.ch_start_time#qiskit.pulse.instructions.ShiftFrequency.ch_start_time "qiskit.pulse.instructions.ShiftFrequency.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.ShiftFrequency.ch_stop_time#qiskit.pulse.instructions.ShiftFrequency.ch_stop_time "qiskit.pulse.instructions.ShiftFrequency.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.ShiftFrequency.draw#qiskit.pulse.instructions.ShiftFrequency.draw "qiskit.pulse.instructions.ShiftFrequency.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.ShiftFrequency.flatten#qiskit.pulse.instructions.ShiftFrequency.flatten "qiskit.pulse.instructions.ShiftFrequency.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.ShiftFrequency.insert#qiskit.pulse.instructions.ShiftFrequency.insert "qiskit.pulse.instructions.ShiftFrequency.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.ShiftFrequency.is_parameterized#qiskit.pulse.instructions.ShiftFrequency.is_parameterized "qiskit.pulse.instructions.ShiftFrequency.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.ShiftFrequency.shift#qiskit.pulse.instructions.ShiftFrequency.shift "qiskit.pulse.instructions.ShiftFrequency.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`ShiftFrequency.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`ShiftFrequency.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`ShiftFrequency.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`ShiftFrequency.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`ShiftFrequency.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`ShiftFrequency.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`ShiftFrequency.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`ShiftFrequency.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`ShiftFrequency.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -43,7 +225,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -53,7 +235,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -63,7 +245,7 @@ Duration of this instruction. `int` - + ### frequency @@ -73,7 +255,7 @@ Frequency shift from the set frequency. `Union`\[`float`, `ParameterExpression`] - + ### id @@ -83,7 +265,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -93,7 +275,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -103,7 +285,7 @@ Name of this instruction. `str` - + ### operands @@ -113,7 +295,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -123,7 +305,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -133,7 +315,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -142,3 +324,4 @@ Relative end time of this instruction. **Return type** `int` + 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 2c43957382d..da52194db0e 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.ShiftPhase.md @@ -1,8 +1,16 @@ -# ShiftPhase +--- +title: ShiftPhase +description: API reference for qiskit.pulse.instructions.ShiftPhase +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.ShiftPhase +--- +# ShiftPhase + -`ShiftPhase(phase, channel, name=None)` +`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` @@ -28,22 +36,196 @@ Instantiate a shift phase instruction, increasing the output signal phase on `ch ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.ShiftPhase.append#qiskit.pulse.instructions.ShiftPhase.append "qiskit.pulse.instructions.ShiftPhase.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.ShiftPhase.assign_parameters#qiskit.pulse.instructions.ShiftPhase.assign_parameters "qiskit.pulse.instructions.ShiftPhase.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.ShiftPhase.ch_duration#qiskit.pulse.instructions.ShiftPhase.ch_duration "qiskit.pulse.instructions.ShiftPhase.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.ShiftPhase.ch_start_time#qiskit.pulse.instructions.ShiftPhase.ch_start_time "qiskit.pulse.instructions.ShiftPhase.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.ShiftPhase.ch_stop_time#qiskit.pulse.instructions.ShiftPhase.ch_stop_time "qiskit.pulse.instructions.ShiftPhase.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.ShiftPhase.draw#qiskit.pulse.instructions.ShiftPhase.draw "qiskit.pulse.instructions.ShiftPhase.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.ShiftPhase.flatten#qiskit.pulse.instructions.ShiftPhase.flatten "qiskit.pulse.instructions.ShiftPhase.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.ShiftPhase.insert#qiskit.pulse.instructions.ShiftPhase.insert "qiskit.pulse.instructions.ShiftPhase.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.ShiftPhase.is_parameterized#qiskit.pulse.instructions.ShiftPhase.is_parameterized "qiskit.pulse.instructions.ShiftPhase.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.ShiftPhase.shift#qiskit.pulse.instructions.ShiftPhase.shift "qiskit.pulse.instructions.ShiftPhase.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`ShiftPhase.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`ShiftPhase.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`ShiftPhase.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`ShiftPhase.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`ShiftPhase.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + +`ShiftPhase.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)` +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`ShiftPhase.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`ShiftPhase.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`ShiftPhase.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -53,7 +235,7 @@ Return the `Channel` that this instruction is scheduled on. `PulseChannel` - + ### channels @@ -63,7 +245,7 @@ Returns the channels that this schedule uses. `Tuple`\[`PulseChannel`] - + ### duration @@ -73,7 +255,7 @@ Duration of this instruction. `int` - + ### id @@ -83,7 +265,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -93,7 +275,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### name @@ -103,7 +285,7 @@ Name of this instruction. `str` - + ### operands @@ -113,7 +295,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -123,7 +305,7 @@ Parameters which determine the instruction behavior. `Set` - + ### phase @@ -133,7 +315,7 @@ Return the rotation angle enacted by this instruction in radians. `Union`\[`complex`, `ParameterExpression`] - + ### start\_time @@ -143,7 +325,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -152,3 +334,4 @@ Relative end time of this instruction. **Return type** `int` + 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 9a182bd4618..6a8c84c04ea 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.Snapshot.md @@ -1,8 +1,16 @@ -# Snapshot +--- +title: Snapshot +description: API reference for qiskit.pulse.instructions.Snapshot +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.instructions.Snapshot +--- +# Snapshot + -`Snapshot(label, snapshot_type='statevector', name=None)` +`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` @@ -18,26 +26,200 @@ Create new snapshot. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If snapshot label is invalid. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If snapshot label is invalid. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`append`](qiskit.pulse.instructions.Snapshot.append#qiskit.pulse.instructions.Snapshot.append "qiskit.pulse.instructions.Snapshot.append") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`. | -| [`assign_parameters`](qiskit.pulse.instructions.Snapshot.assign_parameters#qiskit.pulse.instructions.Snapshot.assign_parameters "qiskit.pulse.instructions.Snapshot.assign_parameters") | Modify and return self with parameters assigned according to the input. | -| [`ch_duration`](qiskit.pulse.instructions.Snapshot.ch_duration#qiskit.pulse.instructions.Snapshot.ch_duration "qiskit.pulse.instructions.Snapshot.ch_duration") | Return duration of the supplied channels in this Instruction. | -| [`ch_start_time`](qiskit.pulse.instructions.Snapshot.ch_start_time#qiskit.pulse.instructions.Snapshot.ch_start_time "qiskit.pulse.instructions.Snapshot.ch_start_time") | Return minimum start time for supplied channels. | -| [`ch_stop_time`](qiskit.pulse.instructions.Snapshot.ch_stop_time#qiskit.pulse.instructions.Snapshot.ch_stop_time "qiskit.pulse.instructions.Snapshot.ch_stop_time") | Return maximum start time for supplied channels. | -| [`draw`](qiskit.pulse.instructions.Snapshot.draw#qiskit.pulse.instructions.Snapshot.draw "qiskit.pulse.instructions.Snapshot.draw") | Plot the instruction. | -| [`flatten`](qiskit.pulse.instructions.Snapshot.flatten#qiskit.pulse.instructions.Snapshot.flatten "qiskit.pulse.instructions.Snapshot.flatten") | Return itself as already single instruction. | -| [`insert`](qiskit.pulse.instructions.Snapshot.insert#qiskit.pulse.instructions.Snapshot.insert "qiskit.pulse.instructions.Snapshot.insert") | Return a new [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. | -| [`is_parameterized`](qiskit.pulse.instructions.Snapshot.is_parameterized#qiskit.pulse.instructions.Snapshot.is_parameterized "qiskit.pulse.instructions.Snapshot.is_parameterized") | Return True iff the instruction is parameterized. | -| [`shift`](qiskit.pulse.instructions.Snapshot.shift#qiskit.pulse.instructions.Snapshot.shift "qiskit.pulse.instructions.Snapshot.shift") | Return a new schedule shifted forward by time. | +### append -## Attributes + + +`Snapshot.append(schedule, name=None)` + +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`. + +**Parameters** + +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self +**Returns** +A new schedule with `schedule` a this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### assign\_parameters + + + +`Snapshot.assign_parameters(value_dict)` + +Modify and return self with parameters assigned according to the input. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Instruction` + +**Returns** + +Self with updated parameters. + +### ch\_duration + + + +`Snapshot.ch_duration(*channels)` + +Return duration of the supplied channels in this Instruction. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_start\_time + + + +`Snapshot.ch_start_time(*channels)` + +Return minimum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### ch\_stop\_time + + + +`Snapshot.ch_stop_time(*channels)` + +Return maximum start time for supplied channels. + +**Parameters** + +**\*channels** – Supplied channels + +**Return type** + +`int` + +### draw + + + +`Snapshot.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)` + +Plot the instruction. + +**Parameters** + +* **dt** (`float`) – Time interval of samples +* **style** (*Optional\[SchedStyle]*) – A style sheet to configure plot appearance +* **filename** (`Optional`\[`str`]) – Name required to save pulse image +* **interp\_method** (`Optional`\[`Callable`]) – A function for interpolation +* **scale** (`float`) – Relative visual scaling of waveform amplitudes +* **plot\_all** (`bool`) – Plot empty channels +* **plot\_range** (`Optional`\[`Tuple`\[`float`]]) – A tuple of time range to plot +* **interactive** (`bool`) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this) +* **table** (`bool`) – Draw event table for supported instructions +* **label** (`bool`) – Label individual instructions +* **framechange** (`bool`) – Add framechange indicators +* **channels** (`Optional`\[`List`\[`Channel`]]) – A list of channel names to plot + +**Returns** + +A matplotlib figure object of the pulse schedule + +**Return type** + +matplotlib.figure + +### flatten + + + +`Snapshot.flatten()` + +Return itself as already single instruction. + +**Return type** + +`Instruction` + +### insert + + + +`Snapshot.insert(start_time, schedule, name=None)` + +Return a new [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`. + +**Parameters** + +* **start\_time** (`int`) – Time to insert the schedule schedule +* **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +A new schedule with `schedule` inserted with this instruction at t=0. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +### shift + + + +`Snapshot.shift(time, name=None)` + +Return a new schedule shifted forward by time. + +**Parameters** + +* **time** (`int`) – Time to shift by +* **name** (`Optional`\[`str`]) – Name of the new schedule. Defaults to name of self + +**Returns** + +The shifted schedule. + +**Return type** + +[Schedule](qiskit.pulse.Schedule "qiskit.pulse.Schedule") + +## Attributes + + ### channel @@ -47,7 +229,7 @@ Return the `Channel` that this instruction is scheduled on; trivially, a `Snapsh `SnapshotChannel` - + ### channels @@ -57,7 +239,7 @@ Returns the channels that this schedule uses. `Tuple`\[`SnapshotChannel`] - + ### duration @@ -67,7 +249,7 @@ Duration of this instruction. `int` - + ### id @@ -77,7 +259,7 @@ Unique identifier for this instruction. `int` - + ### instructions @@ -87,7 +269,7 @@ Iterable for getting instructions from Schedule tree. `Tuple`\[`Tuple`\[`int`, `Instruction`]] - + ### label @@ -97,7 +279,7 @@ Label of snapshot. `str` - + ### name @@ -107,7 +289,7 @@ Name of this instruction. `str` - + ### operands @@ -117,7 +299,7 @@ Return instruction operands. `Tuple` - + ### parameters @@ -127,7 +309,7 @@ Parameters which determine the instruction behavior. `Set` - + ### start\_time @@ -137,7 +319,7 @@ Relative begin time of this instruction. `int` - + ### stop\_time @@ -147,7 +329,7 @@ Relative end time of this instruction. `int` - + ### type @@ -156,3 +338,4 @@ Type of snapshot. **Return type** `str` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.instructions.md b/docs/api/qiskit/0.32/qiskit.pulse.instructions.md index 2dbda1c3a94..5bcc0b989ac 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.instructions.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.instructions.md @@ -4,34 +4,34 @@ The `instruction` module holds the various `Instruction` s which are supported by Qiskit Pulse. Instructions have operands, which typically include at least one `Channel` specifying where the instruction will be applied. -Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase#qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a `Channel` `channel`: +Every instruction has a duration, whether explicitly included as an operand or implicitly defined. For instance, a [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase") instruction can be instantiated with operands *phase* and *channel*, for some float `phase` and a `Channel` `channel`: ```python ShiftPhase(phase, channel) ``` -The duration of this instruction is implicitly zero. On the other hand, the [`Delay`](qiskit.pulse.instructions.Delay#qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay") instruction takes an explicit duration: +The duration of this instruction is implicitly zero. On the other hand, the [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay") instruction takes an explicit duration: ```python Delay(duration, channel) ``` -An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule#qiskit.pulse.Schedule "qiskit.pulse.Schedule"), which is a sequence of scheduled Pulse `Instruction` s over many channels. `Instruction` s and `Schedule` s implement the same interface. +An instruction can be added to a [`Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), which is a sequence of scheduled Pulse `Instruction` s over many channels. `Instruction` s and `Schedule` s implement the same interface. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| [`Acquire`](qiskit.pulse.instructions.Acquire#qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | -| [`Call`](qiskit.pulse.instructions.Call#qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | -| [`Delay`](qiskit.pulse.instructions.Delay#qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | -| [`Play`](qiskit.pulse.instructions.Play#qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | -| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency#qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | -| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency#qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | -| [`SetPhase`](qiskit.pulse.instructions.SetPhase#qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | -| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase#qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. | -| [`Snapshot`](qiskit.pulse.instructions.Snapshot#qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | +| [`Acquire`](qiskit.pulse.instructions.Acquire "qiskit.pulse.instructions.Acquire")(duration, channel\[, mem\_slot, …]) | The Acquire instruction is used to trigger the ADC associated with a particular qubit; e.g. | +| [`Call`](qiskit.pulse.instructions.Call "qiskit.pulse.instructions.Call")(subroutine\[, value\_dict, name]) | Pulse `Call` instruction. | +| [`Delay`](qiskit.pulse.instructions.Delay "qiskit.pulse.instructions.Delay")(duration, channel\[, name]) | A blocking instruction with no other effect. | +| [`Play`](qiskit.pulse.instructions.Play "qiskit.pulse.instructions.Play")(pulse, channel\[, name]) | This instruction is responsible for applying a pulse on a channel. | +| [`SetFrequency`](qiskit.pulse.instructions.SetFrequency "qiskit.pulse.instructions.SetFrequency")(frequency, channel\[, name]) | Set the channel frequency. | +| [`ShiftFrequency`](qiskit.pulse.instructions.ShiftFrequency "qiskit.pulse.instructions.ShiftFrequency")(frequency, channel\[, name]) | Shift the channel frequency away from the current frequency. | +| [`SetPhase`](qiskit.pulse.instructions.SetPhase "qiskit.pulse.instructions.SetPhase")(phase, channel\[, name]) | The set phase instruction sets the phase of the proceeding pulses on that channel to `phase` radians. | +| [`ShiftPhase`](qiskit.pulse.instructions.ShiftPhase "qiskit.pulse.instructions.ShiftPhase")(phase, channel\[, name]) | The shift phase instruction updates the modulation phase of proceeding pulses played on the same `Channel`. | +| [`Snapshot`](qiskit.pulse.instructions.Snapshot "qiskit.pulse.instructions.Snapshot")(label\[, snapshot\_type, name]) | An instruction targeted for simulators, to capture a moment in the simulation. | ## Abstract Classes -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | -| [`Instruction`](qiskit.pulse.instructions.Instruction#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| [`Instruction`](qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.Instruction")(operands\[, duration, channels, name]) | The smallest schedulable unit: a single instruction. | 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 17a75069cba..b6a1742d533 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Constant.md @@ -1,8 +1,16 @@ -# Constant +--- +title: Constant +description: API reference for qiskit.pulse.library.Constant +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.library.Constant +--- +# Constant + -`Constant(duration, amp, name=None)` +`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` @@ -23,18 +31,131 @@ Initialize the constant-valued pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.library.Constant.assign#qiskit.pulse.library.Constant.assign "qiskit.pulse.library.Constant.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.library.Constant.assign_parameters#qiskit.pulse.library.Constant.assign_parameters "qiskit.pulse.library.Constant.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.library.Constant.draw#qiskit.pulse.library.Constant.draw "qiskit.pulse.library.Constant.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.library.Constant.get_waveform#qiskit.pulse.library.Constant.get_waveform "qiskit.pulse.library.Constant.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.library.Constant.is_parameterized#qiskit.pulse.library.Constant.is_parameterized "qiskit.pulse.library.Constant.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.library.Constant.validate_parameters#qiskit.pulse.library.Constant.validate_parameters "qiskit.pulse.library.Constant.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`Constant.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`Constant.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Constant.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. + +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`Constant.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`Constant.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -44,7 +165,7 @@ The constant value amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### id @@ -54,16 +175,17 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters **Return type** `Dict`\[`str`, `Any`] + 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 8806d605753..f0e3157a227 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Drag.md @@ -1,8 +1,16 @@ -# Drag +--- +title: Drag +description: API reference for qiskit.pulse.library.Drag +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.library.Drag +--- +# Drag + -`Drag(duration, amp, sigma, beta, name=None)` +`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` @@ -37,18 +45,131 @@ Initialize the drag pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.library.Drag.assign#qiskit.pulse.library.Drag.assign "qiskit.pulse.library.Drag.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.library.Drag.assign_parameters#qiskit.pulse.library.Drag.assign_parameters "qiskit.pulse.library.Drag.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.library.Drag.draw#qiskit.pulse.library.Drag.draw "qiskit.pulse.library.Drag.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.library.Drag.get_waveform#qiskit.pulse.library.Drag.get_waveform "qiskit.pulse.library.Drag.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.library.Drag.is_parameterized#qiskit.pulse.library.Drag.is_parameterized "qiskit.pulse.library.Drag.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.library.Drag.validate_parameters#qiskit.pulse.library.Drag.validate_parameters "qiskit.pulse.library.Drag.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`Drag.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`Drag.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Drag.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`Drag.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`Drag.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -58,7 +179,7 @@ The Gaussian amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### beta @@ -68,7 +189,7 @@ The weighing factor for the Gaussian derivative component of the waveform. `Union`\[`float`, `ParameterExpression`] - + ### id @@ -78,13 +199,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -92,7 +213,7 @@ Unique identifier for this pulse. `Dict`\[`str`, `Any`] - + ### sigma @@ -101,3 +222,4 @@ The Gaussian standard deviation of the pulse width. **Return type** `Union`\[`float`, `ParameterExpression`] + 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 29e95eb1840..8a9a5b4afca 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Gaussian.md @@ -1,8 +1,16 @@ -# Gaussian +--- +title: Gaussian +description: API reference for qiskit.pulse.library.Gaussian +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.library.Gaussian +--- +# Gaussian + -`Gaussian(duration, amp, sigma, name=None)` +`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` @@ -23,18 +31,131 @@ Initialize the gaussian pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.library.Gaussian.assign#qiskit.pulse.library.Gaussian.assign "qiskit.pulse.library.Gaussian.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.library.Gaussian.assign_parameters#qiskit.pulse.library.Gaussian.assign_parameters "qiskit.pulse.library.Gaussian.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.library.Gaussian.draw#qiskit.pulse.library.Gaussian.draw "qiskit.pulse.library.Gaussian.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.library.Gaussian.get_waveform#qiskit.pulse.library.Gaussian.get_waveform "qiskit.pulse.library.Gaussian.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.library.Gaussian.is_parameterized#qiskit.pulse.library.Gaussian.is_parameterized "qiskit.pulse.library.Gaussian.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.library.Gaussian.validate_parameters#qiskit.pulse.library.Gaussian.validate_parameters "qiskit.pulse.library.Gaussian.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`Gaussian.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`Gaussian.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Gaussian.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`Gaussian.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`Gaussian.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -44,7 +165,7 @@ The Gaussian amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### id @@ -54,13 +175,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -68,7 +189,7 @@ Unique identifier for this pulse. `Dict`\[`str`, `Any`] - + ### sigma @@ -77,3 +198,4 @@ The Gaussian standard deviation of the pulse width. **Return type** `Union`\[`float`, `ParameterExpression`] + 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 11377670af3..0b10fefe392 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.GaussianSquare.md @@ -1,8 +1,16 @@ -# GaussianSquare +--- +title: GaussianSquare +description: API reference for qiskit.pulse.library.GaussianSquare +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.library.GaussianSquare +--- +# GaussianSquare + -`GaussianSquare(duration, amp, sigma, width=None, risefall_sigma_ratio=None, name=None)` +`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` @@ -41,18 +49,131 @@ Initialize the gaussian square pulse. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -| [`assign`](qiskit.pulse.library.GaussianSquare.assign#qiskit.pulse.library.GaussianSquare.assign "qiskit.pulse.library.GaussianSquare.assign") | Assign one parameter to a value, which can either be numeric or another parameter expression. | -| [`assign_parameters`](qiskit.pulse.library.GaussianSquare.assign_parameters#qiskit.pulse.library.GaussianSquare.assign_parameters "qiskit.pulse.library.GaussianSquare.assign_parameters") | Return a new ParametricPulse with parameters assigned. | -| [`draw`](qiskit.pulse.library.GaussianSquare.draw#qiskit.pulse.library.GaussianSquare.draw "qiskit.pulse.library.GaussianSquare.draw") | Plot the interpolated envelope of pulse. | -| [`get_waveform`](qiskit.pulse.library.GaussianSquare.get_waveform#qiskit.pulse.library.GaussianSquare.get_waveform "qiskit.pulse.library.GaussianSquare.get_waveform") | Return a Waveform with samples filled according to the formula that the pulse represents and the parameter values it contains. | -| [`is_parameterized`](qiskit.pulse.library.GaussianSquare.is_parameterized#qiskit.pulse.library.GaussianSquare.is_parameterized "qiskit.pulse.library.GaussianSquare.is_parameterized") | Return True iff the instruction is parameterized. | -| [`validate_parameters`](qiskit.pulse.library.GaussianSquare.validate_parameters#qiskit.pulse.library.GaussianSquare.validate_parameters "qiskit.pulse.library.GaussianSquare.validate_parameters") | Validate parameters. | +### assign -## Attributes + + +`GaussianSquare.assign(parameter, value)` + +Assign one parameter to a value, which can either be numeric or another parameter expression. + +**Return type** + +`ParametricPulse` + +### assign\_parameters + + + +`GaussianSquare.assign_parameters(value_dict)` + +Return a new ParametricPulse with parameters assigned. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`ParametricPulse` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`GaussianSquare.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + + Name of plotter API to generate an output image. One of following APIs should be specified: + + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### get\_waveform + + + +`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. + +**Return type** + +`Waveform` + +### is\_parameterized + + + +`GaussianSquare.is_parameterized()` + +Return True iff the instruction is parameterized. + +**Return type** + +`bool` + +### validate\_parameters + + + +`GaussianSquare.validate_parameters()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/parametric_pulses.py "view source code") + +Validate parameters. + +**Raises** + +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the parameters passed are not valid. + +**Return type** + +`None` + +## Attributes + + ### amp @@ -62,7 +183,7 @@ The Gaussian amplitude. `Union`\[`complex`, `ParameterExpression`] - + ### id @@ -72,13 +193,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -86,7 +207,7 @@ Unique identifier for this pulse. `Dict`\[`str`, `Any`] - + ### risefall\_sigma\_ratio @@ -96,7 +217,7 @@ The duration of each risefall in terms of sigma. `Union`\[`float`, `ParameterExpression`] - + ### sigma @@ -106,7 +227,7 @@ The Gaussian standard deviation of the pulse width. `Union`\[`float`, `ParameterExpression`] - + ### width @@ -115,3 +236,4 @@ The width of the square portion of the pulse. **Return type** `Union`\[`float`, `ParameterExpression`] + 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 f47af3aa2da..73fb571e07c 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.Waveform.md @@ -1,8 +1,16 @@ -# Waveform +--- +title: Waveform +description: API reference for qiskit.pulse.library.Waveform +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.pulse.library.Waveform +--- +# Waveform + -`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)` +`Waveform(samples, name=None, epsilon=1e-07, limit_amplitude=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/library/waveform.py "view source code") Bases: `qiskit.pulse.library.pulse.Pulse` @@ -19,15 +27,91 @@ Create new sample pulse command. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------- | -| [`assign_parameters`](qiskit.pulse.library.Waveform.assign_parameters#qiskit.pulse.library.Waveform.assign_parameters "qiskit.pulse.library.Waveform.assign_parameters") | Return a new pulse with parameters assigned. | -| [`draw`](qiskit.pulse.library.Waveform.draw#qiskit.pulse.library.Waveform.draw "qiskit.pulse.library.Waveform.draw") | Plot the interpolated envelope of pulse. | -| [`is_parameterized`](qiskit.pulse.library.Waveform.is_parameterized#qiskit.pulse.library.Waveform.is_parameterized "qiskit.pulse.library.Waveform.is_parameterized") | Return True iff the instruction is parameterized. | +### assign\_parameters -## Attributes + + +`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. + +**Parameters** + +**value\_dict** (`Dict`\[`ParameterExpression`, `Union`\[`ParameterExpression`, `float`]]) – A mapping from Parameters to either numeric values or another Parameter expression. + +**Return type** + +`Waveform` + +**Returns** + +New pulse with updated parameters. + +### draw + + + +`Waveform.draw(dt=None, style=None, filename=None, interp_method=None, scale=None, interactive=None, draw_title=None, backend=None, time_range=None, time_unit='dt', show_waveform_info=True, plotter='mpl2d', axis=None)` + +Plot the interpolated envelope of pulse. + +**Parameters** + +* **style** (`Optional`\[`Dict`\[`str`, `Any`]]) – Stylesheet options. This can be dictionary or preset stylesheet classes. See :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXStandard\`, :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXSimple\`, and :py:class:\~\`qiskit.visualization.pulse\_v2.stylesheets.IQXDebugging\` for details of preset stylesheets. + +* **backend** (*Optional\[*[*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")*]*) – Backend object to play the input pulse program. If provided, the plotter may use to make the visualization hardware aware. + +* **time\_range** (`Optional`\[`Tuple`\[`int`, `int`]]) – Set horizontal axis limit. Tuple `(tmin, tmax)`. + +* **time\_unit** (`str`) – The unit of specified time range either `dt` or `ns`. The unit of `ns` is available only when `backend` object is provided. + +* **show\_waveform\_info** (`bool`) – Show waveform annotations, i.e. name, of waveforms. Set `True` to show additional information about waveforms. + +* **plotter** (`str`) – + Name of plotter API to generate an output image. One of following APIs should be specified: + ```python + mpl2d: Matplotlib API for 2D image generation. + Matplotlib API to generate 2D image. Charts are placed along y axis with + vertical offset. This API takes matplotlib.axes.Axes as `axis` input. + ``` + + axis and style kwargs may depend on the plotter. + +* **axis** (`Optional`\[`Any`]) – Arbitrary object passed to the plotter. If this object is provided, the plotters use a given `axis` instead of internally initializing a figure object. This object format depends on the plotter. See plotter argument for details. + +* **dt** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **filename** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. To save output image, you can call .savefig method with returned Matplotlib Figure object. + +* **interp\_method** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **scale** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **interactive** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +* **draw\_title** (`Optional`\[`Any`]) – Deprecated. This argument is used by the legacy pulse drawer. + +**Returns** + +Visualization output data. The returned data type depends on the `plotter`. If matplotlib family is specified, this will be a `matplotlib.pyplot.Figure` data. + +### is\_parameterized + + + +`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. + +**Return type** + +`bool` + +## Attributes + + ### id @@ -37,13 +121,13 @@ Unique identifier for this pulse. `int` - + ### limit\_amplitude `= True` - + ### parameters @@ -53,7 +137,7 @@ Return a dictionary containing the pulse’s parameters. `Dict`\[`str`, `Any`] - + ### samples @@ -62,3 +146,4 @@ Return sample values. **Return type** `ndarray` + diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md b/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md index b72ea4c967a..6ab3313b5a3 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.discrete.md @@ -8,18 +8,18 @@ Note the sampling strategy use for all discrete pulses is `midpoint`. ## Functions -| | | -| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `constant`(duration, amp\[, name]) | Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `cos`(duration, amp\[, freq, phase, name]) | Generates cosine wave [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `drag`(duration, amp, sigma, beta\[, name, …]) | Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. | -| `gaussian`(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `gaussian_deriv`(duration, amp, sigma\[, name]) | Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `gaussian_square`(duration, amp, sigma\[, …]) | Generates gaussian square [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `sawtooth`(duration, amp\[, freq, phase, name]) | Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `sech`(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `sech_deriv`(duration, amp, sigma\[, name]) | Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `sin`(duration, amp\[, freq, phase, name]) | Generates sine wave [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | -| `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform#qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| | | +| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| `constant`(duration, amp\[, name]) | Generates constant-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `cos`(duration, amp\[, freq, phase, name]) | Generates cosine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `drag`(duration, amp, sigma, beta\[, name, …]) | Generates Y-only correction DRAG [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform") for standard nonlinear oscillator (SNO) \[1]. | +| `gaussian`(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized gaussian [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `gaussian_deriv`(duration, amp, sigma\[, name]) | Generates unnormalized gaussian derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `gaussian_square`(duration, amp, sigma\[, …]) | Generates gaussian square [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `sawtooth`(duration, amp\[, freq, phase, name]) | Generates sawtooth wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `sech`(duration, amp, sigma\[, name, zero\_ends]) | Generates unnormalized sech [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `sech_deriv`(duration, amp, sigma\[, name]) | Generates unnormalized sech derivative [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `sin`(duration, amp\[, freq, phase, name]) | Generates sine wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `square`(duration, amp\[, freq, phase, name]) | Generates square wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `triangle`(duration, amp\[, freq, phase, name]) | Generates triangle wave [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | +| `zero`(duration\[, name]) | Generates zero-sampled [`Waveform`](qiskit.pulse.Waveform "qiskit.pulse.Waveform"). | diff --git a/docs/api/qiskit/0.32/qiskit.pulse.library.md b/docs/api/qiskit/0.32/qiskit.pulse.library.md index 1166bc9f9d6..484c25b067f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.library.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.library.md @@ -4,17 +4,17 @@ This library provides Pulse users with convenient methods to build Pulse waveforms. -Arbitrary waveforms can be described with [`Waveform`](qiskit.pulse.library.Waveform#qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") s. +Arbitrary waveforms can be described with [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") s. -The [`discrete`](qiskit.pulse.library.discrete#module-qiskit.pulse.library.discrete "qiskit.pulse.library.discrete") module will generate [`Waveform`](qiskit.pulse.library.Waveform#qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") s for common waveform envelopes. +The [`discrete`](qiskit.pulse.library.discrete#module-qiskit.pulse.library.discrete "qiskit.pulse.library.discrete") module will generate [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform") s for common waveform envelopes. -The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian#qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian"), [`GaussianSquare`](qiskit.pulse.library.GaussianSquare#qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare"), [`Drag`](qiskit.pulse.library.Drag#qiskit.pulse.library.Drag "qiskit.pulse.library.Drag") and [`Constant`](qiskit.pulse.library.Constant#qiskit.pulse.library.Constant "qiskit.pulse.library.Constant") will generate parameterized descriptions of those pulses, which can greatly reduce the size of the job sent to the backend. +The parametric pulses, [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian"), [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare"), [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag") and [`Constant`](qiskit.pulse.library.Constant "qiskit.pulse.library.Constant") will generate parameterized descriptions of those pulses, which can greatly reduce the size of the job sent to the backend. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -| [`discrete`](qiskit.pulse.library.discrete#module-qiskit.pulse.library.discrete "qiskit.pulse.library.discrete") | Module for builtin discrete pulses. | -| [`Waveform`](qiskit.pulse.library.Waveform#qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform")(samples\[, name, epsilon, …]) | A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. | -| [`Constant`](qiskit.pulse.library.Constant#qiskit.pulse.library.Constant "qiskit.pulse.library.Constant")(duration, amp\[, name]) | A simple constant pulse, with an amplitude value and a duration: | -| [`Drag`](qiskit.pulse.library.Drag#qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | -| [`Gaussian`](qiskit.pulse.library.Gaussian#qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | -| [`GaussianSquare`](qiskit.pulse.library.GaussianSquare#qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| [`discrete`](qiskit.pulse.library.discrete#module-qiskit.pulse.library.discrete "qiskit.pulse.library.discrete") | Module for builtin discrete pulses. | +| [`Waveform`](qiskit.pulse.library.Waveform "qiskit.pulse.library.Waveform")(samples\[, name, epsilon, …]) | A pulse specified completely by complex-valued samples; each sample is played for the duration of the backend cycle-time, dt. | +| [`Constant`](qiskit.pulse.library.Constant "qiskit.pulse.library.Constant")(duration, amp\[, name]) | A simple constant pulse, with an amplitude value and a duration: | +| [`Drag`](qiskit.pulse.library.Drag "qiskit.pulse.library.Drag")(duration, amp, sigma, beta\[, name]) | The Derivative Removal by Adiabatic Gate (DRAG) pulse is a standard Gaussian pulse with an additional Gaussian derivative component. | +| [`Gaussian`](qiskit.pulse.library.Gaussian "qiskit.pulse.library.Gaussian")(duration, amp, sigma\[, name]) | A truncated pulse envelope shaped according to the Gaussian function whose mean is centered at the center of the pulse (duration / 2): | +| [`GaussianSquare`](qiskit.pulse.library.GaussianSquare "qiskit.pulse.library.GaussianSquare")(duration, amp, sigma\[, …]) | A square pulse with a Gaussian shaped risefall on both sides. Either risefall\_sigma\_ratio | diff --git a/docs/api/qiskit/0.32/qiskit.pulse.transforms.add_implicit_acquires.md b/docs/api/qiskit/0.32/qiskit.pulse.transforms.add_implicit_acquires.md index 621a9459c84..4a6619928c2 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 @@ -1,8 +1,16 @@ -# qiskit.pulse.transforms.add\_implicit\_acquires +--- +title: add_implicit_acquires +description: API reference for qiskit.pulse.transforms.add_implicit_acquires +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.transforms.add_implicit_acquires +--- +# qiskit.pulse.transforms.add\_implicit\_acquires + -`add_implicit_acquires(schedule, meas_map)` +`add_implicit_acquires(schedule, meas_map)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return a new schedule with implicit acquires from the measurement mapping replaced by explicit ones. @@ -22,3 +30,4 @@ Return a new schedule with implicit acquires from the measurement mapping replac **Returns** A `Schedule` with the additional acquisition instructions. + 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 74fa1205402..912fbe3c1d7 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 @@ -1,16 +1,24 @@ -# qiskit.pulse.transforms.align\_measures +--- +title: align_measures +description: API reference for qiskit.pulse.transforms.align_measures +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.transforms.align_measures +--- +# qiskit.pulse.transforms.align\_measures + -`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)` +`align_measures(schedules, inst_map=None, cal_gate='u3', max_calibration_duration=None, align_time=None, align_all=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/pulse/transforms/canonicalization.py "view source code") Return new schedules where measurements occur at the same physical time. -This transformation will align the first [`qiskit.pulse.Acquire`](qiskit.pulse.Acquire#qiskit.pulse.Acquire "qiskit.pulse.Acquire") on every channel to occur at the same time. +This transformation will align the first [`qiskit.pulse.Acquire`](qiskit.pulse.Acquire "qiskit.pulse.Acquire") on every channel to occur at the same time. Minimum measurement wait time (to allow for calibration pulses) is enforced and may be set with `max_calibration_duration`. -By default only instructions containing a [`AcquireChannel`](qiskit.pulse.AcquireChannel#qiskit.pulse.AcquireChannel "qiskit.pulse.AcquireChannel") or [`MeasureChannel`](qiskit.pulse.MeasureChannel#qiskit.pulse.MeasureChannel "qiskit.pulse.MeasureChannel") will be shifted. If you wish to keep the relative timing of all instructions in the schedule set `align_all=True`. +By default only instructions containing a [`AcquireChannel`](qiskit.pulse.AcquireChannel "qiskit.pulse.AcquireChannel") or [`MeasureChannel`](qiskit.pulse.MeasureChannel "qiskit.pulse.MeasureChannel") will be shifted. If you wish to keep the relative timing of all instructions in the schedule set `align_all=True`. This method assumes that `MeasureChannel(i)` and `AcquireChannel(i)` correspond to the same qubit and the acquire/play instructions should be shifted together on these channels. @@ -65,4 +73,5 @@ The input list of schedules transformed to have their measurements aligned. **Raises** -[**PulseError**](qiskit.pulse.PulseError#qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the provided alignment time is negative. +[**PulseError**](qiskit.pulse.PulseError "qiskit.pulse.PulseError") – If the provided alignment time is negative. + 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 56916211763..4fde0d29b1f 100644 --- a/docs/api/qiskit/0.32/qiskit.pulse.transforms.pad.md +++ b/docs/api/qiskit/0.32/qiskit.pulse.transforms.pad.md @@ -1,8 +1,16 @@ -# qiskit.pulse.transforms.pad +--- +title: pad +description: API reference for qiskit.pulse.transforms.pad +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.pulse.transforms.pad +--- +# qiskit.pulse.transforms.pad + -`pad(schedule, channels=None, until=None, inplace=False)` +`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`. @@ -20,3 +28,4 @@ Pad the input Schedule with `Delay``s on all unoccupied timeslots until ``schedu **Returns** The padded schedule. + diff --git a/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md b/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md index 2146954eac5..d44ffaee05c 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.OpenQASMLexer.md @@ -1,8 +1,16 @@ -# OpenQASMLexer +--- +title: OpenQASMLexer +description: API reference for qiskit.qasm.OpenQASMLexer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qasm.OpenQASMLexer +--- +# OpenQASMLexer + -`OpenQASMLexer(*args, **kwds)` +`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` @@ -10,67 +18,99 @@ A pygments lexer for OpenQasm. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`add_filter`](qiskit.qasm.OpenQASMLexer.add_filter#qiskit.qasm.OpenQASMLexer.add_filter "qiskit.qasm.OpenQASMLexer.add_filter") | Add a new stream filter to this lexer. | -| [`analyse_text`](qiskit.qasm.OpenQASMLexer.analyse_text#qiskit.qasm.OpenQASMLexer.analyse_text "qiskit.qasm.OpenQASMLexer.analyse_text") | Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. | -| [`get_tokens`](qiskit.qasm.OpenQASMLexer.get_tokens#qiskit.qasm.OpenQASMLexer.get_tokens "qiskit.qasm.OpenQASMLexer.get_tokens") | Return an iterable of (tokentype, value) pairs generated from text. | -| [`get_tokens_unprocessed`](qiskit.qasm.OpenQASMLexer.get_tokens_unprocessed#qiskit.qasm.OpenQASMLexer.get_tokens_unprocessed "qiskit.qasm.OpenQASMLexer.get_tokens_unprocessed") | Split `text` into (tokentype, text) pairs. | +### add\_filter -## Attributes + + +`OpenQASMLexer.add_filter(filter_, **options)` + +Add a new stream filter to this lexer. + +### analyse\_text + + + +`static OpenQASMLexer.analyse_text(text)` + +Has to return a float between `0` and `1` that indicates if a lexer wants to highlight this text. Used by `guess_lexer`. If this method returns `0` it won’t highlight it in any case, if it returns `1` highlighting with this lexer is guaranteed. + +The LexerMeta metaclass automatically wraps this function so that it works like a static method (no `self` or `cls` parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it’s the same as if the return values was `0.0`. + +### get\_tokens + + + +`OpenQASMLexer.get_tokens(text, unfiltered=False)` + +Return an iterable of (tokentype, value) pairs generated from text. If unfiltered is set to True, the filtering mechanism is bypassed even if filters are defined. + +Also preprocess the text, i.e. expand tabs and strip it if wanted and applies registered filters. +### get\_tokens\_unprocessed + + +`OpenQASMLexer.get_tokens_unprocessed(text, stack=('root'))` + +Split `text` into (tokentype, text) pairs. + +`stack` is the inital stack (default: `['root']`) + +## Attributes + + ### alias\_filenames `= []` - + ### aliases `= ['qasm']` - + ### filenames `= ['*.qasm']` - + ### flags `= 8` - + ### gates `= ['id', 'cx', 'x', 'y', 'z', 's', 'sdg', 'h', 't', 'tdg', 'ccx', 'c3x', 'c4x', 'c3sqrtx', 'rx', 'ry', 'rz', 'cz', 'cy', 'ch', 'swap', 'cswap', 'crx', 'cry', 'crz', 'cu1', 'cu3', 'rxx', 'rzz', 'rccx', 'rc3x', 'u1', 'u2', 'u3']` - + ### mimetypes `= []` - + ### name `= 'OpenQASM'` - + ### priority `= 0` - + ### tokens = \{'gate' `= {'gate':` `= {'gate': [('[unitary\\d+]', Token.Keyword.Type, '#push'), ('p\\d+', Token.Text, '#push')], 'if_keywords': [('[a-zA-Z0-9_]*', Token.Literal.String, '#pop'), ('\\d+', Token.Literal.Number, '#push'), ('.*\\(', Token.Text, 'params')], 'index': [('\\d+', Token.Literal.Number, '#pop')], 'keywords': [('\\s*("([^"]|"")*")', Token.Literal.String, '#push'), ('\\d+', Token.Literal.Number, '#push'), ('.*\\(', Token.Text, 'params')], 'params': [('[a-zA-Z_][a-zA-Z0-9_]*', Token.Text, '#push'), ('\\d+', Token.Literal.Number, '#push'), ('(\\d+\\.\\d*|\\d*\\.\\d+)([eEf][+-]?[0-9]+)?', Token.Literal.Number, '#push'), ('\\)', Token.Text)], 'root': [('\\n', Token.Text), ('[^\\S\\n]+', Token.Text), ('//\\n', Token.Comment), ('//.*?$', Token.Comment.Single), ('(OPENQASM|include)\\b', Token.Keyword.Reserved, 'keywords'), ('(qreg|creg)\\b', Token.Keyword.Declaration), ('(if)\\b', Token.Keyword.Reserved, 'if_keywords'), ('(pi)\\b', Token.Name.Constant), ('(barrier|measure|reset)\\b', Token.Name.Builtin, 'params'), ('(id|cx|x|y|z|s|sdg|h|t|tdg|ccx|c3x|c4x|c3sqrtx|rx|ry|rz|cz|cy|ch|swap|cswap|crx|cry|crz|cu1|cu3|rxx|rzz|rccx|rc3x|u1|u2|u3)\\b', Token.Keyword.Type, 'params'), ('[unitary\\d+]', Token.Keyword.Type), ('(gate)\\b', Token.Name.Function, 'gate'), ('[a-zA-Z_][a-zA-Z0-9_]*', Token.Text, 'index')]}` + diff --git a/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md b/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md index ed01701c9cc..5811942acdb 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.Qasm.md @@ -1,8 +1,16 @@ -# Qasm +--- +title: Qasm +description: API reference for qiskit.qasm.Qasm +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qasm.Qasm +--- +# Qasm + -`Qasm(filename=None, data=None)` +`Qasm(filename=None, data=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") Bases: `object` @@ -12,8 +20,27 @@ Create an OPENQASM circuit object. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`generate_tokens`](qiskit.qasm.Qasm.generate_tokens#qiskit.qasm.Qasm.generate_tokens "qiskit.qasm.Qasm.generate_tokens") | Returns a generator of the tokens. | -| [`parse`](qiskit.qasm.Qasm.parse#qiskit.qasm.Qasm.parse "qiskit.qasm.Qasm.parse") | Parse the data. | -| [`return_filename`](qiskit.qasm.Qasm.return_filename#qiskit.qasm.Qasm.return_filename "qiskit.qasm.Qasm.return_filename") | Return the filename. | +### generate\_tokens + + + +`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. + +### parse + + + +`Qasm.parse()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/qasm.py "view source code") + +Parse the data. + +### return\_filename + + + +`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 f7a83943d9d..0953fcef5e4 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmError.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmError.md @@ -1,9 +1,18 @@ -# qiskit.qasm.QasmError +--- +title: QasmError +description: API reference for qiskit.qasm.QasmError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.qasm.QasmError +--- +# qiskit.qasm.QasmError + -`QasmError(*msg)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md b/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md index 9babcc1930c..209c8682ecd 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmHTMLStyle.md @@ -1,8 +1,16 @@ -# QasmHTMLStyle +--- +title: QasmHTMLStyle +description: API reference for qiskit.qasm.QasmHTMLStyle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qasm.QasmHTMLStyle +--- +# QasmHTMLStyle + -`QasmHTMLStyle` +`QasmHTMLStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` @@ -10,43 +18,43 @@ A style for OpenQasm in a HTML env (e.g. Jupyter widget). ## Attributes - + ### background\_color `= '#ffffff'` - + ### highlight\_color `= '#ffffcc'` - + ### line\_number\_background\_color `= 'transparent'` - + ### line\_number\_color `= 'inherit'` - + ### line\_number\_special\_background\_color `= '#ffffc0'` - + ### line\_number\_special\_color `= '#000000'` - + ### styles = \{Token @@ -54,8 +62,9 @@ A style for OpenQasm in a HTML env (e.g. Jupyter widget). `= {Token: '', Token.Comment: '', Token.Comment.Hashbang: '', Token.Comment.Multiline: '', Token.Comment.Preproc: '', Token.Comment.PreprocFile: '', Token.Comment.Single: '', Token.Comment.Special: '', Token.Error: '', Token.Escape: '', Token.Generic: '', Token.Generic.Deleted: '', Token.Generic.Emph: '', Token.Generic.Error: '', Token.Generic.Heading: '', Token.Generic.Inserted: '', Token.Generic.Output: '', Token.Generic.Prompt: '', Token.Generic.Strong: '', Token.Generic.Subheading: '', Token.Generic.Traceback: '', Token.Keyword: '', Token.Keyword.Constant: '', Token.Keyword.Declaration: 'ansigreen', Token.Keyword.Namespace: '', Token.Keyword.Pseudo: '', Token.Keyword.Reserved: 'ansigreen', Token.Keyword.Type: 'ansimagenta', Token.Literal: '', Token.Literal.Date: '', Token.Literal.Number: 'ansicyan', Token.Literal.Number.Bin: '', Token.Literal.Number.Float: '', Token.Literal.Number.Hex: '', Token.Literal.Number.Integer: '', Token.Literal.Number.Integer.Long: '', Token.Literal.Number.Oct: '', Token.Literal.String: 'ansired', Token.Literal.String.Affix: '', Token.Literal.String.Backtick: '', Token.Literal.String.Char: '', Token.Literal.String.Delimiter: '', Token.Literal.String.Doc: '', Token.Literal.String.Double: '', Token.Literal.String.Escape: '', Token.Literal.String.Heredoc: '', Token.Literal.String.Interpol: '', Token.Literal.String.Other: '', Token.Literal.String.Regex: '', Token.Literal.String.Single: '', Token.Literal.String.Symbol: '', Token.Name: '', Token.Name.Attribute: '', Token.Name.Builtin: 'ansiblue', Token.Name.Builtin.Pseudo: '', Token.Name.Class: '', Token.Name.Constant: '', Token.Name.Decorator: '', Token.Name.Entity: '', Token.Name.Exception: '', Token.Name.Function: 'ansiyellow', Token.Name.Function.Magic: '', Token.Name.Label: '', Token.Name.Namespace: '', Token.Name.Other: '', Token.Name.Property: '', Token.Name.Tag: '', Token.Name.Variable: '', Token.Name.Variable.Class: '', Token.Name.Variable.Global: '', Token.Name.Variable.Instance: '', Token.Name.Variable.Magic: '', Token.Operator: '', Token.Operator.Word: '', Token.Other: '', Token.Punctuation: '', Token.Text: '', Token.Text.Whitespace: ''}` - + ### web\_style\_gallery\_exclude `= False` + diff --git a/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md b/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md index 973d362e2cf..73a9dc50229 100644 --- a/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md +++ b/docs/api/qiskit/0.32/qiskit.qasm.QasmTerminalStyle.md @@ -1,8 +1,16 @@ -# QasmTerminalStyle +--- +title: QasmTerminalStyle +description: API reference for qiskit.qasm.QasmTerminalStyle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qasm.QasmTerminalStyle +--- +# QasmTerminalStyle + -`QasmTerminalStyle` +`QasmTerminalStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qasm/pygments/lexer.py "view source code") Bases: `pygments.style.Style` @@ -10,43 +18,43 @@ A style for OpenQasm in a Terminal env (e.g. Jupyter print). ## Attributes - + ### background\_color `= '#ffffff'` - + ### highlight\_color `= '#ffffcc'` - + ### line\_number\_background\_color `= 'transparent'` - + ### line\_number\_color `= 'inherit'` - + ### line\_number\_special\_background\_color `= '#ffffc0'` - + ### line\_number\_special\_color `= '#000000'` - + ### styles = \{Token @@ -54,8 +62,9 @@ A style for OpenQasm in a Terminal env (e.g. Jupyter print). `= {Token: '', Token.Comment: '', Token.Comment.Hashbang: '', Token.Comment.Multiline: '', Token.Comment.Preproc: '', Token.Comment.PreprocFile: '', Token.Comment.Single: '', Token.Comment.Special: '', Token.Error: '', Token.Escape: '', Token.Generic: '', Token.Generic.Deleted: '', Token.Generic.Emph: '', Token.Generic.Error: '', Token.Generic.Heading: '', Token.Generic.Inserted: '', Token.Generic.Output: '', Token.Generic.Prompt: '', Token.Generic.Strong: '', Token.Generic.Subheading: '', Token.Generic.Traceback: '', Token.Keyword: '', Token.Keyword.Constant: '', Token.Keyword.Declaration: 'ansibrightgreen', Token.Keyword.Namespace: '', Token.Keyword.Pseudo: '', Token.Keyword.Reserved: 'ansibrightgreen', Token.Keyword.Type: 'ansibrightmagenta', Token.Literal: '', Token.Literal.Date: '', Token.Literal.Number: 'ansibrightcyan', Token.Literal.Number.Bin: '', Token.Literal.Number.Float: '', Token.Literal.Number.Hex: '', Token.Literal.Number.Integer: '', Token.Literal.Number.Integer.Long: '', Token.Literal.Number.Oct: '', Token.Literal.String: 'ansibrightred', Token.Literal.String.Affix: '', Token.Literal.String.Backtick: '', Token.Literal.String.Char: '', Token.Literal.String.Delimiter: '', Token.Literal.String.Doc: '', Token.Literal.String.Double: '', Token.Literal.String.Escape: '', Token.Literal.String.Heredoc: '', Token.Literal.String.Interpol: '', Token.Literal.String.Other: '', Token.Literal.String.Regex: '', Token.Literal.String.Single: '', Token.Literal.String.Symbol: '', Token.Name: '', Token.Name.Attribute: '', Token.Name.Builtin: 'ansibrightblue', Token.Name.Builtin.Pseudo: '', Token.Name.Class: '', Token.Name.Constant: '', Token.Name.Decorator: '', Token.Name.Entity: '', Token.Name.Exception: '', Token.Name.Function: 'ansibrightyellow', Token.Name.Function.Magic: '', Token.Name.Label: '', Token.Name.Namespace: '', Token.Name.Other: '', Token.Name.Property: '', Token.Name.Tag: '', Token.Name.Variable: '', Token.Name.Variable.Class: '', Token.Name.Variable.Global: '', Token.Name.Variable.Instance: '', Token.Name.Variable.Magic: '', Token.Operator: '', Token.Operator.Word: '', Token.Other: '', Token.Punctuation: '', Token.Text: '', Token.Text.Whitespace: ''}` - + ### web\_style\_gallery\_exclude `= False` + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md b/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md index 0c23376b620..dc6807f4f47 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.GateCalibration.md @@ -1,8 +1,16 @@ -# GateCalibration +--- +title: GateCalibration +description: API reference for qiskit.qobj.GateCalibration +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.GateCalibration +--- +# GateCalibration + -`GateCalibration(name, qubits, params, instructions)` +`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` @@ -15,11 +23,43 @@ Initialize a single gate calibration. Instructions may reference waveforms which * **name** (*str*) – Gate name. * **qubits** (*list(int)*) – Qubits the gate applies to. * **params** (*list(complex)*) – Gate parameter values, if any. -* **instructions** (*list(*[*PulseQobjInstruction*](qiskit.qobj.PulseQobjInstruction#qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")*)*) – The gate implementation. +* **instructions** (*list(*[*PulseQobjInstruction*](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")*)*) – The gate implementation. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`from_dict`](qiskit.qobj.GateCalibration.from_dict#qiskit.qobj.GateCalibration.from_dict "qiskit.qobj.GateCalibration.from_dict") | Create a new GateCalibration object from a dictionary. | -| [`to_dict`](qiskit.qobj.GateCalibration.to_dict#qiskit.qobj.GateCalibration.to_dict "qiskit.qobj.GateCalibration.to_dict") | Return a dictionary format representation of the Gate Calibration. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the GateCalibration to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.GateCalibration#to_dict "qiskit.qobj.GateCalibration.to_dict"). + +**Returns** + +The GateCalibration from the input dictionary. + +**Return type** + +[GateCalibration](qiskit.qobj.GateCalibration "qiskit.qobj.GateCalibration") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the GateCalibration. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md index 5145c1febe8..250da02a36c 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseLibraryItem.md @@ -1,8 +1,16 @@ -# PulseLibraryItem +--- +title: PulseLibraryItem +description: API reference for qiskit.qobj.PulseLibraryItem +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.PulseLibraryItem +--- +# PulseLibraryItem + -`PulseLibraryItem(name, samples)` +`PulseLibraryItem(name, samples)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -17,7 +25,39 @@ Instantiate a pulse library item. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.PulseLibraryItem.from_dict#qiskit.qobj.PulseLibraryItem.from_dict "qiskit.qobj.PulseLibraryItem.from_dict") | Create a new PulseLibraryItem object from a dictionary. | -| [`to_dict`](qiskit.qobj.PulseLibraryItem.to_dict#qiskit.qobj.PulseLibraryItem.to_dict "qiskit.qobj.PulseLibraryItem.to_dict") | Return a dictionary format representation of the pulse library item. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the experiment config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[PulseLibraryItem](qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the PulseLibraryItem. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md index e76b5c8ec7f..f32e162938b 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobj.md @@ -1,8 +1,16 @@ -# PulseQobj +--- +title: PulseQobj +description: API reference for qiskit.qobj.PulseQobj +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.PulseQobj +--- +# PulseQobj + -`PulseQobj(qobj_id, config, experiments, header=None)` +`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` @@ -15,13 +23,66 @@ Each Pulse Qobj object is used to represent a single payload that will be passed **Parameters** * **qobj\_id** (*str*) – An identifier for the qobj -* **config** ([*PulseQobjConfig*](qiskit.qobj.PulseQobjConfig#qiskit.qobj.PulseQobjConfig "qiskit.qobj.PulseQobjConfig")) – A config for the entire run -* **header** ([*QobjHeader*](qiskit.qobj.QobjHeader#qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader")) – A header for the entire run -* **experiments** (*list*) – A list of lists of [`PulseQobjExperiment`](qiskit.qobj.PulseQobjExperiment#qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment") objects representing an experiment +* **config** ([*PulseQobjConfig*](qiskit.qobj.PulseQobjConfig "qiskit.qobj.PulseQobjConfig")) – A config for the entire run +* **header** ([*QobjHeader*](qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader")) – A header for the entire run +* **experiments** (*list*) – A list of lists of [`PulseQobjExperiment`](qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment") objects representing an experiment ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`from_dict`](qiskit.qobj.PulseQobj.from_dict#qiskit.qobj.PulseQobj.from_dict "qiskit.qobj.PulseQobj.from_dict") | Create a new PulseQobj object from a dictionary. | -| [`to_dict`](qiskit.qobj.PulseQobj.to_dict#qiskit.qobj.PulseQobj.to_dict "qiskit.qobj.PulseQobj.to_dict") | Return a dictionary format representation of the Pulse Qobj. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the PulseQobj to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.PulseQobj#to_dict "qiskit.qobj.PulseQobj.to_dict"). + +**Returns** + +The PulseQobj from the input dictionary. + +**Return type** + +[PulseQobj](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj") + +### to\_dict + + + +`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. + +Note this dict is not in the json wire format expected by IBMQ and qobj specification because complex numbers are still of type complex. Also this may contain native numpy arrays. When serializing this output for use with IBMQ you can leverage a json encoder that converts these as expected. For example: + +```python +import json +import numpy + +class QobjEncoder(json.JSONEncoder): + def default(self, obj): + if isinstance(obj, numpy.ndarray): + return obj.tolist() + if isinstance(obj, complex): + return (obj.real, obj.imag) + return json.JSONEncoder.default(self, obj) + +json.dumps(qobj.to_dict(), cls=QobjEncoder) +``` + +**Parameters** + +**validate** (*bool*) – When set to true validate the output dictionary against the jsonschema for qobj spec. + +**Returns** + +A dictionary representation of the PulseQobj object + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md index 2a4c9977803..23de14f2b58 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjConfig.md @@ -1,8 +1,16 @@ -# PulseQobjConfig +--- +title: PulseQobjConfig +description: API reference for qiskit.qobj.PulseQobjConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.PulseQobjConfig +--- +# PulseQobjConfig + -`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)` +`PulseQobjConfig(meas_level, meas_return, pulse_library, qubit_lo_freq, meas_lo_freq, memory_slot_size=None, rep_time=None, rep_delay=None, shots=None, max_credits=None, seed_simulator=None, memory_slots=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -14,7 +22,7 @@ Instantiate a PulseQobjConfig object. * **meas\_level** (*int*) – The measurement level to use. * **meas\_return** (*int*) – The level of measurement information to return. -* **pulse\_library** (*list*) – A list of [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem#qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem") objects which define the set of primitive pulses +* **pulse\_library** (*list*) – A list of [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem") objects which define the set of primitive pulses * **qubit\_lo\_freq** (*list*) – List of frequencies (as floats) for the qubit driver LO’s in GHz. * **meas\_lo\_freq** (*list*) – List of frequencies (as floats) for the’ measurement driver LO’s in GHz. * **memory\_slot\_size** (*int*) – Size of each memory slot if the output is Level 0. @@ -28,7 +36,39 @@ Instantiate a PulseQobjConfig object. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.PulseQobjConfig.from_dict#qiskit.qobj.PulseQobjConfig.from_dict "qiskit.qobj.PulseQobjConfig.from_dict") | Create a new PulseQobjConfig object from a dictionary. | -| [`to_dict`](qiskit.qobj.PulseQobjConfig.to_dict#qiskit.qobj.PulseQobjConfig.to_dict "qiskit.qobj.PulseQobjConfig.to_dict") | Return a dictionary format representation of the Pulse Qobj config. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[PulseQobjConfig](qiskit.qobj.PulseQobjConfig "qiskit.qobj.PulseQobjConfig") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the PulseQobjConfig. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md index 4e205dd1e16..946eb56277f 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperiment.md @@ -1,8 +1,16 @@ -# PulseQobjExperiment +--- +title: PulseQobjExperiment +description: API reference for qiskit.qobj.PulseQobjExperiment +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.PulseQobjExperiment +--- +# PulseQobjExperiment + -`PulseQobjExperiment(instructions, config=None, header=None)` +`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` @@ -14,13 +22,45 @@ Instantiate a PulseQobjExperiment. **Parameters** -* **config** ([*PulseQobjExperimentConfig*](qiskit.qobj.PulseQobjExperimentConfig#qiskit.qobj.PulseQobjExperimentConfig "qiskit.qobj.PulseQobjExperimentConfig")) – A config object for the experiment +* **config** ([*PulseQobjExperimentConfig*](qiskit.qobj.PulseQobjExperimentConfig "qiskit.qobj.PulseQobjExperimentConfig")) – A config object for the experiment * **header** (*PulseQobjExperimentHeader*) – A header object for the experiment -* **instructions** (*list*) – A list of [`PulseQobjInstruction`](qiskit.qobj.PulseQobjInstruction#qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction") objects +* **instructions** (*list*) – A list of [`PulseQobjInstruction`](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction") objects ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`from_dict`](qiskit.qobj.PulseQobjExperiment.from_dict#qiskit.qobj.PulseQobjExperiment.from_dict "qiskit.qobj.PulseQobjExperiment.from_dict") | Create a new PulseQobjExperiment object from a dictionary. | -| [`to_dict`](qiskit.qobj.PulseQobjExperiment.to_dict#qiskit.qobj.PulseQobjExperiment.to_dict "qiskit.qobj.PulseQobjExperiment.to_dict") | Return a dictionary format representation of the Experiment. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the experiment config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[PulseQobjExperiment](qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the PulseQobjExperiment. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md index 6e656ce13c0..a102b65db76 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjExperimentConfig.md @@ -1,8 +1,16 @@ -# PulseQobjExperimentConfig +--- +title: PulseQobjExperimentConfig +description: API reference for qiskit.qobj.PulseQobjExperimentConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.PulseQobjExperimentConfig +--- +# PulseQobjExperimentConfig + -`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` +`PulseQobjExperimentConfig(qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -18,7 +26,39 @@ Instantiate a PulseQobjExperimentConfig object. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.PulseQobjExperimentConfig.from_dict#qiskit.qobj.PulseQobjExperimentConfig.from_dict "qiskit.qobj.PulseQobjExperimentConfig.from_dict") | Create a new QobjHeader object from a dictionary. | -| [`to_dict`](qiskit.qobj.PulseQobjExperimentConfig.to_dict#qiskit.qobj.PulseQobjExperimentConfig.to_dict "qiskit.qobj.PulseQobjExperimentConfig.to_dict") | Return a dictionary format representation of the QASM Qobj. | +### from\_dict + + + +`classmethod PulseQobjExperimentConfig.from_dict(data)` + +Create a new QobjHeader object from a dictionary. + +**Parameters** + +**data** (*dict*) – A dictionary representing the QobjHeader to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.PulseQobjExperimentConfig#to_dict "qiskit.qobj.PulseQobjExperimentConfig.to_dict"). + +**Returns** + +The QobjDictField from the input dictionary. + +**Return type** + +QobjDictFieldr + +### to\_dict + + + +`PulseQobjExperimentConfig.to_dict()` + +Return a dictionary format representation of the QASM Qobj. + +**Returns** + +The dictionary form of the QobjHeader. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md index 21eb5304b19..09e4e8cf6b6 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.PulseQobjInstruction.md @@ -1,8 +1,16 @@ -# PulseQobjInstruction +--- +title: PulseQobjInstruction +description: API reference for qiskit.qobj.PulseQobjInstruction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.PulseQobjInstruction +--- +# PulseQobjInstruction + -`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)` +`PulseQobjInstruction(name, t0, ch=None, conditional=None, val=None, phase=None, duration=None, qubits=None, memory_slot=None, register_slot=None, kernels=None, discriminators=None, label=None, type=None, pulse_shape=None, parameters=None, frequency=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -23,8 +31,8 @@ Instantiate a new PulseQobjInstruction object. * **qubits** (*list*) – A list of `int` representing the qubits the instruction operates on * **memory\_slot** (*list*) – If a `measure` instruction this is a list of `int` containing the list of memory slots to store the measurement results in (must be the same length as qubits). If a `bfunc` instruction this is a single `int` of the memory slot to store the boolean function result in. * **register\_slot** (*list*) – If a `measure` instruction this is a list of `int` containing the list of register slots in which to store the measurement results (must be the same length as qubits). If a `bfunc` instruction this is a single `int` of the register slot in which to store the result. -* **kernels** (*list*) – List of [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption#qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption") objects defining the measurement kernels and set of parameters if the measurement level is 1 or 2. Only used for `acquire` instructions. -* **discriminators** (*list*) – A list of [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption#qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption") used to set the discriminators to be used if the measurement level is 2. Only used for `acquire` instructions. +* **kernels** (*list*) – List of [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption") objects defining the measurement kernels and set of parameters if the measurement level is 1 or 2. Only used for `acquire` instructions. +* **discriminators** (*list*) – A list of [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption") used to set the discriminators to be used if the measurement level is 2. Only used for `acquire` instructions. * **label** (*str*) – Label of instruction * **type** (*str*) – Type of instruction * **pulse\_shape** (*str*) – The shape of the parametric pulse @@ -32,7 +40,39 @@ Instantiate a new PulseQobjInstruction object. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.PulseQobjInstruction.from_dict#qiskit.qobj.PulseQobjInstruction.from_dict "qiskit.qobj.PulseQobjInstruction.from_dict") | Create a new PulseQobjExperimentConfig object from a dictionary. | -| [`to_dict`](qiskit.qobj.PulseQobjInstruction.to_dict#qiskit.qobj.PulseQobjInstruction.to_dict "qiskit.qobj.PulseQobjInstruction.to_dict") | Return a dictionary format representation of the Instruction. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the experiment config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[PulseQobjInstruction](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the PulseQobjInstruction. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md index 263eb76bd5a..93e83cf8204 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmExperimentCalibrations.md @@ -1,8 +1,16 @@ -# QasmExperimentCalibrations +--- +title: QasmExperimentCalibrations +description: API reference for qiskit.qobj.QasmExperimentCalibrations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QasmExperimentCalibrations +--- +# QasmExperimentCalibrations + -`QasmExperimentCalibrations(gates)` +`QasmExperimentCalibrations(gates)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -12,11 +20,43 @@ Initialize a container for calibrations. **Parameters** -**gates** (*list(*[*GateCalibration*](qiskit.qobj.GateCalibration#qiskit.qobj.GateCalibration "qiskit.qobj.GateCalibration")*)*) – +**gates** (*list(*[*GateCalibration*](qiskit.qobj.GateCalibration "qiskit.qobj.GateCalibration")*)*) – ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.QasmExperimentCalibrations.from_dict#qiskit.qobj.QasmExperimentCalibrations.from_dict "qiskit.qobj.QasmExperimentCalibrations.from_dict") | Create a new GateCalibration object from a dictionary. | -| [`to_dict`](qiskit.qobj.QasmExperimentCalibrations.to_dict#qiskit.qobj.QasmExperimentCalibrations.to_dict "qiskit.qobj.QasmExperimentCalibrations.to_dict") | Return a dictionary format representation of the calibrations. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the QasmExperimentCalibrations to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.QasmExperimentCalibrations#to_dict "qiskit.qobj.QasmExperimentCalibrations.to_dict"). + +**Returns** + +The QasmExperimentCalibrations from the input dictionary. + +**Return type** + +[QasmExperimentCalibrations](qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the GateCalibration. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md index cab4d1fe15f..229e0c25a80 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobj.md @@ -1,8 +1,16 @@ -# QasmQobj +--- +title: QasmQobj +description: API reference for qiskit.qobj.QasmQobj +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QasmQobj +--- +# QasmQobj + -`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)` +`QasmQobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -16,12 +24,65 @@ Each QASM Qobj object is used to represent a single payload that will be passed * **qobj\_id** (*str*) – An identifier for the qobj * **config** (*QasmQobjRunConfig*) – A config for the entire run -* **header** ([*QobjHeader*](qiskit.qobj.QobjHeader#qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader")) – A header for the entire run -* **experiments** (*list*) – A list of lists of [`QasmQobjExperiment`](qiskit.qobj.QasmQobjExperiment#qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment") objects representing an experiment +* **header** ([*QobjHeader*](qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader")) – A header for the entire run +* **experiments** (*list*) – A list of lists of [`QasmQobjExperiment`](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment") objects representing an experiment ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.QasmQobj.from_dict#qiskit.qobj.QasmQobj.from_dict "qiskit.qobj.QasmQobj.from_dict") | Create a new QASMQobj object from a dictionary. | -| [`to_dict`](qiskit.qobj.QasmQobj.to_dict#qiskit.qobj.QasmQobj.to_dict "qiskit.qobj.QasmQobj.to_dict") | Return a dictionary format representation of the QASM Qobj. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the QasmQobj to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.QasmQobj#to_dict "qiskit.qobj.QasmQobj.to_dict"). + +**Returns** + +The QasmQobj from the input dictionary. + +**Return type** + +[QasmQobj](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj") + +### to\_dict + + + +`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. + +Note this dict is not in the json wire format expected by IBMQ and qobj specification because complex numbers are still of type complex. Also this may contain native numpy arrays. When serializing this output for use with IBMQ you can leverage a json encoder that converts these as expected. For example: + +```python +import json +import numpy + +class QobjEncoder(json.JSONEncoder): + def default(self, obj): + if isinstance(obj, numpy.ndarray): + return obj.tolist() + if isinstance(obj, complex): + return (obj.real, obj.imag) + return json.JSONEncoder.default(self, obj) + +json.dumps(qobj.to_dict(), cls=QobjEncoder) +``` + +**Parameters** + +**validate** (*bool*) – When set to true validate the output dictionary against the jsonschema for qobj spec. + +**Returns** + +A dictionary representation of the QasmQobj object + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md index 5aaa6e0bb22..68efc15b60a 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjConfig.md @@ -1,8 +1,16 @@ -# QasmQobjConfig +--- +title: QasmQobjConfig +description: API reference for qiskit.qobj.QasmQobjConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QasmQobjConfig +--- +# QasmQobjConfig + -`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` +`QasmQobjConfig(shots=None, max_credits=None, seed_simulator=None, memory=None, parameter_binds=None, meas_level=None, meas_return=None, memory_slots=None, n_qubits=None, pulse_library=None, calibrations=None, rep_delay=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `types.SimpleNamespace` @@ -21,8 +29,8 @@ Model for RunConfig. * **meas\_return** (*str*) – For measurement level \< 2, whether single or avg shots are returned * **memory\_slots** (*int*) – The number of memory slots on the device * **n\_qubits** (*int*) – The number of qubits on the device -* **pulse\_library** (*list*) – List of [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem#qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem"). -* **calibrations** ([*QasmExperimentCalibrations*](qiskit.qobj.QasmExperimentCalibrations#qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations")) – Information required for Pulse gates. +* **pulse\_library** (*list*) – List of [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem"). +* **calibrations** ([*QasmExperimentCalibrations*](qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations")) – Information required for Pulse gates. * **rep\_delay** (*float*) – Delay between programs in sec. Only supported on certain backends (`backend.configuration().dynamic_reprate_enabled` ). Must be from the range supplied by the backend (`backend.configuration().rep_delay_range`). Default is `backend.configuration().default_rep_delay`. * **qubit\_lo\_freq** (*list*) – List of frequencies (as floats) for the qubit driver LO’s in GHz. * **meas\_lo\_freq** (*list*) – List of frequencies (as floats) for the measurement driver LO’s in GHz. @@ -30,7 +38,39 @@ Model for RunConfig. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| [`from_dict`](qiskit.qobj.QasmQobjConfig.from_dict#qiskit.qobj.QasmQobjConfig.from_dict "qiskit.qobj.QasmQobjConfig.from_dict") | Create a new QasmQobjConfig object from a dictionary. | -| [`to_dict`](qiskit.qobj.QasmQobjConfig.to_dict#qiskit.qobj.QasmQobjConfig.to_dict "qiskit.qobj.QasmQobjConfig.to_dict") | Return a dictionary format representation of the QASM Qobj config. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[QasmQobjConfig](qiskit.qobj.QasmQobjConfig "qiskit.qobj.QasmQobjConfig") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the QasmQobjConfig. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md index 07777693e32..1ac3a0d1412 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperiment.md @@ -1,8 +1,16 @@ -# QasmQobjExperiment +--- +title: QasmQobjExperiment +description: API reference for qiskit.qobj.QasmQobjExperiment +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QasmQobjExperiment +--- +# QasmQobjExperiment + -`QasmQobjExperiment(config=None, header=None, instructions=None)` +`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` @@ -14,13 +22,45 @@ Instantiate a QasmQobjExperiment. **Parameters** -* **config** ([*QasmQobjExperimentConfig*](qiskit.qobj.QasmQobjExperimentConfig#qiskit.qobj.QasmQobjExperimentConfig "qiskit.qobj.QasmQobjExperimentConfig")) – A config object for the experiment +* **config** ([*QasmQobjExperimentConfig*](qiskit.qobj.QasmQobjExperimentConfig "qiskit.qobj.QasmQobjExperimentConfig")) – A config object for the experiment * **header** (*QasmQobjExperimentHeader*) – A header object for the experiment -* **instructions** (*list*) – A list of [`QasmQobjInstruction`](qiskit.qobj.QasmQobjInstruction#qiskit.qobj.QasmQobjInstruction "qiskit.qobj.QasmQobjInstruction") objects +* **instructions** (*list*) – A list of [`QasmQobjInstruction`](qiskit.qobj.QasmQobjInstruction "qiskit.qobj.QasmQobjInstruction") objects ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`from_dict`](qiskit.qobj.QasmQobjExperiment.from_dict#qiskit.qobj.QasmQobjExperiment.from_dict "qiskit.qobj.QasmQobjExperiment.from_dict") | Create a new QasmQobjExperiment object from a dictionary. | -| [`to_dict`](qiskit.qobj.QasmQobjExperiment.to_dict#qiskit.qobj.QasmQobjExperiment.to_dict "qiskit.qobj.QasmQobjExperiment.to_dict") | Return a dictionary format representation of the Experiment. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the experiment config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[QasmQobjExperiment](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the QasmQObjExperiment. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md index 161cc596f9a..169ff7f0edd 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjExperimentConfig.md @@ -1,8 +1,16 @@ -# QasmQobjExperimentConfig +--- +title: QasmQobjExperimentConfig +description: API reference for qiskit.qobj.QasmQobjExperimentConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QasmQobjExperimentConfig +--- +# QasmQobjExperimentConfig + -`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)` +`QasmQobjExperimentConfig(calibrations=None, qubit_lo_freq=None, meas_lo_freq=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -10,14 +18,46 @@ Configuration for a single QASM experiment in the qobj. **Parameters** -* **calibrations** ([*QasmExperimentCalibrations*](qiskit.qobj.QasmExperimentCalibrations#qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations")) – Information required for Pulse gates. +* **calibrations** ([*QasmExperimentCalibrations*](qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations")) – Information required for Pulse gates. * **qubit\_lo\_freq** (*List\[float]*) – List of qubit LO frequencies in GHz. * **meas\_lo\_freq** (*List\[float]*) – List of meas readout LO frequencies in GHz. * **kwargs** – Additional free form key value fields to add to the configuration ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.QasmQobjExperimentConfig.from_dict#qiskit.qobj.QasmQobjExperimentConfig.from_dict "qiskit.qobj.QasmQobjExperimentConfig.from_dict") | Create a new QobjHeader object from a dictionary. | -| [`to_dict`](qiskit.qobj.QasmQobjExperimentConfig.to_dict#qiskit.qobj.QasmQobjExperimentConfig.to_dict "qiskit.qobj.QasmQobjExperimentConfig.to_dict") | Return a dictionary format representation of the QASM Qobj. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the QobjHeader to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.QasmQobjExperimentConfig#to_dict "qiskit.qobj.QasmQobjExperimentConfig.to_dict"). + +**Returns** + +The QobjDictField from the input dictionary. + +**Return type** + +QobjDictFieldr + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the QobjHeader. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md index fca8c6215f9..2a8827e0025 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QasmQobjInstruction.md @@ -1,8 +1,16 @@ -# QasmQobjInstruction +--- +title: QasmQobjInstruction +description: API reference for qiskit.qobj.QasmQobjInstruction +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QasmQobjInstruction +--- +# QasmQobjInstruction + -`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)` +`QasmQobjInstruction(name, params=None, qubits=None, register=None, memory=None, condition=None, conditional=None, label=None, mask=None, relation=None, val=None, snapshot_type=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/qasm_qobj.py "view source code") Bases: `object` @@ -27,7 +35,39 @@ Instantiate a new QasmQobjInstruction object. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.QasmQobjInstruction.from_dict#qiskit.qobj.QasmQobjInstruction.from_dict "qiskit.qobj.QasmQobjInstruction.from_dict") | Create a new QasmQobjInstruction object from a dictionary. | -| [`to_dict`](qiskit.qobj.QasmQobjInstruction.to_dict#qiskit.qobj.QasmQobjInstruction.to_dict "qiskit.qobj.QasmQobjInstruction.to_dict") | Return a dictionary format representation of the Instruction. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the experiment config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[QasmQobjInstruction](qiskit.qobj.QasmQobjInstruction "qiskit.qobj.QasmQobjInstruction") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the QasmQobjInstruction. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md b/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md index cd80b974b03..48fab3cc3e7 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.Qobj.md @@ -1,8 +1,16 @@ -# Qobj +--- +title: Qobj +description: API reference for qiskit.qobj.Qobj +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.Qobj +--- +# Qobj + -`Qobj(qobj_id=None, config=None, experiments=None, header=None)` +`Qobj(qobj_id=None, config=None, experiments=None, header=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/__init__.py "view source code") Bases: `qiskit.qobj.qasm_qobj.QasmQobj` @@ -12,7 +20,60 @@ Initialize a Qobj object. ## Methods -| | | -| ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.Qobj.from_dict#qiskit.qobj.Qobj.from_dict "qiskit.qobj.Qobj.from_dict") | Create a new QASMQobj object from a dictionary. | -| [`to_dict`](qiskit.qobj.Qobj.to_dict#qiskit.qobj.Qobj.to_dict "qiskit.qobj.Qobj.to_dict") | Return a dictionary format representation of the QASM Qobj. | +### from\_dict + + + +`classmethod Qobj.from_dict(data)` + +Create a new QASMQobj object from a dictionary. + +**Parameters** + +**data** (*dict*) – A dictionary representing the QasmQobj to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.Qobj#to_dict "qiskit.qobj.Qobj.to_dict"). + +**Returns** + +The QasmQobj from the input dictionary. + +**Return type** + +[QasmQobj](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj") + +### to\_dict + + + +`Qobj.to_dict(validate=False)` + +Return a dictionary format representation of the QASM Qobj. + +Note this dict is not in the json wire format expected by IBMQ and qobj specification because complex numbers are still of type complex. Also this may contain native numpy arrays. When serializing this output for use with IBMQ you can leverage a json encoder that converts these as expected. For example: + +```python +import json +import numpy + +class QobjEncoder(json.JSONEncoder): + def default(self, obj): + if isinstance(obj, numpy.ndarray): + return obj.tolist() + if isinstance(obj, complex): + return (obj.real, obj.imag) + return json.JSONEncoder.default(self, obj) + +json.dumps(qobj.to_dict(), cls=QobjEncoder) +``` + +**Parameters** + +**validate** (*bool*) – When set to true validate the output dictionary against the jsonschema for qobj spec. + +**Returns** + +A dictionary representation of the QasmQobj object + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md b/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md index d51c2af37bc..dfdb814e30a 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjExperimentHeader.md @@ -1,8 +1,16 @@ -# QobjExperimentHeader +--- +title: QobjExperimentHeader +description: API reference for qiskit.qobj.QobjExperimentHeader +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QobjExperimentHeader +--- +# QobjExperimentHeader + -`QobjExperimentHeader(**kwargs)` +`QobjExperimentHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjHeader` @@ -16,7 +24,39 @@ Instantiate a new Qobj dict field object. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.QobjExperimentHeader.from_dict#qiskit.qobj.QobjExperimentHeader.from_dict "qiskit.qobj.QobjExperimentHeader.from_dict") | Create a new QobjHeader object from a dictionary. | -| [`to_dict`](qiskit.qobj.QobjExperimentHeader.to_dict#qiskit.qobj.QobjExperimentHeader.to_dict "qiskit.qobj.QobjExperimentHeader.to_dict") | Return a dictionary format representation of the QASM Qobj. | +### from\_dict + + + +`classmethod QobjExperimentHeader.from_dict(data)` + +Create a new QobjHeader object from a dictionary. + +**Parameters** + +**data** (*dict*) – A dictionary representing the QobjHeader to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.QobjExperimentHeader#to_dict "qiskit.qobj.QobjExperimentHeader.to_dict"). + +**Returns** + +The QobjDictField from the input dictionary. + +**Return type** + +QobjDictFieldr + +### to\_dict + + + +`QobjExperimentHeader.to_dict()` + +Return a dictionary format representation of the QASM Qobj. + +**Returns** + +The dictionary form of the QobjHeader. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md b/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md index f62cd5a0536..0683e853895 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjHeader.md @@ -1,8 +1,16 @@ -# QobjHeader +--- +title: QobjHeader +description: API reference for qiskit.qobj.QobjHeader +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QobjHeader +--- +# QobjHeader + -`QobjHeader(**kwargs)` +`QobjHeader(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/common.py "view source code") Bases: `qiskit.qobj.common.QobjDictField` @@ -16,7 +24,39 @@ Instantiate a new Qobj dict field object. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.QobjHeader.from_dict#qiskit.qobj.QobjHeader.from_dict "qiskit.qobj.QobjHeader.from_dict") | Create a new QobjHeader object from a dictionary. | -| [`to_dict`](qiskit.qobj.QobjHeader.to_dict#qiskit.qobj.QobjHeader.to_dict "qiskit.qobj.QobjHeader.to_dict") | Return a dictionary format representation of the QASM Qobj. | +### from\_dict + + + +`classmethod QobjHeader.from_dict(data)` + +Create a new QobjHeader object from a dictionary. + +**Parameters** + +**data** (*dict*) – A dictionary representing the QobjHeader to create. It will be in the same format as output by [`to_dict()`](qiskit.qobj.QobjHeader#to_dict "qiskit.qobj.QobjHeader.to_dict"). + +**Returns** + +The QobjDictField from the input dictionary. + +**Return type** + +QobjDictFieldr + +### to\_dict + + + +`QobjHeader.to_dict()` + +Return a dictionary format representation of the QASM Qobj. + +**Returns** + +The dictionary form of the QobjHeader. + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md b/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md index 88cc0de91d9..8d2804fa7cf 100644 --- a/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md +++ b/docs/api/qiskit/0.32/qiskit.qobj.QobjMeasurementOption.md @@ -1,8 +1,16 @@ -# QobjMeasurementOption +--- +title: QobjMeasurementOption +description: API reference for qiskit.qobj.QobjMeasurementOption +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.qobj.QobjMeasurementOption +--- +# QobjMeasurementOption + -`QobjMeasurementOption(name, params=None)` +`QobjMeasurementOption(name, params=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/qobj/pulse_qobj.py "view source code") Bases: `object` @@ -17,7 +25,39 @@ Instantiate a new QobjMeasurementOption object. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`from_dict`](qiskit.qobj.QobjMeasurementOption.from_dict#qiskit.qobj.QobjMeasurementOption.from_dict "qiskit.qobj.QobjMeasurementOption.from_dict") | Create a new QobjMeasurementOption object from a dictionary. | -| [`to_dict`](qiskit.qobj.QobjMeasurementOption.to_dict#qiskit.qobj.QobjMeasurementOption.to_dict "qiskit.qobj.QobjMeasurementOption.to_dict") | Return a dict format representation of the QobjMeasurementOption. | +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary for the experiment config + +**Returns** + +The object from the input dictionary. + +**Return type** + +[QobjMeasurementOption](qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption") + +### to\_dict + + + +`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. + +**Returns** + +The dictionary form of the QasmMeasurementOption. + +**Return type** + +dict + 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 c647860d15d..5432eb9ed40 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.CNOTDihedral.md @@ -1,14 +1,22 @@ -# CNOTDihedral +--- +title: CNOTDihedral +description: API reference for qiskit.quantum_info.CNOTDihedral +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.CNOTDihedral +--- +# CNOTDihedral + -`CNOTDihedral(data=None, num_qubits=None, validate=True)` +`CNOTDihedral(data=None, num_qubits=None, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.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` An N-qubit operator from the CNOT-Dihedral group. -> The CNOT-Dihedral group is generated by the quantum gates, [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`TGate`](qiskit.circuit.library.TGate#qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), and [`XGate`](qiskit.circuit.library.XGate#qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). +> The CNOT-Dihedral group is generated by the quantum gates, [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), and [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"). > > **Representation** > @@ -43,9 +51,9 @@ An N-qubit operator from the CNOT-Dihedral group. **Circuit Conversion** -> CNOTDihedral operators can be initialized from circuits containing *only* the following gates: [`IGate`](qiskit.circuit.library.IGate#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"), [`XGate`](qiskit.circuit.library.XGate#qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), [`YGate`](qiskit.circuit.library.YGate#qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"), [`ZGate`](qiskit.circuit.library.ZGate#qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"), [`TGate`](qiskit.circuit.library.TGate#qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), [`TdgGate`](qiskit.circuit.library.TdgGate#qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate") [`SGate`](qiskit.circuit.library.SGate#qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"), [`SdgGate`](qiskit.circuit.library.SdgGate#qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"), [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`CZGate`](qiskit.circuit.library.CZGate#qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"), [`SwapGate`](qiskit.circuit.library.SwapGate#qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). They can be converted back into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), or [`Gate`](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate") object using the [`to_circuit()`](qiskit.quantum_info.CNOTDihedral.to_circuit#qiskit.quantum_info.CNOTDihedral.to_circuit "qiskit.quantum_info.CNOTDihedral.to_circuit") or `to_instruction()` methods respectively. Note that this decomposition is not necessarily optimal in terms of number of gates if the number of qubits is more than two. +> CNOTDihedral operators can be initialized from circuits containing *only* the following gates: [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"), [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"), [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"), [`TGate`](qiskit.circuit.library.TGate "qiskit.circuit.library.TGate"), [`TdgGate`](qiskit.circuit.library.TdgGate "qiskit.circuit.library.TdgGate") [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"), [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"), [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"), [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). They can be converted back into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), or [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object using the [`to_circuit()`](qiskit.quantum_info.CNOTDihedral#to_circuit "qiskit.quantum_info.CNOTDihedral.to_circuit") or `to_instruction()` methods respectively. Note that this decomposition is not necessarily optimal in terms of number of gates if the number of qubits is more than two. > -> CNOTDihedral operators can also be converted to [`Operator`](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") objects using the [`to_operator()`](qiskit.quantum_info.CNOTDihedral.to_operator#qiskit.quantum_info.CNOTDihedral.to_operator "qiskit.quantum_info.CNOTDihedral.to_operator") method. This is done via decomposing to a circuit, and then simulating the circuit as a unitary operator. +> CNOTDihedral operators can also be converted to [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") objects using the [`to_operator()`](qiskit.quantum_info.CNOTDihedral#to_operator "qiskit.quantum_info.CNOTDihedral.to_operator") method. This is done via decomposing to a circuit, and then simulating the circuit as a unitary operator. > > **References:** > @@ -56,7 +64,7 @@ Initialize a CNOTDihedral operator object. **Parameters** -* **data** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral#qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Instruction*](qiskit.circuit.Instruction#qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – Optional, operator to initialize. +* **data** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – Optional, operator to initialize. * **num\_qubits** (*int*) – Optional, initialize an empty CNOTDihedral operator. * **validate** (*bool*) – if True, validates the CNOTDihedral element. @@ -67,47 +75,273 @@ Initialize a CNOTDihedral operator object. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.CNOTDihedral.adjoint#qiskit.quantum_info.CNOTDihedral.adjoint "qiskit.quantum_info.CNOTDihedral.adjoint") | Return the adjoint of the Operator. | -| [`compose`](qiskit.quantum_info.CNOTDihedral.compose#qiskit.quantum_info.CNOTDihedral.compose "qiskit.quantum_info.CNOTDihedral.compose") | Return the operator composition with another CNOTDihedral. | -| [`conjugate`](qiskit.quantum_info.CNOTDihedral.conjugate#qiskit.quantum_info.CNOTDihedral.conjugate "qiskit.quantum_info.CNOTDihedral.conjugate") | Return the conjugate of the CNOTDihedral. | -| [`copy`](qiskit.quantum_info.CNOTDihedral.copy#qiskit.quantum_info.CNOTDihedral.copy "qiskit.quantum_info.CNOTDihedral.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.CNOTDihedral.dot#qiskit.quantum_info.CNOTDihedral.dot "qiskit.quantum_info.CNOTDihedral.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.CNOTDihedral.expand#qiskit.quantum_info.CNOTDihedral.expand "qiskit.quantum_info.CNOTDihedral.expand") | Return the reverse-order tensor product with another CNOTDihedral. | -| [`input_dims`](qiskit.quantum_info.CNOTDihedral.input_dims#qiskit.quantum_info.CNOTDihedral.input_dims "qiskit.quantum_info.CNOTDihedral.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`output_dims`](qiskit.quantum_info.CNOTDihedral.output_dims#qiskit.quantum_info.CNOTDihedral.output_dims "qiskit.quantum_info.CNOTDihedral.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.CNOTDihedral.power#qiskit.quantum_info.CNOTDihedral.power "qiskit.quantum_info.CNOTDihedral.power") | Return the compose of a operator with itself n times. | -| [`reshape`](qiskit.quantum_info.CNOTDihedral.reshape#qiskit.quantum_info.CNOTDihedral.reshape "qiskit.quantum_info.CNOTDihedral.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.CNOTDihedral.tensor#qiskit.quantum_info.CNOTDihedral.tensor "qiskit.quantum_info.CNOTDihedral.tensor") | Return the tensor product with another CNOTDihedral. | -| [`to_circuit`](qiskit.quantum_info.CNOTDihedral.to_circuit#qiskit.quantum_info.CNOTDihedral.to_circuit "qiskit.quantum_info.CNOTDihedral.to_circuit") | Return a QuantumCircuit implementing the CNOT-Dihedral element. | -| [`to_instruction`](qiskit.quantum_info.CNOTDihedral.to_instruction#qiskit.quantum_info.CNOTDihedral.to_instruction "qiskit.quantum_info.CNOTDihedral.to_instruction") | Return a Gate instruction implementing the CNOTDihedral object. | -| [`to_matrix`](qiskit.quantum_info.CNOTDihedral.to_matrix#qiskit.quantum_info.CNOTDihedral.to_matrix "qiskit.quantum_info.CNOTDihedral.to_matrix") | Convert operator to Numpy matrix. | -| [`to_operator`](qiskit.quantum_info.CNOTDihedral.to_operator#qiskit.quantum_info.CNOTDihedral.to_operator "qiskit.quantum_info.CNOTDihedral.to_operator") | Convert to an Operator object. | -| [`transpose`](qiskit.quantum_info.CNOTDihedral.transpose#qiskit.quantum_info.CNOTDihedral.transpose "qiskit.quantum_info.CNOTDihedral.transpose") | Return the transpose of the CNOTDihedral. | +### adjoint -## Attributes + + +`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. + +### compose + + + +`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. + +**Parameters** + +* **other** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")) – a CNOTDihedral object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed CNOTDihedral. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.CNOTDihedral#dot "qiskit.quantum_info.CNOTDihedral.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.CNOTDihedral#dot "qiskit.quantum_info.CNOTDihedral.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + +### copy + + + +`CNOTDihedral.copy()` + +Make a deep copy of current operator. + +### dot + + + +`CNOTDihedral.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")) – a CNOTDihedral object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current CNOTDihedral, and $b$ is the other CNOTDihedral. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + +### input\_dims + + + +`CNOTDihedral.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### output\_dims + + + +`CNOTDihedral.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`CNOTDihedral.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** +**n** (*int*) – the number of times to compose with self (n>0). +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### reshape + + + +`CNOTDihedral.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*CNOTDihedral*](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")) – a CNOTDihedral object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current CNOTDihedral, and $b$ is the other CNOTDihedral. + +**Return type** + +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_circuit + + + +`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. + +**Returns** + +a circuit implementation of the CNOTDihedral object. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +#### References + +1. Shelly Garion and Andrew W. Cross, *Synthesis of CNOT-Dihedral circuits with optimal number of two qubit gates*, [Quantum 4(369), 2020](https://quantum-journal.org/papers/q-2020-12-07-369/) +2. Andrew W. Cross, Easwar Magesan, Lev S. Bishop, John A. Smolin and Jay M. Gambetta, *Scalable randomised benchmarking of non-Clifford gates*, npj Quantum Inf 2, 16012 (2016). + +### to\_instruction + + + +`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. + +### to\_matrix + + + +`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. + +### to\_operator + + + +`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. + +### transpose + + + +`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. + +## Attributes + + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### settings Return operator settings. + 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 4d0f6fc140e..8a384da9ea3 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Chi.md @@ -1,20 +1,28 @@ -# Chi +--- +title: Chi +description: API reference for qiskit.quantum_info.Chi +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Chi +--- +# Chi + -`Chi(data, input_dims=None, output_dims=None)` +`Chi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/chi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli basis Chi-matrix representation of a quantum channel. -The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by +The Chi-matrix representation of an $n$-qubit quantum channel $\mathcal{E}$ is a matrix $\chi$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by $$ \mathcal{E}(ρ) = \sum_{i, j} \chi_{i,j} P_i ρ P_j $$ -where $[P_0, P_1, ..., P_{4^{n}-1}]$ is the $n$-qubit Pauli basis in lexicographic order. It is related to the [`Choi`](qiskit.quantum_info.Choi#qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") representation by a change of basis of the Choi-matrix into the Pauli basis. +where $[P_0, P_1, ..., P_{4^{n}-1}]$ is the $n$-qubit Pauli basis in lexicographic order. It is related to the [`Choi`](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") representation by a change of basis of the Choi-matrix into the Pauli basis. See reference \[1] for further details. @@ -40,67 +48,324 @@ If the input or output dimensions are None, they will be automatically determine ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.Chi.adjoint#qiskit.quantum_info.Chi.adjoint "qiskit.quantum_info.Chi.adjoint") | Return the adjoint quantum channel. | -| [`compose`](qiskit.quantum_info.Chi.compose#qiskit.quantum_info.Chi.compose "qiskit.quantum_info.Chi.compose") | Return the operator composition with another Chi. | -| [`conjugate`](qiskit.quantum_info.Chi.conjugate#qiskit.quantum_info.Chi.conjugate "qiskit.quantum_info.Chi.conjugate") | Return the conjugate quantum channel. | -| [`copy`](qiskit.quantum_info.Chi.copy#qiskit.quantum_info.Chi.copy "qiskit.quantum_info.Chi.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.Chi.dot#qiskit.quantum_info.Chi.dot "qiskit.quantum_info.Chi.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.Chi.expand#qiskit.quantum_info.Chi.expand "qiskit.quantum_info.Chi.expand") | Return the reverse-order tensor product with another Chi. | -| [`input_dims`](qiskit.quantum_info.Chi.input_dims#qiskit.quantum_info.Chi.input_dims "qiskit.quantum_info.Chi.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_cp`](qiskit.quantum_info.Chi.is_cp#qiskit.quantum_info.Chi.is_cp "qiskit.quantum_info.Chi.is_cp") | Test if Choi-matrix is completely-positive (CP) | -| [`is_cptp`](qiskit.quantum_info.Chi.is_cptp#qiskit.quantum_info.Chi.is_cptp "qiskit.quantum_info.Chi.is_cptp") | Return True if completely-positive trace-preserving (CPTP). | -| [`is_tp`](qiskit.quantum_info.Chi.is_tp#qiskit.quantum_info.Chi.is_tp "qiskit.quantum_info.Chi.is_tp") | Test if a channel is trace-preserving (TP) | -| [`is_unitary`](qiskit.quantum_info.Chi.is_unitary#qiskit.quantum_info.Chi.is_unitary "qiskit.quantum_info.Chi.is_unitary") | Return True if QuantumChannel is a unitary channel. | -| [`output_dims`](qiskit.quantum_info.Chi.output_dims#qiskit.quantum_info.Chi.output_dims "qiskit.quantum_info.Chi.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.Chi.power#qiskit.quantum_info.Chi.power "qiskit.quantum_info.Chi.power") | Return the power of the quantum channel. | -| [`reshape`](qiskit.quantum_info.Chi.reshape#qiskit.quantum_info.Chi.reshape "qiskit.quantum_info.Chi.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.Chi.tensor#qiskit.quantum_info.Chi.tensor "qiskit.quantum_info.Chi.tensor") | Return the tensor product with another Chi. | -| [`to_instruction`](qiskit.quantum_info.Chi.to_instruction#qiskit.quantum_info.Chi.to_instruction "qiskit.quantum_info.Chi.to_instruction") | Convert to a Kraus or UnitaryGate circuit instruction. | -| [`to_operator`](qiskit.quantum_info.Chi.to_operator#qiskit.quantum_info.Chi.to_operator "qiskit.quantum_info.Chi.to_operator") | Try to convert channel to a unitary representation Operator. | -| [`transpose`](qiskit.quantum_info.Chi.transpose#qiskit.quantum_info.Chi.transpose "qiskit.quantum_info.Chi.transpose") | Return the transpose quantum channel. | +### adjoint -## Attributes + + +`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. + + + This is equivalent to the matrix Hermitian conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the adjoint channel $\mathcal{{E}}^\dagger$ is $S_{\mathcal{E}^\dagger} = S_{\mathcal{E}}^\dagger$. + + +### compose + + + +`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. + +**Parameters** + +* **other** ([*Chi*](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")) – a Chi object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed Chi. + +**Return type** + +[Chi](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.Chi#dot "qiskit.quantum_info.Chi.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.Chi#dot "qiskit.quantum_info.Chi.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + + + This is equivalent to the matrix complex conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the conjugate channel $\overline{{\mathcal{{E}}}}$ is $S_{\overline{\mathcal{E}^\dagger}} = \overline{S_{\mathcal{E}}}$. + + +### copy + + + +`Chi.copy()` + +Make a deep copy of current operator. + +### dot + + + +`Chi.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*Chi*](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")) – a Chi object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current Chi, and $b$ is the other Chi. + +**Return type** + +[Chi](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi") + +### input\_dims + + + +`Chi.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_cp + + + +`Chi.is_cp(atol=None, rtol=None)` + +Test if Choi-matrix is completely-positive (CP) + +### is\_cptp + + + +`Chi.is_cptp(atol=None, rtol=None)` + +Return True if completely-positive trace-preserving (CPTP). + +### is\_tp + + + +`Chi.is_tp(atol=None, rtol=None)` + +Test if a channel is trace-preserving (TP) + +### is\_unitary + + + +`Chi.is_unitary(atol=None, rtol=None)` + +Return True if QuantumChannel is a unitary channel. + +### output\_dims + +`Chi.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`Chi.power(n)` + +Return the power of the quantum channel. + +**Parameters** + +**n** (*float*) – the power exponent. + +**Returns** + +the channel $\mathcal{{E}} ^n$. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +**Raises** + +**QiskitError** – if the input and output dimensions of the SuperOp are not equal. + + + For non-positive or non-integer exponents the power is defined as the matrix power of the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{{E}}$, the SuperOp of the powered channel $\mathcal{{E}}^\n$ is $S_{{\mathcal{{E}}^n}} = S_{{\mathcal{{E}}}}^n$. + + +### reshape + + + +`Chi.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Chi*](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")) – a Chi object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current Chi, and $b$ is the other Chi. + +**Return type** + +[Chi](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`Chi.to_instruction()` + +Convert to a Kraus or UnitaryGate circuit instruction. + +If the channel is unitary it will be added as a unitary gate, otherwise it will be added as a kraus simulator instruction. + +**Returns** + +A kraus instruction for the channel. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**QiskitError** – if input data is not an N-qubit CPTP quantum channel. + +### to\_operator + + + +`Chi.to_operator()` + +Try to convert channel to a unitary representation Operator. + +### transpose + + + +`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. + + + This is equivalent to the matrix transpose in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation, ie. for a channel $\mathcal{E}$, the SuperOp of the transpose channel $\mathcal{{E}}^T$ is $S_{mathcal{E}^T} = S_{\mathcal{E}}^T$. + + +## Attributes + + ### atol `= 1e-08` - + ### data Return data. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 808ba137eb4..7e530295f80 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Choi.md @@ -1,8 +1,16 @@ -# Choi +--- +title: Choi +description: API reference for qiskit.quantum_info.Choi +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Choi +--- +# Choi + -`Choi(data, input_dims=None, output_dims=None)` +`Choi(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/choi.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` @@ -15,14 +23,14 @@ $$ \mathcal{E}\left(|i\rangle\!\langle j|\right) $$ -Evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ with respect to the Choi-matrix is given by +Evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ with respect to the Choi-matrix is given by $$ \mathcal{E}(\rho) = \mbox{Tr}_{1}\left[\Lambda (\rho^T \otimes \mathbb{I})\right] $$ -where $\mbox{Tr}_1$ is the [`partial_trace()`](qiskit.quantum_info.partial_trace#qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace") over subsystem 1. +where $\mbox{Tr}_1$ is the [`partial_trace()`](qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace") over subsystem 1. See reference \[1] for further details. @@ -48,67 +56,324 @@ If the input or output dimensions are None, they will be automatically determine ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.Choi.adjoint#qiskit.quantum_info.Choi.adjoint "qiskit.quantum_info.Choi.adjoint") | Return the adjoint quantum channel. | -| [`compose`](qiskit.quantum_info.Choi.compose#qiskit.quantum_info.Choi.compose "qiskit.quantum_info.Choi.compose") | Return the operator composition with another Choi. | -| [`conjugate`](qiskit.quantum_info.Choi.conjugate#qiskit.quantum_info.Choi.conjugate "qiskit.quantum_info.Choi.conjugate") | Return the conjugate quantum channel. | -| [`copy`](qiskit.quantum_info.Choi.copy#qiskit.quantum_info.Choi.copy "qiskit.quantum_info.Choi.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.Choi.dot#qiskit.quantum_info.Choi.dot "qiskit.quantum_info.Choi.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.Choi.expand#qiskit.quantum_info.Choi.expand "qiskit.quantum_info.Choi.expand") | Return the reverse-order tensor product with another Choi. | -| [`input_dims`](qiskit.quantum_info.Choi.input_dims#qiskit.quantum_info.Choi.input_dims "qiskit.quantum_info.Choi.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_cp`](qiskit.quantum_info.Choi.is_cp#qiskit.quantum_info.Choi.is_cp "qiskit.quantum_info.Choi.is_cp") | Test if Choi-matrix is completely-positive (CP) | -| [`is_cptp`](qiskit.quantum_info.Choi.is_cptp#qiskit.quantum_info.Choi.is_cptp "qiskit.quantum_info.Choi.is_cptp") | Return True if completely-positive trace-preserving (CPTP). | -| [`is_tp`](qiskit.quantum_info.Choi.is_tp#qiskit.quantum_info.Choi.is_tp "qiskit.quantum_info.Choi.is_tp") | Test if a channel is trace-preserving (TP) | -| [`is_unitary`](qiskit.quantum_info.Choi.is_unitary#qiskit.quantum_info.Choi.is_unitary "qiskit.quantum_info.Choi.is_unitary") | Return True if QuantumChannel is a unitary channel. | -| [`output_dims`](qiskit.quantum_info.Choi.output_dims#qiskit.quantum_info.Choi.output_dims "qiskit.quantum_info.Choi.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.Choi.power#qiskit.quantum_info.Choi.power "qiskit.quantum_info.Choi.power") | Return the power of the quantum channel. | -| [`reshape`](qiskit.quantum_info.Choi.reshape#qiskit.quantum_info.Choi.reshape "qiskit.quantum_info.Choi.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.Choi.tensor#qiskit.quantum_info.Choi.tensor "qiskit.quantum_info.Choi.tensor") | Return the tensor product with another Choi. | -| [`to_instruction`](qiskit.quantum_info.Choi.to_instruction#qiskit.quantum_info.Choi.to_instruction "qiskit.quantum_info.Choi.to_instruction") | Convert to a Kraus or UnitaryGate circuit instruction. | -| [`to_operator`](qiskit.quantum_info.Choi.to_operator#qiskit.quantum_info.Choi.to_operator "qiskit.quantum_info.Choi.to_operator") | Try to convert channel to a unitary representation Operator. | -| [`transpose`](qiskit.quantum_info.Choi.transpose#qiskit.quantum_info.Choi.transpose "qiskit.quantum_info.Choi.transpose") | Return the transpose quantum channel. | +### adjoint -## Attributes + + +`Choi.adjoint()` + +Return the adjoint quantum channel. + + + This is equivalent to the matrix Hermitian conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the adjoint channel $\mathcal{{E}}^\dagger$ is $S_{\mathcal{E}^\dagger} = S_{\mathcal{E}}^\dagger$. + + +### compose + + + +`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. + +**Parameters** + +* **other** ([*Choi*](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")) – a Choi object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed Choi. + +**Return type** + +[Choi](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.Choi#dot "qiskit.quantum_info.Choi.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.Choi#dot "qiskit.quantum_info.Choi.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + + + This is equivalent to the matrix complex conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the conjugate channel $\overline{{\mathcal{{E}}}}$ is $S_{\overline{\mathcal{E}^\dagger}} = \overline{S_{\mathcal{E}}}$. + + +### copy + + + +`Choi.copy()` + +Make a deep copy of current operator. + +### dot + + + +`Choi.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*Choi*](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")) – a Choi object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current Choi, and $b$ is the other Choi. + +**Return type** + +[Choi](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") + +### input\_dims + + + +`Choi.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_cp + + + +`Choi.is_cp(atol=None, rtol=None)` + +Test if Choi-matrix is completely-positive (CP) + +### is\_cptp + + + +`Choi.is_cptp(atol=None, rtol=None)` + +Return True if completely-positive trace-preserving (CPTP). + +### is\_tp + + + +`Choi.is_tp(atol=None, rtol=None)` + +Test if a channel is trace-preserving (TP) + +### is\_unitary + + + +`Choi.is_unitary(atol=None, rtol=None)` + +Return True if QuantumChannel is a unitary channel. + +### output\_dims + +`Choi.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`Choi.power(n)` + +Return the power of the quantum channel. + +**Parameters** + +**n** (*float*) – the power exponent. + +**Returns** + +the channel $\mathcal{{E}} ^n$. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +**Raises** + +**QiskitError** – if the input and output dimensions of the SuperOp are not equal. + + + For non-positive or non-integer exponents the power is defined as the matrix power of the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{{E}}$, the SuperOp of the powered channel $\mathcal{{E}}^\n$ is $S_{{\mathcal{{E}}^n}} = S_{{\mathcal{{E}}}}^n$. + + +### reshape + + + +`Choi.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Choi*](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")) – a Choi object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current Choi, and $b$ is the other Choi. + +**Return type** + +[Choi](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`Choi.to_instruction()` + +Convert to a Kraus or UnitaryGate circuit instruction. + +If the channel is unitary it will be added as a unitary gate, otherwise it will be added as a kraus simulator instruction. + +**Returns** + +A kraus instruction for the channel. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**QiskitError** – if input data is not an N-qubit CPTP quantum channel. + +### to\_operator + + + +`Choi.to_operator()` + +Try to convert channel to a unitary representation Operator. + +### transpose + + + +`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. + + + This is equivalent to the matrix transpose in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation, ie. for a channel $\mathcal{E}$, the SuperOp of the transpose channel $\mathcal{{E}}^T$ is $S_{mathcal{E}^T} = S_{\mathcal{E}}^T$. + + +## Attributes + + ### atol `= 1e-08` - + ### data Return data. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 558e394be9b..445334243ff 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Clifford.md @@ -1,8 +1,16 @@ -# Clifford +--- +title: Clifford +description: API reference for qiskit.quantum_info.Clifford +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Clifford +--- +# Clifford + -`Clifford(data, validate=True)` +`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` @@ -10,14 +18,14 @@ An N-qubit unitary operator from the Clifford group. **Representation** -An *N*-qubit Clifford operator is stored as a length *2N* [`StabilizerTable`](qiskit.quantum_info.StabilizerTable#qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") using the convention from reference \[1]. +An *N*-qubit Clifford operator is stored as a length *2N* [`StabilizerTable`](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") using the convention from reference \[1]. * Rows 0 to *N-1* are the *destabilizer* group generators * Rows *N* to *2N-1* are the *stabilizer* group generators. -The internal [`StabilizerTable`](qiskit.quantum_info.StabilizerTable#qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") for the Clifford can be accessed using the [`table`](#qiskit.quantum_info.Clifford.table "qiskit.quantum_info.Clifford.table") attribute. The destabilizer or stabilizer rows can each be accessed as a length-N Stabilizer table using [`destabilizer`](#qiskit.quantum_info.Clifford.destabilizer "qiskit.quantum_info.Clifford.destabilizer") and [`stabilizer`](#qiskit.quantum_info.Clifford.stabilizer "qiskit.quantum_info.Clifford.stabilizer") attributes. +The internal [`StabilizerTable`](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") for the Clifford can be accessed using the [`table`](#qiskit.quantum_info.Clifford.table "qiskit.quantum_info.Clifford.table") attribute. The destabilizer or stabilizer rows can each be accessed as a length-N Stabilizer table using [`destabilizer`](#qiskit.quantum_info.Clifford.destabilizer "qiskit.quantum_info.Clifford.destabilizer") and [`stabilizer`](#qiskit.quantum_info.Clifford.stabilizer "qiskit.quantum_info.Clifford.stabilizer") attributes. -A more easily human readable representation of the Clifford operator can be obtained by calling the [`to_dict()`](qiskit.quantum_info.Clifford.to_dict#qiskit.quantum_info.Clifford.to_dict "qiskit.quantum_info.Clifford.to_dict") method. This representation is also used if a Clifford object is printed as in the following example +A more easily human readable representation of the Clifford operator can be obtained by calling the [`to_dict()`](qiskit.quantum_info.Clifford#to_dict "qiskit.quantum_info.Clifford.to_dict") method. This representation is also used if a Clifford object is printed as in the following example ```python from qiskit import QuantumCircuit @@ -47,13 +55,13 @@ StabilizerTable: ['+XX', '+ZZ'] **Circuit Conversion** -Clifford operators can be initialized from circuits containing *only* the following Clifford gates: [`IGate`](qiskit.circuit.library.IGate#qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"), [`XGate`](qiskit.circuit.library.XGate#qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), [`YGate`](qiskit.circuit.library.YGate#qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"), [`ZGate`](qiskit.circuit.library.ZGate#qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"), [`HGate`](qiskit.circuit.library.HGate#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"), [`SGate`](qiskit.circuit.library.SGate#qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"), [`SdgGate`](qiskit.circuit.library.SdgGate#qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"), [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`CZGate`](qiskit.circuit.library.CZGate#qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"), [`SwapGate`](qiskit.circuit.library.SwapGate#qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). They can be converted back into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), or [`Gate`](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate") object using the [`to_circuit()`](qiskit.quantum_info.Clifford.to_circuit#qiskit.quantum_info.Clifford.to_circuit "qiskit.quantum_info.Clifford.to_circuit") or [`to_instruction()`](qiskit.quantum_info.Clifford.to_instruction#qiskit.quantum_info.Clifford.to_instruction "qiskit.quantum_info.Clifford.to_instruction") methods respectively. Note that this decomposition is not necessarily optimal in terms of number of gates. +Clifford operators can be initialized from circuits containing *only* the following Clifford gates: [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate"), [`XGate`](qiskit.circuit.library.XGate "qiskit.circuit.library.XGate"), [`YGate`](qiskit.circuit.library.YGate "qiskit.circuit.library.YGate"), [`ZGate`](qiskit.circuit.library.ZGate "qiskit.circuit.library.ZGate"), [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate"), [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate"), [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate"), [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate"), [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate"), [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate"). They can be converted back into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit"), or [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate") object using the [`to_circuit()`](qiskit.quantum_info.Clifford#to_circuit "qiskit.quantum_info.Clifford.to_circuit") or [`to_instruction()`](qiskit.quantum_info.Clifford#to_instruction "qiskit.quantum_info.Clifford.to_instruction") methods respectively. Note that this decomposition is not necessarily optimal in terms of number of gates. - A minimally generating set of gates for Clifford circuits is the [`HGate`](qiskit.circuit.library.HGate#qiskit.circuit.library.HGate "qiskit.circuit.library.HGate") and [`SGate`](qiskit.circuit.library.SGate#qiskit.circuit.library.SGate "qiskit.circuit.library.SGate") gate and *either* the [`CXGate`](qiskit.circuit.library.CXGate#qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") or [`CZGate`](qiskit.circuit.library.CZGate#qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate") two-qubit gate. + A minimally generating set of gates for Clifford circuits is the [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate") and [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate") gate and *either* the [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate") or [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate") two-qubit gate. -Clifford operators can also be converted to [`Operator`](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") objects using the [`to_operator()`](qiskit.quantum_info.Clifford.to_operator#qiskit.quantum_info.Clifford.to_operator "qiskit.quantum_info.Clifford.to_operator") method. This is done via decomposing to a circuit, and then simulating the circuit as a unitary operator. +Clifford operators can also be converted to [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") objects using the [`to_operator()`](qiskit.quantum_info.Clifford#to_operator "qiskit.quantum_info.Clifford.to_operator") method. This is done via decomposing to a circuit, and then simulating the circuit as a unitary operator. ## References @@ -63,70 +71,391 @@ Initialize an operator object. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.Clifford.adjoint#qiskit.quantum_info.Clifford.adjoint "qiskit.quantum_info.Clifford.adjoint") | Return the adjoint of the Operator. | -| [`compose`](qiskit.quantum_info.Clifford.compose#qiskit.quantum_info.Clifford.compose "qiskit.quantum_info.Clifford.compose") | Return the operator composition with another Clifford. | -| [`conjugate`](qiskit.quantum_info.Clifford.conjugate#qiskit.quantum_info.Clifford.conjugate "qiskit.quantum_info.Clifford.conjugate") | Return the conjugate of the Clifford. | -| [`copy`](qiskit.quantum_info.Clifford.copy#qiskit.quantum_info.Clifford.copy "qiskit.quantum_info.Clifford.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.Clifford.dot#qiskit.quantum_info.Clifford.dot "qiskit.quantum_info.Clifford.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.Clifford.expand#qiskit.quantum_info.Clifford.expand "qiskit.quantum_info.Clifford.expand") | Return the reverse-order tensor product with another Clifford. | -| [`from_circuit`](qiskit.quantum_info.Clifford.from_circuit#qiskit.quantum_info.Clifford.from_circuit "qiskit.quantum_info.Clifford.from_circuit") | Initialize from a QuantumCircuit or Instruction. | -| [`from_dict`](qiskit.quantum_info.Clifford.from_dict#qiskit.quantum_info.Clifford.from_dict "qiskit.quantum_info.Clifford.from_dict") | Load a Clifford from a dictionary | -| [`from_label`](qiskit.quantum_info.Clifford.from_label#qiskit.quantum_info.Clifford.from_label "qiskit.quantum_info.Clifford.from_label") | Return a tensor product of single-qubit Clifford gates. | -| [`input_dims`](qiskit.quantum_info.Clifford.input_dims#qiskit.quantum_info.Clifford.input_dims "qiskit.quantum_info.Clifford.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_unitary`](qiskit.quantum_info.Clifford.is_unitary#qiskit.quantum_info.Clifford.is_unitary "qiskit.quantum_info.Clifford.is_unitary") | Return True if the Clifford table is valid. | -| [`output_dims`](qiskit.quantum_info.Clifford.output_dims#qiskit.quantum_info.Clifford.output_dims "qiskit.quantum_info.Clifford.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.Clifford.power#qiskit.quantum_info.Clifford.power "qiskit.quantum_info.Clifford.power") | Return the compose of a operator with itself n times. | -| [`reshape`](qiskit.quantum_info.Clifford.reshape#qiskit.quantum_info.Clifford.reshape "qiskit.quantum_info.Clifford.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.Clifford.tensor#qiskit.quantum_info.Clifford.tensor "qiskit.quantum_info.Clifford.tensor") | Return the tensor product with another Clifford. | -| [`to_circuit`](qiskit.quantum_info.Clifford.to_circuit#qiskit.quantum_info.Clifford.to_circuit "qiskit.quantum_info.Clifford.to_circuit") | Return a QuantumCircuit implementing the Clifford. | -| [`to_dict`](qiskit.quantum_info.Clifford.to_dict#qiskit.quantum_info.Clifford.to_dict "qiskit.quantum_info.Clifford.to_dict") | Return dictionary representation of Clifford object. | -| [`to_instruction`](qiskit.quantum_info.Clifford.to_instruction#qiskit.quantum_info.Clifford.to_instruction "qiskit.quantum_info.Clifford.to_instruction") | Return a Gate instruction implementing the Clifford. | -| [`to_matrix`](qiskit.quantum_info.Clifford.to_matrix#qiskit.quantum_info.Clifford.to_matrix "qiskit.quantum_info.Clifford.to_matrix") | Convert operator to Numpy matrix. | -| [`to_operator`](qiskit.quantum_info.Clifford.to_operator#qiskit.quantum_info.Clifford.to_operator "qiskit.quantum_info.Clifford.to_operator") | Convert to an Operator object. | -| [`transpose`](qiskit.quantum_info.Clifford.transpose#qiskit.quantum_info.Clifford.transpose "qiskit.quantum_info.Clifford.transpose") | Return the transpose of the Clifford. | +### adjoint -## Attributes + + +`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. + +### compose + + + +`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. + +**Parameters** + +* **other** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – a Clifford object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed Clifford. + +**Return type** + +[Clifford](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.Clifford#dot "qiskit.quantum_info.Clifford.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.Clifford#dot "qiskit.quantum_info.Clifford.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + +### copy + + + +`Clifford.copy()` + +Make a deep copy of current operator. + +### dot + + + +`Clifford.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – a Clifford object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current Clifford, and $b$ is the other Clifford. + +**Return type** + +[Clifford](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") + +### from\_circuit + + + +`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. + +**Parameters** + +**circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – instruction to initialize. + +**Returns** + +the Clifford object for the instruction. + +**Return type** + +[Clifford](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") + +**Raises** + +**QiskitError** – if the input instruction is non-Clifford or contains classical register instruction. + +### from\_dict + + + +`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 + +### from\_label + + + +`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. + +**Parameters** + +**label** (*string*) – single-qubit operator string. + +**Returns** + +The N-qubit Clifford operator. + +**Return type** + +[Clifford](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") + +**Raises** + +**QiskitError** – if the label contains invalid characters. + +#### Additional Information: + +The labels correspond to the single-qubit Cliffords are + +* * Label + * Stabilizer + * Destabilizer +* * `"I"` + * +Z + * +X +* * `"X"` + * -Z + * +X +* * `"Y"` + * -Z + * -X +* * `"Z"` + * +Z + * -X +* * `"H"` + * +X + * +Z +* * `"S"` + * +Z + * +Y + +### input\_dims + + + +`Clifford.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. +### is\_unitary + + +`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. + +### output\_dims + + + +`Clifford.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`Clifford.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### reshape + + + +`Clifford.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – a Clifford object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current Clifford, and $b$ is the other Clifford. + +**Return type** + +[Clifford](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_circuit + + + +`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. + +For N \<= 3 qubits this is based on optimal CX cost decomposition from reference \[1]. For N > 3 qubits this is done using the general non-optimal compilation routine from reference \[2]. + +**Returns** + +a circuit implementation of the Clifford. + +**Return type** + +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") + +#### References + +1. S. Bravyi, D. Maslov, *Hadamard-free circuits expose the structure of the Clifford group*, [arXiv:2003.09412 \[quant-ph\]](https://arxiv.org/abs/2003.09412) +2. S. Aaronson, D. Gottesman, *Improved Simulation of Stabilizer Circuits*, Phys. Rev. A 70, 052328 (2004). [arXiv:quant-ph/0406196](https://arxiv.org/abs/quant-ph/0406196) + +### to\_dict + + + +`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. + +### to\_instruction + + + +`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. + +### to\_matrix + + + +`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. + +### to\_operator + + + +`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. + +### transpose + + + +`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. + +## Attributes + + ### destabilizer Return the destabilizer block of the StabilizerTable. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### settings Return operator settings. - + ### stabilizer Return the stabilizer block of the StabilizerTable. - + ### table Return StabilizerTable + 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 7876fffe246..f4115dc5e5b 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.DensityMatrix.md @@ -1,8 +1,16 @@ -# DensityMatrix +--- +title: DensityMatrix +description: API reference for qiskit.quantum_info.DensityMatrix +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.DensityMatrix +--- +# DensityMatrix + -`DensityMatrix(data, dims=None)` +`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` @@ -28,62 +36,633 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [`conjugate`](qiskit.quantum_info.DensityMatrix.conjugate#qiskit.quantum_info.DensityMatrix.conjugate "qiskit.quantum_info.DensityMatrix.conjugate") | Return the conjugate of the density matrix. | -| [`copy`](qiskit.quantum_info.DensityMatrix.copy#qiskit.quantum_info.DensityMatrix.copy "qiskit.quantum_info.DensityMatrix.copy") | Make a copy of current operator. | -| [`dims`](qiskit.quantum_info.DensityMatrix.dims#qiskit.quantum_info.DensityMatrix.dims "qiskit.quantum_info.DensityMatrix.dims") | Return tuple of input dimension for specified subsystems. | -| [`draw`](qiskit.quantum_info.DensityMatrix.draw#qiskit.quantum_info.DensityMatrix.draw "qiskit.quantum_info.DensityMatrix.draw") | Return a visualization of the Statevector. | -| [`evolve`](qiskit.quantum_info.DensityMatrix.evolve#qiskit.quantum_info.DensityMatrix.evolve "qiskit.quantum_info.DensityMatrix.evolve") | Evolve a quantum state by an operator. | -| [`expand`](qiskit.quantum_info.DensityMatrix.expand#qiskit.quantum_info.DensityMatrix.expand "qiskit.quantum_info.DensityMatrix.expand") | Return the tensor product state other ⊗ self. | -| [`expectation_value`](qiskit.quantum_info.DensityMatrix.expectation_value#qiskit.quantum_info.DensityMatrix.expectation_value "qiskit.quantum_info.DensityMatrix.expectation_value") | Compute the expectation value of an operator. | -| [`from_instruction`](qiskit.quantum_info.DensityMatrix.from_instruction#qiskit.quantum_info.DensityMatrix.from_instruction "qiskit.quantum_info.DensityMatrix.from_instruction") | Return the output density matrix of an instruction. | -| [`from_int`](qiskit.quantum_info.DensityMatrix.from_int#qiskit.quantum_info.DensityMatrix.from_int "qiskit.quantum_info.DensityMatrix.from_int") | Return a computational basis state density matrix. | -| [`from_label`](qiskit.quantum_info.DensityMatrix.from_label#qiskit.quantum_info.DensityMatrix.from_label "qiskit.quantum_info.DensityMatrix.from_label") | Return a tensor product of Pauli X,Y,Z eigenstates. | -| [`is_valid`](qiskit.quantum_info.DensityMatrix.is_valid#qiskit.quantum_info.DensityMatrix.is_valid "qiskit.quantum_info.DensityMatrix.is_valid") | Return True if trace 1 and positive semidefinite. | -| [`measure`](qiskit.quantum_info.DensityMatrix.measure#qiskit.quantum_info.DensityMatrix.measure "qiskit.quantum_info.DensityMatrix.measure") | Measure subsystems and return outcome and post-measure state. | -| [`probabilities`](qiskit.quantum_info.DensityMatrix.probabilities#qiskit.quantum_info.DensityMatrix.probabilities "qiskit.quantum_info.DensityMatrix.probabilities") | Return the subsystem measurement probability vector. | -| [`probabilities_dict`](qiskit.quantum_info.DensityMatrix.probabilities_dict#qiskit.quantum_info.DensityMatrix.probabilities_dict "qiskit.quantum_info.DensityMatrix.probabilities_dict") | Return the subsystem measurement probability dictionary. | -| [`purity`](qiskit.quantum_info.DensityMatrix.purity#qiskit.quantum_info.DensityMatrix.purity "qiskit.quantum_info.DensityMatrix.purity") | Return the purity of the quantum state. | -| [`reset`](qiskit.quantum_info.DensityMatrix.reset#qiskit.quantum_info.DensityMatrix.reset "qiskit.quantum_info.DensityMatrix.reset") | Reset state or subsystems to the 0-state. | -| [`reverse_qargs`](qiskit.quantum_info.DensityMatrix.reverse_qargs#qiskit.quantum_info.DensityMatrix.reverse_qargs "qiskit.quantum_info.DensityMatrix.reverse_qargs") | Return a DensityMatrix with reversed subsystem ordering. | -| [`sample_counts`](qiskit.quantum_info.DensityMatrix.sample_counts#qiskit.quantum_info.DensityMatrix.sample_counts "qiskit.quantum_info.DensityMatrix.sample_counts") | Sample a dict of qubit measurement outcomes in the computational basis. | -| [`sample_memory`](qiskit.quantum_info.DensityMatrix.sample_memory#qiskit.quantum_info.DensityMatrix.sample_memory "qiskit.quantum_info.DensityMatrix.sample_memory") | Sample a list of qubit measurement outcomes in the computational basis. | -| [`seed`](qiskit.quantum_info.DensityMatrix.seed#qiskit.quantum_info.DensityMatrix.seed "qiskit.quantum_info.DensityMatrix.seed") | Set the seed for the quantum state RNG. | -| [`tensor`](qiskit.quantum_info.DensityMatrix.tensor#qiskit.quantum_info.DensityMatrix.tensor "qiskit.quantum_info.DensityMatrix.tensor") | Return the tensor product state self ⊗ other. | -| [`to_dict`](qiskit.quantum_info.DensityMatrix.to_dict#qiskit.quantum_info.DensityMatrix.to_dict "qiskit.quantum_info.DensityMatrix.to_dict") | Convert the density matrix to dictionary form. | -| [`to_operator`](qiskit.quantum_info.DensityMatrix.to_operator#qiskit.quantum_info.DensityMatrix.to_operator "qiskit.quantum_info.DensityMatrix.to_operator") | Convert to Operator | -| [`to_statevector`](qiskit.quantum_info.DensityMatrix.to_statevector#qiskit.quantum_info.DensityMatrix.to_statevector "qiskit.quantum_info.DensityMatrix.to_statevector") | Return a statevector from a pure density matrix. | -| [`trace`](qiskit.quantum_info.DensityMatrix.trace#qiskit.quantum_info.DensityMatrix.trace "qiskit.quantum_info.DensityMatrix.trace") | Return the trace of the density matrix. | +### conjugate -## Attributes + + +`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. + +### copy + + + +`DensityMatrix.copy()` + +Make a copy of current operator. + +### dims + + + +`DensityMatrix.dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### draw + + + +`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. + +**repr**: ASCII TextMatrix of the state’s `__repr__`. + +**text**: ASCII TextMatrix that can be printed in the console. + +**latex**: An IPython Latex object for displaying in Jupyter Notebooks. + +**latex\_source**: Raw, uncompiled ASCII source to generate array using LaTeX. + +**qsphere**: Matplotlib figure, rendering of density matrix using plot\_state\_qsphere(). + +**hinton**: Matplotlib figure, rendering of density matrix using plot\_state\_hinton(). + +**bloch**: Matplotlib figure, rendering of density matrix using plot\_bloch\_multivector(). + +**Parameters** + +* **output** (*str*) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, qsphere, hinton, or bloch. Default is repr. Default can be changed by adding the line `state_drawer = ` to `~/.qiskit/settings.conf` under `[default]`. +* **drawer\_args** – Arguments to be passed directly to the relevant drawing function or constructor (TextMatrix(), array\_to\_latex(), plot\_state\_qsphere(), plot\_state\_hinton() or plot\_bloch\_multivector()). See the relevant function under qiskit.visualization for that function’s documentation. + +**Returns** + +`matplotlib.Figure` or `str` or `TextMatrix` or `IPython.display.Latex`: Drawing of the Statevector. + +**Raises** + +**ValueError** – when an invalid output method is selected. + +### evolve + + + +`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. + +**Parameters** + +* \*\*(****Operator**** or \*\***QuantumChannel** (*other*) – or Instruction or Circuit): The operator to evolve by. +* **qargs** (*list*) – a list of QuantumState subsystem positions to apply the operator on. + +**Returns** + +the output quantum state. + +**Return type** + +QuantumState + +**Raises** + +**QiskitError** – if the operator dimension does not match the specified QuantumState subsystem dimensions. + +### expand + + + +`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. + +**Parameters** + +**other** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state object. + +**Returns** + +the tensor product state other ⊗ self. + +**Return type** + +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + +**Raises** + +**QiskitError** – if other is not a quantum state. + +### expectation\_value + + + +`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. + +**Parameters** + +* **oper** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator to evaluate expval. +* **qargs** (*None or list*) – subsystems to apply the operator on. + +**Returns** + +the expectation value. + +**Return type** + +complex + +### from\_instruction + + + +`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. + +The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. + +**Parameters** + +**instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – instruction or circuit + +**Returns** + +the final density matrix. + +**Return type** + +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + +**Raises** + +**QiskitError** – if the instruction contains invalid instructions for density matrix simulation. + +### from\_int + + + +`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. + +**Parameters** + +* **i** (*int*) – the basis state element. +* **dims** (*int or tuple or list*) – The subsystem dimensions of the statevector (See additional information). + +**Returns** + +The computational basis state $|i\rangle\!\langle i|$. + +**Return type** + +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + +#### Additional Information: + +The `dims` kwarg can be an integer or an iterable of integers. + +* `Iterable` – the subsystem dimensions are the values in the list with the total number of subsystems given by the length of the list. +* `Int` – the integer specifies the total dimension of the state. If it is a power of two the state will be initialized as an N-qubit state. If it is not a power of two the state will have a single d-dimensional subsystem. + +### from\_label + + + +`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. + +| Label | Statevector | +| ----- | ----------------------------------------------------------- | +| `"0"` | $\begin{pmatrix} 1 & 0 \\ 0 & 0 \end{pmatrix}$ | +| `"1"` | $\begin{pmatrix} 0 & 0 \\ 0 & 1 \end{pmatrix}$ | +| `"+"` | $\frac{1}{2}\begin{pmatrix} 1 & 1 \\ 1 & 1 \end{pmatrix}$ | +| `"-"` | $\frac{1}{2}\begin{pmatrix} 1 & -1 \\ -1 & 1 \end{pmatrix}$ | +| `"r"` | $\frac{1}{2}\begin{pmatrix} 1 & -i \\ i & 1 \end{pmatrix}$ | +| `"l"` | $\frac{1}{2}\begin{pmatrix} 1 & i \\ -i & 1 \end{pmatrix}$ | + +**Parameters** + +**label** (*string*) – a eigenstate string ket label (see table for allowed values). + +**Returns** + +The N-qubit basis state density matrix. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +**Raises** + +**QiskitError** – if the label contains invalid characters, or the length of the label is larger than an explicitly specified num\_qubits. + +### is\_valid + + + +`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. + +### measure + + + +`DensityMatrix.measure(qargs=None)` + +Measure subsystems and return outcome and post-measure state. + +Note that this function uses the QuantumStates internal random number generator for sampling the measurement outcome. The RNG seed can be set using the [`seed()`](qiskit.quantum_info.DensityMatrix#seed "qiskit.quantum_info.DensityMatrix.seed") method. + +**Parameters** + +**qargs** (*list or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +**the pair `(outcome, state)` where `outcome` is the** + +measurement outcome string label, and `state` is the collapsed post-measurement state for the corresponding outcome. + +**Return type** + +tuple + +### probabilities + + + +`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. + +Measurement probabilities are with respect to measurement in the computation (diagonal) basis. + +**Parameters** + +* **qargs** (*None or list*) – subsystems to return probabilities for, if None return for all subsystems (Default: None). +* **decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). + +**Returns** + +The Numpy vector array of probabilities. + +**Return type** + +np.array + +#### Examples + +Consider a 2-qubit product state $\rho=\rho_1\otimes\rho_0$ with $\rho_1=|+\rangle\!\langle+|$, $\rho_0=|0\rangle\!\langle0|$. + +```python +from qiskit.quantum_info import DensityMatrix +rho = DensityMatrix.from_label('+0') +# Probabilities for measuring both qubits +probs = rho.probabilities() +print('probs: {}'.format(probs)) + +# Probabilities for measuring only qubit-0 +probs_qubit_0 = rho.probabilities([0]) +print('Qubit-0 probs: {}'.format(probs_qubit_0)) + +# Probabilities for measuring only qubit-1 +probs_qubit_1 = rho.probabilities([1]) +print('Qubit-1 probs: {}'.format(probs_qubit_1)) +``` + +```python +probs: [0.5 0. 0.5 0. ] +Qubit-0 probs: [1. 0.] +Qubit-1 probs: [0.5 0.5] +``` + +We can also permute the order of qubits in the `qargs` list to change the qubit position in the probabilities output + +```python +from qiskit.quantum_info import DensityMatrix + +rho = DensityMatrix.from_label('+0') + +# Probabilities for measuring both qubits +probs = rho.probabilities([0, 1]) +print('probs: {}'.format(probs)) + +# Probabilities for measuring both qubits +# but swapping qubits 0 and 1 in output +probs_swapped = rho.probabilities([1, 0]) +print('Swapped probs: {}'.format(probs_swapped)) +``` + +```python +probs: [0.5 0. 0.5 0. ] +Swapped probs: [0.5 0.5 0. 0. ] +``` + +### probabilities\_dict + + + +`DensityMatrix.probabilities_dict(qargs=None, decimals=None)` + +Return the subsystem measurement probability dictionary. + +Measurement probabilities are with respect to measurement in the computation (diagonal) basis. + +This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. + +**Parameters** + +* **qargs** (*None or list*) – subsystems to return probabilities for, if None return for all subsystems (Default: None). +* **decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). + +**Returns** + +The measurement probabilities in dict (ket) form. + +**Return type** + +dict + +### purity + + + +`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. + +### reset + + + +`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. + +**Parameters** + +**qargs** (*list or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). + +**Returns** + +the reset state. + +**Return type** + +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + +#### Additional Information: + +If all subsystems are reset this will return the ground state on all subsystems. If only a some subsystems are reset this function will perform evolution by the reset [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") of the reset subsystems. + +### reverse\_qargs + + + +`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. + +For a tensor product state this is equivalent to reversing the order of tensor product subsystems. For a density matrix $\rho = \rho_{n-1} \otimes ... \otimes \rho_0$ the returned state will be $\rho_0 \otimes ... \otimes \rho_{n-1}$. + +**Returns** + +the state with reversed subsystem order. + +**Return type** + +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + +### sample\_counts + + + +`DensityMatrix.sample_counts(shots, qargs=None)` + +Sample a dict of qubit measurement outcomes in the computational basis. + +**Parameters** + +* **shots** (*int*) – number of samples to generate. +* **qargs** (*None or list*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +sampled counts dictionary. + +**Return type** + +[Counts](qiskit.result.Counts "qiskit.result.Counts") + +Additional Information: + +> This function *samples* measurement outcomes using the measure [`probabilities()`](qiskit.quantum_info.DensityMatrix#probabilities "qiskit.quantum_info.DensityMatrix.probabilities") for the current state and qargs. It does not actually implement the measurement so the current state is not modified. +> +> The seed for random number generator used for sampling can be set to a fixed value by using the stats [`seed()`](qiskit.quantum_info.DensityMatrix#seed "qiskit.quantum_info.DensityMatrix.seed") method. + +### sample\_memory + + + +`DensityMatrix.sample_memory(shots, qargs=None)` + +Sample a list of qubit measurement outcomes in the computational basis. + +**Parameters** + +* **shots** (*int*) – number of samples to generate. +* **qargs** (*None or list*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +list of sampled counts if the order sampled. + +**Return type** + +np.array + +Additional Information: + +> This function *samples* measurement outcomes using the measure [`probabilities()`](qiskit.quantum_info.DensityMatrix#probabilities "qiskit.quantum_info.DensityMatrix.probabilities") for the current state and qargs. It does not actually implement the measurement so the current state is not modified. +> +> The seed for random number generator used for sampling can be set to a fixed value by using the stats [`seed()`](qiskit.quantum_info.DensityMatrix#seed "qiskit.quantum_info.DensityMatrix.seed") method. + +### seed + + + +`DensityMatrix.seed(value=None)` + +Set the seed for the quantum state RNG. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state object. + +**Returns** + +the tensor product operator self ⊗ other. + +**Return type** + +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") + +**Raises** + +**QiskitError** – if other is not a quantum state. + +### to\_dict + + + +`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. + +This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. + +**Parameters** + +**decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). + +**Returns** + +the dictionary form of the DensityMatrix. + +**Return type** + +dict + +#### Examples + +The ket-form of a 2-qubit density matrix $rho = |-\rangle\!\langle -|\otimes |0\rangle\!\langle 0|$ + +```python +from qiskit.quantum_info import DensityMatrix + +rho = DensityMatrix.from_label('-0') +print(rho.to_dict()) +``` + +```python +{'00|00': (0.4999999999999999+0j), '10|00': (-0.4999999999999999-0j), '00|10': (-0.4999999999999999+0j), '10|10': (0.4999999999999999+0j)} +``` + +For non-qubit subsystems the integer range can go from 0 to 9. For example in a qutrit system + +```python +import numpy as np +from qiskit.quantum_info import DensityMatrix + +mat = np.zeros((9, 9)) +mat[0, 0] = 0.25 +mat[3, 3] = 0.25 +mat[6, 6] = 0.25 +mat[-1, -1] = 0.25 +rho = DensityMatrix(mat, dims=(3, 3)) +print(rho.to_dict()) +``` + +```python +{'00|00': (0.25+0j), '10|10': (0.25+0j), '20|20': (0.25+0j), '22|22': (0.25+0j)} +``` + +For large subsystem dimensions delimiters are required. The following example is for a 20-dimensional system consisting of a qubit and 10-dimensional qudit. + +```python +import numpy as np +from qiskit.quantum_info import DensityMatrix + +mat = np.zeros((2 * 10, 2 * 10)) +mat[0, 0] = 0.5 +mat[-1, -1] = 0.5 +rho = DensityMatrix(mat, dims=(2, 10)) +print(rho.to_dict()) +``` + +```python +{'00|00': (0.5+0j), '91|91': (0.5+0j)} +``` + +### to\_operator + + + +`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 + +### to\_statevector + + + +`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. + +**Parameters** + +* **atol** (*float*) – Absolute tolerance for checking operation validity. +* **rtol** (*float*) – Relative tolerance for checking operation validity. + +**Returns** + +**The pure density matrix’s corresponding statevector.** + +Corresponds to the eigenvector of the only non-zero eigenvalue. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +**Raises** + +**QiskitError** – if the state is not pure. + +### trace + + + +`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. + +## Attributes + + ### atol `= 1e-08` - + ### data Return data. - + ### dim Return total state dimension. - + ### num\_qubits Return the number of qubits if a N-qubit state or None otherwise. - + ### rtol `= 1e-05` + 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 091e192f9dc..983f13e11a2 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Kraus.md @@ -1,14 +1,22 @@ -# Kraus +--- +title: Kraus +description: API reference for qiskit.quantum_info.Kraus +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Kraus +--- +# Kraus + -`Kraus(data, input_dims=None, output_dims=None)` +`Kraus(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/kraus.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Kraus representation of a quantum channel. -For a quantum channel $\mathcal{E}$, the Kraus representation is given by a set of matrices $[A_0,...,A_{K-1}]$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by +For a quantum channel $\mathcal{E}$, the Kraus representation is given by a set of matrices $[A_0,...,A_{K-1}]$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by $$ \mathcal{E}(\rho) = \sum_{i=0}^{K-1} A_i \rho A_i^\dagger @@ -44,67 +52,324 @@ If the input or output dimensions are None, they will be automatically determine ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.Kraus.adjoint#qiskit.quantum_info.Kraus.adjoint "qiskit.quantum_info.Kraus.adjoint") | Return the adjoint quantum channel. | -| [`compose`](qiskit.quantum_info.Kraus.compose#qiskit.quantum_info.Kraus.compose "qiskit.quantum_info.Kraus.compose") | Return the operator composition with another Kraus. | -| [`conjugate`](qiskit.quantum_info.Kraus.conjugate#qiskit.quantum_info.Kraus.conjugate "qiskit.quantum_info.Kraus.conjugate") | Return the conjugate quantum channel. | -| [`copy`](qiskit.quantum_info.Kraus.copy#qiskit.quantum_info.Kraus.copy "qiskit.quantum_info.Kraus.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.Kraus.dot#qiskit.quantum_info.Kraus.dot "qiskit.quantum_info.Kraus.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.Kraus.expand#qiskit.quantum_info.Kraus.expand "qiskit.quantum_info.Kraus.expand") | Return the reverse-order tensor product with another Kraus. | -| [`input_dims`](qiskit.quantum_info.Kraus.input_dims#qiskit.quantum_info.Kraus.input_dims "qiskit.quantum_info.Kraus.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_cp`](qiskit.quantum_info.Kraus.is_cp#qiskit.quantum_info.Kraus.is_cp "qiskit.quantum_info.Kraus.is_cp") | Test if Choi-matrix is completely-positive (CP) | -| [`is_cptp`](qiskit.quantum_info.Kraus.is_cptp#qiskit.quantum_info.Kraus.is_cptp "qiskit.quantum_info.Kraus.is_cptp") | Return True if completely-positive trace-preserving. | -| [`is_tp`](qiskit.quantum_info.Kraus.is_tp#qiskit.quantum_info.Kraus.is_tp "qiskit.quantum_info.Kraus.is_tp") | Test if a channel is trace-preserving (TP) | -| [`is_unitary`](qiskit.quantum_info.Kraus.is_unitary#qiskit.quantum_info.Kraus.is_unitary "qiskit.quantum_info.Kraus.is_unitary") | Return True if QuantumChannel is a unitary channel. | -| [`output_dims`](qiskit.quantum_info.Kraus.output_dims#qiskit.quantum_info.Kraus.output_dims "qiskit.quantum_info.Kraus.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.Kraus.power#qiskit.quantum_info.Kraus.power "qiskit.quantum_info.Kraus.power") | Return the power of the quantum channel. | -| [`reshape`](qiskit.quantum_info.Kraus.reshape#qiskit.quantum_info.Kraus.reshape "qiskit.quantum_info.Kraus.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.Kraus.tensor#qiskit.quantum_info.Kraus.tensor "qiskit.quantum_info.Kraus.tensor") | Return the tensor product with another Kraus. | -| [`to_instruction`](qiskit.quantum_info.Kraus.to_instruction#qiskit.quantum_info.Kraus.to_instruction "qiskit.quantum_info.Kraus.to_instruction") | Convert to a Kraus or UnitaryGate circuit instruction. | -| [`to_operator`](qiskit.quantum_info.Kraus.to_operator#qiskit.quantum_info.Kraus.to_operator "qiskit.quantum_info.Kraus.to_operator") | Try to convert channel to a unitary representation Operator. | -| [`transpose`](qiskit.quantum_info.Kraus.transpose#qiskit.quantum_info.Kraus.transpose "qiskit.quantum_info.Kraus.transpose") | Return the transpose quantum channel. | +### adjoint -## Attributes + + +`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. + + + This is equivalent to the matrix Hermitian conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the adjoint channel $\mathcal{{E}}^\dagger$ is $S_{\mathcal{E}^\dagger} = S_{\mathcal{E}}^\dagger$. + + +### compose + + + +`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. + +**Parameters** + +* **other** ([*Kraus*](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")) – a Kraus object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed Kraus. + +**Return type** + +[Kraus](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.Kraus#dot "qiskit.quantum_info.Kraus.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.Kraus#dot "qiskit.quantum_info.Kraus.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + + + This is equivalent to the matrix complex conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the conjugate channel $\overline{{\mathcal{{E}}}}$ is $S_{\overline{\mathcal{E}^\dagger}} = \overline{S_{\mathcal{E}}}$. + + +### copy + + + +`Kraus.copy()` + +Make a deep copy of current operator. + +### dot + + + +`Kraus.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*Kraus*](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")) – a Kraus object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current Kraus, and $b$ is the other Kraus. + +**Return type** + +[Kraus](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus") + +### input\_dims + + + +`Kraus.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_cp + + + +`Kraus.is_cp(atol=None, rtol=None)` + +Test if Choi-matrix is completely-positive (CP) + +### is\_cptp + + + +`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. + +### is\_tp + + + +`Kraus.is_tp(atol=None, rtol=None)` + +Test if a channel is trace-preserving (TP) + +### is\_unitary + + + +`Kraus.is_unitary(atol=None, rtol=None)` + +Return True if QuantumChannel is a unitary channel. + +### output\_dims + +`Kraus.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`Kraus.power(n)` + +Return the power of the quantum channel. + +**Parameters** + +**n** (*float*) – the power exponent. + +**Returns** + +the channel $\mathcal{{E}} ^n$. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +**Raises** + +**QiskitError** – if the input and output dimensions of the SuperOp are not equal. + + + For non-positive or non-integer exponents the power is defined as the matrix power of the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{{E}}$, the SuperOp of the powered channel $\mathcal{{E}}^\n$ is $S_{{\mathcal{{E}}^n}} = S_{{\mathcal{{E}}}}^n$. + + +### reshape + + + +`Kraus.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Kraus*](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")) – a Kraus object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current Kraus, and $b$ is the other Kraus. + +**Return type** + +[Kraus](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`Kraus.to_instruction()` + +Convert to a Kraus or UnitaryGate circuit instruction. + +If the channel is unitary it will be added as a unitary gate, otherwise it will be added as a kraus simulator instruction. + +**Returns** + +A kraus instruction for the channel. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**QiskitError** – if input data is not an N-qubit CPTP quantum channel. + +### to\_operator + + + +`Kraus.to_operator()` + +Try to convert channel to a unitary representation Operator. + +### transpose + + + +`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. + + + This is equivalent to the matrix transpose in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation, ie. for a channel $\mathcal{E}$, the SuperOp of the transpose channel $\mathcal{{E}}^T$ is $S_{mathcal{E}^T} = S_{\mathcal{E}}^T$. + + +## Attributes + + ### atol `= 1e-08` - + ### data Return list of Kraus matrices for channel. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 c84fa6a50d5..d746922fe44 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.OneQubitEulerDecomposer.md @@ -1,8 +1,16 @@ -# OneQubitEulerDecomposer +--- +title: OneQubitEulerDecomposer +description: API reference for qiskit.quantum_info.OneQubitEulerDecomposer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.OneQubitEulerDecomposer +--- +# OneQubitEulerDecomposer + -`OneQubitEulerDecomposer(basis='U3')` +`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` @@ -39,15 +47,51 @@ Supported bases are: ‘U’, ‘PSX’, ‘ZSXX’, ‘ZSX’, ‘U321’, ‘U ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`angles`](qiskit.quantum_info.OneQubitEulerDecomposer.angles#qiskit.quantum_info.OneQubitEulerDecomposer.angles "qiskit.quantum_info.OneQubitEulerDecomposer.angles") | Return the Euler angles for input array. | -| [`angles_and_phase`](qiskit.quantum_info.OneQubitEulerDecomposer.angles_and_phase#qiskit.quantum_info.OneQubitEulerDecomposer.angles_and_phase "qiskit.quantum_info.OneQubitEulerDecomposer.angles_and_phase") | Return the Euler angles and phase for input array. | +### angles -## Attributes + + +`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. + +**Parameters** + +**unitary** (*np.ndarray*) – 2x2 unitary matrix. + +**Returns** + +(theta, phi, lambda). + +**Return type** + +tuple + +### angles\_and\_phase + +`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. + +**Parameters** + +**unitary** (*np.ndarray*) – 2x2 unitary matrix. + +**Returns** + +(theta, phi, lambda, phase). + +**Return type** + +tuple + +## Attributes + + ### basis The decomposition basis. + 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 1ea58307941..174a69f047a 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Operator.md @@ -1,20 +1,28 @@ -# Operator +--- +title: Operator +description: API reference for qiskit.quantum_info.Operator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Operator +--- +# Operator + -`Operator(data, input_dims=None, output_dims=None)` +`Operator(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/operator.py "view source code") Bases: `qiskit.quantum_info.operators.linear_op.LinearOp` Matrix operator class -This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector.evolve#qiskit.quantum_info.Statevector.evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication +This represents a matrix operator $M$ that will [`evolve()`](qiskit.quantum_info.Statevector#evolve "qiskit.quantum_info.Statevector.evolve") a [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ by matrix-vector multiplication $$ |\psi\rangle \mapsto M|\psi\rangle, $$ -and will [`evolve()`](qiskit.quantum_info.DensityMatrix.evolve#qiskit.quantum_info.DensityMatrix.evolve "qiskit.quantum_info.DensityMatrix.evolve") a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ by left and right multiplication +and will [`evolve()`](qiskit.quantum_info.DensityMatrix#evolve "qiskit.quantum_info.DensityMatrix.evolve") a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ by left and right multiplication $$ \rho \mapsto M \rho M^\dagger. @@ -38,67 +46,338 @@ If the input or output dimensions are None, they will be automatically determine ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.Operator.adjoint#qiskit.quantum_info.Operator.adjoint "qiskit.quantum_info.Operator.adjoint") | Return the adjoint of the Operator. | -| [`compose`](qiskit.quantum_info.Operator.compose#qiskit.quantum_info.Operator.compose "qiskit.quantum_info.Operator.compose") | Return the operator composition with another Operator. | -| [`conjugate`](qiskit.quantum_info.Operator.conjugate#qiskit.quantum_info.Operator.conjugate "qiskit.quantum_info.Operator.conjugate") | Return the conjugate of the Operator. | -| [`copy`](qiskit.quantum_info.Operator.copy#qiskit.quantum_info.Operator.copy "qiskit.quantum_info.Operator.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.Operator.dot#qiskit.quantum_info.Operator.dot "qiskit.quantum_info.Operator.dot") | Return the right multiplied operator self \* other. | -| [`equiv`](qiskit.quantum_info.Operator.equiv#qiskit.quantum_info.Operator.equiv "qiskit.quantum_info.Operator.equiv") | Return True if operators are equivalent up to global phase. | -| [`expand`](qiskit.quantum_info.Operator.expand#qiskit.quantum_info.Operator.expand "qiskit.quantum_info.Operator.expand") | Return the reverse-order tensor product with another Operator. | -| [`from_label`](qiskit.quantum_info.Operator.from_label#qiskit.quantum_info.Operator.from_label "qiskit.quantum_info.Operator.from_label") | Return a tensor product of single-qubit operators. | -| [`input_dims`](qiskit.quantum_info.Operator.input_dims#qiskit.quantum_info.Operator.input_dims "qiskit.quantum_info.Operator.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_unitary`](qiskit.quantum_info.Operator.is_unitary#qiskit.quantum_info.Operator.is_unitary "qiskit.quantum_info.Operator.is_unitary") | Return True if operator is a unitary matrix. | -| [`output_dims`](qiskit.quantum_info.Operator.output_dims#qiskit.quantum_info.Operator.output_dims "qiskit.quantum_info.Operator.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.Operator.power#qiskit.quantum_info.Operator.power "qiskit.quantum_info.Operator.power") | Return the matrix power of the operator. | -| [`reshape`](qiskit.quantum_info.Operator.reshape#qiskit.quantum_info.Operator.reshape "qiskit.quantum_info.Operator.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`reverse_qargs`](qiskit.quantum_info.Operator.reverse_qargs#qiskit.quantum_info.Operator.reverse_qargs "qiskit.quantum_info.Operator.reverse_qargs") | Return an Operator with reversed subsystem ordering. | -| [`tensor`](qiskit.quantum_info.Operator.tensor#qiskit.quantum_info.Operator.tensor "qiskit.quantum_info.Operator.tensor") | Return the tensor product with another Operator. | -| [`to_instruction`](qiskit.quantum_info.Operator.to_instruction#qiskit.quantum_info.Operator.to_instruction "qiskit.quantum_info.Operator.to_instruction") | Convert to a UnitaryGate instruction. | -| [`to_operator`](qiskit.quantum_info.Operator.to_operator#qiskit.quantum_info.Operator.to_operator "qiskit.quantum_info.Operator.to_operator") | Convert operator to matrix operator class | -| [`transpose`](qiskit.quantum_info.Operator.transpose#qiskit.quantum_info.Operator.transpose "qiskit.quantum_info.Operator.transpose") | Return the transpose of the Operator. | +### adjoint -## Attributes + + +`Operator.adjoint()` + +Return the adjoint of the Operator. + +### compose + + + +`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. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.Operator#dot "qiskit.quantum_info.Operator.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.Operator#dot "qiskit.quantum_info.Operator.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + +### copy + + + +`Operator.copy()` + +Make a deep copy of current operator. + +### dot + + + +`Operator.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### equiv + + + +`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. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **rtol** (*float*) – relative tolerance value for comparison. +* **atol** (*float*) – absolute tolerance value for comparison. + +**Returns** + +True if operators are equivalent up to global phase. + +**Return type** + +bool + +### expand + + + +`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. + +**Parameters** + +**other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Operator object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current Operator, and $b$ is the other Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### from\_label + + + +`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. + +**Parameters** + +**label** (*string*) – single-qubit operator string. + +**Returns** + +The N-qubit operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +**Raises** + +**QiskitError** – if the label contains invalid characters, or the length of the label is larger than an explicitly specified num\_qubits. + +#### Additional Information: + +The labels correspond to the single-qubit matrices: ‘I’: \[\[1, 0], \[0, 1]] ‘X’: \[\[0, 1], \[1, 0]] ‘Y’: \[\[0, -1j], \[1j, 0]] ‘Z’: \[\[1, 0], \[0, -1]] ‘H’: \[\[1, 1], \[1, -1]] / sqrt(2) ‘S’: \[\[1, 0], \[0 , 1j]] ‘T’: \[\[1, 0], \[0, (1+1j) / sqrt(2)]] ‘0’: \[\[1, 0], \[0, 0]] ‘1’: \[\[0, 0], \[0, 1]] ‘+’: \[\[0.5, 0.5], \[0.5 , 0.5]] ‘-‘: \[\[0.5, -0.5], \[-0.5 , 0.5]] ‘r’: \[\[0.5, -0.5j], \[0.5j , 0.5]] ‘l’: \[\[0.5, 0.5j], \[-0.5j , 0.5]] + +### input\_dims + + +`Operator.input_dims(qargs=None)` +Return tuple of input dimension for specified subsystems. + +### is\_unitary + + + +`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. + +### output\_dims + + + +`Operator.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`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. + +**Parameters** + +**n** (*float*) – the power to raise the matrix to. + +**Returns** + +the resulting operator `O ** n`. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal. + +### reshape + + + +`Operator.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### reverse\_qargs + + + +`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. + +For a tensor product operator this is equivalent to reversing the order of tensor product subsystems. For an operator $A = A_{n-1} \otimes ... \otimes A_0$ the returned operator will be $A_0 \otimes ... \otimes A_{n-1}$. + +**Returns** + +the operator with reversed subsystem order. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – a Operator object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current Operator, and $b$ is the other Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`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. + +### to\_operator + + + +`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 + +### transpose + + + +`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. + +## Attributes + + ### atol `= 1e-08` - + ### data Return data. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 b8c447645a0..3c42f8c41d6 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PTM.md @@ -1,14 +1,22 @@ -# PTM +--- +title: PTM +description: API reference for qiskit.quantum_info.PTM +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.PTM +--- +# PTM + -`PTM(data, input_dims=None, output_dims=None)` +`PTM(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/ptm.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Pauli Transfer Matrix (PTM) representation of a Quantum Channel. -The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp#qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by +The PTM representation of an $n$-qubit quantum channel $\mathcal{E}$ is an $n$-qubit [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") $R$ defined with respect to vectorization in the Pauli basis instead of column-vectorization. The elements of the PTM $R$ are given by $$ R_{i,j} = \mbox{Tr}\left[P_i \mathcal{E}(P_j) \right] @@ -16,7 +24,7 @@ $$ where $[P_0, P_1, ..., P_{4^{n}-1}]$ is the $n$-qubit Pauli basis in lexicographic order. -Evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ with respect to the PTM is given by +Evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ with respect to the PTM is given by $$ |\mathcal{E}(\rho)\rangle\!\rangle_P = S_P |\rho\rangle\!\rangle_P @@ -48,67 +56,324 @@ If the input or output dimensions are None, they will be automatically determine ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.PTM.adjoint#qiskit.quantum_info.PTM.adjoint "qiskit.quantum_info.PTM.adjoint") | Return the adjoint quantum channel. | -| [`compose`](qiskit.quantum_info.PTM.compose#qiskit.quantum_info.PTM.compose "qiskit.quantum_info.PTM.compose") | Return the operator composition with another PTM. | -| [`conjugate`](qiskit.quantum_info.PTM.conjugate#qiskit.quantum_info.PTM.conjugate "qiskit.quantum_info.PTM.conjugate") | Return the conjugate quantum channel. | -| [`copy`](qiskit.quantum_info.PTM.copy#qiskit.quantum_info.PTM.copy "qiskit.quantum_info.PTM.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.PTM.dot#qiskit.quantum_info.PTM.dot "qiskit.quantum_info.PTM.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.PTM.expand#qiskit.quantum_info.PTM.expand "qiskit.quantum_info.PTM.expand") | Return the reverse-order tensor product with another PTM. | -| [`input_dims`](qiskit.quantum_info.PTM.input_dims#qiskit.quantum_info.PTM.input_dims "qiskit.quantum_info.PTM.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_cp`](qiskit.quantum_info.PTM.is_cp#qiskit.quantum_info.PTM.is_cp "qiskit.quantum_info.PTM.is_cp") | Test if Choi-matrix is completely-positive (CP) | -| [`is_cptp`](qiskit.quantum_info.PTM.is_cptp#qiskit.quantum_info.PTM.is_cptp "qiskit.quantum_info.PTM.is_cptp") | Return True if completely-positive trace-preserving (CPTP). | -| [`is_tp`](qiskit.quantum_info.PTM.is_tp#qiskit.quantum_info.PTM.is_tp "qiskit.quantum_info.PTM.is_tp") | Test if a channel is trace-preserving (TP) | -| [`is_unitary`](qiskit.quantum_info.PTM.is_unitary#qiskit.quantum_info.PTM.is_unitary "qiskit.quantum_info.PTM.is_unitary") | Return True if QuantumChannel is a unitary channel. | -| [`output_dims`](qiskit.quantum_info.PTM.output_dims#qiskit.quantum_info.PTM.output_dims "qiskit.quantum_info.PTM.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.PTM.power#qiskit.quantum_info.PTM.power "qiskit.quantum_info.PTM.power") | Return the power of the quantum channel. | -| [`reshape`](qiskit.quantum_info.PTM.reshape#qiskit.quantum_info.PTM.reshape "qiskit.quantum_info.PTM.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.PTM.tensor#qiskit.quantum_info.PTM.tensor "qiskit.quantum_info.PTM.tensor") | Return the tensor product with another PTM. | -| [`to_instruction`](qiskit.quantum_info.PTM.to_instruction#qiskit.quantum_info.PTM.to_instruction "qiskit.quantum_info.PTM.to_instruction") | Convert to a Kraus or UnitaryGate circuit instruction. | -| [`to_operator`](qiskit.quantum_info.PTM.to_operator#qiskit.quantum_info.PTM.to_operator "qiskit.quantum_info.PTM.to_operator") | Try to convert channel to a unitary representation Operator. | -| [`transpose`](qiskit.quantum_info.PTM.transpose#qiskit.quantum_info.PTM.transpose "qiskit.quantum_info.PTM.transpose") | Return the transpose quantum channel. | +### adjoint -## Attributes + + +`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. + + + This is equivalent to the matrix Hermitian conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the adjoint channel $\mathcal{{E}}^\dagger$ is $S_{\mathcal{E}^\dagger} = S_{\mathcal{E}}^\dagger$. + + +### compose + + + +`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. + +**Parameters** + +* **other** ([*PTM*](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")) – a PTM object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed PTM. + +**Return type** + +[PTM](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.PTM#dot "qiskit.quantum_info.PTM.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.PTM#dot "qiskit.quantum_info.PTM.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + + + This is equivalent to the matrix complex conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the conjugate channel $\overline{{\mathcal{{E}}}}$ is $S_{\overline{\mathcal{E}^\dagger}} = \overline{S_{\mathcal{E}}}$. + + +### copy + + + +`PTM.copy()` + +Make a deep copy of current operator. + +### dot + + + +`PTM.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*PTM*](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")) – a PTM object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current PTM, and $b$ is the other PTM. + +**Return type** + +[PTM](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM") + +### input\_dims + + + +`PTM.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_cp + + + +`PTM.is_cp(atol=None, rtol=None)` + +Test if Choi-matrix is completely-positive (CP) + +### is\_cptp + + + +`PTM.is_cptp(atol=None, rtol=None)` + +Return True if completely-positive trace-preserving (CPTP). + +### is\_tp + + + +`PTM.is_tp(atol=None, rtol=None)` + +Test if a channel is trace-preserving (TP) + +### is\_unitary + + + +`PTM.is_unitary(atol=None, rtol=None)` + +Return True if QuantumChannel is a unitary channel. + +### output\_dims + +`PTM.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`PTM.power(n)` + +Return the power of the quantum channel. + +**Parameters** + +**n** (*float*) – the power exponent. + +**Returns** + +the channel $\mathcal{{E}} ^n$. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +**Raises** + +**QiskitError** – if the input and output dimensions of the SuperOp are not equal. + + + For non-positive or non-integer exponents the power is defined as the matrix power of the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{{E}}$, the SuperOp of the powered channel $\mathcal{{E}}^\n$ is $S_{{\mathcal{{E}}^n}} = S_{{\mathcal{{E}}}}^n$. + + +### reshape + + + +`PTM.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*PTM*](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")) – a PTM object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current PTM, and $b$ is the other PTM. + +**Return type** + +[PTM](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`PTM.to_instruction()` + +Convert to a Kraus or UnitaryGate circuit instruction. + +If the channel is unitary it will be added as a unitary gate, otherwise it will be added as a kraus simulator instruction. + +**Returns** + +A kraus instruction for the channel. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**QiskitError** – if input data is not an N-qubit CPTP quantum channel. + +### to\_operator + + + +`PTM.to_operator()` + +Try to convert channel to a unitary representation Operator. + +### transpose + + + +`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. + + + This is equivalent to the matrix transpose in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation, ie. for a channel $\mathcal{E}$, the SuperOp of the transpose channel $\mathcal{{E}}^T$ is $S_{mathcal{E}^T} = S_{\mathcal{E}}^T$. + + +## Attributes + + ### atol `= 1e-08` - + ### data Return data. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 11e7c008c0e..73bb703a783 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Pauli.md @@ -1,8 +1,16 @@ -# Pauli +--- +title: Pauli +description: API reference for qiskit.quantum_info.Pauli +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Pauli +--- +# Pauli + -`Pauli(data=None, x=None, *, z=None, label=None)` +`Pauli(data=None, x=None, *, z=None, label=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/pauli.py "view source code") Bases: `qiskit.quantum_info.operators.symplectic.base_pauli.BasePauli` @@ -29,7 +37,7 @@ A Pauli object can be initialized in several ways: > **`Pauli(obj)`** > -> where `obj` is a Pauli string, `Pauli` or [`ScalarOp`](qiskit.quantum_info.ScalarOp#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") operator, or a Pauli gate or `QuantumCircuit` containing only Pauli gates. +> where `obj` is a Pauli string, `Pauli` or [`ScalarOp`](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") operator, or a Pauli gate or `QuantumCircuit` containing only Pauli gates. > > **`Pauli((z, x, phase))`** > @@ -45,10 +53,10 @@ An $n$-qubit Pauli may be represented by a string consisting of $n$ characters f In the string representation qubit-0 corresponds to the right-most Pauli character, and qubit-$(n-1)$ to the left-most Pauli character. For example `'XYZ'` represents $X\otimes Y \otimes Z$ with `'Z'` on qubit-0, `'Y'` on qubit-1, and `'X'` on qubit-3. -The string representation can be converted to a `Pauli` using the class initialization (`Pauli('-iXYZ')`). A `Pauli` object can be converted back to the string representation using the [`to_label()`](qiskit.quantum_info.Pauli.to_label#qiskit.quantum_info.Pauli.to_label "qiskit.quantum_info.Pauli.to_label") method or `str(pauli)`. +The string representation can be converted to a `Pauli` using the class initialization (`Pauli('-iXYZ')`). A `Pauli` object can be converted back to the string representation using the [`to_label()`](qiskit.quantum_info.Pauli#to_label "qiskit.quantum_info.Pauli.to_label") method or `str(pauli)`. - Using `str` to convert a `Pauli` to a string will truncate the returned string for large numbers of qubits while [`to_label()`](qiskit.quantum_info.Pauli.to_label#qiskit.quantum_info.Pauli.to_label "qiskit.quantum_info.Pauli.to_label") will return the full string with no truncation. The default truncation length is 50 characters. The default value can be changed by setting the class \_\_truncate\_\_ attribute to an integer value. If set to `0` no truncation will be performed. + Using `str` to convert a `Pauli` to a string will truncate the returned string for large numbers of qubits while [`to_label()`](qiskit.quantum_info.Pauli#to_label "qiskit.quantum_info.Pauli.to_label") will return the full string with no truncation. The default truncation length is 50 characters. The default value can be changed by setting the class \_\_truncate\_\_ attribute to an integer value. If set to `0` no truncation will be performed. **Array Representation** @@ -72,7 +80,7 @@ The $z$ and $x$ arrays can be accessed and updated using the [`z`](#qiskit.quant **Matrix Operator Representation** -Pauli’s can be converted to $(2^n, 2^n)$ [`Operator`](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") using the `to_operator()` method, or to a dense or sparse complex matrix using the [`to_matrix()`](qiskit.quantum_info.Pauli.to_matrix#qiskit.quantum_info.Pauli.to_matrix "qiskit.quantum_info.Pauli.to_matrix") method. +Pauli’s can be converted to $(2^n, 2^n)$ [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") using the `to_operator()` method, or to a dense or sparse complex matrix using the [`to_matrix()`](qiskit.quantum_info.Pauli#to_matrix "qiskit.quantum_info.Pauli.to_matrix") method. **Data Access** @@ -86,7 +94,7 @@ When using the symplectic array input data both z and x arguments must be provid **Parameters** -* **data** (*str or tuple or* [*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*ScalarOp*](qiskit.quantum_info.ScalarOp#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – input data for Pauli. If input is a tuple it must be of the form `(z, x)` or (z, x, phase)\`\` where `z` and `x` are boolean Numpy arrays, and phase is an integer from Z\_4. If input is a string, it must be a concatenation of a phase and a Pauli string (e.g. ‘XYZ’, ‘-iZIZ’) where a phase string is a combination of at most three characters from \[‘+’, ‘-‘, ‘’], \[‘1’, ‘’], and \[‘i’, ‘j’, ‘’] in this order, e.g. ‘’, ‘-1j’ while a Pauli string is 1 or more characters of ‘I’, ‘X’, ‘Y’ or ‘Z’, e.g. ‘Z’, ‘XIYY’. +* **data** (*str or tuple or* [*Pauli*](#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – input data for Pauli. If input is a tuple it must be of the form `(z, x)` or (z, x, phase)\`\` where `z` and `x` are boolean Numpy arrays, and phase is an integer from Z\_4. If input is a string, it must be a concatenation of a phase and a Pauli string (e.g. ‘XYZ’, ‘-iZIZ’) where a phase string is a combination of at most three characters from \[‘+’, ‘-‘, ‘’], \[‘1’, ‘’], and \[‘i’, ‘j’, ‘’] in this order, e.g. ‘’, ‘-1j’ while a Pauli string is 1 or more characters of ‘I’, ‘X’, ‘Y’ or ‘Z’, e.g. ‘Z’, ‘XIYY’. * **x** (*np.ndarray*) – DEPRECATED, symplectic x vector. * **z** (*np.ndarray*) – DEPRECATED, symplectic z vector. * **label** (*str*) – DEPRECATED, string label. @@ -97,70 +105,714 @@ When using the symplectic array input data both z and x arguments must be provid ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.Pauli.adjoint#qiskit.quantum_info.Pauli.adjoint "qiskit.quantum_info.Pauli.adjoint") | Return the adjoint of the Operator. | -| [`anticommutes`](qiskit.quantum_info.Pauli.anticommutes#qiskit.quantum_info.Pauli.anticommutes "qiskit.quantum_info.Pauli.anticommutes") | Return True if other Pauli anticommutes with self. | -| [`append_paulis`](qiskit.quantum_info.Pauli.append_paulis#qiskit.quantum_info.Pauli.append_paulis "qiskit.quantum_info.Pauli.append_paulis") | DEPRECATED: Append pauli at the end. | -| [`commutes`](qiskit.quantum_info.Pauli.commutes#qiskit.quantum_info.Pauli.commutes "qiskit.quantum_info.Pauli.commutes") | Return True if the Pauli commutes with other. | -| [`compose`](qiskit.quantum_info.Pauli.compose#qiskit.quantum_info.Pauli.compose "qiskit.quantum_info.Pauli.compose") | Return the operator composition with another Pauli. | -| [`conjugate`](qiskit.quantum_info.Pauli.conjugate#qiskit.quantum_info.Pauli.conjugate "qiskit.quantum_info.Pauli.conjugate") | Return the conjugate of each Pauli in the list. | -| [`copy`](qiskit.quantum_info.Pauli.copy#qiskit.quantum_info.Pauli.copy "qiskit.quantum_info.Pauli.copy") | Make a deep copy of current operator. | -| [`delete`](qiskit.quantum_info.Pauli.delete#qiskit.quantum_info.Pauli.delete "qiskit.quantum_info.Pauli.delete") | Return a Pauli with qubits deleted. | -| [`delete_qubits`](qiskit.quantum_info.Pauli.delete_qubits#qiskit.quantum_info.Pauli.delete_qubits "qiskit.quantum_info.Pauli.delete_qubits") | DEPRECATED: Delete pauli at the indices. | -| [`dot`](qiskit.quantum_info.Pauli.dot#qiskit.quantum_info.Pauli.dot "qiskit.quantum_info.Pauli.dot") | Return the right multiplied operator self \* other. | -| [`equiv`](qiskit.quantum_info.Pauli.equiv#qiskit.quantum_info.Pauli.equiv "qiskit.quantum_info.Pauli.equiv") | Return True if Pauli’s are equivalent up to group phase. | -| [`evolve`](qiskit.quantum_info.Pauli.evolve#qiskit.quantum_info.Pauli.evolve "qiskit.quantum_info.Pauli.evolve") | Heisenberg picture evolution of a Pauli by a Clifford. | -| [`expand`](qiskit.quantum_info.Pauli.expand#qiskit.quantum_info.Pauli.expand "qiskit.quantum_info.Pauli.expand") | Return the reverse-order tensor product with another Pauli. | -| [`from_label`](qiskit.quantum_info.Pauli.from_label#qiskit.quantum_info.Pauli.from_label "qiskit.quantum_info.Pauli.from_label") | DEPRECATED: Construct a Pauli from a string label. | -| [`input_dims`](qiskit.quantum_info.Pauli.input_dims#qiskit.quantum_info.Pauli.input_dims "qiskit.quantum_info.Pauli.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`insert`](qiskit.quantum_info.Pauli.insert#qiskit.quantum_info.Pauli.insert "qiskit.quantum_info.Pauli.insert") | Insert a Pauli at specific qubit value. | -| [`insert_paulis`](qiskit.quantum_info.Pauli.insert_paulis#qiskit.quantum_info.Pauli.insert_paulis "qiskit.quantum_info.Pauli.insert_paulis") | DEPRECATED: Insert or append pauli to the targeted indices. | -| [`inverse`](qiskit.quantum_info.Pauli.inverse#qiskit.quantum_info.Pauli.inverse "qiskit.quantum_info.Pauli.inverse") | Return the inverse of the Pauli. | -| [`kron`](qiskit.quantum_info.Pauli.kron#qiskit.quantum_info.Pauli.kron "qiskit.quantum_info.Pauli.kron") | DEPRECATED: Kronecker product of two paulis. | -| [`output_dims`](qiskit.quantum_info.Pauli.output_dims#qiskit.quantum_info.Pauli.output_dims "qiskit.quantum_info.Pauli.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`pauli_single`](qiskit.quantum_info.Pauli.pauli_single#qiskit.quantum_info.Pauli.pauli_single "qiskit.quantum_info.Pauli.pauli_single") | DEPRECATED: Generate single qubit pauli at index with pauli\_label with length num\_qubits. | -| [`power`](qiskit.quantum_info.Pauli.power#qiskit.quantum_info.Pauli.power "qiskit.quantum_info.Pauli.power") | Return the compose of a operator with itself n times. | -| [`random`](qiskit.quantum_info.Pauli.random#qiskit.quantum_info.Pauli.random "qiskit.quantum_info.Pauli.random") | DEPRECATED: Return a random Pauli on number of qubits. | -| [`reshape`](qiskit.quantum_info.Pauli.reshape#qiskit.quantum_info.Pauli.reshape "qiskit.quantum_info.Pauli.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`set_truncation`](qiskit.quantum_info.Pauli.set_truncation#qiskit.quantum_info.Pauli.set_truncation "qiskit.quantum_info.Pauli.set_truncation") | Set the max number of Pauli characters to display before truncation/ | -| [`sgn_prod`](qiskit.quantum_info.Pauli.sgn_prod#qiskit.quantum_info.Pauli.sgn_prod "qiskit.quantum_info.Pauli.sgn_prod") | DEPRECATED: Multiply two Paulis and track the phase. | -| [`tensor`](qiskit.quantum_info.Pauli.tensor#qiskit.quantum_info.Pauli.tensor "qiskit.quantum_info.Pauli.tensor") | Return the tensor product with another Pauli. | -| [`to_instruction`](qiskit.quantum_info.Pauli.to_instruction#qiskit.quantum_info.Pauli.to_instruction "qiskit.quantum_info.Pauli.to_instruction") | Convert to Pauli circuit instruction. | -| [`to_label`](qiskit.quantum_info.Pauli.to_label#qiskit.quantum_info.Pauli.to_label "qiskit.quantum_info.Pauli.to_label") | Convert a Pauli to a string label. | -| [`to_matrix`](qiskit.quantum_info.Pauli.to_matrix#qiskit.quantum_info.Pauli.to_matrix "qiskit.quantum_info.Pauli.to_matrix") | Convert to a Numpy array or sparse CSR matrix. | -| [`to_spmatrix`](qiskit.quantum_info.Pauli.to_spmatrix#qiskit.quantum_info.Pauli.to_spmatrix "qiskit.quantum_info.Pauli.to_spmatrix") | DEPRECATED Convert Pauli to a sparse matrix representation (CSR format). | -| [`transpose`](qiskit.quantum_info.Pauli.transpose#qiskit.quantum_info.Pauli.transpose "qiskit.quantum_info.Pauli.transpose") | Return the transpose of each Pauli in the list. | -| [`update_x`](qiskit.quantum_info.Pauli.update_x#qiskit.quantum_info.Pauli.update_x "qiskit.quantum_info.Pauli.update_x") | DEPRECATED: Update partial or entire x. | -| [`update_z`](qiskit.quantum_info.Pauli.update_z#qiskit.quantum_info.Pauli.update_z "qiskit.quantum_info.Pauli.update_z") | DEPRECATED: Update partial or entire z. | +### adjoint -## Attributes + + +`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. + +### anticommutes + + + +`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. + +**Parameters** + +* **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – another Pauli operator. +* **qargs** (*list*) – qubits to apply dot product on (default: None). + +**Returns** + +True if Pauli’s anticommute, False if they commute. + +**Return type** + +bool + +### append\_paulis + + + +`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. + +**Parameters** + +* **paulis** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – the to-be-inserted or appended pauli +* **pauli\_labels** (*list\[str]*) – the to-be-inserted or appended pauli label + +**Returns** + +self + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### commutes + + + +`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. + +**Parameters** + +* **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another Pauli operator. +* **qargs** (*list*) – qubits to apply dot product on (default: None). + +**Returns** + +True if Pauli’s commute, False if they anti-commute. + +**Return type** + +bool + +### compose + + + +`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. + +**Parameters** + +* **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli object. +* **qargs** (*list or None*) – Optional, qubits to apply dot product on (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. +* **inplace** (*bool*) – If True update in-place (default: False). + +**Returns** + +The composed Pauli. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + +### copy + + + +`Pauli.copy()` + +Make a deep copy of current operator. + +### delete + + + +`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. + +**Parameters** + +**qubits** (*int or list*) – qubits to delete from Pauli. + +**Returns** + +the resulting Pauli with the specified qubits removed. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if ind is out of bounds for the array size or number of qubits. + +### delete\_qubits + + + +`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. + +This function is deprecated. Equivalent functionality can be obtained using the [`delete()`](qiskit.quantum_info.Pauli#delete "qiskit.quantum_info.Pauli.delete") method. + +**Parameters** + +**indices** (*list\[int]*) – the indices of to-be-deleted paulis + +**Returns** + +self + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### dot + + + +`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. + +**Parameters** + +* **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – an operator object. +* **qargs** (*list or None*) – Optional, qubits to apply dot product on (default: None). +* **inplace** (*bool*) – If True update in-place (default: False). + +**Returns** + +The operator self \* other. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### equiv + + + +`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. + +**Parameters** + +**other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – an operator object. + +**Returns** + +True if the Pauli’s are equivalent up to group phase. + +**Return type** + +bool + +### evolve + + + +`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. + +This returns the Pauli $P^\prime = C^\dagger.P.C$. + +**Parameters** + +* **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The Clifford operator to evolve by. +* **qargs** (*list*) – a list of qubits to apply the Clifford to. + +**Returns** + +the Pauli $C^\dagger.P.C$. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the Clifford number of qubits and qargs don’t match. + +### expand + + + +`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. + +**Parameters** + +**other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current Pauli, and $b$ is the other Pauli. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### from\_label + + + +`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. + +This function is deprecated use `Pauli(label)` instead. + +**Parameters** + +**label** (*str*) – Pauli string label. + +**Returns** + +the constructed Pauli. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +* **QiskitError** – If the input list is empty or contains invalid +* **Pauli strings.** – + +### input\_dims + + + +`Pauli.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### insert + + + +`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. + +**Parameters** + +* **qubits** (*int or list*) – qubits index to insert at. +* **value** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – value to insert. + +**Returns** + +the resulting Pauli with the entries inserted. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the insertion qubits are invalid. + +### insert\_paulis + + + +`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. + +This function is deprecated. Similar functionality can be obtained using the [`insert()`](qiskit.quantum_info.Pauli#insert "qiskit.quantum_info.Pauli.insert") method. + +If indices is None, it means append at the end. + +**Parameters** + +* **indices** (*list\[int]*) – the qubit indices to be inserted +* **paulis** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – the to-be-inserted or appended pauli +* **pauli\_labels** (*list\[str]*) – the to-be-inserted or appended pauli label + + + the indices refers to the location of original paulis, e.g. if indices = \[0, 2], pauli\_labels = \[‘Z’, ‘I’] and original pauli = ‘ZYXI’ the pauli will be updated to ZY’I’XI’Z’ ‘Z’ and ‘I’ are inserted before the qubit at 0 and 2. + + +**Returns** + +self + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** +**QiskitError** – provide both paulis and pauli\_labels at the same time + +### inverse + + + +`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. + +### kron + + + +`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. + +This function is deprecated. Use [`expand()`](qiskit.quantum_info.Pauli#expand "qiskit.quantum_info.Pauli.expand") instead. + +Order is \$P\_2 (other) otimes P\_1 (self)\$ + +**Parameters** + +**other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – P2 + +**Returns** + +self + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### output\_dims + + + +`Pauli.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### pauli\_single + + + +`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. + +**Parameters** + +* **num\_qubits** (*int*) – the length of pauli +* **index** (*int*) – the qubit index to insert the single qubit +* **pauli\_label** (*str*) – pauli + +**Returns** + +single qubit pauli + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### power + + + +`Pauli.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### random + + + +`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. + +This function is deprecated use [`random_pauli()`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli") instead. + +**Parameters** + +* **num\_qubits** (*int*) – the number of qubits +* **seed** (*int*) – Optional. To set a random seed. + +**Returns** + +the random pauli + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### reshape + + + +`Pauli.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### set\_truncation + + + +`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/ + +**Parameters** + +**val** (*int*) – the number of characters. + + + Truncation will be disabled if the truncation value is set to 0. + + +### sgn\_prod + + + +`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. + +This function is deprecated. The Pauli class now handles full Pauli group multiplication using [`compose()`](qiskit.quantum_info.Pauli#compose "qiskit.quantum_info.Pauli.compose") or [`dot()`](qiskit.quantum_info.Pauli#dot "qiskit.quantum_info.Pauli.dot"). + +\$P\_3 = P\_1 otimes P\_2\$: X\*Y + +**Parameters** + +* **p1** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – pauli 1 +* **p2** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – pauli 2 + +**Returns** + +the multiplied pauli (without phase) complex: the sign of the multiplication, 1, -1, 1j or -1j + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a Pauli object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current Pauli, and $b$ is the other Pauli. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`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. + +### to\_label + + + +`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. + + + The difference between to\_label and `__str__()` is that the later will truncate the output for large numbers of qubits. + + +**Returns** + +the Pauli string label. + +**Return type** + +str + +### to\_matrix + + + +`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. + +**Parameters** + +**sparse** (*bool*) – if True return sparse CSR matrices, otherwise return dense Numpy arrays (default: False). + +**Returns** + +The Pauli matrix. + +**Return type** + +array + +### to\_spmatrix + + + +`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). + +This function is deprecated. Use [`to_matrix()`](qiskit.quantum_info.Pauli#to_matrix "qiskit.quantum_info.Pauli.to_matrix") with kwarg `sparse=True` instead. + +**Returns** + +a sparse matrix with CSR format that represents the pauli. + +**Return type** + +scipy.sparse.csr\_matrix + +### transpose + + + +`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. + +### update\_x + + + +`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. + +This function is deprecated. Use the setter for `X` instead. + +**Parameters** + +* **x** (*numpy.ndarray or list*) – to-be-updated x +* **indices** (*numpy.ndarray or list or optional*) – to-be-updated qubit indices + +**Returns** + +self + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – when updating whole x, the number of qubits must be the same. + +### update\_z + + + +`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. + +This function is deprecated. Use the setter for `Z` instead. + +**Parameters** + +* **z** (*numpy.ndarray or list*) – to-be-updated z +* **indices** (*numpy.ndarray or list or optional*) – to-be-updated qubit indices + +**Returns** + +self + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – when updating whole z, the number of qubits must be the same. + +## Attributes + + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### phase Return the group phase exponent for the Pauli. - + ### qargs Return the qargs for the operator. - + ### settings @@ -170,14 +822,15 @@ Return settings. `Dict` - + ### x The x vector for the Pauli. - + ### z The z vector for the Pauli. + 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 3bea101ea5b..26f96fd2a3f 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliList.md @@ -1,14 +1,22 @@ -# PauliList +--- +title: PauliList +description: API reference for qiskit.quantum_info.PauliList +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.PauliList +--- +# PauliList + -`PauliList(data)` +`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` List of N-qubit Pauli operators. -This class is an efficient representation of a list of [`Pauli`](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") operators. It supports 1D numpy array indexing returning a [`Pauli`](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") for integer indexes or a [`PauliList`](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") for slice or list indices. +This class is an efficient representation of a list of [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") operators. It supports 1D numpy array indexing returning a [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") for integer indexes or a [`PauliList`](#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") for slice or list indices. **Initialization** @@ -16,11 +24,11 @@ A PauliList object can be initialized in several ways. > **`PauliList(list[str])`** > -> where strings are same representation with [`Pauli`](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"). +> where strings are same representation with [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"). > > **`PauliList(Pauli) and PauliList(list[Pauli])`** > -> where Pauli is [`Pauli`](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"). +> where Pauli is [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli"). > > **`PauliList.from_symplectic(z, x, phase)`** > @@ -80,13 +88,13 @@ Slice: PauliList(['XX', 'ZZ']) **Iteration** -Rows in the Pauli table can be iterated over like a list. Iteration can also be done using the label or matrix representation of each row using the [`label_iter()`](qiskit.quantum_info.PauliList.label_iter#qiskit.quantum_info.PauliList.label_iter "qiskit.quantum_info.PauliList.label_iter") and [`matrix_iter()`](qiskit.quantum_info.PauliList.matrix_iter#qiskit.quantum_info.PauliList.matrix_iter "qiskit.quantum_info.PauliList.matrix_iter") methods. +Rows in the Pauli table can be iterated over like a list. Iteration can also be done using the label or matrix representation of each row using the [`label_iter()`](qiskit.quantum_info.PauliList#label_iter "qiskit.quantum_info.PauliList.label_iter") and [`matrix_iter()`](qiskit.quantum_info.PauliList#matrix_iter "qiskit.quantum_info.PauliList.matrix_iter") methods. Initialize the PauliList. **Parameters** -**data** ([*Pauli*](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or list*) – input data for Paulis. If input is a list each item in the list must be a Pauli object or Pauli str. +**data** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or list*) – input data for Paulis. If input is a list each item in the list must be a Pauli object or Pauli str. **Raises** @@ -98,90 +106,708 @@ The input array is not copied so multiple Pauli tables can share the same underl ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.PauliList.adjoint#qiskit.quantum_info.PauliList.adjoint "qiskit.quantum_info.PauliList.adjoint") | Return the adjoint of each Pauli in the list. | -| [`anticommutes`](qiskit.quantum_info.PauliList.anticommutes#qiskit.quantum_info.PauliList.anticommutes "qiskit.quantum_info.PauliList.anticommutes") | Return True if other Pauli that anticommutes with other. | -| [`anticommutes_with_all`](qiskit.quantum_info.PauliList.anticommutes_with_all#qiskit.quantum_info.PauliList.anticommutes_with_all "qiskit.quantum_info.PauliList.anticommutes_with_all") | Return indexes of rows that commute other. | -| [`argsort`](qiskit.quantum_info.PauliList.argsort#qiskit.quantum_info.PauliList.argsort "qiskit.quantum_info.PauliList.argsort") | Return indices for sorting the rows of the table. | -| [`commutes`](qiskit.quantum_info.PauliList.commutes#qiskit.quantum_info.PauliList.commutes "qiskit.quantum_info.PauliList.commutes") | Return True for each Pauli that commutes with other. | -| [`commutes_with_all`](qiskit.quantum_info.PauliList.commutes_with_all#qiskit.quantum_info.PauliList.commutes_with_all "qiskit.quantum_info.PauliList.commutes_with_all") | Return indexes of rows that commute other. | -| [`compose`](qiskit.quantum_info.PauliList.compose#qiskit.quantum_info.PauliList.compose "qiskit.quantum_info.PauliList.compose") | Return the composition self∘other for each Pauli in the list. | -| [`conjugate`](qiskit.quantum_info.PauliList.conjugate#qiskit.quantum_info.PauliList.conjugate "qiskit.quantum_info.PauliList.conjugate") | Return the conjugate of each Pauli in the list. | -| [`copy`](qiskit.quantum_info.PauliList.copy#qiskit.quantum_info.PauliList.copy "qiskit.quantum_info.PauliList.copy") | Make a deep copy of current operator. | -| [`delete`](qiskit.quantum_info.PauliList.delete#qiskit.quantum_info.PauliList.delete "qiskit.quantum_info.PauliList.delete") | Return a copy with Pauli rows deleted from table. | -| [`dot`](qiskit.quantum_info.PauliList.dot#qiskit.quantum_info.PauliList.dot "qiskit.quantum_info.PauliList.dot") | Return the composition other∘self for each Pauli in the list. | -| [`equiv`](qiskit.quantum_info.PauliList.equiv#qiskit.quantum_info.PauliList.equiv "qiskit.quantum_info.PauliList.equiv") | Entrywise comparison of Pauli equivalence up to global phase. | -| [`evolve`](qiskit.quantum_info.PauliList.evolve#qiskit.quantum_info.PauliList.evolve "qiskit.quantum_info.PauliList.evolve") | Evolve the Pauli by a Clifford. | -| [`expand`](qiskit.quantum_info.PauliList.expand#qiskit.quantum_info.PauliList.expand "qiskit.quantum_info.PauliList.expand") | Return the expand product of each Pauli in the list. | -| [`from_symplectic`](qiskit.quantum_info.PauliList.from_symplectic#qiskit.quantum_info.PauliList.from_symplectic "qiskit.quantum_info.PauliList.from_symplectic") | Construct a PauliList from a symplectic data. | -| [`input_dims`](qiskit.quantum_info.PauliList.input_dims#qiskit.quantum_info.PauliList.input_dims "qiskit.quantum_info.PauliList.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`insert`](qiskit.quantum_info.PauliList.insert#qiskit.quantum_info.PauliList.insert "qiskit.quantum_info.PauliList.insert") | Insert Pauli’s into the table. | -| [`inverse`](qiskit.quantum_info.PauliList.inverse#qiskit.quantum_info.PauliList.inverse "qiskit.quantum_info.PauliList.inverse") | Return the inverse of each Pauli in the list. | -| [`label_iter`](qiskit.quantum_info.PauliList.label_iter#qiskit.quantum_info.PauliList.label_iter "qiskit.quantum_info.PauliList.label_iter") | Return a label representation iterator. | -| [`matrix_iter`](qiskit.quantum_info.PauliList.matrix_iter#qiskit.quantum_info.PauliList.matrix_iter "qiskit.quantum_info.PauliList.matrix_iter") | Return a matrix representation iterator. | -| [`output_dims`](qiskit.quantum_info.PauliList.output_dims#qiskit.quantum_info.PauliList.output_dims "qiskit.quantum_info.PauliList.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.PauliList.power#qiskit.quantum_info.PauliList.power "qiskit.quantum_info.PauliList.power") | Return the compose of a operator with itself n times. | -| [`reshape`](qiskit.quantum_info.PauliList.reshape#qiskit.quantum_info.PauliList.reshape "qiskit.quantum_info.PauliList.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`sort`](qiskit.quantum_info.PauliList.sort#qiskit.quantum_info.PauliList.sort "qiskit.quantum_info.PauliList.sort") | Sort the rows of the table. | -| [`tensor`](qiskit.quantum_info.PauliList.tensor#qiskit.quantum_info.PauliList.tensor "qiskit.quantum_info.PauliList.tensor") | Return the tensor product with each Pauli in the list. | -| [`to_labels`](qiskit.quantum_info.PauliList.to_labels#qiskit.quantum_info.PauliList.to_labels "qiskit.quantum_info.PauliList.to_labels") | Convert a PauliList to a list Pauli string labels. | -| [`to_matrix`](qiskit.quantum_info.PauliList.to_matrix#qiskit.quantum_info.PauliList.to_matrix "qiskit.quantum_info.PauliList.to_matrix") | Convert to a list or array of Pauli matrices. | -| [`transpose`](qiskit.quantum_info.PauliList.transpose#qiskit.quantum_info.PauliList.transpose "qiskit.quantum_info.PauliList.transpose") | Return the transpose of each Pauli in the list. | -| [`unique`](qiskit.quantum_info.PauliList.unique#qiskit.quantum_info.PauliList.unique "qiskit.quantum_info.PauliList.unique") | Return unique Paulis from the table. | +### adjoint -## Attributes + + +`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. + +### anticommutes + + + +`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. + +**Parameters** + +* **other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList operator. +* **qargs** (*list*) – qubits to apply dot product on (default: None). + +**Returns** + +True if Pauli’s anticommute, False if they commute. + +**Return type** + +bool + +### anticommutes\_with\_all + + + +`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. + +If other is a multi-row Pauli list the returned vector indexes rows of the current PauliList that anti-commute with *all* Pauli’s in other. If no rows satisfy the condition the returned array will be empty. + +**Parameters** + +**other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – a single Pauli or multi-row PauliList. + +**Returns** + +index array of the anti-commuting rows. + +**Return type** + +array + +### argsort + + + +`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. + +The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Pauli’s of a given weight are still ordered lexicographically. + +**Parameters** + +* **weight** (*bool*) – Optionally sort by weight if True (Default: False). +* **phase** (*bool*) – Optionally sort by phase before weight or order (Default: False). + +**Returns** + +the indices for sorting the table. + +**Return type** + +array + +### commutes + + + +`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. + +**Parameters** + +* **other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList operator. +* **qargs** (*list*) – qubits to apply dot product on (default: None). + +**Returns** + +True if Pauli’s commute, False if they anti-commute. + +**Return type** + +bool + +### commutes\_with\_all + + + +`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. + +If other is a multi-row Pauli list the returned vector indexes rows of the current PauliList that commute with *all* Pauli’s in other. If no rows satisfy the condition the returned array will be empty. + +**Parameters** + +**other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – a single Pauli or multi-row PauliList. + +**Returns** + +index array of the commuting rows. + +**Return type** + +array + +### compose + + + +`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. + +**Parameters** + +* **other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList. +* **qargs** (*None or list*) – qubits to apply dot product on (Default: None). +* **front** (*bool*) – If True use dot composition method \[default: False]. +* **inplace** (*bool*) – If True update in-place (default: False). + +**Returns** + +the list of composed Paulis. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list, or has the wrong number of qubits for the specified qargs. + +### conjugate + + + +`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. + +### copy + + + +`PauliList.copy()` + +Make a deep copy of current operator. + +### delete + + + +`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. + +When deleting qubits the qubit index is the same as the column index of the underlying `X` and `Z` arrays. + +**Parameters** + +* **ind** (*int or list*) – index(es) to delete. +* **qubit** (*bool*) – if True delete qubit columns, otherwise delete Pauli rows (Default: False). + +**Returns** + +the resulting table with the entries removed. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +**Raises** + +**QiskitError** – if ind is out of bounds for the array size or number of qubits. + +### dot + + + +`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. + +**Parameters** + +* **other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList. +* **qargs** (*None or list*) – qubits to apply dot product on (Default: None). +* **inplace** (*bool*) – If True update in-place (default: False). + +**Returns** + +the list of composed Paulis. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list, or has the wrong number of qubits for the specified qargs. + +### equiv + + + +`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. + +**Parameters** + +**other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") *or*[*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")) – a comparison object. + +**Returns** + +**An array of True or False for entrywise equivalence** + +of the current table. + +**Return type** + +np.ndarray + +### evolve + + + +`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. + +This returns the Pauli $P^\prime = C.P.C^\dagger$. + +**Parameters** + +* **other** ([*Pauli*](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") *or*[*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – The Clifford operator to evolve by. +* **qargs** (*list*) – a list of qubits to apply the Clifford to. + +**Returns** + +the Pauli $C.P.C^\dagger$. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the Clifford number of qubits and qargs don’t match. + +### expand + + + +`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. + +**Parameters** + +**other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList. + +**Returns** + +the list of tensor product Paulis. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list. + +### from\_symplectic + + + +`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. + +**Parameters** + +* **z** (*np.ndarray*) – 2D boolean Numpy array. +* **x** (*np.ndarray*) – 2D boolean Numpy array. +* **phase** (*np.ndarray or None*) – Optional, 1D integer array from Z\_4. + +**Returns** + +the constructed PauliList. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +### input\_dims + + + +`PauliList.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. +### insert + + +`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. + +When inserting qubits the qubit index is the same as the column index of the underlying `X` and `Z` arrays. + +**Parameters** + +* **ind** (*int*) – index to insert at. +* **value** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – values to insert. +* **qubit** (*bool*) – if True delete qubit columns, otherwise delete Pauli rows (Default: False). + +**Returns** + +the resulting table with the entries inserted. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +**Raises** + +**QiskitError** – if the insertion index is invalid. + +### inverse + + + +`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. + +### label\_iter + + + +`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. + +This is a lazy iterator that converts each row into the string label only as it is used. To convert the entire table to labels use the [`to_labels()`](qiskit.quantum_info.PauliList#to_labels "qiskit.quantum_info.PauliList.to_labels") method. + +**Returns** + +label iterator object for the PauliList. + +**Return type** + +LabelIterator + +### matrix\_iter + + + +`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. + +This is a lazy iterator that converts each row into the Pauli matrix representation only as it is used. To convert the entire table to matrices use the [`to_matrix()`](qiskit.quantum_info.PauliList#to_matrix "qiskit.quantum_info.PauliList.to_matrix") method. + +**Parameters** + +**sparse** (*bool*) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False) + +**Returns** + +matrix iterator object for the PauliList. + +**Return type** + +MatrixIterator + +### output\_dims + + + +`PauliList.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`PauliList.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### reshape + + + +`PauliList.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### sort + + + +`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. + +The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Pauli’s of a given weight are still ordered lexicographically. + +**Example** + +Consider sorting all a random ordering of all 2-qubit Paulis + +```python +from numpy.random import shuffle +from qiskit.quantum_info.operators import PauliList + +# 2-qubit labels +labels = ['II', 'IX', 'IY', 'IZ', 'XI', 'XX', 'XY', 'XZ', + 'YI', 'YX', 'YY', 'YZ', 'ZI', 'ZX', 'ZY', 'ZZ'] +# Shuffle Labels +shuffle(labels) +pt = PauliList(labels) +print('Initial Ordering') +print(pt) + +# Lexicographic Ordering +srt = pt.sort() +print('Lexicographically sorted') +print(srt) + +# Weight Ordering +srt = pt.sort(weight=True) +print('Weight sorted') +print(srt) +``` + +```python +Initial Ordering +['ZI', 'YY', 'ZX', 'II', 'IX', 'YZ', 'XY', 'YX', 'IY', 'ZY', 'ZZ', 'YI', + 'IZ', 'XX', 'XZ', 'XI'] +Lexicographically sorted +['II', 'IX', 'IY', 'IZ', 'XI', 'XX', 'XY', 'XZ', 'YI', 'YX', 'YY', 'YZ', + 'ZI', 'ZX', 'ZY', 'ZZ'] +Weight sorted +['II', 'IX', 'IY', 'IZ', 'XI', 'YI', 'ZI', 'XX', 'XY', 'XZ', 'YX', 'YY', + 'YZ', 'ZX', 'ZY', 'ZZ'] +``` + +**Parameters** + +* **weight** (*bool*) – optionally sort by weight if True (Default: False). +* **phase** (*bool*) – Optionally sort by phase before weight or order (Default: False). + +**Returns** + +a sorted copy of the original table. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +### tensor + + + +`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. + +**Parameters** + +**other** ([*PauliList*](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")) – another PauliList. + +**Returns** + +the list of tensor product Paulis. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliList, does not have either 1 or the same number of Paulis as the current list. + +### to\_labels + + + +`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. + +For large PauliLists converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance. + +| Label | Symplectic | Matrix | +| ----- | ---------- | ----------------------------------------------- | +| `"I"` | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ | +| `"X"` | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ | +| `"Y"` | $[1, 1]$ | $\begin{bmatrix} 0 & -i \\ i & 0 \end{bmatrix}$ | +| `"Z"` | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | + +**Parameters** + +**array** (*bool*) – return a Numpy array if True, otherwise return a list (Default: False). + +**Returns** + +The rows of the PauliList in label form. + +**Return type** + +list or array + +### to\_matrix + + + +`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. + +For large PauliLists converting using the `array=True` kwarg will be more efficient since it allocates memory a full rank-3 Numpy array of matrices in advance. + +| Label | Symplectic | Matrix | +| ----- | ---------- | ----------------------------------------------- | +| `"I"` | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ | +| `"X"` | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ | +| `"Y"` | $[1, 1]$ | $\begin{bmatrix} 0 & -i \\ i & 0 \end{bmatrix}$ | +| `"Z"` | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | + +**Parameters** + +* **sparse** (*bool*) – if True return sparse CSR matrices, otherwise return dense Numpy arrays (Default: False). +* **array** (*bool*) – return as rank-3 numpy array if True, otherwise return a list of Numpy arrays (Default: False). + +**Returns** + +A list of dense Pauli matrices if array=False and sparse=False. list: A list of sparse Pauli matrices if array=False and sparse=True. array: A dense rank-3 array of Pauli matrices if array=True. + +**Return type** + +list + +### transpose + + + +`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. + +### unique + + + +`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. + +**Example** + +```python +from qiskit.quantum_info.operators import PauliList + +pt = PauliList(['X', 'Y', '-X', 'I', 'I', 'Z', 'X', 'iZ']) +unique = pt.unique() +print(unique) +``` + +```python +['X', 'Y', '-X', 'I', 'Z', 'iZ'] +``` + +**Parameters** + +* **return\_index** (*bool*) – If True, also return the indices that result in the unique array. (Default: False) +* **return\_counts** (*bool*) – If True, also return the number of times each unique item appears in the table. + +**Returns** + +**unique** + +the table of the unique rows. + +**unique\_indices: np.ndarray, optional** + +The indices of the first occurrences of the unique values in the original array. Only provided if `return_index` is True. + +**unique\_counts: np.array, optional** + +The number of times each of the unique values comes up in the original array. Only provided if `return_counts` is True. + +**Return type** + +[PauliList](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList") + +## Attributes + + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### phase Return the phase exponent of the PauliList. - + ### qargs Return the qargs for the operator. - + ### settings Return operator settings. - + ### shape The full shape of the `array()` - + ### size The number of Pauli rows in the table. - + ### x The x array for the symplectic representation. - + ### z The z array for the symplectic representation. + 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 dd15ee22148..185722c7a25 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.PauliTable.md @@ -1,8 +1,16 @@ -# PauliTable +--- +title: PauliTable +description: API reference for qiskit.quantum_info.PauliTable +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.PauliTable +--- +# PauliTable + -`PauliTable(data)` +`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` @@ -32,11 +40,11 @@ $$ where each row is a block vector $[X_i, Z_i]$ with $X = [x_{i,0}, ..., x_{i,N-1}]$, $Z = [z_{i,0}, ..., z_{i,N-1}]$ is the symplectic representation of an N-qubit Pauli. This representation is based on reference \[1]. -PauliTable’s can be created from a list of labels using [`from_labels()`](qiskit.quantum_info.PauliTable.from_labels#qiskit.quantum_info.PauliTable.from_labels "qiskit.quantum_info.PauliTable.from_labels"), and converted to a list of labels or a list of matrices using [`to_labels()`](qiskit.quantum_info.PauliTable.to_labels#qiskit.quantum_info.PauliTable.to_labels "qiskit.quantum_info.PauliTable.to_labels") and [`to_matrix()`](qiskit.quantum_info.PauliTable.to_matrix#qiskit.quantum_info.PauliTable.to_matrix "qiskit.quantum_info.PauliTable.to_matrix") respectively. +PauliTable’s can be created from a list of labels using [`from_labels()`](qiskit.quantum_info.PauliTable#from_labels "qiskit.quantum_info.PauliTable.from_labels"), and converted to a list of labels or a list of matrices using [`to_labels()`](qiskit.quantum_info.PauliTable#to_labels "qiskit.quantum_info.PauliTable.to_labels") and [`to_matrix()`](qiskit.quantum_info.PauliTable#to_matrix "qiskit.quantum_info.PauliTable.to_matrix") respectively. **Group Product** -The Pauli’s in the Pauli table do not represent the full Pauli as they are restricted to having +1 phase. The dot-product for the Pauli’s is defined to discard any phase obtained from matrix multiplication so that we have $X.Z = Z.X = Y$, etc. This means that for the PauliTable class the operator methods [`compose()`](qiskit.quantum_info.PauliTable.compose#qiskit.quantum_info.PauliTable.compose "qiskit.quantum_info.PauliTable.compose") and [`dot()`](qiskit.quantum_info.PauliTable.dot#qiskit.quantum_info.PauliTable.dot "qiskit.quantum_info.PauliTable.dot") are equivalent. +The Pauli’s in the Pauli table do not represent the full Pauli as they are restricted to having +1 phase. The dot-product for the Pauli’s is defined to discard any phase obtained from matrix multiplication so that we have $X.Z = Z.X = Y$, etc. This means that for the PauliTable class the operator methods [`compose()`](qiskit.quantum_info.PauliTable#compose "qiskit.quantum_info.PauliTable.compose") and [`dot()`](qiskit.quantum_info.PauliTable#dot "qiskit.quantum_info.PauliTable.dot") are equivalent. | A.B | I | X | Y | Z | | ----- | - | - | - | - | @@ -55,7 +63,7 @@ Subsets of rows can be accessed using the list access `[]` operator and will ret **Iteration** -Rows in the Pauli table can be iterated over like a list. Iteration can also be done using the label or matrix representation of each row using the [`label_iter()`](qiskit.quantum_info.PauliTable.label_iter#qiskit.quantum_info.PauliTable.label_iter "qiskit.quantum_info.PauliTable.label_iter") and [`matrix_iter()`](qiskit.quantum_info.PauliTable.matrix_iter#qiskit.quantum_info.PauliTable.matrix_iter "qiskit.quantum_info.PauliTable.matrix_iter") methods. +Rows in the Pauli table can be iterated over like a list. Iteration can also be done using the label or matrix representation of each row using the [`label_iter()`](qiskit.quantum_info.PauliTable#label_iter "qiskit.quantum_info.PauliTable.label_iter") and [`matrix_iter()`](qiskit.quantum_info.PauliTable#matrix_iter "qiskit.quantum_info.PauliTable.matrix_iter") methods. ## References @@ -65,7 +73,7 @@ Initialize the PauliTable. **Parameters** -**data** (*array or str or* [*ScalarOp*](qiskit.quantum_info.ScalarOp#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") *or*[*PauliTable*](#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – input data. +**data** (*array or str or* [*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") *or*[*PauliTable*](#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – input data. **Raises** @@ -77,73 +85,681 @@ The input array is not copied so multiple Pauli tables can share the same underl ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.PauliTable.adjoint#qiskit.quantum_info.PauliTable.adjoint "qiskit.quantum_info.PauliTable.adjoint") | Return the adjoint of the Operator. | -| [`anticommutes_with_all`](qiskit.quantum_info.PauliTable.anticommutes_with_all#qiskit.quantum_info.PauliTable.anticommutes_with_all "qiskit.quantum_info.PauliTable.anticommutes_with_all") | Return indexes of rows that commute other. | -| [`argsort`](qiskit.quantum_info.PauliTable.argsort#qiskit.quantum_info.PauliTable.argsort "qiskit.quantum_info.PauliTable.argsort") | Return indices for sorting the rows of the table. | -| [`commutes`](qiskit.quantum_info.PauliTable.commutes#qiskit.quantum_info.PauliTable.commutes "qiskit.quantum_info.PauliTable.commutes") | Return list of commutation properties for each row with a Pauli. | -| [`commutes_with_all`](qiskit.quantum_info.PauliTable.commutes_with_all#qiskit.quantum_info.PauliTable.commutes_with_all "qiskit.quantum_info.PauliTable.commutes_with_all") | Return indexes of rows that commute other. | -| [`compose`](qiskit.quantum_info.PauliTable.compose#qiskit.quantum_info.PauliTable.compose "qiskit.quantum_info.PauliTable.compose") | Return the compose output product of two tables. | -| [`conjugate`](qiskit.quantum_info.PauliTable.conjugate#qiskit.quantum_info.PauliTable.conjugate "qiskit.quantum_info.PauliTable.conjugate") | Not implemented. | -| [`copy`](qiskit.quantum_info.PauliTable.copy#qiskit.quantum_info.PauliTable.copy "qiskit.quantum_info.PauliTable.copy") | Make a deep copy of current operator. | -| [`delete`](qiskit.quantum_info.PauliTable.delete#qiskit.quantum_info.PauliTable.delete "qiskit.quantum_info.PauliTable.delete") | Return a copy with Pauli rows deleted from table. | -| [`dot`](qiskit.quantum_info.PauliTable.dot#qiskit.quantum_info.PauliTable.dot "qiskit.quantum_info.PauliTable.dot") | Return the dot output product of two tables. | -| [`expand`](qiskit.quantum_info.PauliTable.expand#qiskit.quantum_info.PauliTable.expand "qiskit.quantum_info.PauliTable.expand") | Return the expand output product of two tables. | -| [`from_labels`](qiskit.quantum_info.PauliTable.from_labels#qiskit.quantum_info.PauliTable.from_labels "qiskit.quantum_info.PauliTable.from_labels") | Construct a PauliTable from a list of Pauli strings. | -| [`input_dims`](qiskit.quantum_info.PauliTable.input_dims#qiskit.quantum_info.PauliTable.input_dims "qiskit.quantum_info.PauliTable.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`insert`](qiskit.quantum_info.PauliTable.insert#qiskit.quantum_info.PauliTable.insert "qiskit.quantum_info.PauliTable.insert") | Insert Pauli’s into the table. | -| [`label_iter`](qiskit.quantum_info.PauliTable.label_iter#qiskit.quantum_info.PauliTable.label_iter "qiskit.quantum_info.PauliTable.label_iter") | Return a label representation iterator. | -| [`matrix_iter`](qiskit.quantum_info.PauliTable.matrix_iter#qiskit.quantum_info.PauliTable.matrix_iter "qiskit.quantum_info.PauliTable.matrix_iter") | Return a matrix representation iterator. | -| [`output_dims`](qiskit.quantum_info.PauliTable.output_dims#qiskit.quantum_info.PauliTable.output_dims "qiskit.quantum_info.PauliTable.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.PauliTable.power#qiskit.quantum_info.PauliTable.power "qiskit.quantum_info.PauliTable.power") | Return the compose of a operator with itself n times. | -| [`reshape`](qiskit.quantum_info.PauliTable.reshape#qiskit.quantum_info.PauliTable.reshape "qiskit.quantum_info.PauliTable.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`sort`](qiskit.quantum_info.PauliTable.sort#qiskit.quantum_info.PauliTable.sort "qiskit.quantum_info.PauliTable.sort") | Sort the rows of the table. | -| [`tensor`](qiskit.quantum_info.PauliTable.tensor#qiskit.quantum_info.PauliTable.tensor "qiskit.quantum_info.PauliTable.tensor") | Return the tensor output product of two tables. | -| [`to_labels`](qiskit.quantum_info.PauliTable.to_labels#qiskit.quantum_info.PauliTable.to_labels "qiskit.quantum_info.PauliTable.to_labels") | Convert a PauliTable to a list Pauli string labels. | -| [`to_matrix`](qiskit.quantum_info.PauliTable.to_matrix#qiskit.quantum_info.PauliTable.to_matrix "qiskit.quantum_info.PauliTable.to_matrix") | Convert to a list or array of Pauli matrices. | -| [`transpose`](qiskit.quantum_info.PauliTable.transpose#qiskit.quantum_info.PauliTable.transpose "qiskit.quantum_info.PauliTable.transpose") | Not implemented. | -| [`unique`](qiskit.quantum_info.PauliTable.unique#qiskit.quantum_info.PauliTable.unique "qiskit.quantum_info.PauliTable.unique") | Return unique Paulis from the table. | +### adjoint -## Attributes + + +`PauliTable.adjoint()` + +Return the adjoint of the Operator. + +### anticommutes\_with\_all + + + +`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. + +If other is a multi-row Pauli table the returned vector indexes rows of the current PauliTable that anti-commute with *all* Pauli’s in other. If no rows satisfy the condition the returned array will be empty. + +**Parameters** + +**other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – a single Pauli or multi-row PauliTable. + +**Returns** + +index array of the anti-commuting rows. + +**Return type** + +array + +### argsort + + + +`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. + +The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Pauli’s of a given weight are still ordered lexicographically. + +**Parameters** + +**weight** (*bool*) – optionally sort by weight if True (Default: False). + +**Returns** + +the indices for sorting the table. + +**Return type** + +array + +### commutes + + + +`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. + +The returned vector is the same length as the size of the table and contains True for rows that commute with the Pauli, and False for the rows that anti-commute. + +**Parameters** + +**pauli** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – a single Pauli row. + +**Returns** + +The boolean vector of which rows commute or anti-commute. + +**Return type** + +array + +**Raises** + +**QiskitError** – if input is not a single Pauli row. + +### commutes\_with\_all + + + +`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. + +If other is a multi-row Pauli table the returned vector indexes rows of the current PauliTable that commute with *all* Pauli’s in other. If no rows satisfy the condition the returned array will be empty. + +**Parameters** + +**other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – a single Pauli or multi-row PauliTable. + +**Returns** + +index array of the commuting rows. + +**Return type** + +array + +### compose + + + +`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. + +This returns the combination of the dot product of all Paulis in the current table with all Pauli’s in the other table and discards the complex phase from the product. Note that for PauliTables this method is equivalent to [`dot()`](qiskit.quantum_info.PauliTable#dot "qiskit.quantum_info.PauliTable.dot") and hence the `front` kwarg does not change the output. + +**Example** + +```python +from qiskit.quantum_info.operators import PauliTable + +current = PauliTable.from_labels(['I', 'X']) +other = PauliTable.from_labels(['Y', 'Z']) +print(current.compose(other)) +``` + +```python +PauliTable: ['Y', 'Z', 'Z', 'Y'] +``` + +**Parameters** + +* **other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – another PauliTable. +* **qargs** (*None or list*) – qubits to apply dot product on (Default: None). +* **front** (*bool*) – If True use dot composition method \[default: False]. + +**Returns** + +the compose outer product table. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliTable. + +### conjugate + + + +`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. + +### copy + + + +`PauliTable.copy()` + +Make a deep copy of current operator. +### delete + + +`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. + +When deleting qubits the qubit index is the same as the column index of the underlying [`X`](qiskit.quantum_info.PauliTable#x "qiskit.quantum_info.PauliTable.X") and [`Z`](qiskit.quantum_info.PauliTable#z "qiskit.quantum_info.PauliTable.Z") arrays. + +**Parameters** + +* **ind** (*int or list*) – index(es) to delete. +* **qubit** (*bool*) – if True delete qubit columns, otherwise delete Pauli rows (Default: False). + +**Returns** + +the resulting table with the entries removed. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +**Raises** + +**QiskitError** – if ind is out of bounds for the array size or number of qubits. + +### dot + + + +`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. + +This returns the combination of the dot product of all Paulis in the current table with all Pauli’s in the other table and discards the complex phase from the product. Note that for PauliTables this method is equivalent to [`compose()`](qiskit.quantum_info.PauliTable#compose "qiskit.quantum_info.PauliTable.compose"). + +**Example** + +```python +from qiskit.quantum_info.operators import PauliTable + +current = PauliTable.from_labels(['I', 'X']) +other = PauliTable.from_labels(['Y', 'Z']) +print(current.dot(other)) +``` + +```python +PauliTable: ['Y', 'Z', 'Z', 'Y'] +``` + +**Parameters** + +* **other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – another PauliTable. +* **qargs** (*None or list*) – qubits to apply dot product on (Default: None). + +**Returns** + +the dot outer product table. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliTable. + +### expand + + + +`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. + +This returns the combination of the tensor product of all Paulis in the other table with all Pauli’s in the current table, with the current tables qubits being the least-significant in the returned table. This is the opposite tensor order to [`tensor()`](qiskit.quantum_info.PauliTable#tensor "qiskit.quantum_info.PauliTable.tensor"). + +**Example** + +```python +from qiskit.quantum_info.operators import PauliTable + +current = PauliTable.from_labels(['I', 'X']) +other = PauliTable.from_labels(['Y', 'Z']) +print(current.expand(other)) +``` + +```python +PauliTable: ['YI', 'YX', 'ZI', 'ZX'] +``` + +**Parameters** + +**other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – another PauliTable. + +**Returns** + +the expand outer product table. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliTable. + +### from\_labels + + + +`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. + +**Parameters** + +**labels** (*list*) – Pauli string label(es). + +**Returns** + +the constructed PauliTable. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +**Raises** + +* **QiskitError** – If the input list is empty or contains invalid +* **Pauli strings.** – + +### input\_dims + + + +`PauliTable.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### insert + + + +`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. + +When inserting qubits the qubit index is the same as the column index of the underlying [`X`](qiskit.quantum_info.PauliTable#x "qiskit.quantum_info.PauliTable.X") and [`Z`](qiskit.quantum_info.PauliTable#z "qiskit.quantum_info.PauliTable.Z") arrays. + +**Parameters** + +* **ind** (*int*) – index to insert at. +* **value** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – values to insert. +* **qubit** (*bool*) – if True delete qubit columns, otherwise delete Pauli rows (Default: False). + +**Returns** + +the resulting table with the entries inserted. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +**Raises** + +**QiskitError** – if the insertion index is invalid. + +### label\_iter + + + +`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. + +This is a lazy iterator that converts each row into the string label only as it is used. To convert the entire table to labels use the [`to_labels()`](qiskit.quantum_info.PauliTable#to_labels "qiskit.quantum_info.PauliTable.to_labels") method. + +**Returns** + +label iterator object for the PauliTable. + +**Return type** + +LabelIterator + +### matrix\_iter + + + +`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. + +This is a lazy iterator that converts each row into the Pauli matrix representation only as it is used. To convert the entire table to matrices use the [`to_matrix()`](qiskit.quantum_info.PauliTable#to_matrix "qiskit.quantum_info.PauliTable.to_matrix") method. + +**Parameters** + +**sparse** (*bool*) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False) + +**Returns** + +matrix iterator object for the PauliTable. + +**Return type** + +MatrixIterator + +### output\_dims + + + +`PauliTable.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`PauliTable.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### reshape + + + +`PauliTable.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### sort + + + +`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. + +The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Pauli’s of a given weight are still ordered lexicographically. + +**Example** + +Consider sorting all a random ordering of all 2-qubit Paulis + +```python +from numpy.random import shuffle +from qiskit.quantum_info.operators import PauliTable + +# 2-qubit labels +labels = ['II', 'IX', 'IY', 'IZ', 'XI', 'XX', 'XY', 'XZ', + 'YI', 'YX', 'YY', 'YZ', 'ZI', 'ZX', 'ZY', 'ZZ'] +# Shuffle Labels +shuffle(labels) +pt = PauliTable.from_labels(labels) +print('Initial Ordering') +print(pt) + +# Lexicographic Ordering +srt = pt.sort() +print('Lexicographically sorted') +print(srt) + +# Weight Ordering +srt = pt.sort(weight=True) +print('Weight sorted') +print(srt) +``` + +```python +Initial Ordering +PauliTable: ['ZY', 'YY', 'XZ', 'IY', 'ZZ', 'XI', 'YZ', 'ZI', 'XX', 'IX', 'II', 'IZ', 'YX', 'YI', 'XY', 'ZX'] +Lexicographically sorted +PauliTable: ['II', 'IX', 'IY', 'IZ', 'XI', 'XX', 'XY', 'XZ', 'YI', 'YX', 'YY', 'YZ', 'ZI', 'ZX', 'ZY', 'ZZ'] +Weight sorted +PauliTable: ['II', 'IX', 'IY', 'IZ', 'XI', 'YI', 'ZI', 'XX', 'XY', 'XZ', 'YX', 'YY', 'YZ', 'ZX', 'ZY', 'ZZ'] +``` + +**Parameters** + +**weight** (*bool*) – optionally sort by weight if True (Default: False). + +**Returns** + +a sorted copy of the original table. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +### tensor + + + +`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. + +This returns the combination of the tensor product of all Paulis in the current table with all Pauli’s in the other table, with the other tables qubits being the least-significant in the returned table. This is the opposite tensor order to [`expand()`](qiskit.quantum_info.PauliTable#expand "qiskit.quantum_info.PauliTable.expand"). + +**Example** + +```python +from qiskit.quantum_info.operators import PauliTable + +current = PauliTable.from_labels(['I', 'X']) +other = PauliTable.from_labels(['Y', 'Z']) +print(current.tensor(other)) +``` + +```python +PauliTable: ['IY', 'IZ', 'XY', 'XZ'] +``` + +**Parameters** + +**other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – another PauliTable. + +**Returns** + +the tensor outer product table. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a PauliTable. + +### to\_labels + + + +`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. + +For large PauliTables converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance. + +| Label | Symplectic | Matrix | +| ----- | ---------- | ----------------------------------------------- | +| `"I"` | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ | +| `"X"` | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ | +| `"Y"` | $[1, 1]$ | $\begin{bmatrix} 0 & -i \\ i & 0 \end{bmatrix}$ | +| `"Z"` | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | + +**Parameters** + +**array** (*bool*) – return a Numpy array if True, otherwise return a list (Default: False). + +**Returns** + +The rows of the PauliTable in label form. + +**Return type** + +list or array + +### to\_matrix + + + +`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. + +For large PauliTables converting using the `array=True` kwarg will be more efficient since it allocates memory a full rank-3 Numpy array of matrices in advance. + +| Label | Symplectic | Matrix | +| ----- | ---------- | ----------------------------------------------- | +| `"I"` | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ | +| `"X"` | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ | +| `"Y"` | $[1, 1]$ | $\begin{bmatrix} 0 & -i \\ i & 0 \end{bmatrix}$ | +| `"Z"` | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | + +**Parameters** + +* **sparse** (*bool*) – if True return sparse CSR matrices, otherwise return dense Numpy arrays (Default: False). +* **array** (*bool*) – return as rank-3 numpy array if True, otherwise return a list of Numpy arrays (Default: False). + +**Returns** + +A list of dense Pauli matrices if array=False and sparse=False. list: A list of sparse Pauli matrices if array=False and sparse=True. array: A dense rank-3 array of Pauli matrices if array=True. + +**Return type** + +list + +### transpose + + + +`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. + +### unique + + + +`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. + +**Example** + +```python +from qiskit.quantum_info.operators import PauliTable + +pt = PauliTable.from_labels(['X', 'Y', 'X', 'I', 'I', 'Z', 'X', 'Z']) +unique = pt.unique() +print(unique) +``` + +```python +PauliTable: ['X', 'Y', 'I', 'Z'] +``` + +**Parameters** + +* **return\_index** (*bool*) – If True, also return the indices that result in the unique array. (Default: False) +* **return\_counts** (*bool*) – If True, also return the number of times each unique item appears in the table. + +**Returns** + +**unique** + +the table of the unique rows. + +**unique\_indices: np.ndarray, optional** + +The indices of the first occurrences of the unique values in the original array. Only provided if `return_index` is True. + +**unique\_counts: np.array, optional** + +The number of times each of the unique values comes up in the original array. Only provided if `return_counts` is True. + +**Return type** + +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + +## Attributes + + ### X The X block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). - + ### Z The Z block of the [`array`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array"). - + ### array The underlying boolean array. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### settings @@ -153,14 +769,15 @@ Return settings. `Dict` - + ### shape The full shape of the [`array()`](#qiskit.quantum_info.PauliTable.array "qiskit.quantum_info.PauliTable.array") - + ### size The number of Pauli rows in the table. + diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md index da3f6a934cf..ebd5cb973c2 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Quaternion.md @@ -1,8 +1,16 @@ -# Quaternion +--- +title: Quaternion +description: API reference for qiskit.quantum_info.Quaternion +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Quaternion +--- +# Quaternion + -`Quaternion(data)` +`Quaternion(data)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") Bases: `object` @@ -10,11 +18,109 @@ A class representing a Quaternion. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| [`from_axis_rotation`](qiskit.quantum_info.Quaternion.from_axis_rotation#qiskit.quantum_info.Quaternion.from_axis_rotation "qiskit.quantum_info.Quaternion.from_axis_rotation") | Return quaternion for rotation about given axis. | -| [`from_euler`](qiskit.quantum_info.Quaternion.from_euler#qiskit.quantum_info.Quaternion.from_euler "qiskit.quantum_info.Quaternion.from_euler") | Generate a quaternion from a set of Euler angles. | -| [`norm`](qiskit.quantum_info.Quaternion.norm#qiskit.quantum_info.Quaternion.norm "qiskit.quantum_info.Quaternion.norm") | Norm of quaternion. | -| [`normalize`](qiskit.quantum_info.Quaternion.normalize#qiskit.quantum_info.Quaternion.normalize "qiskit.quantum_info.Quaternion.normalize") | Normalizes a Quaternion to unit length so that it represents a valid rotation. | -| [`to_matrix`](qiskit.quantum_info.Quaternion.to_matrix#qiskit.quantum_info.Quaternion.to_matrix "qiskit.quantum_info.Quaternion.to_matrix") | Converts a unit-length quaternion to a rotation matrix. | -| [`to_zyz`](qiskit.quantum_info.Quaternion.to_zyz#qiskit.quantum_info.Quaternion.to_zyz "qiskit.quantum_info.Quaternion.to_zyz") | Converts a unit-length quaternion to a sequence of ZYZ Euler angles. | +### from\_axis\_rotation + + + +`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. + +**Parameters** + +* **angle** (*float*) – Angle in radians. +* **axis** (*str*) – Axis for rotation + +**Returns** + +Quaternion for axis rotation. + +**Return type** + +[Quaternion](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion") + +**Raises** + +**ValueError** – Invalid input axis. + +### from\_euler + + + +`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. + +**Parameters** + +* **angles** (*array\_like*) – Array of Euler angles. +* **order** (*str*) – Order of Euler rotations. ‘yzy’ is default. + +**Returns** + +Quaternion representation of Euler rotation. + +**Return type** + +[Quaternion](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion") + +### norm + + + +`Quaternion.norm()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/quaternion.py "view source code") + +Norm of quaternion. + +### normalize + + + +`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. + +**Parameters** + +**inplace** (*bool*) – Do an inplace normalization. + +**Returns** + +Normalized quaternion. + +**Return type** + +[Quaternion](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion") + +### to\_matrix + + + +`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. + +**Returns** + +Rotation matrix. + +**Return type** + +ndarray + +### to\_zyz + + + +`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. + +**Returns** + +Array of Euler angles. + +**Return type** + +ndarray + 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 4ee762aff15..4580365d9cc 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.ScalarOp.md @@ -1,14 +1,22 @@ -# ScalarOp +--- +title: ScalarOp +description: API reference for qiskit.quantum_info.ScalarOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.ScalarOp +--- +# ScalarOp + -`ScalarOp(dims=None, coeff=1)` +`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` Scalar identity operator class. -This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](qiskit.quantum_info.ScalarOp.compose#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](qiskit.quantum_info.ScalarOp.dot#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](qiskit.quantum_info.ScalarOp.tensor#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](qiskit.quantum_info.ScalarOp.expand#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") methods. +This is a symbolic representation of an scalar identity operator on multiple subsystems. It may be used to initialize a symbolic scalar multiplication of an identity and then be implicitly converted to other kinds of operator subclasses by using the [`compose()`](qiskit.quantum_info.ScalarOp#compose "qiskit.quantum_info.ScalarOp.compose"), [`dot()`](qiskit.quantum_info.ScalarOp#dot "qiskit.quantum_info.ScalarOp.dot"), [`tensor()`](qiskit.quantum_info.ScalarOp#tensor "qiskit.quantum_info.ScalarOp.tensor"), [`expand()`](qiskit.quantum_info.ScalarOp#expand "qiskit.quantum_info.ScalarOp.expand") methods. Initialize an operator object. @@ -23,64 +31,266 @@ Initialize an operator object. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.ScalarOp.adjoint#qiskit.quantum_info.ScalarOp.adjoint "qiskit.quantum_info.ScalarOp.adjoint") | Return the adjoint of the Operator. | -| [`compose`](qiskit.quantum_info.ScalarOp.compose#qiskit.quantum_info.ScalarOp.compose "qiskit.quantum_info.ScalarOp.compose") | Return the operator composition with another ScalarOp. | -| [`conjugate`](qiskit.quantum_info.ScalarOp.conjugate#qiskit.quantum_info.ScalarOp.conjugate "qiskit.quantum_info.ScalarOp.conjugate") | Return the conjugate of the ScalarOp. | -| [`copy`](qiskit.quantum_info.ScalarOp.copy#qiskit.quantum_info.ScalarOp.copy "qiskit.quantum_info.ScalarOp.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.ScalarOp.dot#qiskit.quantum_info.ScalarOp.dot "qiskit.quantum_info.ScalarOp.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.ScalarOp.expand#qiskit.quantum_info.ScalarOp.expand "qiskit.quantum_info.ScalarOp.expand") | Return the reverse-order tensor product with another ScalarOp. | -| [`input_dims`](qiskit.quantum_info.ScalarOp.input_dims#qiskit.quantum_info.ScalarOp.input_dims "qiskit.quantum_info.ScalarOp.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_unitary`](qiskit.quantum_info.ScalarOp.is_unitary#qiskit.quantum_info.ScalarOp.is_unitary "qiskit.quantum_info.ScalarOp.is_unitary") | Return True if operator is a unitary matrix. | -| [`output_dims`](qiskit.quantum_info.ScalarOp.output_dims#qiskit.quantum_info.ScalarOp.output_dims "qiskit.quantum_info.ScalarOp.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.ScalarOp.power#qiskit.quantum_info.ScalarOp.power "qiskit.quantum_info.ScalarOp.power") | Return the power of the ScalarOp. | -| [`reshape`](qiskit.quantum_info.ScalarOp.reshape#qiskit.quantum_info.ScalarOp.reshape "qiskit.quantum_info.ScalarOp.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.ScalarOp.tensor#qiskit.quantum_info.ScalarOp.tensor "qiskit.quantum_info.ScalarOp.tensor") | Return the tensor product with another ScalarOp. | -| [`to_matrix`](qiskit.quantum_info.ScalarOp.to_matrix#qiskit.quantum_info.ScalarOp.to_matrix "qiskit.quantum_info.ScalarOp.to_matrix") | Convert to a Numpy matrix. | -| [`to_operator`](qiskit.quantum_info.ScalarOp.to_operator#qiskit.quantum_info.ScalarOp.to_operator "qiskit.quantum_info.ScalarOp.to_operator") | Convert to an Operator object. | -| [`transpose`](qiskit.quantum_info.ScalarOp.transpose#qiskit.quantum_info.ScalarOp.transpose "qiskit.quantum_info.ScalarOp.transpose") | Return the transpose of the ScalarOp. | +### adjoint -## Attributes + + +`ScalarOp.adjoint()` + +Return the adjoint of the Operator. + +### compose + + + +`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. + +**Parameters** + +* **other** ([*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – a ScalarOp object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed ScalarOp. + +**Return type** + +[ScalarOp](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.ScalarOp#dot "qiskit.quantum_info.ScalarOp.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.ScalarOp#dot "qiskit.quantum_info.ScalarOp.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + +### copy + + + +`ScalarOp.copy()` + +Make a deep copy of current operator. + +### dot + + + +`ScalarOp.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – a ScalarOp object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current ScalarOp, and $b$ is the other ScalarOp. + +**Return type** + +[ScalarOp](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") + +### input\_dims + + + +`ScalarOp.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_unitary + + + +`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. + +### output\_dims + +`ScalarOp.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`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. + +**Parameters** + +**n** (*float*) – the exponent for the scalar op. + +**Returns** + +the `coeff ** n` ScalarOp. + +**Return type** + +[ScalarOp](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") + +### reshape + + + +`ScalarOp.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*ScalarOp*](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")) – a ScalarOp object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current ScalarOp, and $b$ is the other ScalarOp. + +**Return type** + +[ScalarOp](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_matrix + + + +`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. + +### to\_operator + + + +`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. + +### transpose + + + +`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. + +## Attributes + + ### atol `= 1e-08` - + ### coeff Return the coefficient - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 c4e5a87154e..b72250d6dc1 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.SparsePauliOp.md @@ -1,24 +1,32 @@ -# SparsePauliOp +--- +title: SparsePauliOp +description: API reference for qiskit.quantum_info.SparsePauliOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.SparsePauliOp +--- +# SparsePauliOp + -`SparsePauliOp(data, coeffs=None)` +`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` Sparse N-qubit operator in a Pauli basis representation. -This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. +This is a sparse representation of an N-qubit matrix [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") in terms of N-qubit [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") and complex coefficients. It can be used for performing operator arithmetic for hundred of qubits if the number of non-zero Pauli basis terms is sufficiently small. -The Pauli basis components are stored as a [`PauliTable`](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") object and can be accessed using the [`table`](#qiskit.quantum_info.SparsePauliOp.table "qiskit.quantum_info.SparsePauliOp.table") attribute. The coefficients are stored as a complex Numpy array vector and can be accessed using the [`coeffs`](#qiskit.quantum_info.SparsePauliOp.coeffs "qiskit.quantum_info.SparsePauliOp.coeffs") attribute. +The Pauli basis components are stored as a [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") object and can be accessed using the [`table`](#qiskit.quantum_info.SparsePauliOp.table "qiskit.quantum_info.SparsePauliOp.table") attribute. The coefficients are stored as a complex Numpy array vector and can be accessed using the [`coeffs`](#qiskit.quantum_info.SparsePauliOp.coeffs "qiskit.quantum_info.SparsePauliOp.coeffs") attribute. Initialize an operator object. **Parameters** -* **data** ([*PauliTable*](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – Pauli table of terms. +* **data** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – Pauli table of terms. * **coeffs** (*np.ndarray*) – complex coefficients for Pauli terms. **Raises** @@ -27,69 +35,412 @@ Initialize an operator object. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.SparsePauliOp.adjoint#qiskit.quantum_info.SparsePauliOp.adjoint "qiskit.quantum_info.SparsePauliOp.adjoint") | Return the adjoint of the Operator. | -| [`compose`](qiskit.quantum_info.SparsePauliOp.compose#qiskit.quantum_info.SparsePauliOp.compose "qiskit.quantum_info.SparsePauliOp.compose") | Return the operator composition with another SparsePauliOp. | -| [`conjugate`](qiskit.quantum_info.SparsePauliOp.conjugate#qiskit.quantum_info.SparsePauliOp.conjugate "qiskit.quantum_info.SparsePauliOp.conjugate") | Return the conjugate of the SparsePauliOp. | -| [`copy`](qiskit.quantum_info.SparsePauliOp.copy#qiskit.quantum_info.SparsePauliOp.copy "qiskit.quantum_info.SparsePauliOp.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.SparsePauliOp.dot#qiskit.quantum_info.SparsePauliOp.dot "qiskit.quantum_info.SparsePauliOp.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.SparsePauliOp.expand#qiskit.quantum_info.SparsePauliOp.expand "qiskit.quantum_info.SparsePauliOp.expand") | Return the reverse-order tensor product with another SparsePauliOp. | -| [`from_list`](qiskit.quantum_info.SparsePauliOp.from_list#qiskit.quantum_info.SparsePauliOp.from_list "qiskit.quantum_info.SparsePauliOp.from_list") | Construct from a list \[(pauli\_str, coeffs)] | -| [`from_operator`](qiskit.quantum_info.SparsePauliOp.from_operator#qiskit.quantum_info.SparsePauliOp.from_operator "qiskit.quantum_info.SparsePauliOp.from_operator") | Construct from an Operator objector. | -| [`input_dims`](qiskit.quantum_info.SparsePauliOp.input_dims#qiskit.quantum_info.SparsePauliOp.input_dims "qiskit.quantum_info.SparsePauliOp.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_unitary`](qiskit.quantum_info.SparsePauliOp.is_unitary#qiskit.quantum_info.SparsePauliOp.is_unitary "qiskit.quantum_info.SparsePauliOp.is_unitary") | Return True if operator is a unitary matrix. | -| [`label_iter`](qiskit.quantum_info.SparsePauliOp.label_iter#qiskit.quantum_info.SparsePauliOp.label_iter "qiskit.quantum_info.SparsePauliOp.label_iter") | Return a label representation iterator. | -| [`matrix_iter`](qiskit.quantum_info.SparsePauliOp.matrix_iter#qiskit.quantum_info.SparsePauliOp.matrix_iter "qiskit.quantum_info.SparsePauliOp.matrix_iter") | Return a matrix representation iterator. | -| [`output_dims`](qiskit.quantum_info.SparsePauliOp.output_dims#qiskit.quantum_info.SparsePauliOp.output_dims "qiskit.quantum_info.SparsePauliOp.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.SparsePauliOp.power#qiskit.quantum_info.SparsePauliOp.power "qiskit.quantum_info.SparsePauliOp.power") | Return the compose of a operator with itself n times. | -| [`reshape`](qiskit.quantum_info.SparsePauliOp.reshape#qiskit.quantum_info.SparsePauliOp.reshape "qiskit.quantum_info.SparsePauliOp.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`simplify`](qiskit.quantum_info.SparsePauliOp.simplify#qiskit.quantum_info.SparsePauliOp.simplify "qiskit.quantum_info.SparsePauliOp.simplify") | Simplify PauliTable by combining duplicates and removing zeros. | -| [`tensor`](qiskit.quantum_info.SparsePauliOp.tensor#qiskit.quantum_info.SparsePauliOp.tensor "qiskit.quantum_info.SparsePauliOp.tensor") | Return the tensor product with another SparsePauliOp. | -| [`to_list`](qiskit.quantum_info.SparsePauliOp.to_list#qiskit.quantum_info.SparsePauliOp.to_list "qiskit.quantum_info.SparsePauliOp.to_list") | Convert to a list Pauli string labels and coefficients. | -| [`to_matrix`](qiskit.quantum_info.SparsePauliOp.to_matrix#qiskit.quantum_info.SparsePauliOp.to_matrix "qiskit.quantum_info.SparsePauliOp.to_matrix") | Convert to a dense or sparse matrix. | -| [`to_operator`](qiskit.quantum_info.SparsePauliOp.to_operator#qiskit.quantum_info.SparsePauliOp.to_operator "qiskit.quantum_info.SparsePauliOp.to_operator") | Convert to a matrix Operator object | -| [`transpose`](qiskit.quantum_info.SparsePauliOp.transpose#qiskit.quantum_info.SparsePauliOp.transpose "qiskit.quantum_info.SparsePauliOp.transpose") | Return the transpose of the SparsePauliOp. | +### adjoint -## Attributes + + +`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. + +### compose + + + +`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. + +**Parameters** + +* **other** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – a SparsePauliOp object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed SparsePauliOp. + +**Return type** + +[SparsePauliOp](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.SparsePauliOp#dot "qiskit.quantum_info.SparsePauliOp.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.SparsePauliOp#dot "qiskit.quantum_info.SparsePauliOp.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + +### copy + + + +`SparsePauliOp.copy()` + +Make a deep copy of current operator. + +### dot + + + +`SparsePauliOp.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – a SparsePauliOp object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current SparsePauliOp, and $b$ is the other SparsePauliOp. + +**Return type** + +[SparsePauliOp](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") + +### from\_list + + + +`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)] + +### from\_operator + + + +`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. + +Note that the cost of this construction is exponential as it involves taking inner products with every element of the N-qubit Pauli basis. + +**Parameters** + +* **obj** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an N-qubit operator. +* **atol** (*float*) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). +* **rtol** (*float*) – Optional. relative tolerance for checking if coefficients are zero (Default: 1e-5). + +**Returns** + +the SparsePauliOp representation of the operator. + +**Return type** + +[SparsePauliOp](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") + +**Raises** + +**QiskitError** – if the input operator is not an N-qubit operator. + +### input\_dims + + + +`SparsePauliOp.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_unitary + + + +`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. + +**Parameters** + +* **atol** (*float*) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). +* **rtol** (*float*) – Optional. relative tolerance for checking if coefficients are zero (Default: 1e-5). + +**Returns** + +True if the operator is unitary, False otherwise. + +**Return type** + +bool + +### label\_iter + + + +`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. + +This is a lazy iterator that converts each term in the SparsePauliOp into a tuple (label, coeff). To convert the entire table to labels use the `to_labels()` method. + +**Returns** + +label iterator object for the PauliTable. + +**Return type** + +LabelIterator + +### matrix\_iter + + + +`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. + +This is a lazy iterator that converts each term in the SparsePauliOp into a matrix as it is used. To convert to a single matrix use the [`to_matrix()`](qiskit.quantum_info.SparsePauliOp#to_matrix "qiskit.quantum_info.SparsePauliOp.to_matrix") method. + +**Parameters** + +**sparse** (*bool*) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False) +**Returns** +matrix iterator object for the PauliTable. + +**Return type** + +MatrixIterator + +### output\_dims + + + +`SparsePauliOp.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`SparsePauliOp.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### reshape + + + +`SparsePauliOp.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### simplify + + + +`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. + +**Parameters** + +* **atol** (*float*) – Optional. Absolute tolerance for checking if coefficients are zero (Default: 1e-8). +* **rtol** (*float*) – Optional. relative tolerance for checking if coefficients are zero (Default: 1e-5). + +**Returns** + +the simplified SparsePauliOp operator. + +**Return type** + +[SparsePauliOp](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") + +### tensor + + + +`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. + +**Parameters** + +**other** ([*SparsePauliOp*](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")) – a SparsePauliOp object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current SparsePauliOp, and $b$ is the other SparsePauliOp. + +**Return type** + +[SparsePauliOp](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_list + + + +`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. + +For operators with a lot of terms converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance. + +**Parameters** + +**array** (*bool*) – return a Numpy array if True, otherwise return a list (Default: False). + +**Returns** + +List of pairs (label, coeff) for rows of the PauliTable. + +**Return type** + +list or array + +### to\_matrix + + + +`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. + +**Parameters** + +**sparse** (*bool*) – if True return a sparse CSR matrix, otherwise return dense Numpy array (Default: False). + +**Returns** + +A dense matrix if sparse=False. csr\_matrix: A sparse matrix in CSR format if sparse=True. + +**Return type** + +array + +### to\_operator + + + +`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 + +### transpose + + + +`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. + +## Attributes + + ### atol `= 1e-08` - + ### coeffs Return the Pauli coefficients. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings @@ -99,14 +450,15 @@ Return settings. `Dict` - + ### size The number of Pauli of Pauli terms in the operator. - + ### table Return the the PauliTable. + 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 17bd153a007..9261a3fd8eb 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerState.md @@ -1,12 +1,20 @@ -# StabilizerState +--- +title: StabilizerState +description: API reference for qiskit.quantum_info.StabilizerState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.StabilizerState +--- +# StabilizerState + -`StabilizerState(data, validate=True)` +`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` -StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford#qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). +StabilizerState class. Stabilizer simulator using the convention from reference \[1]. Based on the internal class [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford"). ```python from qiskit import QuantumCircuit @@ -47,43 +55,356 @@ Initialize a StabilizerState object. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| [`conjugate`](qiskit.quantum_info.StabilizerState.conjugate#qiskit.quantum_info.StabilizerState.conjugate "qiskit.quantum_info.StabilizerState.conjugate") | Return the conjugate of the operator. | -| [`copy`](qiskit.quantum_info.StabilizerState.copy#qiskit.quantum_info.StabilizerState.copy "qiskit.quantum_info.StabilizerState.copy") | Make a copy of current operator. | -| [`dims`](qiskit.quantum_info.StabilizerState.dims#qiskit.quantum_info.StabilizerState.dims "qiskit.quantum_info.StabilizerState.dims") | Return tuple of input dimension for specified subsystems. | -| [`evolve`](qiskit.quantum_info.StabilizerState.evolve#qiskit.quantum_info.StabilizerState.evolve "qiskit.quantum_info.StabilizerState.evolve") | Evolve a stabilizer state by a Clifford operator. | -| [`expand`](qiskit.quantum_info.StabilizerState.expand#qiskit.quantum_info.StabilizerState.expand "qiskit.quantum_info.StabilizerState.expand") | Return the tensor product stabilzier state other ⊗ self. | -| [`expectation_value`](qiskit.quantum_info.StabilizerState.expectation_value#qiskit.quantum_info.StabilizerState.expectation_value "qiskit.quantum_info.StabilizerState.expectation_value") | Compute the expectation value of an operator. | -| [`is_valid`](qiskit.quantum_info.StabilizerState.is_valid#qiskit.quantum_info.StabilizerState.is_valid "qiskit.quantum_info.StabilizerState.is_valid") | Return True if a valid StabilizerState. | -| [`measure`](qiskit.quantum_info.StabilizerState.measure#qiskit.quantum_info.StabilizerState.measure "qiskit.quantum_info.StabilizerState.measure") | Measure subsystems and return outcome and post-measure state. | -| [`probabilities`](qiskit.quantum_info.StabilizerState.probabilities#qiskit.quantum_info.StabilizerState.probabilities "qiskit.quantum_info.StabilizerState.probabilities") | Return the subsystem measurement probability vector. | -| [`probabilities_dict`](qiskit.quantum_info.StabilizerState.probabilities_dict#qiskit.quantum_info.StabilizerState.probabilities_dict "qiskit.quantum_info.StabilizerState.probabilities_dict") | Return the subsystem measurement probability dictionary. | -| [`purity`](qiskit.quantum_info.StabilizerState.purity#qiskit.quantum_info.StabilizerState.purity "qiskit.quantum_info.StabilizerState.purity") | Return the purity of the quantum state, which equals to 1, since it is always a pure state. | -| [`reset`](qiskit.quantum_info.StabilizerState.reset#qiskit.quantum_info.StabilizerState.reset "qiskit.quantum_info.StabilizerState.reset") | Reset state or subsystems to the 0-state. | -| [`sample_counts`](qiskit.quantum_info.StabilizerState.sample_counts#qiskit.quantum_info.StabilizerState.sample_counts "qiskit.quantum_info.StabilizerState.sample_counts") | Sample a dict of qubit measurement outcomes in the computational basis. | -| [`sample_memory`](qiskit.quantum_info.StabilizerState.sample_memory#qiskit.quantum_info.StabilizerState.sample_memory "qiskit.quantum_info.StabilizerState.sample_memory") | Sample a list of qubit measurement outcomes in the computational basis. | -| [`seed`](qiskit.quantum_info.StabilizerState.seed#qiskit.quantum_info.StabilizerState.seed "qiskit.quantum_info.StabilizerState.seed") | Set the seed for the quantum state RNG. | -| [`tensor`](qiskit.quantum_info.StabilizerState.tensor#qiskit.quantum_info.StabilizerState.tensor "qiskit.quantum_info.StabilizerState.tensor") | Return the tensor product stabilzier state self ⊗ other. | -| [`to_operator`](qiskit.quantum_info.StabilizerState.to_operator#qiskit.quantum_info.StabilizerState.to_operator "qiskit.quantum_info.StabilizerState.to_operator") | Convert state to matrix operator class | -| [`trace`](qiskit.quantum_info.StabilizerState.trace#qiskit.quantum_info.StabilizerState.trace "qiskit.quantum_info.StabilizerState.trace") | Return the trace of the stabilizer state as a density matrix, which equals to 1, since it is always a pure state. | +### conjugate -## Attributes + + +`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. + +### copy + + + +`StabilizerState.copy()` + +Make a copy of current operator. + +### dims + + + +`StabilizerState.dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### evolve + + + +`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. + +**Parameters** + +* **other** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction")) – The Clifford operator to evolve by. +* **qargs** (*list*) – a list of stabilizer subsystem positions to apply the operator on. + +**Returns** + +the output stabilizer state. + +**Return type** + +[StabilizerState](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") + +**Raises** + +* **QiskitError** – if other is not a StabilizerState. +* **QiskitError** – if the operator dimension does not match the specified StabilizerState subsystem dimensions. + +### expand + + + +`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. + +**Parameters** + +**other** ([*StabilizerState*](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState")) – a stabilizer state object. + +**Returns** + +the tensor product operator other ⊗ self. + +**Return type** + +[StabilizerState](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") + +**Raises** + +**QiskitError** – if other is not a StabilizerState. + +### expectation\_value + + + +`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. + +**Parameters** + +* **oper** (*BaseOperator*) – an operator to evaluate expval. +* **qargs** (*None or list*) – subsystems to apply the operator on. + +**Returns** + +the expectation value (only 0 or 1 or -1). + +**Return type** + +complex + +### is\_valid + + + +`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. + +### measure + + + +`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. + +Note that this function uses the QuantumStates internal random number generator for sampling the measurement outcome. The RNG seed can be set using the [`seed()`](qiskit.quantum_info.StabilizerState#seed "qiskit.quantum_info.StabilizerState.seed") method. + +**Parameters** + +**qargs** (*list or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +**the pair `(outcome, state)` where `outcome` is the** + +measurement outcome string label, and `state` is the collapsed post-measurement stabilizer state for the corresponding outcome. + +**Return type** + +tuple + +### probabilities + + + +`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. + +Measurement probabilities are with respect to measurement in the computation (diagonal) basis. + +**Parameters** + +* **qargs** (*None or list*) – subsystems to return probabilities for, if None return for all subsystems (Default: None). +* **decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). + +**Returns** + +The Numpy vector array of probabilities. + +**Return type** + +np.array + +### probabilities\_dict + + + +`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. + +Measurement probabilities are with respect to measurement in the computation (diagonal) basis. + +This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. + +**Parameters** + +* **qargs** (*None or list*) – subsystems to return probabilities for, if None return for all subsystems (Default: None). +* **decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). +**Returns** +The measurement probabilities in dict (ket) form. + +**Return type** + +dict + +### purity + + + +`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. + +**Returns** + +the purity (should equal 1). + +**Return type** + +double + +**Raises** + +**QiskitError** – if input is not a StabilizerState. + +### reset + + + +`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. + +**Parameters** + +**qargs** (*list or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). + +**Returns** + +the reset state. + +**Return type** + +[StabilizerState](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") + +#### Additional Information: + +If all subsystems are reset this will return the ground state on all subsystems. If only some subsystems are reset this function will perform a measurement on those subsystems and evolve the subsystems so that the collapsed post-measurement states are rotated to the 0-state. The RNG seed for this sampling can be set using the [`seed()`](qiskit.quantum_info.StabilizerState#seed "qiskit.quantum_info.StabilizerState.seed") method. + +### sample\_counts + + + +`StabilizerState.sample_counts(shots, qargs=None)` + +Sample a dict of qubit measurement outcomes in the computational basis. + +**Parameters** + +* **shots** (*int*) – number of samples to generate. +* **qargs** (*None or list*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +sampled counts dictionary. + +**Return type** + +[Counts](qiskit.result.Counts "qiskit.result.Counts") + +Additional Information: + +> This function *samples* measurement outcomes using the measure [`probabilities()`](qiskit.quantum_info.StabilizerState#probabilities "qiskit.quantum_info.StabilizerState.probabilities") for the current state and qargs. It does not actually implement the measurement so the current state is not modified. +> +> The seed for random number generator used for sampling can be set to a fixed value by using the stats [`seed()`](qiskit.quantum_info.StabilizerState#seed "qiskit.quantum_info.StabilizerState.seed") method. + +### sample\_memory + + + +`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. + +**Parameters** + +* **shots** (*int*) – number of samples to generate. +* **qargs** (*None or list*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +list of sampled counts if the order sampled. + +**Return type** + +np.array + +Additional Information: + +> This function implements the measurement [`measure()`](qiskit.quantum_info.StabilizerState#measure "qiskit.quantum_info.StabilizerState.measure") method. +> +> The seed for random number generator used for sampling can be set to a fixed value by using the stats [`seed()`](qiskit.quantum_info.StabilizerState#seed "qiskit.quantum_info.StabilizerState.seed") method. + +### seed + + + +`StabilizerState.seed(value=None)` + +Set the seed for the quantum state RNG. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*StabilizerState*](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState")) – a stabilizer state object. + +**Returns** + +the tensor product operator self ⊗ other. + +**Return type** + +[StabilizerState](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState") + +**Raises** + +**QiskitError** – if other is not a StabilizerState. + +### to\_operator + + + +`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 + +### trace + + + +`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. + +**Returns** + +the trace (should equal 1). + +**Return type** + +double + +**Raises** + +**QiskitError** – if input is not a StabilizerState. + +## Attributes + + ### clifford Return StabilizerState Clifford data - + ### dim Return total state dimension. - + ### num\_qubits Return the number of qubits if a N-qubit state or None otherwise. + 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 10f748d6530..8d6bdf87a83 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.StabilizerTable.md @@ -1,8 +1,16 @@ -# StabilizerTable +--- +title: StabilizerTable +description: API reference for qiskit.quantum_info.StabilizerTable +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.StabilizerTable +--- +# StabilizerTable + -`StabilizerTable(data, phase=None)` +`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` @@ -23,7 +31,7 @@ The symplectic representation of a single-qubit Stabilizer matrix is a pair of b | `"Z"` | 0 | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | $Z$ | | `"-Z"` | 1 | $[0, 1]$ | $\begin{bmatrix} -1 & 0 \\ 0 & 1 \end{bmatrix}$ | $-Z$ | -Internally this is stored as a length N boolean phase vector $[p_{N-1}, ..., p_{0}]$ and a [`PauliTable`](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") $M \times 2N$ boolean matrix: +Internally this is stored as a length N boolean phase vector $[p_{N-1}, ..., p_{0}]$ and a [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") $M \times 2N$ boolean matrix: $$ \begin{split}\left(\begin{array}{ccc|ccc} @@ -36,7 +44,7 @@ $$ where each row is a block vector $[X_i, Z_i]$ with $X_i = [x_{i,0}, ..., x_{i,N-1}]$, $Z_i = [z_{i,0}, ..., z_{i,N-1}]$ is the symplectic representation of an N-qubit Pauli. This representation is based on reference \[1]. -StabilizerTable’s can be created from a list of labels using [`from_labels()`](qiskit.quantum_info.StabilizerTable.from_labels#qiskit.quantum_info.StabilizerTable.from_labels "qiskit.quantum_info.StabilizerTable.from_labels"), and converted to a list of labels or a list of matrices using [`to_labels()`](qiskit.quantum_info.StabilizerTable.to_labels#qiskit.quantum_info.StabilizerTable.to_labels "qiskit.quantum_info.StabilizerTable.to_labels") and [`to_matrix()`](qiskit.quantum_info.StabilizerTable.to_matrix#qiskit.quantum_info.StabilizerTable.to_matrix "qiskit.quantum_info.StabilizerTable.to_matrix") respectively. +StabilizerTable’s can be created from a list of labels using [`from_labels()`](qiskit.quantum_info.StabilizerTable#from_labels "qiskit.quantum_info.StabilizerTable.from_labels"), and converted to a list of labels or a list of matrices using [`to_labels()`](qiskit.quantum_info.StabilizerTable#to_labels "qiskit.quantum_info.StabilizerTable.to_labels") and [`to_matrix()`](qiskit.quantum_info.StabilizerTable#to_matrix "qiskit.quantum_info.StabilizerTable.to_matrix") respectively. **Group Product** @@ -49,9 +57,9 @@ The product of the stabilizer elements is defined with respect to the matrix mul | **Y** | Y | Z | -I | -X | | **Z** | Z | -Y | X | I | -The [`dot()`](qiskit.quantum_info.StabilizerTable.dot#qiskit.quantum_info.StabilizerTable.dot "qiskit.quantum_info.StabilizerTable.dot") method will return the output for `row.dot(col) = row.col`, while the [`compose()`](qiskit.quantum_info.StabilizerTable.compose#qiskit.quantum_info.StabilizerTable.compose "qiskit.quantum_info.StabilizerTable.compose") will return `row.compose(col) = col.row` from the above table. +The [`dot()`](qiskit.quantum_info.StabilizerTable#dot "qiskit.quantum_info.StabilizerTable.dot") method will return the output for `row.dot(col) = row.col`, while the [`compose()`](qiskit.quantum_info.StabilizerTable#compose "qiskit.quantum_info.StabilizerTable.compose") will return `row.compose(col) = col.row` from the above table. -Note that while this dot product is different to the matrix product of the [`PauliTable`](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable"), it does not change the commutation structure of elements. Hence `commutes:()` will be the same for the same labels. +Note that while this dot product is different to the matrix product of the [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable"), it does not change the commutation structure of elements. Hence `commutes:()` will be the same for the same labels. **Qubit Ordering** @@ -61,11 +69,11 @@ The qubits are ordered in the table such the least significant qubit \[x\_\{i, 0 Subsets of rows can be accessed using the list access `[]` operator and will return a table view of part of the StabilizerTable. The underlying phase vector and Pauli array can be directly accessed using the [`phase`](#qiskit.quantum_info.StabilizerTable.phase "qiskit.quantum_info.StabilizerTable.phase") and [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array") properties respectively. The sub-arrays for only the X or Z blocks can be accessed using the [`X`](#qiskit.quantum_info.StabilizerTable.X "qiskit.quantum_info.StabilizerTable.X") and [`Z`](#qiskit.quantum_info.StabilizerTable.Z "qiskit.quantum_info.StabilizerTable.Z") properties respectively. -The Pauli part of the Stabilizer table can be viewed and accessed as a [`PauliTable`](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") object using the [`pauli`](#qiskit.quantum_info.StabilizerTable.pauli "qiskit.quantum_info.StabilizerTable.pauli") property. Note that this doesn’t copy the underlying array so any changes made to the Pauli table will also change the stabilizer table. +The Pauli part of the Stabilizer table can be viewed and accessed as a [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") object using the [`pauli`](#qiskit.quantum_info.StabilizerTable.pauli "qiskit.quantum_info.StabilizerTable.pauli") property. Note that this doesn’t copy the underlying array so any changes made to the Pauli table will also change the stabilizer table. **Iteration** -Rows in the Stabilizer table can be iterated over like a list. Iteration can also be done using the label or matrix representation of each row using the [`label_iter()`](qiskit.quantum_info.StabilizerTable.label_iter#qiskit.quantum_info.StabilizerTable.label_iter "qiskit.quantum_info.StabilizerTable.label_iter") and [`matrix_iter()`](qiskit.quantum_info.StabilizerTable.matrix_iter#qiskit.quantum_info.StabilizerTable.matrix_iter "qiskit.quantum_info.StabilizerTable.matrix_iter") methods. +Rows in the Stabilizer table can be iterated over like a list. Iteration can also be done using the label or matrix representation of each row using the [`label_iter()`](qiskit.quantum_info.StabilizerTable#label_iter "qiskit.quantum_info.StabilizerTable.label_iter") and [`matrix_iter()`](qiskit.quantum_info.StabilizerTable#matrix_iter "qiskit.quantum_info.StabilizerTable.matrix_iter") methods. ## References @@ -75,7 +83,7 @@ Initialize the StabilizerTable. **Parameters** -* **data** (*array or str or* [*PauliTable*](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – input PauliTable data. +* **data** (*array or str or* [*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – input PauliTable data. * **phase** (*array or bool or None*) – optional phase vector for input data (Default: None). **Raises** @@ -88,85 +96,737 @@ The input array is not copied so multiple Pauli and Stabilizer tables can share ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.StabilizerTable.adjoint#qiskit.quantum_info.StabilizerTable.adjoint "qiskit.quantum_info.StabilizerTable.adjoint") | Return the adjoint of the Operator. | -| [`anticommutes_with_all`](qiskit.quantum_info.StabilizerTable.anticommutes_with_all#qiskit.quantum_info.StabilizerTable.anticommutes_with_all "qiskit.quantum_info.StabilizerTable.anticommutes_with_all") | Return indexes of rows that commute other. | -| [`argsort`](qiskit.quantum_info.StabilizerTable.argsort#qiskit.quantum_info.StabilizerTable.argsort "qiskit.quantum_info.StabilizerTable.argsort") | Return indices for sorting the rows of the PauliTable. | -| [`commutes`](qiskit.quantum_info.StabilizerTable.commutes#qiskit.quantum_info.StabilizerTable.commutes "qiskit.quantum_info.StabilizerTable.commutes") | Return list of commutation properties for each row with a Pauli. | -| [`commutes_with_all`](qiskit.quantum_info.StabilizerTable.commutes_with_all#qiskit.quantum_info.StabilizerTable.commutes_with_all "qiskit.quantum_info.StabilizerTable.commutes_with_all") | Return indexes of rows that commute other. | -| [`compose`](qiskit.quantum_info.StabilizerTable.compose#qiskit.quantum_info.StabilizerTable.compose "qiskit.quantum_info.StabilizerTable.compose") | Return the compose output product of two tables. | -| [`conjugate`](qiskit.quantum_info.StabilizerTable.conjugate#qiskit.quantum_info.StabilizerTable.conjugate "qiskit.quantum_info.StabilizerTable.conjugate") | Not implemented. | -| [`copy`](qiskit.quantum_info.StabilizerTable.copy#qiskit.quantum_info.StabilizerTable.copy "qiskit.quantum_info.StabilizerTable.copy") | Return a copy of the StabilizerTable. | -| [`delete`](qiskit.quantum_info.StabilizerTable.delete#qiskit.quantum_info.StabilizerTable.delete "qiskit.quantum_info.StabilizerTable.delete") | Return a copy with Stabilizer rows deleted from table. | -| [`dot`](qiskit.quantum_info.StabilizerTable.dot#qiskit.quantum_info.StabilizerTable.dot "qiskit.quantum_info.StabilizerTable.dot") | Return the dot output product of two tables. | -| [`expand`](qiskit.quantum_info.StabilizerTable.expand#qiskit.quantum_info.StabilizerTable.expand "qiskit.quantum_info.StabilizerTable.expand") | Return the expand output product of two tables. | -| [`from_labels`](qiskit.quantum_info.StabilizerTable.from_labels#qiskit.quantum_info.StabilizerTable.from_labels "qiskit.quantum_info.StabilizerTable.from_labels") | Construct a StabilizerTable from a list of Pauli stabilizer strings. | -| [`input_dims`](qiskit.quantum_info.StabilizerTable.input_dims#qiskit.quantum_info.StabilizerTable.input_dims "qiskit.quantum_info.StabilizerTable.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`insert`](qiskit.quantum_info.StabilizerTable.insert#qiskit.quantum_info.StabilizerTable.insert "qiskit.quantum_info.StabilizerTable.insert") | Insert stabilizers’s into the table. | -| [`label_iter`](qiskit.quantum_info.StabilizerTable.label_iter#qiskit.quantum_info.StabilizerTable.label_iter "qiskit.quantum_info.StabilizerTable.label_iter") | Return a label representation iterator. | -| [`matrix_iter`](qiskit.quantum_info.StabilizerTable.matrix_iter#qiskit.quantum_info.StabilizerTable.matrix_iter "qiskit.quantum_info.StabilizerTable.matrix_iter") | Return a matrix representation iterator. | -| [`output_dims`](qiskit.quantum_info.StabilizerTable.output_dims#qiskit.quantum_info.StabilizerTable.output_dims "qiskit.quantum_info.StabilizerTable.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.StabilizerTable.power#qiskit.quantum_info.StabilizerTable.power "qiskit.quantum_info.StabilizerTable.power") | Return the compose of a operator with itself n times. | -| [`reshape`](qiskit.quantum_info.StabilizerTable.reshape#qiskit.quantum_info.StabilizerTable.reshape "qiskit.quantum_info.StabilizerTable.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`sort`](qiskit.quantum_info.StabilizerTable.sort#qiskit.quantum_info.StabilizerTable.sort "qiskit.quantum_info.StabilizerTable.sort") | Sort the rows of the table. | -| [`tensor`](qiskit.quantum_info.StabilizerTable.tensor#qiskit.quantum_info.StabilizerTable.tensor "qiskit.quantum_info.StabilizerTable.tensor") | Return the tensor output product of two tables. | -| [`to_labels`](qiskit.quantum_info.StabilizerTable.to_labels#qiskit.quantum_info.StabilizerTable.to_labels "qiskit.quantum_info.StabilizerTable.to_labels") | Convert a StabilizerTable to a list Pauli stabilizer string labels. | -| [`to_matrix`](qiskit.quantum_info.StabilizerTable.to_matrix#qiskit.quantum_info.StabilizerTable.to_matrix "qiskit.quantum_info.StabilizerTable.to_matrix") | Convert to a list or array of Stabilizer matrices. | -| [`transpose`](qiskit.quantum_info.StabilizerTable.transpose#qiskit.quantum_info.StabilizerTable.transpose "qiskit.quantum_info.StabilizerTable.transpose") | Not implemented. | -| [`unique`](qiskit.quantum_info.StabilizerTable.unique#qiskit.quantum_info.StabilizerTable.unique "qiskit.quantum_info.StabilizerTable.unique") | Return unique stabilizers from the table. | +### adjoint -## Attributes + + +`StabilizerTable.adjoint()` + +Return the adjoint of the Operator. + +### anticommutes\_with\_all + + + +`StabilizerTable.anticommutes_with_all(other)` + +Return indexes of rows that commute other. + +If other is a multi-row Pauli table the returned vector indexes rows of the current PauliTable that anti-commute with *all* Pauli’s in other. If no rows satisfy the condition the returned array will be empty. + +**Parameters** + +**other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – a single Pauli or multi-row PauliTable. + +**Returns** + +index array of the anti-commuting rows. + +**Return type** + +array + +### argsort + + + +`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. + +The default sort method is lexicographic sorting of Paulis by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Stabilizer, where the set of all Pauli’s of a given weight are still ordered lexicographically. + +This does not sort based on phase values. It will preserve the original order of rows with the same Pauli’s but different phases. + +**Parameters** + +**weight** (*bool*) – optionally sort by weight if True (Default: False). + +**Returns** + +the indices for sorting the table. + +**Return type** + +array + +### commutes + + + +`StabilizerTable.commutes(pauli)` + +Return list of commutation properties for each row with a Pauli. + +The returned vector is the same length as the size of the table and contains True for rows that commute with the Pauli, and False for the rows that anti-commute. + +**Parameters** + +**pauli** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – a single Pauli row. + +**Returns** + +The boolean vector of which rows commute or anti-commute. + +**Return type** + +array + +**Raises** + +**QiskitError** – if input is not a single Pauli row. + +### commutes\_with\_all + + + +`StabilizerTable.commutes_with_all(other)` + +Return indexes of rows that commute other. + +If other is a multi-row Pauli table the returned vector indexes rows of the current PauliTable that commute with *all* Pauli’s in other. If no rows satisfy the condition the returned array will be empty. + +**Parameters** + +**other** ([*PauliTable*](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")) – a single Pauli or multi-row PauliTable. + +**Returns** + +index array of the commuting rows. + +**Return type** + +array + +### compose + + + +`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. + +This returns the combination of the compose product of all stabilizers in the current table with all stabilizers in the other table. + +The individual stabilizer compose product is given by + +| `A.compose(B)` | I | X | Y | Z | +| -------------- | - | -- | -- | -- | +| **I** | I | X | Y | Z | +| **X** | X | I | Z | -Y | +| **Y** | Y | -Z | -I | X | +| **Z** | Z | Y | -X | I | + +If front=True the composition will be given by the [`dot()`](qiskit.quantum_info.StabilizerTable#dot "qiskit.quantum_info.StabilizerTable.dot") method. + +**Example** + +```python +from qiskit.quantum_info.operators import StabilizerTable + +current = StabilizerTable.from_labels(['+I', '-X']) +other = StabilizerTable.from_labels(['+X', '-Z']) +print(current.compose(other)) +``` + +```python +StabilizerTable: ['+X', '-Z', '-I', '-Y'] +``` + +**Parameters** + +* **other** ([*StabilizerTable*](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable")) – another StabilizerTable. +* **qargs** (*None or list*) – qubits to apply compose product on (Default: None). +* **front** (*bool*) – If True use dot composition method (default: False). + +**Returns** + +the compose outer product table. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a StabilizerTable. + +### conjugate + + + +`StabilizerTable.conjugate()` + +Not implemented. + +### copy + + + +`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. + +### delete + + + +`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. +When deleting qubit columns, qubit-0 is the right-most (largest index) column, and qubit-(N-1) is the left-most (0 index) column of the underlying [`X`](qiskit.quantum_info.StabilizerTable#x "qiskit.quantum_info.StabilizerTable.X") and [`Z`](qiskit.quantum_info.StabilizerTable#z "qiskit.quantum_info.StabilizerTable.Z") arrays. + +**Parameters** + +* **ind** (*int or list*) – index(es) to delete. +* **qubit** (*bool*) – if True delete qubit columns, otherwise delete Stabilizer rows (Default: False). + +**Returns** + +the resulting table with the entries removed. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +**Raises** + +**QiskitError** – if ind is out of bounds for the array size or number of qubits. + +### dot + + + +`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. + +This returns the combination of the compose product of all stabilizers in the current table with all stabilizers in the other table. + +The individual stabilizer dot product is given by + +| `A.dot(B)` | I | X | Y | Z | +| ---------- | - | -- | -- | -- | +| **I** | I | X | Y | Z | +| **X** | X | I | -Z | Y | +| **Y** | Y | Z | -I | -X | +| **Z** | Z | -Y | X | I | + +**Example** + +```python +from qiskit.quantum_info.operators import StabilizerTable + +current = StabilizerTable.from_labels(['+I', '-X']) +other = StabilizerTable.from_labels(['+X', '-Z']) +print(current.dot(other)) +``` + +```python +StabilizerTable: ['+X', '-Z', '-I', '+Y'] +``` + +**Parameters** + +* **other** ([*StabilizerTable*](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable")) – another StabilizerTable. +* **qargs** (*None or list*) – qubits to apply dot product on (Default: None). + +**Returns** + +the dot outer product table. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a StabilizerTable. + +### expand + + + +`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. + +This returns the combination of the tensor product of all stabilizers in the other table with all stabilizers in the current table. The current tables qubits will be the least-significant in the returned table. This is the opposite tensor order to [`tensor()`](qiskit.quantum_info.StabilizerTable#tensor "qiskit.quantum_info.StabilizerTable.tensor"). + +**Example** + +```python +from qiskit.quantum_info.operators import StabilizerTable + +current = StabilizerTable.from_labels(['+I', '-X']) +other = StabilizerTable.from_labels(['-Y', '+Z']) +print(current.expand(other)) +``` + +```python +StabilizerTable: ['-YI', '+YX', '+ZI', '-ZX'] +``` + +**Parameters** + +**other** ([*StabilizerTable*](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable")) – another StabilizerTable. + +**Returns** + +the expand outer product table. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a StabilizerTable. + +### from\_labels + + + +`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. + +Pauli Stabilizer string labels are Pauli strings with an optional `"+"` or `"-"` character. If there is no +/-sign a + phase is used by default. + +| Label | Phase | Symplectic | Matrix | Pauli | +| ------ | ----- | ---------- | ------------------------------------------------ | ----- | +| `"+I"` | 0 | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ | $I$ | +| `"-I"` | 1 | $[0, 0]$ | $\begin{bmatrix} -1 & 0 \\ 0 & -1 \end{bmatrix}$ | $-I$ | +| `"X"` | 0 | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ | $X$ | +| `"-X"` | 1 | $[1, 0]$ | $\begin{bmatrix} 0 & -1 \\ -1 & 0 \end{bmatrix}$ | $-X$ | +| `"Y"` | 0 | $[1, 1]$ | $\begin{bmatrix} 0 & 1 \\ -1 & 0 \end{bmatrix}$ | $iY$ | +| `"-Y"` | 1 | $[1, 1]$ | $\begin{bmatrix} 0 & -1 \\ 1 & 0 \end{bmatrix}$ | $-iY$ | +| `"Z"` | 0 | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | $Z$ | +| `"-Z"` | 1 | $[0, 1]$ | $\begin{bmatrix} -1 & 0 \\ 0 & 1 \end{bmatrix}$ | $-Z$ | + +**Parameters** + +**labels** (*list*) – Pauli stabilizer string label(es). + +**Returns** + +the constructed StabilizerTable. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +**Raises** + +**QiskitError** – If the input list is empty or contains invalid Pauli stabilizer strings. + +### input\_dims + + + +`StabilizerTable.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### insert + + + +`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. + +When inserting qubit columns, qubit-0 is the right-most (largest index) column, and qubit-(N-1) is the left-most (0 index) column of the underlying [`X`](qiskit.quantum_info.StabilizerTable#x "qiskit.quantum_info.StabilizerTable.X") and [`Z`](qiskit.quantum_info.StabilizerTable#z "qiskit.quantum_info.StabilizerTable.Z") arrays. + +**Parameters** + +* **ind** (*int*) – index to insert at. +* **value** ([*StabilizerTable*](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable")) – values to insert. +* **qubit** (*bool*) – if True delete qubit columns, otherwise delete Pauli rows (Default: False). + +**Returns** + +the resulting table with the entries inserted. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +**Raises** + +**QiskitError** – if the insertion index is invalid. + +### label\_iter + + + +`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. + +This is a lazy iterator that converts each row into the string label only as it is used. To convert the entire table to labels use the [`to_labels()`](qiskit.quantum_info.StabilizerTable#to_labels "qiskit.quantum_info.StabilizerTable.to_labels") method. + +**Returns** + +label iterator object for the StabilizerTable. + +**Return type** + +LabelIterator + +### matrix\_iter + + + +`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. + +This is a lazy iterator that converts each row into the Pauli matrix representation only as it is used. To convert the entire table to matrices use the [`to_matrix()`](qiskit.quantum_info.StabilizerTable#to_matrix "qiskit.quantum_info.StabilizerTable.to_matrix") method. + +**Parameters** + +**sparse** (*bool*) – optionally return sparse CSR matrices if True, otherwise return Numpy array matrices (Default: False) + +**Returns** + +matrix iterator object for the StabilizerTable. + +**Return type** + +MatrixIterator + +### output\_dims + + + +`StabilizerTable.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`StabilizerTable.power(n)` + +Return the compose of a operator with itself n times. + +**Parameters** + +**n** (*int*) – the number of times to compose with self (n>0). + +**Returns** + +the n-times composed operator. + +**Return type** + +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") + +**Raises** + +**QiskitError** – if the input and output dimensions of the operator are not equal, or the power is not a positive integer. + +### reshape + + + +`StabilizerTable.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### sort + + + +`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. + +The default sort method is lexicographic sorting by qubit number. By using the weight kwarg the output can additionally be sorted by the number of non-identity terms in the Pauli, where the set of all Pauli’s of a given weight are still ordered lexicographically. + +This does not sort based on phase values. It will preserve the original order of rows with the same Pauli’s but different phases. + +Consider sorting all a random ordering of all 2-qubit Paulis + +```python +from numpy.random import shuffle +from qiskit.quantum_info.operators import StabilizerTable + +# 2-qubit labels +labels = ['+II', '+IX', '+IY', '+IZ', '+XI', '+XX', '+XY', '+XZ', + '+YI', '+YX', '+YY', '+YZ', '+ZI', '+ZX', '+ZY', '+ZZ', + '-II', '-IX', '-IY', '-IZ', '-XI', '-XX', '-XY', '-XZ', + '-YI', '-YX', '-YY', '-YZ', '-ZI', '-ZX', '-ZY', '-ZZ'] +# Shuffle Labels +shuffle(labels) +st = StabilizerTable.from_labels(labels) +print('Initial Ordering') +print(st) + +# Lexicographic Ordering +srt = st.sort() +print('Lexicographically sorted') +print(srt) + +# Weight Ordering +srt = st.sort(weight=True) +print('Weight sorted') +print(srt) +``` + +```python +Initial Ordering +StabilizerTable: ['+IY', '-ZZ', '-ZX', '-IZ', '-YZ', '+XI', '-XZ', '+II', '-II', '-YY', '-YI', '-IX', '-IY', '+YX', '+YY', '-XI', '+ZY', '+IZ', '+ZZ', '+ZI', '-ZY', '+ZX', '+XZ', '-YX', '+XY', '-XX', '+YZ', '+IX', '-ZI', '+XX', '+YI', '-XY'] +Lexicographically sorted +StabilizerTable: ['+II', '-II', '-IX', '+IX', '+IY', '-IY', '-IZ', '+IZ', '+XI', '-XI', '-XX', '+XX', '+XY', '-XY', '-XZ', '+XZ', '-YI', '+YI', '+YX', '-YX', '-YY', '+YY', '-YZ', '+YZ', '+ZI', '-ZI', '-ZX', '+ZX', '+ZY', '-ZY', '-ZZ', '+ZZ'] +Weight sorted +StabilizerTable: ['+II', '-II', '-IX', '+IX', '+IY', '-IY', '-IZ', '+IZ', '+XI', '-XI', '-YI', '+YI', '+ZI', '-ZI', '-XX', '+XX', '+XY', '-XY', '-XZ', '+XZ', '+YX', '-YX', '-YY', '+YY', '-YZ', '+YZ', '-ZX', '+ZX', '+ZY', '-ZY', '-ZZ', '+ZZ'] +``` + +**Parameters** + +**weight** (*bool*) – optionally sort by weight if True (Default: False). + +**Returns** + +a sorted copy of the original table. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +### tensor + + + +`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. + +This returns the combination of the tensor product of all stabilizers in the current table with all stabilizers in the other table. The other tables qubits will be the least-significant in the returned table. This is the opposite tensor order to [`tensor()`](#qiskit.quantum_info.StabilizerTable.tensor "qiskit.quantum_info.StabilizerTable.tensor"). + +**Example** + +```python +from qiskit.quantum_info.operators import StabilizerTable + +current = StabilizerTable.from_labels(['+I', '-X']) +other = StabilizerTable.from_labels(['-Y', '+Z']) +print(current.tensor(other)) +``` + +```python +StabilizerTable: ['-IY', '+IZ', '+XY', '-XZ'] +``` + +**Parameters** + +**other** ([*StabilizerTable*](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable")) – another StabilizerTable. + +**Returns** + +the tensor outer product table. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +**Raises** + +**QiskitError** – if other cannot be converted to a StabilizerTable. + +### to\_labels + + + +`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. + +For large StabilizerTables converting using the `array=True` kwarg will be more efficient since it allocates memory for the full Numpy array of labels in advance. + +| Label | Phase | Symplectic | Matrix | Pauli | +| ------ | ----- | ---------- | ------------------------------------------------ | ----- | +| `"+I"` | 0 | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ | $I$ | +| `"-I"` | 1 | $[0, 0]$ | $\begin{bmatrix} -1 & 0 \\ 0 & -1 \end{bmatrix}$ | $-I$ | +| `"X"` | 0 | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ | $X$ | +| `"-X"` | 1 | $[1, 0]$ | $\begin{bmatrix} 0 & -1 \\ -1 & 0 \end{bmatrix}$ | $-X$ | +| `"Y"` | 0 | $[1, 1]$ | $\begin{bmatrix} 0 & 1 \\ -1 & 0 \end{bmatrix}$ | $iY$ | +| `"-Y"` | 1 | $[1, 1]$ | $\begin{bmatrix} 0 & -1 \\ 1 & 0 \end{bmatrix}$ | $-iY$ | +| `"Z"` | 0 | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | $Z$ | +| `"-Z"` | 1 | $[0, 1]$ | $\begin{bmatrix} -1 & 0 \\ 0 & 1 \end{bmatrix}$ | $-Z$ | + +**Parameters** + +**array** (*bool*) – return a Numpy array if True, otherwise return a list (Default: False). + +**Returns** + +The rows of the StabilizerTable in label form. + +**Return type** + +list or array + +### to\_matrix + + + +`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. + +For large StabilizerTables converting using the `array=True` kwarg will be more efficient since it allocates memory for the full rank-3 Numpy array of matrices in advance. + +| Label | Phase | Symplectic | Matrix | Pauli | +| ------ | ----- | ---------- | ------------------------------------------------ | ----- | +| `"+I"` | 0 | $[0, 0]$ | $\begin{bmatrix} 1 & 0 \\ 0 & 1 \end{bmatrix}$ | $I$ | +| `"-I"` | 1 | $[0, 0]$ | $\begin{bmatrix} -1 & 0 \\ 0 & -1 \end{bmatrix}$ | $-I$ | +| `"X"` | 0 | $[1, 0]$ | $\begin{bmatrix} 0 & 1 \\ 1 & 0 \end{bmatrix}$ | $X$ | +| `"-X"` | 1 | $[1, 0]$ | $\begin{bmatrix} 0 & -1 \\ -1 & 0 \end{bmatrix}$ | $-X$ | +| `"Y"` | 0 | $[1, 1]$ | $\begin{bmatrix} 0 & 1 \\ -1 & 0 \end{bmatrix}$ | $iY$ | +| `"-Y"` | 1 | $[1, 1]$ | $\begin{bmatrix} 0 & -1 \\ 1 & 0 \end{bmatrix}$ | $-iY$ | +| `"Z"` | 0 | $[0, 1]$ | $\begin{bmatrix} 1 & 0 \\ 0 & -1 \end{bmatrix}$ | $Z$ | +| `"-Z"` | 1 | $[0, 1]$ | $\begin{bmatrix} -1 & 0 \\ 0 & 1 \end{bmatrix}$ | $-Z$ | + +**Parameters** + +* **sparse** (*bool*) – if True return sparse CSR matrices, otherwise return dense Numpy arrays (Default: False). +* **array** (*bool*) – return as rank-3 numpy array if True, otherwise return a list of Numpy arrays (Default: False). + +**Returns** + +A list of dense Pauli matrices if array=False and sparse=False. list: A list of sparse Pauli matrices if array=False and sparse=True. array: A dense rank-3 array of Pauli matrices if array=True. + +**Return type** + +list + +### transpose + + + +`StabilizerTable.transpose()` + +Not implemented. + +### unique + + + +`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. + +**Example** + +```python +from qiskit.quantum_info.operators import StabilizerTable + +st = StabilizerTable.from_labels(['+X', '+I', '-I', '-X', '+X', '-X', '+I']) +unique = st.unique() +print(unique) +``` + +```python +StabilizerTable: ['+X', '+I', '-I', '-X'] +``` + +**Parameters** + +* **return\_index** (*bool*) – If True, also return the indices that result in the unique array. (Default: False) +* **return\_counts** (*bool*) – If True, also return the number of times each unique item appears in the table. + +**Returns** + +**unique** + +the table of the unique rows. + +**unique\_indices: np.ndarray, optional** + +The indices of the first occurrences of the unique values in the original array. Only provided if `return_index` is True. + +**unique\_counts: np.array, optional** + +The number of times each of the unique values comes up in the original array. Only provided if `return_counts` is True. + +**Return type** + +[StabilizerTable](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable") + +## Attributes + + ### X The X block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). - + ### Z The Z block of the [`array`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array"). - + ### array The underlying boolean array. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### pauli Return PauliTable - + ### phase Return phase vector - + ### qargs Return the qargs for the operator. - + ### settings @@ -176,14 +836,15 @@ Return settings. `Dict` - + ### shape The full shape of the [`array()`](#qiskit.quantum_info.StabilizerTable.array "qiskit.quantum_info.StabilizerTable.array") - + ### size The number of Pauli rows in the table. + diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md b/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md index 5f847f057d5..0ccf37c45ef 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Statevector.md @@ -1,8 +1,16 @@ -# Statevector +--- +title: Statevector +description: API reference for qiskit.quantum_info.Statevector +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Statevector +--- +# Statevector + -`Statevector(data, dims=None)` +`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` @@ -28,67 +36,638 @@ The `dims` kwarg can be None, an integer, or an iterable of integers. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [`conjugate`](qiskit.quantum_info.Statevector.conjugate#qiskit.quantum_info.Statevector.conjugate "qiskit.quantum_info.Statevector.conjugate") | Return the conjugate of the operator. | -| [`copy`](qiskit.quantum_info.Statevector.copy#qiskit.quantum_info.Statevector.copy "qiskit.quantum_info.Statevector.copy") | Make a copy of current operator. | -| [`dims`](qiskit.quantum_info.Statevector.dims#qiskit.quantum_info.Statevector.dims "qiskit.quantum_info.Statevector.dims") | Return tuple of input dimension for specified subsystems. | -| [`draw`](qiskit.quantum_info.Statevector.draw#qiskit.quantum_info.Statevector.draw "qiskit.quantum_info.Statevector.draw") | Return a visualization of the Statevector. | -| [`equiv`](qiskit.quantum_info.Statevector.equiv#qiskit.quantum_info.Statevector.equiv "qiskit.quantum_info.Statevector.equiv") | Return True if other is equivalent as a statevector up to global phase. | -| [`evolve`](qiskit.quantum_info.Statevector.evolve#qiskit.quantum_info.Statevector.evolve "qiskit.quantum_info.Statevector.evolve") | Evolve a quantum state by the operator. | -| [`expand`](qiskit.quantum_info.Statevector.expand#qiskit.quantum_info.Statevector.expand "qiskit.quantum_info.Statevector.expand") | Return the tensor product state other ⊗ self. | -| [`expectation_value`](qiskit.quantum_info.Statevector.expectation_value#qiskit.quantum_info.Statevector.expectation_value "qiskit.quantum_info.Statevector.expectation_value") | Compute the expectation value of an operator. | -| [`from_instruction`](qiskit.quantum_info.Statevector.from_instruction#qiskit.quantum_info.Statevector.from_instruction "qiskit.quantum_info.Statevector.from_instruction") | Return the output statevector of an instruction. | -| [`from_int`](qiskit.quantum_info.Statevector.from_int#qiskit.quantum_info.Statevector.from_int "qiskit.quantum_info.Statevector.from_int") | Return a computational basis statevector. | -| [`from_label`](qiskit.quantum_info.Statevector.from_label#qiskit.quantum_info.Statevector.from_label "qiskit.quantum_info.Statevector.from_label") | Return a tensor product of Pauli X,Y,Z eigenstates. | -| [`is_valid`](qiskit.quantum_info.Statevector.is_valid#qiskit.quantum_info.Statevector.is_valid "qiskit.quantum_info.Statevector.is_valid") | Return True if a Statevector has norm 1. | -| [`measure`](qiskit.quantum_info.Statevector.measure#qiskit.quantum_info.Statevector.measure "qiskit.quantum_info.Statevector.measure") | Measure subsystems and return outcome and post-measure state. | -| [`probabilities`](qiskit.quantum_info.Statevector.probabilities#qiskit.quantum_info.Statevector.probabilities "qiskit.quantum_info.Statevector.probabilities") | Return the subsystem measurement probability vector. | -| [`probabilities_dict`](qiskit.quantum_info.Statevector.probabilities_dict#qiskit.quantum_info.Statevector.probabilities_dict "qiskit.quantum_info.Statevector.probabilities_dict") | Return the subsystem measurement probability dictionary. | -| [`purity`](qiskit.quantum_info.Statevector.purity#qiskit.quantum_info.Statevector.purity "qiskit.quantum_info.Statevector.purity") | Return the purity of the quantum state. | -| [`reset`](qiskit.quantum_info.Statevector.reset#qiskit.quantum_info.Statevector.reset "qiskit.quantum_info.Statevector.reset") | Reset state or subsystems to the 0-state. | -| [`reverse_qargs`](qiskit.quantum_info.Statevector.reverse_qargs#qiskit.quantum_info.Statevector.reverse_qargs "qiskit.quantum_info.Statevector.reverse_qargs") | Return a Statevector with reversed subsystem ordering. | -| [`sample_counts`](qiskit.quantum_info.Statevector.sample_counts#qiskit.quantum_info.Statevector.sample_counts "qiskit.quantum_info.Statevector.sample_counts") | Sample a dict of qubit measurement outcomes in the computational basis. | -| [`sample_memory`](qiskit.quantum_info.Statevector.sample_memory#qiskit.quantum_info.Statevector.sample_memory "qiskit.quantum_info.Statevector.sample_memory") | Sample a list of qubit measurement outcomes in the computational basis. | -| [`seed`](qiskit.quantum_info.Statevector.seed#qiskit.quantum_info.Statevector.seed "qiskit.quantum_info.Statevector.seed") | Set the seed for the quantum state RNG. | -| [`tensor`](qiskit.quantum_info.Statevector.tensor#qiskit.quantum_info.Statevector.tensor "qiskit.quantum_info.Statevector.tensor") | Return the tensor product state self ⊗ other. | -| [`to_dict`](qiskit.quantum_info.Statevector.to_dict#qiskit.quantum_info.Statevector.to_dict "qiskit.quantum_info.Statevector.to_dict") | Convert the statevector to dictionary form. | -| [`to_operator`](qiskit.quantum_info.Statevector.to_operator#qiskit.quantum_info.Statevector.to_operator "qiskit.quantum_info.Statevector.to_operator") | Convert state to a rank-1 projector operator | -| [`trace`](qiskit.quantum_info.Statevector.trace#qiskit.quantum_info.Statevector.trace "qiskit.quantum_info.Statevector.trace") | Return the trace of the quantum state as a density matrix. | +### conjugate -## Attributes + + +`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. + +### copy + + + +`Statevector.copy()` + +Make a copy of current operator. + +### dims + + + +`Statevector.dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### draw + + + +`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. + +**repr**: ASCII TextMatrix of the state’s `__repr__`. + +**text**: ASCII TextMatrix that can be printed in the console. + +**latex**: An IPython Latex object for displaying in Jupyter Notebooks. + +**latex\_source**: Raw, uncompiled ASCII source to generate array using LaTeX. + +**qsphere**: Matplotlib figure, rendering of statevector using plot\_state\_qsphere(). + +**hinton**: Matplotlib figure, rendering of statevector using plot\_state\_hinton(). + +**bloch**: Matplotlib figure, rendering of statevector using plot\_bloch\_multivector(). + +**city**: Matplotlib figure, rendering of statevector using plot\_state\_city(). + +**paulivec**: Matplotlib figure, rendering of statevector using plot\_state\_paulivec(). + +**Parameters** + +* **output** (*str*) – Select the output method to use for drawing the state. Valid choices are repr, text, latex, latex\_source, qsphere, hinton, bloch, city, or paulivec. Default is repr. Default can be changed by adding the line `state_drawer = ` to `~/.qiskit/settings.conf` under `[default]`. +* **drawer\_args** – Arguments to be passed directly to the relevant drawing function or constructor (TextMatrix(), array\_to\_latex(), plot\_state\_qsphere(), plot\_state\_hinton() or plot\_bloch\_multivector()). See the relevant function under qiskit.visualization for that function’s documentation. + +**Returns** + +`matplotlib.Figure` or `str` or `TextMatrix` or `IPython.display.Latex`: Drawing of the Statevector. + +**Raises** + +**ValueError** – when an invalid output method is selected. + +### equiv + + + +`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. + + + If other is not a Statevector, but can be used to initialize a statevector object, this will check that Statevector(other) is equivalent to the current statevector up to global phase. + + +**Parameters** + +* **other** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – an object from which a `Statevector` can be constructed. +* **rtol** (*float*) – relative tolerance value for comparison. +* **atol** (*float*) – absolute tolerance value for comparison. + +**Returns** + +True if statevectors are equivalent up to global phase. + +**Return type** + +bool + +### evolve + + + +`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. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – The operator to evolve by. +* **qargs** (*list*) – a list of Statevector subsystem positions to apply the operator on. + +**Returns** + +the output quantum state. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +**Raises** + +**QiskitError** – if the operator dimension does not match the specified Statevector subsystem dimensions. + +### expand + + + +`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. + +**Parameters** + +**other** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – a quantum state object. + +**Returns** + +the tensor product state other ⊗ self. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +**Raises** + +**QiskitError** – if other is not a quantum state. + +### expectation\_value + + + +`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. + +**Parameters** + +* **oper** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator to evaluate expval of. +* **qargs** (*None or list*) – subsystems to apply operator on. + +**Returns** + +the expectation value. + +**Return type** + +complex + +### from\_instruction + + + +`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. + +The statevector is initialized in the state $|{0,\ldots,0}\rangle$ of the same number of qubits as the input instruction or circuit, evolved by the input instruction, and the output statevector returned. + +**Parameters** + +**instruction** ([*qiskit.circuit.Instruction*](qiskit.circuit.Instruction "qiskit.circuit.Instruction") *or*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – instruction or circuit + +**Returns** + +The final statevector. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +**Raises** + +**QiskitError** – if the instruction contains invalid instructions for the statevector simulation. + +### from\_int + + + +`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. + +**Parameters** + +* **i** (*int*) – the basis state element. +* **dims** (*int or tuple or list*) – The subsystem dimensions of the statevector (See additional information). + +**Returns** + +The computational basis state $|i\rangle$. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +#### Additional Information: + +The `dims` kwarg can be an integer or an iterable of integers. + +* `Iterable` – the subsystem dimensions are the values in the list with the total number of subsystems given by the length of the list. +* `Int` – the integer specifies the total dimension of the state. If it is a power of two the state will be initialized as an N-qubit state. If it is not a power of two the state will have a single d-dimensional subsystem. + +### from\_label + + + +`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. + +| Label | Statevector | +| ----- | ------------------------------- | +| `"0"` | $[1, 0]$ | +| `"1"` | $[0, 1]$ | +| `"+"` | $[1 / \sqrt{2}, 1 / \sqrt{2}]$ | +| `"-"` | $[1 / \sqrt{2}, -1 / \sqrt{2}]$ | +| `"r"` | $[1 / \sqrt{2}, i / \sqrt{2}]$ | +| `"l"` | $[1 / \sqrt{2}, -i / \sqrt{2}]$ | + +**Parameters** + +**label** (*string*) – a eigenstate string ket label (see table for allowed values). + +**Returns** + +The N-qubit basis state density matrix. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +**Raises** + +**QiskitError** – if the label contains invalid characters, or the length of the label is larger than an explicitly specified num\_qubits. + +### is\_valid + + + +`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. + +### measure + + + +`Statevector.measure(qargs=None)` + +Measure subsystems and return outcome and post-measure state. + +Note that this function uses the QuantumStates internal random number generator for sampling the measurement outcome. The RNG seed can be set using the [`seed()`](qiskit.quantum_info.Statevector#seed "qiskit.quantum_info.Statevector.seed") method. + +**Parameters** + +**qargs** (*list or None*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +**the pair `(outcome, state)` where `outcome` is the** + +measurement outcome string label, and `state` is the collapsed post-measurement state for the corresponding outcome. + +**Return type** + +tuple + +### probabilities + +`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. + +Measurement probabilities are with respect to measurement in the computation (diagonal) basis. + +**Parameters** + +* **qargs** (*None or list*) – subsystems to return probabilities for, if None return for all subsystems (Default: None). +* **decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). + +**Returns** + +The Numpy vector array of probabilities. + +**Return type** + +np.array + +#### Examples + +Consider a 2-qubit product state $|\psi\rangle=|+\rangle\otimes|0\rangle$. + +```python +from qiskit.quantum_info import Statevector + +psi = Statevector.from_label('+0') + +# Probabilities for measuring both qubits +probs = psi.probabilities() +print('probs: {}'.format(probs)) + +# Probabilities for measuring only qubit-0 +probs_qubit_0 = psi.probabilities([0]) +print('Qubit-0 probs: {}'.format(probs_qubit_0)) + +# Probabilities for measuring only qubit-1 +probs_qubit_1 = psi.probabilities([1]) +print('Qubit-1 probs: {}'.format(probs_qubit_1)) +``` + +```python +probs: [0.5 0. 0.5 0. ] +Qubit-0 probs: [1. 0.] +Qubit-1 probs: [0.5 0.5] +``` + +We can also permute the order of qubits in the `qargs` list to change the qubit position in the probabilities output + +```python +from qiskit.quantum_info import Statevector + +psi = Statevector.from_label('+0') + +# Probabilities for measuring both qubits +probs = psi.probabilities([0, 1]) +print('probs: {}'.format(probs)) + +# Probabilities for measuring both qubits +# but swapping qubits 0 and 1 in output +probs_swapped = psi.probabilities([1, 0]) +print('Swapped probs: {}'.format(probs_swapped)) +``` + +```python +probs: [0.5 0. 0.5 0. ] +Swapped probs: [0.5 0.5 0. 0. ] +``` + +### probabilities\_dict + + + +`Statevector.probabilities_dict(qargs=None, decimals=None)` + +Return the subsystem measurement probability dictionary. + +Measurement probabilities are with respect to measurement in the computation (diagonal) basis. + +This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. + +**Parameters** + +* **qargs** (*None or list*) – subsystems to return probabilities for, if None return for all subsystems (Default: None). +* **decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). + +**Returns** + +The measurement probabilities in dict (ket) form. + +**Return type** + +dict + +### purity + + + +`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. + +### reset + + + +`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. + +**Parameters** + +**qargs** (*list or None*) – subsystems to reset, if None all subsystems will be reset to their 0-state (Default: None). + +**Returns** + +the reset state. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +#### Additional Information: + +If all subsystems are reset this will return the ground state on all subsystems. If only a some subsystems are reset this function will perform a measurement on those subsystems and evolve the subsystems so that the collapsed post-measurement states are rotated to the 0-state. The RNG seed for this sampling can be set using the [`seed()`](qiskit.quantum_info.Statevector#seed "qiskit.quantum_info.Statevector.seed") method. + +### reverse\_qargs + + + +`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. + +For a tensor product state this is equivalent to reversing the order of tensor product subsystems. For a statevector $|\psi \rangle = |\psi_{n-1} \rangle \otimes ... \otimes |\psi_0 \rangle$ the returned statevector will be $|\psi_{0} \rangle \otimes ... \otimes |\psi_{n-1} \rangle$. + +**Returns** + +the Statevector with reversed subsystem order. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +### sample\_counts + + + +`Statevector.sample_counts(shots, qargs=None)` + +Sample a dict of qubit measurement outcomes in the computational basis. + +**Parameters** + +* **shots** (*int*) – number of samples to generate. +* **qargs** (*None or list*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +sampled counts dictionary. + +**Return type** + +[Counts](qiskit.result.Counts "qiskit.result.Counts") + +Additional Information: + +> This function *samples* measurement outcomes using the measure [`probabilities()`](qiskit.quantum_info.Statevector#probabilities "qiskit.quantum_info.Statevector.probabilities") for the current state and qargs. It does not actually implement the measurement so the current state is not modified. +> +> The seed for random number generator used for sampling can be set to a fixed value by using the stats [`seed()`](qiskit.quantum_info.Statevector#seed "qiskit.quantum_info.Statevector.seed") method. + +### sample\_memory + + + +`Statevector.sample_memory(shots, qargs=None)` + +Sample a list of qubit measurement outcomes in the computational basis. + +**Parameters** + +* **shots** (*int*) – number of samples to generate. +* **qargs** (*None or list*) – subsystems to sample measurements for, if None sample measurement of all subsystems (Default: None). + +**Returns** + +list of sampled counts if the order sampled. + +**Return type** + +np.array + +Additional Information: + +> This function *samples* measurement outcomes using the measure [`probabilities()`](qiskit.quantum_info.Statevector#probabilities "qiskit.quantum_info.Statevector.probabilities") for the current state and qargs. It does not actually implement the measurement so the current state is not modified. +> +> The seed for random number generator used for sampling can be set to a fixed value by using the stats [`seed()`](qiskit.quantum_info.Statevector#seed "qiskit.quantum_info.Statevector.seed") method. + +### seed + + + +`Statevector.seed(value=None)` + +Set the seed for the quantum state RNG. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")) – a quantum state object. + +**Returns** + +the tensor product operator self ⊗ other. + +**Return type** + +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") + +**Raises** + +**QiskitError** – if other is not a quantum state. + +### to\_dict + + + +`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. + +This dictionary representation uses a Ket-like notation where the dictionary keys are qudit strings for the subsystem basis vectors. If any subsystem has a dimension greater than 10 comma delimiters are inserted between integers so that subsystems can be distinguished. + +**Parameters** + +**decimals** (*None or int*) – the number of decimal places to round values. If None no rounding is done (Default: None). + +**Returns** + +the dictionary form of the Statevector. + +**Return type** + +dict + +#### Example + +The ket-form of a 2-qubit statevector $|\psi\rangle = |-\rangle\otimes |0\rangle$ + +```python +from qiskit.quantum_info import Statevector + +psi = Statevector.from_label('-0') +print(psi.to_dict()) +``` + +```python +{'00': (0.7071067811865475+0j), '10': (-0.7071067811865475+0j)} +``` + +For non-qubit subsystems the integer range can go from 0 to 9. For example in a qutrit system + +```python +import numpy as np +from qiskit.quantum_info import Statevector + +vec = np.zeros(9) +vec[0] = 1 / np.sqrt(2) +vec[-1] = 1 / np.sqrt(2) +psi = Statevector(vec, dims=(3, 3)) +print(psi.to_dict()) +``` + +```python +{'00': (0.7071067811865475+0j), '22': (0.7071067811865475+0j)} +``` + +For large subsystem dimensions delimiters are required. The following example is for a 20-dimensional system consisting of a qubit and 10-dimensional qudit. + +```python +import numpy as np +from qiskit.quantum_info import Statevector + +vec = np.zeros(2 * 10) +vec[0] = 1 / np.sqrt(2) +vec[-1] = 1 / np.sqrt(2) +psi = Statevector(vec, dims=(2, 10)) +print(psi.to_dict()) +``` + +```python +{'00': (0.7071067811865475+0j), '91': (0.7071067811865475+0j)} +``` + +### to\_operator + + + +`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 + +### trace + + + +`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. + +## Attributes + + ### atol `= 1e-08` - + ### data Return data. - + ### dim Return total state dimension. - + ### num\_qubits Return the number of qubits if a N-qubit state or None otherwise. - + ### rtol `= 1e-05` - + ### settings @@ -97,3 +676,4 @@ Return settings. **Return type** `Dict` + 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 81805a218ea..8cc9a6a5a5b 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.Stinespring.md @@ -1,20 +1,28 @@ -# Stinespring +--- +title: Stinespring +description: API reference for qiskit.quantum_info.Stinespring +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.Stinespring +--- +# Stinespring + -`Stinespring(data, input_dims=None, output_dims=None)` +`Stinespring(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/stinespring.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Stinespring representation of a quantum channel. -The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by +The Stinespring representation of a quantum channel $\mathcal{E}$ is a rectangular matrix $A$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by $$ \mathcal{E}(ρ) = \mbox{Tr}_2\left[A ρ A^\dagger\right] $$ -where $\mbox{Tr}_2$ is the [`partial_trace()`](qiskit.quantum_info.partial_trace#qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace") over subsystem 2. +where $\mbox{Tr}_2$ is the [`partial_trace()`](qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace") over subsystem 2. A general operator map $\mathcal{G}$ can also be written using the generalized Stinespring representation which is given by two matrices $A$, $B$ such that @@ -46,65 +54,322 @@ If the input or output dimensions are None, they will be automatically determine ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.Stinespring.adjoint#qiskit.quantum_info.Stinespring.adjoint "qiskit.quantum_info.Stinespring.adjoint") | Return the adjoint quantum channel. | -| [`compose`](qiskit.quantum_info.Stinespring.compose#qiskit.quantum_info.Stinespring.compose "qiskit.quantum_info.Stinespring.compose") | Return the operator composition with another Stinespring. | -| [`conjugate`](qiskit.quantum_info.Stinespring.conjugate#qiskit.quantum_info.Stinespring.conjugate "qiskit.quantum_info.Stinespring.conjugate") | Return the conjugate quantum channel. | -| [`copy`](qiskit.quantum_info.Stinespring.copy#qiskit.quantum_info.Stinespring.copy "qiskit.quantum_info.Stinespring.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.Stinespring.dot#qiskit.quantum_info.Stinespring.dot "qiskit.quantum_info.Stinespring.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.Stinespring.expand#qiskit.quantum_info.Stinespring.expand "qiskit.quantum_info.Stinespring.expand") | Return the reverse-order tensor product with another Stinespring. | -| [`input_dims`](qiskit.quantum_info.Stinespring.input_dims#qiskit.quantum_info.Stinespring.input_dims "qiskit.quantum_info.Stinespring.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_cp`](qiskit.quantum_info.Stinespring.is_cp#qiskit.quantum_info.Stinespring.is_cp "qiskit.quantum_info.Stinespring.is_cp") | Test if Choi-matrix is completely-positive (CP) | -| [`is_cptp`](qiskit.quantum_info.Stinespring.is_cptp#qiskit.quantum_info.Stinespring.is_cptp "qiskit.quantum_info.Stinespring.is_cptp") | Return True if completely-positive trace-preserving. | -| [`is_tp`](qiskit.quantum_info.Stinespring.is_tp#qiskit.quantum_info.Stinespring.is_tp "qiskit.quantum_info.Stinespring.is_tp") | Test if a channel is trace-preserving (TP) | -| [`is_unitary`](qiskit.quantum_info.Stinespring.is_unitary#qiskit.quantum_info.Stinespring.is_unitary "qiskit.quantum_info.Stinespring.is_unitary") | Return True if QuantumChannel is a unitary channel. | -| [`output_dims`](qiskit.quantum_info.Stinespring.output_dims#qiskit.quantum_info.Stinespring.output_dims "qiskit.quantum_info.Stinespring.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.Stinespring.power#qiskit.quantum_info.Stinespring.power "qiskit.quantum_info.Stinespring.power") | Return the power of the quantum channel. | -| [`reshape`](qiskit.quantum_info.Stinespring.reshape#qiskit.quantum_info.Stinespring.reshape "qiskit.quantum_info.Stinespring.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.Stinespring.tensor#qiskit.quantum_info.Stinespring.tensor "qiskit.quantum_info.Stinespring.tensor") | Return the tensor product with another Stinespring. | -| [`to_instruction`](qiskit.quantum_info.Stinespring.to_instruction#qiskit.quantum_info.Stinespring.to_instruction "qiskit.quantum_info.Stinespring.to_instruction") | Convert to a Kraus or UnitaryGate circuit instruction. | -| [`to_operator`](qiskit.quantum_info.Stinespring.to_operator#qiskit.quantum_info.Stinespring.to_operator "qiskit.quantum_info.Stinespring.to_operator") | Try to convert channel to a unitary representation Operator. | -| [`transpose`](qiskit.quantum_info.Stinespring.transpose#qiskit.quantum_info.Stinespring.transpose "qiskit.quantum_info.Stinespring.transpose") | Return the transpose quantum channel. | +### adjoint -## Attributes + + +`Stinespring.adjoint()` + +Return the adjoint quantum channel. + + + This is equivalent to the matrix Hermitian conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the adjoint channel $\mathcal{{E}}^\dagger$ is $S_{\mathcal{E}^\dagger} = S_{\mathcal{E}}^\dagger$. + + +### compose + + + +`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. + +**Parameters** + +* **other** ([*Stinespring*](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")) – a Stinespring object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed Stinespring. + +**Return type** + +[Stinespring](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.Stinespring#dot "qiskit.quantum_info.Stinespring.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.Stinespring#dot "qiskit.quantum_info.Stinespring.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + + + This is equivalent to the matrix complex conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the conjugate channel $\overline{{\mathcal{{E}}}}$ is $S_{\overline{\mathcal{E}^\dagger}} = \overline{S_{\mathcal{E}}}$. + + +### copy + + + +`Stinespring.copy()` + +Make a deep copy of current operator. + +### dot + + + +`Stinespring.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*Stinespring*](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")) – a Stinespring object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current Stinespring, and $b$ is the other Stinespring. + +**Return type** + +[Stinespring](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring") + +### input\_dims + + + +`Stinespring.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_cp + + + +`Stinespring.is_cp(atol=None, rtol=None)` + +Test if Choi-matrix is completely-positive (CP) + +### is\_cptp + + + +`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. + +### is\_tp + + + +`Stinespring.is_tp(atol=None, rtol=None)` + +Test if a channel is trace-preserving (TP) + +### is\_unitary + + + +`Stinespring.is_unitary(atol=None, rtol=None)` + +Return True if QuantumChannel is a unitary channel. + +### output\_dims + +`Stinespring.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`Stinespring.power(n)` + +Return the power of the quantum channel. + +**Parameters** + +**n** (*float*) – the power exponent. + +**Returns** + +the channel $\mathcal{{E}} ^n$. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +**Raises** + +**QiskitError** – if the input and output dimensions of the SuperOp are not equal. + + + For non-positive or non-integer exponents the power is defined as the matrix power of the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{{E}}$, the SuperOp of the powered channel $\mathcal{{E}}^\n$ is $S_{{\mathcal{{E}}^n}} = S_{{\mathcal{{E}}}}^n$. + + +### reshape + + + +`Stinespring.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*Stinespring*](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")) – a Stinespring object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current Stinespring, and $b$ is the other Stinespring. + +**Return type** + +[Stinespring](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`Stinespring.to_instruction()` + +Convert to a Kraus or UnitaryGate circuit instruction. + +If the channel is unitary it will be added as a unitary gate, otherwise it will be added as a kraus simulator instruction. + +**Returns** + +A kraus instruction for the channel. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**QiskitError** – if input data is not an N-qubit CPTP quantum channel. + +### to\_operator + + + +`Stinespring.to_operator()` + +Try to convert channel to a unitary representation Operator. + +### transpose + + + +`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. + + + This is equivalent to the matrix transpose in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation, ie. for a channel $\mathcal{E}$, the SuperOp of the transpose channel $\mathcal{{E}}^T$ is $S_{mathcal{E}^T} = S_{\mathcal{E}}^T$. + + +## Attributes + + ### atol `= 1e-08` - + ### data - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 45b4f071ca9..2b7892a21ce 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.SuperOp.md @@ -1,14 +1,22 @@ -# SuperOp +--- +title: SuperOp +description: API reference for qiskit.quantum_info.SuperOp +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.SuperOp +--- +# SuperOp + -`SuperOp(data, input_dims=None, output_dims=None)` +`SuperOp(data, input_dims=None, output_dims=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/channel/superop.py "view source code") Bases: `qiskit.quantum_info.operators.channel.quantum_channel.QuantumChannel` Superoperator representation of a quantum channel. -The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by +The Superoperator representation of a quantum channel $\mathcal{E}$ is a matrix $S$ such that the evolution of a [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") $\rho$ is given by $$ |\mathcal{E}(\rho)\rangle\!\rangle = S |\rho\rangle\!\rangle @@ -40,67 +48,324 @@ If the input or output dimensions are None, they will be automatically determine ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------- | -| [`adjoint`](qiskit.quantum_info.SuperOp.adjoint#qiskit.quantum_info.SuperOp.adjoint "qiskit.quantum_info.SuperOp.adjoint") | Return the adjoint quantum channel. | -| [`compose`](qiskit.quantum_info.SuperOp.compose#qiskit.quantum_info.SuperOp.compose "qiskit.quantum_info.SuperOp.compose") | Return the operator composition with another SuperOp. | -| [`conjugate`](qiskit.quantum_info.SuperOp.conjugate#qiskit.quantum_info.SuperOp.conjugate "qiskit.quantum_info.SuperOp.conjugate") | Return the conjugate quantum channel. | -| [`copy`](qiskit.quantum_info.SuperOp.copy#qiskit.quantum_info.SuperOp.copy "qiskit.quantum_info.SuperOp.copy") | Make a deep copy of current operator. | -| [`dot`](qiskit.quantum_info.SuperOp.dot#qiskit.quantum_info.SuperOp.dot "qiskit.quantum_info.SuperOp.dot") | Return the right multiplied operator self \* other. | -| [`expand`](qiskit.quantum_info.SuperOp.expand#qiskit.quantum_info.SuperOp.expand "qiskit.quantum_info.SuperOp.expand") | Return the reverse-order tensor product with another SuperOp. | -| [`input_dims`](qiskit.quantum_info.SuperOp.input_dims#qiskit.quantum_info.SuperOp.input_dims "qiskit.quantum_info.SuperOp.input_dims") | Return tuple of input dimension for specified subsystems. | -| [`is_cp`](qiskit.quantum_info.SuperOp.is_cp#qiskit.quantum_info.SuperOp.is_cp "qiskit.quantum_info.SuperOp.is_cp") | Test if Choi-matrix is completely-positive (CP) | -| [`is_cptp`](qiskit.quantum_info.SuperOp.is_cptp#qiskit.quantum_info.SuperOp.is_cptp "qiskit.quantum_info.SuperOp.is_cptp") | Return True if completely-positive trace-preserving (CPTP). | -| [`is_tp`](qiskit.quantum_info.SuperOp.is_tp#qiskit.quantum_info.SuperOp.is_tp "qiskit.quantum_info.SuperOp.is_tp") | Test if a channel is trace-preserving (TP) | -| [`is_unitary`](qiskit.quantum_info.SuperOp.is_unitary#qiskit.quantum_info.SuperOp.is_unitary "qiskit.quantum_info.SuperOp.is_unitary") | Return True if QuantumChannel is a unitary channel. | -| [`output_dims`](qiskit.quantum_info.SuperOp.output_dims#qiskit.quantum_info.SuperOp.output_dims "qiskit.quantum_info.SuperOp.output_dims") | Return tuple of output dimension for specified subsystems. | -| [`power`](qiskit.quantum_info.SuperOp.power#qiskit.quantum_info.SuperOp.power "qiskit.quantum_info.SuperOp.power") | Return the power of the quantum channel. | -| [`reshape`](qiskit.quantum_info.SuperOp.reshape#qiskit.quantum_info.SuperOp.reshape "qiskit.quantum_info.SuperOp.reshape") | Return a shallow copy with reshaped input and output subsystem dimensions. | -| [`tensor`](qiskit.quantum_info.SuperOp.tensor#qiskit.quantum_info.SuperOp.tensor "qiskit.quantum_info.SuperOp.tensor") | Return the tensor product with another SuperOp. | -| [`to_instruction`](qiskit.quantum_info.SuperOp.to_instruction#qiskit.quantum_info.SuperOp.to_instruction "qiskit.quantum_info.SuperOp.to_instruction") | Convert to a Kraus or UnitaryGate circuit instruction. | -| [`to_operator`](qiskit.quantum_info.SuperOp.to_operator#qiskit.quantum_info.SuperOp.to_operator "qiskit.quantum_info.SuperOp.to_operator") | Try to convert channel to a unitary representation Operator. | -| [`transpose`](qiskit.quantum_info.SuperOp.transpose#qiskit.quantum_info.SuperOp.transpose "qiskit.quantum_info.SuperOp.transpose") | Return the transpose quantum channel. | +### adjoint -## Attributes + + +`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. + + + This is equivalent to the matrix Hermitian conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the adjoint channel $\mathcal{{E}}^\dagger$ is $S_{\mathcal{E}^\dagger} = S_{\mathcal{E}}^\dagger$. + + +### compose + + + +`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. + +**Parameters** + +* **other** ([*SuperOp*](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")) – a SuperOp object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). +* **front** (*bool*) – If True compose using right operator multiplication, instead of left multiplication \[default: False]. + +**Returns** + +The composed SuperOp. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +**Raises** + +**QiskitError** – if other cannot be converted to an operator, or has incompatible dimensions for specified subsystems. + + + Composition (`&`) by default is defined as left matrix multiplication for matrix operators, while [`dot()`](qiskit.quantum_info.SuperOp#dot "qiskit.quantum_info.SuperOp.dot") is defined as right matrix multiplication. That is that `A & B == A.compose(B)` is equivalent to `B.dot(A)` when `A` and `B` are of the same type. + + Setting the `front=True` kwarg changes this to right matrix multiplication and is equivalent to the [`dot()`](qiskit.quantum_info.SuperOp#dot "qiskit.quantum_info.SuperOp.dot") method `A.dot(B) == A.compose(B, front=True)`. + + +### conjugate + + + +`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. + + + This is equivalent to the matrix complex conjugate in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{E}$, the SuperOp of the conjugate channel $\overline{{\mathcal{{E}}}}$ is $S_{\overline{\mathcal{E}^\dagger}} = \overline{S_{\mathcal{E}}}$. + + +### copy + + + +`SuperOp.copy()` + +Make a deep copy of current operator. + +### dot + + + +`SuperOp.dot(other, qargs=None)` + +Return the right multiplied operator self \* other. + +**Parameters** + +* **other** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – an operator object. +* **qargs** (*list or None*) – Optional, a list of subsystem positions to apply other on. If None apply on all subsystems (default: None). + +**Returns** + +The right matrix multiplied Operator. + +**Return type** + +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") + +### expand + + + +`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. + +**Parameters** + +**other** ([*SuperOp*](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")) – a SuperOp object. + +**Returns** + +**the tensor product $b \otimes a$, where $a$** + +is the current SuperOp, and $b$ is the other SuperOp. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +### input\_dims + + + +`SuperOp.input_dims(qargs=None)` + +Return tuple of input dimension for specified subsystems. + +### is\_cp + + + +`SuperOp.is_cp(atol=None, rtol=None)` + +Test if Choi-matrix is completely-positive (CP) + +### is\_cptp + + + +`SuperOp.is_cptp(atol=None, rtol=None)` + +Return True if completely-positive trace-preserving (CPTP). + +### is\_tp + + + +`SuperOp.is_tp(atol=None, rtol=None)` + +Test if a channel is trace-preserving (TP) + +### is\_unitary + + + +`SuperOp.is_unitary(atol=None, rtol=None)` + +Return True if QuantumChannel is a unitary channel. + +### output\_dims + +`SuperOp.output_dims(qargs=None)` + +Return tuple of output dimension for specified subsystems. + +### power + + + +`SuperOp.power(n)` + +Return the power of the quantum channel. + +**Parameters** + +**n** (*float*) – the power exponent. + +**Returns** + +the channel $\mathcal{{E}} ^n$. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + +**Raises** + +**QiskitError** – if the input and output dimensions of the SuperOp are not equal. + + + For non-positive or non-integer exponents the power is defined as the matrix power of the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation ie. for a channel $\mathcal{{E}}$, the SuperOp of the powered channel $\mathcal{{E}}^\n$ is $S_{{\mathcal{{E}}^n}} = S_{{\mathcal{{E}}}}^n$. + + +### reshape + + + +`SuperOp.reshape(input_dims=None, output_dims=None, num_qubits=None)` + +Return a shallow copy with reshaped input and output subsystem dimensions. + +**Parameters** + +* **input\_dims** (*None or tuple*) – new subsystem input dimensions. If None the original input dims will be preserved \[Default: None]. +* **output\_dims** (*None or tuple*) – new subsystem output dimensions. If None the original output dims will be preserved \[Default: None]. +* **num\_qubits** (*None or int*) – reshape to an N-qubit operator \[Default: None]. + +**Returns** + +returns self with reshaped input and output dimensions. + +**Return type** + +BaseOperator + +**Raises** + +**QiskitError** – if combined size of all subsystem input dimension or subsystem output dimensions is not constant. + +### tensor + + + +`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. + +**Parameters** + +**other** ([*SuperOp*](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")) – a SuperOp object. + +**Returns** + +**the tensor product $a \otimes b$, where $a$** + +is the current SuperOp, and $b$ is the other SuperOp. + +**Return type** + +[SuperOp](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") + + + The tensor product can be obtained using the `^` binary operator. Hence `a.tensor(b)` is equivalent to `a ^ b`. + + +### to\_instruction + + + +`SuperOp.to_instruction()` + +Convert to a Kraus or UnitaryGate circuit instruction. + +If the channel is unitary it will be added as a unitary gate, otherwise it will be added as a kraus simulator instruction. + +**Returns** + +A kraus instruction for the channel. + +**Return type** + +[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction") + +**Raises** + +**QiskitError** – if input data is not an N-qubit CPTP quantum channel. + +### to\_operator + + + +`SuperOp.to_operator()` + +Try to convert channel to a unitary representation Operator. + +### transpose + + + +`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. + + + This is equivalent to the matrix transpose in the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") representation, ie. for a channel $\mathcal{E}$, the SuperOp of the transpose channel $\mathcal{{E}}^T$ is $S_{mathcal{E}^T} = S_{\mathcal{E}}^T$. + + +## Attributes + + ### atol `= 1e-08` - + ### data Return data. - + ### dim Return tuple (input\_shape, output\_shape). - + ### num\_qubits Return the number of qubits if a N-qubit operator or None otherwise. - + ### qargs Return the qargs for the operator. - + ### rtol `= 1e-05` - + ### settings Return operator settings. + 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 27920bb3ec4..033460fc1ea 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer.md @@ -1,8 +1,16 @@ -# TwoQubitBasisDecomposer +--- +title: TwoQubitBasisDecomposer +description: API reference for qiskit.quantum_info.TwoQubitBasisDecomposer +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.quantum_info.TwoQubitBasisDecomposer +--- +# TwoQubitBasisDecomposer + -`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)` +`TwoQubitBasisDecomposer(gate, basis_fidelity=1.0, euler_basis=None, pulse_optimize=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/synthesis/two_qubit_decompose.py "view source code") Bases: `object` @@ -10,18 +18,72 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub **Parameters** -* **gate** ([*Gate*](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. +* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. ## Methods -| | | | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | ----------------------- | --------------------------------------- | -| [`decomp0`](qiskit.quantum_info.TwoQubitBasisDecomposer.decomp0#qiskit.quantum_info.TwoQubitBasisDecomposer.decomp0 "qiskit.quantum_info.TwoQubitBasisDecomposer.decomp0") | Decompose target \~Ud(x, y, z) with 0 uses of the basis gate. | | | -| [`decomp1`](qiskit.quantum_info.TwoQubitBasisDecomposer.decomp1#qiskit.quantum_info.TwoQubitBasisDecomposer.decomp1 "qiskit.quantum_info.TwoQubitBasisDecomposer.decomp1") | Decompose target \~Ud(x, y, z) with 1 uses of the basis gate \~Ud(a, b, c). Result Ur has trace: .. math::. | | | -| [`decomp2_supercontrolled`](qiskit.quantum_info.TwoQubitBasisDecomposer.decomp2_supercontrolled#qiskit.quantum_info.TwoQubitBasisDecomposer.decomp2_supercontrolled "qiskit.quantum_info.TwoQubitBasisDecomposer.decomp2_supercontrolled") | Decompose target \~Ud(x, y, z) with 2 uses of the basis gate. | | | -| [`decomp3_supercontrolled`](qiskit.quantum_info.TwoQubitBasisDecomposer.decomp3_supercontrolled#qiskit.quantum_info.TwoQubitBasisDecomposer.decomp3_supercontrolled "qiskit.quantum_info.TwoQubitBasisDecomposer.decomp3_supercontrolled") | Decompose target with 3 uses of the basis. | | | -| [`num_basis_gates`](qiskit.quantum_info.TwoQubitBasisDecomposer.num_basis_gates#qiskit.quantum_info.TwoQubitBasisDecomposer.num_basis_gates "qiskit.quantum_info.TwoQubitBasisDecomposer.num_basis_gates") | Computes the number of basis gates needed in a decomposition of input unitary | | | -| [`traces`](qiskit.quantum_info.TwoQubitBasisDecomposer.traces#qiskit.quantum_info.TwoQubitBasisDecomposer.traces "qiskit.quantum_info.TwoQubitBasisDecomposer.traces") | Give the expected traces \$ | Tr(U \cdot Utarget^dag) | \$ for different number of basis gates. | +### decomp0 + + + +`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 + +### decomp1 + + + +`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: + +```python +|Tr(Ur.Utarget^dag)| = 4|cos(x-a)cos(y-b)cos(z-c) + j sin(x-a)sin(y-b)sin(z-c)| +``` + +which is optimal for all targets and bases with z==0 or c==0 + +### decomp2\_supercontrolled + + + +`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. + +For supercontrolled basis \~Ud(pi/4, b, 0), all b, result Ur has trace .. math: + +```python +|Tr(Ur.Utarget^dag)| = 4cos(z) +``` + +which is the optimal approximation for basis of CNOT-class `~Ud(pi/4, 0, 0)` or DCNOT-class `~Ud(pi/4, pi/4, 0)` and any target. May be sub-optimal for b!=0 (e.g. there exists exact decomposition for any target using B `B~Ud(pi/4, pi/8, 0)`, but not this decomposition.) This is an exact decomposition for supercontrolled basis and target `~Ud(x, y, 0)`. No guarantees for non-supercontrolled basis. + +### decomp3\_supercontrolled + + + +`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. + +### num\_basis\_gates + + + +`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 + +### traces + + + +`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 085f7bf5d6e..7fb9a34233e 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.average\_gate\_fidelity +--- +title: average_gate_fidelity +description: API reference for qiskit.quantum_info.average_gate_fidelity +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.average_gate_fidelity +--- +# qiskit.quantum\_info.average\_gate\_fidelity + -`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)` +`average_gate_fidelity(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the average gate fidelity of a noisy quantum channel. @@ -15,12 +23,12 @@ $$ &= \frac{d F_{\text{pro}}(\mathcal{E}, U) + 1}{d + 1}\end{split} $$ -where $F_{\text{pro}}(\mathcal{E}, U)$ is the [`process_fidelity()`](qiskit.quantum_info.process_fidelity#qiskit.quantum_info.process_fidelity "qiskit.quantum_info.process_fidelity") of the input quantum *channel* $\mathcal{E}$ with a *target* unitary $U$, and $d$ is the dimension of the *channel*. +where $F_{\text{pro}}(\mathcal{E}, U)$ is the [`process_fidelity()`](qiskit.quantum_info.process_fidelity "qiskit.quantum_info.process_fidelity") of the input quantum *channel* $\mathcal{E}$ with a *target* unitary $U$, and $d$ is the dimension of the *channel*. **Parameters** -* **channel** (*QuantumChannel or* [*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – noisy quantum channel. -* **target** ([*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or None*) – target unitary operator. If None target is the identity operator \[Default: None]. +* **channel** (*QuantumChannel or* [*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")) – noisy quantum channel. +* **target** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or None*) – target unitary operator. If None target is the identity operator \[Default: None]. * **require\_cp** (*bool*) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. * **require\_tp** (*bool*) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\mbox{out}}[\mathcal{E}] - I$ \[Default: True]. @@ -35,3 +43,4 @@ float **Raises** **QiskitError** – if the channel and target do not have the same dimensions, or have different input and output dimensions. + 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 8362e62b485..c78b08178f3 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.concurrence.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.concurrence.md @@ -1,18 +1,26 @@ -# qiskit.quantum\_info.concurrence +--- +title: concurrence +description: API reference for qiskit.quantum_info.concurrence +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.concurrence +--- +# qiskit.quantum\_info.concurrence + -`concurrence(state)` +`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. -The concurrence of a bipartite [`Statevector`](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ is given by +The concurrence of a bipartite [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") $|\psi\rangle$ is given by $$ C(|\psi\rangle) = \sqrt{2(1 - Tr[\rho_0^2])} $$ -where $\rho_0 = Tr_1[|\psi\rangle\!\langle\psi|]$ is the reduced state from by taking the [`partial_trace()`](qiskit.quantum_info.partial_trace#qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace") of the input state. +where $\rho_0 = Tr_1[|\psi\rangle\!\langle\psi|]$ is the reduced state from by taking the [`partial_trace()`](qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace") of the input state. For density matrices the concurrence is only defined for 2-qubit states, it is given by: @@ -24,7 +32,7 @@ where $\lambda _1 \ge \lambda _2 \ge \lambda _3 \ge \lambda _4$ are the ordered **Parameters** -**state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a 2-qubit quantum state. +**state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a 2-qubit quantum state. **Returns** @@ -39,3 +47,4 @@ float * **QiskitError** – if the input state is not a valid QuantumState. * **QiskitError** – if input is not a bipartite QuantumState. * **QiskitError** – if density matrix input is not a 2-qubit 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 b41bc4b6295..ae82e519865 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.decompose\_clifford +--- +title: decompose_clifford +description: API reference for qiskit.quantum_info.decompose_clifford +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.decompose_clifford +--- +# qiskit.quantum\_info.decompose\_clifford + -`decompose_clifford(clifford, method=None)` +`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. @@ -10,7 +18,7 @@ For N \<= 3 qubits this is based on optimal CX cost decomposition from reference **Parameters** -* **clifford** ([*Clifford*](qiskit.quantum_info.Clifford#qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – a clifford operator. +* **clifford** ([*Clifford*](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")) – a clifford operator. * **method** (*str*) – Optional, a synthesis method (‘AG’ or ‘greedy’). If set this overrides optimal decomposition for N \<=3 qubits. **Returns** @@ -19,10 +27,11 @@ a circuit implementation of the Clifford. **Return type** -[QuantumCircuit](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") +[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") ## References 1. S. Bravyi, D. Maslov, *Hadamard-free circuits expose the structure of the Clifford group*, [arXiv:2003.09412 \[quant-ph\]](https://arxiv.org/abs/2003.09412) 2. S. Aaronson, D. Gottesman, *Improved Simulation of Stabilizer Circuits*, Phys. Rev. A 70, 052328 (2004). [arXiv:quant-ph/0406196](https://arxiv.org/abs/quant-ph/0406196) 3. Sergey Bravyi, Shaohan Hu, Dmitri Maslov, Ruslan Shaydulin, *Clifford Circuit Optimization with Templates and Symbolic Pauli Gates*, [arXiv:2105.02291 \[quant-ph\]](https://arxiv.org/abs/2105.02291) + 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 6224825fec8..86f41fd7f25 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.diamond\_norm +--- +title: diamond_norm +description: API reference for qiskit.quantum_info.diamond_norm +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.diamond_norm +--- +# qiskit.quantum\_info.diamond\_norm + -`diamond_norm(choi, **kwargs)` +`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. @@ -10,7 +18,7 @@ This function computes the completely-bounded trace-norm (often referred to as t **Parameters** -* **choi** ([*Choi*](qiskit.quantum_info.Choi#qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") *or QuantumChannel*) – a quantum channel object or Choi-matrix array. +* **choi** ([*Choi*](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") *or QuantumChannel*) – a quantum channel object or Choi-matrix array. * **kwargs** – optional arguments to pass to CVXPY solver. **Returns** @@ -38,3 +46,4 @@ J. Watrous. “Simpler semidefinite programs for completely bounded norms”, ar This function requires the optional CVXPY package to be installed. Any additional kwargs will be passed to the `cvxpy.solve` function. See the CVXPY documentation for information on available SDP solvers. + 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 a6705eb63bd..ba0a5cf5d39 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.entanglement\_of\_formation +--- +title: entanglement_of_formation +description: API reference for qiskit.quantum_info.entanglement_of_formation +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.entanglement_of_formation +--- +# qiskit.quantum\_info.entanglement\_of\_formation + -`entanglement_of_formation(state)` +`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. @@ -10,7 +18,7 @@ The input quantum state must be either a bipartite state vector, or a 2-qubit de **Parameters** -**state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a 2-qubit quantum state. +**state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a 2-qubit quantum state. **Returns** @@ -25,3 +33,4 @@ float * **QiskitError** – if the input state is not a valid QuantumState. * **QiskitError** – if input is not a bipartite QuantumState. * **QiskitError** – if density matrix input is not a 2-qubit 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 7d81970ce5f..972b7960c19 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.entropy.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.entropy.md @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.entropy +--- +title: entropy +description: API reference for qiskit.quantum_info.entropy +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.entropy +--- +# qiskit.quantum\_info.entropy + -`entropy(state, base=2)` +`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. @@ -14,7 +22,7 @@ $$ **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state. * **base** (*int*) – the base of the logarithm \[Default: 2]. **Returns** @@ -28,3 +36,4 @@ float **Raises** **QiskitError** – if the input state is not a valid QuantumState. + 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 5af69894cb0..2e21141eb7e 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.gate\_error +--- +title: gate_error +description: API reference for qiskit.quantum_info.gate_error +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.gate_error +--- +# qiskit.quantum\_info.gate\_error + -`gate_error(channel, target=None, require_cp=True, require_tp=False)` +`gate_error(channel, target=None, require_cp=True, require_tp=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the gate error of a noisy quantum channel. @@ -12,12 +20,12 @@ $$ E(\mathcal{E}, U) = 1 - F_{\text{ave}}(\mathcal{E}, U) $$ -where $F_{\text{ave}}(\mathcal{E}, U)$ is the [`average_gate_fidelity()`](qiskit.quantum_info.average_gate_fidelity#qiskit.quantum_info.average_gate_fidelity "qiskit.quantum_info.average_gate_fidelity") of the input quantum *channel* $\mathcal{E}$ with a *target* unitary $U$. +where $F_{\text{ave}}(\mathcal{E}, U)$ is the [`average_gate_fidelity()`](qiskit.quantum_info.average_gate_fidelity "qiskit.quantum_info.average_gate_fidelity") of the input quantum *channel* $\mathcal{E}$ with a *target* unitary $U$. **Parameters** * **channel** (*QuantumChannel*) – noisy quantum channel. -* **target** ([*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or None*) – target unitary operator. If None target is the identity operator \[Default: None]. +* **target** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or None*) – target unitary operator. If None target is the identity operator \[Default: None]. * **require\_cp** (*bool*) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. * **require\_tp** (*bool*) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\mbox{out}}[\mathcal{E}] - I$ \[Default: True]. @@ -32,3 +40,4 @@ float **Raises** **QiskitError** – if the channel and target do not have the same dimensions, or have different input and output dimensions. + 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 097e6d0fbd5..a74d9223153 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.hellinger\_distance +--- +title: hellinger_distance +description: API reference for qiskit.quantum_info.hellinger_distance +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.hellinger_distance +--- +# qiskit.quantum\_info.hellinger\_distance + -`hellinger_distance(dist_p, dist_q)` +`hellinger_distance(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger distance between two counts distributions. @@ -22,3 +30,4 @@ float ## References [Hellinger Distance @ wikipedia](https://en.wikipedia.org/wiki/Hellinger_distance) + 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 91bd21d2a26..5a8379aeb45 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.hellinger\_fidelity +--- +title: hellinger_fidelity +description: API reference for qiskit.quantum_info.hellinger_fidelity +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.hellinger_fidelity +--- +# qiskit.quantum\_info.hellinger\_fidelity + -`hellinger_fidelity(dist_p, dist_q)` +`hellinger_fidelity(dist_p, dist_q)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/analysis/distance.py "view source code") Computes the Hellinger fidelity between two counts distributions. @@ -51,3 +59,4 @@ hellinger_fidelity(res1.get_counts(), res2.get_counts()) ## References [Quantum Fidelity @ wikipedia](https://en.wikipedia.org/wiki/Fidelity_of_quantum_states) [Hellinger Distance @ wikipedia](https://en.wikipedia.org/wiki/Hellinger_distance) + 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 a220d803997..e4a660de27e 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.mutual\_information +--- +title: mutual_information +description: API reference for qiskit.quantum_info.mutual_information +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.mutual_information +--- +# qiskit.quantum\_info.mutual\_information + -`mutual_information(state, base=2)` +`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. @@ -16,7 +24,7 @@ where $\rho_A=Tr_B[\rho_{AB}], \rho_B=Tr_A[\rho_{AB}]$, are the reduced density **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a bipartite state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a bipartite state. * **base** (*int*) – the base of the logarithm \[Default: 2]. **Returns** @@ -31,3 +39,4 @@ float * **QiskitError** – if the input state is not a valid QuantumState. * **QiskitError** – if input is not a bipartite QuantumState. + 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 ced94cefd76..fcab650edfc 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 @@ -1,16 +1,24 @@ -# qiskit.quantum\_info.partial\_trace +--- +title: partial_trace +description: API reference for qiskit.quantum_info.partial_trace +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.partial_trace +--- +# qiskit.quantum\_info.partial\_trace + -`partial_trace(state, qargs)` +`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. -If all subsystems are traced over this returns the [`trace()`](qiskit.quantum_info.DensityMatrix.trace#qiskit.quantum_info.DensityMatrix.trace "qiskit.quantum_info.DensityMatrix.trace") of the input state. +If all subsystems are traced over this returns the [`trace()`](qiskit.quantum_info.DensityMatrix#trace "qiskit.quantum_info.DensityMatrix.trace") of the input state. **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the input state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the input state. * **qargs** (*list*) – The subsystems to trace over. **Returns** @@ -19,8 +27,9 @@ The reduced density matrix. **Return type** -[DensityMatrix](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") **Raises** **QiskitError** – if input state is invalid. + 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 6966b12d5d0..1013541d50e 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.pauli\_basis +--- +title: pauli_basis +description: API reference for qiskit.quantum_info.pauli_basis +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.pauli_basis +--- +# qiskit.quantum\_info.pauli\_basis + -`pauli_basis(num_qubits, weight=False)` +`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. @@ -17,4 +25,5 @@ the PauliTable for the basis **Return type** -[PauliTable](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + 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 1bc6fb7f056..4e5d94cc6fe 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 @@ -1,12 +1,20 @@ -# qiskit.quantum\_info.pauli\_group +--- +title: pauli_group +description: API reference for qiskit.quantum_info.pauli_group +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.pauli_group +--- +# qiskit.quantum\_info.pauli\_group + -`pauli_group(number_of_qubits, case='weight')` +`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. -This function is deprecated. Use [`pauli_basis()`](qiskit.quantum_info.pauli_basis#qiskit.quantum_info.pauli_basis "qiskit.quantum_info.pauli_basis") for equivalent functionality. +This function is deprecated. Use [`pauli_basis()`](qiskit.quantum_info.pauli_basis "qiskit.quantum_info.pauli_basis") for equivalent functionality. The phases have been removed. case ‘weight’ is ordered by Pauli weights and case ‘tensor’ is ordered by I,X,Y,Z counting lowest qubit fastest. @@ -27,3 +35,4 @@ list * **QiskitError** – case is not ‘weight’ or ‘tensor’ * **QiskitError** – number\_of\_qubits is larger than 4 + 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 9d9b95313c5..54dc69af792 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.process\_fidelity +--- +title: process_fidelity +description: API reference for qiskit.quantum_info.process_fidelity +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.process_fidelity +--- +# qiskit.quantum\_info.process\_fidelity + -`process_fidelity(channel, target=None, require_cp=True, require_tp=True)` +`process_fidelity(channel, target=None, require_cp=True, require_tp=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/measures.py "view source code") Return the process fidelity of a noisy quantum channel. @@ -13,7 +21,7 @@ F_{\text{pro}}(\mathcal{E}, \mathcal{F}) = F(\rho_{\mathcal{E}}, \rho_{\mathcal{F}}) $$ -where $F$ is the [`state_fidelity()`](qiskit.quantum_info.state_fidelity#qiskit.quantum_info.state_fidelity "qiskit.quantum_info.state_fidelity"), $\rho_{\mathcal{E}} = \Lambda_{\mathcal{E}} / d$ is the normalized [`Choi`](qiskit.quantum_info.Choi#qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") matrix for the channel $\mathcal{E}$, and $d$ is the input dimension of $\mathcal{E}$. +where $F$ is the [`state_fidelity()`](qiskit.quantum_info.state_fidelity "qiskit.quantum_info.state_fidelity"), $\rho_{\mathcal{E}} = \Lambda_{\mathcal{E}} / d$ is the normalized [`Choi`](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi") matrix for the channel $\mathcal{E}$, and $d$ is the input dimension of $\mathcal{E}$. When the target channel is unitary this is equivalent to @@ -22,12 +30,12 @@ F_{\text{pro}}(\mathcal{E}, U) = \frac{Tr[S_U^\dagger S_{\mathcal{E}}]}{d^2} $$ -where $S_{\mathcal{E}}, S_{U}$ are the [`SuperOp`](qiskit.quantum_info.SuperOp#qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") matrices for the *input* quantum channel $\mathcal{E}$ and *target* unitary $U$ respectively, and $d$ is the input dimension of the channel. +where $S_{\mathcal{E}}, S_{U}$ are the [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp") matrices for the *input* quantum channel $\mathcal{E}$ and *target* unitary $U$ respectively, and $d$ is the input dimension of the channel. **Parameters** -* **channel** ([*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or QuantumChannel*) – input quantum channel. -* **target** ([*Operator*](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or QuantumChannel or None*) – target quantum channel. If None target is the identity operator \[Default: None]. +* **channel** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or QuantumChannel*) – input quantum channel. +* **target** ([*Operator*](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") *or QuantumChannel or None*) – target quantum channel. If None target is the identity operator \[Default: None]. * **require\_cp** (*bool*) – check if input and target channels are completely-positive and if non-CP log warning containing negative eigenvalues of Choi-matrix \[Default: True]. * **require\_tp** (*bool*) – check if input and target channels are trace-preserving and if non-TP log warning containing negative eigenvalues of partial Choi-matrix $Tr_{\mbox{out}}[\mathcal{E}] - I$ \[Default: True]. @@ -42,3 +50,4 @@ float **Raises** **QiskitError** – if the channel and target do not have the same dimensions. + 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 bf3fa7e0a8b..2508d906b61 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.purity.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.purity.md @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.purity +--- +title: purity +description: API reference for qiskit.quantum_info.purity +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.purity +--- +# qiskit.quantum\_info.purity + -`purity(state, validate=True)` +`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. @@ -14,7 +22,7 @@ $$ **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – a quantum state. * **validate** (*bool*) – check if input state is valid \[Default: True] **Returns** @@ -28,3 +36,4 @@ float **Raises** **QiskitError** – if the input isn’t a valid 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 34fc22f67f2..e397857937f 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_clifford +--- +title: random_clifford +description: API reference for qiskit.quantum_info.random_clifford +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_clifford +--- +# qiskit.quantum\_info.random\_clifford + -`random_clifford(num_qubits, seed=None)` +`random_clifford(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Clifford operator. @@ -19,8 +27,9 @@ a random Clifford operator. **Return type** -[Clifford](qiskit.quantum_info.Clifford#qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") +[Clifford](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford") ## Reference: 1. S. Bravyi and D. Maslov, *Hadamard-free circuits expose the structure of the Clifford group*. [arXiv:2003.09412 \[quant-ph\]](https://arxiv.org/abs/2003.09412) + 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 bcbfd73de9e..78482875122 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_cnotdihedral +--- +title: random_cnotdihedral +description: API reference for qiskit.quantum_info.random_cnotdihedral +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_cnotdihedral +--- +# qiskit.quantum\_info.random\_cnotdihedral + -`random_cnotdihedral(num_qubits, seed=None)` +`random_cnotdihedral(num_qubits, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/dihedral/random.py "view source code") Return a random CNOTDihedral element. @@ -17,4 +25,5 @@ a random CNOTDihedral element. **Return type** -[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral#qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") +[CNOTDihedral](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral") + 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 5a46cdf1af7..712a7a1eb2c 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_density\_matrix +--- +title: random_density_matrix +description: API reference for qiskit.quantum_info.random_density_matrix +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_density_matrix +--- +# qiskit.quantum\_info.random\_density\_matrix + -`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)` +`random_density_matrix(dims, rank=None, method='Hilbert-Schmidt', seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/random.py "view source code") Generator a random DensityMatrix. @@ -19,8 +27,9 @@ the random density matrix. **Return type** -[DensityMatrix](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") +[DensityMatrix](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") **Raises** **QiskitError** – if the method is not valid. + 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 1634007bcd6..7822a9824b8 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_hermitian +--- +title: random_hermitian +description: API reference for qiskit.quantum_info.random_hermitian +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_hermitian +--- +# qiskit.quantum\_info.random\_hermitian + -`random_hermitian(dims, traceless=False, seed=None)` +`random_hermitian(dims, traceless=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random hermitian Operator. @@ -20,4 +28,5 @@ a Hermitian operator. **Return type** -[Operator](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.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 58cdd8f0feb..bd5ff2607f8 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_pauli +--- +title: random_pauli +description: API reference for qiskit.quantum_info.random_pauli +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_pauli +--- +# qiskit.quantum\_info.random\_pauli + -`random_pauli(num_qubits, group_phase=False, seed=None)` +`random_pauli(num_qubits, group_phase=False, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random Pauli. @@ -18,4 +26,5 @@ a random Pauli **Return type** -[Pauli](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli") +[Pauli](qiskit.quantum_info.Pauli "qiskit.quantum_info.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 45a42cf89d8..137ca4d950e 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_pauli\_table +--- +title: random_pauli_table +description: API reference for qiskit.quantum_info.random_pauli_table +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_pauli_table +--- +# qiskit.quantum\_info.random\_pauli\_table + -`random_pauli_table(num_qubits, size=1, seed=None)` +`random_pauli_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random PauliTable. @@ -18,4 +26,5 @@ a random PauliTable. **Return type** -[PauliTable](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.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 80350347518..22449571abe 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_quantum\_channel +--- +title: random_quantum_channel +description: API reference for qiskit.quantum_info.random_quantum_channel +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_quantum_channel +--- +# qiskit.quantum\_info.random\_quantum\_channel + -`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)` +`random_quantum_channel(input_dims=None, output_dims=None, rank=None, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/random.py "view source code") Return a random CPTP quantum channel. @@ -21,8 +29,9 @@ a quantum channel operator. **Return type** -[Stinespring](qiskit.quantum_info.Stinespring#qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring") +[Stinespring](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring") **Raises** **QiskitError** – if rank or dimensions are invalid. + 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 50dad2a6226..7b50b105331 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_stabilizer\_table +--- +title: random_stabilizer_table +description: API reference for qiskit.quantum_info.random_stabilizer_table +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_stabilizer_table +--- +# qiskit.quantum\_info.random\_stabilizer\_table + -`random_stabilizer_table(num_qubits, size=1, seed=None)` +`random_stabilizer_table(num_qubits, size=1, seed=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/operators/symplectic/random.py "view source code") Return a random StabilizerTable. @@ -18,4 +26,5 @@ a random StabilizerTable. **Return type** -[PauliTable](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") +[PauliTable](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable") + 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 d3aa1b96d10..ffd24a93345 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_statevector +--- +title: random_statevector +description: API reference for qiskit.quantum_info.random_statevector +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_statevector +--- +# qiskit.quantum\_info.random\_statevector + -`random_statevector(dims, seed=None)` +`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. @@ -19,4 +27,5 @@ the random statevector. **Return type** -[Statevector](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") +[Statevector](qiskit.quantum_info.Statevector "qiskit.quantum_info.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 56fe9445411..fbfab7f787f 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.random\_unitary +--- +title: random_unitary +description: API reference for qiskit.quantum_info.random_unitary +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.random_unitary +--- +# qiskit.quantum\_info.random\_unitary + -`random_unitary(dims, seed=None)` +`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. @@ -19,4 +27,5 @@ a unitary operator. **Return type** -[Operator](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator") +[Operator](qiskit.quantum_info.Operator "qiskit.quantum_info.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 258b8eb3da0..3cffae817a1 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.shannon\_entropy +--- +title: shannon_entropy +description: API reference for qiskit.quantum_info.shannon_entropy +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.shannon_entropy +--- +# qiskit.quantum\_info.shannon\_entropy + -`shannon_entropy(pvec, base=2)` +`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. @@ -26,3 +34,4 @@ The Shannon entropy H(pvec). **Return type** float + 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 51c5495ca6a..a17bb1a7eeb 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 @@ -1,8 +1,16 @@ -# qiskit.quantum\_info.state\_fidelity +--- +title: state_fidelity +description: API reference for qiskit.quantum_info.state_fidelity +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.quantum_info.state_fidelity +--- +# qiskit.quantum\_info.state\_fidelity + -`state_fidelity(state1, state2, validate=True)` +`state_fidelity(state1, state2, validate=True)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/quantum_info/states/measures.py "view source code") Return the state fidelity between two quantum states. @@ -16,8 +24,8 @@ If one of the states is a pure state this simplifies to $F(\rho_1, \rho_2) = \la **Parameters** -* **state1** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the first quantum state. -* **state2** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the second quantum state. +* **state1** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the first quantum state. +* **state2** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")) – the second quantum state. * **validate** (*bool*) – check if the inputs are valid quantum states \[Default: True] **Returns** @@ -31,3 +39,4 @@ float **Raises** **QiskitError** – if `validate=True` and the inputs are invalid quantum states. + diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.md b/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.md index 9402c150bb1..505da64312b 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.md +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.md @@ -6,7 +6,7 @@ A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qub **Parameters** -* **gate** ([*Gate*](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. +* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. diff --git a/docs/api/qiskit/0.32/qiskit.result.Counts.md b/docs/api/qiskit/0.32/qiskit.result.Counts.md index add449b1965..3e0c1b28c27 100644 --- a/docs/api/qiskit/0.32/qiskit.result.Counts.md +++ b/docs/api/qiskit/0.32/qiskit.result.Counts.md @@ -1,8 +1,16 @@ -# Counts +--- +title: Counts +description: API reference for qiskit.result.Counts +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.result.Counts +--- +# Counts + -`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)` +`Counts(data, time_taken=None, creg_sizes=None, memory_slots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/counts.py "view source code") Bases: `dict` @@ -19,7 +27,7 @@ Build a counts object > * A hexadecimal string of the form `"0x4a"` > * A bit string prefixed with `0b` for example `'0b1011'` > * A bit string formatted across register and memory slots. For example, `'00 10'`. - > * A dit string, for example `'02'`. Note for objects created with dit strings the `creg_sizes``and ``memory_slots` kwargs don’t work and [`hex_outcomes()`](qiskit.result.Counts.hex_outcomes#qiskit.result.Counts.hex_outcomes "qiskit.result.Counts.hex_outcomes") and [`int_outcomes()`](qiskit.result.Counts.int_outcomes#qiskit.result.Counts.int_outcomes "qiskit.result.Counts.int_outcomes") also do not work. + > * A dit string, for example `'02'`. Note for objects created with dit strings the `creg_sizes``and ``memory_slots` kwargs don’t work and [`hex_outcomes()`](qiskit.result.Counts#hex_outcomes "qiskit.result.Counts.hex_outcomes") and [`int_outcomes()`](qiskit.result.Counts#int_outcomes "qiskit.result.Counts.int_outcomes") also do not work. * **time\_taken** (*float*) – The duration of the experiment that generated the counts @@ -34,27 +42,153 @@ Build a counts object ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.result.Counts.clear#qiskit.result.Counts.clear "qiskit.result.Counts.clear") | | -| [`copy`](qiskit.result.Counts.copy#qiskit.result.Counts.copy "qiskit.result.Counts.copy") | | -| [`fromkeys`](qiskit.result.Counts.fromkeys#qiskit.result.Counts.fromkeys "qiskit.result.Counts.fromkeys") | Create a new dictionary with keys from iterable and values set to value. | -| [`get`](qiskit.result.Counts.get#qiskit.result.Counts.get "qiskit.result.Counts.get") | Return the value for key if key is in the dictionary, else default. | -| [`hex_outcomes`](qiskit.result.Counts.hex_outcomes#qiskit.result.Counts.hex_outcomes "qiskit.result.Counts.hex_outcomes") | Return a counts dictionary with hexadecimal string keys | -| [`int_outcomes`](qiskit.result.Counts.int_outcomes#qiskit.result.Counts.int_outcomes "qiskit.result.Counts.int_outcomes") | Build a counts dictionary with integer keys instead of count strings | -| [`items`](qiskit.result.Counts.items#qiskit.result.Counts.items "qiskit.result.Counts.items") | | -| [`keys`](qiskit.result.Counts.keys#qiskit.result.Counts.keys "qiskit.result.Counts.keys") | | -| [`most_frequent`](qiskit.result.Counts.most_frequent#qiskit.result.Counts.most_frequent "qiskit.result.Counts.most_frequent") | Return the most frequent count | -| [`pop`](qiskit.result.Counts.pop#qiskit.result.Counts.pop "qiskit.result.Counts.pop") | If key is not found, d is returned if given, otherwise KeyError is raised | -| [`popitem`](qiskit.result.Counts.popitem#qiskit.result.Counts.popitem "qiskit.result.Counts.popitem") | 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.result.Counts.setdefault#qiskit.result.Counts.setdefault "qiskit.result.Counts.setdefault") | Insert key with a value of default if key is not in the dictionary. | -| [`update`](qiskit.result.Counts.update#qiskit.result.Counts.update "qiskit.result.Counts.update") | If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] | -| [`values`](qiskit.result.Counts.values#qiskit.result.Counts.values "qiskit.result.Counts.values") | | +### clear -## Attributes + + +`Counts.clear() → None. Remove all items from D.` + +### copy + + + +`Counts.copy() → a shallow copy of D` + +### fromkeys + + + +`Counts.fromkeys(value=None, /)` + +Create a new dictionary with keys from iterable and values set to value. + +### get + + + +`Counts.get(key, default=None, /)` + +Return the value for key if key is in the dictionary, else default. + +### hex\_outcomes + + + +`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 + +**Returns** + +**A dictionary with the keys as hexadecimal strings instead of** + +bitstrings + +**Return type** + +dict + +**Raises** + +**QiskitError** – If the Counts object contains counts for dit strings + +### int\_outcomes + + + +`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 + +**Returns** + +A dictionary with the keys as integers instead of bitstrings + +**Return type** + +dict + +**Raises** + +**QiskitError** – If the Counts object contains counts for dit strings + +### items + +`Counts.items() → a set-like object providing a view on D’s items` + +### keys + + + +`Counts.keys() → a set-like object providing a view on D’s keys` + +### most\_frequent + + + +`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 + +**Returns** + +The bit string for the most frequent result + +**Return type** + +str + +**Raises** + +**QiskitError** – when there is >1 count with the same max counts, or an empty object. + +### pop + + + +`Counts.pop(k[, d]) → v, remove specified key and return the corresponding value.` + +If key is not found, d is returned if given, otherwise KeyError is raised + +### popitem + + + +`Counts.popitem() → (k, v), remove and return some (key, value) pair as a` + +2-tuple; but raise KeyError if D is empty. + +### setdefault + + + +`Counts.setdefault(key, default=None, /)` + +Insert key with a value of default if key is not in the dictionary. + +Return the value for key if key is in the dictionary, else default. + +### update + + + +`Counts.update([E, ]**F) → None. Update D from dict/iterable E and F.` + +If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + +### values + + + +`Counts.values() → an object providing a view on D’s values` + +## Attributes + + ### bitstring\_regex `= re.compile('^[01\\s]+$')` + diff --git a/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md b/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md index 325907678c7..652a93c0df8 100644 --- a/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.result.ProbDistribution.md @@ -1,8 +1,16 @@ -# ProbDistribution +--- +title: ProbDistribution +description: API reference for qiskit.result.ProbDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.result.ProbDistribution +--- +# ProbDistribution + -`ProbDistribution(data, shots=None)` +`ProbDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/probability.py "view source code") Bases: `dict` @@ -29,18 +37,123 @@ Builds a probability distribution object. ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`binary_probabilities`](qiskit.result.ProbDistribution.binary_probabilities#qiskit.result.ProbDistribution.binary_probabilities "qiskit.result.ProbDistribution.binary_probabilities") | Build a probabilities dictionary with binary string keys | -| [`clear`](qiskit.result.ProbDistribution.clear#qiskit.result.ProbDistribution.clear "qiskit.result.ProbDistribution.clear") | | -| [`copy`](qiskit.result.ProbDistribution.copy#qiskit.result.ProbDistribution.copy "qiskit.result.ProbDistribution.copy") | | -| [`fromkeys`](qiskit.result.ProbDistribution.fromkeys#qiskit.result.ProbDistribution.fromkeys "qiskit.result.ProbDistribution.fromkeys") | Create a new dictionary with keys from iterable and values set to value. | -| [`get`](qiskit.result.ProbDistribution.get#qiskit.result.ProbDistribution.get "qiskit.result.ProbDistribution.get") | Return the value for key if key is in the dictionary, else default. | -| [`hex_probabilities`](qiskit.result.ProbDistribution.hex_probabilities#qiskit.result.ProbDistribution.hex_probabilities "qiskit.result.ProbDistribution.hex_probabilities") | Build a probabilities dictionary with hexadecimal string keys | -| [`items`](qiskit.result.ProbDistribution.items#qiskit.result.ProbDistribution.items "qiskit.result.ProbDistribution.items") | | -| [`keys`](qiskit.result.ProbDistribution.keys#qiskit.result.ProbDistribution.keys "qiskit.result.ProbDistribution.keys") | | -| [`pop`](qiskit.result.ProbDistribution.pop#qiskit.result.ProbDistribution.pop "qiskit.result.ProbDistribution.pop") | If key is not found, d is returned if given, otherwise KeyError is raised | -| [`popitem`](qiskit.result.ProbDistribution.popitem#qiskit.result.ProbDistribution.popitem "qiskit.result.ProbDistribution.popitem") | 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.result.ProbDistribution.setdefault#qiskit.result.ProbDistribution.setdefault "qiskit.result.ProbDistribution.setdefault") | Insert key with a value of default if key is not in the dictionary. | -| [`update`](qiskit.result.ProbDistribution.update#qiskit.result.ProbDistribution.update "qiskit.result.ProbDistribution.update") | If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] | -| [`values`](qiskit.result.ProbDistribution.values#qiskit.result.ProbDistribution.values "qiskit.result.ProbDistribution.values") | | +### binary\_probabilities + + + +`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 + +**Parameters** + +**num\_bits** (*int*) – number of bits in the binary bitstrings (leading zeros will be padded). If None, the length will be derived from the largest key present. + +**Returns** + +**A dictionary where the keys are binary strings in the format** + +`"0110"` + +**Return type** + +dict + +### clear + + + +`ProbDistribution.clear() → None. Remove all items from D.` + +### copy + + + +`ProbDistribution.copy() → a shallow copy of D` + +### fromkeys + + + +`ProbDistribution.fromkeys(value=None, /)` + +Create a new dictionary with keys from iterable and values set to value. + +### get + + + +`ProbDistribution.get(key, default=None, /)` + +Return the value for key if key is in the dictionary, else default. + +### hex\_probabilities + + + +`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 + +**Returns** + +**A dictionary where the keys are hexadecimal strings in the** + +format `"0x1a"` + +**Return type** + +dict + +### items + + + +`ProbDistribution.items() → a set-like object providing a view on D’s items` + +### keys + + + +`ProbDistribution.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`ProbDistribution.pop(k[, d]) → v, remove specified key and return the corresponding value.` + +If key is not found, d is returned if given, otherwise KeyError is raised + +### popitem + + + +`ProbDistribution.popitem() → (k, v), remove and return some (key, value) pair as a` + +2-tuple; but raise KeyError if D is empty. + +### setdefault + + + +`ProbDistribution.setdefault(key, default=None, /)` + +Insert key with a value of default if key is not in the dictionary. + +Return the value for key if key is in the dictionary, else default. + +### update + + + +`ProbDistribution.update([E, ]**F) → None. Update D from dict/iterable E and F.` + +If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + +### values + + + +`ProbDistribution.values() → an object providing a view on D’s values` + diff --git a/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md b/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md index e326ced960e..ae283986e11 100644 --- a/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md +++ b/docs/api/qiskit/0.32/qiskit.result.QuasiDistribution.md @@ -1,8 +1,16 @@ -# QuasiDistribution +--- +title: QuasiDistribution +description: API reference for qiskit.result.QuasiDistribution +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.result.QuasiDistribution +--- +# QuasiDistribution + -`QuasiDistribution(data, shots=None)` +`QuasiDistribution(data, shots=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/distributions/quasi.py "view source code") Bases: `dict` @@ -29,19 +37,147 @@ Builds a quasiprobability distribution object. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`binary_probabilities`](qiskit.result.QuasiDistribution.binary_probabilities#qiskit.result.QuasiDistribution.binary_probabilities "qiskit.result.QuasiDistribution.binary_probabilities") | Build a quasi-probabilities dictionary with binary string keys | -| [`clear`](qiskit.result.QuasiDistribution.clear#qiskit.result.QuasiDistribution.clear "qiskit.result.QuasiDistribution.clear") | | -| [`copy`](qiskit.result.QuasiDistribution.copy#qiskit.result.QuasiDistribution.copy "qiskit.result.QuasiDistribution.copy") | | -| [`fromkeys`](qiskit.result.QuasiDistribution.fromkeys#qiskit.result.QuasiDistribution.fromkeys "qiskit.result.QuasiDistribution.fromkeys") | Create a new dictionary with keys from iterable and values set to value. | -| [`get`](qiskit.result.QuasiDistribution.get#qiskit.result.QuasiDistribution.get "qiskit.result.QuasiDistribution.get") | Return the value for key if key is in the dictionary, else default. | -| [`hex_probabilities`](qiskit.result.QuasiDistribution.hex_probabilities#qiskit.result.QuasiDistribution.hex_probabilities "qiskit.result.QuasiDistribution.hex_probabilities") | Build a quasi-probabilities dictionary with hexadecimal string keys | -| [`items`](qiskit.result.QuasiDistribution.items#qiskit.result.QuasiDistribution.items "qiskit.result.QuasiDistribution.items") | | -| [`keys`](qiskit.result.QuasiDistribution.keys#qiskit.result.QuasiDistribution.keys "qiskit.result.QuasiDistribution.keys") | | -| [`nearest_probability_distribution`](qiskit.result.QuasiDistribution.nearest_probability_distribution#qiskit.result.QuasiDistribution.nearest_probability_distribution "qiskit.result.QuasiDistribution.nearest_probability_distribution") | Takes a quasiprobability distribution and maps it to the closest probability distribution as defined by the L2-norm. | -| [`pop`](qiskit.result.QuasiDistribution.pop#qiskit.result.QuasiDistribution.pop "qiskit.result.QuasiDistribution.pop") | If key is not found, d is returned if given, otherwise KeyError is raised | -| [`popitem`](qiskit.result.QuasiDistribution.popitem#qiskit.result.QuasiDistribution.popitem "qiskit.result.QuasiDistribution.popitem") | 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.result.QuasiDistribution.setdefault#qiskit.result.QuasiDistribution.setdefault "qiskit.result.QuasiDistribution.setdefault") | Insert key with a value of default if key is not in the dictionary. | -| [`update`](qiskit.result.QuasiDistribution.update#qiskit.result.QuasiDistribution.update "qiskit.result.QuasiDistribution.update") | If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] | -| [`values`](qiskit.result.QuasiDistribution.values#qiskit.result.QuasiDistribution.values "qiskit.result.QuasiDistribution.values") | | +### binary\_probabilities + + + +`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 + +**Parameters** + +**num\_bits** (*int*) – number of bits in the binary bitstrings (leading zeros will be padded). If None, the length will be derived from the largest key present. + +**Returns** + +**A dictionary where the keys are binary strings in the format** + +`"0110"` + +**Return type** + +dict + +### clear + + + +`QuasiDistribution.clear() → None. Remove all items from D.` + +### copy + + + +`QuasiDistribution.copy() → a shallow copy of D` + +### fromkeys + + + +`QuasiDistribution.fromkeys(value=None, /)` + +Create a new dictionary with keys from iterable and values set to value. + +### get + + + +`QuasiDistribution.get(key, default=None, /)` + +Return the value for key if key is in the dictionary, else default. + +### hex\_probabilities + + + +`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 + +**Returns** + +**A dictionary where the keys are hexadecimal strings in the** + +format `"0x1a"` + +**Return type** + +dict + +### items + + + +`QuasiDistribution.items() → a set-like object providing a view on D’s items` + +### keys + + + +`QuasiDistribution.keys() → a set-like object providing a view on D’s keys` + +### nearest\_probability\_distribution + + + +`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. + +**Parameters** + +**return\_distance** (*bool*) – Return the L2 distance between distributions. + +**Returns** + +Nearest probability distribution. float: Euclidean (L2) distance of distributions. + +**Return type** + +[ProbDistribution](qiskit.result.ProbDistribution "qiskit.result.ProbDistribution") + +#### Notes + +Method from Smolin et al., Phys. Rev. Lett. 108, 070502 (2012). + +### pop + + + +`QuasiDistribution.pop(k[, d]) → v, remove specified key and return the corresponding value.` + +If key is not found, d is returned if given, otherwise KeyError is raised + +### popitem + + + +`QuasiDistribution.popitem() → (k, v), remove and return some (key, value) pair as a` + +2-tuple; but raise KeyError if D is empty. + +### setdefault + + + +`QuasiDistribution.setdefault(key, default=None, /)` + +Insert key with a value of default if key is not in the dictionary. + +Return the value for key if key is in the dictionary, else default. + +### update + + + +`QuasiDistribution.update([E, ]**F) → None. Update D from dict/iterable E and F.` + +If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + +### values + + + +`QuasiDistribution.values() → an object providing a view on D’s values` + diff --git a/docs/api/qiskit/0.32/qiskit.result.Result.md b/docs/api/qiskit/0.32/qiskit.result.Result.md index c747d53bcc3..1d5d04a9af8 100644 --- a/docs/api/qiskit/0.32/qiskit.result.Result.md +++ b/docs/api/qiskit/0.32/qiskit.result.Result.md @@ -1,14 +1,22 @@ -# Result +--- +title: Result +description: API reference for qiskit.result.Result +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.result.Result +--- +# Result + -`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)` +`Result(backend_name, backend_version, qobj_id, job_id, success, results, date=None, status=None, header=None, **kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/result/result.py "view source code") Bases: `object` Model for Results. - + ### backend\_name @@ -18,7 +26,7 @@ backend name. str - + ### backend\_version @@ -28,7 +36,7 @@ backend version, in the form X.Y.Z. str - + ### qobj\_id @@ -38,7 +46,7 @@ user-generated Qobj id. str - + ### job\_id @@ -48,7 +56,7 @@ unique execution id from the backend. str - + ### success @@ -58,7 +66,7 @@ True if complete input qobj executed correctly. (Implies each experiment success bool - + ### results @@ -70,12 +78,181 @@ list\[ExperimentResult] ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`data`](qiskit.result.Result.data#qiskit.result.Result.data "qiskit.result.Result.data") | Get the raw data for an experiment. | -| [`from_dict`](qiskit.result.Result.from_dict#qiskit.result.Result.from_dict "qiskit.result.Result.from_dict") | Create a new ExperimentResultData object from a dictionary. | -| [`get_counts`](qiskit.result.Result.get_counts#qiskit.result.Result.get_counts "qiskit.result.Result.get_counts") | Get the histogram data of an experiment. | -| [`get_memory`](qiskit.result.Result.get_memory#qiskit.result.Result.get_memory "qiskit.result.Result.get_memory") | 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’] | -| [`get_statevector`](qiskit.result.Result.get_statevector#qiskit.result.Result.get_statevector "qiskit.result.Result.get_statevector") | Get the final statevector of an experiment. | -| [`get_unitary`](qiskit.result.Result.get_unitary#qiskit.result.Result.get_unitary "qiskit.result.Result.get_unitary") | Get the final unitary of an experiment. | -| [`to_dict`](qiskit.result.Result.to_dict#qiskit.result.Result.to_dict "qiskit.result.Result.to_dict") | Return a dictionary format representation of the Result | +### data + + + +`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. + +Note this data will be a single classical and quantum register and in a format required by the results schema. We recommend that most users use the get\_xxx method, and the data will be post-processed for the data type. + +**Parameters** + +**experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment. Several types are accepted for convenience:: \* str: the name of the experiment. \* QuantumCircuit: the name of the circuit instance will be used. \* Schedule: the name of the schedule instance will be used. \* int: the position of the experiment. \* None: if there is only one experiment, returns it. + +**Returns** + +A dictionary of results data for an experiment. The data depends on the backend it ran on and the settings of meas\_level, meas\_return and memory. + +QASM backends return a dictionary of dictionary with the key ‘counts’ and with the counts, with the second dictionary keys containing a string in hex format (`0x123`) and values equal to the number of times this outcome was measured. + +Statevector backends return a dictionary with key ‘statevector’ and values being a list\[list\[complex components]] list of 2^num\_qubits complex amplitudes. Where each complex number is represented as a 2 entry list for each component. For example, a list of \[0.5+1j, 0-1j] would be represented as \[\[0.5, 1], \[0, -1]]. + +Unitary backends return a dictionary with key ‘unitary’ and values being a list\[list\[list\[complex components]]] list of 2^num\_qubits x 2^num\_qubits complex amplitudes in a two entry list for each component. For example if the amplitude is \[\[0.5+0j, 0-1j], …] the value returned will be \[\[\[0.5, 0], \[0, -1]], …]. + +The simulator backends also have an optional key ‘snapshots’ which returns a dict of snapshots specified by the simulator backend. The value is of the form dict\[slot: dict\[str: array]] where the keys are the requested snapshot slots, and the values are a dictionary of the snapshots. + +**Return type** + +dict + +**Raises** + +**QiskitError** – if data for the experiment could not be retrieved. + +### from\_dict + + + +`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. + +**Parameters** + +**data** (*dict*) – A dictionary representing the Result to create. It will be in the same format as output by [`to_dict()`](qiskit.result.Result#to_dict "qiskit.result.Result.to_dict"). + +**Returns** + +The `Result` object from the input dictionary. + +**Return type** + +[Result](qiskit.result.Result "qiskit.result.Result") + +### get\_counts + + + +`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. + +**Parameters** + +**experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data([experiment])`. + +**Returns** + +a dictionary or a list of dictionaries. A dictionary has the counts for each qubit with the keys containing a string in binary format and separated according to the registers in circuit (e.g. `0100 1110`). The string is little-endian (cr\[0] on the right hand side). + +**Return type** + +dict\[str, int] or list\[dict\[str, int]] + +**Raises** + +**QiskitError** – if there are no counts for the experiment. + +### get\_memory + + + +`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’] + +**Parameters** + +**experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data()`. + +**Returns** + +Either the list of each outcome, formatted according to registers in circuit or a complex numpy np.ndarray with shape: + +> | meas\_level | meas\_return | shape | +> | ----------- | ------------ | ----------------------------------------------------- | +> | 0 | single | np.ndarray\[shots, memory\_slots, memory\_slot\_size] | +> | 0 | avg | np.ndarray\[memory\_slots, memory\_slot\_size] | +> | 1 | single | np.ndarray\[shots, memory\_slots] | +> | 1 | avg | np.ndarray\[memory\_slots] | +> | 2 | memory=True | list | + +**Return type** + +List\[str] or np.ndarray + +**Raises** + +**QiskitError** – if there is no memory data for the circuit. + +### get\_statevector + + + +`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. + +**Parameters** + +* **experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data()`. +* **decimals** (*int*) – the number of decimals in the statevector. If None, does not round. + +**Returns** + +list of 2^num\_qubits complex amplitudes. + +**Return type** + +list\[complex] + +**Raises** + +**QiskitError** – if there is no statevector for the experiment. + +### get\_unitary + + + +`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. + +**Parameters** + +* **experiment** (*str or* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or*[*Schedule*](qiskit.pulse.Schedule "qiskit.pulse.Schedule") *or int or None*) – the index of the experiment, as specified by `data()`. +* **decimals** (*int*) – the number of decimals in the unitary. If None, does not round. + +**Returns** + +**list of 2^num\_qubits x 2^num\_qubits complex** + +amplitudes. + +**Return type** + +list\[list\[complex]] + +**Raises** + +**QiskitError** – if there is no unitary for the experiment. + +### to\_dict + + + +`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 + +**Returns** + +The dictionary form of the Result + +**Return type** + +dict + diff --git a/docs/api/qiskit/0.32/qiskit.result.ResultError.md b/docs/api/qiskit/0.32/qiskit.result.ResultError.md index 4ef27fc7cb2..9636b827e5e 100644 --- a/docs/api/qiskit/0.32/qiskit.result.ResultError.md +++ b/docs/api/qiskit/0.32/qiskit.result.ResultError.md @@ -1,8 +1,16 @@ -# qiskit.result.ResultError +--- +title: ResultError +description: API reference for qiskit.result.ResultError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.result.ResultError +--- +# qiskit.result.ResultError + -`ResultError(error)` +`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. @@ -21,3 +29,4 @@ error = {'status': 403, ``` Set the error message. + 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 7ea3c1e77d6..984ec18e675 100644 --- a/docs/api/qiskit/0.32/qiskit.result.marginal_counts.md +++ b/docs/api/qiskit/0.32/qiskit.result.marginal_counts.md @@ -1,14 +1,22 @@ -# qiskit.result.marginal\_counts +--- +title: marginal_counts +description: API reference for qiskit.result.marginal_counts +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.result.marginal_counts +--- +# qiskit.result.marginal\_counts + -`marginal_counts(result, indices=None, inplace=False, format_marginal=False)` +`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. **Parameters** -* **result** (*dict or* [*Result*](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")) – result to be marginalized (a Result object or a dict(str, int) of counts). +* **result** (*dict or* [*Result*](qiskit.result.Result "qiskit.result.Result")) – result to be marginalized (a Result object or a dict(str, int) of counts). * **indices** (*list(int) or None*) – The bit positions of interest to marginalize over. If `None` (default), do not marginalize at all. * **inplace** (*bool*) – Default: False. Operates on the original Result argument if True, leading to loss of original Job Result. It has no effect if `result` is a dict. * **format\_marginal** (*bool*) – Default: False. If True, takes the output of marginalize and formats it with placeholders between cregs and for non-indices. @@ -21,8 +29,9 @@ the observed counts, marginalized to only account for frequency of observations **Return type** -[Result](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result") or dict(str, int) +[Result](qiskit.result.Result "qiskit.result.Result") or dict(str, int) **Raises** **QiskitError** – in case of invalid indices to marginalize over. + diff --git a/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md b/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md index ea14541a6ed..d95b631d265 100644 --- a/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md +++ b/docs/api/qiskit/0.32/qiskit.scheduler.ScheduleConfig.md @@ -1,8 +1,16 @@ -# ScheduleConfig +--- +title: ScheduleConfig +description: API reference for qiskit.scheduler.ScheduleConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.scheduler.ScheduleConfig +--- +# ScheduleConfig + -`ScheduleConfig(inst_map, meas_map, dt)` +`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` @@ -15,3 +23,4 @@ Container for information needed to schedule a QuantumCircuit into a pulse Sched * **inst\_map** (`InstructionScheduleMap`) – The schedule definition of all gates supported on a backend. * **meas\_map** (`List`\[`List`\[`int`]]) – A list of groups of qubits which have to be measured together. * **dt** (`float`) – Sample duration. + 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 5ff5fc1c2cb..900dae82e23 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.backend_monitor.md +++ b/docs/api/qiskit/0.32/qiskit.tools.backend_monitor.md @@ -1,16 +1,25 @@ -# qiskit.tools.backend\_monitor +--- +title: backend_monitor +description: API reference for qiskit.tools.backend_monitor +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.tools.backend_monitor +--- +# qiskit.tools.backend\_monitor + -`backend_monitor(backend)` +`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. **Parameters** -**backend** ([*IBMQBackend*](qiskit.providers.ibmq.IBMQBackend#qiskit.providers.ibmq.IBMQBackend "qiskit.providers.ibmq.IBMQBackend")) – Backend to monitor. +**backend** ([*IBMQBackend*](qiskit.providers.ibmq.IBMQBackend "qiskit.providers.ibmq.IBMQBackend")) – Backend to monitor. **Raises** * **QiskitError** – Input is not a IBMQ backend. -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If qiskit-ibmq-provider is not installed +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If qiskit-ibmq-provider is not installed + 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 e6f756bf3e6..957fb280a60 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.backend_overview.md +++ b/docs/api/qiskit/0.32/qiskit.tools.backend_overview.md @@ -1,7 +1,16 @@ -# qiskit.tools.backend\_overview +--- +title: backend_overview +description: API reference for qiskit.tools.backend_overview +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.tools.backend_overview +--- +# qiskit.tools.backend\_overview + -`backend_overview()` +`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 6d3b75b8909..3d16ebac30c 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.job_monitor.md +++ b/docs/api/qiskit/0.32/qiskit.tools.job_monitor.md @@ -1,17 +1,26 @@ -# qiskit.tools.job\_monitor +--- +title: job_monitor +description: API reference for qiskit.tools.job_monitor +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.tools.job_monitor +--- +# qiskit.tools.job\_monitor + -`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')` +`job_monitor(job, interval=None, quiet=False, output=<_io.TextIOWrapper name='' mode='w' encoding='UTF-8'>, line_discipline='\r')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/tools/monitor/job_monitor.py "view source code") Monitor the status of a IBMQJob instance. **Parameters** -* **job** ([*BaseJob*](qiskit.providers.BaseJob#qiskit.providers.BaseJob "qiskit.providers.BaseJob")) – Job to monitor. +* **job** ([*BaseJob*](qiskit.providers.BaseJob "qiskit.providers.BaseJob")) – Job to monitor. * **interval** (*int*) – Time interval between status queries. * **quiet** (*bool*) – If True, do not print status messages. * **output** (*file*) – The file like object to write status messages to. * **default this is sys.stdout.** (*By*) – * **line\_discipline** (*string*) – character emitted at start of a line of job monitor output, * **defaults to r.** (*This*) – + 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 fb02eb45a70..07db725f8f3 100644 --- a/docs/api/qiskit/0.32/qiskit.tools.parallel_map.md +++ b/docs/api/qiskit/0.32/qiskit.tools.parallel_map.md @@ -1,8 +1,16 @@ -# qiskit.tools.parallel\_map +--- +title: parallel_map +description: API reference for qiskit.tools.parallel_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.tools.parallel_map +--- +# qiskit.tools.parallel\_map + -`parallel_map(task, values, task_args=(), task_kwargs={}, num_processes=32)` +`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: @@ -39,3 +47,4 @@ result ## Events: terra.parallel.start: The collection of parallel tasks are about to start. terra.parallel.update: One of the parallel task has finished. terra.parallel.finish: All the parallel tasks have finished. + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md b/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md index 1a45987182a..5567193156c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.AnalysisPass.md @@ -1,8 +1,16 @@ -# AnalysisPass +--- +title: AnalysisPass +description: API reference for qiskit.transpiler.AnalysisPass +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.AnalysisPass +--- +# AnalysisPass + -`AnalysisPass(*args, **kwargs)` +`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` @@ -10,14 +18,33 @@ An analysis pass: change property set, not DAG. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`name`](qiskit.transpiler.AnalysisPass.name#qiskit.transpiler.AnalysisPass.name "qiskit.transpiler.AnalysisPass.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.AnalysisPass.run#qiskit.transpiler.AnalysisPass.run "qiskit.transpiler.AnalysisPass.run") | Run a pass on the DAGCircuit. | +### name -## Attributes + + +`AnalysisPass.name()` + +Return the name of the pass. + +### run + + + +`abstract AnalysisPass.run(dag)` +Run a pass on the DAGCircuit. This is implemented by the pass developer. +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the dag on which the pass is run. + +**Raises** + +**NotImplementedError** – when this is left unimplemented for a pass. + +## Attributes + + ### is\_analysis\_pass @@ -25,10 +52,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md b/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md index f9be77b4d27..2ce2dfac706 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.CouplingMap.md @@ -1,8 +1,16 @@ -# CouplingMap +--- +title: CouplingMap +description: API reference for qiskit.transpiler.CouplingMap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.CouplingMap +--- +# CouplingMap + -`CouplingMap(couplinglist=None, description=None)` +`CouplingMap(couplinglist=None, description=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") Bases: `object` @@ -19,35 +27,237 @@ Create coupling graph. By default, the generated coupling has no nodes. ## Methods -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -| [`add_edge`](qiskit.transpiler.CouplingMap.add_edge#qiskit.transpiler.CouplingMap.add_edge "qiskit.transpiler.CouplingMap.add_edge") | Add directed edge to coupling graph. | -| [`add_physical_qubit`](qiskit.transpiler.CouplingMap.add_physical_qubit#qiskit.transpiler.CouplingMap.add_physical_qubit "qiskit.transpiler.CouplingMap.add_physical_qubit") | Add a physical qubit to the coupling graph as a node. | -| [`distance`](qiskit.transpiler.CouplingMap.distance#qiskit.transpiler.CouplingMap.distance "qiskit.transpiler.CouplingMap.distance") | Returns the undirected distance between physical\_qubit1 and physical\_qubit2. | -| [`draw`](qiskit.transpiler.CouplingMap.draw#qiskit.transpiler.CouplingMap.draw "qiskit.transpiler.CouplingMap.draw") | Draws the coupling map. | -| [`from_full`](qiskit.transpiler.CouplingMap.from_full#qiskit.transpiler.CouplingMap.from_full "qiskit.transpiler.CouplingMap.from_full") | Return a fully connected coupling map on n qubits. | -| [`from_grid`](qiskit.transpiler.CouplingMap.from_grid#qiskit.transpiler.CouplingMap.from_grid "qiskit.transpiler.CouplingMap.from_grid") | Return qubits connected on a grid of num\_rows x num\_columns. | -| [`from_line`](qiskit.transpiler.CouplingMap.from_line#qiskit.transpiler.CouplingMap.from_line "qiskit.transpiler.CouplingMap.from_line") | Return a fully connected coupling map on n qubits. | -| [`from_ring`](qiskit.transpiler.CouplingMap.from_ring#qiskit.transpiler.CouplingMap.from_ring "qiskit.transpiler.CouplingMap.from_ring") | Return a fully connected coupling map on n qubits. | -| [`get_edges`](qiskit.transpiler.CouplingMap.get_edges#qiskit.transpiler.CouplingMap.get_edges "qiskit.transpiler.CouplingMap.get_edges") | Gets the list of edges in the coupling graph. | -| [`is_connected`](qiskit.transpiler.CouplingMap.is_connected#qiskit.transpiler.CouplingMap.is_connected "qiskit.transpiler.CouplingMap.is_connected") | Test if the graph is connected. | -| [`largest_connected_component`](qiskit.transpiler.CouplingMap.largest_connected_component#qiskit.transpiler.CouplingMap.largest_connected_component "qiskit.transpiler.CouplingMap.largest_connected_component") | Return a set of qubits in the largest connected component. | -| [`make_symmetric`](qiskit.transpiler.CouplingMap.make_symmetric#qiskit.transpiler.CouplingMap.make_symmetric "qiskit.transpiler.CouplingMap.make_symmetric") | Convert uni-directional edges into bi-directional. | -| [`neighbors`](qiskit.transpiler.CouplingMap.neighbors#qiskit.transpiler.CouplingMap.neighbors "qiskit.transpiler.CouplingMap.neighbors") | Return the nearest neighbors of a physical qubit. | -| [`reduce`](qiskit.transpiler.CouplingMap.reduce#qiskit.transpiler.CouplingMap.reduce "qiskit.transpiler.CouplingMap.reduce") | Returns a reduced coupling map that corresponds to the subgraph of qubits selected in the mapping. | -| [`shortest_undirected_path`](qiskit.transpiler.CouplingMap.shortest_undirected_path#qiskit.transpiler.CouplingMap.shortest_undirected_path "qiskit.transpiler.CouplingMap.shortest_undirected_path") | Returns the shortest undirected path between physical\_qubit1 and physical\_qubit2. | -| [`size`](qiskit.transpiler.CouplingMap.size#qiskit.transpiler.CouplingMap.size "qiskit.transpiler.CouplingMap.size") | Return the number of physical qubits in this graph. | -| [`subgraph`](qiskit.transpiler.CouplingMap.subgraph#qiskit.transpiler.CouplingMap.subgraph "qiskit.transpiler.CouplingMap.subgraph") | Return a CouplingMap object for a subgraph of self. | +### add\_edge -## Attributes + + +`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. + +src (int): source physical qubit dst (int): destination physical qubit + +### add\_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") + +Add a physical qubit to the coupling graph as a node. + +physical\_qubit (int): An integer representing a physical qubit. + +**Raises** + +**CouplingError** – if trying to add duplicate qubit + +### distance + + + +`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. + +**Parameters** + +* **physical\_qubit1** (*int*) – A physical qubit +* **physical\_qubit2** (*int*) – Another physical qubit + +**Returns** + +The undirected distance + +**Return type** + +int + +**Raises** + +**CouplingError** – if the qubits do not exist in the CouplingMap + +### draw + + + +`CouplingMap.draw()`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/coupling.py "view source code") + +Draws the coupling map. + +This function needs [pydot](https://github.com/erocarrera/pydot), which in turn needs [Graphviz](https://www.graphviz.org/) to be installed. Additionally, [pillow](https://python-pillow.org/) will need to be installed. + +**Returns** + +Drawn coupling map. + +**Return type** + +PIL.Image + +**Raises** + +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when pydot or pillow are not installed. + +### from\_full + + + +`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. + +### from\_grid + + + +`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. + +### from\_line + + + +`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. + +### from\_ring + + + +`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. + +### get\_edges + + + +`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. + +**Returns** + +Each edge is a pair of physical qubits. +**Return type** +Tuple(int,int) + +### is\_connected + + + +`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. + +Return True if connected, False otherwise + +### largest\_connected\_component + + + +`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. + +### make\_symmetric + + + +`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. + +### neighbors + + + +`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. + +Directionality matters, i.e. a neighbor must be reachable by going one hop in the direction of an edge. + +### reduce + + + +`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. + +**Parameters** + +**mapping** (*list*) – A mapping of reduced qubits to device qubits. + +**Returns** + +A reduced coupling\_map for the selected qubits. + +**Return type** + +[CouplingMap](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap") + +**Raises** + +**CouplingError** – Reduced coupling map must be connected. + +### shortest\_undirected\_path + + + +`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. + +**Parameters** + +* **physical\_qubit1** (*int*) – A physical qubit +* **physical\_qubit2** (*int*) – Another physical qubit + +**Returns** + +The shortest undirected path + +**Return type** + +List + +**Raises** + +**CouplingError** – When there is no path between physical\_qubit1, physical\_qubit2. + +### size + + + +`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. + +### subgraph + + + +`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. + +nodelist (list): list of integer node labels + +## Attributes + + ### distance\_matrix Return the distance matrix for the coupling map. - + ### is\_symmetric @@ -55,8 +265,9 @@ Test if the graph is symmetric. Return True if symmetric, False otherwise - + ### physical\_qubits Returns a sorted list of physical\_qubits + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md b/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md index 54e35b51099..2911a55d282 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FencedDAGCircuit.md @@ -1,9 +1,18 @@ -# FencedDAGCircuit +--- +title: FencedDAGCircuit +description: API reference for qiskit.transpiler.FencedDAGCircuit +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.FencedDAGCircuit +--- +# FencedDAGCircuit + -`FencedDAGCircuit(dag_circuit_instance)` +`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` A dag circuit that cannot be modified (via remove\_op\_node) + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md b/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md index a9151c8f757..b19b52b8d4b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FencedPropertySet.md @@ -1,9 +1,18 @@ -# FencedPropertySet +--- +title: FencedPropertySet +description: API reference for qiskit.transpiler.FencedPropertySet +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.FencedPropertySet +--- +# FencedPropertySet + -`FencedPropertySet(property_set_instance)` +`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` A property set that cannot be written (via \_\_setitem\_\_) + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md b/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md index 01019733dc2..1eedeae80f1 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.FlowController.md @@ -1,8 +1,16 @@ -# FlowController +--- +title: FlowController +description: API reference for qiskit.transpiler.FlowController +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.FlowController +--- +# FlowController + -`FlowController(passes, options, **partial_controller)` +`FlowController(passes, options, **partial_controller)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/runningpassmanager.py "view source code") Bases: `object` @@ -12,19 +20,84 @@ This class is a base class for multiple types of working list. When you iterate ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| [`add_flow_controller`](qiskit.transpiler.FlowController.add_flow_controller#qiskit.transpiler.FlowController.add_flow_controller "qiskit.transpiler.FlowController.add_flow_controller") | Adds a flow controller. | -| [`controller_factory`](qiskit.transpiler.FlowController.controller_factory#qiskit.transpiler.FlowController.controller_factory "qiskit.transpiler.FlowController.controller_factory") | Constructs a flow controller based on the partially evaluated controller arguments. | -| [`dump_passes`](qiskit.transpiler.FlowController.dump_passes#qiskit.transpiler.FlowController.dump_passes "qiskit.transpiler.FlowController.dump_passes") | Fetches the passes added to this flow controller. | -| [`remove_flow_controller`](qiskit.transpiler.FlowController.remove_flow_controller#qiskit.transpiler.FlowController.remove_flow_controller "qiskit.transpiler.FlowController.remove_flow_controller") | Removes a flow controller. | +### add\_flow\_controller -## Attributes + + +`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. + +**Parameters** + +* **name** (*string*) – Name of the controller to add. +* **controller** (*type(*[*FlowController*](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController")*)*) – The class implementing a flow controller. + +### controller\_factory + + + +`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. + +**Parameters** + +* **passes** (*list\[BasePass]*) – passes to add to the flow controller. +* **options** (*dict*) – PassManager options. +* **\*\*partial\_controller** (*dict*) – Partially evaluated controller arguments in the form \{name:partial} + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – When partial\_controller is not well-formed. + +**Returns** + +A FlowController instance. + +**Return type** + +[FlowController](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController") +### dump\_passes + + +`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. + +**Returns** + +\{‘options’: self.options, ‘passes’: \[passes], ‘type’: type(self)} + +**Return type** + +dict + +### remove\_flow\_controller + + + +`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. + +**Parameters** + +**name** (*string*) – Name of the controller to remove. + +**Raises** + +**KeyError** – If the controller to remove was not registered. + +## Attributes + + ### registered\_controllers = \{'condition' `= {'condition':` `= {'condition': , 'do_while': }` + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md b/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md index 17c9a05670e..f535bb13e7b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.InstructionDurations.md @@ -1,8 +1,16 @@ -# InstructionDurations +--- +title: InstructionDurations +description: API reference for qiskit.transpiler.InstructionDurations +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.InstructionDurations +--- +# InstructionDurations + -`InstructionDurations(instruction_durations=None, dt=None)` +`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` @@ -12,9 +20,94 @@ It stores durations (gate lengths) and dt to be used at the scheduling stage of ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`from_backend`](qiskit.transpiler.InstructionDurations.from_backend#qiskit.transpiler.InstructionDurations.from_backend "qiskit.transpiler.InstructionDurations.from_backend") | Construct an [`InstructionDurations`](#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") object from the backend. | -| [`get`](qiskit.transpiler.InstructionDurations.get#qiskit.transpiler.InstructionDurations.get "qiskit.transpiler.InstructionDurations.get") | Get the duration of the instruction with the name and the qubits. | -| [`units_used`](qiskit.transpiler.InstructionDurations.units_used#qiskit.transpiler.InstructionDurations.units_used "qiskit.transpiler.InstructionDurations.units_used") | Get the set of all units used in this instruction durations. | -| [`update`](qiskit.transpiler.InstructionDurations.update#qiskit.transpiler.InstructionDurations.update "qiskit.transpiler.InstructionDurations.update") | Update self with inst\_durations (inst\_durations overwrite self). | +### from\_backend + + + +`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. + +**Parameters** + +**backend** (`BaseBackend`) – backend from which durations (gate lengths) and dt are extracted. + +**Returns** + +The InstructionDurations constructed from backend. + +**Return type** + +[InstructionDurations](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If dt and dtm is different in the backend. + +### get + + + +`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. + +**Parameters** + +* **inst** (`Union`\[`str`, `Instruction`]) – An instruction or its name to be queried. +* **qubits** (`Union`\[`int`, `List`\[`int`], `Qubit`, `List`\[`Qubit`]]) – Qubits or its indices that the instruction acts on. +* **unit** (`str`) – The unit of duration to be returned. It must be ‘s’ or ‘dt’. + +**Returns** + +The duration of the instruction on the qubits. + +**Return type** + +float|int + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – No duration is defined for the instruction. + +### units\_used + + + +`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. + +**Return type** + +`Set`\[`str`] + +**Returns** + +Set of units used in this instruction durations. + +### update + + + +`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). + +**Parameters** + +* **inst\_durations** (`Optional`\[`Union`\[`List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`, `str`]], `List`\[`Tuple`\[`str`, `Optional`\[`Iterable`\[`int`]], `float`]], `InstructionDurations`]]) – Instruction durations to be merged into self (overwriting self). +* **dt** (`Optional`\[`float`]) – Sampling duration in seconds of the target backend. + +**Returns** + +The updated InstructionDurations. + +**Return type** + +[InstructionDurations](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If the format of instruction\_durations is invalid. + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md b/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md index 987934dedc6..fd318dce9c7 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.Layout.md @@ -1,8 +1,16 @@ -# Layout +--- +title: Layout +description: API reference for qiskit.transpiler.Layout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.Layout +--- +# Layout + -`Layout(input_dict=None)` +`Layout(input_dict=None)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/layout.py "view source code") Bases: `object` @@ -12,19 +20,248 @@ construct a Layout from a bijective dictionary, mapping virtual qubits to physic ## Methods -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`add`](qiskit.transpiler.Layout.add#qiskit.transpiler.Layout.add "qiskit.transpiler.Layout.add") | Adds a map element between bit and physical\_bit. | -| [`add_register`](qiskit.transpiler.Layout.add_register#qiskit.transpiler.Layout.add_register "qiskit.transpiler.Layout.add_register") | Adds at the end physical\_qubits that map each bit in reg. | -| [`combine_into_edge_map`](qiskit.transpiler.Layout.combine_into_edge_map#qiskit.transpiler.Layout.combine_into_edge_map "qiskit.transpiler.Layout.combine_into_edge_map") | Combines self and another\_layout into an “edge map”. | -| [`copy`](qiskit.transpiler.Layout.copy#qiskit.transpiler.Layout.copy "qiskit.transpiler.Layout.copy") | Returns a copy of a Layout instance. | -| [`from_dict`](qiskit.transpiler.Layout.from_dict#qiskit.transpiler.Layout.from_dict "qiskit.transpiler.Layout.from_dict") | Populates a Layout from a dictionary. | -| [`from_intlist`](qiskit.transpiler.Layout.from_intlist#qiskit.transpiler.Layout.from_intlist "qiskit.transpiler.Layout.from_intlist") | Converts a list of integers to a Layout mapping virtual qubits (index of the list) to physical qubits (the list values). | -| [`from_qubit_list`](qiskit.transpiler.Layout.from_qubit_list#qiskit.transpiler.Layout.from_qubit_list "qiskit.transpiler.Layout.from_qubit_list") | Populates a Layout from a list containing virtual qubits, Qubit or None. | -| [`generate_trivial_layout`](qiskit.transpiler.Layout.generate_trivial_layout#qiskit.transpiler.Layout.generate_trivial_layout "qiskit.transpiler.Layout.generate_trivial_layout") | Creates a trivial (“one-to-one”) Layout with the registers and qubits in regs. | -| [`get_physical_bits`](qiskit.transpiler.Layout.get_physical_bits#qiskit.transpiler.Layout.get_physical_bits "qiskit.transpiler.Layout.get_physical_bits") | Returns the dictionary where the keys are physical (qu)bits and the values are virtual (qu)bits. | -| [`get_registers`](qiskit.transpiler.Layout.get_registers#qiskit.transpiler.Layout.get_registers "qiskit.transpiler.Layout.get_registers") | Returns the registers in the layout \[QuantumRegister(2, ‘qr0’), QuantumRegister(3, ‘qr1’)] :returns: A set of Registers in the layout :rtype: Set | -| [`get_virtual_bits`](qiskit.transpiler.Layout.get_virtual_bits#qiskit.transpiler.Layout.get_virtual_bits "qiskit.transpiler.Layout.get_virtual_bits") | Returns the dictionary where the keys are virtual (qu)bits and the values are physical (qu)bits. | -| [`order_based_on_type`](qiskit.transpiler.Layout.order_based_on_type#qiskit.transpiler.Layout.order_based_on_type "qiskit.transpiler.Layout.order_based_on_type") | decides which one is physical/virtual based on the type. | -| [`reorder_bits`](qiskit.transpiler.Layout.reorder_bits#qiskit.transpiler.Layout.reorder_bits "qiskit.transpiler.Layout.reorder_bits") | Given an ordered list of bits, reorder them according to this layout. | -| [`swap`](qiskit.transpiler.Layout.swap#qiskit.transpiler.Layout.swap "qiskit.transpiler.Layout.swap") | Swaps the map between left and right. | +### add + + + +`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.) + +**Parameters** + +* **virtual\_bit** (*tuple*) – A (qu)bit. For example, (QuantumRegister(3, ‘qr’), 2). +* **physical\_bit** (*int*) – A physical bit. For example, 3. + +### add\_register + + + +`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. + +**Parameters** + +**reg** (*Register*) – A (qu)bit Register. For example, QuantumRegister(3, ‘qr’). + +### combine\_into\_edge\_map + + + +`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”. + +For example: + +```python + self another_layout resulting edge map +qr_1 -> 0 0 <- q_2 qr_1 -> q_2 +qr_2 -> 2 2 <- q_1 qr_2 -> q_1 +qr_3 -> 3 3 <- q_0 qr_3 -> q_0 +``` + +The edge map is used to compose dags via, for example, compose. + +**Parameters** + +**another\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – The other layout to combine. + +**Returns** + +A “edge map”. + +**Return type** + +dict + +**Raises** + +**LayoutError** – another\_layout can be bigger than self, but not smaller. Otherwise, raises. + +### copy + + + +`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. + +### from\_dict + + + +`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. + +The dictionary must be a bijective mapping between virtual qubits (tuple) and physical qubits (int). + +**Parameters** + +**input\_dict** (*dict*) – + +e.g.: + +```python +{(QuantumRegister(3, 'qr'), 0): 0, + (QuantumRegister(3, 'qr'), 1): 1, + (QuantumRegister(3, 'qr'), 2): 2} + +Can be written more concisely as follows: + +* virtual to physical:: + + {qr[0]: 0, + qr[1]: 1, + qr[2]: 2} + +* physical to virtual:: + + {0: qr[0], + 1: qr[1], + 2: qr[2]} +``` + +### from\_intlist + + + +`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). + +**Parameters** + +* **int\_list** (*list*) – A list of integers. +* **\*qregs** (*QuantumRegisters*) – The quantum registers to apply the layout to. + +**Returns** + +The corresponding Layout object. + +**Return type** + +[Layout](qiskit.transpiler.Layout "qiskit.transpiler.Layout") + +**Raises** + +**LayoutError** – Invalid input layout. + +### from\_qubit\_list + + + +`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. + +**Parameters** + +* **qubit\_list** (*list*) – e.g.: \[qr\[0], None, qr\[2], qr\[3]] +* **\*qregs** (*QuantumRegisters*) – The quantum registers to apply the layout to. + +**Returns** + +the corresponding Layout object + +**Return type** + +[Layout](qiskit.transpiler.Layout "qiskit.transpiler.Layout") + +**Raises** + +**LayoutError** – If the elements are not Qubit or None + +### generate\_trivial\_layout + + + +`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. + +**Parameters** + +**\*regs** (*Registers, Qubits*) – registers and qubits to include in the layout. + +**Returns** + +A layout with all the regs in the given order. + +**Return type** + +[Layout](qiskit.transpiler.Layout "qiskit.transpiler.Layout") + +### get\_physical\_bits + + + +`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. + +### get\_registers + + + +`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 + +### get\_virtual\_bits + + + +`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. + +### order\_based\_on\_type + + + +`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) + +### reorder\_bits + + + +`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. + +The list of bits must exactly match the virtual bits in this layout. + +**Parameters** + +**bits** (*list\[Bit]*) – the bits to reorder. + +**Returns** + +ordered bits. + +**Return type** + +List + +### swap + + + +`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. + +**Parameters** + +* **left** (*tuple or int*) – Item to swap with right. +* **right** (*tuple or int*) – Item to swap with left. + +**Raises** + +**LayoutError** – If left and right have not the same type. + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md b/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md index 41768922e9c..d60d3062ea4 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PassManager.md @@ -1,8 +1,16 @@ -# PassManager +--- +title: PassManager +description: API reference for qiskit.transpiler.PassManager +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.PassManager +--- +# PassManager + -`PassManager(passes=None, max_iteration=1000)` +`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` @@ -12,16 +20,173 @@ Initialize an empty PassManager object (with no passes scheduled). **Parameters** -* **passes** (`Union`\[`BasePass`, `List`\[`BasePass`], `None`]) – A pass set (as defined in [`qiskit.transpiler.PassManager.append()`](qiskit.transpiler.PassManager.append#qiskit.transpiler.PassManager.append "qiskit.transpiler.PassManager.append")) to be added to the pass manager schedule. +* **passes** (`Union`\[`BasePass`, `List`\[`BasePass`], `None`]) – A pass set (as defined in [`qiskit.transpiler.PassManager.append()`](qiskit.transpiler.PassManager#append "qiskit.transpiler.PassManager.append")) to be added to the pass manager schedule. * **max\_iteration** (`int`) – The maximum number of iterations the schedule will be looped if the condition is not met. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| [`append`](qiskit.transpiler.PassManager.append#qiskit.transpiler.PassManager.append "qiskit.transpiler.PassManager.append") | Append a Pass Set to the schedule of passes. | -| [`draw`](qiskit.transpiler.PassManager.draw#qiskit.transpiler.PassManager.draw "qiskit.transpiler.PassManager.draw") | Draw the pass manager. | -| [`passes`](qiskit.transpiler.PassManager.passes#qiskit.transpiler.PassManager.passes "qiskit.transpiler.PassManager.passes") | Return a list structure of the appended passes and its options. | -| [`remove`](qiskit.transpiler.PassManager.remove#qiskit.transpiler.PassManager.remove "qiskit.transpiler.PassManager.remove") | Removes a particular pass in the scheduler. | -| [`replace`](qiskit.transpiler.PassManager.replace#qiskit.transpiler.PassManager.replace "qiskit.transpiler.PassManager.replace") | Replace a particular pass in the scheduler. | -| [`run`](qiskit.transpiler.PassManager.run#qiskit.transpiler.PassManager.run "qiskit.transpiler.PassManager.run") | Run all the passes on the specified `circuits`. | +### append + + + +`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. + +**Parameters** + +* **passes** (`Union`\[`BasePass`, `List`\[`BasePass`]]) – A set of passes (a pass set) to be added to schedule. A pass set is a list of passes that are controlled by the same flow controller. If a single pass is provided, the pass set will only have that pass a single element. It is also possible to append a `FlowController` instance and the rest of the parameter will be ignored. +* **max\_iteration** (`Optional`\[`int`]) – max number of iterations of passes. +* **flow\_controller\_conditions** (`Any`) – control flow plugins. + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if a pass in passes is not a proper pass. + + + `RunningPassManager.add_flow_controller()` for more information about the control flow plugins. + + +**Return type** + +`None` + +### draw + + + +`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. + +This function needs [pydot](https://github.com/erocarrera/pydot), which in turn needs [Graphviz](https://www.graphviz.org/) to be installed. + +**Parameters** + +* **filename** (*str*) – file path to save image to. +* **style** (*dict*) – keys are the pass classes and the values are the colors to make them. An example can be seen in the DEFAULT\_STYLE. An ordered dict can be used to ensure a priority coloring when pass falls into multiple categories. Any values not included in the provided dict will be filled in from the default dict. +* **raw** (*bool*) – If `True`, save the raw Dot output instead of the image. + +**Returns** + +an in-memory representation of the pass manager, or `None` if no image was generated or [Pillow](https://pypi.org/project/Pillow/) is not installed. + +**Return type** + +Optional\[[PassManager](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")] + +**Raises** + +**ImportError** – when nxpd or pydot not installed. + +### passes + + + +`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. + +**Return type** + +`List`\[`Dict`\[`str`, `BasePass`]] + +**Returns** + +A list of pass sets, as defined in `append()`. + +### remove + + + +`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. + +**Parameters** + +**index** (`int`) – Pass index to replace, based on the position in passes(). + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the index is not found. + +**Return type** + +`None` + +### replace + + + +`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. + +**Parameters** + +* **index** (`int`) – Pass index to replace, based on the position in passes(). +* **passes** (`Union`\[`BasePass`, `List`\[`BasePass`]]) – A pass set (as defined in [`qiskit.transpiler.PassManager.append()`](qiskit.transpiler.PassManager#append "qiskit.transpiler.PassManager.append")) to be added to the pass manager schedule. +* **max\_iteration** (`Optional`\[`int`]) – max number of iterations of passes. +* **flow\_controller\_conditions** (`Any`) – control flow plugins. + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if a pass in passes is not a proper pass or index not found. + + + `RunningPassManager.add_flow_controller()` for more information about the control flow plugins. + + +**Return type** + +`None` + +### run + + + +`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`. + +**Parameters** + +* **circuits** (`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]]) – Circuit(s) to transform via all the registered passes. + +* **output\_name** (`Optional`\[`str`]) – The output circuit name. If `None`, it will be set to the same as the input circuit name. + +* **callback** (`Optional`\[`Callable`]) – + + A callback function that will be called after each pass execution. The function will be called with 5 keyword arguments: + + ```python + pass_ (Pass): the pass being run + dag (DAGCircuit): the dag output of the pass + time (float): the time to execute the pass + property_set (PropertySet): the property set + count (int): the index for the pass execution + ``` + + The exact arguments pass expose the internals of the pass manager and are subject to change as the pass manager internals change. If you intend to reuse a callback function over multiple releases be sure to check that the arguments being passed are the same. + + To use the callback feature you define a function that will take in kwargs dict and access the variables. For example: + + ```python + def callback_func(**kwargs): + pass_ = kwargs['pass_'] + dag = kwargs['dag'] + time = kwargs['time'] + property_set = kwargs['property_set'] + count = kwargs['count'] + ... + ``` + +**Return type** + +`Union`\[`QuantumCircuit`, `List`\[`QuantumCircuit`]] + +**Returns** + +The transformed circuit(s). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md b/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md index a64ae69678b..7a34b30ea18 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PassManagerConfig.md @@ -1,8 +1,16 @@ -# PassManagerConfig +--- +title: PassManagerConfig +description: API reference for qiskit.transpiler.PassManagerConfig +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.PassManagerConfig +--- +# 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)` +`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` @@ -12,15 +20,16 @@ Initialize a PassManagerConfig object **Parameters** -* **initial\_layout** ([*Layout*](qiskit.transpiler.Layout#qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – Initial position of virtual qubits on physical qubits. +* **initial\_layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – Initial position of virtual qubits on physical qubits. * **basis\_gates** (*list*) – List of basis gate names to unroll to. -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. * **layout\_method** (*str*) – the pass to use for choosing initial qubit placement. * **routing\_method** (*str*) – the pass to use for routing qubits on the architecture. * **translation\_method** (*str*) – the pass to use for translating gates to basis\_gates. * **scheduling\_method** (*str*) – the pass to use for scheduling instructions. -* **instruction\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Dictionary of duration (in dt) for each instruction. -* **backend\_properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Properties returned by a backend, including information on gate errors, readout errors, qubit coherence times, etc. +* **instruction\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Dictionary of duration (in dt) for each instruction. +* **backend\_properties** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Properties returned by a backend, including information on gate errors, readout errors, qubit coherence times, etc. * **approximation\_degree** (*float*) – heuristic dial used for circuit approximation (1.0=no approximation, 0.0=maximal approximation) * **seed\_transpiler** (*int*) – Sets random seed for the stochastic parts of the transpiler. * **timing\_constraints** (*TimingConstraints*) – Hardware time alignment restrictions. + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md b/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md index 9f84b8fa2fc..940178feedb 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.PropertySet.md @@ -1,8 +1,16 @@ -# PropertySet +--- +title: PropertySet +description: API reference for qiskit.transpiler.PropertySet +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.PropertySet +--- +# PropertySet + -`PropertySet` +`PropertySet`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/propertyset.py "view source code") Bases: `dict` @@ -10,16 +18,83 @@ A default dictionary-like object ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.transpiler.PropertySet.clear#qiskit.transpiler.PropertySet.clear "qiskit.transpiler.PropertySet.clear") | | -| [`copy`](qiskit.transpiler.PropertySet.copy#qiskit.transpiler.PropertySet.copy "qiskit.transpiler.PropertySet.copy") | | -| [`fromkeys`](qiskit.transpiler.PropertySet.fromkeys#qiskit.transpiler.PropertySet.fromkeys "qiskit.transpiler.PropertySet.fromkeys") | Create a new dictionary with keys from iterable and values set to value. | -| [`get`](qiskit.transpiler.PropertySet.get#qiskit.transpiler.PropertySet.get "qiskit.transpiler.PropertySet.get") | Return the value for key if key is in the dictionary, else default. | -| [`items`](qiskit.transpiler.PropertySet.items#qiskit.transpiler.PropertySet.items "qiskit.transpiler.PropertySet.items") | | -| [`keys`](qiskit.transpiler.PropertySet.keys#qiskit.transpiler.PropertySet.keys "qiskit.transpiler.PropertySet.keys") | | -| [`pop`](qiskit.transpiler.PropertySet.pop#qiskit.transpiler.PropertySet.pop "qiskit.transpiler.PropertySet.pop") | If key is not found, d is returned if given, otherwise KeyError is raised | -| [`popitem`](qiskit.transpiler.PropertySet.popitem#qiskit.transpiler.PropertySet.popitem "qiskit.transpiler.PropertySet.popitem") | 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.transpiler.PropertySet.setdefault#qiskit.transpiler.PropertySet.setdefault "qiskit.transpiler.PropertySet.setdefault") | Insert key with a value of default if key is not in the dictionary. | -| [`update`](qiskit.transpiler.PropertySet.update#qiskit.transpiler.PropertySet.update "qiskit.transpiler.PropertySet.update") | If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] | -| [`values`](qiskit.transpiler.PropertySet.values#qiskit.transpiler.PropertySet.values "qiskit.transpiler.PropertySet.values") | | +### clear + + + +`PropertySet.clear() → None. Remove all items from D.` + +### copy + + + +`PropertySet.copy() → a shallow copy of D` + +### fromkeys + + + +`PropertySet.fromkeys(value=None, /)` + +Create a new dictionary with keys from iterable and values set to value. + +### get + + + +`PropertySet.get(key, default=None, /)` + +Return the value for key if key is in the dictionary, else default. + +### items + + + +`PropertySet.items() → a set-like object providing a view on D’s items` + +### keys + + + +`PropertySet.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`PropertySet.pop(k[, d]) → v, remove specified key and return the corresponding value.` + +If key is not found, d is returned if given, otherwise KeyError is raised + +### popitem + + + +`PropertySet.popitem() → (k, v), remove and return some (key, value) pair as a` + +2-tuple; but raise KeyError if D is empty. + +### setdefault + + + +`PropertySet.setdefault(key, default=None, /)` + +Insert key with a value of default if key is not in the dictionary. + +Return the value for key if key is in the dictionary, else default. + +### update + + + +`PropertySet.update([E, ]**F) → None. Update D from dict/iterable E and F.` + +If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + +### values + + + +`PropertySet.values() → an object providing a view on D’s values` + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md b/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md index cdff92c7d0e..58f37fcce1f 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TransformationPass.md @@ -1,8 +1,16 @@ -# TransformationPass +--- +title: TransformationPass +description: API reference for qiskit.transpiler.TransformationPass +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.TransformationPass +--- +# TransformationPass + -`TransformationPass(*args, **kwargs)` +`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` @@ -10,14 +18,33 @@ A transformation pass: change DAG, not property set. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`name`](qiskit.transpiler.TransformationPass.name#qiskit.transpiler.TransformationPass.name "qiskit.transpiler.TransformationPass.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.TransformationPass.run#qiskit.transpiler.TransformationPass.run "qiskit.transpiler.TransformationPass.run") | Run a pass on the DAGCircuit. | +### name -## Attributes + + +`TransformationPass.name()` + +Return the name of the pass. + +### run + + + +`abstract TransformationPass.run(dag)` +Run a pass on the DAGCircuit. This is implemented by the pass developer. +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the dag on which the pass is run. + +**Raises** + +**NotImplementedError** – when this is left unimplemented for a pass. + +## Attributes + + ### is\_analysis\_pass @@ -25,10 +52,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md index fef7096b6cd..6187572348c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerAccessError.md @@ -1,9 +1,18 @@ -# qiskit.transpiler.TranspilerAccessError +--- +title: TranspilerAccessError +description: API reference for qiskit.transpiler.TranspilerAccessError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.transpiler.TranspilerAccessError +--- +# qiskit.transpiler.TranspilerAccessError + -`TranspilerAccessError(*message)` +`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. Set the error message. + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md index accfe902807..04921d4f0c9 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.TranspilerError.md @@ -1,9 +1,18 @@ -# qiskit.transpiler.TranspilerError +--- +title: TranspilerError +description: API reference for qiskit.transpiler.TranspilerError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.transpiler.TranspilerError +--- +# qiskit.transpiler.TranspilerError + -`TranspilerError(*message)` +`TranspilerError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/exceptions.py "view source code") Exceptions raised during transpilation. Set the error message. + 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 0925a3761a4..5834bbcf5ba 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ALAPSchedule.md @@ -1,8 +1,16 @@ -# ALAPSchedule +--- +title: ALAPSchedule +description: API reference for qiskit.transpiler.passes.ALAPSchedule +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.ALAPSchedule +--- +# ALAPSchedule + -`ALAPSchedule(*args, **kwargs)` +`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` @@ -12,18 +20,45 @@ ALAPSchedule initializer. **Parameters** -**durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Durations of instructions to be used in scheduling +**durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Durations of instructions to be used in scheduling ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`name`](qiskit.transpiler.passes.ALAPSchedule.name#qiskit.transpiler.passes.ALAPSchedule.name "qiskit.transpiler.passes.ALAPSchedule.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.ALAPSchedule.run#qiskit.transpiler.passes.ALAPSchedule.run "qiskit.transpiler.passes.ALAPSchedule.run") | Run the ALAPSchedule pass on dag. | +### name -## Attributes + + +`ALAPSchedule.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to schedule. +**Returns** + +A scheduled DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the circuit is not mapped on physical qubits. + +## Attributes + + ### is\_analysis\_pass @@ -31,10 +66,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md index 799949ed2bd..bf869cf5632 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ASAPSchedule.md @@ -1,8 +1,16 @@ -# ASAPSchedule +--- +title: ASAPSchedule +description: API reference for qiskit.transpiler.passes.ASAPSchedule +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.ASAPSchedule +--- +# ASAPSchedule + -`ASAPSchedule(*args, **kwargs)` +`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` @@ -12,18 +20,45 @@ ASAPSchedule initializer. **Parameters** -**durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Durations of instructions to be used in scheduling +**durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Durations of instructions to be used in scheduling ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -| [`name`](qiskit.transpiler.passes.ASAPSchedule.name#qiskit.transpiler.passes.ASAPSchedule.name "qiskit.transpiler.passes.ASAPSchedule.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.ASAPSchedule.run#qiskit.transpiler.passes.ASAPSchedule.run "qiskit.transpiler.passes.ASAPSchedule.run") | Run the ASAPSchedule pass on dag. | +### name -## Attributes + + +`ASAPSchedule.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to schedule. +**Returns** + +A scheduled DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the circuit is not mapped on physical qubits. + +## Attributes + + ### is\_analysis\_pass @@ -31,10 +66,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md index e9a97e8fb13..db162d71b42 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.AlignMeasures.md @@ -1,8 +1,16 @@ -# AlignMeasures +--- +title: AlignMeasures +description: API reference for qiskit.transpiler.passes.AlignMeasures +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.AlignMeasures +--- +# AlignMeasures + -`AlignMeasures(alignment=1)` +`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` @@ -16,7 +24,7 @@ In a typical hardware implementation of superconducting quantum processors, a si Measurement alignment is required if a backend only allows triggering `measure` instructions at a certain multiple value of this pulse granularity. This value is usually provided by `backend.configuration().timing_constraints`. -In Qiskit SDK, the duration of delay can take arbitrary value in units of `dt`, thus circuits involving delays may violate the above alignment constraint (i.e. misalignment). This pass shifts measurement instructions to a new time position to fix the misalignment, by inserting extra delay right before the measure instructions. The input of this pass should be scheduled [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"), thus one should select one of the scheduling passes ([`ALAPSchedule`](qiskit.transpiler.passes.ALAPSchedule#qiskit.transpiler.passes.ALAPSchedule "qiskit.transpiler.passes.ALAPSchedule") or `ASAPSchedule`) before calling this. +In Qiskit SDK, the duration of delay can take arbitrary value in units of `dt`, thus circuits involving delays may violate the above alignment constraint (i.e. misalignment). This pass shifts measurement instructions to a new time position to fix the misalignment, by inserting extra delay right before the measure instructions. The input of this pass should be scheduled [`DAGCircuit`](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit"), thus one should select one of the scheduling passes ([`ALAPSchedule`](qiskit.transpiler.passes.ALAPSchedule "qiskit.transpiler.passes.ALAPSchedule") or `ASAPSchedule`) before calling this. ## Examples @@ -54,14 +62,41 @@ Create new pass. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`name`](qiskit.transpiler.passes.AlignMeasures.name#qiskit.transpiler.passes.AlignMeasures.name "qiskit.transpiler.passes.AlignMeasures.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.AlignMeasures.run#qiskit.transpiler.passes.AlignMeasures.run "qiskit.transpiler.passes.AlignMeasures.run") | Run the measurement alignment pass on dag. | +### name -## Attributes + + +`AlignMeasures.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to be checked. +**Returns** + +DAG with consistent timing and op nodes annotated with duration. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If circuit is not scheduled. + +## Attributes + + ### is\_analysis\_pass @@ -69,10 +104,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md index 73545603a95..8dbbf1adade 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ApplyLayout.md @@ -1,8 +1,16 @@ -# ApplyLayout +--- +title: ApplyLayout +description: API reference for qiskit.transpiler.passes.ApplyLayout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.ApplyLayout +--- +# ApplyLayout + -`ApplyLayout(*args, **kwargs)` +`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` @@ -12,14 +20,41 @@ Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubi ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`name`](qiskit.transpiler.passes.ApplyLayout.name#qiskit.transpiler.passes.ApplyLayout.name "qiskit.transpiler.passes.ApplyLayout.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.ApplyLayout.run#qiskit.transpiler.passes.ApplyLayout.run "qiskit.transpiler.passes.ApplyLayout.run") | Run the ApplyLayout pass on dag. | +### name -## Attributes + + +`ApplyLayout.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. +**Returns** + +A mapped DAG (with physical qubits). + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if no layout is found in property\_set or no full physical qubits. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +62,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md index df5b740d303..3148d827221 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BIPMapping.md @@ -1,8 +1,16 @@ -# BIPMapping +--- +title: BIPMapping +description: API reference for qiskit.transpiler.passes.BIPMapping +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.BIPMapping +--- +# BIPMapping + -`BIPMapping(*args, **kwargs)` +`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` @@ -28,7 +36,7 @@ BIPMapping initializer. **Parameters** -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. * **objective** (*str*) – @@ -38,7 +46,7 @@ BIPMapping initializer. * `'depth'`: \[Default] Depth (number of time-steps) of the circuit * `'balanced'`: \[NotImplemented] Weighted sum of `'error_rate'` and `'depth'` -* **backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Backend properties object +* **backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Backend properties object * **time\_limit** (*float*) – Time limit for solving BIP in seconds @@ -48,18 +56,48 @@ BIPMapping initializer. **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – if cplex or docplex are not installed. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – if cplex or docplex are not installed. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`name`](qiskit.transpiler.passes.BIPMapping.name#qiskit.transpiler.passes.BIPMapping.name "qiskit.transpiler.passes.BIPMapping.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.BIPMapping.run#qiskit.transpiler.passes.BIPMapping.run "qiskit.transpiler.passes.BIPMapping.run") | 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. | +### name -## Attributes + + +`BIPMapping.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. +**Returns** +**A mapped DAG. If there is no 2q-gate in DAG or it fails to map,** + +returns the original dag. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +* [**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the number of virtual and physical qubits are not the same. +* **AssertionError** – if the final layout is not valid. + +## Attributes + + ### is\_analysis\_pass @@ -67,10 +105,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md index ddf01502463..868cc99c318 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.md @@ -1,8 +1,16 @@ -# BarrierBeforeFinalMeasurements +--- +title: BarrierBeforeFinalMeasurements +description: API reference for qiskit.transpiler.passes.BarrierBeforeFinalMeasurements +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.BarrierBeforeFinalMeasurements +--- +# BarrierBeforeFinalMeasurements + -`BarrierBeforeFinalMeasurements(*args, **kwargs)` +`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` @@ -12,14 +20,25 @@ This pass adds a barrier before the set of final measurements. Measurements are ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`name`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.name#qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.name "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.run#qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.run "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements.run") | Run the BarrierBeforeFinalMeasurements pass on dag. | +### name -## Attributes + + +`BarrierBeforeFinalMeasurements.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +46,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md index 50d7aa036af..90564fc4170 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasicSwap.md @@ -1,8 +1,16 @@ -# BasicSwap +--- +title: BasicSwap +description: API reference for qiskit.transpiler.passes.BasicSwap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.BasicSwap +--- +# BasicSwap + -`BasicSwap(*args, **kwargs)` +`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` @@ -14,19 +22,47 @@ BasicSwap initializer. **Parameters** -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. * **fake\_run** (*bool*) – if true, it only pretend to do routing, i.e., no swap is effectively added. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`name`](qiskit.transpiler.passes.BasicSwap.name#qiskit.transpiler.passes.BasicSwap.name "qiskit.transpiler.passes.BasicSwap.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.BasicSwap.run#qiskit.transpiler.passes.BasicSwap.run "qiskit.transpiler.passes.BasicSwap.run") | Run the BasicSwap pass on dag. | +### name -## Attributes + + +`BasicSwap.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. +**Returns** + +A mapped DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +* [**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the coupling map or the layout are not +* **compatible with the DAG.** – + +## Attributes + + ### is\_analysis\_pass @@ -34,10 +70,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md index 8d8ec2325c9..6d963211a62 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.BasisTranslator.md @@ -1,8 +1,16 @@ -# BasisTranslator +--- +title: BasisTranslator +description: API reference for qiskit.transpiler.passes.BasisTranslator +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.BasisTranslator +--- +# BasisTranslator + -`BasisTranslator(*args, **kwargs)` +`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` @@ -19,19 +27,46 @@ Initialize a BasisTranslator instance. **Parameters** -* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.) +* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.) * **target\_basis** (*list\[str]*) – Target basis names to unroll to, e.g. \[‘u3’, ‘cx’]. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`name`](qiskit.transpiler.passes.BasisTranslator.name#qiskit.transpiler.passes.BasisTranslator.name "qiskit.transpiler.passes.BasisTranslator.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.BasisTranslator.run#qiskit.transpiler.passes.BasisTranslator.run "qiskit.transpiler.passes.BasisTranslator.run") | Translate an input DAGCircuit to the target basis. | +### name -## Attributes + + +`BasisTranslator.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – input dag +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the target basis cannot be reached + +**Returns** + +translated circuit. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -39,10 +74,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md index 1a8711b56e7..80c02cf7d65 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CSPLayout.md @@ -1,8 +1,16 @@ -# CSPLayout +--- +title: CSPLayout +description: API reference for qiskit.transpiler.passes.CSPLayout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CSPLayout +--- +# CSPLayout + -`CSPLayout(*args, **kwargs)` +`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` @@ -27,14 +35,25 @@ If not possible, does not set the layout property. In all the cases, the propert ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`name`](qiskit.transpiler.passes.CSPLayout.name#qiskit.transpiler.passes.CSPLayout.name "qiskit.transpiler.passes.CSPLayout.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CSPLayout.run#qiskit.transpiler.passes.CSPLayout.run "qiskit.transpiler.passes.CSPLayout.run") | run the layout method | +### name -## Attributes + + +`CSPLayout.name()` + +Return the name of the pass. + +### run + +`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 + +## Attributes + + ### is\_analysis\_pass @@ -42,10 +61,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md index a04308799dc..6f04b9e6248 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXCancellation.md @@ -1,8 +1,16 @@ -# CXCancellation +--- +title: CXCancellation +description: API reference for qiskit.transpiler.passes.CXCancellation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CXCancellation +--- +# CXCancellation + -`CXCancellation(*args, **kwargs)` +`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` @@ -10,14 +18,37 @@ Cancel back-to-back cx gates in dag. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`name`](qiskit.transpiler.passes.CXCancellation.name#qiskit.transpiler.passes.CXCancellation.name "qiskit.transpiler.passes.CXCancellation.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CXCancellation.run#qiskit.transpiler.passes.CXCancellation.run "qiskit.transpiler.passes.CXCancellation.run") | Run the CXCancellation pass on dag. | +### name -## Attributes + + +`CXCancellation.name()` + +Return the name of the pass. + +### run + + + +`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. +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the directed acyclic graph to run on. + +**Returns** + +Transformed DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -25,10 +56,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md index 3c98fa12b8c..b525f3316e5 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CXDirection.md @@ -1,29 +1,66 @@ -# CXDirection +--- +title: CXDirection +description: API reference for qiskit.transpiler.passes.CXDirection +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CXDirection +--- +# CXDirection + -`CXDirection(*args, **kwargs)` +`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` -Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection#qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. +Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. GateDirection pass. **Parameters** -**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. +**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`name`](qiskit.transpiler.passes.CXDirection.name#qiskit.transpiler.passes.CXDirection.name "qiskit.transpiler.passes.CXDirection.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CXDirection.run#qiskit.transpiler.passes.CXDirection.run "qiskit.transpiler.passes.CXDirection.run") | Run the GateDirection pass on dag. | +### name -## Attributes + + +`CXDirection.name()` + +Return the name of the pass. + +### run + + + +`CXDirection.run(dag)` + +Run the GateDirection pass on dag. + +Flips the cx nodes to match the directed coupling map. Modifies the input dag. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. + +**Returns** + +The rearranged dag for the coupling map + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") +**Raises** +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If the circuit cannot be mapped just by flipping the cx nodes. + +## Attributes + + ### is\_analysis\_pass @@ -31,10 +68,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md index c966c034c8a..c71de599680 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckCXDirection.md @@ -1,29 +1,54 @@ -# CheckCXDirection +--- +title: CheckCXDirection +description: API reference for qiskit.transpiler.passes.CheckCXDirection +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CheckCXDirection +--- +# CheckCXDirection + -`CheckCXDirection(*args, **kwargs)` +`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` -Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection#qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. +Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. CheckGateDirection initializer. **Parameters** -**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. +**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`name`](qiskit.transpiler.passes.CheckCXDirection.name#qiskit.transpiler.passes.CheckCXDirection.name "qiskit.transpiler.passes.CheckCXDirection.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CheckCXDirection.run#qiskit.transpiler.passes.CheckCXDirection.run "qiskit.transpiler.passes.CheckCXDirection.run") | Run the CheckGateDirection pass on dag. | +### name -## Attributes + + +`CheckCXDirection.name()` + +Return the name of the pass. + +### run + + + +`CheckCXDirection.run(dag)` +Run the CheckGateDirection pass on dag. +If dag is mapped and the direction is correct the property is\_direction\_mapped is set to True (or to False otherwise). + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to check. + +## Attributes + + ### is\_analysis\_pass @@ -31,10 +56,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md index a2d617f7eb9..6a17860c54c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckGateDirection.md @@ -1,8 +1,16 @@ -# CheckGateDirection +--- +title: CheckGateDirection +description: API reference for qiskit.transpiler.passes.CheckGateDirection +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CheckGateDirection +--- +# CheckGateDirection + -`CheckGateDirection(*args, **kwargs)` +`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` @@ -12,18 +20,35 @@ CheckGateDirection initializer. **Parameters** -**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. +**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`name`](qiskit.transpiler.passes.CheckGateDirection.name#qiskit.transpiler.passes.CheckGateDirection.name "qiskit.transpiler.passes.CheckGateDirection.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CheckGateDirection.run#qiskit.transpiler.passes.CheckGateDirection.run "qiskit.transpiler.passes.CheckGateDirection.run") | Run the CheckGateDirection pass on dag. | +### name -## Attributes + + +`CheckGateDirection.name()` + +Return the name of the pass. + +### run + + + +`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. +If dag is mapped and the direction is correct the property is\_direction\_mapped is set to True (or to False otherwise). + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to check. + +## Attributes + + ### is\_analysis\_pass @@ -31,10 +56,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md index 133c548cc2a..810eaa83cc7 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CheckMap.md @@ -1,8 +1,16 @@ -# CheckMap +--- +title: CheckMap +description: API reference for qiskit.transpiler.passes.CheckMap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CheckMap +--- +# CheckMap + -`CheckMap(*args, **kwargs)` +`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` @@ -14,18 +22,35 @@ CheckMap initializer. **Parameters** -**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. +**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`name`](qiskit.transpiler.passes.CheckMap.name#qiskit.transpiler.passes.CheckMap.name "qiskit.transpiler.passes.CheckMap.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CheckMap.run#qiskit.transpiler.passes.CheckMap.run "qiskit.transpiler.passes.CheckMap.run") | Run the CheckMap pass on dag. | +### name -## Attributes + + +`CheckMap.name()` + +Return the name of the pass. + +### run + + + +`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. +If dag is mapped to coupling\_map, the property is\_swap\_mapped is set to True (or to False otherwise). + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. + +## Attributes + + ### is\_analysis\_pass @@ -33,10 +58,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md index 0ef5f271f91..032e151ddc1 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Collect2qBlocks.md @@ -1,8 +1,16 @@ -# Collect2qBlocks +--- +title: Collect2qBlocks +description: API reference for qiskit.transpiler.passes.Collect2qBlocks +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Collect2qBlocks +--- +# Collect2qBlocks + -`Collect2qBlocks(*args, **kwargs)` +`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` @@ -22,14 +30,29 @@ Based on implementation by Andrew Cross. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| [`name`](qiskit.transpiler.passes.Collect2qBlocks.name#qiskit.transpiler.passes.Collect2qBlocks.name "qiskit.transpiler.passes.Collect2qBlocks.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Collect2qBlocks.run#qiskit.transpiler.passes.Collect2qBlocks.run "qiskit.transpiler.passes.Collect2qBlocks.run") | Run the Collect2qBlocks pass on dag. | +### name -## Attributes + + +`Collect2qBlocks.name()` + +Return the name of the pass. + +### run + + +`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. + +The blocks contain “op” nodes in topological sort order such that all gates in a block act on the same pair of qubits and are adjacent in the circuit. the blocks are built by examining predecessors and successors of 2q gates in the circuit. + +After the execution, `property_set['block_list']` is set to a list of tuples of “op” node labels. + +## Attributes + + ### is\_analysis\_pass @@ -37,10 +60,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md index 98d1e19311e..744736cbc13 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutationAnalysis.md @@ -1,8 +1,16 @@ -# CommutationAnalysis +--- +title: CommutationAnalysis +description: API reference for qiskit.transpiler.passes.CommutationAnalysis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CommutationAnalysis +--- +# CommutationAnalysis + -`CommutationAnalysis(*args, **kwargs)` +`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` @@ -14,14 +22,27 @@ TODO: the current pass determines commutativity through matrix multiplication. A ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`name`](qiskit.transpiler.passes.CommutationAnalysis.name#qiskit.transpiler.passes.CommutationAnalysis.name "qiskit.transpiler.passes.CommutationAnalysis.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CommutationAnalysis.run#qiskit.transpiler.passes.CommutationAnalysis.run "qiskit.transpiler.passes.CommutationAnalysis.run") | Run the CommutationAnalysis pass on dag. | +### name -## Attributes + + +`CommutationAnalysis.name()` + +Return the name of the pass. + +### run + + +`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. + +Run the pass on the DAG, and write the discovered commutation relations into the property\_set. + +## Attributes + + ### is\_analysis\_pass @@ -29,10 +50,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md index 01c302d2976..a72caa5131d 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CommutativeCancellation.md @@ -1,8 +1,16 @@ -# CommutativeCancellation +--- +title: CommutativeCancellation +description: API reference for qiskit.transpiler.passes.CommutativeCancellation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CommutativeCancellation +--- +# CommutativeCancellation + -`CommutativeCancellation(*args, **kwargs)` +`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` @@ -22,14 +30,41 @@ CommutativeCancellation initializer. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`name`](qiskit.transpiler.passes.CommutativeCancellation.name#qiskit.transpiler.passes.CommutativeCancellation.name "qiskit.transpiler.passes.CommutativeCancellation.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CommutativeCancellation.run#qiskit.transpiler.passes.CommutativeCancellation.run "qiskit.transpiler.passes.CommutativeCancellation.run") | Run the CommutativeCancellation pass on dag. | +### name -## Attributes + + +`CommutativeCancellation.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the DAG to be optimized. +**Returns** + +the optimized DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – when the 1-qubit rotation gates are not found + +## Attributes + + ### is\_analysis\_pass @@ -37,10 +72,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md index 000faf398ef..65dfc785574 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ConsolidateBlocks.md @@ -1,8 +1,16 @@ -# ConsolidateBlocks +--- +title: ConsolidateBlocks +description: API reference for qiskit.transpiler.passes.ConsolidateBlocks +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.ConsolidateBlocks +--- +# ConsolidateBlocks + -`ConsolidateBlocks(*args, **kwargs)` +`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` @@ -18,20 +26,33 @@ ConsolidateBlocks initializer. **Parameters** -* **kak\_basis\_gate** ([*Gate*](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate")) – Basis gate for KAK decomposition. +* **kak\_basis\_gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Basis gate for KAK decomposition. * **force\_consolidate** (*bool*) – Force block consolidation * **basis\_gates** (*List(str)*) – Basis gates from which to choose a KAK gate. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`name`](qiskit.transpiler.passes.ConsolidateBlocks.name#qiskit.transpiler.passes.ConsolidateBlocks.name "qiskit.transpiler.passes.ConsolidateBlocks.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.ConsolidateBlocks.run#qiskit.transpiler.passes.ConsolidateBlocks.run "qiskit.transpiler.passes.ConsolidateBlocks.run") | Run the ConsolidateBlocks pass on dag. | +### name -## Attributes + + +`ConsolidateBlocks.name()` + +Return the name of the pass. + +### run + + +`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. + +Iterate over each block and replace it with an equivalent Unitary on the same wires. + +## Attributes + + ### is\_analysis\_pass @@ -39,10 +60,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md index e84a609843e..02a07d088d0 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOps.md @@ -1,8 +1,16 @@ -# CountOps +--- +title: CountOps +description: API reference for qiskit.transpiler.passes.CountOps +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CountOps +--- +# CountOps + -`CountOps(*args, **kwargs)` +`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` @@ -12,14 +20,25 @@ The result is saved in `property_set['count_ops']` as an integer. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`name`](qiskit.transpiler.passes.CountOps.name#qiskit.transpiler.passes.CountOps.name "qiskit.transpiler.passes.CountOps.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CountOps.run#qiskit.transpiler.passes.CountOps.run "qiskit.transpiler.passes.CountOps.run") | Run the CountOps pass on dag. | +### name -## Attributes + + +`CountOps.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +46,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md index b6c72418447..4f9431bb37b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CountOpsLongestPath.md @@ -1,8 +1,16 @@ -# CountOpsLongestPath +--- +title: CountOpsLongestPath +description: API reference for qiskit.transpiler.passes.CountOpsLongestPath +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CountOpsLongestPath +--- +# CountOpsLongestPath + -`CountOpsLongestPath(*args, **kwargs)` +`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` @@ -12,14 +20,25 @@ The result is saved in `property_set['count_ops_longest_path']` as an integer. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`name`](qiskit.transpiler.passes.CountOpsLongestPath.name#qiskit.transpiler.passes.CountOpsLongestPath.name "qiskit.transpiler.passes.CountOpsLongestPath.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.CountOpsLongestPath.run#qiskit.transpiler.passes.CountOpsLongestPath.run "qiskit.transpiler.passes.CountOpsLongestPath.run") | Run the CountOpsLongestPath pass on dag. | +### name -## Attributes + + +`CountOpsLongestPath.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +46,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md index 2a566cc320d..b32c79c6cc3 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.md @@ -1,8 +1,16 @@ -# CrosstalkAdaptiveSchedule +--- +title: CrosstalkAdaptiveSchedule +description: API reference for qiskit.transpiler.passes.CrosstalkAdaptiveSchedule +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.CrosstalkAdaptiveSchedule +--- +# CrosstalkAdaptiveSchedule + -`CrosstalkAdaptiveSchedule(*args, **kwargs)` +`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` @@ -12,7 +20,7 @@ CrosstalkAdaptiveSchedule initializer. **Parameters** -* **backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – backend properties object +* **backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – backend properties object * **crosstalk\_prop** (*dict*) – @@ -38,40 +46,233 @@ CrosstalkAdaptiveSchedule initializer. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [`assign_gate_id`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.assign_gate_id#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.assign_gate_id "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.assign_gate_id") | ID for each gate | -| [`basic_bounds`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.basic_bounds#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.basic_bounds "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.basic_bounds") | Basic variable bounds for optimization | -| [`check_dag_dependency`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.check_dag_dependency#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.check_dag_dependency "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.check_dag_dependency") | gate2 is a DAG dependent of gate1 if it is a descendant of gate1 | -| [`check_xtalk_dependency`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.check_xtalk_dependency#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.check_xtalk_dependency "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.check_xtalk_dependency") | Check if two gates have a crosstalk dependency. | -| [`coherence_constraints`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.coherence_constraints#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.coherence_constraints "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.coherence_constraints") | Set decoherence errors based on qubit lifetimes | -| [`create_updated_dag`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.create_updated_dag#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.create_updated_dag "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.create_updated_dag") | Given a set of layers and barriers, construct a new dag | -| [`create_z3_vars`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.create_z3_vars#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.create_z3_vars "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.create_z3_vars") | Setup the variables required for Z3 optimization | -| [`cx_tuple`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.cx_tuple#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.cx_tuple "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.cx_tuple") | Representation for two-qubit gate Note: current implementation assumes that the CX error rates and crosstalk behavior are independent of gate direction | -| [`enforce_schedule_on_dag`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.enforce_schedule_on_dag#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.enforce_schedule_on_dag "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.enforce_schedule_on_dag") | Z3 outputs start times for each gate. | -| [`extract_crosstalk_relevant_sets`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_crosstalk_relevant_sets") | Extract the set of program gates which potentially have crosstalk noise | -| [`extract_dag_overlap_sets`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_dag_overlap_sets#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_dag_overlap_sets "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_dag_overlap_sets") | Gate A, B are overlapping if A is neither a descendant nor an ancestor of B. | -| [`extract_solution`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_solution#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_solution "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.extract_solution") | Extract gate start and finish times from Z3 solution | -| [`fidelity_constraints`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.fidelity_constraints#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.fidelity_constraints "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.fidelity_constraints") | Set gate fidelity based on gate overlap conditions | -| [`filter_candidates`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.filter_candidates#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.filter_candidates "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.filter_candidates") | 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. | -| [`find_layer`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.find_layer#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.find_layer "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.find_layer") | Find the appropriate layer for a gate | -| [`gate_tuple`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.gate_tuple#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.gate_tuple "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.gate_tuple") | Representation for gate | -| [`generate_barriers`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.generate_barriers#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.generate_barriers "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.generate_barriers") | For each gate g, see if a barrier is required to serialize it with some previously processed gate | -| [`is_significant_xtalk`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.is_significant_xtalk#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.is_significant_xtalk "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.is_significant_xtalk") | Given two conditional gate error rates check if there is high crosstalk by comparing with independent error rates. | -| [`name`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.name#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.name "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.name") | Return the name of the pass. | -| [`objective_function`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.objective_function#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.objective_function "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.objective_function") | Objective function is a weighted combination of gate errors and decoherence errors | -| [`parse_backend_properties`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.parse_backend_properties#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.parse_backend_properties "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.parse_backend_properties") | 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. | -| [`powerset`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.powerset#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.powerset "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.powerset") | Finds the set of all subsets of the given iterable This function is used to generate constraints for the Z3 optimization | -| [`r2f`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.r2f#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.r2f "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.r2f") | Convert Z3 Real to Python float | -| [`reset`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.reset#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.reset "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.reset") | Reset variables | -| [`run`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.run#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.run "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.run") | Main scheduling function | -| [`scheduling_constraints`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.scheduling_constraints#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.scheduling_constraints "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.scheduling_constraints") | DAG scheduling constraints optimization Sets overlap indicator variables | -| [`singleq_tuple`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.singleq_tuple#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.singleq_tuple "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.singleq_tuple") | Representation for single-qubit gate | -| [`solve_optimization`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.solve_optimization#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.solve_optimization "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule.solve_optimization") | Setup and solve a Z3 optimization for finding the best schedule | +### assign\_gate\_id -## Attributes + + +`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 + +### basic\_bounds + + + +`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 + +### check\_dag\_dependency + + + +`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 + +### check\_xtalk\_dependency + + + +`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. + +### coherence\_constraints + + + +`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 + +### create\_updated\_dag + + + +`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 + +### create\_z3\_vars + + + +`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 + +### cx\_tuple + + + +`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 + +### enforce\_schedule\_on\_dag + + + +`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 + +### extract\_crosstalk\_relevant\_sets + + + +`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 + +### extract\_dag\_overlap\_sets + + + +`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. + +### extract\_solution + + + +`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 + +### fidelity\_constraints + + + +`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 + +### filter\_candidates + + + +`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. + +### find\_layer + +`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 + +### gate\_tuple + + + +`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 + +### generate\_barriers + + + +`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 + +### is\_significant\_xtalk + + + +`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. + +### name + + + +`CrosstalkAdaptiveSchedule.name()` + +Return the name of the pass. + +### objective\_function + + + +`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 + +### parse\_backend\_properties + + + +`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. + +### powerset + + + +`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 + +### r2f + + + +`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 + +### reset + + + +`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 + +### run + + + +`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 + +### scheduling\_constraints + + + +`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 + +### singleq\_tuple + + + +`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 + +### solve\_optimization + + + +`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 + +## Attributes + + ### is\_analysis\_pass @@ -79,10 +280,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md index bfadee536ca..997db28662b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGFixedPoint.md @@ -1,8 +1,16 @@ -# DAGFixedPoint +--- +title: DAGFixedPoint +description: API reference for qiskit.transpiler.passes.DAGFixedPoint +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.DAGFixedPoint +--- +# DAGFixedPoint + -`DAGFixedPoint(*args, **kwargs)` +`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` @@ -12,14 +20,25 @@ A dummy analysis pass that checks if the DAG a fixed point (the DAG is not modif ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`name`](qiskit.transpiler.passes.DAGFixedPoint.name#qiskit.transpiler.passes.DAGFixedPoint.name "qiskit.transpiler.passes.DAGFixedPoint.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.DAGFixedPoint.run#qiskit.transpiler.passes.DAGFixedPoint.run "qiskit.transpiler.passes.DAGFixedPoint.run") | Run the DAGFixedPoint pass on dag. | +### name -## Attributes + + +`DAGFixedPoint.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +46,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md index 8a8d08d20d2..4ecd9af788b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DAGLongestPath.md @@ -1,8 +1,16 @@ -# DAGLongestPath +--- +title: DAGLongestPath +description: API reference for qiskit.transpiler.passes.DAGLongestPath +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.DAGLongestPath +--- +# DAGLongestPath + -`DAGLongestPath(*args, **kwargs)` +`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` @@ -10,14 +18,25 @@ Return the longest path in a DAGcircuit as a list of DAGNodes. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`name`](qiskit.transpiler.passes.DAGLongestPath.name#qiskit.transpiler.passes.DAGLongestPath.name "qiskit.transpiler.passes.DAGLongestPath.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.DAGLongestPath.run#qiskit.transpiler.passes.DAGLongestPath.run "qiskit.transpiler.passes.DAGLongestPath.run") | Run the DAGLongestPath pass on dag. | +### name -## Attributes + + +`DAGLongestPath.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -25,10 +44,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md index 9e2f195343a..4821800c0d5 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Decompose.md @@ -1,8 +1,16 @@ -# Decompose +--- +title: Decompose +description: API reference for qiskit.transpiler.passes.Decompose +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Decompose +--- +# Decompose + -`Decompose(gate=None)` +`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` @@ -16,14 +24,37 @@ Decompose initializer. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`name`](qiskit.transpiler.passes.Decompose.name#qiskit.transpiler.passes.Decompose.name "qiskit.transpiler.passes.Decompose.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Decompose.run#qiskit.transpiler.passes.Decompose.run "qiskit.transpiler.passes.Decompose.run") | Run the Decompose pass on dag. | +### name -## Attributes + + +`Decompose.name()` + +Return the name of the pass. +### run + + + +`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. + +**Parameters** +**dag** (`DAGCircuit`) – input dag. + +**Return type** + +`DAGCircuit` + +**Returns** + +output dag where `gate` was expanded. + +## Attributes + + ### is\_analysis\_pass @@ -31,10 +62,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md index e20dafb00c5..718d92615bc 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DenseLayout.md @@ -1,8 +1,16 @@ -# DenseLayout +--- +title: DenseLayout +description: API reference for qiskit.transpiler.passes.DenseLayout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.DenseLayout +--- +# DenseLayout + -`DenseLayout(*args, **kwargs)` +`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` @@ -19,18 +27,39 @@ DenseLayout initializer. **Parameters** * **coupling\_map** (*Coupling*) – directed graph representing a coupling map. -* **backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – backend properties object +* **backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – backend properties object ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`name`](qiskit.transpiler.passes.DenseLayout.name#qiskit.transpiler.passes.DenseLayout.name "qiskit.transpiler.passes.DenseLayout.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.DenseLayout.run#qiskit.transpiler.passes.DenseLayout.run "qiskit.transpiler.passes.DenseLayout.run") | Run the DenseLayout pass on dag. | +### name -## Attributes + + +`DenseLayout.name()` + +Return the name of the pass. + +### run + + + +`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. +Pick a convenient layout depending on the best matching qubit connectivity, and set the property layout. +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to find layout for. + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if dag wider than self.coupling\_map + +## Attributes + + ### is\_analysis\_pass @@ -38,10 +67,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md index 24050f51af6..9c0c24fee12 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Depth.md @@ -1,8 +1,16 @@ -# Depth +--- +title: Depth +description: API reference for qiskit.transpiler.passes.Depth +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Depth +--- +# Depth + -`Depth(*args, **kwargs)` +`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` @@ -10,14 +18,25 @@ Calculate the depth of a DAG circuit. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`name`](qiskit.transpiler.passes.Depth.name#qiskit.transpiler.passes.Depth.name "qiskit.transpiler.passes.Depth.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Depth.run#qiskit.transpiler.passes.Depth.run "qiskit.transpiler.passes.Depth.run") | Run the Depth pass on dag. | +### name -## Attributes + + +`Depth.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -25,10 +44,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md index b3b0912e1b3..31691a5df25 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.DynamicalDecoupling.md @@ -1,8 +1,16 @@ -# DynamicalDecoupling +--- +title: DynamicalDecoupling +description: API reference for qiskit.transpiler.passes.DynamicalDecoupling +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.DynamicalDecoupling +--- +# DynamicalDecoupling + -`DynamicalDecoupling(*args, **kwargs)` +`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` @@ -71,22 +79,51 @@ Dynamical decoupling initializer. **Parameters** -* **durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Durations of instructions to be used in scheduling. -* **dd\_sequence** (*list\[*[*Gate*](qiskit.circuit.Gate#qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – sequence of gates to apply in idle spots. +* **durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – Durations of instructions to be used in scheduling. +* **dd\_sequence** (*list\[*[*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")*]*) – sequence of gates to apply in idle spots. * **qubits** (*list\[int]*) – physical qubits on which to apply DD. If None, all qubits will undergo DD (when possible). * **spacing** (*list\[float]*) – a list of spacings between the DD gates. The available slack will be divided according to this. The list length must be one more than the length of dd\_sequence, and the elements must sum to 1. If None, a balanced spacing will be used \[d/2, d, d, …, d, d, d/2]. * **skip\_reset\_qubits** (*bool*) – if True, does not insert DD on idle periods that immediately follow initialized/reset qubits (as qubits in the ground state are less susceptile to decoherence). ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`name`](qiskit.transpiler.passes.DynamicalDecoupling.name#qiskit.transpiler.passes.DynamicalDecoupling.name "qiskit.transpiler.passes.DynamicalDecoupling.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.DynamicalDecoupling.run#qiskit.transpiler.passes.DynamicalDecoupling.run "qiskit.transpiler.passes.DynamicalDecoupling.run") | Run the DynamicalDecoupling pass on dag. | +### name -## Attributes + + +`DynamicalDecoupling.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – a scheduled DAG. +**Returns** + +**equivalent circuit with delays interrupted by DD,** + +where possible. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the circuit is not mapped on physical qubits. + +## Attributes + + ### is\_analysis\_pass @@ -94,10 +131,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md index 46f8da19945..72a4c9337b5 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.EnlargeWithAncilla.md @@ -1,8 +1,16 @@ -# EnlargeWithAncilla +--- +title: EnlargeWithAncilla +description: API reference for qiskit.transpiler.passes.EnlargeWithAncilla +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.EnlargeWithAncilla +--- +# EnlargeWithAncilla + -`EnlargeWithAncilla(*args, **kwargs)` +`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` @@ -12,14 +20,41 @@ Extend the DAG circuit with new virtual qubits (ancilla) that are specified in t ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -| [`name`](qiskit.transpiler.passes.EnlargeWithAncilla.name#qiskit.transpiler.passes.EnlargeWithAncilla.name "qiskit.transpiler.passes.EnlargeWithAncilla.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.EnlargeWithAncilla.run#qiskit.transpiler.passes.EnlargeWithAncilla.run "qiskit.transpiler.passes.EnlargeWithAncilla.run") | Run the EnlargeWithAncilla pass on dag. | +### name -## Attributes + + +`EnlargeWithAncilla.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to extend. +**Returns** + +An extended DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If there is not layout in the property set or not set at init time. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +62,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md index a489a17cf86..58f845efea2 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FixedPoint.md @@ -1,8 +1,16 @@ -# FixedPoint +--- +title: FixedPoint +description: API reference for qiskit.transpiler.passes.FixedPoint +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.FixedPoint +--- +# FixedPoint + -`FixedPoint(*args, **kwargs)` +`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` @@ -18,14 +26,25 @@ FixedPoint initializer. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`name`](qiskit.transpiler.passes.FixedPoint.name#qiskit.transpiler.passes.FixedPoint.name "qiskit.transpiler.passes.FixedPoint.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.FixedPoint.run#qiskit.transpiler.passes.FixedPoint.run "qiskit.transpiler.passes.FixedPoint.run") | Run the FixedPoint pass on dag. | +### name -## Attributes + + +`FixedPoint.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -33,10 +52,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md index f5a77675a4a..75443220b25 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.FullAncillaAllocation.md @@ -1,8 +1,16 @@ -# FullAncillaAllocation +--- +title: FullAncillaAllocation +description: API reference for qiskit.transpiler.passes.FullAncillaAllocation +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.FullAncillaAllocation +--- +# FullAncillaAllocation + -`FullAncillaAllocation(*args, **kwargs)` +`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` @@ -22,15 +30,53 @@ FullAncillaAllocation initializer. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`name`](qiskit.transpiler.passes.FullAncillaAllocation.name#qiskit.transpiler.passes.FullAncillaAllocation.name "qiskit.transpiler.passes.FullAncillaAllocation.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.FullAncillaAllocation.run#qiskit.transpiler.passes.FullAncillaAllocation.run "qiskit.transpiler.passes.FullAncillaAllocation.run") | Run the FullAncillaAllocation pass on dag. | -| [`validate_layout`](qiskit.transpiler.passes.FullAncillaAllocation.validate_layout#qiskit.transpiler.passes.FullAncillaAllocation.validate_layout "qiskit.transpiler.passes.FullAncillaAllocation.validate_layout") | Checks if all the qregs in layout\_qregs already exist in dag\_qregs. | +### name -## Attributes + + +`FullAncillaAllocation.name()` + +Return the name of the pass. + +### run + + + +`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. + +Extend the layout with new (physical qubit, virtual qubit) pairs. The dag signals which virtual qubits are already in the circuit. This pass will allocate new virtual qubits such that no collision occurs (i.e. Layout bijectivity is preserved) + +The coupling\_map and layout together determine which physical qubits are free. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – circuit to analyze +**Returns** +returns the same dag circuit, unmodified + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If there is not layout in the property set or not set at init time. + +### validate\_layout + + + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -38,10 +84,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md index 30227a78143..bd591642853 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.GateDirection.md @@ -1,8 +1,16 @@ -# GateDirection +--- +title: GateDirection +description: API reference for qiskit.transpiler.passes.GateDirection +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.GateDirection +--- +# GateDirection + -`GateDirection(*args, **kwargs)` +`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` @@ -28,18 +36,47 @@ GateDirection pass. **Parameters** -**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. +**coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`name`](qiskit.transpiler.passes.GateDirection.name#qiskit.transpiler.passes.GateDirection.name "qiskit.transpiler.passes.GateDirection.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.GateDirection.run#qiskit.transpiler.passes.GateDirection.run "qiskit.transpiler.passes.GateDirection.run") | Run the GateDirection pass on dag. | +### name -## Attributes + + +`GateDirection.name()` + +Return the name of the pass. + +### run + + + +`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. + +Flips the cx nodes to match the directed coupling map. Modifies the input dag. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. + +**Returns** + +The rearranged dag for the coupling map + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") +**Raises** +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If the circuit cannot be mapped just by flipping the cx nodes. + +## Attributes + + ### is\_analysis\_pass @@ -47,10 +84,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md index 6993a735bf3..526e67b3172 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Layout2qDistance.md @@ -1,8 +1,16 @@ -# Layout2qDistance +--- +title: Layout2qDistance +description: API reference for qiskit.transpiler.passes.Layout2qDistance +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Layout2qDistance +--- +# Layout2qDistance + -`Layout2qDistance(*args, **kwargs)` +`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` @@ -14,19 +22,30 @@ Layout2qDistance initializer. **Parameters** -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph represented a coupling map. * **property\_name** (*str*) – The property name to save the score. Default: layout\_score ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`name`](qiskit.transpiler.passes.Layout2qDistance.name#qiskit.transpiler.passes.Layout2qDistance.name "qiskit.transpiler.passes.Layout2qDistance.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Layout2qDistance.run#qiskit.transpiler.passes.Layout2qDistance.run "qiskit.transpiler.passes.Layout2qDistance.run") | Run the Layout2qDistance pass on dag. | +### name -## Attributes + + +`Layout2qDistance.name()` + +Return the name of the pass. + +### run + +`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 + +## Attributes + + ### is\_analysis\_pass @@ -34,10 +53,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md index 137726bbac2..3b941efdc17 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.LookaheadSwap.md @@ -1,8 +1,16 @@ -# LookaheadSwap +--- +title: LookaheadSwap +description: API reference for qiskit.transpiler.passes.LookaheadSwap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.LookaheadSwap +--- +# LookaheadSwap + -`LookaheadSwap(*args, **kwargs)` +`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` @@ -28,21 +36,51 @@ LookaheadSwap initializer. **Parameters** -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – CouplingMap of the target backend. +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – CouplingMap of the target backend. * **search\_depth** (*int*) – lookahead tree depth when ranking best SWAP options. * **search\_width** (*int*) – lookahead tree width when ranking best SWAP options. * **fake\_run** (*bool*) – if true, it only pretend to do routing, i.e., no swap is effectively added. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`name`](qiskit.transpiler.passes.LookaheadSwap.name#qiskit.transpiler.passes.LookaheadSwap.name "qiskit.transpiler.passes.LookaheadSwap.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.LookaheadSwap.run#qiskit.transpiler.passes.LookaheadSwap.run "qiskit.transpiler.passes.LookaheadSwap.run") | Run the LookaheadSwap pass on dag. | +### name -## Attributes + + +`LookaheadSwap.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the directed acyclic graph to be mapped +**Returns** + +**A dag mapped to be compatible with the coupling\_map in** + +the property\_set. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +* [**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the coupling map or the layout are not +* **compatible with the DAG** – + +## Attributes + + ### is\_analysis\_pass @@ -50,10 +88,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md index e05427fee2d..c5ef7c51fe2 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.MergeAdjacentBarriers.md @@ -1,8 +1,16 @@ -# MergeAdjacentBarriers +--- +title: MergeAdjacentBarriers +description: API reference for qiskit.transpiler.passes.MergeAdjacentBarriers +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.MergeAdjacentBarriers +--- +# MergeAdjacentBarriers + -`MergeAdjacentBarriers(*args, **kwargs)` +`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` @@ -35,14 +43,25 @@ The pass then can be reapplied to merge the newly adjacent barriers. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`name`](qiskit.transpiler.passes.MergeAdjacentBarriers.name#qiskit.transpiler.passes.MergeAdjacentBarriers.name "qiskit.transpiler.passes.MergeAdjacentBarriers.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.MergeAdjacentBarriers.run#qiskit.transpiler.passes.MergeAdjacentBarriers.run "qiskit.transpiler.passes.MergeAdjacentBarriers.run") | Run the MergeAdjacentBarriers pass on dag. | +### name -## Attributes + + +`MergeAdjacentBarriers.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -50,10 +69,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md index 73eb7002b0a..18b39f6de80 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NoiseAdaptiveLayout.md @@ -1,8 +1,16 @@ -# NoiseAdaptiveLayout +--- +title: NoiseAdaptiveLayout +description: API reference for qiskit.transpiler.passes.NoiseAdaptiveLayout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.NoiseAdaptiveLayout +--- +# NoiseAdaptiveLayout + -`NoiseAdaptiveLayout(*args, **kwargs)` +`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` @@ -12,55 +20,37 @@ Choose a noise-adaptive Layout based on current calibration data for the backend > > The pass implements the qubit mapping method from: Noise-Adaptive Compiler Mappings for Noisy Intermediate-Scale Quantum Computers Prakash Murali, Jonathan M. Baker, Ali Javadi-Abhari, Frederic T. Chong, Margaret R. Martonosi ASPLOS 2019 (arXiv:1901.11054). - - `Ordering of edges` - - `Map qubits edge-by-edge in the order of decreasing frequency of occurrence in the program dag.` +### Initialization + `Initialization()` - - `If an edge exists with both endpoints unmapped,` - - `pick the best available hardware cx to execute this edge.` - - `Iterative step` - - `When an edge exists with one endpoint unmapped,` - - `map that endpoint to a location which allows` - - `maximum reliability for CNOTs with previously mapped qubits.` - - `In the end if there are unmapped qubits (which don't` - - `participate in any CNOT), map them to any available` - - `hardware qubit.` +### Notes + `Notes()` @@ -70,22 +60,33 @@ NoiseAdaptiveLayout initializer. **Parameters** -**backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – backend properties object +**backend\_prop** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – backend properties object **Raises** -[**TranspilerError**](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if invalid options +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if invalid options ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -| [`name`](qiskit.transpiler.passes.NoiseAdaptiveLayout.name#qiskit.transpiler.passes.NoiseAdaptiveLayout.name "qiskit.transpiler.passes.NoiseAdaptiveLayout.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.NoiseAdaptiveLayout.run#qiskit.transpiler.passes.NoiseAdaptiveLayout.run "qiskit.transpiler.passes.NoiseAdaptiveLayout.run") | Run the NoiseAdaptiveLayout pass on dag. | +### name -## Attributes + + +`NoiseAdaptiveLayout.name()` +Return the name of the pass. +### run + + + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -93,10 +94,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md index 9cf7c4ca99b..bfb88eaa73f 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.NumTensorFactors.md @@ -1,8 +1,16 @@ -# NumTensorFactors +--- +title: NumTensorFactors +description: API reference for qiskit.transpiler.passes.NumTensorFactors +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.NumTensorFactors +--- +# NumTensorFactors + -`NumTensorFactors(*args, **kwargs)` +`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` @@ -12,14 +20,25 @@ The result is saved in `property_set['num_tensor_factors']` as an integer. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`name`](qiskit.transpiler.passes.NumTensorFactors.name#qiskit.transpiler.passes.NumTensorFactors.name "qiskit.transpiler.passes.NumTensorFactors.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.NumTensorFactors.run#qiskit.transpiler.passes.NumTensorFactors.run "qiskit.transpiler.passes.NumTensorFactors.run") | Run the NumTensorFactors pass on dag. | +### name -## Attributes + + +`NumTensorFactors.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +46,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md index 8fb50940de1..a43c925315a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGates.md @@ -1,8 +1,16 @@ -# Optimize1qGates +--- +title: Optimize1qGates +description: API reference for qiskit.transpiler.passes.Optimize1qGates +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Optimize1qGates +--- +# Optimize1qGates + -`Optimize1qGates(*args, **kwargs)` +`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` @@ -17,16 +25,74 @@ Optimize1qGates initializer. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | -| [`compose_u3`](qiskit.transpiler.passes.Optimize1qGates.compose_u3#qiskit.transpiler.passes.Optimize1qGates.compose_u3 "qiskit.transpiler.passes.Optimize1qGates.compose_u3") | Return a triple theta, phi, lambda for the product. | -| [`name`](qiskit.transpiler.passes.Optimize1qGates.name#qiskit.transpiler.passes.Optimize1qGates.name "qiskit.transpiler.passes.Optimize1qGates.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Optimize1qGates.run#qiskit.transpiler.passes.Optimize1qGates.run "qiskit.transpiler.passes.Optimize1qGates.run") | Run the Optimize1qGates pass on dag. | -| [`yzy_to_zyz`](qiskit.transpiler.passes.Optimize1qGates.yzy_to_zyz#qiskit.transpiler.passes.Optimize1qGates.yzy_to_zyz "qiskit.transpiler.passes.Optimize1qGates.yzy_to_zyz") | Express a Y.Z.Y single qubit gate as a Z.Y.Z gate. | +### compose\_u3 -## Attributes + + +`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. + +#### u3(theta, phi, lambda) + +\= u3(theta1, phi1, lambda1).u3(theta2, phi2, lambda2) = Rz(phi1).Ry(theta1).Rz(lambda1+phi2).Ry(theta2).Rz(lambda2) = Rz(phi1).Rz(phi’).Ry(theta’).Rz(lambda’).Rz(lambda2) = u3(theta’, phi1 + phi’, lambda2 + lambda’) + +Return theta, phi, lambda. + +### name + + + +`Optimize1qGates.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the DAG to be optimized. +**Returns** +the optimized DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if YZY and ZYZ angles do not give same rotation matrix. + +### yzy\_to\_zyz + + + +`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. + +Solve the equation + +$$ +$$ + +Ry(theta1).Rz(xi).Ry(theta2) = Rz(phi).Ry(theta).Rz(lambda) + +for theta, phi, and lambda. + +Return a solution theta, phi, and lambda. + +## Attributes + + ### is\_analysis\_pass @@ -34,10 +100,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md index fbf09993e1e..9f025335f64 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Optimize1qGatesDecomposition.md @@ -1,8 +1,16 @@ -# Optimize1qGatesDecomposition +--- +title: Optimize1qGatesDecomposition +description: API reference for qiskit.transpiler.passes.Optimize1qGatesDecomposition +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Optimize1qGatesDecomposition +--- +# Optimize1qGatesDecomposition + -`Optimize1qGatesDecomposition(*args, **kwargs)` +`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` @@ -16,14 +24,37 @@ Optimize1qGatesDecomposition initializer. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| [`name`](qiskit.transpiler.passes.Optimize1qGatesDecomposition.name#qiskit.transpiler.passes.Optimize1qGatesDecomposition.name "qiskit.transpiler.passes.Optimize1qGatesDecomposition.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Optimize1qGatesDecomposition.run#qiskit.transpiler.passes.Optimize1qGatesDecomposition.run "qiskit.transpiler.passes.Optimize1qGatesDecomposition.run") | Run the Optimize1qGatesDecomposition pass on dag. | +### name -## Attributes + + +`Optimize1qGatesDecomposition.name()` + +Return the name of the pass. +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the DAG to be optimized. + +**Returns** + +the optimized DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -31,10 +62,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md index 723cdc2efb5..247952bd2a6 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilder.md @@ -1,8 +1,16 @@ -# RZXCalibrationBuilder +--- +title: RZXCalibrationBuilder +description: API reference for qiskit.transpiler.passes.RZXCalibrationBuilder +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilder +--- +# RZXCalibrationBuilder + -`RZXCalibrationBuilder(backend)` +`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` @@ -20,17 +28,104 @@ Initializes a RZXGate calibration builder. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | -| [`get_calibration`](qiskit.transpiler.passes.RZXCalibrationBuilder.get_calibration#qiskit.transpiler.passes.RZXCalibrationBuilder.get_calibration "qiskit.transpiler.passes.RZXCalibrationBuilder.get_calibration") | **type params**`List` | -| [`name`](qiskit.transpiler.passes.RZXCalibrationBuilder.name#qiskit.transpiler.passes.RZXCalibrationBuilder.name "qiskit.transpiler.passes.RZXCalibrationBuilder.name") | Return the name of the pass. | -| [`rescale_cr_inst`](qiskit.transpiler.passes.RZXCalibrationBuilder.rescale_cr_inst#qiskit.transpiler.passes.RZXCalibrationBuilder.rescale_cr_inst "qiskit.transpiler.passes.RZXCalibrationBuilder.rescale_cr_inst") | **type instruction**`Play` | -| [`run`](qiskit.transpiler.passes.RZXCalibrationBuilder.run#qiskit.transpiler.passes.RZXCalibrationBuilder.run "qiskit.transpiler.passes.RZXCalibrationBuilder.run") | Run the calibration adder pass on dag. | -| [`supported`](qiskit.transpiler.passes.RZXCalibrationBuilder.supported#qiskit.transpiler.passes.RZXCalibrationBuilder.supported "qiskit.transpiler.passes.RZXCalibrationBuilder.supported") | **type node\_op**`DAGNode` | +### get\_calibration -## Attributes + + +`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** + +* **params** (`List`) – Parameters of the RZXGate(theta). I.e. params\[0] is theta. +* **qubits** (`List`) – List of qubits for which to get the schedules. The first qubit is the control and the second is the target. + +**Returns** + +The calibration schedule for the RZXGate(theta). + +**Return type** + +schedule + +**Raises** + +**QiskitError** – if the control and target qubits cannot be identified or the backend does not support cx between the qubits. + +### name + + + +`RZXCalibrationBuilder.name()` + +Return the name of the pass. + +### rescale\_cr\_inst + + + +`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** + +* **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. +* **theta** (`float`) – desired angle, pi/2 is assumed to be the angle that the pulse in the given play instruction implements. +* **sample\_mult** (`int`) – All pulses must be a multiple of sample\_mult. + +**Returns** + +**The play instruction with the stretched compressed** + +GaussianSquare pulse. + +**Return type** +[qiskit.pulse.Play](qiskit.pulse.Play "qiskit.pulse.Play") +**Raises** + +**QiskitError** – if the pulses are not GaussianSquare. + +### run + + + +`RZXCalibrationBuilder.run(dag)` + +Run the calibration adder pass on dag. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to schedule. + +**Returns** + +A DAG with calibrations added to it. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +### supported + + + +`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** + +**node\_op** (`DAGNode`) – The node from the dag dep. + +**Returns** + +True if the node is a RZXGate. + +**Return type** + +match + +## Attributes + + ### is\_analysis\_pass @@ -38,10 +133,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md index 29764b81bc5..d1e35d9d7f8 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.md @@ -1,14 +1,22 @@ -# RZXCalibrationBuilderNoEcho +--- +title: RZXCalibrationBuilderNoEcho +description: API reference for qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho +--- +# RZXCalibrationBuilderNoEcho + -`RZXCalibrationBuilderNoEcho(backend)` +`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` Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. -The `RZXCalibrationBuilderNoEcho` is a variation of the [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder#qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.RZXCalibrationBuilder") pass that creates calibrations for the cross-resonance pulses without inserting the echo pulses in the pulse schedule. This enables exposing the echo in the cross-resonance sequence as gates so that the transpiler can simplify them. The `RZXCalibrationBuilderNoEcho` only supports the hardware-native direction of the CX gate. +The `RZXCalibrationBuilderNoEcho` is a variation of the [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.RZXCalibrationBuilder") pass that creates calibrations for the cross-resonance pulses without inserting the echo pulses in the pulse schedule. This enables exposing the echo in the cross-resonance sequence as gates so that the transpiler can simplify them. The `RZXCalibrationBuilderNoEcho` only supports the hardware-native direction of the CX gate. Initializes a RZXGate calibration builder. @@ -22,17 +30,106 @@ Initializes a RZXGate calibration builder. ## Methods -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`get_calibration`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.get_calibration#qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.get_calibration "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.get_calibration") | Builds the calibration schedule for the RZXGate(theta) without echos. | -| [`name`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.name#qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.name "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.name") | Return the name of the pass. | -| [`rescale_cr_inst`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.rescale_cr_inst#qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.rescale_cr_inst "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.rescale_cr_inst") | **type instruction**`Play` | -| [`run`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.run#qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.run "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.run") | Run the calibration adder pass on dag. | -| [`supported`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.supported#qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.supported "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho.supported") | **type node\_op**`DAGNode` | +### get\_calibration -## Attributes + + +`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. + +**Parameters** + +* **params** (`List`) – Parameters of the RZXGate(theta). I.e. params\[0] is theta. +* **qubits** (`List`) – List of qubits for which to get the schedules. The first qubit is the control and the second is the target. + +**Returns** + +The calibration schedule for the RZXGate(theta). + +**Return type** + +schedule + +**Raises** + +**QiskitError** – If the control and target qubits cannot be identified, or the backend does not support a cx gate between the qubits, or the backend does not natively support the specified direction of the cx. +### name + + +`RZXCalibrationBuilderNoEcho.name()` + +Return the name of the pass. + +### rescale\_cr\_inst + + + +`static RZXCalibrationBuilderNoEcho.rescale_cr_inst(instruction, theta, sample_mult=16)` + +**Parameters** + +* **instruction** (`Play`) – The instruction from which to create a new shortened or lengthened pulse. +* **theta** (`float`) – desired angle, pi/2 is assumed to be the angle that the pulse in the given play instruction implements. +* **sample\_mult** (`int`) – All pulses must be a multiple of sample\_mult. + +**Returns** + +**The play instruction with the stretched compressed** + +GaussianSquare pulse. + +**Return type** + +[qiskit.pulse.Play](qiskit.pulse.Play "qiskit.pulse.Play") + +**Raises** + +**QiskitError** – if the pulses are not GaussianSquare. + +### run + + + +`RZXCalibrationBuilderNoEcho.run(dag)` + +Run the calibration adder pass on dag. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to schedule. + +**Returns** + +A DAG with calibrations added to it. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +### supported + + + +`RZXCalibrationBuilderNoEcho.supported(node_op)` + +**Parameters** + +**node\_op** (`DAGNode`) – The node from the dag dep. + +**Returns** + +True if the node is a RZXGate. + +**Return type** + +match + +## Attributes + + ### is\_analysis\_pass @@ -40,10 +137,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md index 45278b8e09c..77690bd461b 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveBarriers.md @@ -1,8 +1,16 @@ -# RemoveBarriers +--- +title: RemoveBarriers +description: API reference for qiskit.transpiler.passes.RemoveBarriers +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.RemoveBarriers +--- +# RemoveBarriers + -`RemoveBarriers(*args, **kwargs)` +`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` @@ -33,14 +41,29 @@ q_0: ┤ X ├┤ H ├ ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`name`](qiskit.transpiler.passes.RemoveBarriers.name#qiskit.transpiler.passes.RemoveBarriers.name "qiskit.transpiler.passes.RemoveBarriers.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.RemoveBarriers.run#qiskit.transpiler.passes.RemoveBarriers.run "qiskit.transpiler.passes.RemoveBarriers.run") | Run the RemoveBarriers pass on dag. | +### name -## Attributes + + +`RemoveBarriers.name()` + +Return the name of the pass. + +### run + + +`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. + +**Return type** + +`DAGCircuit` + +## Attributes + + ### is\_analysis\_pass @@ -48,10 +71,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md index 426c2a3099f..ea691cfcdcc 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.md @@ -1,8 +1,16 @@ -# RemoveDiagonalGatesBeforeMeasure +--- +title: RemoveDiagonalGatesBeforeMeasure +description: API reference for qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure +--- +# RemoveDiagonalGatesBeforeMeasure + -`RemoveDiagonalGatesBeforeMeasure(*args, **kwargs)` +`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` @@ -12,14 +20,37 @@ Transpiler pass to remove diagonal gates (like RZ, T, Z, etc) before a measureme ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`name`](qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.name#qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.name "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.run#qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.run "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure.run") | Run the RemoveDiagonalGatesBeforeMeasure pass on dag. | +### name -## Attributes + + +`RemoveDiagonalGatesBeforeMeasure.name()` + +Return the name of the pass. + +### run + + + +`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. +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the DAG to be optimized. + +**Returns** + +the optimized DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +58,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md index 5b669ed398b..bd287fcc787 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveFinalMeasurements.md @@ -1,8 +1,16 @@ -# RemoveFinalMeasurements +--- +title: RemoveFinalMeasurements +description: API reference for qiskit.transpiler.passes.RemoveFinalMeasurements +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.RemoveFinalMeasurements +--- +# RemoveFinalMeasurements + -`RemoveFinalMeasurements(*args, **kwargs)` +`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` @@ -12,14 +20,37 @@ This pass removes final barriers and final measurements, as well as the Classica ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`name`](qiskit.transpiler.passes.RemoveFinalMeasurements.name#qiskit.transpiler.passes.RemoveFinalMeasurements.name "qiskit.transpiler.passes.RemoveFinalMeasurements.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.RemoveFinalMeasurements.run#qiskit.transpiler.passes.RemoveFinalMeasurements.run "qiskit.transpiler.passes.RemoveFinalMeasurements.run") | Run the RemoveFinalMeasurements pass on dag. | +### name -## Attributes + + +`RemoveFinalMeasurements.name()` + +Return the name of the pass. + +### run + + + +`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. +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the DAG to be optimized. + +**Returns** + +the optimized DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +58,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md index eea774a7f91..d92c6ed6a1a 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.RemoveResetInZeroState.md @@ -1,8 +1,16 @@ -# RemoveResetInZeroState +--- +title: RemoveResetInZeroState +description: API reference for qiskit.transpiler.passes.RemoveResetInZeroState +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.RemoveResetInZeroState +--- +# RemoveResetInZeroState + -`RemoveResetInZeroState(*args, **kwargs)` +`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` @@ -10,14 +18,37 @@ Remove reset gate when the qubit is in zero state. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| [`name`](qiskit.transpiler.passes.RemoveResetInZeroState.name#qiskit.transpiler.passes.RemoveResetInZeroState.name "qiskit.transpiler.passes.RemoveResetInZeroState.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.RemoveResetInZeroState.run#qiskit.transpiler.passes.RemoveResetInZeroState.run "qiskit.transpiler.passes.RemoveResetInZeroState.run") | Run the RemoveResetInZeroState pass on dag. | +### name -## Attributes + + +`RemoveResetInZeroState.name()` + +Return the name of the pass. + +### run + + + +`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. +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the DAG to be optimized. + +**Returns** + +the optimized DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -25,10 +56,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md index 56dbad80882..43a1246b882 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreLayout.md @@ -1,8 +1,16 @@ -# SabreLayout +--- +title: SabreLayout +description: API reference for qiskit.transpiler.passes.SabreLayout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.SabreLayout +--- +# SabreLayout + -`SabreLayout(*args, **kwargs)` +`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` @@ -27,14 +35,33 @@ SabreLayout initializer. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| [`name`](qiskit.transpiler.passes.SabreLayout.name#qiskit.transpiler.passes.SabreLayout.name "qiskit.transpiler.passes.SabreLayout.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.SabreLayout.run#qiskit.transpiler.passes.SabreLayout.run "qiskit.transpiler.passes.SabreLayout.run") | Run the SabreLayout pass on dag. | +### name -## Attributes + + +`SabreLayout.name()` + +Return the name of the pass. +### run + + +`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. + +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to find layout for. + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if dag wider than self.coupling\_map + +## Attributes + + ### is\_analysis\_pass @@ -42,10 +69,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md index 2c454bed33c..24b02cd5d37 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SabreSwap.md @@ -1,8 +1,16 @@ -# SabreSwap +--- +title: SabreSwap +description: API reference for qiskit.transpiler.passes.SabreSwap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.SabreSwap +--- +# SabreSwap + -`SabreSwap(*args, **kwargs)` +`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` @@ -24,7 +32,7 @@ SabreSwap initializer. **Parameters** -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – CouplingMap of the target backend. +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – CouplingMap of the target backend. * **heuristic** (*str*) – The type of heuristic to use when deciding best swap strategy (‘basic’ or ‘lookahead’ or ‘decay’). * **seed** (*int*) – random seed used to tie-break among candidate swaps. * **fake\_run** (*bool*) – if true, it only pretend to do routing, i.e., no swap is effectively added. @@ -63,14 +71,42 @@ Additional Information: ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`name`](qiskit.transpiler.passes.SabreSwap.name#qiskit.transpiler.passes.SabreSwap.name "qiskit.transpiler.passes.SabreSwap.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.SabreSwap.run#qiskit.transpiler.passes.SabreSwap.run "qiskit.transpiler.passes.SabreSwap.run") | Run the SabreSwap pass on dag. | +### name -## Attributes + + +`SabreSwap.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – the directed acyclic graph to be mapped. +**Returns** + +A dag mapped to be compatible with the coupling\_map. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +* [**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the coupling map or the layout are not +* **compatible with the DAG** – + +## Attributes + + ### is\_analysis\_pass @@ -78,10 +114,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md index c959d94f8ff..310f7e38d21 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.SetLayout.md @@ -1,8 +1,16 @@ -# SetLayout +--- +title: SetLayout +description: API reference for qiskit.transpiler.passes.SetLayout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.SetLayout +--- +# SetLayout + -`SetLayout(*args, **kwargs)` +`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` @@ -14,18 +22,41 @@ SetLayout initializer. **Parameters** -**layout** ([*Layout*](qiskit.transpiler.Layout#qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – the layout to set. +**layout** ([*Layout*](qiskit.transpiler.Layout "qiskit.transpiler.Layout")) – the layout to set. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | -| [`name`](qiskit.transpiler.passes.SetLayout.name#qiskit.transpiler.passes.SetLayout.name "qiskit.transpiler.passes.SetLayout.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.SetLayout.run#qiskit.transpiler.passes.SetLayout.run "qiskit.transpiler.passes.SetLayout.run") | Run the SetLayout pass on dag. | +### name -## Attributes + + +`SetLayout.name()` + +Return the name of the pass. +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. + +**Returns** + +the original DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -33,10 +64,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md index d0b6c8c8c3b..088beac9622 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Size.md @@ -1,8 +1,16 @@ -# Size +--- +title: Size +description: API reference for qiskit.transpiler.passes.Size +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Size +--- +# Size + -`Size(*args, **kwargs)` +`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` @@ -12,14 +20,25 @@ The result is saved in `property_set['size']` as an integer. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`name`](qiskit.transpiler.passes.Size.name#qiskit.transpiler.passes.Size.name "qiskit.transpiler.passes.Size.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Size.run#qiskit.transpiler.passes.Size.run "qiskit.transpiler.passes.Size.run") | Run the Size pass on dag. | +### name -## Attributes + + +`Size.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +46,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md index 8c52ebfe687..8a13931f367 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.StochasticSwap.md @@ -1,8 +1,16 @@ -# StochasticSwap +--- +title: StochasticSwap +description: API reference for qiskit.transpiler.passes.StochasticSwap +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.StochasticSwap +--- +# StochasticSwap + -`StochasticSwap(*args, **kwargs)` +`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` @@ -23,21 +31,49 @@ If these are not satisfied, the behavior is undefined. **Parameters** -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – Directed graph representing a coupling map. * **trials** (*int*) – maximum number of iterations to attempt * **seed** (*int*) – seed for random number generator * **fake\_run** (*bool*) – if true, it only pretend to do routing, i.e., no swap is effectively added. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`name`](qiskit.transpiler.passes.StochasticSwap.name#qiskit.transpiler.passes.StochasticSwap.name "qiskit.transpiler.passes.StochasticSwap.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.StochasticSwap.run#qiskit.transpiler.passes.StochasticSwap.run "qiskit.transpiler.passes.StochasticSwap.run") | Run the StochasticSwap pass on dag. | +### name -## Attributes + + +`StochasticSwap.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to map. +**Returns** + +A mapped DAG. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +* [**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the coupling map or the layout are not +* **compatible with the DAG** – + +## Attributes + + ### is\_analysis\_pass @@ -45,10 +81,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md index 02b2cd906ba..e9a9ae62a6e 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TemplateOptimization.md @@ -1,8 +1,16 @@ -# TemplateOptimization +--- +title: TemplateOptimization +description: API reference for qiskit.transpiler.passes.TemplateOptimization +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.TemplateOptimization +--- +# TemplateOptimization + -`TemplateOptimization(*args, **kwargs)` +`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` @@ -10,21 +18,46 @@ Class for the template optimization pass. **Parameters** -* **template\_list** (*list\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*()]*) – list of the different template circuit to apply. +* **template\_list** (*list\[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*()]*) – list of the different template circuit to apply. * **heuristics\_backward\_param** (*list\[int]*) – \[length, survivor] Those are the parameters for applying heuristics on the backward part of the algorithm. This part of the algorithm creates a tree of matching scenario. This tree grows exponentially. The heuristics evaluates which scenarios have the longest match and keep only those. The length is the interval in the tree for cutting it and survivor is the number of scenarios that are kept. We advice to use l=3 and s=1 to have serious time advantage. We remind that the heuristics implies losing a part of the maximal matches. Check reference for more details. * **heuristics\_qubits\_param** (*list\[int]*) – \[length] The heuristics for the qubit choice make guesses from the dag dependency of the circuit in order to limit the number of qubit configurations to explore. The length is the number of successors or not predecessors that will be explored in the dag dependency of the circuit, each qubits of the nodes are added to the set of authorized qubits. We advice to use length=1. Check reference for more details. * **user\_cost\_dict** (*Dict\[str, int]*) – quantum cost dictionary passed to TemplateSubstitution to configure its behavior. This will override any default values if None is not given. The key is the name of the gate and the value its quantum cost. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`name`](qiskit.transpiler.passes.TemplateOptimization.name#qiskit.transpiler.passes.TemplateOptimization.name "qiskit.transpiler.passes.TemplateOptimization.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.TemplateOptimization.run#qiskit.transpiler.passes.TemplateOptimization.run "qiskit.transpiler.passes.TemplateOptimization.run") | **param dag**DAG circuit. | +### name -## Attributes + + +`TemplateOptimization.name()` + +Return the name of the pass. + +### run + + + +`TemplateOptimization.run(dag)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/passes/optimization/template_optimization.py "view source code") + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG circuit. +**Returns** + +optimized DAG circuit. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – If the template has not the right form or if the output circuit acts differently as the input circuit. + +## Attributes + + ### is\_analysis\_pass @@ -32,10 +65,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md index f6457de7c29..44a16cd9703 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TimeUnitConversion.md @@ -1,8 +1,16 @@ -# TimeUnitConversion +--- +title: TimeUnitConversion +description: API reference for qiskit.transpiler.passes.TimeUnitConversion +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.TimeUnitConversion +--- +# TimeUnitConversion + -`TimeUnitConversion(inst_durations)` +`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` @@ -16,18 +24,45 @@ TimeUnitAnalysis initializer. **Parameters** -**inst\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – A dictionary of durations of instructions. +**inst\_durations** ([*InstructionDurations*](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")) – A dictionary of durations of instructions. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`name`](qiskit.transpiler.passes.TimeUnitConversion.name#qiskit.transpiler.passes.TimeUnitConversion.name "qiskit.transpiler.passes.TimeUnitConversion.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.TimeUnitConversion.run#qiskit.transpiler.passes.TimeUnitConversion.run "qiskit.transpiler.passes.TimeUnitConversion.run") | Run the TimeUnitAnalysis pass on dag. | +### name -## Attributes + + +`TimeUnitConversion.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to be checked. +**Returns** + +DAG with consistent timing and op nodes annotated with duration. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the units are not unifiable + +## Attributes + + ### is\_analysis\_pass @@ -35,10 +70,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md index 5c22ab20191..c6dc911389c 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.TrivialLayout.md @@ -1,8 +1,16 @@ -# TrivialLayout +--- +title: TrivialLayout +description: API reference for qiskit.transpiler.passes.TrivialLayout +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.TrivialLayout +--- +# TrivialLayout + -`TrivialLayout(*args, **kwargs)` +`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` @@ -22,18 +30,37 @@ TrivialLayout initializer. **Raises** -[**TranspilerError**](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if invalid options +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if invalid options ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`name`](qiskit.transpiler.passes.TrivialLayout.name#qiskit.transpiler.passes.TrivialLayout.name "qiskit.transpiler.passes.TrivialLayout.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.TrivialLayout.run#qiskit.transpiler.passes.TrivialLayout.run "qiskit.transpiler.passes.TrivialLayout.run") | Run the TrivialLayout pass on dag. | +### name -## Attributes + + +`TrivialLayout.name()` + +Return the name of the pass. + +### run + + + +`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. +**Parameters** + +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to find layout for. +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if dag wider than self.coupling\_map + +## Attributes + + ### is\_analysis\_pass @@ -41,10 +68,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md index 3a2a294fa67..b72a56d66a9 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnitarySynthesis.md @@ -1,8 +1,16 @@ -# UnitarySynthesis +--- +title: UnitarySynthesis +description: API reference for qiskit.transpiler.passes.UnitarySynthesis +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.UnitarySynthesis +--- +# UnitarySynthesis + -`UnitarySynthesis(basis_gates, approximation_degree=1, coupling_map=None, backend_props=None, pulse_optimize=None, natural_direction=None, synth_gates=None)` +`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` @@ -16,22 +24,51 @@ This pass can approximate 2-qubit unitaries given some approximation closeness m * **basis\_gates** (*list\[str]*) – List of gate names to target. * **approximation\_degree** (*float*) – Closeness of approximation (0: lowest, 1: highest). -* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – the coupling map of the backend in case synthesis is done on a physical circuit. The directionality of the coupling\_map will be taken into account if pulse\_optimize is True/None and natural\_direction is True/None. -* **backend\_props** ([*BackendProperties*](qiskit.providers.models.BackendProperties#qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Properties of a backend to synthesize for (e.g. gate fidelities). +* **coupling\_map** ([*CouplingMap*](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")) – the coupling map of the backend in case synthesis is done on a physical circuit. The directionality of the coupling\_map will be taken into account if pulse\_optimize is True/None and natural\_direction is True/None. +* **backend\_props** ([*BackendProperties*](qiskit.providers.models.BackendProperties "qiskit.providers.models.BackendProperties")) – Properties of a backend to synthesize for (e.g. gate fidelities). * **pulse\_optimize** (*bool*) – Whether to optimize pulses during synthesis. A value of None will attempt it but fall back if it doesn’t succeed. A value of True will raise an error if pulse-optimized synthesis does not succeed. * **natural\_direction** (*bool*) – Whether to apply synthesis considering directionality of 2-qubit gates. Only applies when pulse\_optimize is True or None. The natural direction is determined by first checking to see whether the coupling map is unidirectional. If there is no coupling map or the coupling map is bidirectional, the gate direction with the shorter duration from the backend properties will be used. If set to True, and a natural direction can not be determined, raises TranspileError. If set to None, no exception will be raised if a natural direction can not be determined. * **synth\_gates** (*list\[str]*) – List of gates to synthesize. If None and pulse\_optimize is False or None, default to \[‘unitary’]. If None and pulse\_optimzie == True, default to \[‘unitary’, ‘swap’] ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`name`](qiskit.transpiler.passes.UnitarySynthesis.name#qiskit.transpiler.passes.UnitarySynthesis.name "qiskit.transpiler.passes.UnitarySynthesis.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.UnitarySynthesis.run#qiskit.transpiler.passes.UnitarySynthesis.run "qiskit.transpiler.passes.UnitarySynthesis.run") | Run the UnitarySynthesis pass on dag. | +### name -## Attributes + + +`UnitarySynthesis.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** (`DAGCircuit`) – input dag. +**Return type** + +`DAGCircuit` + +**Returns** + +Output dag with UnitaryGates synthesized to target basis. + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – + +1. pulse\_optimize is True but pulse optimal decomposition is not known for requested basis. 2. pulse\_optimize is True and natural\_direction is True but a preferred gate direction can’t be determined from the coupling map or the relative gate lengths. + +## Attributes + + ### is\_analysis\_pass @@ -39,10 +76,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md index a1e2b3cb79d..d55722e6613 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroll3qOrMore.md @@ -1,8 +1,16 @@ -# Unroll3qOrMore +--- +title: Unroll3qOrMore +description: API reference for qiskit.transpiler.passes.Unroll3qOrMore +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Unroll3qOrMore +--- +# Unroll3qOrMore + -`Unroll3qOrMore(*args, **kwargs)` +`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` @@ -10,14 +18,41 @@ Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`name`](qiskit.transpiler.passes.Unroll3qOrMore.name#qiskit.transpiler.passes.Unroll3qOrMore.name "qiskit.transpiler.passes.Unroll3qOrMore.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Unroll3qOrMore.run#qiskit.transpiler.passes.Unroll3qOrMore.run "qiskit.transpiler.passes.Unroll3qOrMore.run") | Run the Unroll3qOrMore pass on dag. | +### name -## Attributes + + +`Unroll3qOrMore.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – input dag +**Returns** + +output dag with maximum node degrees of 2 + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +**QiskitError** – if a 3q+ gate is not decomposable + +## Attributes + + ### is\_analysis\_pass @@ -25,10 +60,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md index bc74958c355..691671212e0 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.UnrollCustomDefinitions.md @@ -1,8 +1,16 @@ -# UnrollCustomDefinitions +--- +title: UnrollCustomDefinitions +description: API reference for qiskit.transpiler.passes.UnrollCustomDefinitions +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.UnrollCustomDefinitions +--- +# UnrollCustomDefinitions + -`UnrollCustomDefinitions(*args, **kwargs)` +`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` @@ -12,19 +20,47 @@ Unrolls instructions with custom definitions. **Parameters** -* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary#qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.) +* **equivalence\_library** ([*EquivalenceLibrary*](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary")) – The equivalence library which will be used by the BasisTranslator pass. (Instructions in this library will not be unrolled by this pass.) * **basis\_gates** (*list\[str]*) – Target basis names to unroll to, e.g. \[‘u3’, ‘cx’]. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`name`](qiskit.transpiler.passes.UnrollCustomDefinitions.name#qiskit.transpiler.passes.UnrollCustomDefinitions.name "qiskit.transpiler.passes.UnrollCustomDefinitions.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.UnrollCustomDefinitions.run#qiskit.transpiler.passes.UnrollCustomDefinitions.run "qiskit.transpiler.passes.UnrollCustomDefinitions.run") | Run the UnrollCustomDefinitions pass on dag. | +### name -## Attributes + + +`UnrollCustomDefinitions.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – input dag +**Raises** + +* **QiskitError** – if unable to unroll given the basis due to undefined +* **decomposition rules**\*\* (****such as a bad basis****) or \*\***excessive recursion.** – + +**Returns** + +output unrolled dag + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -32,10 +68,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md index a7e82d75168..c02d018eb79 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Unroller.md @@ -1,8 +1,16 @@ -# Unroller +--- +title: Unroller +description: API reference for qiskit.transpiler.passes.Unroller +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Unroller +--- +# Unroller + -`Unroller(*args, **kwargs)` +`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` @@ -18,14 +26,42 @@ Unroller initializer. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | -| [`name`](qiskit.transpiler.passes.Unroller.name#qiskit.transpiler.passes.Unroller.name "qiskit.transpiler.passes.Unroller.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Unroller.run#qiskit.transpiler.passes.Unroller.run "qiskit.transpiler.passes.Unroller.run") | Run the Unroller pass on dag. | +### name -## Attributes + + +`Unroller.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – input dag +**Raises** + +* **QiskitError** – if unable to unroll given the basis due to undefined +* **decomposition rules**\*\* (****such as a bad basis****) or \*\***excessive recursion.** – + +**Returns** + +output unrolled dag + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +## Attributes + + ### is\_analysis\_pass @@ -33,10 +69,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md index 95d7dd61965..a5078bb49fa 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.ValidatePulseGates.md @@ -1,8 +1,16 @@ -# ValidatePulseGates +--- +title: ValidatePulseGates +description: API reference for qiskit.transpiler.passes.ValidatePulseGates +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.ValidatePulseGates +--- +# ValidatePulseGates + -`ValidatePulseGates(granularity=1, min_length=1)` +`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` @@ -25,14 +33,41 @@ Create new pass. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| [`name`](qiskit.transpiler.passes.ValidatePulseGates.name#qiskit.transpiler.passes.ValidatePulseGates.name "qiskit.transpiler.passes.ValidatePulseGates.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.ValidatePulseGates.run#qiskit.transpiler.passes.ValidatePulseGates.run "qiskit.transpiler.passes.ValidatePulseGates.run") | Run the measurement alignment pass on dag. | +### name -## Attributes + + +`ValidatePulseGates.name()` + +Return the name of the pass. + +### run + + + +`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. + +**Parameters** +**dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – DAG to be checked. +**Returns** + +DAG with consistent timing and op nodes annotated with duration. + +**Return type** + +[DAGCircuit](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit") + +**Raises** + +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – When pulse gate violate pulse controller constraints. + +## Attributes + + ### is\_analysis\_pass @@ -40,10 +75,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md index ecff035cdb0..f7e21cd7667 100644 --- a/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md +++ b/docs/api/qiskit/0.32/qiskit.transpiler.passes.Width.md @@ -1,8 +1,16 @@ -# Width +--- +title: Width +description: API reference for qiskit.transpiler.passes.Width +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.transpiler.passes.Width +--- +# Width + -`Width(*args, **kwargs)` +`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` @@ -12,14 +20,25 @@ The result is saved in `property_set['width']` as an integer that contains the n ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------- | ---------------------------- | -| [`name`](qiskit.transpiler.passes.Width.name#qiskit.transpiler.passes.Width.name "qiskit.transpiler.passes.Width.name") | Return the name of the pass. | -| [`run`](qiskit.transpiler.passes.Width.run#qiskit.transpiler.passes.Width.run "qiskit.transpiler.passes.Width.run") | Run the Width pass on dag. | +### name -## Attributes + + +`Width.name()` + +Return the name of the pass. + +### run + +`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. + +## Attributes + + ### is\_analysis\_pass @@ -27,10 +46,11 @@ Check if the pass is an analysis pass. If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass. - + ### is\_transformation\_pass Check if the pass is a transformation pass. If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read). + diff --git a/docs/api/qiskit/0.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 e5f10c9acff..ce49450400a 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 @@ -1,8 +1,16 @@ -# qiskit.transpiler.preset\_passmanagers.level\_0\_pass\_manager +--- +title: level_0_pass_manager +description: API reference for qiskit.transpiler.preset_passmanagers.level_0_pass_manager +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.transpiler.preset_passmanagers.level_0_pass_manager +--- +# qiskit.transpiler.preset\_passmanagers.level\_0\_pass\_manager + -`level_0_pass_manager(pass_manager_config)` +`level_0_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level0.py "view source code") Level 0 pass manager: no explicit optimization other than mapping to backend. @@ -28,4 +36,5 @@ a level 0 pass manager. **Raises** -[**TranspilerError**](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. + 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 192c27ef906..893991f1e1e 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 @@ -1,8 +1,16 @@ -# qiskit.transpiler.preset\_passmanagers.level\_1\_pass\_manager +--- +title: level_1_pass_manager +description: API reference for qiskit.transpiler.preset_passmanagers.level_1_pass_manager +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.transpiler.preset_passmanagers.level_1_pass_manager +--- +# qiskit.transpiler.preset\_passmanagers.level\_1\_pass\_manager + -`level_1_pass_manager(pass_manager_config)` +`level_1_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/transpiler/preset_passmanagers/level1.py "view source code") Level 1 pass manager: light optimization by simple adjacent gate collapsing. @@ -26,4 +34,5 @@ a level 1 pass manager. **Raises** -[**TranspilerError**](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. + 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 387638f028f..2a48a316b60 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 @@ -1,8 +1,16 @@ -# qiskit.transpiler.preset\_passmanagers.level\_2\_pass\_manager +--- +title: level_2_pass_manager +description: API reference for qiskit.transpiler.preset_passmanagers.level_2_pass_manager +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.transpiler.preset_passmanagers.level_2_pass_manager +--- +# qiskit.transpiler.preset\_passmanagers.level\_2\_pass\_manager + -`level_2_pass_manager(pass_manager_config)` +`level_2_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.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. @@ -28,4 +36,5 @@ a level 2 pass manager. **Raises** -[**TranspilerError**](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. + 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 9990cb7f48a..67a6d205867 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 @@ -1,8 +1,16 @@ -# qiskit.transpiler.preset\_passmanagers.level\_3\_pass\_manager +--- +title: level_3_pass_manager +description: API reference for qiskit.transpiler.preset_passmanagers.level_3_pass_manager +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.transpiler.preset_passmanagers.level_3_pass_manager +--- +# qiskit.transpiler.preset\_passmanagers.level\_3\_pass\_manager + -`level_3_pass_manager(pass_manager_config)` +`level_3_pass_manager(pass_manager_config)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.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. @@ -28,4 +36,5 @@ a level 3 pass manager. **Raises** -[**TranspilerError**](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. +[**TranspilerError**](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError") – if the passmanager config is invalid. + diff --git a/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md b/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md index 8d2563ee0e9..328d57f775f 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md +++ b/docs/api/qiskit/0.32/qiskit.utils.QuantumInstance.md @@ -1,8 +1,16 @@ -# QuantumInstance +--- +title: QuantumInstance +description: API reference for qiskit.utils.QuantumInstance +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.utils.QuantumInstance +--- +# 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)` +`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` @@ -41,115 +49,226 @@ Quantum Instance holds a Qiskit Terra backend as well as configuration for circu ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [`assemble`](qiskit.utils.QuantumInstance.assemble#qiskit.utils.QuantumInstance.assemble "qiskit.utils.QuantumInstance.assemble") | assemble circuits | -| [`cals_matrix`](qiskit.utils.QuantumInstance.cals_matrix#qiskit.utils.QuantumInstance.cals_matrix "qiskit.utils.QuantumInstance.cals_matrix") | Get the stored calibration matrices and its timestamp. | -| [`execute`](qiskit.utils.QuantumInstance.execute#qiskit.utils.QuantumInstance.execute "qiskit.utils.QuantumInstance.execute") | A wrapper to interface with quantum backend. | -| [`maybe_refresh_cals_matrix`](qiskit.utils.QuantumInstance.maybe_refresh_cals_matrix#qiskit.utils.QuantumInstance.maybe_refresh_cals_matrix "qiskit.utils.QuantumInstance.maybe_refresh_cals_matrix") | Calculate the time difference from the query of last time. | -| [`reset_execution_results`](qiskit.utils.QuantumInstance.reset_execution_results#qiskit.utils.QuantumInstance.reset_execution_results "qiskit.utils.QuantumInstance.reset_execution_results") | Reset execution results | -| [`set_config`](qiskit.utils.QuantumInstance.set_config#qiskit.utils.QuantumInstance.set_config "qiskit.utils.QuantumInstance.set_config") | Set configurations for the quantum instance. | -| [`transpile`](qiskit.utils.QuantumInstance.transpile#qiskit.utils.QuantumInstance.transpile "qiskit.utils.QuantumInstance.transpile") | A wrapper to transpile circuits to allow algorithm access the transpiled circuits. | +### assemble -## Attributes + + +`QuantumInstance.assemble(circuits)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/quantum_instance.py "view source code") + +assemble circuits + +**Return type** + +[`Qobj`](qiskit.qobj.Qobj "qiskit.qobj.Qobj") + +### cals\_matrix + + + +`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. + +**Parameters** + +**qubit\_index** (`Optional`\[`List`\[`int`]]) – the qubit index of corresponding calibration matrix. If None, return all stored calibration matrices. + +**Return type** + +`Union`\[`Tuple`\[`ndarray`, `float`], `Dict`\[`str`, `Tuple`\[`ndarray`, `float`]], `None`] + +**Returns** + +The calibration matrix and the creation timestamp if qubit\_index is not None otherwise, return all matrices and their timestamp in a dictionary. + +### execute + + + +`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. + +**Parameters** + +* **circuits** (*Union\['QuantumCircuit', List\['QuantumCircuit']]*) – circuits to execute +* **had\_transpiled** (`bool`) – whether or not circuits had been transpiled + +**Raises** + +* **QiskitError** – Invalid error mitigation fitter class +* **QiskitError** – TensoredMeasFitter class doesn’t support subset fitter +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Ignis not installed + +**Returns** + +result object + +**Return type** + +[Result](qiskit.result.Result "qiskit.result.Result") + +#### TODO: Maybe we can combine the circuits for the main ones and calibration circuits before + +assembling to the qobj. + +### maybe\_refresh\_cals\_matrix + + + +`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. + +**Parameters** + +**timestamp** (`Optional`\[`float`]) – timestamp +**Return type** + +`bool` + +**Returns** + +Whether or not refresh the cals\_matrix + +### reset\_execution\_results + + + +`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 + +**Return type** + +`None` + +### set\_config + + + +`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. + +### transpile + + + +`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’]] + +**Returns** + +**The transpiled circuits, it is always a list even though** + +the length is one. +**Return type** + +List\[‘QuantumCircuit’] + +## Attributes + + ### backend Return BaseBackend backend object. - + ### backend\_config Getter of backend\_config. - + ### backend\_name Return backend name. - + ### backend\_options Getter of backend\_options. - + ### cals\_matrix\_refresh\_period returns matrix refresh period - + ### circuit\_summary Getter of circuit summary. - + ### compile\_config Getter of compile\_config. - + ### is\_local Return True if backend is a local backend. - + ### is\_simulator Return True if backend is a simulator. - + ### is\_statevector Return True if backend is a statevector-type simulator. - + ### measurement\_error\_mitigation\_cls returns measurement error mitigation cls - + ### measurement\_error\_mitigation\_shots returns measurement error mitigation shots - + ### noise\_config Getter of noise\_config. - + ### qjob\_config Getter of qjob\_config. - + ### run\_config Getter of run\_config. - + ### skip\_qobj\_validation checks if skip qobj validation - + ### time\_taken @@ -158,3 +277,4 @@ Accumulated time taken for execution. **Return type** `float` + 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 c6a5fb0a22b..2017d1c6643 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.apply_prefix.md +++ b/docs/api/qiskit/0.32/qiskit.utils.apply_prefix.md @@ -1,8 +1,16 @@ -# qiskit.utils.apply\_prefix +--- +title: apply_prefix +description: API reference for qiskit.utils.apply_prefix +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.apply_prefix +--- +# qiskit.utils.apply\_prefix + -`apply_prefix(value, unit)` +`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. @@ -22,3 +30,4 @@ Converted value. **Raises** **Exception** – If the units aren’t recognized. + 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 589025e2b97..8282d5f19c9 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.deprecate_arguments.md +++ b/docs/api/qiskit/0.32/qiskit.utils.deprecate_arguments.md @@ -1,7 +1,16 @@ -# qiskit.utils.deprecate\_arguments +--- +title: deprecate_arguments +description: API reference for qiskit.utils.deprecate_arguments +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.deprecate_arguments +--- +# qiskit.utils.deprecate\_arguments + -`deprecate_arguments(kwarg_map)` +`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 0a6cd3f98db..2b87a5fcc00 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.deprecate_function.md +++ b/docs/api/qiskit/0.32/qiskit.utils.deprecate_function.md @@ -1,8 +1,16 @@ -# qiskit.utils.deprecate\_function +--- +title: deprecate_function +description: API reference for qiskit.utils.deprecate_function +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.deprecate_function +--- +# qiskit.utils.deprecate\_function + -`deprecate_function(msg, stacklevel=2)` +`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. @@ -18,3 +26,4 @@ The decorated, deprecated callable. **Return type** Callable + 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 28c302e75c0..6cf74ea4af2 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 @@ -1,8 +1,16 @@ -# qiskit.utils.get\_entangler\_map +--- +title: get_entangler_map +description: API reference for qiskit.utils.get_entangler_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.get_entangler_map +--- +# qiskit.utils.get\_entangler\_map + -`get_entangler_map(map_type, num_qubits, offset=0)` +`get_entangler_map(map_type, num_qubits, offset=0)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Utility method to get an entangler map among qubits. @@ -23,3 +31,4 @@ list **Raises** **ValueError** – if map\_type is not valid. + 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 240510cff64..189bf9bfc23 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.has_aer.md +++ b/docs/api/qiskit/0.32/qiskit.utils.has_aer.md @@ -1,7 +1,16 @@ -# qiskit.utils.has\_aer +--- +title: has_aer +description: API reference for qiskit.utils.has_aer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.has_aer +--- +# qiskit.utils.has\_aer + -`has_aer()` +`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 a691ba5d4db..60361543541 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md +++ b/docs/api/qiskit/0.32/qiskit.utils.has_ibmq.md @@ -1,7 +1,16 @@ -# qiskit.utils.has\_ibmq +--- +title: has_ibmq +description: API reference for qiskit.utils.has_ibmq +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.has_ibmq +--- +# qiskit.utils.has\_ibmq + -`has_ibmq()` +`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 9d648b0daf2..fa2d188fc3a 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 @@ -1,7 +1,16 @@ -# qiskit.utils.is\_main\_process +--- +title: is_main_process +description: API reference for qiskit.utils.is_main_process +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.is_main_process +--- +# qiskit.utils.is\_main\_process + -`is_main_process()` +`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 422d3b74447..830ffd2cddc 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 @@ -1,8 +1,16 @@ -# qiskit.utils.local\_hardware\_info +--- +title: local_hardware_info +description: API reference for qiskit.utils.local_hardware_info +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.local_hardware_info +--- +# qiskit.utils.local\_hardware\_info + -`local_hardware_info()` +`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. @@ -15,3 +23,4 @@ The hardware information. **Return type** dict + 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 3d3ca0e77ff..eaa2979d4a7 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.name_args.md +++ b/docs/api/qiskit/0.32/qiskit.utils.name_args.md @@ -1,8 +1,16 @@ -# qiskit.utils.name\_args +--- +title: name_args +description: API reference for qiskit.utils.name_args +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.name_args +--- +# qiskit.utils.name\_args + -`name_args(mapping, skip=0)` +`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. @@ -27,3 +35,4 @@ def new_f(a: TypeA, d: TypeD, b: TypeB=None, c: TypeC=None): if c is not None: # raise warning, this is deprecated! ``` + 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 a610325469c..a0271e0a592 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.summarize_circuits.md +++ b/docs/api/qiskit/0.32/qiskit.utils.summarize_circuits.md @@ -1,8 +1,16 @@ -# qiskit.utils.summarize\_circuits +--- +title: summarize_circuits +description: API reference for qiskit.utils.summarize_circuits +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.summarize_circuits +--- +# qiskit.utils.summarize\_circuits + -`summarize_circuits(circuits)` +`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. @@ -16,7 +24,7 @@ The average statistic of the first four is provided if multiple circuits are pro **Parameters** -**circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or \[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – the to-be-summarized circuits +**circuits** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") *or \[*[*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")*]*) – the to-be-summarized circuits **Returns** @@ -25,3 +33,4 @@ a formatted string records the summary **Return type** str + 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 424bca35e64..2b216c7bc49 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 @@ -1,8 +1,16 @@ -# qiskit.utils.validate\_entangler\_map +--- +title: validate_entangler_map +description: API reference for qiskit.utils.validate_entangler_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.utils.validate_entangler_map +--- +# qiskit.utils.validate\_entangler\_map + -`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)` +`validate_entangler_map(entangler_map, num_qubits, allow_double_entanglement=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/utils/entangler_map.py "view source code") Validate a user supplied entangler map and converts entries to ints. @@ -25,3 +33,4 @@ list * **TypeError** – entangler map is not list type or list of list * **ValueError** – the index of entangler map is out of range * **ValueError** – the qubits are cross-entangled. + 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 1f9a73d1527..c6da2a2e904 100644 --- a/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.md +++ b/docs/api/qiskit/0.32/qiskit.validation.jsonschema.SchemaValidationError.md @@ -1,9 +1,18 @@ -# qiskit.validation.jsonschema.SchemaValidationError +--- +title: SchemaValidationError +description: API reference for qiskit.validation.jsonschema.SchemaValidationError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.validation.jsonschema.SchemaValidationError +--- +# qiskit.validation.jsonschema.SchemaValidationError + -`SchemaValidationError(*message)` +`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. Set the error message. + 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 32bf74c695e..2a574f25167 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 @@ -1,8 +1,16 @@ -# qiskit.validation.jsonschema.validate\_json\_against\_schema +--- +title: validate_json_against_schema +description: API reference for qiskit.validation.jsonschema.validate_json_against_schema +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.validation.jsonschema.validate_json_against_schema +--- +# qiskit.validation.jsonschema.validate\_json\_against\_schema + -`validate_json_against_schema(json_dict, schema, err_msg=None)` +`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. @@ -14,4 +22,5 @@ Validates JSON dict against a schema. **Raises** -[**SchemaValidationError**](qiskit.validation.jsonschema.SchemaValidationError#qiskit.validation.jsonschema.SchemaValidationError "qiskit.validation.jsonschema.SchemaValidationError") – Raised if validation fails. +[**SchemaValidationError**](qiskit.validation.jsonschema.SchemaValidationError "qiskit.validation.jsonschema.SchemaValidationError") – Raised if validation fails. + diff --git a/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md b/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md index 2b9b92366b7..019d0e86d97 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.VisualizationError.md @@ -1,9 +1,18 @@ -# qiskit.visualization.VisualizationError +--- +title: VisualizationError +description: API reference for qiskit.visualization.VisualizationError +in_page_toc_min_heading_level: 1 +python_api_type: exception +python_api_name: qiskit.visualization.VisualizationError +--- +# qiskit.visualization.VisualizationError + -`VisualizationError(*message)` +`VisualizationError(*message)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/exceptions.py "view source code") For visualization specific errors. Set the error message. + 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 8e1b5d0f512..6be62f03dfb 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 @@ -1,8 +1,16 @@ -# qiskit.visualization.array\_to\_latex +--- +title: array_to_latex +description: API reference for qiskit.visualization.array_to_latex +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.array_to_latex +--- +# qiskit.visualization.array\_to\_latex + -`array_to_latex(array, precision=5, prefix='', source=False, max_size=8)` +`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) @@ -37,4 +45,5 @@ str or IPython.display.Latex * **TypeError** – If array can not be interpreted as a numerical numpy array. * **ValueError** – If the dimension of array is not 1 or 2. -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If `source` is `False` and `IPython.display.Latex` cannot be imported. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If `source` is `False` and `IPython.display.Latex` cannot be imported. + 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 6bb6b4c7f4f..897f38ffee5 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.circuit_drawer.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.circuit_drawer.md @@ -1,8 +1,16 @@ -# qiskit.visualization.circuit\_drawer +--- +title: circuit_drawer +description: API reference for qiskit.visualization.circuit_drawer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.circuit_drawer +--- +# 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)` +`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: @@ -16,10 +24,10 @@ Draw the quantum circuit. Use the output parameter to choose the drawing format: **Parameters** -* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit to draw +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – the quantum circuit to draw * **scale** (*float*) – scale of image to draw (shrink if \< 1.0). Only used by the mpl, latex and latex\_source outputs. Defaults to 1.0. * **filename** (*str*) – file path to save image to. Defaults to None. -* **style** (*dict or str*) – dictionary of style or file name of style json file. This option is only used by the mpl or latex output type. If style is a str, it is used as the path to a json file which contains a style dict. The file will be opened, parsed, and then any style elements in the dict will replace the default values in the input dict. A file to be loaded must end in `.json`, but the name entered here can omit `.json`. For example, `style='iqx.json'` or `style='iqx'`. If style is a dict and the `'name'` key is set, that name will be used to load a json file, followed by loading the other items in the style dict. For example, `style={'name': 'iqx'}`. If style is not a str and name is not a key in the style dict, then the default value from the user config file (usually `~/.qiskit/settings.conf`) will be used, for example, `circuit_mpl_style = iqx`. If none of these are set, the default style will be used. The search path for style json files can be specified in the user config, for example, `circuit_mpl_style_path = /home/user/styles:/home/user`. See: [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle#qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle") for more information on the contents. +* **style** (*dict or str*) – dictionary of style or file name of style json file. This option is only used by the mpl or latex output type. If style is a str, it is used as the path to a json file which contains a style dict. The file will be opened, parsed, and then any style elements in the dict will replace the default values in the input dict. A file to be loaded must end in `.json`, but the name entered here can omit `.json`. For example, `style='iqx.json'` or `style='iqx'`. If style is a dict and the `'name'` key is set, that name will be used to load a json file, followed by loading the other items in the style dict. For example, `style={'name': 'iqx'}`. If style is not a str and name is not a key in the style dict, then the default value from the user config file (usually `~/.qiskit/settings.conf`) will be used, for example, `circuit_mpl_style = iqx`. If none of these are set, the default style will be used. The search path for style json files can be specified in the user config, for example, `circuit_mpl_style_path = /home/user/styles:/home/user`. See: [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle") for more information on the contents. * **output** (*str*) – select the output method to use for drawing the circuit. Valid choices are `text`, `mpl`, `latex`, `latex_source`. By default the text drawer is used unless the user config file (usually `~/.qiskit/settings.conf`) has an alternative backend set as the default. For example, `circuit_drawer = latex`. If the output kwarg is set, that backend will always be used over the default in the user config file. * **interactive** (*bool*) – when set to true, show the circuit in a new window (for mpl this depends on the matplotlib backend being used supporting this). Note when used with either the text or the latex\_source output type this has no effect and will be silently ignored. Defaults to False. * **reverse\_bits** (*bool*) – when set to True, reverse the bit order inside registers for the output visualization. Defaults to False. @@ -55,8 +63,8 @@ Draw the quantum circuit. Use the output parameter to choose the drawing format: **Raises** -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when the output methods requires non-installed libraries. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when an invalid output method is selected +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when the output methods requires non-installed libraries. ## Example @@ -72,3 +80,4 @@ circuit_drawer(qc, output='mpl', style={'backgroundcolor': '#EEEEEE'}) ``` ![../\_images/qiskit.visualization.circuit\_drawer\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.circuit_drawer_0_0.png) + 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 97efae1e551..741ab2c5c1e 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.dag_drawer.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.dag_drawer.md @@ -1,8 +1,16 @@ -# qiskit.visualization.dag\_drawer +--- +title: dag_drawer +description: API reference for qiskit.visualization.dag_drawer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.dag_drawer +--- +# qiskit.visualization.dag\_drawer + -`dag_drawer(dag, scale=0.7, filename=None, style='color')` +`dag_drawer(dag, scale=0.7, filename=None, style='color')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/dag_visualization.py "view source code") Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. @@ -12,7 +20,7 @@ The current release of Graphviz can be downloaded here: \<[https://graphviz.gitl **Parameters** -* **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit#qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – The dag to draw. +* **dag** ([*DAGCircuit*](qiskit.dagcircuit.DAGCircuit "qiskit.dagcircuit.DAGCircuit")) – The dag to draw. * **scale** (*float*) – scaling factor * **filename** (*str*) – file path to save image to (format inferred from name) * **style** (*str*) – ‘plain’: B\&W graph ‘color’ (default): color input/output/op nodes @@ -29,8 +37,8 @@ PIL.Image **Raises** -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when style is not recognized. -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when pydot or pillow are not installed. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – when style is not recognized. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when pydot or pillow are not installed. ## Example @@ -54,3 +62,4 @@ dag_drawer(dag) ``` ![../\_images/qiskit.visualization.dag\_drawer\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.dag_drawer_0_0.png) + 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 f15efc1cf95..301414dd80a 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 @@ -1,8 +1,16 @@ -# qiskit.visualization.pass\_manager\_drawer +--- +title: pass_manager_drawer +description: API reference for qiskit.visualization.pass_manager_drawer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.pass_manager_drawer +--- +# qiskit.visualization.pass\_manager\_drawer + -`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)` +`pass_manager_drawer(pass_manager, filename=None, style=None, raw=False)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pass_manager_visualization.py "view source code") Draws the pass manager. @@ -10,7 +18,7 @@ This function needs pydot \<[https://github.com/erocarrera/pydot](https://github **Parameters** -* **pass\_manager** ([*PassManager*](qiskit.transpiler.PassManager#qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")) – the pass manager to be drawn +* **pass\_manager** ([*PassManager*](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")) – the pass manager to be drawn * **filename** (*str*) – file path to save image to * **style** (*dict or OrderedDict*) – keys are the pass classes and the values are the colors to make them. An example can be seen in the DEFAULT\_STYLE. An ordered dict can be used to ensure a priority coloring when pass falls into multiple categories. Any values not included in the provided dict will be filled in from the default dict * **raw** (*Bool*) – True if you want to save the raw Dot output not an image. The default is False. @@ -25,8 +33,8 @@ PIL.Image or None **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when nxpd or pydot not installed. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – If raw=True and filename=None. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – when nxpd or pydot not installed. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – If raw=True and filename=None. ## Example @@ -49,3 +57,4 @@ new_circ.draw(output='mpl') pass_manager_drawer(pm, "passmanager.jpg") ``` + 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 8b2c00391bd..d83cc16caf0 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 @@ -1,8 +1,16 @@ -# qiskit.visualization.plot\_bloch\_multivector +--- +title: plot_bloch_multivector +description: API reference for qiskit.visualization.plot_bloch_multivector +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_bloch_multivector +--- +# qiskit.visualization.plot\_bloch\_multivector + -`plot_bloch_multivector(state, title='', figsize=None, *, rho=None, reverse_bits=False)` +`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. @@ -10,7 +18,7 @@ Plot a sphere, axes, the Bloch vector, and its projections onto each axis. **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. * **title** (*str*) – a string that represents the plot title * **figsize** (*tuple*) – Has no effect, here for compatibility only. * **reverse\_bits** (*bool*) – If True, plots qubits following Qiskit’s convention \[Default:False]. @@ -25,8 +33,8 @@ matplotlib.Figure **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. ## Example @@ -45,3 +53,4 @@ plot_bloch_multivector(state, title="New Bloch Multivector", reverse_bits=False) ``` ![../\_images/qiskit.visualization.plot\_bloch\_multivector\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_bloch_multivector_0_0.png) + 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 0bb0267e17f..3f6cc7c81b5 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 @@ -1,8 +1,16 @@ -# qiskit.visualization.plot\_bloch\_vector +--- +title: plot_bloch_vector +description: API reference for qiskit.visualization.plot_bloch_vector +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_bloch_vector +--- +# qiskit.visualization.plot\_bloch\_vector + -`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')` +`plot_bloch_vector(bloch, title='', ax=None, figsize=None, coord_type='cartesian')`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/state_visualization.py "view source code") Plot the Bloch sphere. @@ -26,7 +34,7 @@ Figure **Raises** -[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. +[**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. ## Example @@ -38,3 +46,4 @@ plot_bloch_vector([0,1,0], title="New Bloch Sphere") ``` ![../\_images/qiskit.visualization.plot\_bloch\_vector\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_bloch_vector_0_0.png) + 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 91a46a300cd..31fbea873f5 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 @@ -1,15 +1,23 @@ -# qiskit.visualization.plot\_circuit\_layout +--- +title: plot_circuit_layout +description: API reference for qiskit.visualization.plot_circuit_layout +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_circuit_layout +--- +# qiskit.visualization.plot\_circuit\_layout + -`plot_circuit_layout(circuit, backend, view='virtual')` +`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. **Parameters** -* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Input quantum circuit. -* **backend** ([*BaseBackend*](qiskit.providers.BaseBackend#qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")) – Target backend. +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Input quantum circuit. +* **backend** ([*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")) – Target backend. * **view** (*str*) – Layout view: either ‘virtual’ or ‘physical’. **Returns** @@ -23,7 +31,7 @@ Figure **Raises** * **QiskitError** – Invalid view type given. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – Circuit has no layout attribute. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – Circuit has no layout attribute. ## Example @@ -50,3 +58,4 @@ plot_circuit_layout(new_circ_lv3, backend) ``` ![../\_images/qiskit.visualization.plot\_circuit\_layout\_1\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_circuit_layout_1_0.png) + 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 13618b1dd09..e8e3d1e4cec 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 @@ -1,14 +1,22 @@ -# qiskit.visualization.plot\_error\_map +--- +title: plot_error_map +description: API reference for qiskit.visualization.plot_error_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_error_map +--- +# qiskit.visualization.plot\_error\_map + -`plot_error_map(backend, figsize=(12, 9), show_title=True)` +`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. **Parameters** -* **backend** ([*IBMQBackend*](qiskit.providers.ibmq.IBMQBackend#qiskit.providers.ibmq.IBMQBackend "qiskit.providers.ibmq.IBMQBackend")) – Given backend. +* **backend** ([*IBMQBackend*](qiskit.providers.ibmq.IBMQBackend "qiskit.providers.ibmq.IBMQBackend")) – Given backend. * **figsize** (*tuple*) – Figure size in inches. * **show\_title** (*bool*) – Show the title or not. @@ -22,9 +30,9 @@ Figure **Raises** -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – Input is not IBMQ backend. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – The backend does not provide gate errors for the ‘sx’ gate. -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If seaborn is not installed +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – Input is not IBMQ backend. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – The backend does not provide gate errors for the ‘sx’ gate. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – If seaborn is not installed ## Example @@ -40,3 +48,4 @@ plot_error_map(backend) ``` ![../\_images/qiskit.visualization.plot\_error\_map\_1\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_error_map_1_0.png) + 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 ff5ff2edfa7..78796acecee 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 @@ -1,14 +1,22 @@ -# qiskit.visualization.plot\_gate\_map +--- +title: plot_gate_map +description: API reference for qiskit.visualization.plot_gate_map +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_gate_map +--- +# 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)` +`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. **Parameters** -* **backend** ([*BaseBackend*](qiskit.providers.BaseBackend#qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")) – A backend instance, +* **backend** ([*BaseBackend*](qiskit.providers.BaseBackend "qiskit.providers.BaseBackend")) – A backend instance, * **figsize** (*tuple*) – Output figure size (wxh) in inches. * **plot\_directed** (*bool*) – Plot directed coupling map. * **label\_qubits** (*bool*) – Label the qubits. @@ -32,7 +40,7 @@ Figure **Raises** * **QiskitError** – if tried to pass a simulator. -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – if matplotlib not installed. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – if matplotlib not installed. ## Example @@ -48,3 +56,4 @@ plot_gate_map(backend) ``` ![../\_images/qiskit.visualization.plot\_gate\_map\_1\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_gate_map_1_0.png) + 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 a7f5a23fe20..41306305d03 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.plot_histogram.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.plot_histogram.md @@ -1,8 +1,16 @@ -# qiskit.visualization.plot\_histogram +--- +title: plot_histogram +description: API reference for qiskit.visualization.plot_histogram +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_histogram +--- +# 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)` +`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. @@ -29,8 +37,8 @@ matplotlib.Figure **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Matplotlib not available. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When legend is provided and the length doesn’t match the input data. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Matplotlib not available. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When legend is provided and the length doesn’t match the input data. ## Example @@ -50,3 +58,4 @@ plot_histogram(job.result().get_counts(), color='midnightblue', title="New Histo ``` ![../\_images/qiskit.visualization.plot\_histogram\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_histogram_0_0.png) + 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 cad4bfde6be..2dac50ef8e7 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 @@ -1,8 +1,16 @@ -# qiskit.visualization.plot\_state\_city +--- +title: plot_state_city +description: API reference for qiskit.visualization.plot_state_city +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_state_city +--- +# qiskit.visualization.plot\_state\_city + -`plot_state_city(state, title='', figsize=None, color=None, alpha=1, ax_real=None, ax_imag=None, *, rho=None)` +`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. @@ -10,7 +18,7 @@ Plot two 3d bar graphs (two dimensional) of the real and imaginary part of the d **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. * **title** (*str*) – a string that represents the plot title * **figsize** (*tuple*) – Figure size in inches. * **color** (*list*) – A list of len=2 giving colors for real and imaginary components of matrix elements. @@ -28,9 +36,9 @@ matplotlib.Figure **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. * **ValueError** – When ‘color’ is not a list of len=2. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. ## Example @@ -50,3 +58,4 @@ plot_state_city(state, color=['midnightblue', 'midnightblue'], ``` ![../\_images/qiskit.visualization.plot\_state\_city\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_state_city_0_0.png) + 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 c09bc4ecc5c..ed6cf7f00fa 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 @@ -1,14 +1,22 @@ -# qiskit.visualization.plot\_state\_hinton +--- +title: plot_state_hinton +description: API reference for qiskit.visualization.plot_state_hinton +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_state_hinton +--- +# qiskit.visualization.plot\_state\_hinton + -`plot_state_hinton(state, title='', figsize=None, ax_real=None, ax_imag=None, *, rho=None)` +`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. **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – An N-qubit quantum state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – An N-qubit quantum state. * **title** (*str*) – a string that represents the plot title * **figsize** (*tuple*) – Figure size in inches. * **ax\_real** (*matplotlib.axes.Axes*) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. If this is specified without an ax\_imag only the real component plot will be generated. Additionally, if specified there will be no returned Figure since it is redundant. @@ -24,8 +32,8 @@ matplotlib.Figure **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. ## Example @@ -44,3 +52,4 @@ plot_state_hinton(state, title="New Hinton Plot") ``` ![../\_images/qiskit.visualization.plot\_state\_hinton\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_state_hinton_0_0.png) + 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 0358d618aa0..efb48c03704 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 @@ -1,8 +1,16 @@ -# qiskit.visualization.plot\_state\_paulivec +--- +title: plot_state_paulivec +description: API reference for qiskit.visualization.plot_state_paulivec +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_state_paulivec +--- +# qiskit.visualization.plot\_state\_paulivec + -`plot_state_paulivec(state, title='', figsize=None, color=None, ax=None, *, rho=None)` +`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. @@ -10,7 +18,7 @@ Plot a bargraph of the mixed state rho over the pauli matrices **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. * **title** (*str*) – a string that represents the plot title * **figsize** (*tuple*) – Figure size in inches. * **color** (*list or str*) – Color of the expectation value bars. @@ -26,8 +34,8 @@ matplotlib.Figure **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. ## Example @@ -47,3 +55,4 @@ plot_state_paulivec(state, color='midnightblue', ``` ![../\_images/qiskit.visualization.plot\_state\_paulivec\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_state_paulivec_0_0.png) + 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 b8c9d08984a..1b859725920 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 @@ -1,14 +1,22 @@ -# qiskit.visualization.plot\_state\_qsphere +--- +title: plot_state_qsphere +description: API reference for qiskit.visualization.plot_state_qsphere +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.plot_state_qsphere +--- +# 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)` +`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. **Parameters** -* **state** ([*Statevector*](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. +* **state** ([*Statevector*](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector") *or*[*DensityMatrix*](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix") *or ndarray*) – an N-qubit quantum state. * **figsize** (*tuple*) – Figure size in inches. * **ax** (*matplotlib.axes.Axes*) – An optional Axes object to be used for the visualization output. If none is specified a new matplotlib Figure will be created and used. Additionally, if specified there will be no returned Figure since it is redundant. * **show\_state\_labels** (*bool*) – An optional boolean indicating whether to show labels for each basis state. @@ -25,8 +33,8 @@ Figure **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Requires matplotlib. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – if input is not a valid N-qubit state. * **QiskitError** – Input statevector does not have valid dimensions. ## Example @@ -46,3 +54,4 @@ plot_state_qsphere(state) ``` ![../\_images/qiskit.visualization.plot\_state\_qsphere\_0\_0.png](/images/api/qiskit/0.32/qiskit.visualization.plot_state_qsphere_0_0.png) + 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 3e727b04b2f..e2d818293eb 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 @@ -1,8 +1,16 @@ -# IQXDebugging +--- +title: IQXDebugging +description: API reference for qiskit.visualization.pulse_v2.IQXDebugging +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.visualization.pulse_v2.IQXDebugging +--- +# IQXDebugging + -`IQXDebugging(**kwargs)` +`IQXDebugging(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` @@ -21,16 +29,83 @@ Pulse stylesheet for pulse programmers. Show details of instructions. ## Methods -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.visualization.pulse_v2.IQXDebugging.clear#qiskit.visualization.pulse_v2.IQXDebugging.clear "qiskit.visualization.pulse_v2.IQXDebugging.clear") | | -| [`copy`](qiskit.visualization.pulse_v2.IQXDebugging.copy#qiskit.visualization.pulse_v2.IQXDebugging.copy "qiskit.visualization.pulse_v2.IQXDebugging.copy") | | -| [`fromkeys`](qiskit.visualization.pulse_v2.IQXDebugging.fromkeys#qiskit.visualization.pulse_v2.IQXDebugging.fromkeys "qiskit.visualization.pulse_v2.IQXDebugging.fromkeys") | Create a new dictionary with keys from iterable and values set to value. | -| [`get`](qiskit.visualization.pulse_v2.IQXDebugging.get#qiskit.visualization.pulse_v2.IQXDebugging.get "qiskit.visualization.pulse_v2.IQXDebugging.get") | Return the value for key if key is in the dictionary, else default. | -| [`items`](qiskit.visualization.pulse_v2.IQXDebugging.items#qiskit.visualization.pulse_v2.IQXDebugging.items "qiskit.visualization.pulse_v2.IQXDebugging.items") | | -| [`keys`](qiskit.visualization.pulse_v2.IQXDebugging.keys#qiskit.visualization.pulse_v2.IQXDebugging.keys "qiskit.visualization.pulse_v2.IQXDebugging.keys") | | -| [`pop`](qiskit.visualization.pulse_v2.IQXDebugging.pop#qiskit.visualization.pulse_v2.IQXDebugging.pop "qiskit.visualization.pulse_v2.IQXDebugging.pop") | If key is not found, d is returned if given, otherwise KeyError is raised | -| [`popitem`](qiskit.visualization.pulse_v2.IQXDebugging.popitem#qiskit.visualization.pulse_v2.IQXDebugging.popitem "qiskit.visualization.pulse_v2.IQXDebugging.popitem") | 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.visualization.pulse_v2.IQXDebugging.setdefault#qiskit.visualization.pulse_v2.IQXDebugging.setdefault "qiskit.visualization.pulse_v2.IQXDebugging.setdefault") | Insert key with a value of default if key is not in the dictionary. | -| [`update`](qiskit.visualization.pulse_v2.IQXDebugging.update#qiskit.visualization.pulse_v2.IQXDebugging.update "qiskit.visualization.pulse_v2.IQXDebugging.update") | If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] | -| [`values`](qiskit.visualization.pulse_v2.IQXDebugging.values#qiskit.visualization.pulse_v2.IQXDebugging.values "qiskit.visualization.pulse_v2.IQXDebugging.values") | | +### clear + + + +`IQXDebugging.clear() → None. Remove all items from D.` + +### copy + + + +`IQXDebugging.copy() → a shallow copy of D` + +### fromkeys + + + +`IQXDebugging.fromkeys(value=None, /)` + +Create a new dictionary with keys from iterable and values set to value. + +### get + + + +`IQXDebugging.get(key, default=None, /)` + +Return the value for key if key is in the dictionary, else default. + +### items + + + +`IQXDebugging.items() → a set-like object providing a view on D’s items` + +### keys + + + +`IQXDebugging.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`IQXDebugging.pop(k[, d]) → v, remove specified key and return the corresponding value.` + +If key is not found, d is returned if given, otherwise KeyError is raised + +### popitem + + + +`IQXDebugging.popitem() → (k, v), remove and return some (key, value) pair as a` + +2-tuple; but raise KeyError if D is empty. + +### setdefault + + + +`IQXDebugging.setdefault(key, default=None, /)` + +Insert key with a value of default if key is not in the dictionary. + +Return the value for key if key is in the dictionary, else default. + +### update + + + +`IQXDebugging.update([E, ]**F) → None. Update D from dict/iterable E and F.` + +If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + +### values + + + +`IQXDebugging.values() → an object providing a view on D’s values` + 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 6d805794c48..53ecd61a0b0 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 @@ -1,8 +1,16 @@ -# IQXSimple +--- +title: IQXSimple +description: API reference for qiskit.visualization.pulse_v2.IQXSimple +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.visualization.pulse_v2.IQXSimple +--- +# IQXSimple + -`IQXSimple(**kwargs)` +`IQXSimple(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` @@ -18,16 +26,83 @@ Simple pulse stylesheet without channel notation. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.visualization.pulse_v2.IQXSimple.clear#qiskit.visualization.pulse_v2.IQXSimple.clear "qiskit.visualization.pulse_v2.IQXSimple.clear") | | -| [`copy`](qiskit.visualization.pulse_v2.IQXSimple.copy#qiskit.visualization.pulse_v2.IQXSimple.copy "qiskit.visualization.pulse_v2.IQXSimple.copy") | | -| [`fromkeys`](qiskit.visualization.pulse_v2.IQXSimple.fromkeys#qiskit.visualization.pulse_v2.IQXSimple.fromkeys "qiskit.visualization.pulse_v2.IQXSimple.fromkeys") | Create a new dictionary with keys from iterable and values set to value. | -| [`get`](qiskit.visualization.pulse_v2.IQXSimple.get#qiskit.visualization.pulse_v2.IQXSimple.get "qiskit.visualization.pulse_v2.IQXSimple.get") | Return the value for key if key is in the dictionary, else default. | -| [`items`](qiskit.visualization.pulse_v2.IQXSimple.items#qiskit.visualization.pulse_v2.IQXSimple.items "qiskit.visualization.pulse_v2.IQXSimple.items") | | -| [`keys`](qiskit.visualization.pulse_v2.IQXSimple.keys#qiskit.visualization.pulse_v2.IQXSimple.keys "qiskit.visualization.pulse_v2.IQXSimple.keys") | | -| [`pop`](qiskit.visualization.pulse_v2.IQXSimple.pop#qiskit.visualization.pulse_v2.IQXSimple.pop "qiskit.visualization.pulse_v2.IQXSimple.pop") | If key is not found, d is returned if given, otherwise KeyError is raised | -| [`popitem`](qiskit.visualization.pulse_v2.IQXSimple.popitem#qiskit.visualization.pulse_v2.IQXSimple.popitem "qiskit.visualization.pulse_v2.IQXSimple.popitem") | 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.visualization.pulse_v2.IQXSimple.setdefault#qiskit.visualization.pulse_v2.IQXSimple.setdefault "qiskit.visualization.pulse_v2.IQXSimple.setdefault") | Insert key with a value of default if key is not in the dictionary. | -| [`update`](qiskit.visualization.pulse_v2.IQXSimple.update#qiskit.visualization.pulse_v2.IQXSimple.update "qiskit.visualization.pulse_v2.IQXSimple.update") | If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] | -| [`values`](qiskit.visualization.pulse_v2.IQXSimple.values#qiskit.visualization.pulse_v2.IQXSimple.values "qiskit.visualization.pulse_v2.IQXSimple.values") | | +### clear + + + +`IQXSimple.clear() → None. Remove all items from D.` + +### copy + + + +`IQXSimple.copy() → a shallow copy of D` + +### fromkeys + + + +`IQXSimple.fromkeys(value=None, /)` + +Create a new dictionary with keys from iterable and values set to value. + +### get + + + +`IQXSimple.get(key, default=None, /)` + +Return the value for key if key is in the dictionary, else default. + +### items + + + +`IQXSimple.items() → a set-like object providing a view on D’s items` + +### keys + + + +`IQXSimple.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`IQXSimple.pop(k[, d]) → v, remove specified key and return the corresponding value.` + +If key is not found, d is returned if given, otherwise KeyError is raised + +### popitem + + + +`IQXSimple.popitem() → (k, v), remove and return some (key, value) pair as a` + +2-tuple; but raise KeyError if D is empty. + +### setdefault + + + +`IQXSimple.setdefault(key, default=None, /)` + +Insert key with a value of default if key is not in the dictionary. + +Return the value for key if key is in the dictionary, else default. + +### update + + + +`IQXSimple.update([E, ]**F) → None. Update D from dict/iterable E and F.` + +If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + +### values + + + +`IQXSimple.values() → an object providing a view on D’s values` + 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 886a0031d2a..808cab2e4eb 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 @@ -1,8 +1,16 @@ -# IQXStandard +--- +title: IQXStandard +description: API reference for qiskit.visualization.pulse_v2.IQXStandard +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.visualization.pulse_v2.IQXStandard +--- +# IQXStandard + -`IQXStandard(**kwargs)` +`IQXStandard(**kwargs)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/pulse_v2/stylesheet.py "view source code") Bases: `dict` @@ -18,16 +26,83 @@ Standard pulse stylesheet. ## Methods -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`clear`](qiskit.visualization.pulse_v2.IQXStandard.clear#qiskit.visualization.pulse_v2.IQXStandard.clear "qiskit.visualization.pulse_v2.IQXStandard.clear") | | -| [`copy`](qiskit.visualization.pulse_v2.IQXStandard.copy#qiskit.visualization.pulse_v2.IQXStandard.copy "qiskit.visualization.pulse_v2.IQXStandard.copy") | | -| [`fromkeys`](qiskit.visualization.pulse_v2.IQXStandard.fromkeys#qiskit.visualization.pulse_v2.IQXStandard.fromkeys "qiskit.visualization.pulse_v2.IQXStandard.fromkeys") | Create a new dictionary with keys from iterable and values set to value. | -| [`get`](qiskit.visualization.pulse_v2.IQXStandard.get#qiskit.visualization.pulse_v2.IQXStandard.get "qiskit.visualization.pulse_v2.IQXStandard.get") | Return the value for key if key is in the dictionary, else default. | -| [`items`](qiskit.visualization.pulse_v2.IQXStandard.items#qiskit.visualization.pulse_v2.IQXStandard.items "qiskit.visualization.pulse_v2.IQXStandard.items") | | -| [`keys`](qiskit.visualization.pulse_v2.IQXStandard.keys#qiskit.visualization.pulse_v2.IQXStandard.keys "qiskit.visualization.pulse_v2.IQXStandard.keys") | | -| [`pop`](qiskit.visualization.pulse_v2.IQXStandard.pop#qiskit.visualization.pulse_v2.IQXStandard.pop "qiskit.visualization.pulse_v2.IQXStandard.pop") | If key is not found, d is returned if given, otherwise KeyError is raised | -| [`popitem`](qiskit.visualization.pulse_v2.IQXStandard.popitem#qiskit.visualization.pulse_v2.IQXStandard.popitem "qiskit.visualization.pulse_v2.IQXStandard.popitem") | 2-tuple; but raise KeyError if D is empty. | -| [`setdefault`](qiskit.visualization.pulse_v2.IQXStandard.setdefault#qiskit.visualization.pulse_v2.IQXStandard.setdefault "qiskit.visualization.pulse_v2.IQXStandard.setdefault") | Insert key with a value of default if key is not in the dictionary. | -| [`update`](qiskit.visualization.pulse_v2.IQXStandard.update#qiskit.visualization.pulse_v2.IQXStandard.update "qiskit.visualization.pulse_v2.IQXStandard.update") | If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] | -| [`values`](qiskit.visualization.pulse_v2.IQXStandard.values#qiskit.visualization.pulse_v2.IQXStandard.values "qiskit.visualization.pulse_v2.IQXStandard.values") | | +### clear + + + +`IQXStandard.clear() → None. Remove all items from D.` + +### copy + + + +`IQXStandard.copy() → a shallow copy of D` + +### fromkeys + + + +`IQXStandard.fromkeys(value=None, /)` + +Create a new dictionary with keys from iterable and values set to value. + +### get + + + +`IQXStandard.get(key, default=None, /)` + +Return the value for key if key is in the dictionary, else default. + +### items + + + +`IQXStandard.items() → a set-like object providing a view on D’s items` + +### keys + + + +`IQXStandard.keys() → a set-like object providing a view on D’s keys` + +### pop + + + +`IQXStandard.pop(k[, d]) → v, remove specified key and return the corresponding value.` + +If key is not found, d is returned if given, otherwise KeyError is raised + +### popitem + + + +`IQXStandard.popitem() → (k, v), remove and return some (key, value) pair as a` + +2-tuple; but raise KeyError if D is empty. + +### setdefault + + + +`IQXStandard.setdefault(key, default=None, /)` + +Insert key with a value of default if key is not in the dictionary. + +Return the value for key if key is in the dictionary, else default. + +### update + + + +`IQXStandard.update([E, ]**F) → None. Update D from dict/iterable E and F.` + +If E is present and has a .keys() method, then does: for k in E: D\[k] = E\[k] If E is present and lacks a .keys() method, then does: for k, v in E: D\[k] = v In either case, this is followed by: for k in F: D\[k] = F\[k] + +### values + + + +`IQXStandard.values() → an object providing a view on D’s values` + 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 dc0fb91eccf..cb6071a3027 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 @@ -1,8 +1,16 @@ -# qiskit.visualization.pulse\_v2.draw +--- +title: draw +description: API reference for qiskit.visualization.pulse_v2.draw +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.pulse_v2.draw +--- +# 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)` +`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. @@ -306,5 +314,6 @@ In the same way as above, you can create custom generator or layout functions an **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – When required visualization package is not installed. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When invalid plotter API or invalid time range is specified. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – When required visualization package is not installed. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When invalid plotter API or invalid time range is specified. + 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 aed4e34039e..ebc50613fb6 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.qcstyle.DefaultStyle.md @@ -1,8 +1,16 @@ -# DefaultStyle +--- +title: DefaultStyle +description: API reference for qiskit.visualization.qcstyle.DefaultStyle +in_page_toc_min_heading_level: 1 +python_api_type: class +python_api_name: qiskit.visualization.qcstyle.DefaultStyle +--- +# DefaultStyle + -`DefaultStyle` +`DefaultStyle`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/qcstyle.py "view source code") Bases: `object` @@ -150,3 +158,4 @@ the form (gate\_color, text\_color). Colors can also be entered without the text 'measure': ('#000000', '#FFFFFF'), } ``` + 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 1fb6b0a1e8e..ea097d8895b 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.timeline.draw.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.timeline.draw.md @@ -1,8 +1,16 @@ -# qiskit.visualization.timeline.draw +--- +title: draw +description: API reference for qiskit.visualization.timeline.draw +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.timeline.draw +--- +# 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)` +`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. @@ -50,8 +58,8 @@ The returned data type depends on the plotter. If matplotlib family is specified **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – When required visualization package is not installed. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When invalid plotter API is specified. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – When required visualization package is not installed. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When invalid plotter API is specified. **Style Dict Details** @@ -308,3 +316,4 @@ draw(qc, style=style) ``` In the same way as above, you can create custom generator or layout functions and update existing stylesheet with custom functions. This feature enables you to control the most of appearance of the output image without modifying the codebase of the scheduled circuit drawer. + diff --git a/docs/api/qiskit/0.32/qiskit.visualization.timeline_drawer.md b/docs/api/qiskit/0.32/qiskit.visualization.timeline_drawer.md index 455dbc4baa0..00be284902a 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.timeline_drawer.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.timeline_drawer.md @@ -1,6 +1,14 @@ -# qiskit.visualization.timeline\_drawer +--- +title: timeline_drawer +description: API reference for qiskit.visualization.timeline_drawer +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.timeline_drawer +--- +# qiskit.visualization.timeline\_drawer + `timeline_drawer(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)` @@ -50,8 +58,8 @@ The returned data type depends on the plotter. If matplotlib family is specified **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – When required visualization package is not installed. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When invalid plotter API is specified. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – When required visualization package is not installed. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – When invalid plotter API is specified. **Style Dict Details** @@ -308,3 +316,4 @@ draw(qc, style=style) ``` In the same way as above, you can create custom generator or layout functions and update existing stylesheet with custom functions. This feature enables you to control the most of appearance of the output image without modifying the codebase of the scheduled circuit drawer. + 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 ed914d2f092..f799d8cd91f 100644 --- a/docs/api/qiskit/0.32/qiskit.visualization.visualize_transition.md +++ b/docs/api/qiskit/0.32/qiskit.visualization.visualize_transition.md @@ -1,14 +1,22 @@ -# qiskit.visualization.visualize\_transition +--- +title: visualize_transition +description: API reference for qiskit.visualization.visualize_transition +in_page_toc_min_heading_level: 1 +python_api_type: function +python_api_name: qiskit.visualization.visualize_transition +--- +# qiskit.visualization.visualize\_transition + -`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)` +`visualize_transition(circuit, trace=False, saveas=None, fpg=100, spg=2)`[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/visualization/transition_visualization.py "view source code") Creates animation showing transitions between states of a single qubit by applying quantum gates. **Parameters** -* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Qiskit single-qubit QuantumCircuit. Gates supported are h,x, y, z, rx, ry, rz, s, sdg, t, tdg and u1. +* **circuit** ([*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")) – Qiskit single-qubit QuantumCircuit. Gates supported are h,x, y, z, rx, ry, rz, s, sdg, t, tdg and u1. * **trace** (*bool*) – Controls whether to display tracing vectors - history of 10 past vectors at each step of the animation. * **saveas** (*str*) – User can choose to save the animation as a video to their filesystem. This argument is a string of path with filename and extension (e.g. “movie.mp4” to save the video in current working directory). * **fpg** (*int*) – Frames per gate. Finer control over animation smoothness and computational needs to render the animation. Works well for tkinter GUI as it is, for jupyter GUI it might be preferable to choose fpg between 5-30. @@ -24,5 +32,6 @@ IPython.core.display.HTML **Raises** -* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Must have Matplotlib (and/or IPython) installed. -* [**VisualizationError**](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – Given gate(s) are not supported. +* [**MissingOptionalLibraryError**](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") – Must have Matplotlib (and/or IPython) installed. +* [**VisualizationError**](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError") – Given gate(s) are not supported. + diff --git a/docs/api/qiskit/0.32/qiskit_aqua.md b/docs/api/qiskit/0.32/qiskit_aqua.md index f3a388e4be6..12cb4e05d21 100644 --- a/docs/api/qiskit/0.32/qiskit_aqua.md +++ b/docs/api/qiskit/0.32/qiskit_aqua.md @@ -22,18 +22,18 @@ Qiskit Aqua provides a library of quantum algorithms and components to build qua | ---------------------------------------------------------------------------------------------- | --------------------------------- | | [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | -Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance#qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). +Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | -| [`AquaError`](qiskit.aqua.AquaError#qiskit.aqua.AquaError "qiskit.aqua.AquaError") | Base class for errors raised by Aqua. | -| [`MissingOptionalLibraryError`](qiskit.aqua.MissingOptionalLibraryError#qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") | Raised when an optional library is missing. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | +| [`AquaError`](qiskit.aqua.AquaError "qiskit.aqua.AquaError") | Base class for errors raised by Aqua. | +| [`MissingOptionalLibraryError`](qiskit.aqua.MissingOptionalLibraryError "qiskit.aqua.MissingOptionalLibraryError") | Raised when an optional library is missing. | In addition to standard Python errors Aqua will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`QuantumInstance`](qiskit.aqua.QuantumInstance#qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") | Quantum Backend including execution setting. | +| | | +| ------------------------------------------------------------------------------ | -------------------------------------------- | +| [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") | Quantum Backend including execution setting. | A QuantumInstance holds the Qiskit backend as well as a number of compile and runtime parameters controlling circuit compilation and execution. Aqua’s quantum [`algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms") are run on a device or simulator by passing a QuantumInstance setup with the desired backend etc. diff --git a/docs/api/qiskit/0.32/qiskit_chemistry.md b/docs/api/qiskit/0.32/qiskit_chemistry.md index 045cf3cc319..58d2debb76d 100644 --- a/docs/api/qiskit/0.32/qiskit_chemistry.md +++ b/docs/api/qiskit/0.32/qiskit_chemistry.md @@ -22,11 +22,11 @@ This is Qiskit’s chemistry module that provides for experimentation with chemi This is an overview of the workings of the chemistry module and how it may be used. There are different levels of exposure to its functionality, allowing for experimentation at different abstractions. The outline below starts with the flow that provides the most control of the process. -A classical chemistry driver is first instantiated, from the available [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers"), by means of a molecule specification, along with other configuration such as basis set and method (RHF, ROHF, UHF). This configuration may include custom settings for the specific driver for more custom control over the driver’s behavior. When the driver is run the output is a mostly driver independent [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule"). This contains various quantities that were computed including one and two-body electron integrals that are used as input [`FermionicOperator`](qiskit.chemistry.FermionicOperator#qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator"). Mostly driver independent means that these integrals, for example, will be there from every driver but the values may differ due to how each underlying chemistry library/program computes them. Also some fields in the QMolecule may not be populated by all drivers, for instance dipole integrals are not output from the PyQuante driver, and hence the dipole moment cannot be computed by qiskit.chemistry when using this driver. The FermionicOperator once created can then be converted/mapped to a qubit operator for use as input to an Aqua algorithms. The operator must be in qubit form at this stage since the execution target of the algorithm will be a quantum device, or simulator ,comprised of qubits and the mapping is needed as qubits behave differently than fermions. Once the algorithm is run it will compute the electronic part of the quantity, such as the electronic ground state energy. To get the total ground state energy this can be combined with the nuclear repulsion energy in the QMolecule. +A classical chemistry driver is first instantiated, from the available [`drivers`](qiskit.chemistry.drivers#module-qiskit.chemistry.drivers "qiskit.chemistry.drivers"), by means of a molecule specification, along with other configuration such as basis set and method (RHF, ROHF, UHF). This configuration may include custom settings for the specific driver for more custom control over the driver’s behavior. When the driver is run the output is a mostly driver independent [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule"). This contains various quantities that were computed including one and two-body electron integrals that are used as input [`FermionicOperator`](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator"). Mostly driver independent means that these integrals, for example, will be there from every driver but the values may differ due to how each underlying chemistry library/program computes them. Also some fields in the QMolecule may not be populated by all drivers, for instance dipole integrals are not output from the PyQuante driver, and hence the dipole moment cannot be computed by qiskit.chemistry when using this driver. The FermionicOperator once created can then be converted/mapped to a qubit operator for use as input to an Aqua algorithms. The operator must be in qubit form at this stage since the execution target of the algorithm will be a quantum device, or simulator ,comprised of qubits and the mapping is needed as qubits behave differently than fermions. Once the algorithm is run it will compute the electronic part of the quantity, such as the electronic ground state energy. To get the total ground state energy this can be combined with the nuclear repulsion energy in the QMolecule. -Instead of using the FermionicOperator the [`core.Hamiltonian`](qiskit.chemistry.core.Hamiltonian#qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian") may be used. This itself uses the FermionicOperator but provides a higher level of function to simplify use. For instance the FermionicOperator supports particle-hole transformation and different mappings. And to compute dipole moments each of the X, Y and Z dipole integrals must be prepared, as individual FermionicOperators, in a like manner to the main electronic energy one, i.e. same transformations, and eventually same qubit mapping. The core.Hamiltonian class does all this and more, such as orbital reductions, frozen core and automatic symmetry reduction. When run with a QMolecule output from a driver it produces qubit operators that can be given directly to Aqua algorithms for the computation. Also available are several properties, such as number of particles and number of orbitals, that are needed to correctly instantiate chemistry specific components such as [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD#qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") and [`HartreeFock`](qiskit.chemistry.components.initial_states.HartreeFock#qiskit.chemistry.components.initial_states.HartreeFock "qiskit.chemistry.components.initial_states.HartreeFock"). Using the FermionicOperator directly requires taking the initial values for the QMolecule and then keeping track of any changes based on any orbital elimination and/or freezing, and/or Z2Symmetry reductions that are done. Once the output qubit operators have been used with an Aqua algorithm, to compute the electronic result, this result can be fed back to the core.Hamiltonian, to [`process_algorithm_result()`](qiskit.chemistry.core.Hamiltonian.process_algorithm_result#qiskit.chemistry.core.Hamiltonian.process_algorithm_result "qiskit.chemistry.core.Hamiltonian.process_algorithm_result") which will then compute a final total result including a user friendly formatted text result that may be printed. +Instead of using the FermionicOperator the [`core.Hamiltonian`](qiskit.chemistry.core.Hamiltonian "qiskit.chemistry.core.Hamiltonian") may be used. This itself uses the FermionicOperator but provides a higher level of function to simplify use. For instance the FermionicOperator supports particle-hole transformation and different mappings. And to compute dipole moments each of the X, Y and Z dipole integrals must be prepared, as individual FermionicOperators, in a like manner to the main electronic energy one, i.e. same transformations, and eventually same qubit mapping. The core.Hamiltonian class does all this and more, such as orbital reductions, frozen core and automatic symmetry reduction. When run with a QMolecule output from a driver it produces qubit operators that can be given directly to Aqua algorithms for the computation. Also available are several properties, such as number of particles and number of orbitals, that are needed to correctly instantiate chemistry specific components such as [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") and [`HartreeFock`](qiskit.chemistry.components.initial_states.HartreeFock "qiskit.chemistry.components.initial_states.HartreeFock"). Using the FermionicOperator directly requires taking the initial values for the QMolecule and then keeping track of any changes based on any orbital elimination and/or freezing, and/or Z2Symmetry reductions that are done. Once the output qubit operators have been used with an Aqua algorithm, to compute the electronic result, this result can be fed back to the core.Hamiltonian, to [`process_algorithm_result()`](qiskit.chemistry.core.Hamiltonian#process_algorithm_result "qiskit.chemistry.core.Hamiltonian.process_algorithm_result") which will then compute a final total result including a user friendly formatted text result that may be printed. -Lastly the chemistry [`applications`](qiskit.chemistry.applications#module-qiskit.chemistry.applications "qiskit.chemistry.applications") may be used. These are given a chemistry driver and, in the case of [`MolecularGroundStateEnergy`](qiskit.chemistry.applications.MolecularGroundStateEnergy#qiskit.chemistry.applications.MolecularGroundStateEnergy "qiskit.chemistry.applications.MolecularGroundStateEnergy") an optional instance of an Aqua [`MinimumEigensolver`](qiskit.aqua.algorithms.MinimumEigensolver#qiskit.aqua.algorithms.MinimumEigensolver "qiskit.aqua.algorithms.MinimumEigensolver"), such as [`VQE`](qiskit.aqua.algorithms.VQE#qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"). Optional since components such as [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD#qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") need certain information that may be unknown at this point. So alternatively, when its method [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy#qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") is run a callback can be provided which will later be passed information, such as number of particles and orbitals, and allow a complete MinimumEigensolver to be built using say UCCSD with HartreeFock, and subsequently returned to the application and run. MinimumEigensolver itself uses the core.Hamiltonian class wrapping it to form this high level application. +Lastly the chemistry [`applications`](qiskit.chemistry.applications#module-qiskit.chemistry.applications "qiskit.chemistry.applications") may be used. These are given a chemistry driver and, in the case of [`MolecularGroundStateEnergy`](qiskit.chemistry.applications.MolecularGroundStateEnergy "qiskit.chemistry.applications.MolecularGroundStateEnergy") an optional instance of an Aqua [`MinimumEigensolver`](qiskit.aqua.algorithms.MinimumEigensolver "qiskit.aqua.algorithms.MinimumEigensolver"), such as [`VQE`](qiskit.aqua.algorithms.VQE "qiskit.aqua.algorithms.VQE"). Optional since components such as [`UCCSD`](qiskit.chemistry.components.variational_forms.UCCSD "qiskit.chemistry.components.variational_forms.UCCSD") need certain information that may be unknown at this point. So alternatively, when its method [`compute_energy()`](qiskit.chemistry.applications.MolecularGroundStateEnergy#compute_energy "qiskit.chemistry.applications.MolecularGroundStateEnergy.compute_energy") is run a callback can be provided which will later be passed information, such as number of particles and orbitals, and allow a complete MinimumEigensolver to be built using say UCCSD with HartreeFock, and subsequently returned to the application and run. MinimumEigensolver itself uses the core.Hamiltonian class wrapping it to form this high level application. ### Mappings @@ -52,19 +52,19 @@ The classes and submodules of qiskit.chemistry are now listed for reference: ## Chemistry Error -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | -| [`QiskitChemistryError`](qiskit.chemistry.QiskitChemistryError#qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") | Class for errors returned by Qiskit’s Chemistry module. | +| | | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | +| [`QiskitChemistryError`](qiskit.chemistry.QiskitChemistryError "qiskit.chemistry.QiskitChemistryError") | Class for errors returned by Qiskit’s Chemistry module. | ## Chemistry Classes -| | | -| --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| [`BosonicOperator`](qiskit.chemistry.BosonicOperator#qiskit.chemistry.BosonicOperator "qiskit.chemistry.BosonicOperator") | A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. | -| [`FermionicOperator`](qiskit.chemistry.FermionicOperator#qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") | A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. | -| [`QMolecule`](qiskit.chemistry.QMolecule#qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") | Molecule data class containing driver result. | -| [`WatsonHamiltonian`](qiskit.chemistry.WatsonHamiltonian#qiskit.chemistry.WatsonHamiltonian "qiskit.chemistry.WatsonHamiltonian") | Watson Hamiltonian class containing the results of a driver’s anharmonic calculation | -| [`MP2Info`](qiskit.chemistry.MP2Info#qiskit.chemistry.MP2Info "qiskit.chemistry.MP2Info") | A utility class for Moller-Plesset 2nd order (MP2) information | +| | | +| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| [`BosonicOperator`](qiskit.chemistry.BosonicOperator "qiskit.chemistry.BosonicOperator") | A set of functions to map bosonic Hamiltonians to qubit Hamiltonians. | +| [`FermionicOperator`](qiskit.chemistry.FermionicOperator "qiskit.chemistry.FermionicOperator") | A set of functions to map fermionic Hamiltonians to qubit Hamiltonians. | +| [`QMolecule`](qiskit.chemistry.QMolecule "qiskit.chemistry.QMolecule") | Molecule data class containing driver result. | +| [`WatsonHamiltonian`](qiskit.chemistry.WatsonHamiltonian "qiskit.chemistry.WatsonHamiltonian") | Watson Hamiltonian class containing the results of a driver’s anharmonic calculation | +| [`MP2Info`](qiskit.chemistry.MP2Info "qiskit.chemistry.MP2Info") | A utility class for Moller-Plesset 2nd order (MP2) information | ## Submodules diff --git a/docs/api/qiskit/0.32/qiskit_finance.md b/docs/api/qiskit/0.32/qiskit_finance.md index dae22754151..b2b65c1e285 100644 --- a/docs/api/qiskit/0.32/qiskit_finance.md +++ b/docs/api/qiskit/0.32/qiskit_finance.md @@ -18,9 +18,9 @@ python_api_name: qiskit.finance This is the Qiskit\`s finance module. There is an initial set of function here that will be built out over time. At present it has applications in the form of Ising Hamiltonians. Some financial uncertainty problem components and data providers which supply a source of financial data. -| | | -| ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | -| [`QiskitFinanceError`](qiskit.finance.QiskitFinanceError#qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") | Class for errors returned by Qiskit’s finance module. | +| | | +| --------------------------------------------------------------------------------------------- | ----------------------------------------------------- | +| [`QiskitFinanceError`](qiskit.finance.QiskitFinanceError "qiskit.finance.QiskitFinanceError") | Class for errors returned by Qiskit’s finance module. | In addition to standard Python errors Qiskit’s finance module will raise this error if circumstances are that it cannot proceed to completion. diff --git a/docs/api/qiskit/0.32/qiskit_optimization.md b/docs/api/qiskit/0.32/qiskit_optimization.md index 9264614baed..2c66b903932 100644 --- a/docs/api/qiskit/0.32/qiskit_optimization.md +++ b/docs/api/qiskit/0.32/qiskit_optimization.md @@ -18,19 +18,19 @@ python_api_name: qiskit.optimization Qiskit’s optimization module covers the whole range from high-level modeling of optimization problems, with automatic conversion of problems to different required representations, to a suite of easy-to-use quantum optimization algorithms that are ready to run on classical simulators, as well as on real quantum devices via Qiskit. -This module enables easy, efficient modeling of optimization problems using [docplex](https://developer.ibm.com/docloud/documentation/optimization-modeling/modeling-for-python/). A uniform interface as well as automatic conversion between different problem representations allows users to solve problems using a large set of algorithms, from variational quantum algorithms, such as the Quantum Approximate Optimization Algorithm ([`QAOA`](qiskit.aqua.algorithms.QAOA#qiskit.aqua.algorithms.QAOA "qiskit.aqua.algorithms.QAOA")), to [Grover Adaptive Search](https://arxiv.org/abs/quant-ph/9607014) ([`GroverOptimizer`](qiskit.optimization.algorithms.GroverOptimizer#qiskit.optimization.algorithms.GroverOptimizer "qiskit.optimization.algorithms.GroverOptimizer")), leveraging fundamental [`algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms") provided by Qiskit Aqua. Furthermore, the modular design of the optimization module allows it to be easily extended and facilitates rapid development and testing of new algorithms. Compatible classical optimizers are also provided for testing, validation, and benchmarking. +This module enables easy, efficient modeling of optimization problems using [docplex](https://developer.ibm.com/docloud/documentation/optimization-modeling/modeling-for-python/). A uniform interface as well as automatic conversion between different problem representations allows users to solve problems using a large set of algorithms, from variational quantum algorithms, such as the Quantum Approximate Optimization Algorithm ([`QAOA`](qiskit.aqua.algorithms.QAOA "qiskit.aqua.algorithms.QAOA")), to [Grover Adaptive Search](https://arxiv.org/abs/quant-ph/9607014) ([`GroverOptimizer`](qiskit.optimization.algorithms.GroverOptimizer "qiskit.optimization.algorithms.GroverOptimizer")), leveraging fundamental [`algorithms`](qiskit.aqua.algorithms#module-qiskit.aqua.algorithms "qiskit.aqua.algorithms") provided by Qiskit Aqua. Furthermore, the modular design of the optimization module allows it to be easily extended and facilitates rapid development and testing of new algorithms. Compatible classical optimizers are also provided for testing, validation, and benchmarking. Qiskit’s optimization module supports Quadratically Constrained Quadratic Programs – for simplicity we refer to them just as Quadratic Programs – with binary, integer, and continuous variables, as well as equality and inequality constraints. This class of optimization problems has a vast amount of relevant applications, while still being efficiently representable by matrices and vectors. This class covers some very interesting sub-classes, from Convex Continuous Quadratic Programs, which can be solved efficiently by classical optimization algorithms, to Quadratic Unconstrained Binary Optimization QUBO) problems, which cover many NP-complete, i.e., classically intractable, problems. -| | | -| -------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`QuadraticProgram`](qiskit.optimization.QuadraticProgram#qiskit.optimization.QuadraticProgram "qiskit.optimization.QuadraticProgram") | Quadratically Constrained Quadratic Program representation. | +| | | +| ------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| [`QuadraticProgram`](qiskit.optimization.QuadraticProgram "qiskit.optimization.QuadraticProgram") | Quadratically Constrained Quadratic Program representation. | Representation of a Quadratically Constrained Quadratic Program supporting inequality and equality constraints as well as continuous, binary, and integer variables. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- | -| [`QiskitOptimizationError`](qiskit.optimization.QiskitOptimizationError#qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") | Class for errors returned by Qiskit’s optimization module. | +| | | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | +| [`QiskitOptimizationError`](qiskit.optimization.QiskitOptimizationError "qiskit.optimization.QiskitOptimizationError") | Class for errors returned by Qiskit’s optimization module. | In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. diff --git a/docs/api/qiskit/0.32/qobj.md b/docs/api/qiskit/0.32/qobj.md index d022a3819b5..7cef65651e1 100644 --- a/docs/api/qiskit/0.32/qobj.md +++ b/docs/api/qiskit/0.32/qobj.md @@ -18,33 +18,33 @@ python_api_name: qiskit.qobj ## Base -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | -| [`Qobj`](qiskit.qobj.Qobj#qiskit.qobj.Qobj "qiskit.qobj.Qobj")(\[qobj\_id, config, experiments, header]) | A backwards compat alias for QasmQobj. | -| [`QobjExperimentHeader`](qiskit.qobj.QobjExperimentHeader#qiskit.qobj.QobjExperimentHeader "qiskit.qobj.QobjExperimentHeader")(\*\*kwargs) | A class representing a header dictionary for a Qobj Experiment. | -| [`QobjHeader`](qiskit.qobj.QobjHeader#qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader")(\*\*kwargs) | A class used to represent a dictionary header in Qobj objects. | +| | | +| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| [`Qobj`](qiskit.qobj.Qobj "qiskit.qobj.Qobj")(\[qobj\_id, config, experiments, header]) | A backwards compat alias for QasmQobj. | +| [`QobjExperimentHeader`](qiskit.qobj.QobjExperimentHeader "qiskit.qobj.QobjExperimentHeader")(\*\*kwargs) | A class representing a header dictionary for a Qobj Experiment. | +| [`QobjHeader`](qiskit.qobj.QobjHeader "qiskit.qobj.QobjHeader")(\*\*kwargs) | A class used to represent a dictionary header in Qobj objects. | ## Qasm -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- | -| [`QasmQobj`](qiskit.qobj.QasmQobj#qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")(\[qobj\_id, config, experiments, header]) | A QASM Qobj. | -| [`QasmQobjInstruction`](qiskit.qobj.QasmQobjInstruction#qiskit.qobj.QasmQobjInstruction "qiskit.qobj.QasmQobjInstruction")(name\[, params, qubits, …]) | A class representing a single instruction in an QasmQobj Experiment. | -| [`QasmQobjExperimentConfig`](qiskit.qobj.QasmQobjExperimentConfig#qiskit.qobj.QasmQobjExperimentConfig "qiskit.qobj.QasmQobjExperimentConfig")(\[calibrations, …]) | Configuration for a single QASM experiment in the qobj. | -| [`QasmQobjExperiment`](qiskit.qobj.QasmQobjExperiment#qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment")(\[config, header, …]) | A QASM Qobj Experiment. | -| [`QasmQobjConfig`](qiskit.qobj.QasmQobjConfig#qiskit.qobj.QasmQobjConfig "qiskit.qobj.QasmQobjConfig")(\[shots, max\_credits, …]) | A configuration for a QASM Qobj. | -| [`QasmExperimentCalibrations`](qiskit.qobj.QasmExperimentCalibrations#qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations")(gates) | A container for any calibrations data. | -| [`GateCalibration`](qiskit.qobj.GateCalibration#qiskit.qobj.GateCalibration "qiskit.qobj.GateCalibration")(name, qubits, params, …) | Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| [`QasmQobj`](qiskit.qobj.QasmQobj "qiskit.qobj.QasmQobj")(\[qobj\_id, config, experiments, header]) | A QASM Qobj. | +| [`QasmQobjInstruction`](qiskit.qobj.QasmQobjInstruction "qiskit.qobj.QasmQobjInstruction")(name\[, params, qubits, …]) | A class representing a single instruction in an QasmQobj Experiment. | +| [`QasmQobjExperimentConfig`](qiskit.qobj.QasmQobjExperimentConfig "qiskit.qobj.QasmQobjExperimentConfig")(\[calibrations, …]) | Configuration for a single QASM experiment in the qobj. | +| [`QasmQobjExperiment`](qiskit.qobj.QasmQobjExperiment "qiskit.qobj.QasmQobjExperiment")(\[config, header, …]) | A QASM Qobj Experiment. | +| [`QasmQobjConfig`](qiskit.qobj.QasmQobjConfig "qiskit.qobj.QasmQobjConfig")(\[shots, max\_credits, …]) | A configuration for a QASM Qobj. | +| [`QasmExperimentCalibrations`](qiskit.qobj.QasmExperimentCalibrations "qiskit.qobj.QasmExperimentCalibrations")(gates) | A container for any calibrations data. | +| [`GateCalibration`](qiskit.qobj.GateCalibration "qiskit.qobj.GateCalibration")(name, qubits, params, …) | Each calibration specifies a unique gate by name, qubits and params, and contains the Pulse instructions to implement it. | ## Pulse -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`PulseQobj`](qiskit.qobj.PulseQobj#qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj")(qobj\_id, config, experiments\[, header]) | A Pulse Qobj. | -| [`PulseQobjInstruction`](qiskit.qobj.PulseQobjInstruction#qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")(name, t0\[, ch, …]) | A class representing a single instruction in an PulseQobj Experiment. | -| [`PulseQobjExperimentConfig`](qiskit.qobj.PulseQobjExperimentConfig#qiskit.qobj.PulseQobjExperimentConfig "qiskit.qobj.PulseQobjExperimentConfig")(\[qubit\_lo\_freq, …]) | A config for a single Pulse experiment in the qobj. | -| [`PulseQobjExperiment`](qiskit.qobj.PulseQobjExperiment#qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment")(instructions\[, config, …]) | A Pulse Qobj Experiment. | -| [`PulseQobjConfig`](qiskit.qobj.PulseQobjConfig#qiskit.qobj.PulseQobjConfig "qiskit.qobj.PulseQobjConfig")(meas\_level, meas\_return, …) | A configuration for a Pulse Qobj. | -| [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption#qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption")(name\[, params]) | An individual measurement option. | -| [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem#qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem")(name, samples) | An item in a pulse library. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| [`PulseQobj`](qiskit.qobj.PulseQobj "qiskit.qobj.PulseQobj")(qobj\_id, config, experiments\[, header]) | A Pulse Qobj. | +| [`PulseQobjInstruction`](qiskit.qobj.PulseQobjInstruction "qiskit.qobj.PulseQobjInstruction")(name, t0\[, ch, …]) | A class representing a single instruction in an PulseQobj Experiment. | +| [`PulseQobjExperimentConfig`](qiskit.qobj.PulseQobjExperimentConfig "qiskit.qobj.PulseQobjExperimentConfig")(\[qubit\_lo\_freq, …]) | A config for a single Pulse experiment in the qobj. | +| [`PulseQobjExperiment`](qiskit.qobj.PulseQobjExperiment "qiskit.qobj.PulseQobjExperiment")(instructions\[, config, …]) | A Pulse Qobj Experiment. | +| [`PulseQobjConfig`](qiskit.qobj.PulseQobjConfig "qiskit.qobj.PulseQobjConfig")(meas\_level, meas\_return, …) | A configuration for a Pulse Qobj. | +| [`QobjMeasurementOption`](qiskit.qobj.QobjMeasurementOption "qiskit.qobj.QobjMeasurementOption")(name\[, params]) | An individual measurement option. | +| [`PulseLibraryItem`](qiskit.qobj.PulseLibraryItem "qiskit.qobj.PulseLibraryItem")(name, samples) | An item in a pulse library. | diff --git a/docs/api/qiskit/0.32/qpy.md b/docs/api/qiskit/0.32/qpy.md index 541f5d983b3..844851d1a7c 100644 --- a/docs/api/qiskit/0.32/qpy.md +++ b/docs/api/qiskit/0.32/qpy.md @@ -18,7 +18,7 @@ python_api_name: qiskit.circuit.qpy_serialization ## Using QPY -Using QPY is defined to be straightforward and mirror the user API of the serializers in Python’s standard library, `pickle` and `json`. There are 2 user facing functions: [`qiskit.circuit.qpy_serialization.dump()`](qiskit.circuit.qpy_serialization.dump#qiskit.circuit.qpy_serialization.dump "qiskit.circuit.qpy_serialization.dump") and [`qiskit.circuit.qpy_serialization.load()`](qiskit.circuit.qpy_serialization.load#qiskit.circuit.qpy_serialization.load "qiskit.circuit.qpy_serialization.load") which are used to dump QPY data to a file object and load circuits from QPY data in a file object respectively. For example: +Using QPY is defined to be straightforward and mirror the user API of the serializers in Python’s standard library, `pickle` and `json`. There are 2 user facing functions: [`qiskit.circuit.qpy_serialization.dump()`](qiskit.circuit.qpy_serialization.dump "qiskit.circuit.qpy_serialization.dump") and [`qiskit.circuit.qpy_serialization.load()`](qiskit.circuit.qpy_serialization.load "qiskit.circuit.qpy_serialization.load") which are used to dump QPY data to a file object and load circuits from QPY data in a file object respectively. For example: ```python from qiskit.circuit import QuantumCircuit @@ -38,10 +38,10 @@ with open('bell.qpy', 'rb') as fd: ### API documentation -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -| [`load`](qiskit.circuit.qpy_serialization.load#qiskit.circuit.qpy_serialization.load "qiskit.circuit.qpy_serialization.load")(file\_obj) | Load a QPY binary file | -| [`dump`](qiskit.circuit.qpy_serialization.dump#qiskit.circuit.qpy_serialization.dump "qiskit.circuit.qpy_serialization.dump")(circuits, file\_obj) | Write QPY binary data to a file | +| | | +| ------------------------------------------------------------------------------------------------------------ | ------------------------------- | +| [`load`](qiskit.circuit.qpy_serialization.load "qiskit.circuit.qpy_serialization.load")(file\_obj) | Load a QPY binary file | +| [`dump`](qiskit.circuit.qpy_serialization.dump "qiskit.circuit.qpy_serialization.dump")(circuits, file\_obj) | Write QPY binary data to a file | ### QPY Compatibility @@ -51,7 +51,7 @@ For example, if you generated a QPY file using qiskit-terra 0.18.1 you could loa ## QPY Format -The QPY serialization format is a portable cross-platform binary serialization format for [`QuantumCircuit`](qiskit.circuit.QuantumCircuit#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects in Qiskit. The basic file format is as follows: +The QPY serialization format is a portable cross-platform binary serialization format for [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") objects in Qiskit. The basic file format is as follows: A QPY file (or memory object) always starts with the following 7 byte UTF8 string: `QISKIT` which is immediately followed by the overall file header. The contents of the file header as defined as a C struct are: @@ -200,11 +200,11 @@ struct { } ``` -After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. +After each INSTRUCTION\_PARAM the next `size` bytes are the parameter’s data. The `type` field can be `'i'`, `'f'`, `'p'`, `'e'`, `'s'`, `'c'` or `'n'` which dictate the format. For `'i'` it’s an integer, `'f'` it’s a double, `'s'` if it’s a string (encoded as utf8), `'c'` is a complex and the data is represented by the struct format in the [PARAMETER\_EXPR](#param-expr) section. `'p'` defines a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object which is represented by a PARAM struct (see below), `e` defines a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object (that’s not a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter")) which is represented by a PARAM\_EXPR struct (see below), and `'n'` represents an object from numpy (either an `ndarray` or a numpy type) which means the data is .npy format [2](#f2) data. ### PARAMETER -A PARAMETER represents a [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") object the data for a INSTRUCTION\_PARAM. The contents of the PARAMETER are defined as: +A PARAMETER represents a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") object the data for a INSTRUCTION\_PARAM. The contents of the PARAMETER are defined as: ```python struct { @@ -219,7 +219,7 @@ which is immediately followed by `name_size` utf8 bytes representing the paramet ### PARAMETER\_EXPR -A PARAMETER\_EXPR represents a [`ParameterExpression`](qiskit.circuit.ParameterExpression#qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object that the data for an INSTRUCTION\_PARAM. The contents of a PARAMETER\_EXPR are defined as: +A PARAMETER\_EXPR represents a [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.ParameterExpression") object that the data for an INSTRUCTION\_PARAM. The contents of a PARAMETER\_EXPR are defined as: The PARAMETER\_EXPR data starts with a header: @@ -239,7 +239,7 @@ struct { } ``` -Which is followed immediately by `PARAMETER` object (both the struct and utf8 name bytes) for the symbol map key. That is followed by `size` bytes for the data of the symbol. The data format is dependent on the value of `type`. If `type` is `p` then it represents a [`Parameter`](qiskit.circuit.Parameter#qiskit.circuit.Parameter "qiskit.circuit.Parameter") and size will be 0, the value will just be the same as the key. If `type` is `f` then it represents a double precision float. If `type` is `c` it represents a double precision complex, which is represented by: +Which is followed immediately by `PARAMETER` object (both the struct and utf8 name bytes) for the symbol map key. That is followed by `size` bytes for the data of the symbol. The data format is dependent on the value of `type`. If `type` is `p` then it represents a [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") and size will be 0, the value will just be the same as the key. If `type` is `f` then it represents a double precision float. If `type` is `c` it represents a double precision complex, which is represented by: ```python struct { diff --git a/docs/api/qiskit/0.32/quantum_info.md b/docs/api/qiskit/0.32/quantum_info.md index e0eac69be26..68c436c825f 100644 --- a/docs/api/qiskit/0.32/quantum_info.md +++ b/docs/api/qiskit/0.32/quantum_info.md @@ -18,90 +18,90 @@ python_api_name: qiskit.quantum_info ## Operators -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------- | -| [`Operator`](qiskit.quantum_info.Operator#qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")(data\[, input\_dims, output\_dims]) | Matrix operator class | -| [`Pauli`](qiskit.quantum_info.Pauli#qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")(\[data, x, z, label]) | N-qubit Pauli operator. | -| [`Clifford`](qiskit.quantum_info.Clifford#qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")(data\[, validate]) | An N-qubit unitary operator from the Clifford group. | -| [`ScalarOp`](qiskit.quantum_info.ScalarOp#qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")(\[dims, coeff]) | Scalar identity operator class. | -| [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp#qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")(data\[, coeffs]) | Sparse N-qubit operator in a Pauli basis representation. | -| [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedral#qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral")(\[data, num\_qubits, validate]) | An N-qubit operator from the CNOT-Dihedral group. | -| [`PauliList`](qiskit.quantum_info.PauliList#qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")(data) | List of N-qubit Pauli operators. | -| [`PauliTable`](qiskit.quantum_info.PauliTable#qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")(data) | Symplectic representation of a list Pauli matrices. | -| [`StabilizerTable`](qiskit.quantum_info.StabilizerTable#qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable")(data\[, phase]) | Symplectic representation of a list Stabilizer matrices. | -| [`pauli_basis`](qiskit.quantum_info.pauli_basis#qiskit.quantum_info.pauli_basis "qiskit.quantum_info.pauli_basis")(num\_qubits\[, weight]) | Return the ordered PauliTable for the n-qubit Pauli basis. | -| [`pauli_group`](qiskit.quantum_info.pauli_group#qiskit.quantum_info.pauli_group "qiskit.quantum_info.pauli_group")(number\_of\_qubits\[, case]) | DEPRECATED: Return the Pauli group with 4^n elements. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | +| [`Operator`](qiskit.quantum_info.Operator "qiskit.quantum_info.Operator")(data\[, input\_dims, output\_dims]) | Matrix operator class | +| [`Pauli`](qiskit.quantum_info.Pauli "qiskit.quantum_info.Pauli")(\[data, x, z, label]) | N-qubit Pauli operator. | +| [`Clifford`](qiskit.quantum_info.Clifford "qiskit.quantum_info.Clifford")(data\[, validate]) | An N-qubit unitary operator from the Clifford group. | +| [`ScalarOp`](qiskit.quantum_info.ScalarOp "qiskit.quantum_info.ScalarOp")(\[dims, coeff]) | Scalar identity operator class. | +| [`SparsePauliOp`](qiskit.quantum_info.SparsePauliOp "qiskit.quantum_info.SparsePauliOp")(data\[, coeffs]) | Sparse N-qubit operator in a Pauli basis representation. | +| [`CNOTDihedral`](qiskit.quantum_info.CNOTDihedral "qiskit.quantum_info.CNOTDihedral")(\[data, num\_qubits, validate]) | An N-qubit operator from the CNOT-Dihedral group. | +| [`PauliList`](qiskit.quantum_info.PauliList "qiskit.quantum_info.PauliList")(data) | List of N-qubit Pauli operators. | +| [`PauliTable`](qiskit.quantum_info.PauliTable "qiskit.quantum_info.PauliTable")(data) | Symplectic representation of a list Pauli matrices. | +| [`StabilizerTable`](qiskit.quantum_info.StabilizerTable "qiskit.quantum_info.StabilizerTable")(data\[, phase]) | Symplectic representation of a list Stabilizer matrices. | +| [`pauli_basis`](qiskit.quantum_info.pauli_basis "qiskit.quantum_info.pauli_basis")(num\_qubits\[, weight]) | Return the ordered PauliTable for the n-qubit Pauli basis. | +| [`pauli_group`](qiskit.quantum_info.pauli_group "qiskit.quantum_info.pauli_group")(number\_of\_qubits\[, case]) | DEPRECATED: Return the Pauli group with 4^n elements. | ## States -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | -| [`Statevector`](qiskit.quantum_info.Statevector#qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")(data\[, dims]) | Statevector class | -| [`DensityMatrix`](qiskit.quantum_info.DensityMatrix#qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")(data\[, dims]) | DensityMatrix class | -| [`StabilizerState`](qiskit.quantum_info.StabilizerState#qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState")(data\[, validate]) | StabilizerState class. | +| | | +| ----------------------------------------------------------------------------------------------------------------- | ---------------------- | +| [`Statevector`](qiskit.quantum_info.Statevector "qiskit.quantum_info.Statevector")(data\[, dims]) | Statevector class | +| [`DensityMatrix`](qiskit.quantum_info.DensityMatrix "qiskit.quantum_info.DensityMatrix")(data\[, dims]) | DensityMatrix class | +| [`StabilizerState`](qiskit.quantum_info.StabilizerState "qiskit.quantum_info.StabilizerState")(data\[, validate]) | StabilizerState class. | ## Channels -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------- | -| [`Choi`](qiskit.quantum_info.Choi#qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")(data\[, input\_dims, output\_dims]) | Choi-matrix representation of a Quantum Channel. | -| [`SuperOp`](qiskit.quantum_info.SuperOp#qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")(data\[, input\_dims, output\_dims]) | Superoperator representation of a quantum channel. | -| [`Kraus`](qiskit.quantum_info.Kraus#qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")(data\[, input\_dims, output\_dims]) | Kraus representation of a quantum channel. | -| [`Stinespring`](qiskit.quantum_info.Stinespring#qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")(data\[, input\_dims, output\_dims]) | Stinespring representation of a quantum channel. | -| [`Chi`](qiskit.quantum_info.Chi#qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")(data\[, input\_dims, output\_dims]) | Pauli basis Chi-matrix representation of a quantum channel. | -| [`PTM`](qiskit.quantum_info.PTM#qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")(data\[, input\_dims, output\_dims]) | Pauli Transfer Matrix (PTM) representation of a Quantum Channel. | +| | | +| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| [`Choi`](qiskit.quantum_info.Choi "qiskit.quantum_info.Choi")(data\[, input\_dims, output\_dims]) | Choi-matrix representation of a Quantum Channel. | +| [`SuperOp`](qiskit.quantum_info.SuperOp "qiskit.quantum_info.SuperOp")(data\[, input\_dims, output\_dims]) | Superoperator representation of a quantum channel. | +| [`Kraus`](qiskit.quantum_info.Kraus "qiskit.quantum_info.Kraus")(data\[, input\_dims, output\_dims]) | Kraus representation of a quantum channel. | +| [`Stinespring`](qiskit.quantum_info.Stinespring "qiskit.quantum_info.Stinespring")(data\[, input\_dims, output\_dims]) | Stinespring representation of a quantum channel. | +| [`Chi`](qiskit.quantum_info.Chi "qiskit.quantum_info.Chi")(data\[, input\_dims, output\_dims]) | Pauli basis Chi-matrix representation of a quantum channel. | +| [`PTM`](qiskit.quantum_info.PTM "qiskit.quantum_info.PTM")(data\[, input\_dims, output\_dims]) | Pauli Transfer Matrix (PTM) representation of a Quantum Channel. | ## Measures -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`average_gate_fidelity`](qiskit.quantum_info.average_gate_fidelity#qiskit.quantum_info.average_gate_fidelity "qiskit.quantum_info.average_gate_fidelity")(channel\[, target, …]) | Return the average gate fidelity of a noisy quantum channel. | -| [`process_fidelity`](qiskit.quantum_info.process_fidelity#qiskit.quantum_info.process_fidelity "qiskit.quantum_info.process_fidelity")(channel\[, target, …]) | Return the process fidelity of a noisy quantum channel. | -| [`gate_error`](qiskit.quantum_info.gate_error#qiskit.quantum_info.gate_error "qiskit.quantum_info.gate_error")(channel\[, target, require\_cp, …]) | Return the gate error of a noisy quantum channel. | -| [`diamond_norm`](qiskit.quantum_info.diamond_norm#qiskit.quantum_info.diamond_norm "qiskit.quantum_info.diamond_norm")(choi, \*\*kwargs) | Return the diamond norm of the input quantum channel object. | -| [`state_fidelity`](qiskit.quantum_info.state_fidelity#qiskit.quantum_info.state_fidelity "qiskit.quantum_info.state_fidelity")(state1, state2\[, validate]) | Return the state fidelity between two quantum states. | -| [`purity`](qiskit.quantum_info.purity#qiskit.quantum_info.purity "qiskit.quantum_info.purity")(state\[, validate]) | Calculate the purity of a quantum state. | -| [`concurrence`](qiskit.quantum_info.concurrence#qiskit.quantum_info.concurrence "qiskit.quantum_info.concurrence")(state) | Calculate the concurrence of a quantum state. | -| [`entropy`](qiskit.quantum_info.entropy#qiskit.quantum_info.entropy "qiskit.quantum_info.entropy")(state\[, base]) | Calculate the von-Neumann entropy of a quantum state. | -| [`entanglement_of_formation`](qiskit.quantum_info.entanglement_of_formation#qiskit.quantum_info.entanglement_of_formation "qiskit.quantum_info.entanglement_of_formation")(state) | Calculate the entanglement of formation of quantum state. | -| [`mutual_information`](qiskit.quantum_info.mutual_information#qiskit.quantum_info.mutual_information "qiskit.quantum_info.mutual_information")(state\[, base]) | Calculate the mutual information of a bipartite state. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [`average_gate_fidelity`](qiskit.quantum_info.average_gate_fidelity "qiskit.quantum_info.average_gate_fidelity")(channel\[, target, …]) | Return the average gate fidelity of a noisy quantum channel. | +| [`process_fidelity`](qiskit.quantum_info.process_fidelity "qiskit.quantum_info.process_fidelity")(channel\[, target, …]) | Return the process fidelity of a noisy quantum channel. | +| [`gate_error`](qiskit.quantum_info.gate_error "qiskit.quantum_info.gate_error")(channel\[, target, require\_cp, …]) | Return the gate error of a noisy quantum channel. | +| [`diamond_norm`](qiskit.quantum_info.diamond_norm "qiskit.quantum_info.diamond_norm")(choi, \*\*kwargs) | Return the diamond norm of the input quantum channel object. | +| [`state_fidelity`](qiskit.quantum_info.state_fidelity "qiskit.quantum_info.state_fidelity")(state1, state2\[, validate]) | Return the state fidelity between two quantum states. | +| [`purity`](qiskit.quantum_info.purity "qiskit.quantum_info.purity")(state\[, validate]) | Calculate the purity of a quantum state. | +| [`concurrence`](qiskit.quantum_info.concurrence "qiskit.quantum_info.concurrence")(state) | Calculate the concurrence of a quantum state. | +| [`entropy`](qiskit.quantum_info.entropy "qiskit.quantum_info.entropy")(state\[, base]) | Calculate the von-Neumann entropy of a quantum state. | +| [`entanglement_of_formation`](qiskit.quantum_info.entanglement_of_formation "qiskit.quantum_info.entanglement_of_formation")(state) | Calculate the entanglement of formation of quantum state. | +| [`mutual_information`](qiskit.quantum_info.mutual_information "qiskit.quantum_info.mutual_information")(state\[, base]) | Calculate the mutual information of a bipartite state. | ## Utility Functions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`partial_trace`](qiskit.quantum_info.partial_trace#qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace")(state, qargs) | Return reduced density matrix by tracing out part of quantum state. | -| [`shannon_entropy`](qiskit.quantum_info.shannon_entropy#qiskit.quantum_info.shannon_entropy "qiskit.quantum_info.shannon_entropy")(pvec\[, base]) | Compute the Shannon entropy of a probability vector. | +| | | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`partial_trace`](qiskit.quantum_info.partial_trace "qiskit.quantum_info.partial_trace")(state, qargs) | Return reduced density matrix by tracing out part of quantum state. | +| [`shannon_entropy`](qiskit.quantum_info.shannon_entropy "qiskit.quantum_info.shannon_entropy")(pvec\[, base]) | Compute the Shannon entropy of a probability vector. | ## Random -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`random_statevector`](qiskit.quantum_info.random_statevector#qiskit.quantum_info.random_statevector "qiskit.quantum_info.random_statevector")(dims\[, seed]) | Generator a random Statevector. | -| [`random_density_matrix`](qiskit.quantum_info.random_density_matrix#qiskit.quantum_info.random_density_matrix "qiskit.quantum_info.random_density_matrix")(dims\[, rank, method, seed]) | Generator a random DensityMatrix. | -| [`random_unitary`](qiskit.quantum_info.random_unitary#qiskit.quantum_info.random_unitary "qiskit.quantum_info.random_unitary")(dims\[, seed]) | Return a random unitary Operator. | -| [`random_hermitian`](qiskit.quantum_info.random_hermitian#qiskit.quantum_info.random_hermitian "qiskit.quantum_info.random_hermitian")(dims\[, traceless, seed]) | Return a random hermitian Operator. | -| [`random_pauli`](qiskit.quantum_info.random_pauli#qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli")(num\_qubits\[, group\_phase, seed]) | Return a random Pauli. | -| [`random_clifford`](qiskit.quantum_info.random_clifford#qiskit.quantum_info.random_clifford "qiskit.quantum_info.random_clifford")(num\_qubits\[, seed]) | Return a random Clifford operator. | -| [`random_quantum_channel`](qiskit.quantum_info.random_quantum_channel#qiskit.quantum_info.random_quantum_channel "qiskit.quantum_info.random_quantum_channel")(\[input\_dims, …]) | Return a random CPTP quantum channel. | -| [`random_cnotdihedral`](qiskit.quantum_info.random_cnotdihedral#qiskit.quantum_info.random_cnotdihedral "qiskit.quantum_info.random_cnotdihedral")(num\_qubits\[, seed]) | Return a random CNOTDihedral element. | -| [`random_pauli_table`](qiskit.quantum_info.random_pauli_table#qiskit.quantum_info.random_pauli_table "qiskit.quantum_info.random_pauli_table")(num\_qubits\[, size, seed]) | Return a random PauliTable. | -| [`random_stabilizer_table`](qiskit.quantum_info.random_stabilizer_table#qiskit.quantum_info.random_stabilizer_table "qiskit.quantum_info.random_stabilizer_table")(num\_qubits\[, size, seed]) | Return a random StabilizerTable. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| [`random_statevector`](qiskit.quantum_info.random_statevector "qiskit.quantum_info.random_statevector")(dims\[, seed]) | Generator a random Statevector. | +| [`random_density_matrix`](qiskit.quantum_info.random_density_matrix "qiskit.quantum_info.random_density_matrix")(dims\[, rank, method, seed]) | Generator a random DensityMatrix. | +| [`random_unitary`](qiskit.quantum_info.random_unitary "qiskit.quantum_info.random_unitary")(dims\[, seed]) | Return a random unitary Operator. | +| [`random_hermitian`](qiskit.quantum_info.random_hermitian "qiskit.quantum_info.random_hermitian")(dims\[, traceless, seed]) | Return a random hermitian Operator. | +| [`random_pauli`](qiskit.quantum_info.random_pauli "qiskit.quantum_info.random_pauli")(num\_qubits\[, group\_phase, seed]) | Return a random Pauli. | +| [`random_clifford`](qiskit.quantum_info.random_clifford "qiskit.quantum_info.random_clifford")(num\_qubits\[, seed]) | Return a random Clifford operator. | +| [`random_quantum_channel`](qiskit.quantum_info.random_quantum_channel "qiskit.quantum_info.random_quantum_channel")(\[input\_dims, …]) | Return a random CPTP quantum channel. | +| [`random_cnotdihedral`](qiskit.quantum_info.random_cnotdihedral "qiskit.quantum_info.random_cnotdihedral")(num\_qubits\[, seed]) | Return a random CNOTDihedral element. | +| [`random_pauli_table`](qiskit.quantum_info.random_pauli_table "qiskit.quantum_info.random_pauli_table")(num\_qubits\[, size, seed]) | Return a random PauliTable. | +| [`random_stabilizer_table`](qiskit.quantum_info.random_stabilizer_table "qiskit.quantum_info.random_stabilizer_table")(num\_qubits\[, size, seed]) | Return a random StabilizerTable. | ## Analysis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`hellinger_distance`](qiskit.quantum_info.hellinger_distance#qiskit.quantum_info.hellinger_distance "qiskit.quantum_info.hellinger_distance")(dist\_p, dist\_q) | Computes the Hellinger distance between two counts distributions. | -| [`hellinger_fidelity`](qiskit.quantum_info.hellinger_fidelity#qiskit.quantum_info.hellinger_fidelity "qiskit.quantum_info.hellinger_fidelity")(dist\_p, dist\_q) | Computes the Hellinger fidelity between two counts distributions. | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| [`hellinger_distance`](qiskit.quantum_info.hellinger_distance "qiskit.quantum_info.hellinger_distance")(dist\_p, dist\_q) | Computes the Hellinger distance between two counts distributions. | +| [`hellinger_fidelity`](qiskit.quantum_info.hellinger_fidelity "qiskit.quantum_info.hellinger_fidelity")(dist\_p, dist\_q) | Computes the Hellinger fidelity between two counts distributions. | ## Synthesis -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer#qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer#qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion#qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford#qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.32/result.md b/docs/api/qiskit/0.32/result.md index 862d98dd199..4d2c6c18b44 100644 --- a/docs/api/qiskit/0.32/result.md +++ b/docs/api/qiskit/0.32/result.md @@ -16,17 +16,17 @@ python_api_name: qiskit.result `qiskit.result` -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- | -| [`Result`](qiskit.result.Result#qiskit.result.Result "qiskit.result.Result")(backend\_name, backend\_version, …\[, …]) | Model for Results. | -| [`ResultError`](qiskit.result.ResultError#qiskit.result.ResultError "qiskit.result.ResultError")(error) | Exceptions raised due to errors in result output. | -| [`Counts`](qiskit.result.Counts#qiskit.result.Counts "qiskit.result.Counts")(data\[, time\_taken, creg\_sizes, …]) | A class to store a counts result from a circuit execution. | -| [`marginal_counts`](qiskit.result.marginal_counts#qiskit.result.marginal_counts "qiskit.result.marginal_counts")(result\[, indices, inplace, …]) | Marginalize counts from an experiment over some indices of interest. | +| | | +| ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------- | +| [`Result`](qiskit.result.Result "qiskit.result.Result")(backend\_name, backend\_version, …\[, …]) | Model for Results. | +| [`ResultError`](qiskit.result.ResultError "qiskit.result.ResultError")(error) | Exceptions raised due to errors in result output. | +| [`Counts`](qiskit.result.Counts "qiskit.result.Counts")(data\[, time\_taken, creg\_sizes, …]) | A class to store a counts result from a circuit execution. | +| [`marginal_counts`](qiskit.result.marginal_counts "qiskit.result.marginal_counts")(result\[, indices, inplace, …]) | Marginalize counts from an experiment over some indices of interest. | ## Distributions -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| [`ProbDistribution`](qiskit.result.ProbDistribution#qiskit.result.ProbDistribution "qiskit.result.ProbDistribution")(data\[, shots]) | A generic dict-like class for probability distributions. | -| [`QuasiDistribution`](qiskit.result.QuasiDistribution#qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution")(data\[, shots]) | A dict-like class for representing qasi-probabilities. | +| | | +| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| [`ProbDistribution`](qiskit.result.ProbDistribution "qiskit.result.ProbDistribution")(data\[, shots]) | A generic dict-like class for probability distributions. | +| [`QuasiDistribution`](qiskit.result.QuasiDistribution "qiskit.result.QuasiDistribution")(data\[, shots]) | A dict-like class for representing qasi-probabilities. | diff --git a/docs/api/qiskit/0.32/scheduler.md b/docs/api/qiskit/0.32/scheduler.md index 00ffc28179c..643fc7490e4 100644 --- a/docs/api/qiskit/0.32/scheduler.md +++ b/docs/api/qiskit/0.32/scheduler.md @@ -18,10 +18,10 @@ python_api_name: qiskit.scheduler A circuit scheduler compiles a circuit program to a pulse program. -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | -| [`schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit") | QuantumCircuit to Pulse scheduler. | -| [`ScheduleConfig`](qiskit.scheduler.ScheduleConfig#qiskit.scheduler.ScheduleConfig "qiskit.scheduler.ScheduleConfig")(inst\_map, meas\_map, dt) | Configuration for pulse scheduling. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | +| [`schedule_circuit`](qiskit.scheduler.schedule_circuit#module-qiskit.scheduler.schedule_circuit "qiskit.scheduler.schedule_circuit") | QuantumCircuit to Pulse scheduler. | +| [`ScheduleConfig`](qiskit.scheduler.ScheduleConfig "qiskit.scheduler.ScheduleConfig")(inst\_map, meas\_map, dt) | Configuration for pulse scheduling. | diff --git a/docs/api/qiskit/0.32/tools.md b/docs/api/qiskit/0.32/tools.md index ef02c01746c..b2e1f1a0edc 100644 --- a/docs/api/qiskit/0.32/tools.md +++ b/docs/api/qiskit/0.32/tools.md @@ -16,15 +16,15 @@ python_api_name: qiskit.tools ## Parallel Routines -| | | -| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| [`parallel_map`](qiskit.tools.parallel_map#qiskit.tools.parallel_map "qiskit.tools.parallel_map")(task, values\[, task\_args, …]) | Parallel execution of a mapping of values to the function task. This is functionally equivalent to::. | +| | | +| ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| [`parallel_map`](qiskit.tools.parallel_map "qiskit.tools.parallel_map")(task, values\[, task\_args, …]) | Parallel execution of a mapping of values to the function task. This is functionally equivalent to::. | ## Monitoring -| | | -| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| [`job_monitor`](qiskit.tools.job_monitor#qiskit.tools.job_monitor "qiskit.tools.job_monitor")(job\[, interval, quiet, output, …]) | Monitor the status of a IBMQJob instance. | -| [`backend_monitor`](qiskit.tools.backend_monitor#qiskit.tools.backend_monitor "qiskit.tools.backend_monitor")(backend) | Monitor a single IBMQ backend. | -| [`backend_overview`](qiskit.tools.backend_overview#qiskit.tools.backend_overview "qiskit.tools.backend_overview")() | Gives overview information on all the IBMQ backends that are available. | +| | | +| -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| [`job_monitor`](qiskit.tools.job_monitor "qiskit.tools.job_monitor")(job\[, interval, quiet, output, …]) | Monitor the status of a IBMQJob instance. | +| [`backend_monitor`](qiskit.tools.backend_monitor "qiskit.tools.backend_monitor")(backend) | Monitor a single IBMQ backend. | +| [`backend_overview`](qiskit.tools.backend_overview "qiskit.tools.backend_overview")() | Gives overview information on all the IBMQ backends that are available. | diff --git a/docs/api/qiskit/0.32/transpiler.md b/docs/api/qiskit/0.32/transpiler.md index 9268b995696..346acc7d191 100644 --- a/docs/api/qiskit/0.32/transpiler.md +++ b/docs/api/qiskit/0.32/transpiler.md @@ -122,7 +122,7 @@ The choice of initial layout is extremely important when: The choice of initial\_layout can mean the difference between getting a result, and getting nothing but noise. -Lets see what layouts are automatically picked at various optimization levels. The modified circuits returned by [`qiskit.compiler.transpile()`](qiskit.compiler.transpile#qiskit.compiler.transpile "qiskit.compiler.transpile") have this initial layout information in them, and we can view this layout selection graphically using [`qiskit.visualization.plot_circuit_layout()`](qiskit.visualization.plot_circuit_layout#qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout"): +Lets see what layouts are automatically picked at various optimization levels. The modified circuits returned by [`qiskit.compiler.transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") have this initial layout information in them, and we can view this layout selection graphically using [`qiskit.visualization.plot_circuit_layout()`](qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout"): ```python from qiskit import QuantumCircuit, transpile @@ -158,7 +158,7 @@ ghz.draw(output='mpl') > > ![../\_images/transpiler\_9\_0.png](/images/api/qiskit/0.32/transpiler_9_0.png) -It is completely possible to specify your own initial layout. To do so we can pass a list of integers to [`qiskit.compiler.transpile()`](qiskit.compiler.transpile#qiskit.compiler.transpile "qiskit.compiler.transpile") via the initial\_layout keyword argument, where the index labels the virtual qubit in the circuit and the corresponding value is the label for the physical qubit to map onto: +It is completely possible to specify your own initial layout. To do so we can pass a list of integers to [`qiskit.compiler.transpile()`](qiskit.compiler.transpile "qiskit.compiler.transpile") via the initial\_layout keyword argument, where the index labels the virtual qubit in the circuit and the corresponding value is the label for the physical qubit to map onto: ```python # Virtual -> physical @@ -265,44 +265,44 @@ Gate counts: OrderedDict([('cx', 9), ('u3', 6), ('u2', 4), ('u1', 1)]) ### Pass Manager Construction -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -| [`PassManager`](qiskit.transpiler.PassManager#qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")(\[passes, max\_iteration]) | Manager for a set of Passes and their scheduling during transpilation. | -| [`PassManagerConfig`](qiskit.transpiler.PassManagerConfig#qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig")(\[initial\_layout, …]) | Pass Manager Configuration. | -| [`PropertySet`](qiskit.transpiler.PropertySet#qiskit.transpiler.PropertySet "qiskit.transpiler.PropertySet") | A default dictionary-like object | -| [`FlowController`](qiskit.transpiler.FlowController#qiskit.transpiler.FlowController "qiskit.transpiler.FlowController")(passes, options, …) | Base class for multiple types of working list. | +| | | +| ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | +| [`PassManager`](qiskit.transpiler.PassManager "qiskit.transpiler.PassManager")(\[passes, max\_iteration]) | Manager for a set of Passes and their scheduling during transpilation. | +| [`PassManagerConfig`](qiskit.transpiler.PassManagerConfig "qiskit.transpiler.PassManagerConfig")(\[initial\_layout, …]) | Pass Manager Configuration. | +| [`PropertySet`](qiskit.transpiler.PropertySet "qiskit.transpiler.PropertySet") | A default dictionary-like object | +| [`FlowController`](qiskit.transpiler.FlowController "qiskit.transpiler.FlowController")(passes, options, …) | Base class for multiple types of working list. | ### Layout and Topology -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | -| [`Layout`](qiskit.transpiler.Layout#qiskit.transpiler.Layout "qiskit.transpiler.Layout")(\[input\_dict]) | Two-ways dict to represent a Layout. | -| [`CouplingMap`](qiskit.transpiler.CouplingMap#qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")(\[couplinglist, description]) | Directed graph specifying fixed coupling. | +| | | +| ------------------------------------------------------------------------------------------------------------ | ----------------------------------------- | +| [`Layout`](qiskit.transpiler.Layout "qiskit.transpiler.Layout")(\[input\_dict]) | Two-ways dict to represent a Layout. | +| [`CouplingMap`](qiskit.transpiler.CouplingMap "qiskit.transpiler.CouplingMap")(\[couplinglist, description]) | Directed graph specifying fixed coupling. | ### Scheduling -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [`InstructionDurations`](qiskit.transpiler.InstructionDurations#qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")(\[instruction\_durations, dt]) | Helper class to provide durations of instructions for scheduling. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| [`InstructionDurations`](qiskit.transpiler.InstructionDurations "qiskit.transpiler.InstructionDurations")(\[instruction\_durations, dt]) | Helper class to provide durations of instructions for scheduling. | ### Fenced Objects -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`FencedDAGCircuit`](qiskit.transpiler.FencedDAGCircuit#qiskit.transpiler.FencedDAGCircuit "qiskit.transpiler.FencedDAGCircuit")(dag\_circuit\_instance) | A dag circuit that cannot be modified (via remove\_op\_node) | -| [`FencedPropertySet`](qiskit.transpiler.FencedPropertySet#qiskit.transpiler.FencedPropertySet "qiskit.transpiler.FencedPropertySet")(property\_set\_instance) | A property set that cannot be written (via \_\_setitem\_\_) | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [`FencedDAGCircuit`](qiskit.transpiler.FencedDAGCircuit "qiskit.transpiler.FencedDAGCircuit")(dag\_circuit\_instance) | A dag circuit that cannot be modified (via remove\_op\_node) | +| [`FencedPropertySet`](qiskit.transpiler.FencedPropertySet "qiskit.transpiler.FencedPropertySet")(property\_set\_instance) | A property set that cannot be written (via \_\_setitem\_\_) | ### Abstract Passes -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------- | -| [`TransformationPass`](qiskit.transpiler.TransformationPass#qiskit.transpiler.TransformationPass "qiskit.transpiler.TransformationPass")(\*args, \*\*kwargs) | A transformation pass: change DAG, not property set. | -| [`AnalysisPass`](qiskit.transpiler.AnalysisPass#qiskit.transpiler.AnalysisPass "qiskit.transpiler.AnalysisPass")(\*args, \*\*kwargs) | An analysis pass: change property set, not DAG. | +| | | +| ----------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | +| [`TransformationPass`](qiskit.transpiler.TransformationPass "qiskit.transpiler.TransformationPass")(\*args, \*\*kwargs) | A transformation pass: change DAG, not property set. | +| [`AnalysisPass`](qiskit.transpiler.AnalysisPass "qiskit.transpiler.AnalysisPass")(\*args, \*\*kwargs) | An analysis pass: change property set, not DAG. | ### Exceptions -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | -| [`TranspilerError`](qiskit.transpiler.TranspilerError#qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError")(\*message) | Exceptions raised during transpilation. | -| [`TranspilerAccessError`](qiskit.transpiler.TranspilerAccessError#qiskit.transpiler.TranspilerAccessError "qiskit.transpiler.TranspilerAccessError")(\*message) | DEPRECATED: Exception of access error in the transpiler passes. | +| | | +| ----------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| [`TranspilerError`](qiskit.transpiler.TranspilerError "qiskit.transpiler.TranspilerError")(\*message) | Exceptions raised during transpilation. | +| [`TranspilerAccessError`](qiskit.transpiler.TranspilerAccessError "qiskit.transpiler.TranspilerAccessError")(\*message) | DEPRECATED: Exception of access error in the transpiler passes. | diff --git a/docs/api/qiskit/0.32/transpiler_passes.md b/docs/api/qiskit/0.32/transpiler_passes.md index 04f40203f18..74d0820ace9 100644 --- a/docs/api/qiskit/0.32/transpiler_passes.md +++ b/docs/api/qiskit/0.32/transpiler_passes.md @@ -18,99 +18,99 @@ python_api_name: qiskit.transpiler.passes ## Layout Selection (Placement) -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| [`SetLayout`](qiskit.transpiler.passes.SetLayout#qiskit.transpiler.passes.SetLayout "qiskit.transpiler.passes.SetLayout")(\*args, \*\*kwargs) | Set the `layout` property to the given layout. | -| [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout#qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout")(\*args, \*\*kwargs) | Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. | -| [`DenseLayout`](qiskit.transpiler.passes.DenseLayout#qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout")(\*args, \*\*kwargs) | Choose a Layout by finding the most connected subset of qubits. | -| [`NoiseAdaptiveLayout`](qiskit.transpiler.passes.NoiseAdaptiveLayout#qiskit.transpiler.passes.NoiseAdaptiveLayout "qiskit.transpiler.passes.NoiseAdaptiveLayout")(\*args, \*\*kwargs) | Choose a noise-adaptive Layout based on current calibration data for the backend. | -| [`SabreLayout`](qiskit.transpiler.passes.SabreLayout#qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout")(\*args, \*\*kwargs) | Choose a Layout via iterative bidirectional routing of the input circuit. | -| [`CSPLayout`](qiskit.transpiler.passes.CSPLayout#qiskit.transpiler.passes.CSPLayout "qiskit.transpiler.passes.CSPLayout")(\*args, \*\*kwargs) | If possible, chooses a Layout as a CSP, using backtracking. | -| [`ApplyLayout`](qiskit.transpiler.passes.ApplyLayout#qiskit.transpiler.passes.ApplyLayout "qiskit.transpiler.passes.ApplyLayout")(\*args, \*\*kwargs) | Transform a circuit with virtual qubits into a circuit with physical qubits. | -| [`Layout2qDistance`](qiskit.transpiler.passes.Layout2qDistance#qiskit.transpiler.passes.Layout2qDistance "qiskit.transpiler.passes.Layout2qDistance")(\*args, \*\*kwargs) | Evaluate how good the layout selection was. | -| [`EnlargeWithAncilla`](qiskit.transpiler.passes.EnlargeWithAncilla#qiskit.transpiler.passes.EnlargeWithAncilla "qiskit.transpiler.passes.EnlargeWithAncilla")(\*args, \*\*kwargs) | Extend the dag with virtual qubits that are in layout but not in the circuit yet. | -| [`FullAncillaAllocation`](qiskit.transpiler.passes.FullAncillaAllocation#qiskit.transpiler.passes.FullAncillaAllocation "qiskit.transpiler.passes.FullAncillaAllocation")(\*args, \*\*kwargs) | Allocate all idle nodes from the coupling map as ancilla on the layout. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| [`SetLayout`](qiskit.transpiler.passes.SetLayout "qiskit.transpiler.passes.SetLayout")(\*args, \*\*kwargs) | Set the `layout` property to the given layout. | +| [`TrivialLayout`](qiskit.transpiler.passes.TrivialLayout "qiskit.transpiler.passes.TrivialLayout")(\*args, \*\*kwargs) | Choose a Layout by assigning `n` circuit qubits to device qubits `0, .., n-1`. | +| [`DenseLayout`](qiskit.transpiler.passes.DenseLayout "qiskit.transpiler.passes.DenseLayout")(\*args, \*\*kwargs) | Choose a Layout by finding the most connected subset of qubits. | +| [`NoiseAdaptiveLayout`](qiskit.transpiler.passes.NoiseAdaptiveLayout "qiskit.transpiler.passes.NoiseAdaptiveLayout")(\*args, \*\*kwargs) | Choose a noise-adaptive Layout based on current calibration data for the backend. | +| [`SabreLayout`](qiskit.transpiler.passes.SabreLayout "qiskit.transpiler.passes.SabreLayout")(\*args, \*\*kwargs) | Choose a Layout via iterative bidirectional routing of the input circuit. | +| [`CSPLayout`](qiskit.transpiler.passes.CSPLayout "qiskit.transpiler.passes.CSPLayout")(\*args, \*\*kwargs) | If possible, chooses a Layout as a CSP, using backtracking. | +| [`ApplyLayout`](qiskit.transpiler.passes.ApplyLayout "qiskit.transpiler.passes.ApplyLayout")(\*args, \*\*kwargs) | Transform a circuit with virtual qubits into a circuit with physical qubits. | +| [`Layout2qDistance`](qiskit.transpiler.passes.Layout2qDistance "qiskit.transpiler.passes.Layout2qDistance")(\*args, \*\*kwargs) | Evaluate how good the layout selection was. | +| [`EnlargeWithAncilla`](qiskit.transpiler.passes.EnlargeWithAncilla "qiskit.transpiler.passes.EnlargeWithAncilla")(\*args, \*\*kwargs) | Extend the dag with virtual qubits that are in layout but not in the circuit yet. | +| [`FullAncillaAllocation`](qiskit.transpiler.passes.FullAncillaAllocation "qiskit.transpiler.passes.FullAncillaAllocation")(\*args, \*\*kwargs) | Allocate all idle nodes from the coupling map as ancilla on the layout. | ## Routing -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| [`BasicSwap`](qiskit.transpiler.passes.BasicSwap#qiskit.transpiler.passes.BasicSwap "qiskit.transpiler.passes.BasicSwap")(\*args, \*\*kwargs) | Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. | -| [`LookaheadSwap`](qiskit.transpiler.passes.LookaheadSwap#qiskit.transpiler.passes.LookaheadSwap "qiskit.transpiler.passes.LookaheadSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | -| [`StochasticSwap`](qiskit.transpiler.passes.StochasticSwap#qiskit.transpiler.passes.StochasticSwap "qiskit.transpiler.passes.StochasticSwap")(\*args, \*\*kwargs) | Map a DAGCircuit onto a coupling\_map adding swap gates. | -| [`SabreSwap`](qiskit.transpiler.passes.SabreSwap#qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | -| [`BIPMapping`](qiskit.transpiler.passes.BIPMapping#qiskit.transpiler.passes.BIPMapping "qiskit.transpiler.passes.BIPMapping")(\*args, \*\*kwargs) | Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. | +| | | +| ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| [`BasicSwap`](qiskit.transpiler.passes.BasicSwap "qiskit.transpiler.passes.BasicSwap")(\*args, \*\*kwargs) | Map (with minimum effort) a DAGCircuit onto a coupling\_map adding swap gates. | +| [`LookaheadSwap`](qiskit.transpiler.passes.LookaheadSwap "qiskit.transpiler.passes.LookaheadSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | +| [`StochasticSwap`](qiskit.transpiler.passes.StochasticSwap "qiskit.transpiler.passes.StochasticSwap")(\*args, \*\*kwargs) | Map a DAGCircuit onto a coupling\_map adding swap gates. | +| [`SabreSwap`](qiskit.transpiler.passes.SabreSwap "qiskit.transpiler.passes.SabreSwap")(\*args, \*\*kwargs) | Map input circuit onto a backend topology via insertion of SWAPs. | +| [`BIPMapping`](qiskit.transpiler.passes.BIPMapping "qiskit.transpiler.passes.BIPMapping")(\*args, \*\*kwargs) | Map a DAGCircuit onto a given `coupling_map`, allocating qubits and adding swap gates. | ## Basis Change -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| [`Unroller`](qiskit.transpiler.passes.Unroller#qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller")(\*args, \*\*kwargs) | Unroll a circuit to a given basis. | -| [`Unroll3qOrMore`](qiskit.transpiler.passes.Unroll3qOrMore#qiskit.transpiler.passes.Unroll3qOrMore "qiskit.transpiler.passes.Unroll3qOrMore")(\*args, \*\*kwargs) | Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. | -| [`Decompose`](qiskit.transpiler.passes.Decompose#qiskit.transpiler.passes.Decompose "qiskit.transpiler.passes.Decompose")(\[gate]) | Expand a gate in a circuit using its decomposition rules. | -| [`UnrollCustomDefinitions`](qiskit.transpiler.passes.UnrollCustomDefinitions#qiskit.transpiler.passes.UnrollCustomDefinitions "qiskit.transpiler.passes.UnrollCustomDefinitions")(\*args, \*\*kwargs) | Unrolls instructions with custom definitions. | -| [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator#qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator")(\*args, \*\*kwargs) | Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| [`Unroller`](qiskit.transpiler.passes.Unroller "qiskit.transpiler.passes.Unroller")(\*args, \*\*kwargs) | Unroll a circuit to a given basis. | +| [`Unroll3qOrMore`](qiskit.transpiler.passes.Unroll3qOrMore "qiskit.transpiler.passes.Unroll3qOrMore")(\*args, \*\*kwargs) | Recursively expands 3q+ gates until the circuit only contains 2q or 1q gates. | +| [`Decompose`](qiskit.transpiler.passes.Decompose "qiskit.transpiler.passes.Decompose")(\[gate]) | Expand a gate in a circuit using its decomposition rules. | +| [`UnrollCustomDefinitions`](qiskit.transpiler.passes.UnrollCustomDefinitions "qiskit.transpiler.passes.UnrollCustomDefinitions")(\*args, \*\*kwargs) | Unrolls instructions with custom definitions. | +| [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator")(\*args, \*\*kwargs) | Translates gates to a target basis by searching for a set of translations from a given EquivalenceLibrary. | ## Optimizations -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -| [`Optimize1qGates`](qiskit.transpiler.passes.Optimize1qGates#qiskit.transpiler.passes.Optimize1qGates "qiskit.transpiler.passes.Optimize1qGates")(\*args, \*\*kwargs) | Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. | -| [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition#qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition")(\*args, \*\*kwargs) | Optimize chains of single-qubit gates by combining them into a single gate. | -| [`Collect2qBlocks`](qiskit.transpiler.passes.Collect2qBlocks#qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks")(\*args, \*\*kwargs) | Collect sequences of uninterrupted gates acting on 2 qubits. | -| [`ConsolidateBlocks`](qiskit.transpiler.passes.ConsolidateBlocks#qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks")(\*args, \*\*kwargs) | Replace each block of consecutive gates by a single Unitary node. | -| [`CXCancellation`](qiskit.transpiler.passes.CXCancellation#qiskit.transpiler.passes.CXCancellation "qiskit.transpiler.passes.CXCancellation")(\*args, \*\*kwargs) | Cancel back-to-back cx gates in dag. | -| [`CommutationAnalysis`](qiskit.transpiler.passes.CommutationAnalysis#qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis")(\*args, \*\*kwargs) | Analysis pass to find commutation relations between DAG nodes. | -| [`CommutativeCancellation`](qiskit.transpiler.passes.CommutativeCancellation#qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation")(\*args, \*\*kwargs) | Cancel the redundant (self-adjoint) gates through commutation relations. | -| [`RemoveDiagonalGatesBeforeMeasure`](qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure#qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure")(\*args, \*\*kwargs) | Remove diagonal gates (including diagonal 2Q gates) before a measurement. | -| [`RemoveResetInZeroState`](qiskit.transpiler.passes.RemoveResetInZeroState#qiskit.transpiler.passes.RemoveResetInZeroState "qiskit.transpiler.passes.RemoveResetInZeroState")(\*args, \*\*kwargs) | Remove reset gate when the qubit is in zero state. | -| [`CrosstalkAdaptiveSchedule`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule#qiskit.transpiler.passes.CrosstalkAdaptiveSchedule "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule")(\*args, \*\*kwargs) | Crosstalk mitigation through adaptive instruction scheduling. | -| [`TemplateOptimization`](qiskit.transpiler.passes.TemplateOptimization#qiskit.transpiler.passes.TemplateOptimization "qiskit.transpiler.passes.TemplateOptimization")(\*args, \*\*kwargs) | Class for the template optimization pass. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| [`Optimize1qGates`](qiskit.transpiler.passes.Optimize1qGates "qiskit.transpiler.passes.Optimize1qGates")(\*args, \*\*kwargs) | Optimize chains of single-qubit u1, u2, u3 gates by combining them into a single gate. | +| [`Optimize1qGatesDecomposition`](qiskit.transpiler.passes.Optimize1qGatesDecomposition "qiskit.transpiler.passes.Optimize1qGatesDecomposition")(\*args, \*\*kwargs) | Optimize chains of single-qubit gates by combining them into a single gate. | +| [`Collect2qBlocks`](qiskit.transpiler.passes.Collect2qBlocks "qiskit.transpiler.passes.Collect2qBlocks")(\*args, \*\*kwargs) | Collect sequences of uninterrupted gates acting on 2 qubits. | +| [`ConsolidateBlocks`](qiskit.transpiler.passes.ConsolidateBlocks "qiskit.transpiler.passes.ConsolidateBlocks")(\*args, \*\*kwargs) | Replace each block of consecutive gates by a single Unitary node. | +| [`CXCancellation`](qiskit.transpiler.passes.CXCancellation "qiskit.transpiler.passes.CXCancellation")(\*args, \*\*kwargs) | Cancel back-to-back cx gates in dag. | +| [`CommutationAnalysis`](qiskit.transpiler.passes.CommutationAnalysis "qiskit.transpiler.passes.CommutationAnalysis")(\*args, \*\*kwargs) | Analysis pass to find commutation relations between DAG nodes. | +| [`CommutativeCancellation`](qiskit.transpiler.passes.CommutativeCancellation "qiskit.transpiler.passes.CommutativeCancellation")(\*args, \*\*kwargs) | Cancel the redundant (self-adjoint) gates through commutation relations. | +| [`RemoveDiagonalGatesBeforeMeasure`](qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure "qiskit.transpiler.passes.RemoveDiagonalGatesBeforeMeasure")(\*args, \*\*kwargs) | Remove diagonal gates (including diagonal 2Q gates) before a measurement. | +| [`RemoveResetInZeroState`](qiskit.transpiler.passes.RemoveResetInZeroState "qiskit.transpiler.passes.RemoveResetInZeroState")(\*args, \*\*kwargs) | Remove reset gate when the qubit is in zero state. | +| [`CrosstalkAdaptiveSchedule`](qiskit.transpiler.passes.CrosstalkAdaptiveSchedule "qiskit.transpiler.passes.CrosstalkAdaptiveSchedule")(\*args, \*\*kwargs) | Crosstalk mitigation through adaptive instruction scheduling. | +| [`TemplateOptimization`](qiskit.transpiler.passes.TemplateOptimization "qiskit.transpiler.passes.TemplateOptimization")(\*args, \*\*kwargs) | Class for the template optimization pass. | ## Scheduling -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| [`TimeUnitConversion`](qiskit.transpiler.passes.TimeUnitConversion#qiskit.transpiler.passes.TimeUnitConversion "qiskit.transpiler.passes.TimeUnitConversion")(inst\_durations) | Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. | -| [`ALAPSchedule`](qiskit.transpiler.passes.ALAPSchedule#qiskit.transpiler.passes.ALAPSchedule "qiskit.transpiler.passes.ALAPSchedule")(\*args, \*\*kwargs) | ALAP Scheduling. | -| [`ASAPSchedule`](qiskit.transpiler.passes.ASAPSchedule#qiskit.transpiler.passes.ASAPSchedule "qiskit.transpiler.passes.ASAPSchedule")(\*args, \*\*kwargs) | ASAP Scheduling. | -| [`DynamicalDecoupling`](qiskit.transpiler.passes.DynamicalDecoupling#qiskit.transpiler.passes.DynamicalDecoupling "qiskit.transpiler.passes.DynamicalDecoupling")(\*args, \*\*kwargs) | Dynamical decoupling insertion pass. | -| [`AlignMeasures`](qiskit.transpiler.passes.AlignMeasures#qiskit.transpiler.passes.AlignMeasures "qiskit.transpiler.passes.AlignMeasures")(\[alignment]) | Measurement alignment. | -| [`ValidatePulseGates`](qiskit.transpiler.passes.ValidatePulseGates#qiskit.transpiler.passes.ValidatePulseGates "qiskit.transpiler.passes.ValidatePulseGates")(\[granularity, min\_length]) | Check custom gate length. | -| [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder#qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.RZXCalibrationBuilder")(backend) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | -| [`RZXCalibrationBuilderNoEcho`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho#qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho")(backend) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| [`TimeUnitConversion`](qiskit.transpiler.passes.TimeUnitConversion "qiskit.transpiler.passes.TimeUnitConversion")(inst\_durations) | Choose a time unit to be used in the following time-aware passes, and make all circuit time units consistent with that. | +| [`ALAPSchedule`](qiskit.transpiler.passes.ALAPSchedule "qiskit.transpiler.passes.ALAPSchedule")(\*args, \*\*kwargs) | ALAP Scheduling. | +| [`ASAPSchedule`](qiskit.transpiler.passes.ASAPSchedule "qiskit.transpiler.passes.ASAPSchedule")(\*args, \*\*kwargs) | ASAP Scheduling. | +| [`DynamicalDecoupling`](qiskit.transpiler.passes.DynamicalDecoupling "qiskit.transpiler.passes.DynamicalDecoupling")(\*args, \*\*kwargs) | Dynamical decoupling insertion pass. | +| [`AlignMeasures`](qiskit.transpiler.passes.AlignMeasures "qiskit.transpiler.passes.AlignMeasures")(\[alignment]) | Measurement alignment. | +| [`ValidatePulseGates`](qiskit.transpiler.passes.ValidatePulseGates "qiskit.transpiler.passes.ValidatePulseGates")(\[granularity, min\_length]) | Check custom gate length. | +| [`RZXCalibrationBuilder`](qiskit.transpiler.passes.RZXCalibrationBuilder "qiskit.transpiler.passes.RZXCalibrationBuilder")(backend) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | +| [`RZXCalibrationBuilderNoEcho`](qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho "qiskit.transpiler.passes.RZXCalibrationBuilderNoEcho")(backend) | Creates calibrations for RZXGate(theta) by stretching and compressing Gaussian square pulses in the CX gate. | ## Circuit Analysis -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | -| [`Width`](qiskit.transpiler.passes.Width#qiskit.transpiler.passes.Width "qiskit.transpiler.passes.Width")(\*args, \*\*kwargs) | Calculate the width of a DAG circuit. | -| [`Depth`](qiskit.transpiler.passes.Depth#qiskit.transpiler.passes.Depth "qiskit.transpiler.passes.Depth")(\*args, \*\*kwargs) | Calculate the depth of a DAG circuit. | -| [`Size`](qiskit.transpiler.passes.Size#qiskit.transpiler.passes.Size "qiskit.transpiler.passes.Size")(\*args, \*\*kwargs) | Calculate the size of a DAG circuit. | -| [`CountOps`](qiskit.transpiler.passes.CountOps#qiskit.transpiler.passes.CountOps "qiskit.transpiler.passes.CountOps")(\*args, \*\*kwargs) | Count the operations in a DAG circuit. | -| [`CountOpsLongestPath`](qiskit.transpiler.passes.CountOpsLongestPath#qiskit.transpiler.passes.CountOpsLongestPath "qiskit.transpiler.passes.CountOpsLongestPath")(\*args, \*\*kwargs) | Count the operations on the longest path in a DAGcircuit. | -| [`NumTensorFactors`](qiskit.transpiler.passes.NumTensorFactors#qiskit.transpiler.passes.NumTensorFactors "qiskit.transpiler.passes.NumTensorFactors")(\*args, \*\*kwargs) | Calculate the number of tensor factors of a DAG circuit. | -| [`DAGLongestPath`](qiskit.transpiler.passes.DAGLongestPath#qiskit.transpiler.passes.DAGLongestPath "qiskit.transpiler.passes.DAGLongestPath")(\*args, \*\*kwargs) | Return the longest path in a DAGcircuit as a list of DAGNodes. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | +| [`Width`](qiskit.transpiler.passes.Width "qiskit.transpiler.passes.Width")(\*args, \*\*kwargs) | Calculate the width of a DAG circuit. | +| [`Depth`](qiskit.transpiler.passes.Depth "qiskit.transpiler.passes.Depth")(\*args, \*\*kwargs) | Calculate the depth of a DAG circuit. | +| [`Size`](qiskit.transpiler.passes.Size "qiskit.transpiler.passes.Size")(\*args, \*\*kwargs) | Calculate the size of a DAG circuit. | +| [`CountOps`](qiskit.transpiler.passes.CountOps "qiskit.transpiler.passes.CountOps")(\*args, \*\*kwargs) | Count the operations in a DAG circuit. | +| [`CountOpsLongestPath`](qiskit.transpiler.passes.CountOpsLongestPath "qiskit.transpiler.passes.CountOpsLongestPath")(\*args, \*\*kwargs) | Count the operations on the longest path in a DAGcircuit. | +| [`NumTensorFactors`](qiskit.transpiler.passes.NumTensorFactors "qiskit.transpiler.passes.NumTensorFactors")(\*args, \*\*kwargs) | Calculate the number of tensor factors of a DAG circuit. | +| [`DAGLongestPath`](qiskit.transpiler.passes.DAGLongestPath "qiskit.transpiler.passes.DAGLongestPath")(\*args, \*\*kwargs) | Return the longest path in a DAGcircuit as a list of DAGNodes. | ## Synthesis -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | -| [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis#qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis")(basis\_gates\[, …]) | Synthesize gates according to their basis gates. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | +| [`UnitarySynthesis`](qiskit.transpiler.passes.UnitarySynthesis "qiskit.transpiler.passes.UnitarySynthesis")(basis\_gates\[, …]) | Synthesize gates according to their basis gates. | ## Additional Passes -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`CheckMap`](qiskit.transpiler.passes.CheckMap#qiskit.transpiler.passes.CheckMap "qiskit.transpiler.passes.CheckMap")(\*args, \*\*kwargs) | Check if a DAG circuit is already mapped to a coupling map. | -| [`CheckCXDirection`](qiskit.transpiler.passes.CheckCXDirection#qiskit.transpiler.passes.CheckCXDirection "qiskit.transpiler.passes.CheckCXDirection")(\*args, \*\*kwargs) | Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection#qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. | -| [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection#qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection")(\*args, \*\*kwargs) | Check if the two-qubit gates follow the right direction with respect to the coupling map. | -| [`CXDirection`](qiskit.transpiler.passes.CXDirection#qiskit.transpiler.passes.CXDirection "qiskit.transpiler.passes.CXDirection")(\*args, \*\*kwargs) | Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection#qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. | -| [`GateDirection`](qiskit.transpiler.passes.GateDirection#qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection")(\*args, \*\*kwargs) | Modify asymmetric gates to match the hardware coupling direction. | -| [`MergeAdjacentBarriers`](qiskit.transpiler.passes.MergeAdjacentBarriers#qiskit.transpiler.passes.MergeAdjacentBarriers "qiskit.transpiler.passes.MergeAdjacentBarriers")(\*args, \*\*kwargs) | Return a circuit with any adjacent barriers merged together. | -| [`RemoveBarriers`](qiskit.transpiler.passes.RemoveBarriers#qiskit.transpiler.passes.RemoveBarriers "qiskit.transpiler.passes.RemoveBarriers")(\*args, \*\*kwargs) | Return a circuit with any barrier removed. | -| [`BarrierBeforeFinalMeasurements`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements#qiskit.transpiler.passes.BarrierBeforeFinalMeasurements "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements")(\*args, \*\*kwargs) | Add a barrier before final measurements. | -| [`RemoveFinalMeasurements`](qiskit.transpiler.passes.RemoveFinalMeasurements#qiskit.transpiler.passes.RemoveFinalMeasurements "qiskit.transpiler.passes.RemoveFinalMeasurements")(\*args, \*\*kwargs) | Remove final measurements and barriers at the end of a circuit. | -| [`DAGFixedPoint`](qiskit.transpiler.passes.DAGFixedPoint#qiskit.transpiler.passes.DAGFixedPoint "qiskit.transpiler.passes.DAGFixedPoint")(\*args, \*\*kwargs) | Check if the DAG has reached a fixed point. | -| [`FixedPoint`](qiskit.transpiler.passes.FixedPoint#qiskit.transpiler.passes.FixedPoint "qiskit.transpiler.passes.FixedPoint")(\*args, \*\*kwargs) | Check if a property reached a fixed point. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [`CheckMap`](qiskit.transpiler.passes.CheckMap "qiskit.transpiler.passes.CheckMap")(\*args, \*\*kwargs) | Check if a DAG circuit is already mapped to a coupling map. | +| [`CheckCXDirection`](qiskit.transpiler.passes.CheckCXDirection "qiskit.transpiler.passes.CheckCXDirection")(\*args, \*\*kwargs) | Deprecated: use [`qiskit.transpiler.passes.CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection") pass instead. | +| [`CheckGateDirection`](qiskit.transpiler.passes.CheckGateDirection "qiskit.transpiler.passes.CheckGateDirection")(\*args, \*\*kwargs) | Check if the two-qubit gates follow the right direction with respect to the coupling map. | +| [`CXDirection`](qiskit.transpiler.passes.CXDirection "qiskit.transpiler.passes.CXDirection")(\*args, \*\*kwargs) | Deprecated: use [`qiskit.transpiler.passes.GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection") pass instead. | +| [`GateDirection`](qiskit.transpiler.passes.GateDirection "qiskit.transpiler.passes.GateDirection")(\*args, \*\*kwargs) | Modify asymmetric gates to match the hardware coupling direction. | +| [`MergeAdjacentBarriers`](qiskit.transpiler.passes.MergeAdjacentBarriers "qiskit.transpiler.passes.MergeAdjacentBarriers")(\*args, \*\*kwargs) | Return a circuit with any adjacent barriers merged together. | +| [`RemoveBarriers`](qiskit.transpiler.passes.RemoveBarriers "qiskit.transpiler.passes.RemoveBarriers")(\*args, \*\*kwargs) | Return a circuit with any barrier removed. | +| [`BarrierBeforeFinalMeasurements`](qiskit.transpiler.passes.BarrierBeforeFinalMeasurements "qiskit.transpiler.passes.BarrierBeforeFinalMeasurements")(\*args, \*\*kwargs) | Add a barrier before final measurements. | +| [`RemoveFinalMeasurements`](qiskit.transpiler.passes.RemoveFinalMeasurements "qiskit.transpiler.passes.RemoveFinalMeasurements")(\*args, \*\*kwargs) | Remove final measurements and barriers at the end of a circuit. | +| [`DAGFixedPoint`](qiskit.transpiler.passes.DAGFixedPoint "qiskit.transpiler.passes.DAGFixedPoint")(\*args, \*\*kwargs) | Check if the DAG has reached a fixed point. | +| [`FixedPoint`](qiskit.transpiler.passes.FixedPoint "qiskit.transpiler.passes.FixedPoint")(\*args, \*\*kwargs) | Check if a property reached a fixed point. | diff --git a/docs/api/qiskit/0.32/transpiler_preset.md b/docs/api/qiskit/0.32/transpiler_preset.md index ee1fe80255a..8da68edeb35 100644 --- a/docs/api/qiskit/0.32/transpiler_preset.md +++ b/docs/api/qiskit/0.32/transpiler_preset.md @@ -16,10 +16,10 @@ python_api_name: qiskit.transpiler.preset_passmanagers `qiskit.transpiler.preset_passmanagers` -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| [`level_0_pass_manager`](qiskit.transpiler.preset_passmanagers.level_0_pass_manager#qiskit.transpiler.preset_passmanagers.level_0_pass_manager "qiskit.transpiler.preset_passmanagers.level_0_pass_manager")(pass\_manager\_config) | Level 0 pass manager: no explicit optimization other than mapping to backend. | -| [`level_1_pass_manager`](qiskit.transpiler.preset_passmanagers.level_1_pass_manager#qiskit.transpiler.preset_passmanagers.level_1_pass_manager "qiskit.transpiler.preset_passmanagers.level_1_pass_manager")(pass\_manager\_config) | Level 1 pass manager: light optimization by simple adjacent gate collapsing. | -| [`level_2_pass_manager`](qiskit.transpiler.preset_passmanagers.level_2_pass_manager#qiskit.transpiler.preset_passmanagers.level_2_pass_manager "qiskit.transpiler.preset_passmanagers.level_2_pass_manager")(pass\_manager\_config) | Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. | -| [`level_3_pass_manager`](qiskit.transpiler.preset_passmanagers.level_3_pass_manager#qiskit.transpiler.preset_passmanagers.level_3_pass_manager "qiskit.transpiler.preset_passmanagers.level_3_pass_manager")(pass\_manager\_config) | Level 3 pass manager: heavy optimization by noise adaptive qubit mapping and gate cancellation using commutativity rules and unitary synthesis. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | +| [`level_0_pass_manager`](qiskit.transpiler.preset_passmanagers.level_0_pass_manager "qiskit.transpiler.preset_passmanagers.level_0_pass_manager")(pass\_manager\_config) | Level 0 pass manager: no explicit optimization other than mapping to backend. | +| [`level_1_pass_manager`](qiskit.transpiler.preset_passmanagers.level_1_pass_manager "qiskit.transpiler.preset_passmanagers.level_1_pass_manager")(pass\_manager\_config) | Level 1 pass manager: light optimization by simple adjacent gate collapsing. | +| [`level_2_pass_manager`](qiskit.transpiler.preset_passmanagers.level_2_pass_manager "qiskit.transpiler.preset_passmanagers.level_2_pass_manager")(pass\_manager\_config) | Level 2 pass manager: medium optimization by initial layout selection and gate cancellation using commutativity rules. | +| [`level_3_pass_manager`](qiskit.transpiler.preset_passmanagers.level_3_pass_manager "qiskit.transpiler.preset_passmanagers.level_3_pass_manager")(pass\_manager\_config) | 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/utils.md b/docs/api/qiskit/0.32/utils.md index 5d1ff75f9e8..58cccbb8b06 100644 --- a/docs/api/qiskit/0.32/utils.md +++ b/docs/api/qiskit/0.32/utils.md @@ -16,29 +16,29 @@ python_api_name: qiskit.utils `qiskit.utils` -| | | -| --------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| [`deprecate_arguments`](qiskit.utils.deprecate_arguments#qiskit.utils.deprecate_arguments "qiskit.utils.deprecate_arguments")(kwarg\_map) | Decorator to automatically alias deprecated argument names and warn upon use. | -| [`deprecate_function`](qiskit.utils.deprecate_function#qiskit.utils.deprecate_function "qiskit.utils.deprecate_function")(msg\[, stacklevel]) | Emit a warning prior to calling decorated function. | -| [`local_hardware_info`](qiskit.utils.local_hardware_info#qiskit.utils.local_hardware_info "qiskit.utils.local_hardware_info")() | Basic hardware information about the local machine. | -| [`is_main_process`](qiskit.utils.is_main_process#qiskit.utils.is_main_process "qiskit.utils.is_main_process")() | Checks whether the current process is the main one | -| [`apply_prefix`](qiskit.utils.apply_prefix#qiskit.utils.apply_prefix "qiskit.utils.apply_prefix")(value, unit) | Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. | +| | | +| ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| [`deprecate_arguments`](qiskit.utils.deprecate_arguments "qiskit.utils.deprecate_arguments")(kwarg\_map) | Decorator to automatically alias deprecated argument names and warn upon use. | +| [`deprecate_function`](qiskit.utils.deprecate_function "qiskit.utils.deprecate_function")(msg\[, stacklevel]) | Emit a warning prior to calling decorated function. | +| [`local_hardware_info`](qiskit.utils.local_hardware_info "qiskit.utils.local_hardware_info")() | Basic hardware information about the local machine. | +| [`is_main_process`](qiskit.utils.is_main_process "qiskit.utils.is_main_process")() | Checks whether the current process is the main one | +| [`apply_prefix`](qiskit.utils.apply_prefix "qiskit.utils.apply_prefix")(value, unit) | Given a SI unit prefix and value, apply the prefix to convert to standard SI unit. | ## Algorithm Utilities -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits#qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map#qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map#qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq#qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer#qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args#qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | - -| | | -| ------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -| [`QuantumInstance`](qiskit.utils.QuantumInstance#qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance") | Quantum Backend including execution setting. | +| | | +| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | + +| | | +| -------------------------------------------------------------------------------- | -------------------------------------------- | +| [`QuantumInstance`](qiskit.utils.QuantumInstance "qiskit.utils.QuantumInstance") | Quantum Backend including execution setting. | A QuantumInstance holds the Qiskit backend as well as a number of compile and runtime parameters controlling circuit compilation and execution. Quantum [`algorithms`](algorithms#module-qiskit.algorithms "qiskit.algorithms") are run on a device or simulator by passing a QuantumInstance setup with the desired backend etc. diff --git a/docs/api/qiskit/0.32/validation.md b/docs/api/qiskit/0.32/validation.md index d5dec406199..dd6d08a2fa0 100644 --- a/docs/api/qiskit/0.32/validation.md +++ b/docs/api/qiskit/0.32/validation.md @@ -18,13 +18,13 @@ python_api_name: qiskit.validation ## JSON Schema -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | -| [`jsonschema.validate_json_against_schema`](qiskit.validation.jsonschema.validate_json_against_schema#qiskit.validation.jsonschema.validate_json_against_schema "qiskit.validation.jsonschema.validate_json_against_schema")(…) | Validates JSON dict against a schema. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| [`jsonschema.validate_json_against_schema`](qiskit.validation.jsonschema.validate_json_against_schema "qiskit.validation.jsonschema.validate_json_against_schema")(…) | Validates JSON dict against a schema. | ## Exceptions -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | -| [`jsonschema.SchemaValidationError`](qiskit.validation.jsonschema.SchemaValidationError#qiskit.validation.jsonschema.SchemaValidationError "qiskit.validation.jsonschema.SchemaValidationError")(\*message) | Represents an error during JSON Schema validation. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | +| [`jsonschema.SchemaValidationError`](qiskit.validation.jsonschema.SchemaValidationError "qiskit.validation.jsonschema.SchemaValidationError")(\*message) | Represents an error during JSON Schema validation. | diff --git a/docs/api/qiskit/0.32/verification.md b/docs/api/qiskit/0.32/verification.md index 0a87bc6c29d..acb4e18c26b 100644 --- a/docs/api/qiskit/0.32/verification.md +++ b/docs/api/qiskit/0.32/verification.md @@ -18,80 +18,80 @@ python_api_name: qiskit.ignis.verification ## Quantum Volume -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| [`qv_circuits`](qiskit.ignis.verification.qv_circuits#qiskit.ignis.verification.qv_circuits "qiskit.ignis.verification.qv_circuits")(qubit\_lists\[, ntrials, qr, cr, seed]) | Return a list of square quantum volume circuits (depth=width) | -| [`QVFitter`](qiskit.ignis.verification.QVFitter#qiskit.ignis.verification.QVFitter "qiskit.ignis.verification.QVFitter")(\[backend\_result, …]) | Class for fitters for quantum volume. | +| | | +| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | +| [`qv_circuits`](qiskit.ignis.verification.qv_circuits "qiskit.ignis.verification.qv_circuits")(qubit\_lists\[, ntrials, qr, cr, seed]) | Return a list of square quantum volume circuits (depth=width) | +| [`QVFitter`](qiskit.ignis.verification.QVFitter "qiskit.ignis.verification.QVFitter")(\[backend\_result, …]) | Class for fitters for quantum volume. | ## Randomized Benchmarking Randomization benchmarking (RB) is a well-known technique to measure average gate performance by running sequences of random Clifford gates that should return the qubits to the initial state. Qiskit Ignis has tools to generate one- and two-qubit gate Clifford RB sequences simultaneously, as well as performing interleaved RB, purity RB and RB on the non-Clifford CNOT-Dihedral group. -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | -| [`randomized_benchmarking_seq`](qiskit.ignis.verification.randomized_benchmarking_seq#qiskit.ignis.verification.randomized_benchmarking_seq "qiskit.ignis.verification.randomized_benchmarking_seq")(\[nseeds, …]) | Generate generic randomized benchmarking (RB) sequences. | -| [`RBFitter`](qiskit.ignis.verification.RBFitter#qiskit.ignis.verification.RBFitter "qiskit.ignis.verification.RBFitter")(backend\_result, cliff\_lengths\[, …]) | Class for fitters for randomized benchmarking. | -| [`InterleavedRBFitter`](qiskit.ignis.verification.InterleavedRBFitter#qiskit.ignis.verification.InterleavedRBFitter "qiskit.ignis.verification.InterleavedRBFitter")(original\_result, …\[, …]) | Class for fitters for interleaved RB, derived from RBFitterBase class. | -| [`PurityRBFitter`](qiskit.ignis.verification.PurityRBFitter#qiskit.ignis.verification.PurityRBFitter "qiskit.ignis.verification.PurityRBFitter")(purity\_result, npurity, …) | Class for fitter for purity RB. | -| [`CNOTDihedralRBFitter`](qiskit.ignis.verification.CNOTDihedralRBFitter#qiskit.ignis.verification.CNOTDihedralRBFitter "qiskit.ignis.verification.CNOTDihedralRBFitter")(cnotdihedral\_Z\_result, …) | Class for fitters for non-Clifford CNOT-Dihedral RB. | -| [`CNOTDihedral`](qiskit.ignis.verification.CNOTDihedral#qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")(data\[, validate]) | CNOT-dihedral Object Class. | -| [`count_gates`](qiskit.ignis.verification.count_gates#qiskit.ignis.verification.count_gates "qiskit.ignis.verification.count_gates")(qobj, basis, qubits) | Take a compiled qobj and output the number of gates in each circuit. | -| [`gates_per_clifford`](qiskit.ignis.verification.gates_per_clifford#qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford")(transpiled\_circuits\_list, …) | Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. | -| [`calculate_1q_epg`](qiskit.ignis.verification.calculate_1q_epg#qiskit.ignis.verification.calculate_1q_epg "qiskit.ignis.verification.calculate_1q_epg")(gate\_per\_cliff, epc\_1q, qubit) | Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. | -| [`calculate_2q_epg`](qiskit.ignis.verification.calculate_2q_epg#qiskit.ignis.verification.calculate_2q_epg "qiskit.ignis.verification.calculate_2q_epg")(gate\_per\_cliff, epc\_2q, …) | Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. | -| [`calculate_1q_epc`](qiskit.ignis.verification.calculate_1q_epc#qiskit.ignis.verification.calculate_1q_epc "qiskit.ignis.verification.calculate_1q_epc")(gate\_per\_cliff, epg\_1q, qubit) | Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. | -| [`calculate_2q_epc`](qiskit.ignis.verification.calculate_2q_epc#qiskit.ignis.verification.calculate_2q_epc "qiskit.ignis.verification.calculate_2q_epc")(gate\_per\_cliff, epg\_2q, …) | Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. | -| [`coherence_limit`](qiskit.ignis.verification.coherence_limit#qiskit.ignis.verification.coherence_limit "qiskit.ignis.verification.coherence_limit")(\[nQ, T1\_list, T2\_list, gatelen]) | The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. | -| [`twoQ_clifford_error`](qiskit.ignis.verification.twoQ_clifford_error#qiskit.ignis.verification.twoQ_clifford_error "qiskit.ignis.verification.twoQ_clifford_error")(ngates, gate\_qubit, gate\_err) | The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | +| [`randomized_benchmarking_seq`](qiskit.ignis.verification.randomized_benchmarking_seq "qiskit.ignis.verification.randomized_benchmarking_seq")(\[nseeds, …]) | Generate generic randomized benchmarking (RB) sequences. | +| [`RBFitter`](qiskit.ignis.verification.RBFitter "qiskit.ignis.verification.RBFitter")(backend\_result, cliff\_lengths\[, …]) | Class for fitters for randomized benchmarking. | +| [`InterleavedRBFitter`](qiskit.ignis.verification.InterleavedRBFitter "qiskit.ignis.verification.InterleavedRBFitter")(original\_result, …\[, …]) | Class for fitters for interleaved RB, derived from RBFitterBase class. | +| [`PurityRBFitter`](qiskit.ignis.verification.PurityRBFitter "qiskit.ignis.verification.PurityRBFitter")(purity\_result, npurity, …) | Class for fitter for purity RB. | +| [`CNOTDihedralRBFitter`](qiskit.ignis.verification.CNOTDihedralRBFitter "qiskit.ignis.verification.CNOTDihedralRBFitter")(cnotdihedral\_Z\_result, …) | Class for fitters for non-Clifford CNOT-Dihedral RB. | +| [`CNOTDihedral`](qiskit.ignis.verification.CNOTDihedral "qiskit.ignis.verification.CNOTDihedral")(data\[, validate]) | CNOT-dihedral Object Class. | +| [`count_gates`](qiskit.ignis.verification.count_gates "qiskit.ignis.verification.count_gates")(qobj, basis, qubits) | Take a compiled qobj and output the number of gates in each circuit. | +| [`gates_per_clifford`](qiskit.ignis.verification.gates_per_clifford "qiskit.ignis.verification.gates_per_clifford")(transpiled\_circuits\_list, …) | Take a list of transpiled `QuantumCircuit` and use these to calculate the number of gates per Clifford. | +| [`calculate_1q_epg`](qiskit.ignis.verification.calculate_1q_epg "qiskit.ignis.verification.calculate_1q_epg")(gate\_per\_cliff, epc\_1q, qubit) | Convert error per Clifford (EPC) into error per gates (EPGs) of single qubit basis gates. | +| [`calculate_2q_epg`](qiskit.ignis.verification.calculate_2q_epg "qiskit.ignis.verification.calculate_2q_epg")(gate\_per\_cliff, epc\_2q, …) | Convert error per Clifford (EPC) into error per gate (EPG) of two qubit `cx` gates. | +| [`calculate_1q_epc`](qiskit.ignis.verification.calculate_1q_epc "qiskit.ignis.verification.calculate_1q_epc")(gate\_per\_cliff, epg\_1q, qubit) | Convert error per gate (EPG) into error per Clifford (EPC) of single qubit basis gates. | +| [`calculate_2q_epc`](qiskit.ignis.verification.calculate_2q_epc "qiskit.ignis.verification.calculate_2q_epc")(gate\_per\_cliff, epg\_2q, …) | Convert error per gate (EPG) into error per Clifford (EPC) of two qubit `cx` gates. | +| [`coherence_limit`](qiskit.ignis.verification.coherence_limit "qiskit.ignis.verification.coherence_limit")(\[nQ, T1\_list, T2\_list, gatelen]) | The error per gate (1-average\_gate\_fidelity) given by the T1,T2 limit. | +| [`twoQ_clifford_error`](qiskit.ignis.verification.twoQ_clifford_error "qiskit.ignis.verification.twoQ_clifford_error")(ngates, gate\_qubit, gate\_err) | The two qubit Clifford gate error given measured errors in the primitive gates used to construct the Clifford (see arxiv:1712.06550). | ## Tomography -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -| [`state_tomography_circuits`](qiskit.ignis.verification.state_tomography_circuits#qiskit.ignis.verification.state_tomography_circuits "qiskit.ignis.verification.state_tomography_circuits")(circuit, …\[, …]) | Return a list of quantum state tomography circuits. | -| [`process_tomography_circuits`](qiskit.ignis.verification.process_tomography_circuits#qiskit.ignis.verification.process_tomography_circuits "qiskit.ignis.verification.process_tomography_circuits")(circuit, …\[, …]) | Return a list of quantum process tomography circuits. | -| [`gateset_tomography_circuits`](qiskit.ignis.verification.gateset_tomography_circuits#qiskit.ignis.verification.gateset_tomography_circuits "qiskit.ignis.verification.gateset_tomography_circuits")(\[…]) | Return a list of quantum gate set tomography (GST) circuits. | -| [`basis`](qiskit.ignis.verification.basis#module-qiskit.ignis.verification.basis "qiskit.ignis.verification.basis") | Quantum tomography basis | -| [`StateTomographyFitter`](qiskit.ignis.verification.StateTomographyFitter#qiskit.ignis.verification.StateTomographyFitter "qiskit.ignis.verification.StateTomographyFitter")(result, circuits\[, …]) | Maximum-Likelihood estimation state tomography fitter. | -| [`ProcessTomographyFitter`](qiskit.ignis.verification.ProcessTomographyFitter#qiskit.ignis.verification.ProcessTomographyFitter "qiskit.ignis.verification.ProcessTomographyFitter")(result, circuits\[, …]) | Maximum-Likelihood estimation process tomography fitter. | -| [`GatesetTomographyFitter`](qiskit.ignis.verification.GatesetTomographyFitter#qiskit.ignis.verification.GatesetTomographyFitter "qiskit.ignis.verification.GatesetTomographyFitter")(result, circuits\[, …]) | Initialize gateset tomography fitter with experimental data. | -| [`TomographyFitter`](qiskit.ignis.verification.TomographyFitter#qiskit.ignis.verification.TomographyFitter "qiskit.ignis.verification.TomographyFitter")(result, circuits\[, …]) | Base maximum-likelihood estimate tomography fitter class | -| [`marginal_counts`](qiskit.ignis.verification.marginal_counts#qiskit.ignis.verification.marginal_counts "qiskit.ignis.verification.marginal_counts")(counts\[, meas\_qubits, pad\_zeros]) | Compute marginal counts from a counts dictionary. | -| [`combine_counts`](qiskit.ignis.verification.combine_counts#qiskit.ignis.verification.combine_counts "qiskit.ignis.verification.combine_counts")(counts1, counts2) | Combine two counts dictionaries. | -| [`expectation_counts`](qiskit.ignis.verification.expectation_counts#qiskit.ignis.verification.expectation_counts "qiskit.ignis.verification.expectation_counts")(counts) | Converts count dict to an expectation counts dict. | -| [`count_keys`](qiskit.ignis.verification.count_keys#qiskit.ignis.verification.count_keys "qiskit.ignis.verification.count_keys")(num\_qubits) | Return ordered count keys. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | +| [`state_tomography_circuits`](qiskit.ignis.verification.state_tomography_circuits "qiskit.ignis.verification.state_tomography_circuits")(circuit, …\[, …]) | Return a list of quantum state tomography circuits. | +| [`process_tomography_circuits`](qiskit.ignis.verification.process_tomography_circuits "qiskit.ignis.verification.process_tomography_circuits")(circuit, …\[, …]) | Return a list of quantum process tomography circuits. | +| [`gateset_tomography_circuits`](qiskit.ignis.verification.gateset_tomography_circuits "qiskit.ignis.verification.gateset_tomography_circuits")(\[…]) | Return a list of quantum gate set tomography (GST) circuits. | +| [`basis`](qiskit.ignis.verification.basis#module-qiskit.ignis.verification.basis "qiskit.ignis.verification.basis") | Quantum tomography basis | +| [`StateTomographyFitter`](qiskit.ignis.verification.StateTomographyFitter "qiskit.ignis.verification.StateTomographyFitter")(result, circuits\[, …]) | Maximum-Likelihood estimation state tomography fitter. | +| [`ProcessTomographyFitter`](qiskit.ignis.verification.ProcessTomographyFitter "qiskit.ignis.verification.ProcessTomographyFitter")(result, circuits\[, …]) | Maximum-Likelihood estimation process tomography fitter. | +| [`GatesetTomographyFitter`](qiskit.ignis.verification.GatesetTomographyFitter "qiskit.ignis.verification.GatesetTomographyFitter")(result, circuits\[, …]) | Initialize gateset tomography fitter with experimental data. | +| [`TomographyFitter`](qiskit.ignis.verification.TomographyFitter "qiskit.ignis.verification.TomographyFitter")(result, circuits\[, …]) | Base maximum-likelihood estimate tomography fitter class | +| [`marginal_counts`](qiskit.ignis.verification.marginal_counts "qiskit.ignis.verification.marginal_counts")(counts\[, meas\_qubits, pad\_zeros]) | Compute marginal counts from a counts dictionary. | +| [`combine_counts`](qiskit.ignis.verification.combine_counts "qiskit.ignis.verification.combine_counts")(counts1, counts2) | Combine two counts dictionaries. | +| [`expectation_counts`](qiskit.ignis.verification.expectation_counts "qiskit.ignis.verification.expectation_counts")(counts) | Converts count dict to an expectation counts dict. | +| [`count_keys`](qiskit.ignis.verification.count_keys "qiskit.ignis.verification.count_keys")(num\_qubits) | Return ordered count keys. | ## Entanglement -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- | -| [`BConfig`](qiskit.ignis.verification.BConfig#qiskit.ignis.verification.BConfig "qiskit.ignis.verification.BConfig")(backend\[, indicator]) | This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity | -| [`get_ghz_simple`](qiskit.ignis.verification.get_ghz_simple#qiskit.ignis.verification.get_ghz_simple "qiskit.ignis.verification.get_ghz_simple")(n\[, measure, full\_measurement]) | Creates a linear GHZ state with the option of measurement | -| [`get_ghz_mqc`](qiskit.ignis.verification.get_ghz_mqc#qiskit.ignis.verification.get_ghz_mqc "qiskit.ignis.verification.get_ghz_mqc")(n, delta\[, full\_measurement]) | This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta | -| [`get_ghz_mqc_para`](qiskit.ignis.verification.get_ghz_mqc_para#qiskit.ignis.verification.get_ghz_mqc_para "qiskit.ignis.verification.get_ghz_mqc_para")(n\[, full\_measurement]) | This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized | -| [`get_ghz_po`](qiskit.ignis.verification.get_ghz_po#qiskit.ignis.verification.get_ghz_po "qiskit.ignis.verification.get_ghz_po")(n, delta) | This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta | -| [`get_ghz_po_para`](qiskit.ignis.verification.get_ghz_po_para#qiskit.ignis.verification.get_ghz_po_para "qiskit.ignis.verification.get_ghz_po_para")(n) | This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around | -| [`ordered_list_generator`](qiskit.ignis.verification.ordered_list_generator#qiskit.ignis.verification.ordered_list_generator "qiskit.ignis.verification.ordered_list_generator")(counts\_dictionary, qn) | For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily | -| [`composite_pauli_z`](qiskit.ignis.verification.composite_pauli_z#qiskit.ignis.verification.composite_pauli_z "qiskit.ignis.verification.composite_pauli_z")(qn) | Generates n tensored pauli z matrix upon input of qubit number | -| [`composite_pauli_z_expvalue`](qiskit.ignis.verification.composite_pauli_z_expvalue#qiskit.ignis.verification.composite_pauli_z_expvalue "qiskit.ignis.verification.composite_pauli_z_expvalue")(counts\_dictionary, qn) | Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix | -| [`Plotter`](qiskit.ignis.verification.Plotter#qiskit.ignis.verification.Plotter "qiskit.ignis.verification.Plotter")(label) | Various plots of the ground state in MQC and PO experiments | -| [`rho_to_fidelity`](qiskit.ignis.verification.rho_to_fidelity#qiskit.ignis.verification.rho_to_fidelity "qiskit.ignis.verification.rho_to_fidelity")(rho) | Get fidelity given rho :type rho: `float` :param rho: The density matrix | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| [`BConfig`](qiskit.ignis.verification.BConfig "qiskit.ignis.verification.BConfig")(backend\[, indicator]) | This class is used to create a GHZ circuit with parallellized CNOT gates to increase fidelity | +| [`get_ghz_simple`](qiskit.ignis.verification.get_ghz_simple "qiskit.ignis.verification.get_ghz_simple")(n\[, measure, full\_measurement]) | Creates a linear GHZ state with the option of measurement | +| [`get_ghz_mqc`](qiskit.ignis.verification.get_ghz_mqc "qiskit.ignis.verification.get_ghz_mqc")(n, delta\[, full\_measurement]) | This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is by delta | +| [`get_ghz_mqc_para`](qiskit.ignis.verification.get_ghz_mqc_para "qiskit.ignis.verification.get_ghz_mqc_para")(n\[, full\_measurement]) | This function creates an MQC circuit with n qubits, where the middle phase rotation around the z axis is parameterized | +| [`get_ghz_po`](qiskit.ignis.verification.get_ghz_po "qiskit.ignis.verification.get_ghz_po")(n, delta) | This function creates an Parity Oscillation circuit with n qubits, where the middle superposition rotation around the x and y axes is by delta | +| [`get_ghz_po_para`](qiskit.ignis.verification.get_ghz_po_para "qiskit.ignis.verification.get_ghz_po_para")(n) | This function creates a Parity Oscillation circuit with n qubits, where the middle superposition rotation around | +| [`ordered_list_generator`](qiskit.ignis.verification.ordered_list_generator "qiskit.ignis.verification.ordered_list_generator")(counts\_dictionary, qn) | For parity oscillations; just arranges dictionary of counts in bitwise binary order to compute dot products more easily | +| [`composite_pauli_z`](qiskit.ignis.verification.composite_pauli_z "qiskit.ignis.verification.composite_pauli_z")(qn) | Generates n tensored pauli z matrix upon input of qubit number | +| [`composite_pauli_z_expvalue`](qiskit.ignis.verification.composite_pauli_z_expvalue "qiskit.ignis.verification.composite_pauli_z_expvalue")(counts\_dictionary, qn) | Generates expectation value of n tensored pauli matrix upon input of qubit number and composite pauli matrix | +| [`Plotter`](qiskit.ignis.verification.Plotter "qiskit.ignis.verification.Plotter")(label) | Various plots of the ground state in MQC and PO experiments | +| [`rho_to_fidelity`](qiskit.ignis.verification.rho_to_fidelity "qiskit.ignis.verification.rho_to_fidelity")(rho) | Get fidelity given rho :type rho: `float` :param rho: The density matrix | ## Topological Codes -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| [`RepetitionCode`](qiskit.ignis.verification.RepetitionCode#qiskit.ignis.verification.RepetitionCode "qiskit.ignis.verification.RepetitionCode")(d\[, T]) | Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. | -| [`GraphDecoder`](qiskit.ignis.verification.GraphDecoder#qiskit.ignis.verification.GraphDecoder "qiskit.ignis.verification.GraphDecoder")(code\[, S]) | Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. | -| [`lookuptable_decoding`](qiskit.ignis.verification.lookuptable_decoding#qiskit.ignis.verification.lookuptable_decoding "qiskit.ignis.verification.lookuptable_decoding")(training\_results, …) | Calculates the logical error probability using postselection decoding. | -| [`postselection_decoding`](qiskit.ignis.verification.postselection_decoding#qiskit.ignis.verification.postselection_decoding "qiskit.ignis.verification.postselection_decoding")(results) | Calculates the logical error probability using postselection decoding. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| [`RepetitionCode`](qiskit.ignis.verification.RepetitionCode "qiskit.ignis.verification.RepetitionCode")(d\[, T]) | Implementation of a distance d repetition code, implemented over T syndrome measurement rounds. | +| [`GraphDecoder`](qiskit.ignis.verification.GraphDecoder "qiskit.ignis.verification.GraphDecoder")(code\[, S]) | Class to construct the graph corresponding to the possible syndromes of a quantum error correction code, and then run suitable decoders. | +| [`lookuptable_decoding`](qiskit.ignis.verification.lookuptable_decoding "qiskit.ignis.verification.lookuptable_decoding")(training\_results, …) | Calculates the logical error probability using postselection decoding. | +| [`postselection_decoding`](qiskit.ignis.verification.postselection_decoding "qiskit.ignis.verification.postselection_decoding")(results) | Calculates the logical error probability using postselection decoding. | ## Accreditation -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | -| [`AccreditationCircuits`](qiskit.ignis.verification.AccreditationCircuits#qiskit.ignis.verification.AccreditationCircuits "qiskit.ignis.verification.AccreditationCircuits")(target\_circ\[, …]) | This class generates accreditation circuits from a target. | -| [`AccreditationFitter`](qiskit.ignis.verification.AccreditationFitter#qiskit.ignis.verification.AccreditationFitter "qiskit.ignis.verification.AccreditationFitter")() | Class for fitters for accreditation | -| [`QOTP`](qiskit.ignis.verification.QOTP#qiskit.ignis.verification.QOTP "qiskit.ignis.verification.QOTP")(circ, num\[, two\_qubit\_gate, …]) | Performs a QOTP (or random compilation) on a generic circuit. | -| [`QOTPCorrectCounts`](qiskit.ignis.verification.QOTPCorrectCounts#qiskit.ignis.verification.QOTPCorrectCounts "qiskit.ignis.verification.QOTPCorrectCounts")(qotp\_counts, qotp\_postp) | Corrects a dictionary of results, shifting the qotp | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- | +| [`AccreditationCircuits`](qiskit.ignis.verification.AccreditationCircuits "qiskit.ignis.verification.AccreditationCircuits")(target\_circ\[, …]) | This class generates accreditation circuits from a target. | +| [`AccreditationFitter`](qiskit.ignis.verification.AccreditationFitter "qiskit.ignis.verification.AccreditationFitter")() | Class for fitters for accreditation | +| [`QOTP`](qiskit.ignis.verification.QOTP "qiskit.ignis.verification.QOTP")(circ, num\[, two\_qubit\_gate, …]) | Performs a QOTP (or random compilation) on a generic circuit. | +| [`QOTPCorrectCounts`](qiskit.ignis.verification.QOTPCorrectCounts "qiskit.ignis.verification.QOTPCorrectCounts")(qotp\_counts, qotp\_postp) | Corrects a dictionary of results, shifting the qotp | diff --git a/docs/api/qiskit/0.32/visualization.md b/docs/api/qiskit/0.32/visualization.md index bebfc8f6540..e9e1ebcbd99 100644 --- a/docs/api/qiskit/0.32/visualization.md +++ b/docs/api/qiskit/0.32/visualization.md @@ -18,74 +18,74 @@ python_api_name: qiskit.visualization ## Counts and State Visualizations -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | -| [`plot_histogram`](qiskit.visualization.plot_histogram#qiskit.visualization.plot_histogram "qiskit.visualization.plot_histogram")(data\[, figsize, color, …]) | Plot a histogram of data. | -| [`plot_bloch_vector`](qiskit.visualization.plot_bloch_vector#qiskit.visualization.plot_bloch_vector "qiskit.visualization.plot_bloch_vector")(bloch\[, title, ax, …]) | Plot the Bloch sphere. | -| [`plot_bloch_multivector`](qiskit.visualization.plot_bloch_multivector#qiskit.visualization.plot_bloch_multivector "qiskit.visualization.plot_bloch_multivector")(state\[, title, …]) | Plot the Bloch sphere. | -| [`plot_state_city`](qiskit.visualization.plot_state_city#qiskit.visualization.plot_state_city "qiskit.visualization.plot_state_city")(state\[, title, figsize, …]) | Plot the cityscape of quantum state. | -| [`plot_state_hinton`](qiskit.visualization.plot_state_hinton#qiskit.visualization.plot_state_hinton "qiskit.visualization.plot_state_hinton")(state\[, title, figsize, …]) | Plot a hinton diagram for the density matrix of a quantum state. | -| [`plot_state_paulivec`](qiskit.visualization.plot_state_paulivec#qiskit.visualization.plot_state_paulivec "qiskit.visualization.plot_state_paulivec")(state\[, title, figsize, …]) | Plot the paulivec representation of a quantum state. | -| [`plot_state_qsphere`](qiskit.visualization.plot_state_qsphere#qiskit.visualization.plot_state_qsphere "qiskit.visualization.plot_state_qsphere")(state\[, figsize, ax, …]) | Plot the qsphere representation of a quantum state. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | +| [`plot_histogram`](qiskit.visualization.plot_histogram "qiskit.visualization.plot_histogram")(data\[, figsize, color, …]) | Plot a histogram of data. | +| [`plot_bloch_vector`](qiskit.visualization.plot_bloch_vector "qiskit.visualization.plot_bloch_vector")(bloch\[, title, ax, …]) | Plot the Bloch sphere. | +| [`plot_bloch_multivector`](qiskit.visualization.plot_bloch_multivector "qiskit.visualization.plot_bloch_multivector")(state\[, title, …]) | Plot the Bloch sphere. | +| [`plot_state_city`](qiskit.visualization.plot_state_city "qiskit.visualization.plot_state_city")(state\[, title, figsize, …]) | Plot the cityscape of quantum state. | +| [`plot_state_hinton`](qiskit.visualization.plot_state_hinton "qiskit.visualization.plot_state_hinton")(state\[, title, figsize, …]) | Plot a hinton diagram for the density matrix of a quantum state. | +| [`plot_state_paulivec`](qiskit.visualization.plot_state_paulivec "qiskit.visualization.plot_state_paulivec")(state\[, title, figsize, …]) | Plot the paulivec representation of a quantum state. | +| [`plot_state_qsphere`](qiskit.visualization.plot_state_qsphere "qiskit.visualization.plot_state_qsphere")(state\[, figsize, ax, …]) | Plot the qsphere representation of a quantum state. | ## Device Visualizations -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | -| [`plot_gate_map`](qiskit.visualization.plot_gate_map#qiskit.visualization.plot_gate_map "qiskit.visualization.plot_gate_map")(backend\[, figsize, …]) | Plots the gate map of a device. | -| [`plot_error_map`](qiskit.visualization.plot_error_map#qiskit.visualization.plot_error_map "qiskit.visualization.plot_error_map")(backend\[, figsize, show\_title]) | Plots the error map of a given backend. | -| [`plot_circuit_layout`](qiskit.visualization.plot_circuit_layout#qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout")(circuit, backend\[, view]) | Plot the layout of a circuit transpiled for a given target backend. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`plot_gate_map`](qiskit.visualization.plot_gate_map "qiskit.visualization.plot_gate_map")(backend\[, figsize, …]) | Plots the gate map of a device. | +| [`plot_error_map`](qiskit.visualization.plot_error_map "qiskit.visualization.plot_error_map")(backend\[, figsize, show\_title]) | Plots the error map of a given backend. | +| [`plot_circuit_layout`](qiskit.visualization.plot_circuit_layout "qiskit.visualization.plot_circuit_layout")(circuit, backend\[, view]) | Plot the layout of a circuit transpiled for a given target backend. | ## Circuit Visualizations -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | -| [`circuit_drawer`](qiskit.visualization.circuit_drawer#qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer")(circuit\[, scale, filename, …]) | Draw the quantum circuit. | -| [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle#qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle")() | Creates a Default Style dictionary | +| | | +| ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| [`circuit_drawer`](qiskit.visualization.circuit_drawer "qiskit.visualization.circuit_drawer")(circuit\[, scale, filename, …]) | Draw the quantum circuit. | +| [`DefaultStyle`](qiskit.visualization.qcstyle.DefaultStyle "qiskit.visualization.qcstyle.DefaultStyle")() | Creates a Default Style dictionary | ## DAG Visualizations -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| [`dag_drawer`](qiskit.visualization.dag_drawer#qiskit.visualization.dag_drawer "qiskit.visualization.dag_drawer")(dag\[, scale, filename, style]) | Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. | +| | | +| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| [`dag_drawer`](qiskit.visualization.dag_drawer "qiskit.visualization.dag_drawer")(dag\[, scale, filename, style]) | Plot the directed acyclic graph (dag) to represent operation dependencies in a quantum circuit. | ## Pass Manager Visualizations -| | | -| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | -| [`pass_manager_drawer`](qiskit.visualization.pass_manager_drawer#qiskit.visualization.pass_manager_drawer "qiskit.visualization.pass_manager_drawer")(pass\_manager\[, …]) | Draws the pass manager. | +| | | +| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | +| [`pass_manager_drawer`](qiskit.visualization.pass_manager_drawer "qiskit.visualization.pass_manager_drawer")(pass\_manager\[, …]) | Draws the pass manager. | ## Pulse Visualizations -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -| [`draw`](qiskit.visualization.pulse_v2.draw#qiskit.visualization.pulse_v2.draw "qiskit.visualization.pulse_v2.draw")(program\[, style, backend, time\_range, …]) | Generate visualization data for pulse programs. | -| [`IQXStandard`](qiskit.visualization.pulse_v2.IQXStandard#qiskit.visualization.pulse_v2.IQXStandard "qiskit.visualization.pulse_v2.IQXStandard")(\*\*kwargs) | Standard pulse stylesheet. | -| [`IQXSimple`](qiskit.visualization.pulse_v2.IQXSimple#qiskit.visualization.pulse_v2.IQXSimple "qiskit.visualization.pulse_v2.IQXSimple")(\*\*kwargs) | Simple pulse stylesheet without channel notation. | -| [`IQXDebugging`](qiskit.visualization.pulse_v2.IQXDebugging#qiskit.visualization.pulse_v2.IQXDebugging "qiskit.visualization.pulse_v2.IQXDebugging")(\*\*kwargs) | Pulse stylesheet for pulse programmers. | +| | | +| ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | +| [`draw`](qiskit.visualization.pulse_v2.draw "qiskit.visualization.pulse_v2.draw")(program\[, style, backend, time\_range, …]) | Generate visualization data for pulse programs. | +| [`IQXStandard`](qiskit.visualization.pulse_v2.IQXStandard "qiskit.visualization.pulse_v2.IQXStandard")(\*\*kwargs) | Standard pulse stylesheet. | +| [`IQXSimple`](qiskit.visualization.pulse_v2.IQXSimple "qiskit.visualization.pulse_v2.IQXSimple")(\*\*kwargs) | Simple pulse stylesheet without channel notation. | +| [`IQXDebugging`](qiskit.visualization.pulse_v2.IQXDebugging "qiskit.visualization.pulse_v2.IQXDebugging")(\*\*kwargs) | Pulse stylesheet for pulse programmers. | ## Timeline Visualizations -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | -| [`timeline_drawer`](qiskit.visualization.timeline_drawer#qiskit.visualization.timeline_drawer "qiskit.visualization.timeline_drawer")(program\[, style, …]) | Generate visualization data for scheduled circuit programs. | -| [`draw`](qiskit.visualization.timeline.draw#qiskit.visualization.timeline.draw "qiskit.visualization.timeline.draw")(program\[, style, time\_range, …]) | Generate visualization data for scheduled circuit programs. | +| | | +| ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | +| [`timeline_drawer`](qiskit.visualization.timeline_drawer "qiskit.visualization.timeline_drawer")(program\[, style, …]) | Generate visualization data for scheduled circuit programs. | +| [`draw`](qiskit.visualization.timeline.draw "qiskit.visualization.timeline.draw")(program\[, style, time\_range, …]) | Generate visualization data for scheduled circuit programs. | ## Single Qubit State Transition Visualizations -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`visualize_transition`](qiskit.visualization.visualize_transition#qiskit.visualization.visualize_transition "qiskit.visualization.visualize_transition")(circuit\[, trace, …]) | Creates animation showing transitions between states of a single qubit by applying quantum gates. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| [`visualize_transition`](qiskit.visualization.visualize_transition "qiskit.visualization.visualize_transition")(circuit\[, trace, …]) | Creates animation showing transitions between states of a single qubit by applying quantum gates. | ## Array/Matrix Visualizations -| | | -| ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| [`array_to_latex`](qiskit.visualization.array_to_latex#qiskit.visualization.array_to_latex "qiskit.visualization.array_to_latex")(array\[, precision, prefix, …]) | Latex representation of a complex numpy array (with dimension 1 or 2) | +| | | +| ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| [`array_to_latex`](qiskit.visualization.array_to_latex "qiskit.visualization.array_to_latex")(array\[, precision, prefix, …]) | Latex representation of a complex numpy array (with dimension 1 or 2) | ## Exceptions -| | | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- | -| [`VisualizationError`](qiskit.visualization.VisualizationError#qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError")(\*message) | For visualization specific errors. | +| | | +| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | +| [`VisualizationError`](qiskit.visualization.VisualizationError "qiskit.visualization.VisualizationError")(\*message) | For visualization specific errors. | diff --git a/public/images/api/qiskit/0.32/qiskit.circuit.random.random_circuit_0_0.png b/public/images/api/qiskit/0.32/qiskit.circuit.random.random_circuit_0_0.png index ad770638279dccf4ff46ed61ab5371f840a78c0f..8d6a8d13cb9f8d424dc362ec4f4815543d4b7385 100644 GIT binary patch literal 6770 zcmchcS6Gu>mxhBhDFOo0t0)N4q!W4(6a?MddLv$Fs@@`IAcjC7x1K&x)`CEAguv_X zHwnPA`7<*e@JABy_!UCi*$UzL+SL-G@fzXc;EZsvHDmLzbak_Jb`s_n<`>~*vq2zS z+@Jyij{o@uerH!}0ScY|pI{LpmnZse5C{p?KMx#8YC0VRLO=UdSwY7ueRJ9yL2Ws8 zyzA`A#cqMm$s2|z!Wd^t^O+s*8`WphdBGdK{H2OsuWrQh?!Ap%m6~TW^TY3W{gV1c zkZ|}-GM+CVJ1Ovf(UForV2h`Srci#8O7SJ>IQEHpLN3)aPxsIbH_ePOf3&f#p2D6w zY8s`>P>8a7e3M=0Ss?;P@#e1T(>Nk_o#*eK-Tdl9X`y%%mB2=&_&pOZg+lT0UUvvZ z0ha=2$O{=FA@-2<|HH2iDXrbWPE*aY&b_eBzl(|4KVC`n7>RT+9G^K@8|xVua6k1} zSXj_+@G9@C-H5r@%_N~?(7Oc}cwijnV*caD4?0qU+`hV;p8VYZapMoZXrzgK`}S?P z6fSplu_6c7)i%HGVhv=Hlar&>MasG|r%>>Z{&2G%9UG&UaA6xr6R%CP7E9~t>s!e1 zoOwNvDr)o-(Id8fh=yCQkLQyzNyG(Qp8fdgpc}^_G>3paG?KvQs`zu_ByrCCs$WfS z3Cd?!V==!BI>6?Yyy-Cvn(^c9!#+*%y|s`RQDHV-bZ!h#5?nPG;ld(*Pb z4l^;)R8a~0hZU`NWb!AtA3m3kWWCs8f+3AprGCOgWkSAB69LB2eJKOCGw}?l7DIx zY632OV5KGl6UBxpqV_c0+}!;cQb}9W_2xn;tK<0zqxWIzZk~o!3oIS!yF3#lw1Rwo z^qaxBBb_sa2wQ%49>S6&+==z`^pjr8r8*sXc?hGpQ#%@+RBexTy}mqlJ40-0NpW)% zIXgQS!5%_01|6?$>ZxjPRp67*3^xY`9{4mG`zkBrWoBl!cXr;`S%{U(MsGw!M$XUp zZZ8#7{lzim|SF)$}4!k|%{*WcfdnIin463lsIQimXN%$l*0 zmf2{C0sl8ZuQ_SIg=_bt?Q63dDbKl0wpml08uuR;!iwp{otQWiBEX@TiJ`X=KBOr* z41ZB*xY+CCg*P!hfBxKRAXPWNxz+TA-)x2q>NAFbUgts{`?ojoA*fJ{?Gi})p5ETO ze0;aQOWY$TBeO!67?<$X5l>wB@otEHVV0%t^W7-RltLn&^1B}z&|5|2!~6x3;I7!G zk4HyGcMc9L`abh9$@o;k`mhXU;+^d#0jHLrI5GN^ zKF@v}^?-+`;sZT3HT7_Xr8;JWzD4F3+m^45WO8b=tDdk^)6^_+yPU8`KkV!XBUMZi zqtS@nN`_wrzOwiBd86d&>RP;ks9j54<0+o-521u9!S^qPH+8{``SaoRW&F4U`?dln1YZg2J;DA^Z$YYsOXQ zvAkQ>LzzqKsKOe{{r!DgOii&?uK6h^Z68q7*oTq0 z_A*ine2`mS^2ofCf|*$ZUhLN*s`uRyqN=k|z0fj*}G&IPnJGkgj zS*Ya1n|H;;XJ$H~S!ifFfsWiMPz%Rc3#BlHC4Xl|;iY6{!HY|~ZYyH-v94wCo9yd~ z|Gk|eQ~LxyQLbzUsyZ2toA~+pWh6=Jzt}y@Efe#cZ1gztVC4Bw%@2P>J5PRcQEP2| zQ0!-4EH#)QP>g3fmrmqS+OZk0tv*KsD=~WN>MGRJ)3bW$12$WSSo>JaCn=dyzulCE z%nF!t`cY9KgbB9E(?|<5DMcFAI{lrj>?)aU@;`r~rj`v7qCfdj+eDMwil)!;mIhdh zkep=^`@^k2U2^PHig!IR-GI1O5crEB8=vvdPbQ5%x9R9?>Xk}IZ0_B^AG$V%#PHQR zO+yLDm~P6es1N|PONY8g9vmQQ95GfK=o&}Eri(rGhQ>yE86OdEZ*OH~5t~z}EzR#q z0&uINzmpgHS=U7`hc$C>R`E={m+jMYu$dWS(L%+LLW!byfiX;W@lGW?6^5q zU1ap*W7~W3{pB?08^iUU&YAv4`i5CJxCC)2DLpMgxb(7q60`y)?Z8pzqXcf0xy&hc zM$@-}w3l@G0|CJx_|riP{{|us63^#wJv26!d}E>*mrY74O?<|yO}CzZJqRzwg#?uW zh5D$ht&ZfRJTfQ1B_vzSiIpu7x$fc0!ZTg$j@OMT9{?G+3@zhPBBJN*ya%^{<1YI-kQoAIkQiV=6R z*;8cwp@0h`9i(JsGdrSa(HqeF-32dw$oOe^j6*2~EEqC6c%ziauMtl0{9O^thb^ht5&x`K2eI<|zT5&OjE|K! z@C*naKQKdO3YXQrXc?F1N&E977Q~yoN~JB3a>eRbIwJYoJd&kAxtK z@3N^&RKn#tySm=D1`{SECqDs*r;#esY9aJyzMY7SMYfg^JYltGl+8BU0 zV*oayRdTfLKd}|6ZZw?`GTx#$`e6{Mxzf}B)%i9J6G_XvW7QF<*VGXsf%t!Zpn~as z%Vh9xYS|lD2EW-K(=LV$+k7f~JRSo;Z%Fo>ccCj5`80tuahdDhJwe3k3mSf-@K)15 zDb|_n4WAv;L)=Q`*x%*O@Crn}jZ_?fjUA9&&!G!y|8_A9jm{4dlCrWDOjO{dS?k-et}M z+m8AV*{A@1)(vn_gETHWnCH&pZ!)< zMcrr;+iGgs^YOmJ@3K}Jv;6#gP4Y)B`yBtUsqDp$((*u>>dIgSupcXsdDOJD^@mD2 zm;R|jZmWjUKLykOwi!NIKVj3jG!U#?5t;eDCn0z7sZX7X;cB6?2qy89IRHwEMc{d$ zZpv9G>=LbtkV-cc7>B-SnY}s^7jwdfCneDW>v)zb5)n*D4qH!3NNAg?woj3C;{+A6 zoR7?$-|b>0EDQa8b$M>ARf%DVFNQZ~q6+mY-8W!>nI5aD5rZwSD?4 zh~N0O^z-LuzMo|v{zI6$EmDkyNp$^I>_!lGql&i_^_ zKYsibWq0}~nEca&YJ=eIw9e3vcRg5)?CnXewA-28Bsg+q7hDLdL zdzbqh+A)aQwFCG4r{t|FC+A!Npq(9Us@vLfFD)&R(h0sLWc3@y*VS|BV|&QUyZBH4 z!EA79Hu~<}4X{<4@$a`Gm*>YTl|!;QdZi}rQ(-DO`EP{igf^<0^f;}Ber^kUI5y4T z_?=wfUyUA?LyI?H1WI{rKGTkN*zVGKu_wAr5!3yy%uvtahbE2vTCaLwz(kP`o;EQI6ziY->W~j^h%6cO$C2v zz&P*UzfD84JbD&lZctounrnQ8awn-@kWnJsq#@1L!HScGwf>#i*MiVfA|w)!CN2V$(Q*(Z{$~#5}fBhFJx_kJuM^zFFQM1!flxpc)I(^HOx4C z`giP|hcJlF=}p;26ZlFXmnwEoyYIhf6Ev(j?i&++JFSF%dp%r`LrRNZKSUUAYP?-Y z5p{p}d9$TYlr}Jm0kJlU|5l*+Vsx(Vl?J;<+hB&&=ER1Blecmn%5Jjm4acKLkDg^p zrvUt?q^55F#H|g)tR^U6Zbot8>r)$1VbS4k^1Fwqep>!JR8+Wsc2Z0KVML%>bpe;q z`1tsmT?cE|J`SO`-@iWq-K!;94A^ycPL3_Mu3S+!;^(lB{4WZLlv|D(b02qf}ZJNKYO-2SDtiT`$XpT{_D>UsUd(4rs6C^ z@Vj7>N3q8$E?*CcWc}{u6(q6rPsP~~E_3Dngn8xz?7@-aA)Sb7Y zSpy4eBO4=jRSie4p+m9LT9z2Bsu(0Lu{LGFI-t4EWjj9Bb{>sA3UHgS|8_4rTib#a zxf!d4$Q-`+YK^Cz)lw*hPRgTb)KVuql?^lkg{Thi!%dr3G$Ll5P#)Rc#3Wgbrm@J? z3&`zo4wmoSi$c{*m#yqrg<-{~j{?x*8&6_bU!NnEhkKq4CZ*3^4z29JC{4N7aWN3# z%cWZVvvWv!fC43VMCo{ML5Ye7rJRTSQb7&RHZgD-G44^`Fk7#jLB zx~#r`HvcQZaa(TsnkI0~E--v+gZYU=U1q0A6CUB?ox)v*%gu0#Tgi5se2J9PHBy)+ zlOS0qx>=^{^l|>!$z^;ICzag}MG*!**%=&EjY5a5rR&8_%=xc*bLmD^`f=jo0=~f!gFdHj2yszy_F#T17>O@l6R!TarbINvlnw zCxPS`vrDmHX^)PyBdibO{XMFfy8xD zNt}PbzmE*9tL&!xuR$I1GYYgz2>fO@q=9l91uH9j#Zr@o8i!(HnZF)g^1FtE(gJ0J zHe4eParqY!d8cr}4TxHPNmBhasmGP9rvBd^{OL;gpNW9}_^Z-;GBB0c8P|T!ZTyi! zEF~ocyrsB(yY*yu;f}Y9yD^x^eTa*rkd{t&BT*)*-~rXTGpa7|=3w<@)9ErJXsCZz zSVoOn5(Raby}mfvb->oeQ*mj&(9-(lyWNOH=#$-IhJFG9fGmc;Dx%+)yf$oaXih2za-WpTs9FEHm~j#DmY2ew=~ zq@0y0o^n`)i1Pl|1CYQqRN~Q`W4cxphpRFy7&QF5J8k5`j#DC2wa%poNyUz-(9rpn zvE*#G<`;-9TEp|=(x|~pMXi+>-7q>G>A#b@(g>&zV(V35>ZKpU7(Z`S0je$pPhYg( zN;pU5!(D*2T$x^qYpx-^wjvBHEMJi2o;eKX_c@i(bT_|#{pz7=3Wh-;AtB?28MTqb zB)PuGRfcnsBd7K@+yfgC1|(`O9IVFqEcq>ZfaUH0x@f~V zH*08Wk`WOR0nyu^vMmjWu+_mk$Ji2-|>#B(HrJp5gQa+F3jM>@7=qHS2_9Y$&;JfdC&6E z45F~pfue-sENgSIH2P0d+9OJ~Urj8R^z<9nan+)e93A~XLPxfn_=#alzXyw$ntt!I zV$LCQ@I0hUbZqdLrCuCI1+?y!nFW07b`h*FB)QH}cIE@!+1r^T*>AdTK3wivW!Y0} z(~VT@o}#sltl$GaMN$U&IDj*|VB~n4nmVMmRvdU67&4-{F})X1+Cr3?+A$uo2#%G! zyG>T^50(5|%Dsx%x-R@aW=nr1Pn^jD{Rr)%@UGpLwfO!}H_L!U+AHp#2AhGQH(k=r z22;a#dU^_ox6%$(z>w6q+wI97a&91Dtyp}PfA;P-IQJWHIQ(c6qiXtRJFDPZZZ7w$ zM2cT19baV_3>F5?QyZyi33ym@dZL4pL!cBZzY_D3bZxdTA491)o?#c;9dLQ5$4k@a z2q*QDLVi9c_wTw=nw_3F3ZZb5 zI=KM9#-eMph_r;jz2OB7At{Ri*%PK*Em literal 5431 zcmcJTXHb)0o5my31pR{&5TvX0-a9Cu6sgjC2a(=_bWxgyA|jxGV3ejbsi8xpNmp8c z5Q;QI2njWz#eJOJdB5!J&d%(-A5!Mblbri`&V8=ycbyj|MmksMZqR{1peuU1+7CgX z3sk`Oa$0KO9piS&416es-m?xh3-AmLcM0|Y8M=f9`UZshdb{#KJc2{K1N>#gWyEDg zc^-v^28Jk0NcjEh0`Y)gF9}BTkyhYOE(Pk^gn&TwOn+Y&KzRkMAP~4%Py4RdR=!;gHN3S-mr@+ipYJIIm{ntvei^rjS??pQW&Z>2A832&Samh4I{^{u;Op13ii+?!Y5ylT)c>oLE8GeD(}av*Me>#C zFlyh%9|-Q7-##FT9|9BzlSLWqNt!FvkS&h(`s**%lehBv$FJuq$0k7%Olu{NEOo4P zPfOt>>PD=j@9dT9;z~}$gNWG%8oG>bAu>ZRw&+KXd>7g zU&V5igV@b-ZdCNdpN54m5K9+s>iAWgm|luFUD=7R_O5B%=^#2{r{n4QEsw$7A z&X@wlpl45?f`0w__50^18naRZm!UU8zH@bnG~CgQ8X6jVdwVIVsqWaBsr7i~7!`^ps;g#_m`S2iDymw$AgoqB$ z%FEN&)~4);B5v#saF>1j_-ty*Twh;*wk5vGvf_Lq9Uu2NEStCs6~k{f-Hb&-dUfd{3lr+0xzPA)q`{Ul{!!T$B@*X{N$ZtTRToC7$0h>CqV zB5T~(ZMa@)7IIV4968RA+abir4zBI?K0=@q}h8skkAK3gle&o&3$a%h8i ztPf@Hh{7ERgN2$lHf(%+e5!ljZ>1HAh>7v3s~2{6-vN1!7mmIWGJC5ME>1;7Wl*U4 z?vqZ&1WYTLh3Hb-44IL*xkF>%*glPk%=KkF>DVby!NFpQ;Ts#~R~e^T$U$h+qzzf( zS+)+Je0y!?J2!rNudvbKp`nk!qPOq%v$vmYRaDJy4BgQ+HZB9kwwJn!UN8wr2QJ?M z9(StW-u}J=S!Km%TkO2=akoGeorgzyy<2NI-d|KBj;sna;h|P?O&2*2hl0!a%!q>S zr*r55Eo9f^yX%X%b9g*iWjpR)Q*xqNl3(FH;#mPPZj;;bzTUmGRFs-}8B`d#_1V&I z(wwJ2Eh=YkFL*CIDb*}=WKH! zV)K1klcAp8PnRJ)$z4!eM@Qxf!MU!!z6Dd7-@Kkm zDB@7JuCkn|veSumvF$lS`x z%+~hh^kY9++3exyx-t+WJ3H!;zjJ>o+htbCr|Fz36zMMg<))vk8y{PoYp(*`plfJ& zcz+O7d?g8CN9dKJ08mG=nr2=*_rEU#=nSxThUSNvLSYG0* z=)Z@&#sLYO$s->Ka>-rK z{tULAk$#2|;<&#J3fE*$iBnQieg(h?P(n5ph$t}A+S(d`JLESmJxQ6bUUfGIty(t+ z@&fXlkd##CjGzF7^ZUq1B|`#WNTtR_JDGVgt!0vcI0lD=*t9>98XO!1gTa5zQdn4+ z)F%OPi-0grO-&KjvW)jeWX4TwY~~)JiA!-sB@c367Zi-VWENqS_hl8a zs_u2IeU+a-3~Z8?P|Rzct)n>;>o$m3g;fo|ghU2lXrPB?X2-ujWqcnUa@)-g&9A&@T7%ByVr~PE1T}U4$6{NOXyo z)|s%30G(|pbn(i|vs6qEog892Oof+!^KC0G>?yPG#C5r)Bdow2z7f`L@E&A#Ac1~- zdWvfyWL)iR+e>40p(P}hU7^|{9+WG<{QTK7#o#sC*w|QLu^3rde{Z~$*dH_z6cPDU zT%0hNC7=*l-O%ucL?WGB7ZMXogD=JAOS$#iPpgZvKpzBjoGgvq6L9gT=~TSJspTJh zOs+XR+QX`RRnZe_LywIl7ac@a8KQ4=7VSg^yhm4`G3Wsm1C`Kpf4m1J0c&A#!Un`3izU@r!8dSn^o}&|7J+p6{8rUZkfVJ&G}` zwYAf*h?B#%=J#zOUple28BcFx`!l$W@rxZwp}!dc0*S6@YLR9vHF~e_;lT%G5uE>W^s_*#ebsfIJ+#{^Bh#}PGjhD z@qcUsvL=#Ls^(m4_s%Av?T$WX@FaX$+oGKpTqL;}ps$M@A#`JrE@BeZ&s|j{e?=x|^Gkp@|K5(@(8t z{18DC(_QHwEjoCDIFh!JHQaJ?a?vN4GO@qjyEPRvZ5JKguA=YX>&2kg-``*7G0fsN zm&zu?D(MUY0N~)Eg%~}CHsg$OQ53=v+c2%1Lqpw-lX_JM;*2IR8?$fI)`ve>#!?H2 z+*`W5%EX~ja>y06EhWlA4@@*#y^6<=1Ksz!+dPeFS*I4p5_+1Xbd*M$1*3-^5?{N{V`4-R-XSq1MiQ7)q#wV&G+FGU2$>0 zR#zhqe(H2Myl&QWbmZFI-95mea#K@N<%1BgWbW9v0NkIQqxZuE=@R)#r>FY|lg9gV zUPZe=-l>l{g^*8>U6E~~LACSqw$jql)^LALKxcoAypw6)8xmO*AN~x8hnczgTGJ6T zo#Eg7rj`5;6-O=$x3oKLNlA%gwZ47T*RQWqQfR3!vx2%SZR(%k8jU;7`dm!cX6IH^wV$}&DYE%6C15SCdc}J?qfRy+nP8yj27!< zJt3_mw*dRK!yz4H2~CvhVIu8e0|ftUxu5Te;B(``u0g4;ohZan1-GGhW^CDCLepE^zpuqR(o>oU$_{(hOU0aoUSndi`RW`GAI_xq$8e1`n+}QrjlMbX=2G}F z9(k55A}l=go9#_b&NVhROr0`&owcZezA?MNbM?hRYIDon=H$bqNio&RKKZ17IQ4-zbb5rl=sf+!VgXPF@v3^*k5^+0 zQN-V#MGOq|d@1(kScZr=NfS4-ExU@g4slyiAbyi9g{{PBAH zrO%XZ%^b7{N zC0fa#GQW{RwS1sseC63QGc(;iJX#v=Lmj%-t=7|sbYJIufqEVRh5;XLS-}Y}4kV4D zu-r6M5NGo9tl#r|vrvo1?S(|Bs8eI1jD;6A7p)}yqAgZ(3Toj{TKLUEF|72ZL*MCF z6poIPTS^tyB}M(`r^BacWk!%P6_s>Ev_6nUca}EOGxZ!RzfWywxd1w`5clUC2n9^Q zAwXB`Iq9$_4wnFDVGVm}l$pPoc@8=qQuESuk!(p${y!E~>+Vf5FC^N+x>eT=?E3@xvHvTBg?Sb1BfGq=h4kxf8=n+y(n9iXu|usv*br(C^d-4Q7V9z0OlLF3+avS3Irr0!W?flk4U4Xi;R zI!oYBl$jCuM9KG0B=Ao?=-SO78(&0Fs9S&s$lNW+&&M~&2YFjG#3LXO>3a`)33^HC zqUhbAAiqEjd3n_T{e?@u0iN=lwmpr&MOgfd?E^uelRU?NbfDaPeh^5D3ud5a8$r&s=S5laNTgVkT;Q-QYH}BpsJn;w$py6IOouM7rxfKH(Rd?;*dHF&m$J9`aR! zA2Vcxw<=1L7PYy;Z46eDj7?Q|X7%Js&Qr6htqvEf%hR3u>(T?uALKMJXrcZCU%m%5i zXcbJpqaW2s-dsslI(1VN`2vfBkg_&ou(iZot{-f$5fg_C^XFmoua@;;ffA(bAcq-7 zv~cz&J!}j7)R5p)9T998=eQ)reRw=v4zJdGS`{ylsdTt#$%${iGJ`!Tsr`wjP<6DzakfbEjwF*sf z(ESFv{|xp8t%4cBs&qxkBPhWmA?ELlJ|eoh?E4W9bXjxg*b<5?!4`DGOoxn#^bGrq z?<8NYYJ&Pe&{$}U|Cs zR8oUu^IQTaT&|$n8Pb&)w;Ahj z7;X9afcCrf`XwkjRm|8A<>i`zqKiFCXQ-jXRf!gs2MpUNl1CA}%88K6xJQNLOkhK zv+=<`p*dJo%+r`^iKL_vp+Z}G@*X59ag~Y3@J;jy7eP&Ww*!!VYkOB;);rpCAov_;Wx*+MbKX>y^<#YI)`p&vP*)y3DB=Ujf@YHso zbuofqOSU4y(N8}8^vxUlh)$-f$=nnWOKq^y=W&lc>0ZPL8UeQ{L(?}sVH+`vu_B=8 zj7`4w^-ov-9QMI)c_O4bkVidgyHO{$wcMPC=5L?QN)asM|A{|1hoJRGtvsJrI#Wc@ zJPxgt|DwsLFnL<-6t#E2U$Bhs{}pv}G6iMWKg17l)nT06#%53)6LjGL*EW;h$D7Wp z9EgysCIvRkj=X^*@qaB&6f)@0HCHzZ`^96b&B{ZC^q41~M;zq8Na%64Bzq7C;)*&Q zSu|4%o@P+aC04}-0FV!c-6zz&AQ=c zS?9W8Q0m8

3fhy-yIOaT;Jd$Y56$-=e_U&E}eibgQ7A9>%v+7cjwO=U!#(kZsAM z#cGS8mV4FjZ#?DzsgiS_e(Q@ph>cu$J&?`xv4A+k66w=%b?%ZrqT>F7v&Hs=z!{!q z+kk3ea6aP$=!^>=W~`KjkX)RXKYNvUh@g$+u7`qCKrd^A?qbI^!arM>h-1cG319{yu% zp=5F@wyb95 zIPTRU(-vozL$^m68aKW{>Db~nAHl{En#uPZHniy8*^|$=5AwL0wjVC)avf4vYO5vY zEr~m5mD|hAKZN3RC!sbgf1_;{nvMCnTGAB`DrT&y14K&*TyTfEU4CneMI7z$G~~2c z#J7jM-xKau)|A~`WucCrA0mc;C2C8(0&A+L ztpj;TCNo7`1owio@t2t$x8Yt%Lr!6~4HoaxBO4n}S$%<~ z&`%nfPut~?!M9tYrL_3jC99;`DNG+95zU~BZzN8q=Px-Abp{LTBSIo$w{`{VBCBp- zUTS5+_m>M5i@3c68_tR1hJp8*q-a%tX<#MYAjim7Bg}obvIsQ^ZS^bk?(1;7= z`J8n*P6Lxc& zvzTeHHw6g9jp6WGac0b<{5@LBtL5;A7c1-<*8XlEIxW~h?@TPRP_^+ZVw({ChrcLa z4zGG$|DE;MRaEc{8U2*=Y=99fK%;--R+mDKla6_6VinD z5+XZmV(n>c4QD&9sYUvyQ*>`XmT0l0_cecWkfdO~)E}w8PF>{o5s}>2Wp^yo4_tvz zuecgN^!o8*G{s+erlsO6v(1{scv!m<;S9&i^q5tyVNdUZqx85(GYgsTGiSsyAO+)E zQEm6JVHl2PrGIfB$ffY1$8IQtLsH_MQ10!BM}C_t>$#Hh=NXccP2WwF#C_~_sY0&G z#bH0>m5yf7F?~L)a+g$VOo5C>!Tb=5cT|1JEe3uL?mV_96Ij|T-MzabY@k};rHtE- zW~trH*9Q=?BKnzADQ+wriLF}vgpy#6mrCyoVrHaSADKzJESZv9R1|PE%m$&KvlE?6 z)YyDv77aN##P?s8j0ub9mxkR4c1I^ObmWblX;4LPit9i5d(K|9zD-{5XBr}pqZxsC zD}~?DN1K!1#wOfO#g=b9CosY6UwP{d+rL$;8-77BJXiKbnBn$gZ;8*+D zvtsscM4Xr=O>ku4n4_q?O<6rEBStt|UKf!l=j|20cxI5I0&dO3?~Bb}qQ;#r`N+|; zgr%%oU@P-IPk1a1p+057%itI0XcgjQOVxoa^3zjt`A(Qht(2rX?K(KeOIvBjtm?D~ zkBO9rBKq(xQ@Gsbwf=9_K}j37qm_GC+waa?yXjfG@;kannY z+eQt&b*X*R7q-;N`^HjN%!fV9^x?7~b^C55`@2nq=5Wu7`MkS>Lg`D;)z8CI98X%+ zj$DM?$H?k8DPEAEE{ zOOz}hOjwhpPT~)8>gL*dDH+%a=2vSiJxeQK6i^pT$3;D0=7-GR;@K^V-<~ze^Ye;a*sP#-poJR^? zr*ur9e83+FNI?%oTg|0s7QPi&*~Ny>We;W=DH=DphAqB7hR{3+(zTlY zB9Wl(w)ne3V8e*nQ8JyT?3-#`raJy4uHozXg6Q03L9_^4r2nBk!92#<%ku(j#fd7( zGe!5a2R*u%B_LhP3_gX!~?zHd^L1ks{74o&sSwb<2t%6q}Me_B}W1`-$eSJ%&=7 zk?LaayT5Co;^XyXbWXau2@W0jHdX8R?6SOkb;WVp+1PhGFq2D@R2b2ixC z5zhUVVptHJwS3|sTaBIY4X%=+tCnNm2jW`hVd%z-<9^hWcH(an4#I>+n}#Llc^{r$ zMTIXKjJqRLN(s$8^8&N;c&TfeM{MIx)FaFoIZkIuZxm&NMM2xqreykV>)qBXcdIgt9?si0Z<6A6_tDBDq zg8B36G|3JHeCHP^!{#lf z>RGEZQl*3Q3Cq(GBGHPmq8}-3rA`b?w;U%gIu;+i>*!IjtP2*L_@(8^rIZF6`z+7c zYFk!~e(_`CM8n8yxy9{-%s2^Qm|m$qO3_5?B82#Dt;K;Kb&J^*v3i`)NX9ycx8>Up z_s=#2zmhArfchlS+*M808jHmhaW!FFhH7n+W_iNNwVt=f3Qvt58mB6p8FDEmypOYu zfKBbF5+fYl#1mijUfg!!03TVX6_;BR&iZk$Iej2JWdU#4eP5J#h`;O99$Ltxg<0RY ziLos^OVHVz_C5HsH6c=4!_}2HHqB~8o;2#i)^f;5DAauAof?)|x?luKAeTSb)<|I*j|0@HS1h6brlnUYdl zk`XF6p@hC{_ow|?n8r0pX%ltQd`9X zF3wPt)WxVW2)=>Q#~$W=4%xTYKR{!D960Y?E4#ezg`Woz7V=-pv^R1sn25 z1`!4PAOg{%av43WLN44YHj1#hyR@C$h(edrIXaNW%t-HUJl&cmQ0gs8ybX`LplfJJ zRRBKtU!L=tm6leXH;_e5a;zEw58jp*RF3tOfC!Ni!Lud~7w73bFnA}zJqh2|ubm1ABU9Ag=7)w7gDru4b?)L$%Pv`4vD{o64eg)U%K*T(` z#HVq-G;{Tx#oiEsQiKZ58~R(ZIEWs}+H$c+@%E>j_i32%ZQc2uyA^(PE4M%8u)e`v z_jhl>UKIv%E1&-HC+TpErJ5JE{WLVsdSKEnF41xv@_kW2|2a`}dNwaMy~oF5*gQ`X zZmkAe2fN;CCp3*&9s0?v-9o6q$=4Xl!rb<^!lC01WH%y5%vFfFgwN1;mT2jrO@?6F zU@J!M%fiSDy+@-DHhw+rmV5gh?ch82?PdJT)hBGQYMd9G+^_7tXC)zfgZAZd^OL{B zrerXJ|UOx_EelsS9h~-ajyv9_ECaQ2q<|jo3 zH~(hUce(m%`T6#tm#gn%v4Ib9+Pz;%ONy@kKAP2$z|??X?_Ex;g|>%Vo*}qS?7xdw z8VGMKXwWniO=O>9Z+7*z+^)>14vfUN8Rt;S8q)1n)GU}3T!}GGwP2w6;3{5eqLa@Z zOK*WMJQp&wGW2Jw>lFYX)lA6?D+sI6+R}+cG@fDmQk`%N#@WEwXq&6Oil*Ei^1}sL zx?y&XH6>N)Lh_}`r=6LL*%t(dX}tQ>3*N>B-miuDQp!MVXD@$xYpZV2CGBUDj1ihl zm@wAihNL4b#y#n$C6cVvpa%-=Yuk3zfj_z8_Ib8p4*O>KDeksGC8`4K>TPV4pr57T zUh;GhNX}`)=UHiz7Re_Q`<2=A;2D)|)>MPzodr2Fu8K1C3?4<-lZ}6vI{hbRwD$qb zk}FwGfvN;`JSB=$6g$`FMGb=HO*sM*my;?0pK^ODWW9Lsx3=rU$C%y~||W*^x!Go~yiDQ1La@kLQJT4n;YbczkVdD-tF#u+_StM`aeG2qu1 z1IJuJ7S}u!0d}!%wlGMy5CZQ;GoLBA{>j5^XHjkD1-F6>v?N=G%i3IsPVnS@cTY`i zBdLSP^mFSS&$bb+HDy|@x@1ZG_;x)@Lph$c8n;APyG)+uja8|&wAEM0b^25C?}Zdz zgJsrJZlS+LaYzV>Ba^Y}rrDRO|9kEr+{VRIL;W!Q`bS+75 zN2f=UtxzXYq%o3&E4PNkT(DXATg3&uatiRuq%4`44q!G1qW-<%C3rwStvGKZT*a~C zmzu>>GP`#nN*2Cw5=lZF7-1niU1;$nAx)JbmC%*%wvJg&lCopQ{XrFpU3~^#9E~az z;So7m>yjI>Wk2aqvvhn$Fmi01_WY+s_RKrPt(bIK6wHCu2`ng!v`?gn&$Gg0W8Kg$ zSwUX^&m>)jW%AOCoS)NfLn2Z-LR1(5wg+KIbpgq6(O9bT;L`S8K=hCIH}s}!l$aoB z?=ae+X8VEOL!vo?(9=`MbPp`~6(^%^VPq3BJJzGzCs9tW!J1|+AZM2cG4S}XC;eHD z_b@mhAUF9Ie&6}x(f;rKft6`5S#I639A*dUoOkVB(aMv9Q(VZ!alt)qL>*!w@sYz` zbst^orXE#_$WFvnIr9~;=gT6Cw!_uLUf|8helW{U!s?57`%Hly%Ur0ZMFpx;DAcS$ zdv~t5oB)KVRMuPTc7~*`obF3*;B3Xr_?k=^x-*v8?FzZdLq1mqH&TG|+8Nk}H>DEq z4qtw7GEA7CRqLTAFe%9|gbdb6$pl?jgnN(AMZZg8lvY`V$sU5_9qZi-F&J|wjudl? z?v@e`<*vC$-v-5nV#bW@NwWnhBjr=Y}Q`D37F<( zBh}h)6-`RvxolwABKnuT3%$7?84H*hvt2&*E;DtTe%PE1-4W!f3loPVG0+k`{sn(% zVTt<33l`OVOvCg#ka;EOxQYqdMeIxVBq$k*^LW$S$GkVoWP1P9_8UxOS-+0wfsqnA z9{K4RS2^LLIysJo#~KCo>@~aS+h8l5paiql^t=s>N<;2>p<-+ogZ;06Nx8D472?*k z{Va^sg$QxB%kwZ{3lLX`PvysIP}u#zZd1F}h!A`Djxp63%H!s{rI{9#t%LBB=6WcTs=KjR`3*9@8@jR zay@h9D>|6Z`H4#0UJVuBq3nlTvHyG+dn^zegZuDrCHE&v%+;uce z<;=lCi2Vo^p&TZsOY<`A9Mju~$Rhj^))1=bG1RnJ(`1cmS|&K&-nq)5o#9Y+F=!z+ z;9E{&7sPD-HSx}uem)_iZ%;WGE+w_j1-T|;%;^F4{T_Q{&MYi6O~1N`YrT z`sbs+k$Q1TVfYDuO2Wfy>*g;p8hvKv)`F3{@2@6LOOT6_6*)*cAMfU46&aYq`Pb}S zjUG1Nl{t`*cWAjEe0v9|!WQpU_8(EJ?u#2Gn>CbN8|q9vo9-~%y0>E5;BoB%4xLox z&>%CUa`*Z{o82;}m2U>V=#3OlSLsq$YTj^@T78vqrpt-K%ebAYOun;q>V7OS*aAok zn;@N8=B9Cp9PDJQE}cjk5b1|+_I&{90?@B%<2(B)z#$v9rXeGu@4$0;zaDlsuD>#m z)nw7A(q@sKOT{bd?d{n8j0&L^-UO)eaaN+=M*Syv#X`ecj+fxwseD3gPRLmMxQ2cb z3lnkT4&rOiQaDx8H2{A~6=!eNb06|Af}a4A{a5&VR!F4X4q9uu$+qi1887+pPs2`U zvb{$hc;6oX-*x-3(9qCzmH)(CGo;;uvRK0=i`j^Y@*T+wN0G8IPrCyvadral*?!|KJd%ryS)h!%f zg44xR69TqsME?u9F{8rei|_!!vPaTQ8$JYEWCSdQyZ$2wJId-dCg~V+xEpN2k0H*>o572My`+Fk>LsTl%!);wt7?>7NnGU}-8ZMS8CSudIxZ z#5)X?c1sNglW4TN0wPJJ>7p| z8hD{;qX+lvyL!O&r(XrgmPs3{U7a* zcQov-WeIixrQkg8SsN+iOp6ouK$BwgH{#fgr2g8$PCyvr1@)hG-10>@8g#PE&x!#H zsKb`vnWcUz{Ez~ zLs;gHk83(HxmiPk%G@`esMj7Ybvt$oboxR)i8k#8BIj>I%A=!|3 ziPv2-^bdPXmqh3Eahrq9;)#mcXmO8&he?9!mxr<-MifLI${MxxJ<#%Yc$TfCtZ90Bkp)^YGcp2E+iOD( zjcsA>-OzZ5owE=f2p=}i%mU$ng)9YrOP5}8e(NhU`^GeJ1EEq@QE-a6d@hUA5T8jT z8vsc%5_;mpAC2Szy3^{YY$bcLJ}d!JkRL$ul#okRxIp6J zK6SJqXYx+L$?qqztMjsAh5VlYc?BC4#^XkEy${d66D|CffYBasEDi@7c6PkwgEi9e z-$QWxn)9Q@4%lITk4K~@z;2!0X8g_AeHZGLArTle_>Ae(u>ab#ktbT0o!)i ze1jqJo(isoPR2WP$m49)e=S3t&)Q$~Xfg%^C`3v5zcTc~LJmRK8V|D;>lezg3e@t)0$yim8h z&aRgD^FGi}=zKaCRk z)4WU*DlGHW6yFF^YnoO}8p81{JJ@SOdr*w=Sb^to&Xx={1Qrc)VOjyD;+5SN3SmKw zXX5)S<68b~Kn~tw;Y3Xq>yiZbrU(-U_6L01g;)ssNoNQzeL_rj?369m1Z|PEY3Sn} zkL|ew0V0Fr+6u~-(SAqkh<;m@8sKW_sA+H(^q~6flLWNPwehoYulHV!*0P@Cd3fWz zpzZ9Au29+4W4+Cf0-D;m`lo>e=L}mGXr36dGA=^UY!Ja!FEe47oUSd@DXn_2%)jxi zhyD$4DUUbyaKcVm3<-THpd3Ao7xA!s;Rt;5Y{hXH0}6mKE+}GSUQNFsD{amdA)Rv@j&!REcd=>R!4=ET`BMf0)Xoua=lb z8`MvGt+=AqiB*un=VoBa)0jO7%EUN?!UZ%-X^P7CC9R=%%#eQ%_h)s>hR1-O*apR+ zv+Y_zLS9NLj32zQJFfU!OqSAW6_h#)lHwUwcq__qCkkD>+o7Z#OAYE%)c~XegE_)|9tW{0$njH znvfQR!-oIaprKm}ikG#<@_^k~+{nE&sUKf{@UZM?E8>_=v&ZR*S6cT>I>F}N2&idG zGOARsCj`Id9tFIYe zU*7%Pohi$MTC9HSk}P6$M1Cz%&Lwd0*{o6(z%hdw_5s*8?wzF+fK%pqnWm53@jyB> zc)=@B-(K8S{Z(=xtRJy|>Aqdb^DwA+Za-ci4 z`cH%68hEYg=InJU{hx^M7CJ1M(`pbSR4SW#UqMl(Qr7G7j7?+!LjE%D?3L;VbFTW_ z96#GcYGvBUU>vh&y)XL`$9JGs{u#TeN|#=YdWRuBcZAkfd42WIS1IEuT|P?S^f@a( zze;o`&hGm40Z)J=msYJqSZ1_Sr5OG53B^kTG_%?A)bx$f3)UixYznySgvR%P1eY4M zRTeL6F5}aU#)ZmG{fjL^-k6vE!`lEudMN1Wa5+T@X=As;%QAC}_B@IRv-TU!mSiQ^ zt<=q~?n;iWd`7{uQzBiIJHi7o;-^PXg(+IB%FarsWGHcua^wI^2SzdfAr;0Tga-0V zV?i=!7yTlAADu{z40PDA*(Pn1x$ca@6*71GjsYLt)&)Veqsw{^8Ge|}Kv_D4YQe2+ zu86M^6K10m3}UZsS@aJc`w_@jsAX|JW-WiE;f&-Ja+-xlZ@zjtK`8XQ;t*}FI7Ko` z{#L72gN3YznSGnhVbjgSmgVpe{>V2R%h6n6kEv?}`qa&<=VgAuR_<4oFllg!)E0Gpw|0q?yjv&S(8Y&MkMn+h&`-=Pd&9bwX;+b`zW zx@ZE_K>uNgsYOiq7bxlo_16=2gDV957ju{@6Mmbs698f>TIcN3gp5XI#x4NR?pVJm zQ4yusY)Ff3I9)W>*Rz=KJbdBf0l>ZJDJ~Uv5a*OBVX*+1VrKf>LMM3RjMna1ztajg z$=<{i(voHp?Jd{5@!KzkyXjowhFA*umobP((#-f`k$ND)s{rUI{#BTt$x}cR8g5v) zn&Jpe+YE;tNzWIkj~|`?q13a3AUwu6gC9H=g$uCdo2SZra409cQj210Z!`pg#pXNz zhbg|~yqq`L<^2NGQj|rt0xXmg~d@{-!FMlWs);SinCe}_*wIcgZ_pT zegb(IH7Zi6B(GU7R`YcgFi!dN({CyFb$9aFRuW zu77Da3F?+hlfjHhK=bhPrFklQAprE^3O2s{>uT%_KoDrB^<;uVL{{u;ZKacDnQiv; z)N4Zp%aSex{E|l2V;`e=J5fK7BatR(SZ+p$`D3kqT3O6d)$Trn`iPdzYvat`S7o;I zYA_p?i1Axhxsy_Vfd$F>Kp@9q!0t!b<+MZbMGgrw7xa4oNpOD+or>H7#KTkCqu*Gf zwI7<+2;sgpnBgQQ|K|j;H4bn=(WRKNhq;R?;AEzi-hq3CclYk05vKRAky&Atkd_?W zKnf?=Y}~}*{QO;@OEZAUGBbU3=9h0vu0y;B1Eh){OYXf)<)y}qTFj)r4JXd{XOn*u zA>q5g2<}Mx{d#}0ZnQ^O8Fwb`gB{s_VTwNLN~!_Pq!78cL;Mk!E~hFwCm)?#=Knlh zMo53Vexx%*=KKzl7)Gs)^LV`JN#1gH2IO{ z4?Vo50{qagwn2JiC*N{XjfmeXmx8eWU&7%tEHjj7B;1WH^8$k(#WD*e%|~N#;@ZcXAp_ z{X``g6UN?4az(3UPrrFZjXE?MZ#gvd_w;e2Yawu=CcKxi117-3^zbQH);>r9$4BzX zz@R)3j&!&fvrd+sSIg0vc)Ggxn1ZabvX-?V4~RJ$jf3Pvyx~F6&&vN4!{1drDb9tL`a|*DOc=xNBjVmB`Cef;q&WDTKo)< zQvOVLmQfI-+)S@?8bNm}P;1l=<%C!B8B?9FLOFmcuj;RIX1$Gd&4jFFUU=zp8Mpp{ z{HG_YOdY?Ff}>~!IT33J{IckL*?I)klIR^bxBI5fu=sC;>&>OrdGw+B@Qz$vu#d0q z!%toQ`Rp%@(;h&-@F+MS5%R-9mq#>8Fv~o}%OkczptqdcSBCHhgs^2OQ4DQy!lm57 zcl1P#8)C0>cS^#T$H1>Q@3Y&^3WE`VR+zrg$~?gvkVszs3rIn|XiRgkxCpYJri6aA z)?{r2s1<;-4u#>r#ZtVF1nT76qW9oL)42WI$WnNJ$bWN7i2^#jTDl{t*5{&fltM#? z(^2NPQ`L6Ol6v>(`~Wn6EE5Y_5RWIT8wTSx#-;#_6-eU!pf1e#fG`xVcZ@qxi(0W0 zEZ#{sxat!J56o>l&l;j>4EH3BUrnY4fff3DT+l&h>lA1|c%gYBzE&`{fHNPYMQ-_u zL-E-a4q>AVE!EMsDplH%~6Pol{Kv9Al##emca zZTirY%n(A)%R`G2&VKvney_r1oM(@Z%Jn^FGjk~q#1>|3I(!cxLwnzb>BM1IW9V6= z=Lz6m2=nlsK47+d4?9+W-EJLJA1l8z0H|&;{qyPa3Ny2DsxmHYhu2T2js4oJOob_Gax&B zj&r|a$8%YOloD(qx#TGVzL>Uo4yySIGgW@Usl%2n=?lQb68RO+A2-PN`ywXOy_%+z zHMze!%E7x|B{B(S0q&O1$fRevHNHUaStC%k9KH66cBk4xc|OF`)EAopOY+51Kdn@w z?;+L%xr`+M!W5A{;-6(#F(?5<{NML-$H{N6e;FuCp7&H_3}qF$9TR#0T^;<;DoW;t z1ejzx3}pe2{R;KgQzh-WEz52pOZgW9;6SlBxBM>m+a3q3ry;Hq6I}^|snE0_RzHq4 z7;HNB7Fd%DeF?Cq=yYLsXPe@%JtFjza`QL!@rO{-u1+;}qJAnP6R%tKk0R$Ox*JxY z`n0#qE*7cQu9-(X9(awdVQvg3Z3MV-xW2?xdmQ$z%=HTm(R}Rf#h?>DstC_jWrC(g0R4>OU@2qoj_+-SR)*sb>iO&vI5L6 zksYmpFB)@l<@@TcaacY7&3UGe>K0GG9ak{`N}sc)in@NRsK3f=gfL@}1O>iA3apj! zXNrJ)t{4lRcLnGu*cbdUCi3T-&z79MmneyKzsDNLWfnR-(x%C__{8$e??9(kPACYS zR39ST?SExEzCQES1_i{4K$^mtYd~j=D_aIOb#t9c!%Jv%^vC@*p^rL`yx&ZyA2(Jm zs{HDWD&r)C*MJSd*-F!<0QMqvd^CrjJl>z5a|Ho@B=M5>=YuR(A7hbx)2sM>V33uXhB5$6Cy$o8AIE{7RdXK=j1Lm=FOo;_X3fXweIC`QrAtAhlZeQ%1o z**pv=R4EY|F-)x5joJepF{xd!+{cbtml(xV$Iv-M(7uIH^#wy?M#!;p&brY|C^ZIAna#=qZMjiiewzJxblSwNK|~2)mf95=w`VY_NfQ)@~oN zQdOwfhmAm%)wRYNPxjQ%*HlVtmMk3T{3Y0zD)$*mz~1*7{DXTU9#i8klCxt{^}q+m zIVbAfMvrC9vzw=)B+=7Bq9+o5<>_PcJ#%f#-)b0jZ2kL`6JQuj;fepKw6tl5EyIC&MbA~}1Z{>W9Ji4$48_SY!?bCT zFBvoi9I40W=z@&~Ti7|hQat#bV)g$^G!=2d$@_kSWs%Z*_!gviAL47qWeU(Ykmh|m zbDq{$g{vqBq5*tWc5nf3QZDx5%Ks0r(d?_g1NSm01!_U2fugict&Eb;q%RpjpLCs~ zH#=rlPKL)_`NoL010R7e(qEFyS5jQ{wIA2jdG zR_!eqf3QCPmoN&KV>0$QIZOZ`2m+7k3G=3ifYm(l_CcC0&5`930Eo1^n zn{>U*=fxUH!L9e;n~?cwVib`v4)^>XlM7Q6i26aWl?U5Z-R!@vyG|x~7iOnJE4jtm4~2jvdK)^ffUtA`IWa#F zzA2K!;&g6ARl5>c$`_pF(6v%PU(v$)T^hN#uSlE59F;pGy@qt_~h}gBk!6QO0%V{f*4u2k_^(I))h^EfMukTJW!T zBc}Ey2Q{FG9^-~HdcY7t|Ed2zTN>Vg+)upgntt<;2R1O>;0v0L9U^Xr9eldG$GfJb za5{|PolaJfX{z=q(M03)fp#DhWCbnbCxF7CpXS};(V^pX*-#74Gu2?t zxr6A0Hw3D?-Pth-Rp zN`48op&Aym*MYPOgpYXKi{6-=)4!VHp6#;yX&r!&6mbW|wn!GYqup*3Yfh-6C{nTx zs-Qp!e1j=qy~xm;x_QP`u`U|dnqb3La9@&JNz&bG(+rFFl0#mYh}v5&57t?W<-k&Q zO`~mV_ zfU{vndE3rFs3ZQG?!4+*k40daV0soF&gmkUYC2s%^8r@$JP zD++fo{PG+xy$1G+)_Ot@OQHW5`=Q@1P39ogucLoFCYlqll0z7yI1(ic7K<+9P=TA? z(qi{5mmDb}y>^slk;xQ`#ZFC9)eq&%Fx5{g8+AG#m~3-yBWx-tyGjaUJ*|Se(R8B? z4nyKdmu3WPf8V%SGP3C{CV2T|jtyhp*2lemV8`q#pBoS9GrXt`lz%Ibq~)4W(U$@$ zuBZG(0@=TyH@EtG8Wy|o{%ypKqTcu9Pkt)Rv0R;mlL7dK;3*s}KO_@0|z09Q^;B lqy=UU6#D-?2uM6)3i6ld45?uh1WpWtVAm`RYV=(n{$Hy6P&WVo literal 15608 zcma*OcQo67{689_MynK6d+${vR?Qkk%-XAF2|-$FZ%V7$S}|j`1hrKnw2D+)ilC?w zim0|~r1q$J-}?D}fA`*V?jQG$oSc*Me!ug6jpy_E7|&PAZ8L+*7dbA1K%mPILp@6n zh|C=L@X=5KzbM?_i~+uG1mCg`wz>}u4s(Ct1u}IH4)DJp><{zc3-x*s1iOC^d>wpU zL5j~OI5;3kRYnH>e=fLw|ADv66>I!k;32dDh7Lg>&?V;c4;iSShz$f%_k!qYTZb2s ziX+B<G^=!SkXnIjxQ^Q>E+^i^n(flb^31-CZ}52pPVyZ#`=jVs2BvAF%=%cky0F zul||~*_&H!oy|2Ct+M+_dnt5+v5mms_vP#+* z=#M&gZy*P*xN3|7A}Ks82`fRJ7Ot?+eZH9>o=+c7;y}kc2&)Jh8Mk6+xxA+Jm6ld!5oqF`Q4Je|=^^Hju!0lcy?wU$tr= zaA|p`rye&EhzhGkE#t@`6v8Klqg;@E$f0~4593gFa1JV2s8|$s6H_b+Ye4-)m{otf zIm(QPJu%v3It$eIFAK7)>GI1$f@l=iGKyZV_jhCqC=8xgN9Ie*L zOOC(L)3Z89IY&lE*+8wy-pI*v#!d5$ZjDV#i|p7bT8kr}mhM@pImnEB;=(D_a|+5k z^mmY7_QS}A$*l=k-M^&QB*A#;_)Xj*bngk0ePb1sR!Hce>^%{5yDDoinv`UGA=-5`23MNUO2H|5 zr!_8mmf~1=@9v%M5VO1yOp9byeZ&X+oQ*RdZTIJ(5XKD~aG^!etmaL4H)WQ>wF9aR z7jTsJ=%=I+&qqcx&Vyd17nI0D<bMwpe(La_I`ss+0hzYU`Oe)HK1dB$!4y@lE!@+R@4-=yyqdm9;ancag zUIr$_KP(>wkEc$M7KXDls!3Hhqcnt4pRZFh>%We>;6gTM8L~`;LyrV@mdd^rUUE$+! zY74NF)UqK_9-`~9**du94l$sxgG3fz`5bAi!|X)1)T0S35P7UORAf06vK{Xi&kKq} z1Z%lRe19K)wp7~)MlUX6;%vEMx-LeiH8rdR%Uv8WNVB2~oIbq_J_^tZ`xIF4)O_Y& z02!2|Evj553jTk_77&9J!8t=#qv1riZd-L4TA|890tI_WC+Ilwg?nAYz5%#hsbUC{ zB>n8o>c>b?3Ue}EiaA?nhBh2Nx9V$q0Uzc4PaUz4FSmX*h%O5d*}I1q>yx+*hkI1L z^9j$y_uuy5M?dbEJ&%uE5I2$i`2qd0)S(k+bONh8{osrb z_EBA76+?&6$|O~CTcNLgb*!r#8{zL79+DN3L7|CG0WxGxmC>y^IHQ`;_q(=LD=y08 z-)g&$;#YkJb${pK$Z$VYS9X5B58w<4)Zs1Myz(|N16flN$;uqts^3c~lXIsw8B_(D zH+eG|0mWK8tY18T7ruaa_#L@*;nBc%#b-NoRv$ zwc_iWq!L;;J`}IXw9-sq@L0i8Anr1Phu=hl44BxiQ}6=ApSfux#3|je$*7Y(SZC__ zMsHMPf5)k0#gK6l0s!>($>s8(fKf(`C+<`BfDoNJ~h(h9SD>IfZC^ ziZmymH*4d0xcKc#TZKe*4;U9rv>&C&i_6=Yn@+y6;qow%J#Wt~BbcU-;c*2{la}En zAqh21u{Du0`A&R!-Y{179aZ#=pYJm!dcFI?X%xd7->yOmsGx%-yjJGYRSF->LeoY7?TIl<`VnX;-@4&UJNs z|4IA z=){q7cjAIuccegFgseIUFOTLi){*P$>$Hivv&!!YoxB>}I83hA6Pd%_KjyIe{lSDo z(hr%O`Py5!QW}W$wMump5hUT;^p+WFrl{)ovikZ{_ApC0J1JEeO`X+GOZH4$ku)fa zW)+5KKnL0;W1*ojPf2b%*ZXb1`Dt|dJj79DJCMFv%UOw6JHV-9-VfUTG2T# zstc1Cj*FTeJ2;q6XUoF1cn>U}lGwoQ*DD4^2mQB`ww7oa`&WIZXVRPWWN&;5eTsB; zTe@(kPn1?K7+U`&klYUrXi*_4o_C^y>SY zDiSDR27dV;p$K|IbOk01fh=}x{4e4_0dDmlb@)I0O~hfvvF#AeE%*D~nRG4eJ-1Y1 z0zXV^c{~#87zW)peSMNDYq~ZPqq9YVa{|Ajtt;F=N$M$Z_nh;if!qI1Fo6URbmw zh@%8MSy*Z2XAnbuo{~(vN7{}33e?lDD5xqegt9Wxt3_2;c3h@`Bq|%dmL{Wrdg3r( z5)jM_X*ww&;wSp=&7q=Fh#0KVZD}c?V@O$s4AO&p zDhmpq)M_}hf+=O^@Ykz5GEuzD@^!Ag)0rnHG)(CVGttBlaJ%r!LDnpPMCauq)NsbmM1GgEZEK|Z67kzg*33`6r0doul~2@qMA^ z*RuQ@$y}Aug-p|T$fL_9L|_-)dxr;if=^i)Lj#2SzFi})LK5J#`;k{w1U`i_FOWIU z{7TzAIlC6#=tr}XC^X(pNUC_~IO7z5UsyWM@GXVP^;^pu6kxTN*mum!5=#!+>`@_{ zuf4`$EEnH)tUTEP4`M2I++!|@+WnFkzANa@;6JV_X49YR<@dwIVZWT1e0%)F(&kc( zg+j0-5Ed+ZE2kN&uH5rek&N zcU=A8Mxzas76+QpQ11k+7UU43qqRq+Z+w`S)G3;?^cw!6Y1>|XaYv#(-o6yH)FC1~cmYdaK5a-HoW|oL= zX1E^2kWmw<*kho^iXc4B5c+#r0tR_HGLH%)|4l_e&S5^ zu1d`5Sol=5Tl42iESDKugp`2K!PDjr>Vqcatn*m9T6|bOAwQ{8Mp(%1O}m+shet;L zupq=^?3F2hMBi#sCQMqCqAGKZ$k|e?mmx9UzsSRX?0nA|2v}4D;~VZIH~S9DcNkTW zmK=J7_9wT2@{Qs5NeZqSq4%y7eOy|_IJ3;hiM=$Nn46a&n`H4n;*fof<%Nc}peV9B z?aGxN3jK-zM>SM3%#c$^xwAe;%_b!Kt^Q~_LGUe!|Ch59u0g zdF&V~N+ITiZ{VbkWeDP})Jy+pzGy_rR*683z5b1W@m zL~p5`(ap@_&hiQ0lQh@Nrr=g6_}y-V@hC;VNCkhi%B>P_OpZVHl-o3 z=UBI0|hJSOFF=YBw??AY5{ITuiUp5VNlJbY#+=%EJBzN)FwhywNeg8qxX(f;w zy(p^(g?I2*Pqn*qJ0ktNfGQT-@M4dn#mkGQD_wD920Eip4rca`>6mP^&oUac4~qUc zOnZa!X|oN&jmvPjTtXs5)A2?9A9UepzZ2XK)A29met=?4pVnuBK70T{;MchEzbkl= z$lkus@h(mE%|p9-3H#Fz1HS2!HW>}b=RvX7FW}I3`z{mPubwVit?Yc-vp}SG<=@P3 z=e})q{b6FG^!?oWk=Q#hXra*5zio`BE%=OD`@TfsS~q43`O*Z}CMo(3sGfS<;7>8I z%&5NY^qh&om{wLHy78L+3@^DX8eSOF=mQ2GJC)p|6$gbE`xw`Z(K(f$OpP<8{rPQ( zuak61VjQ|pJ64&zxJt0cdQ)Jv7==u3wM@Pu-P5V*K&?mL*ch^%qA7nhcBylc0@uYj z^u?Dy9C>1{#x zlDac7`(MDzs}vV$pRYE5+HV;dd_1$Nt7XE^>jkIWvqJQ=_S*()#m^=%Lo|H zZBh!e)h6v$@MaXL@AD>oj<#f)FM|*MHn82AcS&Ct>!0Y43VEQVns&-_h+VmrpIe`G zTa(RxA|4pbASS_BCv$@THRliwJ-Ns}4cXY(*xcs-eu?dY`r^mgnH z23{F(Jw`f5i0{^P51B5L|6rS)=>FZsq^&emVI|2bzBIGw%bvh!)@&uA88M+WTC!hW z1=l5>e2t4X5X8QrG&r5R_N_MSC@@)A?7C`Z1ABy{if{lYa6^epW9oBMODbmRS|tQnCX78DBVQdxNdBS}w?}0vJyws_!xvpfu3EosKXvGF2ThD%}5Y zGy=T%eIaMDWd{hv09=l9KwL9=Yd#wFK=IrB!s%%=SKopZ6Y@O)q0N#! zk2Ai2%XOMrYeVX!(B02tfdB=>Lz&Dn4Hw;rmY48U`eIzlSr97`qO#zX9+L$_dA!E zkXheAbhm{dOJxD!Yr!5?$TNCcbHT-q$&zyJn$|q1$PF5VzBjEmnPGX*pZF(jz+DQK}vCZ8~YpuZ3cigp~;>$dG6(Ri$A8T2tiNQH!lb+MN@6rQwp zNIN_ZT})N3oZwXQxA*v)!LMt%D&;ySsI}=k;UFsKaQlOl6INrR7a2_cMm=Y zCEjuh>UOR0uU{=c5$^t~SznBK&>N@<%o^2?NEU#IY_NsQvxN8IOIGSF?bc+U%0Df4 zC$$*&2KF0kmm6J8BNC|Dq+yI3&TiZwuv&UX+D2lM18Fsh)ZH;^vV>H+%EJ%4&E;&% zkS;kXW2sUHr_dpa`56}bz2as~uOg>om;cymeZ#CzJisUo$vyFG)=-m4I16evvjkcc zO0`h|pWN==I1nLbZ59aHXIY0w9-Cn1*}A?46K?~O0xFg(z)t@tZ7~=meP`SMNoA_~ zp#LM(GaB!cCq%j>V^z*J$I*(Uy6O2RHnA7*d6?%Ji<`Kqp=gLXbDFd)@haGfmJi0y z&pB*Fv<4T>J9UYeZjhe?ep{D+-!h8X9$LvM+%PeW6)+f6Lw2kn^P=7?hBtY#wk`C5pFiOLbV& zhI52p+Msgh-T~WKR`?~vBxoaC$kM>*OU;LhK419spR;B97-tER`L~m>DL>KP!)Ena z!Z!T~!8gyvwNgLl-|4oFl^`pZw~DN0;vfIIfRn@B$FCLC%seNbW9{mN;W~0L^|+CEEgxe7$rog=3e_$t0`HP>wty| z=dL#oT(1t{i9J|QpIz1#%skLf-~HWV_)e4=#?a3Lm+7#Ej6P1<#fK#PL}*@I;~kcG z%iER{0Qxpe+ncNk1Wz!DzWiZ@(Gi&|f6>!c*f{_FE=nb87iIKaw0=$6B8FkM^B2Lo zn(1b?_-^FHlSLJhfwI~#)HvtCqNQ*zOzSNnB9|&p;)dDL$lzb~Lh180(uE}}4r6m9 zb{}D&=n{`|{Zu2VVT2$YJ*ZTTRa<`t9#;zf{l(hJwmGwG*_u78H03K#FdU=N;AD$3 zY9ur7rI;R~8cIi?7#R0Z%#BAFA&O4wB72zes0Wdp$ObX?_{syxGjyb<%i4L0$}0T7 z7Yb5?xiVGwV*j`jsc~(F{lYtPe?1z$4jOBLHD-IYTFb+Lp}-<+nP0JJh*1uHjTYR_ z@M`u~5GbGnDJ_R)jbBX=->Nf88ym@$&HMKF6Zr-_#fFmfZ7-xC3uUMbNn^$SDk+~;%{;u zoKp8Il4v=yTPcAg?pD(`v0iU+?f8OVn%JX=Mx16cJzP4o_+U=u;vqW z?+)-!q+6|x5e;T^0x(&AxzE8w5uNW0_G)s59N_p9;nZverYWslAY9%96Px>su3V+% zl)Z_5gBDViPYAU@>_}*L?uZ1`A*EA7VzsBVwCqP$apw3nwbZ>Et6Bom*K%yUKR#is z#!B57{g}dR1#g{?jq-@7tuS&xK@g+#jfp)BO@6}H@A^vLQq_l8(KLTf!2N}W>Zis8 zb%$;;ZWb^PuC3H54P>+ZP<3PCmop5(a1&L!J9i85Yh^WCnK(wMNcY@coWkl6U|2Xl zHG0eyGjbzIS6Gxh`If8oU~9s_;M#1G!`5&V$#r&KOzV~~)qDIsK2KXm)2oE4;$$F@ zIjuGdybEM%dT2NU_=G&xL-;1>Eh`k1q?)9A1C8{#$M!}LzieYle4$pgnpJU`;Vhs^6#3M5q?YBo85UOu4>e(D5Qmv%v_L|wZN(6kUn%QX=P0pw0HD%1fO=9=&XJ!|E6%c}nt_iM2hh0g;k<5;t z{XPZTb(s><2w6L+LzL zh^pi09Y_$X%+Q^l0In*b^Gtl12Od_mSLT)(ZRJxr1h%TVYET;cCu311WvA*cUKc$q z%OMJrdauoMF`6ozLEA+kH8z74$u4PIXNbAXVSScfK5|B^GyMKJQ_u|oug;m)rUN*iIUIs?=PWy1M7GuIPlbZS&;|>7Y=hoWRewv zSV4x7jVQbL4+$^?Pd!F>nV&d}qZXFV48AFKmWld_yM|*%4BemD2TZe;?3n2}UWc5@ z-sY}m>^mPpqS8ZpKXaXnszRv(K3ele--hYGv8=9LekT)~?vyaE_-~i0PP-4He_B@1 zMU1@1Rb0zAwdb5o0#f@f6#EhH0&1YH)SC$a7jl29%lqz-!&P766f zKL!+>#mRyOkso>}^&9uPP2TYSGx6x?7E{FdnnIpdfH}#q)-x-~rN*knOxgcu_N;! zKA8eLVVSoDP0%;bGkpKxr-qn_R610Z-tn9g)Ht$z=CU=(1cL;>|GQA{C0j2a;U*}n zNB5w674|=GcGHB&Zp0G(UKd*=c?#T(PfcL3PSuH{^{0P#58AtztJ5D?wD%Gy2d23a zWO~R^E7N28w8b4}udtGnK+qkHNpDEb13|41p97~avgFgfama2DyRdLRnI~dLpV7tV zVH+$9Ts@d8K@wY*(+NFr$9X!k_m%@{E5H!-7(mJAPFj*p=^*30COWO8%@JpMkp z9{X1Xw^yin^3wFx+RK^3299qYczOH@EgpW_*J5MR59tZ z1}-^%p7od;SYhgEZK3%!pQ9M4(gYq$J|v(wV=jv}{Vi^z$_Dr*Sb21PLWl>38?08s z*VNUAzfOMppgNTbuo}p4u}N#j=MWSaDCr8^JWBv>s8w{H^89>`eA-bj5uJj|d7IlR z5Z*uaF31dC(2@%LR+Y(&40$ej`={YJYO?{0##cU39K+1Rx+|o}|L_9sP>>|}h`)&o zhj*zGd6m_@@{tcg#mtmwGTauc8qh}G&cvLEa^`CFnA1~Xpgmkr7wQcxFd!6rmnaT< zAtnU%hlSy{*ixV#P)Q*hrbL>y*9bPs1Ga^>)CfewbM5llgfZF_ZCg;zO(sMxND!2T zc@hxaOE*!J9L)ayZ>+}rWJ9R}#Ihhsyw(i-*^$?=#n+}r+Bgk!^ryXQnkSr?5Y1gH zV4U_tzVbNu+4E{(F-0jR$qONem-#=8(015ZYNu!mBws1poXjUwjs)r)Mi>H+NiK(k z^fG(=ZT0gQz9B1Exk=KU@^1)uASm|}FhbD92vr6p^w{Fk^s1dG6&ci+gCE8Wj_SwX z%fOiH%>RMF1_Fzes@CErBg#n1`Gjp~Xb#dD1|5dH1xAq56cY8Wzhm^Q@0h5XB&I*%*f+pE#j7u~C!M#{w@}f~*5mJ&m%3J~o?fsATVoLU%I5pSYvU0{hu51J z-bc8YW?Y@6@>Ct>s2&w?GXvr$oCtNZwD}QB``$hFYWREnFWVM04?oMSK=%_YlYIdV zmpgP!sF?cr{<UhcTA$eE08W&Z#Z)T2#Lac-|gkUdG%vKG5vr!iizl;wX=ce)K55F&iorGbJPzyM8 z9rqNZe6G%D7n`M4i!hksuIdnbpaC9o8RkdT*Wn)mcJ;#=zaGY1&_3Ye2z9iyhHgJs zUozs*R{6Dmk0^6Om77yKGwj$@EnR#l`^!+f*_ z7XWUTF-U%f;HhXqtJYd_#T*j!)5f&FGRksD!|shQRa=zU^AAgfbAlkP%nu2og@hId zW#Im|@9}#VUe(#y=6N+a*60QJCNnj^pEUMRgF+D!K%M!Q!pdLWojxr>nyxI8sK^#+ z-fx=H8c>qlpfXS!LsX;M^OYP4$aGdlu&3-sC2BD~1-kdZQf*U7dZ6YjO?|eU*GZXI zUp|MkU4MTMX69bIaIV$?F|j%%_qyru@^|@44s}1_!*l0r~ z(+&ljIhH#tewSgMQ0eWBlWf#N+)cKiaLC~i;o8`XA*#tmjSjGr;=OGi6s1+*6o=J0 zLr;@sSM)}Gx)n4}rX1w;OQ4}50hOr60svWY|~PZ~D}Qc%P+Ld^v!~oMbWAXVZID zIpSY!`5&S+$V?Ofw-+?^RlQw9)$CIp8%O^X0PeY@V;d$!x=^G&WwXO1*Qei3JZC~O zUw`#wP}`vxQ@LB~bY90|oQX4PWG zLY)@pRMpq`STciSgw8-N#G0NJPxnQ#u9wRU0zq7|ANAwzL5bH{*q znP>}wI5AiLLF!dGWwLeXPjPCwj>Z`~lKE?ANEGwV%vz0F65Db6LedBYbu9WyIA!>S zws!(Hh~P4m@?EEALS7=00Pu(rdvHGr{JDSW?>erFoRuPKn&UMQM6B&lypwG$K5Ztb zH_MxHQX~8H$~&fo7plW&%PQPDKmz`?GlPeUW@{9oNo6Rbe1ZwYN#xt2Tba_c44Y-> zgQB%%6|*-m8S)4US@c2&MuU3FV)SlOP|9PntVN~j zMH>};R-+l5)kXFOWz$2VC?oe?*{7ReMsD6@X6?djhH6y##h_}G5{zNt) zp4p`Qba;U3*qfFd4?R2CUs}(%5(9paVz+Yr_uh3rM^0sl>dY#cO^@G*^Yd+wal!4l z06{#nkEVRYeRCWC)HV!g|0fh;6lqtIKd0~kSnN18aH2lckpU}`Yl-%aDdptyyhmAG;d;Vn;0nbQB zozGj*38*+>y(wx&f&Erna%=VzkH1?#Q?Ma`RM?wd9tUd?s%9L$c4&~sg>)1(PE)w| zt<8D{2!R}5PSs!^j|kh`O3eIavD5v#gl4a5?E6G&*2qRE(IF?&`xSEh^l`&yLae1u zI>wV{o$Q{VVeTHNI?ICxJj}ON zKE#tj_lzu*mBCqGcYcS3U}6AVyyepl>=*!MA;&_&P7uS}&ygLr8H*;yzcNMO{SxyE zFTVvA(Z5(5+f(-|**7e>zPydlbcxtqC>cu-{C)%oi1@qzkQ2Ggr{$QR>OV6P`s7Cx z;4+dIq+Q~elA%hMDN)6&b&OFU!p)f&L8P$p>M3{+VC#!DzUkr-Pr4lUoFi_ z%j>Lt2n_FPUO9P->y3}wStz*$;QN0x>9lu=Au*P;si=8Q3*EJ>#-xxBDm zw&~UmyieY1dm%lRjEj~ocSm)D8GK|`elmzC!~}^{hW@8&DBNJe0kQ`3!2Pb1y|1bc zmKFN3T9LJR`T%<36bd;Zv2AB~|9E5Ytsn(83^`Y-;QkAA(5n2IqpZ-c0 z!5_zAf04@zYR-(((OUVSv6>@Mv8nFvt0lIy3nVtiTWRXTrkOh#s7HZL;nN|d8J-A{ z3TG>RbIb{hs8yq>1sPHtzA9l^0X}CfwxbGwVv|=>xeqy!hbWVkQdW**Y*b22P-mYx zoa-E0B*t^E+04i6&swdjZ{R5Ys@dL>%;Bhiez-4s%e0SWi>Z`i&A@)HP!RSODgElr zA8FiV!j6f8&5so9x&$l@WhX41g|QqpzM*y^#*f1kqi!M61PpW10FgbQ>D!ylty)^Y z+=2K)niOpbk`&oJO8Vy{Yx;;n>N{Lv;&Adi8C5|3&n_i5C{d%hG`J=QcG73_7v`=y z)gV$+LOdIPAhBn3D$fI&e@0TC{2bm^FblM-(4}$RE0{97C8Wj8#&Dd|RF_fWhd6dQ2WxA5qSngM_qR1w_tbv0l(<{j!o+aZv|geaB=ftt7OMtzt3DrwUn zV(ESDKQ?id4YDrHc5=-viumhyQ!i*tnA;N?WObCc*i)K5$$jbFHMPx@w{J@xp3C}> zasaH|z^Op)F5cX@-HqS{LH7{IR3)_Zpue%3QpU0hzbodX5ivobB!{-z+QG1vRGai3 ziT$VR``#GB+Zw9oX59AS3wVhfwENsBH;J$GZp|<$G1=lJi#4J7@jPeeI^bidi5bjZ zN=S^~t$o@^0ku7GYe+jgy>Rdb^(?{lwy+IC;Za6wL@Pyi-dnT>> z&5YiJma4;lA+e<)0ef2Ofc74(On7-KWG zSGd?ROrC70${yb0+u`o*R*B@kvKp7gXL{xRjr&~5Kie6(I?n0JOlb)%K5vKJ?FA~3 z^2F=#xFT${j06+9wGj3)4X8Ma7}gVw8oVygh=TsTi?ifT9NOAUTTnDTx269AJQv_0!ESrC_Tva@mAZ$2p`Q2B}{? zFsWruJl9I6CnCt(87DYo1U=cSj|yLRULpGq-7SUI9RsD!C3@L$5)a6V8wZe3z za8X70B{SAr$t1zD;!)Dwo3>2ys)OkvW{IP!PfZg^VYL`RDHTuR~4QNKD5cQ6V zLgoUC9^3}hd#hq^ZOaNwsO1b`)O7T%su)Y!_%iJpnZQG@THq<7rF`<|Sl4oa}6JIKV*>={k{FM%xF;aberT)ws-Dxff)9d-c zRO#`Vqwl}8En+}E6}8^MJh0xr-udlhMTR5iD~q;rV}uLc8ojzFbQO?Wl4i9h3kbJ~ z)FR~Q0E5a(9!-s3 zdns_V23T)mfc4g5U2TZ`U&^O!J_Cl0FWldBxel;MrLy`ger4LcYd6xeE|p>%O*`0g zia18gN{fq3Jb(7*RAUn;sIhgt4&_Cef(Dh-qh%|Lz3JxlV84kv>zQ+H1MbkL|MZj_ zAp52|3%9WsaG{7?W7Vfb1uaRKcz|jE{9UL?HeWH#F`vuX>zdG0rWptR<)`+iau9Q} zC^EFLhH&+nSuL;@fX#^kFp3F*u9`jt}ci56wtxH?63 z@Va~9ekp|u2>TQph!80t@WwmQ_FiESc%5#B{~u;_2zJ(?hww=VtAgRAeN?i;-=EOeC2RP?$=9#H=8pJ7iFER zO(@O6=jSOnO1FCorqrigc%2Vm(P_h9g7GE9qCC@9B#V;_7w?Km$_@r}~X^Y0r?Zbv26~=j$(;S&{yG!fm3L(0RRLC64 zcsUazrrINyv};5WD*@Aghi#rQR4lC>@PmsoVj~(r`sAz%i^f0}i+oyyH7*cX=7(Hj zp--!8IeP|ZKYy|S4kR7vhbD~d^?l_6c|*Mm32bg6Kp!{v6&Woym4S2FGz_$l7MYGM zMW!mE>*LYiTk;7x(7o&3!6#y1 zXIcZSW{zyi0;kxq+h`)Wva3H6^ncVnUx)}$XAbqb$;y`i2VHyrm`j${(Cp0h7E&MJ z3A)0UGZn6}89c!b^ZWO4aqc(pax{jVJL>_{C5p1Oo%5c=GcxL*DWwWdH9KNW!m>C0 zhIlv_xLDUUbVu)i)o}P<#*rN1Iaf@zKH+V9La&jhgCrBIfb1@%mB|;yp_3uyd=Hwe zysg$ESS)oH@Z2lB?)rL(R7(AmItCDeq;shQ3%CK5)6FO&FZ_hf3v1Xe=s8h=LAdCd zZA@brMHi?t-=V=8Imihb4PxFA5iKtVj(GEmp@vKtF4;U0I40o{F0|{x` z*aAu{PkQ-aae@PcWIaw0?d+m#V^?|k;t$|?q+byyG1$R4sM{~fu!QV|2bR!@K6?OOH317F*HVcuR=mT~_jt+&< z8iYqvPT7vi;XWh@Y8I*f_GGsLQa?9+w$uN});pd19Wvue_vhXLvUSRj6o@D<%yIH!@s#&8uCBX-C5Sq11rm@e(&fBVXZ#3xSdJ`o`3CFelfDKwBaK zKcTt>G%)N{09+GjIsx)#zt2CS+r@pCr@#3Z;VT|;o+AI%hh~-G%J2W$0e~bhfB>Wx z_fYraQ0P13IaD`DGBf0h}#F73O+(fBT8Zh^T3xXc>Z*7B|nd6=% z(LwBNy{zBT<(n9WzkS#g7o$Zi#|_7u#uE@Ols!norNKk9S^cViloAjjADIUBd8WSA z2h;*zU}M1n{#1>1y5FJrI{NpQm(?N7%?d2qlT^>~Ye3>`V%CNRCm>JArm_Nje@Wx) zYHNzj0-pAQ%qKA0DovbC^xC|t!q{C-q7zh!=0NVtq8kuM(^==GBL?)%q}vDmc8v@; zsZsX@?*c~8#4FbhEMf;1ph{|gT)VPmSCV9#JA^vBP&EKc2Ne7vv=mvn)SOwyb(>eY zazBS^D7h{-0h*q2bz$1#Rmh~-j8p1Au~Hk@uJ^8yi0WrU)4lPw1NrK;h{a$ruTpH@ zTtpA-?*Jmy<^aMyRImp5*I|$iNMe?rHcuy=wN?HEu{Y_A8YG+~?9zC%%#yz&JLYK9 zALS3Xt%xlLBrk%n$rndH(ZOx zzN=>K3enR|z&-Bhn|&ug|8yrOzb`!{5`kJkl#o3pYbE#YRn?_&QVb)zp1b1?n86P7 zy?y46)*Z!JDK{eoHdCA5Q*olstM7X3e!JD`x8O0;m_Jt6&V9Ke?0vJTO|agm0K|ao zZv5rDf6avlpGKECERVI1+l>}RYB*NrP6xYLg%*kO_PgT&N_N0ZQ=9m z2*8IYv#7y50b(XXSo{f6Iz!=7xQwhUHmDO>Os7s+B(gk!(;>z~V_2)$RCi5;d`x<* zcaVl1nJn=RKnn5r3v}k?J1(89$HkQ%W$VYO^{6WZ4Q>NM4Xz>wu=!|{D2TDzHke{Q zn`wqAo~cfen$x(1F7ot`KLl8=F*VD^P~_i(rYml?0|nLNtiharP zXF#^8U;dTp4cj;uxp;xa`N_k|n)IK2qFP#o5=ZbLFt;t!1^a;twKL<>g$|u4(z8EsCLLQ;YCLN~)S?`hVI(;lJzW|W zu<(t#$2}lv9kicyaJIC<}(FAe8eLncRjk`Wx!vop=uK4WxlEI?l@=V8Iou4c2oBY%} z-nn$MKL&AKG=)Axjfck(L~q4OJcUyI;jx&kYOQlA7AQN*b#wjP5TlxsD8O_M1CIU$ zs|LjfB6^HC=(vog=A2DuXFA$-mXPniBL4S*T^{^iKVReM-2O4>ykH6UH}0wdWE+x@ zOSG?%x>0_uFfu`)UDm9piuCU&;s1{_yXWT$kK$Q#GenqxG?6APA_S0b=n_a~Mhu`bMnFOp0g(Ect^2;$S|`Tb)R5=c z>0=NGga`E_@)`uf)Bz474mL0nwZeh}9~yyIYy&O*Fo7XA@3=usZU*{$`vrP?x_lSx zb_eU}=ZjE4D5%PP=Mfm_kJVIE^!fJ_6#VYEE1tMceGMkz^#9Qg3xRO)eLI*SDQQ9w z$l2E@CR=UdmRGlJh?1Po@XU9(P7pZG8@>HChNG%ywmin?q=-r7+Z&&h z86GF&eR{Dcu^Jt@(hp`r33qrPhB)%ukj-Yal?#t_2&WqykydfbloyRwen#ox*L5~!f)D2n! zisc^=!DknIicGW>hAkKW79U5Pfls|`+Z&N|u^$M>!lxwJ?XPe4cp&RF;HM>B43XXs ziK((<44cCU1vt2;K2r1)ER#qKO3a?slAQWju;}DuSEU2j9h$=Giov!GTDIXX?EY7# zD+H~#g0RR49r&Y?VJCx@N?7>?c(6gsQ4CQX+0vXC9%Vk}JbxkjMZd;rLM`Q?yx{d{ zpD4Bn387;S%%cLZCkQN08T3*^FHWFL7H(QnpUFclw0Kwzsdi;trt?sE3v~JDHPkPe zWG;g21-&NL2kg60=h81-u5>l}H9C@Ri*}9c+I6Hm(J#^c@ECeFW%V+2MU6fzu#m=H z&l$?Kl1Hh=x8r*#*XcO+riI?$l~r>)v3&lH$h7X~2V#_A>b@^#sht`Hjbz!6bo;7} z4n}g9);CqJMT#n&upRDnKdia4vE_i&HiTh(hPcxBVei}-CDe$V^v0*m>h6qr>L}~J zus_P}$%j?baEVG{c+o2DQhEYRpO`HN9u?WSH>N* z@Ctf*{fMt7^Jq8zUcVdgfhVpE6?z`!oxNPRj#BoO8pmT_ct3b1rwtxco!H{A)Ev^+fTO50@HCZ&GfzmWUq z$g)=v;{F0x{5zon5cg{%S#~N|D@U>R~Bf8qb+HIeEm|^850`{)=F7d~S>;=r)9AbMc5jSqK&-1S`$oPb)vF zcf*uCzeIZd0PYZC{!8E8mp45OTHIg(KTN;htTkFUrdTHGy|W2w;@a_;{vr2}-!OXH zm7yCu`6o$CL#sOPKU%|tLxxX4=L=t-OlqcaJzM!Kdf^2L z3m5h(>eqICW3xLQDQeI1)4LjBJ5aQ=zgBCMT#mS61V?4gjRMgaT|?!K*Dq4rAKz}1 zG(p{$gO3ZtN{iF@4vgsmXrFECvjZ7fGWi0LPhDPy@hK5pUea#LZE7Cx`i2OG{|*kl zu!G+SpW^j&-#ro=8FTxQ6#i>#oS9}#ytgVanNj!QYbt zSr&TjP2n!El|t(NWvh`3^l|Ebh4pTe*v^@iXllgkhd$#_?oKMUaQIL-v_M5TD0O~e zp>NU-b*++Un?~L&mS1=!+0lmV^kWwHE}#9LUhGq}b(f+@5P`esPs=P-TfdkaF3n2x z(e3V3JB!jh?-+Kbd-bw})7Puo7nZv`Z>6tNuExe>PUx@pZjGK$Ym4_MoI$!UuZTFvT%G(MYTJc6cfT%H7Ah3~EdnS}zvPOPl zka$jL34NulZ+M$`NY~tR3 zNz~h(Fsvy1c_cwEZ52iY;~0wdJDNPykbwWsq@GL-cM9Whn+_(#}Lm@r15+NHwr7c_UL86 z)wn|dAEL2wQIVY5T>C;hp;npqC8ti(y9iy(O-u@%)GO)rTBICFD(t{RNs)ylRoQQ; z06yl*F#nO&|CZ|iZjb@{l6g3nnXKx0QaU~Gr1SoipmXK^BdsO+FMOu--}+2HeLF@b z4!7FdJN1qtz%Q4^S09DcyQCW{HYA{)oKp^(zg|+mX0)|5HZr$&2Ibh=t^LDAb@lZu zUL0|6xheCMthGPQF{B(gsLf{G&Qx63m-2U^;Ha4|D0K2YdZPE04@ARy!QoSQjd~|L!E`#iv)O5Zy{HEgdKuaAx+%sAwZCNUf0oXrMU9M%zr`~_ zodzO*XB9jFL$dfquBQ%_-PD(FPs;Ii^AOKc^BsLZ+mr1asdu~oJovIx5UID@6Mt#5 z-?Dc0d7N!iByMhTd93cK2A1J}_;rSs$;{z!TMSkk%2{r#_JKpZpq4_Mih zhptXt8#$!9>o!}O>9lsJPdL>5bT*$|Nj2WwJuQH((7M;k)pcCv+p{Cpiq1#7G>zr@ zbq`-(Mw@J@Yg>ZMXked7KaGZ+yeD{Pp}6|a1a7;h+RvGdSDY#qGP=69>z*DY@XgwF z!HX{aFD)Wwv?eC&*E>I@c$G|UmPYCD@bEzD_r{hPFH(KyUo<4-498NxES-LBg2Um| z)YO7Qgh@H#Qg8ux49=@vRPTvYzLdTtDTl;ug3`Py>M`Gb5V?^p0fT+fJNPYR*=hXf za2wkuljjd0W&NIF#N>3N^Vc?;WEHn#09>YV%XcLd8+TmtmfuZMyAyJnFAwD_hAfSK zkgpzn^FSEkQ-EjjTI2yiCtg5E=3ZQ06YHBU8THT%M z<61!Sim|ns;=X<`izLP4zT6VUQk4~}udsCK9ck}vE#BH*8WY8B^l*z_IzgYV0uZ+P zhD%Y&rG=<4lGpqgDCGMD6-#FYfYX}`v~{hfb*)m5Cg3xnV+&62Vx%+P10b$heJdiY z9jYX0_~`Rn5kFUIvT|DJRE+4|FXiNJJ^oWu^_#TEZ%Z2n!<~#p?D#LQco?z{l*3;qy0LN%;A+Wwj=O8!yE2O5;{pYd9R%<7(LR(i{PCN-km zI>?yB;uw_^2K6_@jAxLWI;jiz4xlB=#zXK;Yywr~+6b)irWub{k`(9co9+k1Y=Sxy zZJqLz0W_LMcvMlmG}Xt-Oc`S_&HA2-_%PM z*&;*9!&kdvu*lyAea`xyE#nu0LCmL~N4eUANB)OYFCqe+&R0Mgok6HNj{8O273=+*N(ODDl z$+o6Uhx-FgON2ZS)gW198r+t!hVkMZWjC8WyuDe_ zbPC~Wrfxbbmq3}{gf0Zrk|8ugM z&*^nWha@6~1Jjk!(VJ@=wl(C=l&p)>?9yK62H?Ybd~xr$$b)dmxvR;S9UaBmlTJNV z{uX#KeA2JbzcWMT=jVa)y7Y45NqAmIsyglSUVp}Ws_E#x0^V35CT|vuJ7d3KD-~~y zz+Q_x45BnKIlrfBBvzS01>G3^!Mb_8D?%%Z3<@DE6GAr}q zk?wc%Zs6R3>tP0~tBPdfRWsRAWTI~r@<4BBv4_F^RaVA`JHEM#=f8uyNcew`sS=&f zy@MR)xcbs=nk3b8Z$=e?NtzpfbJ4;D$KeL&3Z8dN6U@=jBUFHRpfyG}eD;(v zX~X&T?vGEX^*lAj58d1)&|_xMOy8a@3rfW zCknQkC8r9Amnyb$QKbHgz>Oc*CGZOn_;bB(jtI_V5!h2&jT(v+p71Cdqq7p%wh#i< z!e>#~@giQfPo+>griS_zdMggon}NI! zCS9foE@HuzRQ!=e-76{7e3)iR zkupP|UAr1s##y6_Sf2Z37tF1EoT1w>LKu;p3Z=gU`grfp=MYWVb7S;X${|TP8B6#q zVOSG0h>Qx@>ZMsJ7wMN60L@a=KTrX)(BbONhpk>6*wdwi zQQrQ!5tds?PYhzY@Fzpd5~u433%9KjfUPZtx1zNu>FpV&i@S zW=L$i>g#{qs}!V{y+S_$kG{T@hLOqWOOV>cxOI6ZO=_5+u9XgEVL?hR_JJFTA{nje zf;IoAzbY(eQ5W)?fwlT1r#guqMf+6G)%tIi$vu7#gLF8yfASJ+=UrQu61|65Q}kJ_ z85qAd(&lBhQ^@c4ivmH*&XSKsI| zmLiQhSi2cLYH^f&l!LiyUU} zmdZoX0UXoBI?l7N1n;C$uZWH6p-991J(ELxc!}S75B1R=F`IsnrT5ek#5#=}CRQfA zgZ4^CU;{AY>0|&aCYVUxP{>PN%>xdAfnRIe)b!Y?#lIPot|P>FI-;05!LE9vo$ksS zwDeF?@$8^pbt2S@%o|Valf@P46@JU%&4WR5mpIVFIkL>&cmlRbkxZGs~Os41_NVV;=uVWw-CN~n?FwAl>4cF zg$9e6(HpZp+#+fZfC_}L9T$DSG1vF4pa9e_6b*=0&bcvdaikimX1kdvEFPFt%Xjo9rd#;z!l!Nw zciyty4oVs^ls}ZChE0emBKy^%mh4Dv{o0`>ny2j5t3x@u0lligXPlWDPmG7^v5m9t z3n*1&?*Y8OtI3}NTNR*7;LpW!VbuUacC!?*4)b(S>!sn*kj$4w)!a4TA!t^wA9$7< zNyK84ZxL`5KYY9;=TMuP#3Q2d`6a#s@7%7|@oX7XLFFTH&q&T45qdM_IK7%ML#V?q zCk$P7yY|z_ux)T~+_p1o;|-V8?cPH^TPc*LtC&t+*oBo%IfYsuws{q-?27X7i1rvM z)cwjw(Tt1&nmvJLUkX>vHk=`&8z)Ox3i%?s&W_ zgS}oJA!uEx!w)+W+nE_o1Q_4d*CW}HcOC<|J;zGP0(HL9LBOUqW3d_FiHzJjJvCvkrBDeR9n}4+HvDkF z%pqk@ME2E`$Sxm)!!Vu2ZWiD~q*(eWT52VPlDbo>;bDkGO0JYpNBbFVV6hC%@Xas9 z{9QfTG6+L=h6nnG+{M8gg3@5BUSLTq0hF*h4x_0KVlWz1uhi2G%%>!#)BB6fcx10r zsuZfh$WVWMhC+k8Y#c@tg`g3q;#JS08XUlAI6a6mPqYQ%9zSt?xTG{F09-5ucC%J2 z6ydM7^44gi6w&u#7@Y1j2egbXC5pLEW!;_9rCEFd*!5X&a|L;by9oMdss0Y&pjypv z)Ab{W^8?~1t!yE1!Yg3-`o~i;(jt;BQ2C5vGC6OsKneVi0vw}(f7{hSx*r%N-ui;7 zxneI)hLwa{FWXZu;w`_MUrA@?4Ll^7CX*rI5cGraKY=Ymfb| z{R_BS@*j<^|4TCQKQ+((F=ziYAYqz8OA0Ym87^ShVz;=VqYQ79fSDnYSmbDrQKl>$ zZvR!|g=Gkm6xagv@B?BT!5-fQ&4cnnw+&m8)vWWO8ElOla<|?46d}^qN3M*x$^v_m z)ag@kV>YxGsGx}MQ`;#a>7O9r&3~bujRnjc+gEK zKg$c~aMW*}P@hnQ4_;}BChmA5(;|r@Po(Coc7rF~#dtTEs;WFDj-_EaMjSaEIOSN` zAQEiiu|!XDZGqbivF3EmX^?EgsOegQ_|;GE5NHY{Nx|_L<<~R%-)c7NGhOV@{3aTy zX&O(?8Yh+AdUqTG>g+?WE2o!UR)eI=l~&>i0mYD?c|_F80zMf)&Y7ejGj(ycUV;4;#JVao-|b2u2%mB3BM{q= zI0DvQPV?#1h2az;5n`HKL-~=ElQP$aO@XLGK|9uheujP;&9cISC)V(Nhftho`T?0{ z9j0+2G=DA93{&z_?&w=`SI|2X9^37`8S4N*)%qzA;h?vpk2fa7_Z z1yJ;?chiqYFzwtx*3Y1;Wl+7p&(HsNd@(rk!kdu89CMErDb7%J@i%|A!34mRsw?N{ zzYD~Pvy2bFz0Fg+5e0b}Po#-{{^JZ>-ActH_Fag*{cnD(ouE-RNztqBZSr%w+tcG? z&;rDCBIu5~xRIweUwtCv)zuM8POJ_rDSThR+EgL7y;~&^=;pD-LH;UFw;ywSH+cbm z8hCcy!mrmKO$-gsw{=IH_F#*y^pIfl29wMCY)se;If=IX`Evz(Nv))rn4k$z~f*z|WOA?br2lZ>B81i}00eXXC%6kgP&Te76`5oKS4&EX1=NRIFUAsinQfT+@H2!cb~Q*m zM6Z*Y2n)E5Y3zUKW_0bTf2g%jEb$C~m&^fYt4}#E4K%qP54km`)G3p{ud?e~M=rPa_+)Sn}s&$ia1)BaZJdtyF`S zXCBC83%V}H4hu@kVMME7J8nG0`B5F}KGILD9*9JsZO z0(joU%P^J?uOX=qh__^Mhmf5FLYP13n9MlEaz*K$gh5p*WDwiP77GaZs{{p0dFfkZ zaqo{3&`PbpcKJ}6 zELf)H=%si|6|9eXf=oUfZpxy-WbMj;$|t2Ccd)Y4DT*0DG`Ws`!#~g#U1jIe(PpM$lSDFZslyu58Oj#4Y+uSb5M`cS2a!w?Hs+eNy z`)(|`Rugfgf-qz1gfJ{vW_dwAfPG!sJKij5Qdyw#U>!yOAvR`MklBoB29inuUE0;9 zLi3ZCk=)GDZVbLe;kqqr=M(%eL1+k5A7Z`S_d*3tNp+y4ZBe=jx-Z_E5Y~>Dz%cm6 z?4IUSSz#7qsosx>yyn~;ja79E^E})pi3~|fPO}+u6teMwsu&a^-#`G}n+98CJ)6gt tUVY`wKboU9f4t`K*Nabo!z4!%ZK0tYMp6q2`&#tr@ zWM5-aM)t9eW$+yC_uk&;dG7afKhIz9ALHaWkL5hh`Tc(10`y#NE7 z&T?E=Oq%>j_1-^LoAE|6XVpIB_Sh%0T-2dlcn`7Ts(;g#MxBLG;j;JJMFKUeV#wA! zGc~gHR_$*@R=0~rZ*JBJ58pR$s_1pqBA{{6ku%vN(ift$e}rX7;EXOl%oW429ZrfC zJ9yV#H`?UcUmLwx9+A$W+^t>vjtiA=>*s$#+ZbbKo{+5a?dufKhZr!!vO9M+iDd5c z%adTxPBEA!krq(TQD;k&b>kv$JG;A{twXi_yw@{C;{0-$=*gw}ZZd->QJK)?nVT@Y9V}nG|t59ETQ(ako z$q;%hk|bbK*6@TRh_(sF&O9Y)JSAa7$3A;B@R_V81Vm&=ct@SYpLNq4VjH&}`WV`T z)Mhbb@zriFrws3zL9|KvrgO|ZCcXKRK7rJGW%6Sdo+T@BD<1HBF{XkrXr&w{5A3lp zzQ4sTixOZNzBZEX0H?y&VFBt>xL;w^TZw+m?KEBg#lf{xZpyM8Ylbk7b8ii+AI43c zt^=EeG7#P{H?={hX}YuHtbER#r=Z&%Y<<4|rYka8Zpo4CFN@jXSyQ0bjgRXQ*HLF{ znd@&CCpckQ{B`ls^{eZ@X2(f>WTQmypZst(Nl^{Mu%#KNE;n$kT_U)Aq6EVtNVE9x zo1;8TO@ed_1v$RuqLS}@hoBxyF0rL;Q!Jj74dWOg2j~ZNcaFVWZj$pfBore|kx_9? zI}@-d^P`4jw(uQ$-EU$TGvp|ndM}})goVfX&)L(|tCyt_(%D|kRk59@Y3AZI2YLOb zxYec#*?%g7zbRe%8y~J5Iz+*LiEPN zNs0SWqfbe*n-jU+$g^-n9~9!rjJ`4q3;+@1ezt)IaV49K=d0- zUM|VCNj(7#+|%D(cOBPbXRrI}VT%OMxhCjJu6*~jZ2X2$xZMfd=})5i zxM(gpdGPD6Kkg60lX>ZBKR!my&&rA6f(e>{KB}S=uNRewBXO7EGtq zS7*+qho;-o0#yp~8XMJ915Kk%B+#aJ3BiFa0W+5|Xm*4vyRhS%UuUUOLWQd;Fkfi0 zsEs4GFp4Cj)%+|%-E(k&#!wyrbyg=wJl(@XSr+Q=$PMOjyT&nng_Xu41=kUcLuHT^ za9vBVwr^=`$E>p~x;RU|ThG~9>M_5JbZ|%WBW@w(*y{zR2w9uvJ-LSIZJjxK2mwX6 zW1bUjw&P#oW(MAH5H~ggd}jLJ#!KCT5>@@>&Ye3~XxVUt_*_&+&i2c1pqc%GzCMp9 zjgpa{|0sBK74h}!SGc$6mV=86JASG=pIbndSmD?g@8hy;fAUJ=g*$gdp$8m%xfvOu z<1GnqLU!&$Gz$6Mho^!Ajln8VSFV0mMMa$VbT2~IXT}^fe_R}IK?um*-LtZ?BCnv( z+1beg57&75Z?8`b)Od<%U?V9|2&hujmCveKA)ea?*{ULLN#W11ceQa^2bNhh{ z&dHvM#$Q5&11{U&;jfawbzYmC+>~#EEDoSR4BtSxtK=-j_#&{)nIvy$dfN1(NNqz{FTJ|RVEHJ4~Liy)g2L1p2qxM;86e|_E?`iZhBYQsu*$8(n+ zsg}g>37t#p$lYlqRg*g3YiO|gAo&m?1;3W=Vl6nChv^Q~Joq5FraswM2aKQW*p%Nq zBEuRjR?%Z74K9<_guju1kB@Xjf@AZI^W+>l#nc%!?OUCTb@PqM=Nl&VDM{xZ-*`h< zI3Kcf9&#F~Cl9=_!#MUz?#AV9-*4W2sRz%Px~&e_VZd0I+R2j!KaG8~mVbo-+L6^Y zIQS)8efhX>2-AHxWc(*mKmN|PHxYbe(;K(l-ya-y|0q=AD2O3&KYjYNySuy8byS@| zNqh@By(}sk-iO88~|ms&pRukfs)>xWim}w5Pan51|7_72yG5ylMAXc+bDI*|f76p3u|N zv)i&5lg|93BxGxProUrViU0JUyUW7;Wp}K6e^z@>n|_EC+N@O<)qbL=${jdc(f8Ws zeT3DZ0jLTfk*FLRYlu4^BWZOTX_W zwOcA6DE{SiORNkKKXTqvCMWfinkPV*^KJ%j4vn5f+uys#LQNiJo_s@SRc0zrX29@L(&$XHddx@G~HK= zQs1yQoQ)RqKBKwBy1LwDxSL5Q4N^Y6xcH!Y@ynU@Hs8i2y)E^HM}}_GMO7Y)pT(={ zQUm8363&#=?i3 zL&xwivsV3#S@B&E3Cv#CEz|I!nw{-U|M|etK)>W4AD&KoB}aSJduSi?{#DUu`Gc11 zN}H>jpDS$#wO(mF);RI(9qsmmCvgqUqOAw|LGTW|wr%;|eyhsGcBa29Tx0%QT|!TR zndkQ~e!2ThzqEiUi9?d+ZfiEjh?`&{`ZZdHv&*;Iig(VsoePw&s-dYMLJF;#(w+*Q z_n^WE&_{iDfZw{{=$f`=(1I4I6wSH%$-8OmzxF*mzodjiS0|HCl@5PjB13mRJh29d zqPo&;eD~zzLsDalEi&^9!76S%o%iS`A>ZM*ClW0FykVF6K5%47c(-ghSAF~N zj!z?~c_l&mw(jlQLI=bRf^KhuXZZ|v-2&=~;t~Z@v)rjy=g2RXuk-#<5Z~?K;9yhU zbGpiB*J5L~^KTj|Jt7?>-xwW{i`u11|5nKUg;f1h&!9BILB%NB9g`w|$rCFg!VdqW z$pBee@w3-%=0TO6MO!{49Yncbe7i!^ZhlKL|CYOzMEc}oDel`Y47iPn+7ZB_*xXd; zH>eg=9Q8R#@yDL&RCY<0?VJbFCD5JIR^;`26;ttIoB`XHmk883ibW#1-In$gR-kT( z7BZ^fzR(Z6@pc54lA!Bl1Y9&xn7frEz*>LUudp@qBeBZs^#~7qirTI`z@(D;kD_jg zj@6;u=g#s=;*12<{L^WZFof4hUKN71W{dWr?2zfKZS9m^l6}dLGIa|+jXy=VramGi zlF8FU12k{g8>*FI&8tl7DjO(0ioMjL}6012g_YJwV!NL2Pdjb!J>&kj~VPlVNyK$?B+H$TFC zSk+IKhlfYfsxf72lYx}AYdfmoGW=!1ex1=5Gi*bw0B!c)*`#Ktk{cDnPOz8+J?Om$)+s#o6+%L?zFYdhwFS zF^~4p+SA)#T`%Yd1sZx|*G|hxu(Sbe3ohGAt8^M*fq#CE$n#Oe^SK+f}C^7c8n z2@#S;X2cGuv(>9$?7SA$kVHFTNGl~-xgZ~KUB0dMadX9*i#tDmvTr3c4S*PL8X%cJ zC$G#(O@9_`!|GEPT`@v^83cd%w{$=c#}E>=9FTkWuwLN?*#fw^I#1qn7F8i z1j2|2N|YF7eB}OZeTPJE&l$)jyb~^&KoQb{*7MP2+Fz=qwv2GDF4DS`CHHKoUczvG3c@Ei1sYeu|blbD=w$G#WoKkQfXT z@D4S>!t|`uy(e%+>0LQrDU=dyGuI1VKUIv?8JP_U`lEaN;y5F#&K^;Hxi^nGufK_N z-Z8I;5W`Jn)vDH9#18L6IiknnNQveyb?1Ojv$Y6rsnjahywxE_A+6XlZ94YCAtjbK zz`|;`)jFBS=%JK)Aw~0!#{G$w6|X?=2en6%nz#yG^0xS4>Kz%K=YWA56pz@I7wzRgX1hCQ3uJNy`Vi>DJ!g26a-a4RU`5j73C)bIN>0I#X zK96b7C%A(gQ!arJib!6i6bkiyxfV=qc*C41}w<_mPHqo#y=6a=yo; zd9$L^;8|W28@RX~mwlPK8WXxVvgQbAD!pXZu8kd+yfA@n);pNa0VP1KJ(5?zHgkVT ziR%MduS+fSiJ#|iDKxzXmetbI^km6#SWkwq0+QQ0ZbKpDT7Q-ZgH(+ ze!U0&e2k6}tUs_8PGM@T2Zzfo%@>%G!Je-?7j5MT?SR`BHzUP>D*)bcLc|ppH>1FL zpguYTeg`(5$#M$ecv@Gi*ovK2yThUHO8PjXrrsP+VDY7X;>H3Yzo@=TtN!_?94o-9 zmn|8GQEx}V?|FjQ&SxHBQx!tZ7u@#;n-S7V&-4Fe zM>M=kvpXXwIu;eGfo!~1^e1>G$6968&6CtnpTQ=!C#tI+ps5ao!VZ^3zrki09DPSh z8@!_#5?F6ub(uvNv8{@piy%3EDXAm2v+P{`xmR@TA*o*gRifP-L8^Wc)3^leI#T~Z z)TZdzN0hss%GRz2Aex!OoKT7AM&pdkj?Vru+ZSgQ*T_9QFz^sP#zpm^vg2>8x9gy7 zZW6YEc%MNwvNHGhvH6{$$C3O_VCE%VJ$cN!29n4lmbFIS}kxDx@u+B9x3G9baP9~*!aNa z>MZgF(DOyNsyc^q}grS0f=2B;1s9uT}Ig6AX0TlDM>KIA@pDL7aSXtwh5a!A&9&LS;j z+uvtym=gx-!rsBb8t4+JyQk;uz3x*t zFj#P)&R0fI!3n}M*A}=%)KdWNv$zd9942cAe-Aj1VBw5PS| z$u#T|L*kuHHRplXY{bto;>O0t@1}YR5CTdbV#c{wtifUs(3Al9Q?fP!jdscbRer@x zQ$9exQT>9XD6*#WBFu<%&N%7U3%34P@`TrG7w4KCCdJ}r$9+M!>jZ<@yWcqBebgYT z43W={rZ#TNL3G4;Uenqs2n{3O=o;7tf@mURr{?J6!NDluC53KAJ^fFs6(7#2liP&N zyn9;&;A#w*RU>>wtNf zvu?B(7F1`|s|)uz=moH6tP4-RROvQA3G|o)m6Q5ld}WS>MACxD{@&|LPhoBRZT~HQ zSgL-zH-0EI2eojPdYmc*yF#9I)vf?vUx5O?Uy;u*toP(*X$1yTaOY4te{=H617YEb-xEP)NYSPG_Krnv4nSQNy z1sk1x;8MbT7b}T`34QZLq>n&*I29)bPyj%%WO@|y79K$#43Yon8_KYw6`$?{sh!@@ zbIV|xJrV0L*B8@L;t#Xpt-b#W&-9rSaL5ku@9a6SeNE_jj6FT0pO=NJUjalm^RbJMVPJDS|{>oG60};LExb zssLXSB2v1%Iw4&2seQXRqjrr1YWcSg0~dNSEU){n(oxRS{oG@~dt|1jezM;Q-PsFh zcE+%UAW9!rky{GmHH#OURP5_1uxr9jDka6py^+RD6F-kv%3S{|O!Br{asvV{$an58 z?IEd}b1mVO=}DZCNEbkNzpYvE)Cyd5cZt_I`5m@34{W#4J@C#>sV#K^V;6u!&)0g+ zwS#zIx<-;(VZ#>Z^M9K+t!tQ#sqA)~?l@jKA=mYJ@C0tl@;e|n2)I3zOkP){`&C^B zz$;?n=cjYp%iJ~A`bS9}H=ueDwR z-|#e77=f_eHzy6ku5r#@_>vT^lk@Yx<4XKziT6J=HU2UDg)krRxsRh2w3`c1WoWeY zuk86m(pnv9%^h2=-TZBKx#lGLb!y+|Z?&QzHw*w1##$hTc>#Ii_uKC$hHm?Xk2^xu zqI$xM1`1nTvbl?K0Y^|S)EtA# zWO7Zz;`Oc06FBi&;l2Nt6g>Ka#-YxI zyfUNF^SaB4t7TlUJIb9oKwWQj%9z_8jWvN}Gy)9J*0W1%8DJiK!E2|B| z24MbO%hK-X?q-Ect=}c81u6h1eLSG(>1i`8?7PI8bVhguu~> z-T%nRW<5GI?*L|nuB54wfyOf}vE+e2Jr^a**>ZtqWZZx$kJkC`3I>wZbgrwr%wOyPzfB?$EfWoF!|pJc{L& z53d}^`IC5$ib@IG{$;#9frh}dxw$86@f+7hRGvnoiJqr!<3UO8S^lY{PyA;^N0la$ z%vqn2%|vbkd6AZ9Le!s;!O4yWrz%^a45Q|ek$q*LRxvm?DbUfxVCJJpDEOnq zH^Z7;qx*b9UAb=)t*K(2>4V3}HZs@$D(}X(m*kcvUmcRcDSuyCetwedFYac?(IV}X zCly)R5XF+#lOX1;GLaVdFI~a^h4c82B>i6*m;b*E|1T9r@zT!v_^Jwx6)!=A6ikep*+@&4m0UQ6tS>oLY+2?m0 z<0{Fp+7l#HJuUzO2b_nL0Yte7Cx?Cr2QMpo%rfDxc zRGOu~$xF@T?LExH^icyaI7l8cJdxOcq_yh-xvHF%Y`cVOh= z&V%vU_t$pmR#xYo33<#CRLW9a-J1DW;`YK|+6UeZAVg&%J(8ovgyPbK)3#XL46&*_ zsuw4x`fvU{v=cT**_ez|JSHJPbpYfV$s982Q7V@bvSPNHUb{yR_R{;K<0RV%ZNI%m5p9?#ACvV*klBG^jot+U<=x z%L{mo+@n6CH+k|W3OM1GY6S*b%`5O`C>h>C-e+-QOJfoKLh(kq8xb0NAKU60MY;Kz z3Pq4mv1!H|Lb?pNEo0ff(v*6Ss)sr&g|T`}`qiL&0uh_OEq?-iFQ6`d`-`Z)_bIds z>qr8bXI3&&u2G znxJ%f*{H~j{5I9glYgd1VVl2FoIX>KDEIvr2-_-jIoV=<$5>Wub28Bi+KX9Y(QW^O zd5c;VngcUL$4sfB@Z!j;CBF%J;ox=m$VCsT4_-0nc)ChxNY-z$OT;Gjwl<1>!`0mE z*CYX?1!rL^WxnEukF=Y!|GLA4+XMwhP~1liP27*w-i7Udbl!?InD>&!7v~5jmvU4N}J@y+Foc#r4Rc`+&s=pOYs!s0A>fc8AJ?i{A zGXVdF7pE^!mQzUGIFhL)Acone<41X`%@nd0=b@+->YAvtq7@_)Q3&z$9c z5!&hh{1F@|=V@DV@bqLUX^ktVfRN6vU`I>y*+@wu%P_p0x1O4{zbbNowRNkKp&aWp z%5Vyq4|2_uH`%OfFiy+XMJ-rTk?>BgJnHj==$H`7ov?m%BEvJ)O2cb2F)~djDIj$* zYPt@Vh$U>TI}AxIeu)tVe5`G1o$JK)2vS%qVRFL?RtX*DXk+a~?65NT${ws%!*Hya zrf!Apj;0LrF%9vurF*KC(Nk!fJx3c8@#>|uj90O&`%p-Ur`!!GWI?$l8O)LsRTa;f z0|i5Ca&Ct6*9SxVvh#i7!rj#ok}u@11&Y!!R5TFj&V=okjMKZL^AK5bOCQG%*WJJ7 zfAQ)r8QM!}qu2%HQ|`a}YLfS*DxGJAlJT55rL%WZg3(iNHpDfdrRmqo}mBA|JyEH-a!OB Xe^!$wlJW@rpBRMGGQbvJ!vFpsH$E=q