Welcome to QCEC’s documentation!

QCEC is a tool for quantum circuit equivalence checking developed as part of the Munich Quantum Toolkit (MQT) by the Chair for Design Automation at the Technical University of Munich. It builds upon MQT Core, which forms the backbone of the MQT.

We recommend you to start with the installation instructions. Then proceed to the quickstart guide and read the reference documentation. If you are interested in the theory behind QCEC, have a look at the publications in the publication list.

We appreciate any feedback and contributions to the project. If you want to contribute, you can find more information in the Contribution guide. If you are having trouble with the installation or the usage of QCEC, please let us know at our Support page.

---

User Guide

• Installation
  • A Detailed Walk Through
  • Building from Source for Performance
• Quickstart
• Quantum Circuit Equivalence Checking
  • Construction Equivalence Checker (using Decision Diagrams)
  • Alternating Equivalence Checker (using Decision Diagrams)
  • Simulation Equivalence Checker (using Decision Diagrams)
  • ZX-Calculus Equivalence Checker
  • Resulting Equivalence Checking Flow
• Verifying the Results of Compilation Flows
  • Quantum Circuit Compilation
  • Using QCEC to Verify Compilation Flow Results
• Verifying Parameterized Quantum Circuits
  • Variational Quantum Algorithms
  • Equivalence Checking of Parameterized Quantum Circuits
  • Using QCEC to Verify Parameterized Quantum Circuits
• Partial Equivalence Checking
  • Partial Equivalence vs. Total Equivalence
  • Checking Partial Equivalence of Quantum Circuits
  • Using QCEC to Check for Partial Equivalence
• Publications

Developers

• Contributing
  • Types of Contributions
  • 🎉 Get Started
  • Core Guidelines
  • Pull Request Workflow
• Development Guide
  • Initial Setup
  • Working on the core C++ library
  • Working on the Python module
  • Working on the Documentation
• Support

API Reference

• Library
  • Verify
    • verify()
  • Verify Compilation
    • verify_compilation()
    • AncillaMode
      • AncillaMode.NO_ANCILLA
      • AncillaMode.RECURSION
      • AncillaMode.V_CHAIN
    • Compilation Flow Profile Generation
      • generate_profile()
  • Equivalence Checking Manager
    • EquivalenceCheckingManager
    • Constructing an instance
      • EquivalenceCheckingManager.__init__()
    • Configuration after instantiation
      • EquivalenceCheckingManager.set_parallel()
      • EquivalenceCheckingManager.set_nthreads()
      • EquivalenceCheckingManager.set_timeout()
      • EquivalenceCheckingManager.set_construction_checker()
      • EquivalenceCheckingManager.set_simulation_checker()
      • EquivalenceCheckingManager.set_alternating_checker()
      • EquivalenceCheckingManager.set_zx_checker()
      • EquivalenceCheckingManager.set_tolerance()
      • EquivalenceCheckingManager.fuse_single_qubit_gates()
      • EquivalenceCheckingManager.reconstruct_swaps()
      • EquivalenceCheckingManager.reorder_operations()
      • EquivalenceCheckingManager.set_application_scheme()
      • EquivalenceCheckingManager.set_construction_application_scheme()
      • EquivalenceCheckingManager.set_simulation_application_scheme()
      • EquivalenceCheckingManager.set_alternating_application_scheme()
      • EquivalenceCheckingManager.set_gate_cost_profile()
      • EquivalenceCheckingManager.set_construction_gate_cost_profile()
      • EquivalenceCheckingManager.set_simulation_gate_cost_profile()
      • EquivalenceCheckingManager.set_alternating_gate_cost_profile()
      • EquivalenceCheckingManager.set_trace_threshold()
      • EquivalenceCheckingManager.set_fidelity_threshold()
      • EquivalenceCheckingManager.set_max_sims()
      • EquivalenceCheckingManager.set_state_type()
      • EquivalenceCheckingManager.set_seed()
      • EquivalenceCheckingManager.store_cex_input()
      • EquivalenceCheckingManager.store_cex_output()
    • Running the equivalence check
      • EquivalenceCheckingManager.run()
    • Obtaining the results
      • EquivalenceCheckingManager.equivalence()
      • EquivalenceCheckingManager.get_results()
  • Configuration
    • Configuration
    • Execution
      • Configuration.Execution
        • Configuration.Execution.nthreads
        • Configuration.Execution.numerical_tolerance
        • Configuration.Execution.parallel
        • Configuration.Execution.run_alternating_checker
        • Configuration.Execution.run_construction_checker
        • Configuration.Execution.run_simulation_checker
        • Configuration.Execution.run_zx_checker
        • Configuration.Execution.timeout
      • Timeout Handling
    • Optimizations
      • Configuration.Optimizations
        • Configuration.Optimizations.backpropagate_output_permutation
        • Configuration.Optimizations.elide_permutations
        • Configuration.Optimizations.fuse_single_qubit_gates
        • Configuration.Optimizations.reconstruct_swaps
        • Configuration.Optimizations.remove_diagonal_gates_before_measure
        • Configuration.Optimizations.reorder_operations
        • Configuration.Optimizations.transform_dynamic_circuit
    • Application
      • Configuration.Application
        • Configuration.Application.alternating_scheme
        • Configuration.Application.construction_scheme
        • Configuration.Application.profile
        • Configuration.Application.simulation_scheme
    • Functionality
      • Configuration.Functionality
        • Configuration.Functionality.check_partial_equivalence
        • Configuration.Functionality.trace_threshold
    • Simulation
      • Configuration.Simulation
        • Configuration.Simulation.fidelity_threshold
        • Configuration.Simulation.max_sims
        • Configuration.Simulation.seed
        • Configuration.Simulation.state_type
        • Configuration.Simulation.store_cex_input
        • Configuration.Simulation.store_cex_output
    • Parameterized
      • Configuration.Parameterized
        • Configuration.Parameterized.additional_instantiations
        • Configuration.Parameterized.parameterized_tolerance
    • ConfigurationOptions
      • ConfigurationOptions.additional_instantiations
      • ConfigurationOptions.alternating_scheme
      • ConfigurationOptions.backpropagate_output_permutation
      • ConfigurationOptions.check_partial_equivalence
      • ConfigurationOptions.construction_scheme
      • ConfigurationOptions.elide_permutations
      • ConfigurationOptions.fidelity_threshold
      • ConfigurationOptions.fuse_single_qubit_gates
      • ConfigurationOptions.max_sims
      • ConfigurationOptions.nthreads
      • ConfigurationOptions.numerical_tolerance
      • ConfigurationOptions.parallel
      • ConfigurationOptions.parameterized_tolerance
      • ConfigurationOptions.profile
      • ConfigurationOptions.reconstruct_swaps
      • ConfigurationOptions.remove_diagonal_gates_before_measure
      • ConfigurationOptions.reorder_operations
      • ConfigurationOptions.run_alternating_checker
      • ConfigurationOptions.run_construction_checker
      • ConfigurationOptions.run_simulation_checker
      • ConfigurationOptions.run_zx_checker
      • ConfigurationOptions.seed
      • ConfigurationOptions.simulation_scheme
      • ConfigurationOptions.state_type
      • ConfigurationOptions.store_cex_input
      • ConfigurationOptions.store_cex_output
      • ConfigurationOptions.timeout
      • ConfigurationOptions.trace_threshold
      • ConfigurationOptions.transform_dynamic_circuit
    • augment_config_from_kwargs()
  • Application Scheme
    • ApplicationScheme
      • ApplicationScheme.gate_cost
      • ApplicationScheme.lookahead
      • ApplicationScheme.name
      • ApplicationScheme.one_to_one
      • ApplicationScheme.proportional
      • ApplicationScheme.sequential
      • ApplicationScheme.value
  • State Types for Simulation
    • StateType
      • StateType.computational_basis
      • StateType.name
      • StateType.random_1Q_basis
      • StateType.stabilizer
      • StateType.value
  • Notions of Equivalence
    • EquivalenceCriterion
      • EquivalenceCriterion.equivalent
      • EquivalenceCriterion.equivalent_up_to_global_phase
      • EquivalenceCriterion.equivalent_up_to_phase
      • EquivalenceCriterion.name
      • EquivalenceCriterion.no_information
      • EquivalenceCriterion.not_equivalent
      • EquivalenceCriterion.probably_equivalent
      • EquivalenceCriterion.probably_not_equivalent
      • EquivalenceCriterion.value
  • Results
    • Results
    • Results.preprocessing_time
    • Results.check_time
    • Results.equivalence
    • Results.started_simulations
    • Results.performed_simulations
    • Results.cex_input
    • Results.cex_output1
    • Results.cex_output2
    • Results.considered_equivalent()
    • Results.json()
    • Results.__repr__()