Welcome to libqasm’s documentation!

libqasm is a library for handling cQASM files using C++ or Python.

Context and history

• Context and history

The cQASM 1.x language

• Structure
  • File extension
  • Whitespace and comments
  • Keywords
• Statements
  • Version statement
  • Qubits statement
  • Error model statement
  • Variable statement (1.1+)
  • Map statement
  • Subcircuit headers
  • Bundles and instructions
  • If-else chain (1.2+)
  • C-style for loop (1.2+)
  • Foreach loop (1.2+)
  • While loop (1.2+)
  • Repeat-until loop (1.2+)
  • Break statement (1.2+)
  • Continue statement (1.2+)
• Instructions
  • Assignment instruction
  • Goto instruction (1.2+)
  • Conditional instructions
  • Single-gate-multiple-qubit
  • Default instruction set
• Expressions
  • Number literals
  • Matrix literals
  • String and JSON literals
  • Mappings, references, and named literals
  • Indexation and slicing
  • Functions
  • Unary, binary, and ternary operators
  • Grouping parentheses
• Type system
  • Constant propagation and coercion
• Annotations

API documentation

• C++ API
• Python API