Hide navigation sidebar

Hide table of contents sidebar

🎉 Qiskit is getting a new documentation experience on IBM Quantum! Check it out

Toggle site navigation sidebar

Site contents

Toggle table of contents sidebar

Documentation Home
Quantum computing in a nutshell
Getting started
Introduction to Qiskit
Tutorials
Toggle navigation of Tutorials
API Reference
Toggle navigation of API Reference
- Quantum Circuits (qiskit.circuit)
  Toggle navigation of Quantum Circuits (qiskit.circuit)
- Circuit Library (qiskit.circuit.library)
  Toggle navigation of Circuit Library (qiskit.circuit.library)
  - C3XGate
  - C3SXGate
  - C4XGate
  - CCXGate
  - DCXGate
  - CHGate
  - CPhaseGate
  - CRXGate
  - CRYGate
  - CRZGate
  - CSGate
  - CSdgGate
  - CSwapGate
  - CSXGate
  - CUGate
  - CU1Gate
  - CU3Gate
  - CXGate
  - CYGate
  - CZGate
  - CCZGate
  - ECRGate
  - HGate
  - IGate
  - MSGate
  - PhaseGate
  - RCCXGate
  - RC3XGate
  - RGate
  - RXGate
  - RXXGate
  - RYGate
  - RYYGate
  - RZGate
  - RZZGate
  - RZXGate
  - XXMinusYYGate
  - XXPlusYYGate
  - SGate
  - SdgGate
  - SwapGate
  - iSwapGate
  - SXGate
  - SXdgGate
  - TGate
  - TdgGate
  - UGate
  - U1Gate
  - U2Gate
  - U3Gate
  - XGate
  - YGate
  - ZGate
  - GlobalPhaseGate
  - Barrier
  - Measure
  - Reset
  - Diagonal
  - MCMT
  - MCMTVChain
  - Permutation
  - PermutationGate
  - GMS
  - GR
  - GRX
  - GRY
  - GRZ
  - MCPhaseGate
  - MCXGate
  - MCXGrayCode
  - MCXRecursive
  - MCXVChain
  - RVGate
  - PauliGate
  - LinearFunction
  - AND
  - OR
  - XOR
  - InnerProduct
  - QFT
  - LinearAmplitudeFunction
  - FunctionalPauliRotations
  - LinearPauliRotations
  - PolynomialPauliRotations
  - PiecewiseLinearPauliRotations
  - PiecewisePolynomialPauliRotations
  - PiecewiseChebyshev
  - DraperQFTAdder
  - CDKMRippleCarryAdder
  - VBERippleCarryAdder
  - WeightedAdder
  - HRSCumulativeMultiplier
  - RGQFTMultiplier
  - IntegerComparator
  - QuadraticForm
  - ExactReciprocal
  - FourierChecking
  - GraphState
  - HiddenLinearFunction
  - IQP
  - QuantumVolume
  - PhaseEstimation
  - GroverOperator
  - PhaseOracle
  - EvolvedOperatorAnsatz
  - PauliEvolutionGate
  - NLocal
  - TwoLocal
  - PauliTwoDesign
  - RealAmplitudes
  - EfficientSU2
  - ExcitationPreserving
  - QAOAAnsatz
  - PauliFeatureMap
  - ZFeatureMap
  - ZZFeatureMap
  - StatePreparation
- Classical expressions (qiskit.circuit.classical)
- Compilation Routines (qiskit.compiler)
- Executing Experiments (qiskit.execute_function)
- Visualizations (qiskit.visualization)
  Toggle navigation of Visualizations (qiskit.visualization)
- ClassicalFunction compiler (qiskit.circuit.classicalfunction)
  Toggle navigation of ClassicalFunction compiler (qiskit.circuit.classicalfunction)
- Circuit Converters (qiskit.converters)
- Circuit and Schedule Assembler (qiskit.assembler)
  Toggle navigation of Circuit and Schedule Assembler (qiskit.assembler)
  - RunConfig
- DAG Circuits (qiskit.dagcircuit)
  Toggle navigation of DAG Circuits (qiskit.dagcircuit)
- Quantum Circuit Extensions (qiskit.extensions)
  Toggle navigation of Quantum Circuit Extensions (qiskit.extensions)
- BasicAer: Python-based Simulators (qiskit.providers.basicaer)
  Toggle navigation of BasicAer: Python-based Simulators (qiskit.providers.basicaer)
- Providers Interface (qiskit.providers)
  Toggle navigation of Providers Interface (qiskit.providers)
- Writing a New Provider
- Migrating between Backend API Versions
- Fake Provider (qiskit.providers.fake_provider)
  Toggle navigation of Fake Provider (qiskit.providers.fake_provider)
- Backend Objects (qiskit.providers.models)
  Toggle navigation of Backend Objects (qiskit.providers.models)
- Pulse (qiskit.pulse)
  Toggle navigation of Pulse (qiskit.pulse)
- Circuit Scheduler (qiskit.scheduler)
- Circuit Synthesis (qiskit.synthesis)
  Toggle navigation of Circuit Synthesis (qiskit.synthesis)
- Primitives (qiskit.primitives)
  Toggle navigation of Primitives (qiskit.primitives)
- OpenQASM 2 (qiskit.qasm2)
- OpenQASM 3 (qiskit.qasm3)
- Qasm (qiskit.qasm)
- Qobj (qiskit.qobj)
  Toggle navigation of Qobj (qiskit.qobj)
- QPY serialization (qiskit.qpy)
- Quantum Information (qiskit.quantum_info)
  Toggle navigation of Quantum Information (qiskit.quantum_info)
- Experiment Results (qiskit.result)
  Toggle navigation of Experiment Results (qiskit.result)
- Qiskit Tools (qiskit.tools)
- Jupyter Tools (qiskit.tools.jupyter)
- Transpiler (qiskit.transpiler)
  Toggle navigation of Transpiler (qiskit.transpiler)
- Transpiler Passes (qiskit.transpiler.passes)
  Toggle navigation of Transpiler Passes (qiskit.transpiler.passes)
- Preset Passmanagers (qiskit.transpiler.preset_passmanagers)
- Transpiler Stage Plugin Interface (qiskit.transpiler.preset_passmanagers.plugin)
  Toggle navigation of Transpiler Stage Plugin Interface (qiskit.transpiler.preset_passmanagers.plugin)
  - PassManagerStagePlugin
  - PassManagerStagePluginManager
- Synthesis Plugins (qiskit.transpiler.passes.synthesis.plugin)
  Toggle navigation of Synthesis Plugins (qiskit.transpiler.passes.synthesis.plugin)
- Built-in Transpiler Synthesis Plugins
  Toggle navigation of Built-in Transpiler Synthesis Plugins
  - Approximate Quantum Compiler (qiskit.transpiler.synthesis.aqc)
    Toggle navigation of Approximate Quantum Compiler (qiskit.transpiler.synthesis.aqc)
- Utilities (qiskit.utils)
  Toggle navigation of Utilities (qiskit.utils)
  - QuantumInstance
- Measurement Mitigation Utils (qiskit.utils.mitigation)
  Toggle navigation of Measurement Mitigation Utils (qiskit.utils.mitigation)
  - CompleteMeasFitter
  - TensoredMeasFitter
- Operators (qiskit.opflow)
  Toggle navigation of Operators (qiskit.opflow)
  - OperatorBase
  - qiskit.opflow.primitive_ops
    Toggle navigation of qiskit.opflow.primitive_ops
  - qiskit.opflow.list_ops
    Toggle navigation of qiskit.opflow.list_ops
    - ListOp
    - ComposedOp
    - SummedOp
    - TensoredOp
  - qiskit.opflow.state_fns
    Toggle navigation of qiskit.opflow.state_fns
  - qiskit.opflow.converters
    Toggle navigation of qiskit.opflow.converters
  - qiskit.opflow.evolutions
    Toggle navigation of qiskit.opflow.evolutions
  - qiskit.opflow.expectations
    Toggle navigation of qiskit.opflow.expectations
  - qiskit.opflow.gradients
    Toggle navigation of qiskit.opflow.gradients
    - DerivativeBase
    - GradientBase
    - HessianBase
    - QFIBase
    - CircuitGradient
    - CircuitQFI
    - Gradient
    - Hessian
    - NaturalGradient
    - QFI
- Algorithms (qiskit.algorithms)
  Toggle navigation of Algorithms (qiskit.algorithms)
  - AmplificationProblem
  - AmplitudeAmplifier
  - Grover
  - GroverResult
  - AmplitudeEstimator
  - AmplitudeEstimatorResult
  - AmplitudeEstimation
  - AmplitudeEstimationResult
  - EstimationProblem
  - FasterAmplitudeEstimation
  - FasterAmplitudeEstimationResult
  - IterativeAmplitudeEstimation
  - IterativeAmplitudeEstimationResult
  - MaximumLikelihoodAmplitudeEstimation
  - MaximumLikelihoodAmplitudeEstimationResult
  - qiskit.algorithms.eigensolvers
    Toggle navigation of qiskit.algorithms.eigensolvers
  - Eigensolver
  - EigensolverResult
  - NumPyEigensolver
  - VQD
  - VQDResult
  - RealTimeEvolver
  - ImaginaryTimeEvolver
  - TimeEvolutionResult
  - TimeEvolutionProblem
  - PVQD
  - PVQDResult
  - SciPyImaginaryEvolver
  - SciPyRealEvolver
  - VarQITE
  - VarQRTE
  - RealEvolver
  - ImaginaryEvolver
  - TrotterQRTE
  - EvolutionResult
  - EvolutionProblem
  - qiskit.algorithms.time_evolvers.variational
    Toggle navigation of qiskit.algorithms.time_evolvers.variational
  - qiskit.algorithms.time_evolvers.trotterization
    Toggle navigation of qiskit.algorithms.time_evolvers.trotterization
    - TrotterQRTE
  - qiskit.algorithms.gradients
    Toggle navigation of qiskit.algorithms.gradients
  - qiskit.algorithms.minimum_eigensolvers
    Toggle navigation of qiskit.algorithms.minimum_eigensolvers
  - MinimumEigensolver
  - MinimumEigensolverResult
  - NumPyMinimumEigensolver
  - QAOA
  - VQE
  - qiskit.algorithms.optimizers
    Toggle navigation of qiskit.algorithms.optimizers
    - OptimizerResult
    - OptimizerSupportLevel
    - Optimizer
    - Minimizer
    - qiskit.algorithms.optimizers.optimizer_utils
      Toggle navigation of qiskit.algorithms.optimizers.optimizer_utils
      - LearningRate
    - SteppableOptimizer
    - AskData
    - TellData
    - OptimizerState
    - ADAM
    - AQGD
    - CG
    - COBYLA
    - L_BFGS_B
    - GSLS
    - GradientDescent
    - GradientDescentState
    - NELDER_MEAD
    - NFT
    - P_BFGS
    - POWELL
    - SLSQP
    - SPSA
    - QNSPSA
    - TNC
    - SciPyOptimizer
    - UMDA
    - BOBYQA
    - IMFIL
    - SNOBFIT
    - CRS
    - DIRECT_L
    - DIRECT_L_RAND
    - ESCH
    - ISRES
  - HamiltonianPhaseEstimation
  - HamiltonianPhaseEstimationResult
  - PhaseEstimationScale
  - PhaseEstimation
  - PhaseEstimationResult
  - IterativePhaseEstimation
  - qiskit.algorithms.state_fidelities
    Toggle navigation of qiskit.algorithms.state_fidelities
  - AlgorithmJob
- Top-level exceptions (qiskit.exceptions)
How-to Guides
Toggle navigation of How-to Guides
- Compute circuit output probabilities with Sampler primitive
- Compute an expectation value with Estimator primitive
Explanation
Toggle navigation of Explanation
- Order of qubits in Qiskit
Migration Guides
Toggle navigation of Migration Guides
Release Notes
Local Configuration
GitHub
Frequently Asked Questions

Contributing

Contributing to Qiskit
Deprecation Policy
Maintainers Guide

Previous Releases

Toggle navigation of Previous Releases

0.44
0.43
0.42
0.41
0.40
0.39
0.38
0.37
0.36
0.35
0.34
0.33
0.32
0.31
0.30
0.29
0.28
0.27
0.26
0.25
0.24
0.19

English

Toggle translations list

English
Bengali
French
German
Japanese
Korean
Portuguese
Spanish
Tamil

Back to top

Toggle table of contents sidebar

Explanation#

Order of qubits in Qiskit

Made with Sphinx and @pradyunsg's Furo

Last updated on 2023/10/02