Skip to main content
Ctrl+K

MindQuantum API (EN) documentation

API Modules

  • overview
  • mindquantum.dtype
    • mindquantum.dtype.is_double_precision
    • mindquantum.dtype.is_single_precision
    • mindquantum.dtype.is_same_precision
    • mindquantum.dtype.precision_str
    • mindquantum.dtype.to_real_type
    • mindquantum.dtype.to_complex_type
    • mindquantum.dtype.to_single_precision
    • mindquantum.dtype.to_double_precision
    • mindquantum.dtype.to_precision_like
    • mindquantum.dtype.to_mq_type
    • mindquantum.dtype.to_np_type
  • mindquantum.core
    • mindquantum.core.gates
      • mindquantum.core.gates.BasicGate
      • mindquantum.core.gates.NoneParameterGate
      • mindquantum.core.gates.ParameterGate
      • mindquantum.core.gates.QuantumGate
      • mindquantum.core.gates.NoiseGate
      • mindquantum.core.gates.CNOTGate
      • mindquantum.core.gates.FSim
      • mindquantum.core.gates.GlobalPhase
      • mindquantum.core.gates.HGate
      • mindquantum.core.gates.IGate
      • mindquantum.core.gates.ISWAPGate
      • mindquantum.core.gates.Measure
      • mindquantum.core.gates.PhaseShift
      • mindquantum.core.gates.Rn
      • mindquantum.core.gates.RX
      • mindquantum.core.gates.Rxx
      • mindquantum.core.gates.Rxy
      • mindquantum.core.gates.Rxz
      • mindquantum.core.gates.RY
      • mindquantum.core.gates.Ryy
      • mindquantum.core.gates.Ryz
      • mindquantum.core.gates.RZ
      • mindquantum.core.gates.Rzz
      • mindquantum.core.gates.RotPauliString
      • mindquantum.core.gates.SGate
      • mindquantum.core.gates.SWAPGate
      • mindquantum.core.gates.SWAPalpha
      • mindquantum.core.gates.SXGate
      • mindquantum.core.gates.TGate
      • mindquantum.core.gates.U3
      • mindquantum.core.gates.XGate
      • mindquantum.core.gates.YGate
      • mindquantum.core.gates.ZGate
      • mindquantum.core.gates.GroupedPauli
      • mindquantum.core.gates.Givens
      • mindquantum.core.gates.UnivMathGate
      • mindquantum.core.gates.gene_univ_parameterized_gate
      • mindquantum.core.gates.gene_univ_two_params_gate
      • mindquantum.core.gates.BarrierGate
      • mindquantum.core.gates.AmplitudeDampingChannel
      • mindquantum.core.gates.BitFlipChannel
      • mindquantum.core.gates.BitPhaseFlipChannel
      • mindquantum.core.gates.DepolarizingChannel
      • mindquantum.core.gates.KrausChannel
      • mindquantum.core.gates.PauliChannel
      • mindquantum.core.gates.GroupedPauliChannel
      • mindquantum.core.gates.PhaseDampingChannel
      • mindquantum.core.gates.PhaseFlipChannel
      • mindquantum.core.gates.ThermalRelaxationChannel
      • mindquantum.core.gates.MeasureResult
      • mindquantum.core.gates.Power
    • mindquantum.core.circuit
      • mindquantum.core.circuit.Circuit
      • mindquantum.core.circuit.SwapParts
      • mindquantum.core.circuit.UN
      • mindquantum.core.circuit.add_prefix
      • mindquantum.core.circuit.add_suffix
      • mindquantum.core.circuit.apply
      • mindquantum.core.circuit.as_ansatz
      • mindquantum.core.circuit.as_encoder
      • mindquantum.core.circuit.change_param_name
      • mindquantum.core.circuit.controlled
      • mindquantum.core.circuit.dagger
      • mindquantum.core.circuit.decompose_single_term_time_evolution
      • mindquantum.core.circuit.pauli_word_to_circuits
      • mindquantum.core.circuit.shift
      • mindquantum.core.circuit.qfi
      • mindquantum.core.circuit.partial_psi_partial_psi
      • mindquantum.core.circuit.partial_psi_psi
      • mindquantum.core.circuit.ChannelAdderBase
      • mindquantum.core.circuit.NoiseChannelAdder
      • mindquantum.core.circuit.MeasureAccepter
      • mindquantum.core.circuit.ReverseAdder
      • mindquantum.core.circuit.NoiseExcluder
      • mindquantum.core.circuit.BitFlipAdder
      • mindquantum.core.circuit.MixerAdder
      • mindquantum.core.circuit.SequentialAdder
      • mindquantum.core.circuit.QubitNumberConstrain
      • mindquantum.core.circuit.QubitIDConstrain
      • mindquantum.core.circuit.GateSelector
      • mindquantum.core.circuit.DepolarizingChannelAdder
    • mindquantum.core.operators
      • mindquantum.core.operators.FermionOperator
      • mindquantum.core.operators.Hamiltonian
      • mindquantum.core.operators.InteractionOperator
      • mindquantum.core.operators.PolynomialTensor
      • mindquantum.core.operators.Projector
      • mindquantum.core.operators.QubitExcitationOperator
      • mindquantum.core.operators.QubitOperator
      • mindquantum.core.operators.TimeEvolution
      • mindquantum.core.operators.commutator
      • mindquantum.core.operators.count_qubits
      • mindquantum.core.operators.down_index
      • mindquantum.core.operators.get_fermion_operator
      • mindquantum.core.operators.ground_state_of_sum_zz
      • mindquantum.core.operators.hermitian_conjugated
      • mindquantum.core.operators.normal_ordered
      • mindquantum.core.operators.number_operator
      • mindquantum.core.operators.sz_operator
      • mindquantum.core.operators.up_index
    • mindquantum.core.parameterresolver
      • mindquantum.core.parameterresolver.ParameterResolver
      • mindquantum.core.parameterresolver.PRGenerator
  • mindquantum.simulator
    • mindquantum.simulator.mqchem
      • mindquantum.simulator.mqchem.MQChemSimulator
      • mindquantum.simulator.mqchem.CIHamiltonian
      • mindquantum.simulator.mqchem.UCCExcitationGate
      • mindquantum.simulator.mqchem.SequentialUCCAnsatz
      • mindquantum.simulator.mqchem.prepare_uccsd_vqe
    • mindquantum.simulator.GradOpsWrapper
    • mindquantum.simulator.Simulator
    • mindquantum.simulator.NoiseBackend
    • mindquantum.simulator.fidelity
    • mindquantum.simulator.get_supported_simulator
    • mindquantum.simulator.inner_product
    • mindquantum.simulator.get_stabilizer_string
    • mindquantum.simulator.get_tableau_string
    • mindquantum.simulator.decompose_stabilizer
  • mindquantum.framework
    • mindquantum.framework.MQOps
    • mindquantum.framework.MQN2Ops
    • mindquantum.framework.MQAnsatzOnlyOps
    • mindquantum.framework.MQN2AnsatzOnlyOps
    • mindquantum.framework.MQEncoderOnlyOps
    • mindquantum.framework.MQN2EncoderOnlyOps
    • mindquantum.framework.QRamVecOps
    • mindquantum.framework.MQAnsatzOnlyLayer
    • mindquantum.framework.MQN2AnsatzOnlyLayer
    • mindquantum.framework.MQLayer
    • mindquantum.framework.MQN2Layer
    • mindquantum.framework.QRamVecLayer
  • mindquantum.algorithm
    • mindquantum.algorithm.compiler
      • mindquantum.algorithm.compiler.ch_decompose
      • mindquantum.algorithm.compiler.crx_decompose
      • mindquantum.algorithm.compiler.rxx_decompose
      • mindquantum.algorithm.compiler.crxx_decompose
      • mindquantum.algorithm.compiler.cry_decompose
      • mindquantum.algorithm.compiler.cnry_decompose
      • mindquantum.algorithm.compiler.crz_decompose
      • mindquantum.algorithm.compiler.cnrz_decompose
      • mindquantum.algorithm.compiler.ryy_decompose
      • mindquantum.algorithm.compiler.cryy_decompose
      • mindquantum.algorithm.compiler.rzz_decompose
      • mindquantum.algorithm.compiler.cs_decompose
      • mindquantum.algorithm.compiler.cswap_decompose
      • mindquantum.algorithm.compiler.swap_decompose
      • mindquantum.algorithm.compiler.ct_decompose
      • mindquantum.algorithm.compiler.ccx_decompose
      • mindquantum.algorithm.compiler.cy_decompose
      • mindquantum.algorithm.compiler.cz_decompose
      • mindquantum.algorithm.compiler.euler_decompose
      • mindquantum.algorithm.compiler.u3_decompose
      • mindquantum.algorithm.compiler.cu_decompose
      • mindquantum.algorithm.compiler.qs_decompose
      • mindquantum.algorithm.compiler.abc_decompose
      • mindquantum.algorithm.compiler.kak_decompose
      • mindquantum.algorithm.compiler.tensor_product_decompose
      • mindquantum.algorithm.compiler.BasicCompilerRule
      • mindquantum.algorithm.compiler.KroneckerSeqCompiler
      • mindquantum.algorithm.compiler.SequentialCompiler
      • mindquantum.algorithm.compiler.BasicDecompose
      • mindquantum.algorithm.compiler.DecomposeU3
      • mindquantum.algorithm.compiler.CZBasedChipCompiler
      • mindquantum.algorithm.compiler.CXToCZ
      • mindquantum.algorithm.compiler.CZToCX
      • mindquantum.algorithm.compiler.GateReplacer
      • mindquantum.algorithm.compiler.FullyNeighborCanceler
      • mindquantum.algorithm.compiler.SimpleNeighborCanceler
      • mindquantum.algorithm.compiler.U3Fusion
      • mindquantum.algorithm.compiler.compile_circuit
      • mindquantum.algorithm.compiler.DAGCircuit
      • mindquantum.algorithm.compiler.DAGNode
      • mindquantum.algorithm.compiler.GateNode
      • mindquantum.algorithm.compiler.DAGQubitNode
      • mindquantum.algorithm.compiler.connect_two_node
      • mindquantum.algorithm.compiler.try_merge
    • mindquantum.algorithm.library
      • mindquantum.algorithm.library.amplitude_encoder
      • mindquantum.algorithm.library.bitphaseflip_operator
      • mindquantum.algorithm.library.general_ghz_state
      • mindquantum.algorithm.library.general_w_state
      • mindquantum.algorithm.library.mat_to_op
      • mindquantum.algorithm.library.qft
      • mindquantum.algorithm.library.qjpeg
      • mindquantum.algorithm.library.qudit_symmetric_decoding
      • mindquantum.algorithm.library.qudit_symmetric_encoding
      • mindquantum.algorithm.library.qutrit_symmetric_ansatz
    • mindquantum.algorithm.nisq
      • mindquantum.algorithm.nisq.Ansatz
      • mindquantum.algorithm.nisq.IQPEncoding
      • mindquantum.algorithm.nisq.QuantumNeuron
      • mindquantum.algorithm.nisq.HardwareEfficientAnsatz
      • mindquantum.algorithm.nisq.Max2SATAnsatz
      • mindquantum.algorithm.nisq.MaxCutAnsatz
      • mindquantum.algorithm.nisq.QubitUCCAnsatz
      • mindquantum.algorithm.nisq.SGAnsatz
      • mindquantum.algorithm.nisq.SGAnsatz2D
      • mindquantum.algorithm.nisq.StronglyEntangling
      • mindquantum.algorithm.nisq.UCCAnsatz
      • mindquantum.algorithm.nisq.RYLinear
      • mindquantum.algorithm.nisq.RYFull
      • mindquantum.algorithm.nisq.RYCascade
      • mindquantum.algorithm.nisq.RYRZFull
      • mindquantum.algorithm.nisq.PCHeaXYZ1F
      • mindquantum.algorithm.nisq.PCHeaXYZ2F
      • mindquantum.algorithm.nisq.ASWAP
      • mindquantum.algorithm.nisq.Ansatz1
      • mindquantum.algorithm.nisq.Ansatz2
      • mindquantum.algorithm.nisq.Ansatz3
      • mindquantum.algorithm.nisq.Ansatz4
      • mindquantum.algorithm.nisq.Ansatz5
      • mindquantum.algorithm.nisq.Ansatz6
      • mindquantum.algorithm.nisq.Ansatz7
      • mindquantum.algorithm.nisq.Ansatz8
      • mindquantum.algorithm.nisq.Ansatz9
      • mindquantum.algorithm.nisq.Ansatz10
      • mindquantum.algorithm.nisq.Ansatz11
      • mindquantum.algorithm.nisq.Ansatz12
      • mindquantum.algorithm.nisq.Ansatz13
      • mindquantum.algorithm.nisq.Ansatz14
      • mindquantum.algorithm.nisq.Ansatz15
      • mindquantum.algorithm.nisq.Ansatz16
      • mindquantum.algorithm.nisq.Ansatz17
      • mindquantum.algorithm.nisq.Ansatz18
      • mindquantum.algorithm.nisq.Ansatz19
      • mindquantum.algorithm.nisq.generate_uccsd
      • mindquantum.algorithm.nisq.quccsd_generator
      • mindquantum.algorithm.nisq.uccsd0_singlet_generator
      • mindquantum.algorithm.nisq.uccsd_singlet_generator
      • mindquantum.algorithm.nisq.Transform
      • mindquantum.algorithm.nisq.get_qubit_hamiltonian
      • mindquantum.algorithm.nisq.uccsd_singlet_get_packed_amplitudes
      • mindquantum.algorithm.nisq.ansatz_variance
      • mindquantum.algorithm.nisq.get_reference_circuit
    • mindquantum.algorithm.error_mitigation
      • mindquantum.algorithm.error_mitigation.fold_at_random
      • mindquantum.algorithm.error_mitigation.zne
      • mindquantum.algorithm.error_mitigation.generate_double_qubits_rb_circ
      • mindquantum.algorithm.error_mitigation.generate_single_qubit_rb_circ
      • mindquantum.algorithm.error_mitigation.query_double_qubits_clifford_elem
      • mindquantum.algorithm.error_mitigation.query_single_qubit_clifford_elem
      • mindquantum.algorithm.error_mitigation.virtual_distillation
    • mindquantum.algorithm.mapping
      • mindquantum.algorithm.mapping.SABRE
      • mindquantum.algorithm.mapping.MQSABRE
    • mindquantum.algorithm.qaia
      • mindquantum.algorithm.qaia.QAIA
      • mindquantum.algorithm.qaia.CAC
      • mindquantum.algorithm.qaia.CFC
      • mindquantum.algorithm.qaia.LQA
      • mindquantum.algorithm.qaia.NMFA
      • mindquantum.algorithm.qaia.ASB
      • mindquantum.algorithm.qaia.BSB
      • mindquantum.algorithm.qaia.DSB
      • mindquantum.algorithm.qaia.TSB
      • mindquantum.algorithm.qaia.USB
      • mindquantum.algorithm.qaia.LSB
      • mindquantum.algorithm.qaia.SFC
      • mindquantum.algorithm.qaia.SimCIM
  • mindquantum.device
    • mindquantum.device.QPU
    • mindquantum.device.QubitNode
    • mindquantum.device.QubitsTopology
    • mindquantum.device.GridQubits
    • mindquantum.device.LinearQubits
  • mindquantum.io
    • mindquantum.io.BlochScene
    • mindquantum.io.HiQASM
    • mindquantum.io.OpenQASM
    • mindquantum.io.QCIS
    • mindquantum.io.bprint
    • mindquantum.io.random_hiqasm
    • mindquantum.io.draw_topology
    • mindquantum.io.draw_topology_plt
  • mindquantum.utils
    • mindquantum.utils.fdopen
    • mindquantum.utils.ket_string
    • mindquantum.utils.mod
    • mindquantum.utils.normalize
    • mindquantum.utils.random_circuit
    • mindquantum.utils.random_state
    • mindquantum.utils.random_hamiltonian
    • mindquantum.utils.random_insert_gates
    • mindquantum.utils.SingleLoopProgress
    • mindquantum.utils.TwoLoopsProgress
  • mindquantum.engine
  • .rst

MindQuantum API (EN)

MindQuantum API (EN)#

Welcome to the MindQuantum Python API reference (English).

API Modules

  • overview
  • mindquantum.dtype
    • Supported data type
    • Memory consuming
    • Function
  • mindquantum.core
    • mindquantum.core.gates
    • mindquantum.core.circuit
    • mindquantum.core.operators
    • mindquantum.core.parameterresolver
  • mindquantum.simulator
    • Module
    • Class
    • Function
  • mindquantum.framework
    • Operators
    • Layer
  • mindquantum.algorithm
    • mindquantum.algorithm.compiler
    • mindquantum.algorithm.library
    • mindquantum.algorithm.nisq
    • mindquantum.algorithm.error_mitigation
    • mindquantum.algorithm.mapping
    • mindquantum.algorithm.qaia
  • mindquantum.device
    • Class
  • mindquantum.io
    • Class
    • Function
  • mindquantum.utils
    • Function
    • Progress bar
  • mindquantum.engine
    • BasicQubit
    • CircuitEngine
    • circuit_generator()

next

overview

By MindQuantum Contributors

© Copyright 2026, MindQuantum.