From b54ddb946b2bbe0c91c317f37141987d639a6075 Mon Sep 17 00:00:00 2001
From: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Date: Fri, 10 Jan 2025 15:16:11 +0100
Subject: [PATCH] Regenerate qiski 1.3.1 API docs (#2563)
This PR regenerates the qiskit 1.3.1 API docs. It incorporates fixes in
the documentation like the alt text in all the images except the release
notes.
---
docs/api/qiskit/circuit.mdx | 10 +-
docs/api/qiskit/circuit_library.mdx | 2 +-
docs/api/qiskit/converters.mdx | 4 +-
docs/api/qiskit/providers_fake_provider.mdx | 6 +-
docs/api/qiskit/pulse.mdx | 76 ++---
docs/api/qiskit/qasm3.mdx | 10 +-
.../qiskit/qiskit.circuit.ControlledGate.mdx | 8 +-
docs/api/qiskit/qiskit.circuit.Operation.mdx | 4 +-
docs/api/qiskit/qiskit.circuit.Parameter.mdx | 10 +-
.../qiskit/qiskit.circuit.QuantumCircuit.mdx | 274 +++++++++---------
.../api/qiskit/qiskit.circuit.library.AND.mdx | 6 +-
.../qiskit/qiskit.circuit.library.AndGate.mdx | 8 +-
.../qiskit.circuit.library.BitwiseXorGate.mdx | 6 +-
.../qiskit.circuit.library.EfficientSU2.mdx | 2 +-
....circuit.library.EvolvedOperatorAnsatz.mdx | 2 +-
...t.circuit.library.ExcitationPreserving.mdx | 2 +-
...qiskit.circuit.library.FourierChecking.mdx | 4 +-
.../api/qiskit/qiskit.circuit.library.GMS.mdx | 4 +-
docs/api/qiskit/qiskit.circuit.library.GR.mdx | 4 +-
.../api/qiskit/qiskit.circuit.library.GRX.mdx | 4 +-
.../api/qiskit/qiskit.circuit.library.GRY.mdx | 4 +-
.../api/qiskit/qiskit.circuit.library.GRZ.mdx | 4 +-
.../qiskit.circuit.library.GraphState.mdx | 4 +-
.../qiskit.circuit.library.GraphStateGate.mdx | 6 +-
.../qiskit.circuit.library.GroverOperator.mdx | 2 +-
...t.circuit.library.HiddenLinearFunction.mdx | 4 +-
.../api/qiskit/qiskit.circuit.library.IQP.mdx | 6 +-
.../qiskit.circuit.library.InnerProduct.mdx | 4 +-
...iskit.circuit.library.InnerProductGate.mdx | 4 +-
.../qiskit.circuit.library.MCMTGate.mdx | 6 +-
.../qiskit.circuit.library.MCMTVChain.mdx | 6 +-
.../qiskit/qiskit.circuit.library.MSGate.mdx | 4 +-
.../qiskit/qiskit.circuit.library.NLocal.mdx | 12 +-
docs/api/qiskit/qiskit.circuit.library.OR.mdx | 6 +-
.../qiskit/qiskit.circuit.library.OrGate.mdx | 8 +-
.../qiskit.circuit.library.PauliTwoDesign.mdx | 4 +-
.../qiskit.circuit.library.Permutation.mdx | 6 +-
...qiskit.circuit.library.PermutationGate.mdx | 10 +-
...qiskit.circuit.library.PhaseEstimation.mdx | 4 +-
...kit.circuit.library.PiecewiseChebyshev.mdx | 4 +-
.../qiskit.circuit.library.QAOAAnsatz.mdx | 2 +-
.../api/qiskit/qiskit.circuit.library.QFT.mdx | 12 +-
.../qiskit/qiskit.circuit.library.QFTGate.mdx | 2 +-
.../qiskit.circuit.library.QuadraticForm.mdx | 8 +-
.../qiskit.circuit.library.QuantumVolume.mdx | 6 +-
.../qiskit/qiskit.circuit.library.RVGate.mdx | 2 +-
.../qiskit.circuit.library.RealAmplitudes.mdx | 2 +-
.../qiskit.circuit.library.UnitaryGate.mdx | 2 +-
.../api/qiskit/qiskit.circuit.library.XOR.mdx | 4 +-
.../qiskit.circuit.library.ZFeatureMap.mdx | 2 +-
.../qiskit.circuit.library.ZZFeatureMap.mdx | 2 +-
.../qiskit.circuit.library.efficient_su2.mdx | 8 +-
...ircuit.library.evolved_operator_ansatz.mdx | 4 +-
....circuit.library.excitation_preserving.mdx | 8 +-
...iskit.circuit.library.fourier_checking.mdx | 4 +-
...qiskit.circuit.library.grover_operator.mdx | 22 +-
...library.hamiltonian_variational_ansatz.mdx | 6 +-
...circuit.library.hidden_linear_function.mdx | 4 +-
.../qiskit.circuit.library.iqp_function.mdx | 6 +-
.../qiskit/qiskit.circuit.library.n_local.mdx | 30 +-
...iskit.circuit.library.pauli_two_design.mdx | 4 +-
...iskit.circuit.library.phase_estimation.mdx | 4 +-
.../qiskit.circuit.library.qaoa_ansatz.mdx | 4 +-
.../qiskit.circuit.library.quantum_volume.mdx | 4 +-
...kit.circuit.library.random_bitwise_xor.mdx | 2 +-
.../qiskit.circuit.library.random_iqp.mdx | 4 +-
...qiskit.circuit.library.real_amplitudes.mdx | 22 +-
...qiskit.circuit.library.unitary_overlap.mdx | 4 +-
.../api/qiskit/qiskit.primitives.BitArray.mdx | 8 +-
...qiskit.primitives.StatevectorEstimator.mdx | 6 +-
docs/api/qiskit/qiskit.pulse.library.Cos.mdx | 2 +-
.../qiskit.pulse.library.GaussianDeriv.mdx | 2 +-
...iskit.pulse.library.GaussianSquareDrag.mdx | 2 +-
.../qiskit/qiskit.pulse.library.Sawtooth.mdx | 2 +-
docs/api/qiskit/qiskit.pulse.library.Sech.mdx | 2 +-
.../qiskit/qiskit.pulse.library.SechDeriv.mdx | 2 +-
docs/api/qiskit/qiskit.pulse.library.Sin.mdx | 2 +-
.../qiskit/qiskit.pulse.library.Square.mdx | 2 +-
.../qiskit.pulse.library.SymbolicPulse.mdx | 10 +-
.../qiskit/qiskit.pulse.library.Triangle.mdx | 2 +-
...kit.pulse.library.gaussian_square_echo.mdx | 2 +-
.../qiskit/qiskit.quantum_info.PauliList.mdx | 44 +--
.../qiskit.quantum_info.SparseObservable.mdx | 10 +-
.../qiskit.quantum_info.SparsePauliOp.mdx | 54 ++--
.../qiskit.quantum_info.Statevector.mdx | 42 +--
.../qiskit.result.BaseReadoutMitigator.mdx | 2 +-
...skit.result.CorrelatedReadoutMitigator.mdx | 4 +-
.../qiskit.result.LocalReadoutMitigator.mdx | 4 +-
.../qiskit/qiskit.synthesis.LieTrotter.mdx | 2 +-
...skit.synthesis.OneQubitEulerDecomposer.mdx | 4 +-
.../qiskit.synthesis.ProductFormula.mdx | 2 +-
.../qiskit/qiskit.synthesis.SuzukiTrotter.mdx | 4 +-
...it.synthesis.TwoQubitWeylDecomposition.mdx | 2 +-
...nthesis.unitary.aqc.ApproximateCircuit.mdx | 2 +-
...sis.unitary.aqc.ApproximatingObjective.mdx | 6 +-
....synthesis.unitary.aqc.CNOTUnitCircuit.mdx | 2 +-
...s.unitary.aqc.DefaultCNOTUnitObjective.mdx | 6 +-
...esis.unitary.aqc.FastCNOTUnitObjective.mdx | 8 +-
.../qiskit/qiskit.synthesis.unitary.aqc.mdx | 2 +-
docs/api/qiskit/qiskit.transpiler.Target.mdx | 2 +-
.../qiskit.transpiler.TranspileLayout.mdx | 18 +-
....transpiler.passes.DynamicalDecoupling.mdx | 8 +-
...qiskit.transpiler.passes.FilterOpNodes.mdx | 8 +-
...anspiler.passes.PadDynamicalDecoupling.mdx | 6 +-
...iskit.transpiler.passes.RemoveBarriers.mdx | 6 +-
...iskit.transpiler.passes.StarPreRouting.mdx | 14 +-
...ynthesis.aqc_plugin.AQCSynthesisPlugin.mdx | 4 +-
...is.hls_plugins.ACGSynthesisPermutation.mdx | 4 +-
...thesis.hls_plugins.AGSynthesisClifford.mdx | 4 +-
...thesis.hls_plugins.BMSynthesisClifford.mdx | 4 +-
....hls_plugins.BasicSynthesisPermutation.mdx | 4 +-
...s.hls_plugins.DefaultSynthesisClifford.mdx | 4 +-
...plugins.DefaultSynthesisLinearFunction.mdx | 4 +-
...esis.hls_plugins.FullAdderSynthesisC04.mdx | 4 +-
....hls_plugins.FullAdderSynthesisDefault.mdx | 4 +-
...esis.hls_plugins.FullAdderSynthesisV95.mdx | 4 +-
...is.hls_plugins.GreedySynthesisClifford.mdx | 4 +-
...esis.hls_plugins.HalfAdderSynthesisC04.mdx | 4 +-
...esis.hls_plugins.HalfAdderSynthesisD00.mdx | 4 +-
....hls_plugins.HalfAdderSynthesisDefault.mdx | 4 +-
...esis.hls_plugins.HalfAdderSynthesisV95.mdx | 4 +-
...hls_plugins.KMSSynthesisLinearFunction.mdx | 4 +-
...is.hls_plugins.KMSSynthesisPermutation.mdx | 4 +-
....hls_plugins.LayerLnnSynthesisClifford.mdx | 4 +-
...sis.hls_plugins.LayerSynthesisClifford.mdx | 4 +-
...hesis.hls_plugins.MCMTSynthesisDefault.mdx | 4 +-
...nthesis.hls_plugins.MCMTSynthesisNoAux.mdx | 4 +-
...thesis.hls_plugins.MCMTSynthesisVChain.mdx | 4 +-
...esis.hls_plugins.MCXSynthesis1CleanB95.mdx | 4 +-
...thesis.hls_plugins.MCXSynthesisDefault.mdx | 4 +-
...hesis.hls_plugins.MCXSynthesisGrayCode.mdx | 4 +-
...esis.hls_plugins.MCXSynthesisNCleanM15.mdx | 4 +-
...esis.hls_plugins.MCXSynthesisNDirtyI15.mdx | 4 +-
...hesis.hls_plugins.MCXSynthesisNoAuxV24.mdx | 4 +-
...s.hls_plugins.ModularAdderSynthesisC04.mdx | 4 +-
...s.hls_plugins.ModularAdderSynthesisD00.mdx | 4 +-
...s_plugins.ModularAdderSynthesisDefault.mdx | 4 +-
...s.hls_plugins.ModularAdderSynthesisV95.mdx | 4 +-
...sis.hls_plugins.MultiplierSynthesisH18.mdx | 4 +-
...sis.hls_plugins.MultiplierSynthesisR17.mdx | 4 +-
...hls_plugins.PMHSynthesisLinearFunction.mdx | 4 +-
...plugins.PauliEvolutionSynthesisDefault.mdx | 4 +-
..._plugins.PauliEvolutionSynthesisRustiq.mdx | 4 +-
...synthesis.hls_plugins.QFTSynthesisFull.mdx | 4 +-
...synthesis.hls_plugins.QFTSynthesisLine.mdx | 4 +-
...ugins.TokenSwapperSynthesisPermutation.mdx | 4 +-
...ynthesis.plugin.UnitarySynthesisPlugin.mdx | 2 +-
...itaev_synthesis.SolovayKitaevSynthesis.mdx | 2 +-
...tary_synthesis.DefaultUnitarySynthesis.mdx | 2 +-
.../qiskit.visualization.circuit_drawer.mdx | 4 +-
.../qiskit.visualization.dag_drawer.mdx | 2 +-
...t.visualization.plot_bloch_multivector.mdx | 8 +-
...qiskit.visualization.plot_bloch_vector.mdx | 10 +-
...skit.visualization.plot_circuit_layout.mdx | 4 +-
...qiskit.visualization.plot_coupling_map.mdx | 6 +-
...qiskit.visualization.plot_distribution.mdx | 10 +-
.../qiskit.visualization.plot_error_map.mdx | 4 +-
.../qiskit.visualization.plot_gate_map.mdx | 8 +-
.../qiskit.visualization.plot_histogram.mdx | 10 +-
.../qiskit.visualization.plot_state_city.mdx | 12 +-
...qiskit.visualization.plot_state_hinton.mdx | 12 +-
...skit.visualization.plot_state_paulivec.mdx | 10 +-
...iskit.visualization.plot_state_qsphere.mdx | 12 +-
.../qiskit.visualization.timeline_drawer.mdx | 12 +-
docs/api/qiskit/release-notes/1.3.mdx | 10 +-
docs/api/qiskit/result.mdx | 2 +-
docs/api/qiskit/synthesis.mdx | 18 +-
docs/api/qiskit/transpiler.mdx | 32 +-
docs/api/qiskit/transpiler_preset.mdx | 2 +-
docs/api/qiskit/visualization.mdx | 12 +-
public/images/api/qiskit/circuit-1.png | Bin 5373 -> 5373 bytes
public/images/api/qiskit/circuit-2.png | Bin 7971 -> 7734 bytes
public/images/api/qiskit/circuit-4.png | Bin 13896 -> 13896 bytes
.../images/api/qiskit/circuit_library-1.png | Bin 6289 -> 6289 bytes
public/images/api/qiskit/converters-1.png | Bin 8320 -> 8320 bytes
public/images/api/qiskit/depth.gif | Bin 2874095 -> 0 bytes
.../qiskit/providers_fake_provider-1_00.png | Bin 13102 -> 13102 bytes
.../qiskit/providers_fake_provider-1_01.png | Bin 22104 -> 22559 bytes
.../qiskit/providers_fake_provider-1_02.png | Bin 11275 -> 10577 bytes
public/images/api/qiskit/pulse-1.png | Bin 31312 -> 31312 bytes
public/images/api/qiskit/pulse-2.png | Bin 10927 -> 11029 bytes
public/images/api/qiskit/pulse-3.png | Bin 59323 -> 59915 bytes
public/images/api/qiskit/pulse-4.png | Bin 19219 -> 19061 bytes
public/images/api/qiskit/pulse-5.png | Bin 16529 -> 16409 bytes
public/images/api/qiskit/pulse-6.png | Bin 11604 -> 11509 bytes
public/images/api/qiskit/pulse-7.png | Bin 14199 -> 14315 bytes
public/images/api/qiskit/qasm3-1.png | Bin 25489 -> 25489 bytes
.../qiskit-circuit-ControlledGate-1.png | Bin 4578 -> 4578 bytes
.../qiskit-circuit-ControlledGate-2.png | Bin 7325 -> 7323 bytes
.../api/qiskit/qiskit-circuit-Operation-1.png | Bin 5879 -> 5879 bytes
.../qiskit/qiskit-circuit-Parameter-1_00.png | Bin 1689 -> 1689 bytes
.../qiskit/qiskit-circuit-Parameter-1_01.png | Bin 5370 -> 5370 bytes
.../qiskit-circuit-QuantumCircuit-1_00.png | Bin 3661 -> 3661 bytes
.../qiskit-circuit-QuantumCircuit-1_01.png | Bin 3635 -> 3635 bytes
.../qiskit-circuit-QuantumCircuit-2_00.png | Bin 3585 -> 3585 bytes
.../qiskit-circuit-QuantumCircuit-2_01.png | Bin 3913 -> 3913 bytes
.../qiskit-circuit-QuantumCircuit-3.png | Bin 4256 -> 4256 bytes
.../qiskit-circuit-QuantumCircuit-4.png | Bin 29666 -> 29666 bytes
.../qiskit-circuit-QuantumCircuit-5.png | Bin 3214 -> 3214 bytes
.../qiskit/qiskit-circuit-library-AND-1.png | Bin 16860 -> 16860 bytes
.../qiskit/qiskit-circuit-library-AND-2.png | Bin 17615 -> 17615 bytes
.../qiskit-circuit-library-AndGate-1.png | Bin 13053 -> 13071 bytes
.../qiskit-circuit-library-AndGate-2.png | Bin 15126 -> 15158 bytes
...iskit-circuit-library-BitwiseXorGate-1.png | Bin 14160 -> 14201 bytes
...skit-circuit-library-FourierChecking-1.png | Bin 11627 -> 11627 bytes
.../qiskit/qiskit-circuit-library-GMS-1.png | Bin 13316 -> 13316 bytes
.../qiskit/qiskit-circuit-library-GR-1.png | Bin 16936 -> 16936 bytes
.../qiskit/qiskit-circuit-library-GRX-1.png | Bin 16876 -> 16876 bytes
.../qiskit/qiskit-circuit-library-GRY-1.png | Bin 16936 -> 16936 bytes
.../qiskit/qiskit-circuit-library-GRZ-1.png | Bin 12094 -> 12094 bytes
.../qiskit-circuit-library-GraphState-1.png | Bin 15678 -> 15678 bytes
...iskit-circuit-library-GraphStateGate-1.png | Bin 8954 -> 8954 bytes
...circuit-library-HiddenLinearFunction-1.png | Bin 13076 -> 13076 bytes
.../qiskit/qiskit-circuit-library-IQP-1.png | Bin 6597 -> 6597 bytes
.../qiskit/qiskit-circuit-library-IQP-2.png | Bin 15203 -> 15203 bytes
.../qiskit-circuit-library-InnerProduct-1.png | Bin 14234 -> 14234 bytes
...kit-circuit-library-InnerProductGate-1.png | Bin 14261 -> 14351 bytes
.../qiskit-circuit-library-MCMTVChain-1.png | Bin 14771 -> 14771 bytes
.../qiskit/qiskit-circuit-library-OR-1.png | Bin 20577 -> 20577 bytes
.../qiskit/qiskit-circuit-library-OR-2.png | Bin 18664 -> 18664 bytes
.../qiskit-circuit-library-OrGate-1.png | Bin 18668 -> 18731 bytes
.../qiskit-circuit-library-OrGate-2.png | Bin 16465 -> 16547 bytes
...iskit-circuit-library-PauliTwoDesign-1.png | Bin 10538 -> 10538 bytes
.../qiskit-circuit-library-Permutation-1.png | Bin 9030 -> 9030 bytes
.../qiskit-circuit-library-Permutation-2.png | Bin 16568 -> 16568 bytes
...skit-circuit-library-PermutationGate-1.png | Bin 7616 -> 7616 bytes
...skit-circuit-library-PermutationGate-2.png | Bin 15983 -> 16042 bytes
...skit-circuit-library-PhaseEstimation-1.png | Bin 12165 -> 12206 bytes
...t-circuit-library-PiecewiseChebyshev-1.png | Bin 7636 -> 7636 bytes
.../qiskit/qiskit-circuit-library-QFT-1.png | Bin 11836 -> 11836 bytes
.../qiskit/qiskit-circuit-library-QFT-2.png | Bin 12001 -> 12001 bytes
.../qiskit/qiskit-circuit-library-QFT-3.png | Bin 12100 -> 12100 bytes
...qiskit-circuit-library-QuantumVolume-1.png | Bin 9389 -> 9389 bytes
...qiskit-circuit-library-QuantumVolume-2.png | Bin 19180 -> 19180 bytes
.../qiskit/qiskit-circuit-library-XOR-1.png | Bin 12259 -> 12259 bytes
...qiskit-circuit-library-efficient_su2-1.png | Bin 12067 -> 12067 bytes
...iskit-circuit-library-efficient_su2-2.png} | Bin 14753 -> 14753 bytes
...kit-circuit-library-efficient_su2-2_00.png | Bin 12067 -> 0 bytes
...cuit-library-evolved_operator_ansatz-1.png | Bin 15859 -> 15859 bytes
...ircuit-library-excitation_preserving-1.png | Bin 13137 -> 13137 bytes
...uit-library-excitation_preserving-2_00.png | Bin 13137 -> 13137 bytes
...uit-library-excitation_preserving-2_01.png | Bin 8939 -> 8939 bytes
...kit-circuit-library-fourier_checking-1.png | Bin 5145 -> 5145 bytes
...skit-circuit-library-grover_operator-1.png | Bin 8198 -> 8198 bytes
...kit-circuit-library-grover_operator-2.png} | Bin 4203 -> 4203 bytes
...t-circuit-library-grover_operator-2_00.png | Bin 8198 -> 0 bytes
...kit-circuit-library-grover_operator-3.png} | Bin 10867 -> 10867 bytes
...t-circuit-library-grover_operator-3_00.png | Bin 8198 -> 0 bytes
...t-circuit-library-grover_operator-3_01.png | Bin 4203 -> 0 bytes
...kit-circuit-library-grover_operator-4.png} | Bin 7794 -> 7794 bytes
...t-circuit-library-grover_operator-4_00.png | Bin 8198 -> 0 bytes
...t-circuit-library-grover_operator-4_01.png | Bin 4203 -> 0 bytes
...t-circuit-library-grover_operator-4_02.png | Bin 10867 -> 0 bytes
...brary-hamiltonian_variational_ansatz-1.png | Bin 9240 -> 9240 bytes
...brary-hamiltonian_variational_ansatz-2.png | Bin 9114 -> 9114 bytes
...rcuit-library-hidden_linear_function-1.png | Bin 5797 -> 5797 bytes
.../qiskit-circuit-library-iqp_function-1.png | Bin 9282 -> 9282 bytes
.../qiskit-circuit-library-iqp_function-2.png | Bin 15203 -> 15203 bytes
.../qiskit-circuit-library-n_local-1.png | Bin 14266 -> 14266 bytes
...g => qiskit-circuit-library-n_local-2.png} | Bin 13690 -> 13690 bytes
...g => qiskit-circuit-library-n_local-3.png} | Bin 13539 -> 13539 bytes
.../qiskit-circuit-library-n_local-3_00.png | Bin 14266 -> 0 bytes
.../qiskit-circuit-library-n_local-3_01.png | Bin 13690 -> 0 bytes
...g => qiskit-circuit-library-n_local-4.png} | Bin 8584 -> 8584 bytes
.../qiskit-circuit-library-n_local-4_00.png | Bin 14266 -> 0 bytes
.../qiskit-circuit-library-n_local-4_01.png | Bin 13690 -> 0 bytes
.../qiskit-circuit-library-n_local-4_02.png | Bin 13539 -> 0 bytes
.../qiskit-circuit-library-n_local-5.png | Bin 0 -> 14048 bytes
...kit-circuit-library-pauli_two_design-1.png | Bin 20859 -> 20859 bytes
...kit-circuit-library-phase_estimation-1.png | Bin 18053 -> 17986 bytes
.../qiskit-circuit-library-qaoa_ansatz-1.png | Bin 58349 -> 58349 bytes
...iskit-circuit-library-quantum_volume-1.png | Bin 14587 -> 14587 bytes
.../qiskit-circuit-library-random_iqp-1.png | Bin 8341 -> 8310 bytes
...skit-circuit-library-real_amplitudes-1.png | Bin 11554 -> 11554 bytes
...kit-circuit-library-real_amplitudes-2.png} | Bin 13425 -> 13425 bytes
...t-circuit-library-real_amplitudes-2_00.png | Bin 11554 -> 0 bytes
...kit-circuit-library-real_amplitudes-3.png} | Bin 14266 -> 14266 bytes
...t-circuit-library-real_amplitudes-3_00.png | Bin 11554 -> 0 bytes
...t-circuit-library-real_amplitudes-3_01.png | Bin 13425 -> 0 bytes
...t-circuit-library-real_amplitudes-3_02.png | Bin 14266 -> 0 bytes
...kit-circuit-library-real_amplitudes-4.png} | Bin 12896 -> 12896 bytes
...t-circuit-library-real_amplitudes-4_00.png | Bin 11554 -> 0 bytes
...t-circuit-library-real_amplitudes-4_01.png | Bin 13425 -> 0 bytes
...t-circuit-library-real_amplitudes-4_02.png | Bin 14266 -> 0 bytes
...skit-circuit-library-unitary_overlap-1.png | Bin 10010 -> 10889 bytes
...skit-primitives-StatevectorEstimator-1.png | Bin 43580 -> 43580 bytes
.../qiskit-pulse-library-SymbolicPulse-1.png | Bin 11401 -> 11401 bytes
.../qiskit-quantum_info-Statevector-1.png | Bin 7558 -> 7558 bytes
.../qiskit-transpiler-TranspileLayout-1.png | Bin 9589 -> 9589 bytes
.../qiskit-transpiler-TranspileLayout-2.png | Bin 5357 -> 5357 bytes
.../qiskit-transpiler-TranspileLayout-3.png | Bin 6029 -> 6029 bytes
...spiler-passes-DynamicalDecoupling-1_00.png | Bin 22803 -> 22803 bytes
...spiler-passes-DynamicalDecoupling-1_01.png | Bin 23583 -> 23583 bytes
...skit-transpiler-passes-FilterOpNodes-1.png | Bin 1637 -> 1637 bytes
...ler-passes-PadDynamicalDecoupling-1_00.png | Bin 22803 -> 22803 bytes
...ler-passes-PadDynamicalDecoupling-1_01.png | Bin 23583 -> 23583 bytes
...kit-transpiler-passes-RemoveBarriers-1.png | Bin 1593 -> 1593 bytes
...kit-transpiler-passes-StarPreRouting-1.png | Bin 49789 -> 49789 bytes
.../qiskit-visualization-circuit_drawer-1.png | Bin 3214 -> 3214 bytes
...visualization-plot_bloch_multivector-1.png | Bin 97054 -> 97054 bytes
...visualization-plot_bloch_multivector-2.png | Bin 99845 -> 99845 bytes
...skit-visualization-plot_bloch_vector-1.png | Bin 76275 -> 76275 bytes
...skit-visualization-plot_bloch_vector-2.png | Bin 77587 -> 77587 bytes
...it-visualization-plot_circuit_layout-1.png | Bin 10390 -> 10152 bytes
...skit-visualization-plot_coupling_map-1.png | Bin 8007 -> 8089 bytes
...t-visualization-plot_distribution-1_00.png | Bin 14124 -> 14124 bytes
...t-visualization-plot_distribution-1_01.png | Bin 16685 -> 16685 bytes
...t-visualization-plot_distribution-1_02.png | Bin 16681 -> 16681 bytes
.../qiskit-visualization-plot_error_map-1.png | Bin 49528 -> 50251 bytes
.../qiskit-visualization-plot_gate_map-1.png | Bin 8595 -> 8688 bytes
...skit-visualization-plot_histogram-1_00.png | Bin 10255 -> 10255 bytes
...skit-visualization-plot_histogram-1_01.png | Bin 12587 -> 12587 bytes
...skit-visualization-plot_histogram-1_02.png | Bin 12639 -> 12639 bytes
...qiskit-visualization-plot_state_city-1.png | Bin 115263 -> 115263 bytes
...qiskit-visualization-plot_state_city-2.png | Bin 153769 -> 153769 bytes
...skit-visualization-plot_state_hinton-1.png | Bin 11116 -> 11116 bytes
...it-visualization-plot_state_paulivec-1.png | Bin 17337 -> 17337 bytes
...it-visualization-plot_state_paulivec-2.png | Bin 18522 -> 18522 bytes
...kit-visualization-plot_state_qsphere-1.png | Bin 35058 -> 35058 bytes
...kit-visualization-plot_state_qsphere-2.png | Bin 39591 -> 39591 bytes
...qiskit-visualization-timeline_drawer-1.png | Bin 15905 -> 15999 bytes
...qiskit-visualization-timeline_drawer-2.png | Bin 8104 -> 8375 bytes
...qiskit-visualization-timeline_drawer-3.png | Bin 25652 -> 27128 bytes
public/images/api/qiskit/release_notes-1.png | Bin 4046 -> 4046 bytes
public/images/api/qiskit/release_notes-2.png | Bin 8198 -> 8198 bytes
public/images/api/qiskit/release_notes-3.png | Bin 13433 -> 12198 bytes
public/images/api/qiskit/release_notes-4.png | Bin 15830 -> 15830 bytes
public/images/api/qiskit/release_notes-5.png | Bin 18950 -> 18950 bytes
public/images/api/qiskit/release_notes-6.png | Bin 288463 -> 288463 bytes
public/images/api/qiskit/release_notes-7.png | Bin 2801 -> 2801 bytes
public/images/api/qiskit/release_notes-8.png | Bin 1454 -> 1454 bytes
public/images/api/qiskit/synthesis-1.png | Bin 23473 -> 23473 bytes
public/images/api/qiskit/synthesis-2.png | Bin 148257 -> 148257 bytes
public/images/api/qiskit/transpiler-10.png | Bin 7413 -> 7480 bytes
public/images/api/qiskit/transpiler-11.png | Bin 36154 -> 36154 bytes
public/images/api/qiskit/transpiler-12.png | Bin 8534 -> 8534 bytes
public/images/api/qiskit/transpiler-13.png | Bin 36154 -> 36154 bytes
public/images/api/qiskit/transpiler-14.png | Bin 20314 -> 20314 bytes
public/images/api/qiskit/transpiler-15.png | Bin 9699 -> 9699 bytes
public/images/api/qiskit/transpiler-16.png | Bin 24101 -> 23902 bytes
public/images/api/qiskit/transpiler-17.png | Bin 19352 -> 19116 bytes
public/images/api/qiskit/transpiler-4.png | Bin 6289 -> 6289 bytes
public/images/api/qiskit/transpiler-5.png | Bin 19977 -> 20089 bytes
public/images/api/qiskit/transpiler-6.png | Bin 10473 -> 10473 bytes
public/images/api/qiskit/transpiler-7.png | Bin 12152 -> 12152 bytes
public/images/api/qiskit/transpiler-8.png | Bin 7454 -> 7452 bytes
public/images/api/qiskit/transpiler-9.png | Bin 7385 -> 7451 bytes
public/images/api/qiskit/visualization-1.png | Bin 8219 -> 8219 bytes
public/images/api/qiskit/visualization-2.png | Bin 15392 -> 15392 bytes
public/images/api/qiskit/visualization-3.png | Bin 7806 -> 7806 bytes
public/images/api/qiskit/visualization-4.png | Bin 109432 -> 109432 bytes
public/images/api/qiskit/visualization-5.png | Bin 111196 -> 111196 bytes
public/images/api/qiskit/visualization-6.png | Bin 111196 -> 111196 bytes
scripts/js/commands/checkImages.ts | 7 +-
354 files changed, 690 insertions(+), 727 deletions(-)
delete mode 100644 public/images/api/qiskit/depth.gif
rename public/images/api/qiskit/{qiskit-circuit-library-efficient_su2-2_01.png => qiskit-circuit-library-efficient_su2-2.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-efficient_su2-2_00.png
rename public/images/api/qiskit/{qiskit-circuit-library-grover_operator-2_01.png => qiskit-circuit-library-grover_operator-2.png} (98%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-grover_operator-2_00.png
rename public/images/api/qiskit/{qiskit-circuit-library-grover_operator-3_02.png => qiskit-circuit-library-grover_operator-3.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_00.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-grover_operator-3_01.png
rename public/images/api/qiskit/{qiskit-circuit-library-grover_operator-4_03.png => qiskit-circuit-library-grover_operator-4.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_00.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_01.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-grover_operator-4_02.png
rename public/images/api/qiskit/{qiskit-circuit-library-n_local-2_01.png => qiskit-circuit-library-n_local-2.png} (99%)
rename public/images/api/qiskit/{qiskit-circuit-library-n_local-3_02.png => qiskit-circuit-library-n_local-3.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-n_local-3_00.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-n_local-3_01.png
rename public/images/api/qiskit/{qiskit-circuit-library-n_local-4_03.png => qiskit-circuit-library-n_local-4.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-n_local-4_00.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-n_local-4_01.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-n_local-4_02.png
create mode 100644 public/images/api/qiskit/qiskit-circuit-library-n_local-5.png
rename public/images/api/qiskit/{qiskit-circuit-library-real_amplitudes-2_01.png => qiskit-circuit-library-real_amplitudes-2.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-2_00.png
rename public/images/api/qiskit/{qiskit-circuit-library-n_local-2_00.png => qiskit-circuit-library-real_amplitudes-3.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_00.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_01.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-3_02.png
rename public/images/api/qiskit/{qiskit-circuit-library-real_amplitudes-4_03.png => qiskit-circuit-library-real_amplitudes-4.png} (99%)
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_00.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_01.png
delete mode 100644 public/images/api/qiskit/qiskit-circuit-library-real_amplitudes-4_02.png
diff --git a/docs/api/qiskit/circuit.mdx b/docs/api/qiskit/circuit.mdx
index 5d842e82324..96fa83c6153 100644
--- a/docs/api/qiskit/circuit.mdx
+++ b/docs/api/qiskit/circuit.mdx
@@ -59,7 +59,7 @@ circ.cx(0, 2)
circ.draw('mpl')
```
-![../\_images/circuit-1.png](/images/api/qiskit/circuit-1.png)
+![Circuit diagram output by the previous code.](/images/api/qiskit/circuit-1.png)
@@ -896,7 +896,7 @@ Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`](
#### random\_circuit
-
+
Generate random circuit of arbitrary size and form.
This function will generate a random circuit by randomly selecting gates from the set of standard gates in `qiskit.circuit.library.standard_gates`. For example:
@@ -908,7 +908,7 @@ Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`](
circ.draw(output='mpl')
```
- ![../\_images/circuit-2.png](/images/api/qiskit/circuit-2.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/circuit-2.png)
**Parameters**
@@ -1027,7 +1027,7 @@ If we draw this circuit, we will see that Qiskit places the zeroth qubit on the
qc.draw("mpl")
```
-![../\_images/circuit-4.png](/images/api/qiskit/circuit-4.png)
+![Circuit diagram output by the previous code.](/images/api/qiskit/circuit-4.png)
### Matrix representations
@@ -1038,7 +1038,7 @@ $$
\leftrightarrow \begin{pmatrix} \alpha \\ \beta \end{pmatrix}
$$
-where $\alpha$ and $\beta$ are complex numbers. We store the statevector as a 1D Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.1)") with data `sv = [alpha, beta]`, *i.e.* `sv[0] == alpha` and `sv[1] == beta`; note that the indices into the statevector match the ket labels.
+where $\alpha$ and $\beta$ are complex numbers. We store the statevector as a 1D Numpy [`ndarray`](https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray "(in NumPy v2.2)") with data `sv = [alpha, beta]`, *i.e.* `sv[0] == alpha` and `sv[1] == beta`; note that the indices into the statevector match the ket labels.
We construct [the tensor product of two qubit states](https://en.wikipedia.org/wiki/Tensor_product) in matrix algebra using [the Kronecker product](https://en.wikipedia.org/wiki/Kronecker_product), with qubit 0 on the right and qubit 1 on the left, such that the $Z$ basis state $\lvert x\rangle$ (where $x$ is the integer interpretation of the bitstring) has its non-zero term in the statevector `sv` at `sv[x]`:
diff --git a/docs/api/qiskit/circuit_library.mdx b/docs/api/qiskit/circuit_library.mdx
index 5e934bd12fb..221e02344e1 100644
--- a/docs/api/qiskit/circuit_library.mdx
+++ b/docs/api/qiskit/circuit_library.mdx
@@ -30,7 +30,7 @@ circuit.append(gate, [0, 1, 4, 2, 3])
circuit.draw('mpl')
```
-![../\_images/circuit\_library-1.png](/images/api/qiskit/circuit_library-1.png)
+![Circuit diagram output by the previous code.](/images/api/qiskit/circuit_library-1.png)
The library is organized in several sections. The function [`get_standard_gate_name_mapping()`](#qiskit.circuit.library.get_standard_gate_name_mapping "qiskit.circuit.library.get_standard_gate_name_mapping") allows you to see the available standard gates and operations.
diff --git a/docs/api/qiskit/converters.mdx b/docs/api/qiskit/converters.mdx
index 31fe3198665..d7f8f095a3f 100644
--- a/docs/api/qiskit/converters.mdx
+++ b/docs/api/qiskit/converters.mdx
@@ -138,7 +138,7 @@ python_api_name: qiskit.converters
### dag\_to\_circuit
-
+
Build a `QuantumCircuit` object from a `DAGCircuit`.
**Parameters**
@@ -175,7 +175,7 @@ python_api_name: qiskit.converters
circuit.draw('mpl')
```
- ![../\_images/converters-1.png](/images/api/qiskit/converters-1.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/converters-1.png)
diff --git a/docs/api/qiskit/providers_fake_provider.mdx b/docs/api/qiskit/providers_fake_provider.mdx
index 5bf4099ae32..e87a639bc59 100644
--- a/docs/api/qiskit/providers_fake_provider.mdx
+++ b/docs/api/qiskit/providers_fake_provider.mdx
@@ -50,11 +50,11 @@ counts = job.result().get_counts()
plot_histogram(counts)
```
-![../\_images/providers\_fake\_provider-1\_00.png](/images/api/qiskit/providers_fake_provider-1_00.png)
+![Output from the previous code.](/images/api/qiskit/providers_fake_provider-1_00.png)
-![../\_images/providers\_fake\_provider-1\_01.png](/images/api/qiskit/providers_fake_provider-1_01.png)
+![Output from the previous code.](/images/api/qiskit/providers_fake_provider-1_01.png)
-![../\_images/providers\_fake\_provider-1\_02.png](/images/api/qiskit/providers_fake_provider-1_02.png)
+![Output from the previous code.](/images/api/qiskit/providers_fake_provider-1_02.png)
## V2 Simulated Backends
diff --git a/docs/api/qiskit/pulse.mdx b/docs/api/qiskit/pulse.mdx
index 72151877a34..1827b88bbe3 100644
--- a/docs/api/qiskit/pulse.mdx
+++ b/docs/api/qiskit/pulse.mdx
@@ -603,7 +603,7 @@ with pulse.build(name='pulse_programming_in') as pulse_prog:
pulse_prog.draw()
```
-![../\_images/pulse-1.png](/images/api/qiskit/pulse-1.png)
+![Output from the previous code.](/images/api/qiskit/pulse-1.png)
To begin pulse programming we must first initialize our program builder context with [`build()`](#qiskit.pulse.builder.build "qiskit.pulse.builder.build"), after which we can begin adding program statements. For example, below we write a simple program that [`play()`](#qiskit.pulse.builder.play "qiskit.pulse.builder.play")s a pulse:
@@ -618,7 +618,7 @@ with pulse.build() as pulse_prog:
pulse_prog.draw()
```
-![../\_images/pulse-2.png](/images/api/qiskit/pulse-2.png)
+![Output from the previous code.](/images/api/qiskit/pulse-2.png)
The builder initializes a [`pulse.Schedule`](qiskit.pulse.Schedule "qiskit.pulse.Schedule"), `pulse_prog` and then begins to construct the program within the context. The output pulse schedule will survive after the context is exited and can be used like a normal Qiskit schedule.
@@ -659,7 +659,7 @@ with pulse.build(backend) as decoupled_bell_prep_and_measure:
decoupled_bell_prep_and_measure.draw()
```
-![../\_images/pulse-3.png](/images/api/qiskit/pulse-3.png)
+![Output from the previous code.](/images/api/qiskit/pulse-3.png)
With the pulse builder we are able to blend programming on qubits and channels. While the pulse schedule is based on instructions that operate on channels, the pulse builder automatically handles the mapping from qubits to channels for you.
@@ -772,7 +772,7 @@ The above is just a small taste of what is possible with the builder. See the re
### build
-
+
Create a context manager for launching the imperative pulse builder DSL.
To enter a building context and starting building a pulse program:
@@ -836,7 +836,7 @@ DriveChannel(0)
#### acquire\_channel
-
+
Return `AcquireChannel` for `qubit` on the active builder backend.
@@ -870,7 +870,7 @@ DriveChannel(0)
#### control\_channels
-
+
Return `ControlChannel` for `qubit` on the active builder backend.
Return the secondary drive channel for the given qubit – typically utilized for controlling multi-qubit interactions.
@@ -909,7 +909,7 @@ DriveChannel(0)
#### drive\_channel
-
+
Return `DriveChannel` for `qubit` on the active builder backend.
@@ -943,7 +943,7 @@ DriveChannel(0)
#### measure\_channel
-
+
Return `MeasureChannel` for `qubit` on the active builder backend.
@@ -1006,11 +1006,11 @@ with pulse.build(backend) as drive_sched:
drive_sched.draw()
```
-![../\_images/pulse-4.png](/images/api/qiskit/pulse-4.png)
+![Output from the previous code.](/images/api/qiskit/pulse-4.png)
#### acquire
-
+
Acquire for a `duration` on a `channel` and store the result in a `register`.
@@ -1051,7 +1051,7 @@ drive_sched.draw()
#### barrier
-
+
Barrier directive for a set of channels and qubits.
This directive prevents the compiler from moving instructions across the barrier. Consider the case where we want to enforce that one pulse happens after another on separate channels, this can be done with:
@@ -1126,7 +1126,7 @@ drive_sched.draw()
#### call
-
+
Call the subroutine within the currently active builder context with arbitrary parameters which will be assigned to the target program.
@@ -1299,7 +1299,7 @@ drive_sched.draw()
#### delay
-
+
Delay on a `channel` for a `duration`.
@@ -1326,7 +1326,7 @@ drive_sched.draw()
#### play
-
+
Play a `pulse` on a `channel`.
@@ -1353,7 +1353,7 @@ drive_sched.draw()
#### reference
-
+
Refer to undefined subroutine by string keys.
A [`Reference`](qiskit.pulse.instructions.Reference "qiskit.pulse.instructions.Reference") instruction is implicitly created and a schedule can be separately registered to the reference at a later stage.
@@ -1382,7 +1382,7 @@ drive_sched.draw()
#### set\_frequency
-
+
Set the `frequency` of a pulse `channel`.
@@ -1409,7 +1409,7 @@ drive_sched.draw()
#### set\_phase
-
+
Set the `phase` of a pulse `channel`.
@@ -1438,7 +1438,7 @@ drive_sched.draw()
#### shift\_frequency
-
+
Shift the `frequency` of a pulse `channel`.
@@ -1465,7 +1465,7 @@ drive_sched.draw()
#### shift\_phase
-
+
Shift the `phase` of a pulse `channel`.
@@ -1494,7 +1494,7 @@ drive_sched.draw()
#### snapshot
-
+
Simulator snapshot.
@@ -1536,11 +1536,11 @@ with pulse.build() as pulse_prog:
pulse_prog.draw()
```
-![../\_images/pulse-5.png](/images/api/qiskit/pulse-5.png)
+![Output from the previous code.](/images/api/qiskit/pulse-5.png)
#### align\_equispaced
-
+
Equispaced alignment pulse scheduling context.
Pulse instructions within this context are scheduled with the same interval spacing such that the total length of the context block is `duration`. If the total free `duration` cannot be evenly divided by the number of instructions within the context, the modulo is split and then prepended and appended to the returned schedule. Delay instructions are automatically inserted in between pulses.
@@ -1569,7 +1569,7 @@ pulse_prog.draw()
hahn_echo.draw()
```
- ![../\_images/pulse-6.png](/images/api/qiskit/pulse-6.png)
+ ![Output from the previous code.](/images/api/qiskit/pulse-6.png)
**Parameters**
@@ -1590,7 +1590,7 @@ pulse_prog.draw()
#### align\_func
-
+
Callback defined alignment pulse scheduling context.
Pulse instructions within this context are scheduled at the location specified by arbitrary callback function position that takes integer index and returns the associated fractional location within \[0, 1]. Delay instruction is automatically inserted in between pulses.
@@ -1624,7 +1624,7 @@ pulse_prog.draw()
udd_sched.draw()
```
- ![../\_images/pulse-7.png](/images/api/qiskit/pulse-7.png)
+ ![Output from the previous code.](/images/api/qiskit/pulse-7.png)
**Parameters**
@@ -1646,7 +1646,7 @@ pulse_prog.draw()
#### align\_left
-
+
Left alignment pulse scheduling context.
Pulse instructions within this context are scheduled as early as possible by shifting them left to the earliest available time.
@@ -1685,7 +1685,7 @@ pulse_prog.draw()
#### align\_right
-
+
Right alignment pulse scheduling context.
Pulse instructions within this context are scheduled as late as possible by shifting them right to the latest available time.
@@ -1724,7 +1724,7 @@ pulse_prog.draw()
#### align\_sequential
-
+
Sequential alignment pulse scheduling context.
Pulse instructions within this context are scheduled sequentially in time such that no two instructions will be played at the same time.
@@ -1763,7 +1763,7 @@ pulse_prog.draw()
#### frequency\_offset
-
+
Shift the frequency of inputs channels on entry into context and undo on exit.
@@ -1813,7 +1813,7 @@ pulse_prog.draw()
#### phase\_offset
-
+
Shift the phase of input channels on entry into context and undo on exit.
@@ -1871,7 +1871,7 @@ MemorySlot(0)
#### measure
-
+
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") and [`play()`](#qiskit.pulse.builder.play "qiskit.pulse.builder.play").
@@ -1930,7 +1930,7 @@ MemorySlot(0)
#### measure\_all
-
+
Measure all qubits within the currently active builder context.
A simple macro function to measure all of the qubits in the device at the same time. This is useful for handling device `meas_map` and single measurement constraints.
@@ -1967,7 +1967,7 @@ MemorySlot(0)
#### delay\_qubits
-
+
Insert delays on all the `channels.Channel`s that correspond to the input `qubits` at the same time.
@@ -2028,7 +2028,7 @@ There are 1e-06 seconds in 4500 samples.
#### active\_backend
-
+
Get the backend of the currently active builder context.
@@ -2052,7 +2052,7 @@ There are 1e-06 seconds in 4500 samples.
#### num\_qubits
-
+
Return number of qubits in the currently active backend.
@@ -2086,7 +2086,7 @@ There are 1e-06 seconds in 4500 samples.
#### qubit\_channels
-
+
Returns the set of channels associated with a qubit.
@@ -2128,7 +2128,7 @@ There are 1e-06 seconds in 4500 samples.
#### samples\_to\_seconds
-
+
Obtain the time in seconds that will elapse for the input number of samples on the active backend.
@@ -2150,7 +2150,7 @@ There are 1e-06 seconds in 4500 samples.
#### seconds\_to\_samples
-
+
Obtain the number of samples that will elapse in `seconds` on the active backend.
Rounds down.
diff --git a/docs/api/qiskit/qasm3.mdx b/docs/api/qiskit/qasm3.mdx
index f3350501f38..d2f9a842701 100644
--- a/docs/api/qiskit/qasm3.mdx
+++ b/docs/api/qiskit/qasm3.mdx
@@ -24,7 +24,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.
### dump
-
+
Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object as an OpenQASM 3 stream to file-like object.
**Parameters**
@@ -40,7 +40,7 @@ The high-level functions are simply [`dump()`](#qiskit.qasm3.dump "qiskit.qasm3.
### dumps
-
+
Serialize a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") object in an OpenQASM 3 string.
**Parameters**
@@ -227,7 +227,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor
### load
-
+
Load an OpenQASM 3 program from the file `filename`.
**Parameters**
@@ -249,7 +249,7 @@ Currently only two high-level functions are offered, as Qiskit support for impor
### loads
-
+
Load an OpenQASM 3 program from the given string.
**Parameters**
@@ -330,7 +330,7 @@ circuit = qiskit.qasm3.loads(program)
circuit.draw("mpl")
```
-![../\_images/qasm3-1.png](/images/api/qiskit/qasm3-1.png)
+![Circuit diagram output by the previous code.](/images/api/qiskit/qasm3-1.png)
### Experimental import interface
diff --git a/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx b/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx
index 9394948b1b3..7ee20850fba 100644
--- a/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx
+++ b/docs/api/qiskit/qiskit.circuit.ControlledGate.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.ControlledGate
# ControlledGate
-
+
Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")
Controlled unitary gate.
@@ -46,7 +46,7 @@ python_api_name: qiskit.circuit.ControlledGate
qc.draw('mpl')
```
- ![../\_images/qiskit-circuit-ControlledGate-1.png](/images/api/qiskit/qiskit-circuit-ControlledGate-1.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-ControlledGate-1.png)
Create a controlled custom gate and apply it to a circuit.
@@ -64,7 +64,7 @@ python_api_name: qiskit.circuit.ControlledGate
qc2.draw('mpl')
```
- ![../\_images/qiskit-circuit-ControlledGate-2.png](/images/api/qiskit/qiskit-circuit-ControlledGate-2.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-ControlledGate-2.png)
## Attributes
@@ -343,7 +343,7 @@ python_api_name: qiskit.circuit.ControlledGate
### inverse
-
+
Invert this gate by calling inverse on the base gate.
**Parameters**
diff --git a/docs/api/qiskit/qiskit.circuit.Operation.mdx b/docs/api/qiskit/qiskit.circuit.Operation.mdx
index 0b22409f848..eb9f3416830 100644
--- a/docs/api/qiskit/qiskit.circuit.Operation.mdx
+++ b/docs/api/qiskit/qiskit.circuit.Operation.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Operation
# Operation
-
+
Bases: [`ABC`](https://docs.python.org/3/library/abc.html#abc.ABC "(in Python v3.13)")
Quantum operation interface.
@@ -34,7 +34,7 @@ python_api_name: qiskit.circuit.Operation
qc.draw('mpl')
```
- ![../\_images/qiskit-circuit-Operation-1.png](/images/api/qiskit/qiskit-circuit-Operation-1.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-Operation-1.png)
## Attributes
diff --git a/docs/api/qiskit/qiskit.circuit.Parameter.mdx b/docs/api/qiskit/qiskit.circuit.Parameter.mdx
index b9bd8960e9d..258166f3f05 100644
--- a/docs/api/qiskit/qiskit.circuit.Parameter.mdx
+++ b/docs/api/qiskit/qiskit.circuit.Parameter.mdx
@@ -8,7 +8,7 @@ python_api_name: qiskit.circuit.Parameter
# Parameter
-
+
Bases: [`ParameterExpression`](qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")
A compile-time symbolic parameter.
@@ -38,9 +38,9 @@ python_api_name: qiskit.circuit.Parameter
bc.draw('mpl')
```
- ![../\_images/qiskit-circuit-Parameter-1\_00.png](/images/api/qiskit/qiskit-circuit-Parameter-1_00.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-Parameter-1_00.png)
- ![../\_images/qiskit-circuit-Parameter-1\_01.png](/images/api/qiskit/qiskit-circuit-Parameter-1_01.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-Parameter-1_01.png)
**Parameters**
@@ -97,7 +97,7 @@ python_api_name: qiskit.circuit.Parameter
### assign
-
+
Assign one parameter to a value, which can either be numeric or another parameter expression.
**Parameters**
@@ -227,7 +227,7 @@ python_api_name: qiskit.circuit.Parameter
### subs
-
+
Substitute self with the corresponding parameter in `parameter_map`.
**Parameters**
diff --git a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx
index b179fab1506..a8ff25ca44d 100644
--- a/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx
+++ b/docs/api/qiskit/qiskit.circuit.QuantumCircuit.mdx
@@ -12,7 +12,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
# [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit") class
-
+
Bases: [`object`](https://docs.python.org/3/library/functions.html#object "(in Python v3.13)")
Core Qiskit representation of a quantum circuit.
@@ -327,7 +327,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
### \_\_init\_\_
-
+
Default constructor of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
**Parameters**
@@ -379,7 +379,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
### copy
-
+
Copy the circuit.
**Parameters**
@@ -399,7 +399,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
### copy\_empty\_like
-
+
Return a copy of self with the same structure but empty.
That structure includes:
@@ -446,7 +446,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
### from\_instructions
-
+
Construct a circuit from an iterable of [`CircuitInstruction`](qiskit.circuit.CircuitInstruction "qiskit.circuit.CircuitInstruction")s.
**Parameters**
@@ -471,7 +471,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
### from\_qasm\_file
-
+
Read an OpenQASM 2.0 program from a file and convert to an instance of [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
**Parameters**
@@ -493,7 +493,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
### from\_qasm\_str
-
+
Convert a string containing an OpenQASM 2.0 program to a [`QuantumCircuit`](#qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
**Parameters**
@@ -534,7 +534,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### add\_bits
-
+
Add Bits to the circuit.
**Parameters**
@@ -550,7 +550,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### add\_register
-
+
Add registers.
**Parameters**
@@ -566,7 +566,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### add\_var
-
+
Add a classical variable with automatic storage and scope to this circuit.
The variable is considered to have been “declared” at the beginning of the circuit, but it only becomes initialized at the point of the circuit that you call this method, so it can depend on variables defined before it.
@@ -636,7 +636,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### add\_input
-
+
Register a variable as an input to the circuit.
**Parameters**
@@ -657,7 +657,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### add\_uninitialized\_var
-
+
Add a variable with no initializer.
In most cases, you should use [`add_var()`](#qiskit.circuit.QuantumCircuit.add_var "qiskit.circuit.QuantumCircuit.add_var") to initialize the variable. To use this function, you must already hold a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") instance, as the use of the function typically only makes sense in copying contexts.
@@ -675,7 +675,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### add\_capture
-
+
Add a variable to the circuit that it should capture from a scope it will be contained within.
This method requires a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node to enforce that you’ve got a handle to one, because you will need to declare the same variable using the same object into the outer circuit.
@@ -697,7 +697,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### find\_bit
-
+
Find locations in the circuit which can be used to reference a given [`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit").
In particular, this function can find the integer index of a qubit, which corresponds to its hardware index for a transpiled circuit.
@@ -756,7 +756,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### has\_register
-
+
Test if this circuit has the register r.
**Parameters**
@@ -786,7 +786,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### assign\_parameters
-
+
Assign parameters to new parameters or values.
If `parameters` is passed as a dictionary, the keys should be [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances in the current circuit. The values of the dictionary can either be numeric values or new parameter objects.
@@ -833,9 +833,9 @@ python_api_name: qiskit.circuit.QuantumCircuit
circuit.draw('mpl')
```
- ![../\_images/qiskit-circuit-QuantumCircuit-1\_00.png](/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_00.png)
- ![../\_images/qiskit-circuit-QuantumCircuit-1\_01.png](/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-QuantumCircuit-1_01.png)
Bind the values out-of-place by list and get a copy of the original circuit.
@@ -853,16 +853,16 @@ python_api_name: qiskit.circuit.QuantumCircuit
circuit.draw('mpl')
```
- ![../\_images/qiskit-circuit-QuantumCircuit-2\_00.png](/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_00.png)
- ![../\_images/qiskit-circuit-QuantumCircuit-2\_01.png](/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-QuantumCircuit-2_01.png)
The circuit tracks parameters by [`Parameter`](qiskit.circuit.Parameter "qiskit.circuit.Parameter") instances themselves, and forbids having multiple parameters of the same name to avoid some problems when interoperating with OpenQASM or other external formats. You can use [`has_parameter()`](#qiskit.circuit.QuantumCircuit.has_parameter "qiskit.circuit.QuantumCircuit.has_parameter") and [`get_parameter()`](#qiskit.circuit.QuantumCircuit.get_parameter "qiskit.circuit.QuantumCircuit.get_parameter") to query the circuit for a parameter with the given string name.
#### has\_parameter
-
+
Check whether a parameter object exists in this circuit.
**Parameters**
@@ -890,7 +890,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### get\_parameter
-
+
Retrieve a compile-time parameter that is accessible in this circuit scope by name.
**Parameters**
@@ -962,7 +962,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### get\_var
-
+
Retrieve a variable that is accessible in this circuit scope by name.
**Parameters**
@@ -1012,7 +1012,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### has\_var
-
+
Check whether a variable is accessible in this scope.
**Parameters**
@@ -1042,7 +1042,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### iter\_vars
-
+
Get an iterable over all real-time classical variables in scope within this circuit.
This method will iterate over all variables in scope. For more fine-grained iterators, see [`iter_declared_vars()`](#qiskit.circuit.QuantumCircuit.iter_declared_vars "qiskit.circuit.QuantumCircuit.iter_declared_vars"), [`iter_input_vars()`](#qiskit.circuit.QuantumCircuit.iter_input_vars "qiskit.circuit.QuantumCircuit.iter_input_vars") and [`iter_captured_vars()`](#qiskit.circuit.QuantumCircuit.iter_captured_vars "qiskit.circuit.QuantumCircuit.iter_captured_vars").
@@ -1054,7 +1054,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### iter\_input\_vars
-
+
Get an iterable over all real-time classical variables that are declared as inputs to this circuit scope. This excludes locally declared variables (see [`iter_declared_vars()`](#qiskit.circuit.QuantumCircuit.iter_declared_vars "qiskit.circuit.QuantumCircuit.iter_declared_vars")) and captured variables (see [`iter_captured_vars()`](#qiskit.circuit.QuantumCircuit.iter_captured_vars "qiskit.circuit.QuantumCircuit.iter_captured_vars")).
**Return type**
@@ -1064,7 +1064,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### iter\_captured\_vars
-
+
Get an iterable over all real-time classical variables that are captured by this circuit scope from a containing scope. This excludes input variables (see [`iter_input_vars()`](#qiskit.circuit.QuantumCircuit.iter_input_vars "qiskit.circuit.QuantumCircuit.iter_input_vars")) and locally declared variables (see [`iter_declared_vars()`](#qiskit.circuit.QuantumCircuit.iter_declared_vars "qiskit.circuit.QuantumCircuit.iter_declared_vars")).
**Return type**
@@ -1074,7 +1074,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### iter\_declared\_vars
-
+
Get an iterable over all real-time classical variables that are declared with automatic storage duration in this scope. This excludes input variables (see [`iter_input_vars()`](#qiskit.circuit.QuantumCircuit.iter_input_vars "qiskit.circuit.QuantumCircuit.iter_input_vars")) and captured variables (see [`iter_captured_vars()`](#qiskit.circuit.QuantumCircuit.iter_captured_vars "qiskit.circuit.QuantumCircuit.iter_captured_vars")).
**Return type**
@@ -1117,7 +1117,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### append
-
+
Append one or more instructions to the end of the circuit, modifying the circuit in place.
The `qargs` and `cargs` will be expanded and broadcast according to the rules of the given [`Instruction`](qiskit.circuit.Instruction "qiskit.circuit.Instruction"), and any non-[`Bit`](circuit#qiskit.circuit.Bit "qiskit.circuit.Bit") specifiers (such as integer indices) will be resolved into the relevant instances.
@@ -1148,7 +1148,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### \_append
-
+
Append an instruction to the end of the circuit, modifying the circuit in place.
@@ -1190,7 +1190,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### compose
-
+
Apply the instructions from one circuit onto specified qubits and/or clbits on another.
@@ -1272,7 +1272,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### tensor
-
+
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](/guides/construct-circuits) for more information.
@@ -1306,7 +1306,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
tensored.draw('mpl')
```
- ![../\_images/qiskit-circuit-QuantumCircuit-3.png](/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png)
+ ![Circuit diagram output by the previous code.](/images/api/qiskit/qiskit-circuit-QuantumCircuit-3.png)
**Returns**
@@ -1421,7 +1421,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### barrier
-
+
Apply `Barrier`. If `qargs` is empty, applies to all qubits in the circuit.
**Parameters**
@@ -1440,7 +1440,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### ccx
-
+
Apply [`CCXGate`](qiskit.circuit.library.CCXGate "qiskit.circuit.library.CCXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1463,7 +1463,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### ccz
-
+
Apply [`CCZGate`](qiskit.circuit.library.CCZGate "qiskit.circuit.library.CCZGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1487,7 +1487,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### ch
-
+
Apply [`CHGate`](qiskit.circuit.library.CHGate "qiskit.circuit.library.CHGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1510,7 +1510,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cp
-
+
Apply [`CPhaseGate`](qiskit.circuit.library.CPhaseGate "qiskit.circuit.library.CPhaseGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1534,7 +1534,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### crx
-
+
Apply [`CRXGate`](qiskit.circuit.library.CRXGate "qiskit.circuit.library.CRXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1558,7 +1558,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cry
-
+
Apply [`CRYGate`](qiskit.circuit.library.CRYGate "qiskit.circuit.library.CRYGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1582,7 +1582,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### crz
-
+
Apply [`CRZGate`](qiskit.circuit.library.CRZGate "qiskit.circuit.library.CRZGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1606,7 +1606,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cs
-
+
Apply [`CSGate`](qiskit.circuit.library.CSGate "qiskit.circuit.library.CSGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1629,7 +1629,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### csdg
-
+
Apply [`CSdgGate`](qiskit.circuit.library.CSdgGate "qiskit.circuit.library.CSdgGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1652,7 +1652,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cswap
-
+
Apply [`CSwapGate`](qiskit.circuit.library.CSwapGate "qiskit.circuit.library.CSwapGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1676,7 +1676,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### csx
-
+
Apply [`CSXGate`](qiskit.circuit.library.CSXGate "qiskit.circuit.library.CSXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1699,7 +1699,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cu
-
+
Apply [`CUGate`](qiskit.circuit.library.CUGate "qiskit.circuit.library.CUGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1726,7 +1726,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cx
-
+
Apply [`CXGate`](qiskit.circuit.library.CXGate "qiskit.circuit.library.CXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1749,7 +1749,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cy
-
+
Apply [`CYGate`](qiskit.circuit.library.CYGate "qiskit.circuit.library.CYGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1772,7 +1772,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### cz
-
+
Apply [`CZGate`](qiskit.circuit.library.CZGate "qiskit.circuit.library.CZGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1795,7 +1795,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### dcx
-
+
Apply [`DCXGate`](qiskit.circuit.library.DCXGate "qiskit.circuit.library.DCXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1816,7 +1816,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### delay
-
+
Apply [`Delay`](circuit#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**
@@ -1840,7 +1840,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### ecr
-
+
Apply [`ECRGate`](qiskit.circuit.library.ECRGate "qiskit.circuit.library.ECRGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1861,7 +1861,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### h
-
+
Apply [`HGate`](qiskit.circuit.library.HGate "qiskit.circuit.library.HGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1881,7 +1881,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### id
-
+
Apply [`IGate`](qiskit.circuit.library.IGate "qiskit.circuit.library.IGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -1901,7 +1901,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### initialize
-
+
Initialize qubits in a specific state.
Qubit initialization is done by first resetting the qubits to $|0\rangle$ followed by calling [`StatePreparation`](qiskit.circuit.library.StatePreparation "qiskit.circuit.library.StatePreparation") class to prepare the qubits in a specified state. Both these steps are included in the [`Initialize`](qiskit.circuit.library.Initialize "qiskit.circuit.library.Initialize") instruction.
@@ -1990,7 +1990,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### iswap
-
+
Apply [`iSwapGate`](qiskit.circuit.library.iSwapGate "qiskit.circuit.library.iSwapGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2011,7 +2011,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### mcp
-
+
Apply [`MCPhaseGate`](qiskit.circuit.library.MCPhaseGate "qiskit.circuit.library.MCPhaseGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2090,7 +2090,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### mcx
-
+
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:
@@ -2126,7 +2126,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### measure
-
+
Measure a quantum bit (`qubit`) in the Z basis into a classical bit (`cbit`).
When a quantum state is measured, a qubit is projected in the computational (Pauli Z) basis to either $\lvert 0 \rangle$ or $\lvert 1 \rangle$. The classical bit `cbit` indicates the result of that projection as a `0` or a `1` respectively. This operation is non-reversible.
@@ -2202,7 +2202,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### ms
-
+
Apply [`MSGate`](qiskit.circuit.library.MSGate "qiskit.circuit.library.MSGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2223,7 +2223,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### p
-
+
Apply [`PhaseGate`](qiskit.circuit.library.PhaseGate "qiskit.circuit.library.PhaseGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2244,7 +2244,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### pauli
-
+
Apply [`PauliGate`](qiskit.circuit.library.PauliGate "qiskit.circuit.library.PauliGate").
**Parameters**
@@ -2263,7 +2263,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### prepare\_state
-
+
Prepare qubits in a specific state.
This class implements a state preparing unitary. Unlike [`initialize()`](#qiskit.circuit.QuantumCircuit.initialize "qiskit.circuit.QuantumCircuit.initialize") it does not reset the qubits first.
@@ -2358,7 +2358,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### r
-
+
Apply [`RGate`](qiskit.circuit.library.RGate "qiskit.circuit.library.RGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2380,7 +2380,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rcccx
-
+
Apply [`RC3XGate`](qiskit.circuit.library.RC3XGate "qiskit.circuit.library.RC3XGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2403,7 +2403,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rccx
-
+
Apply [`RCCXGate`](qiskit.circuit.library.RCCXGate "qiskit.circuit.library.RCCXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2425,7 +2425,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### reset
-
+
Reset the quantum bit(s) to their default state.
**Parameters**
@@ -2443,7 +2443,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rv
-
+
Apply [`RVGate`](qiskit.circuit.library.RVGate "qiskit.circuit.library.RVGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2468,7 +2468,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rx
-
+
Apply [`RXGate`](qiskit.circuit.library.RXGate "qiskit.circuit.library.RXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2490,7 +2490,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rxx
-
+
Apply [`RXXGate`](qiskit.circuit.library.RXXGate "qiskit.circuit.library.RXXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2512,7 +2512,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### ry
-
+
Apply [`RYGate`](qiskit.circuit.library.RYGate "qiskit.circuit.library.RYGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2534,7 +2534,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### ryy
-
+
Apply [`RYYGate`](qiskit.circuit.library.RYYGate "qiskit.circuit.library.RYYGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2556,7 +2556,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rz
-
+
Apply [`RZGate`](qiskit.circuit.library.RZGate "qiskit.circuit.library.RZGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2577,7 +2577,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rzx
-
+
Apply [`RZXGate`](qiskit.circuit.library.RZXGate "qiskit.circuit.library.RZXGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2599,7 +2599,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### rzz
-
+
Apply [`RZZGate`](qiskit.circuit.library.RZZGate "qiskit.circuit.library.RZZGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2621,7 +2621,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### s
-
+
Apply [`SGate`](qiskit.circuit.library.SGate "qiskit.circuit.library.SGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2641,7 +2641,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### sdg
-
+
Apply [`SdgGate`](qiskit.circuit.library.SdgGate "qiskit.circuit.library.SdgGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2661,7 +2661,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### store
-
+
Store the result of the given real-time classical expression `rvalue` in the memory location defined by `lvalue`.
Typically `lvalue` will be a [`Var`](circuit_classical#qiskit.circuit.classical.expr.Var "qiskit.circuit.classical.expr.Var") node and `rvalue` will be some [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") to write into it, but anything that [`expr.lift()`](circuit_classical#qiskit.circuit.classical.expr.lift "qiskit.circuit.classical.expr.lift") can raise to an [`Expr`](circuit_classical#qiskit.circuit.classical.expr.Expr "qiskit.circuit.classical.expr.Expr") is permissible in both places, and it will be called on them.
@@ -2688,7 +2688,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### swap
-
+
Apply [`SwapGate`](qiskit.circuit.library.SwapGate "qiskit.circuit.library.SwapGate").
For the full matrix form of this gate, see the underlying gate documentation.
@@ -2709,7 +2709,7 @@ python_api_name: qiskit.circuit.QuantumCircuit
#### sx
-
+