> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rhymeq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Rhyme Language Reference

This reference describes the syntax and semantics of the quantum programming language Rhyme.

## Table of contents

1. [What is Rhyme?](https://docs.rhymeq.com/language-reference/01-what-is-rhyme.md)
2. [First steps: From zero to universality](https://docs.rhymeq.com/language-reference/02-first-steps.md)
   * [2.1 Superposition](https://docs.rhymeq.com/language-reference/02-first-steps.md#2-1-superposition)
   * [2.2 Amplitudes](https://docs.rhymeq.com/language-reference/02-first-steps.md#2-2-amplitudes)
   * [2.3 Phase change](https://docs.rhymeq.com/language-reference/02-first-steps.md#2-3-phase-change)
   * [2.4 Interference](https://docs.rhymeq.com/language-reference/02-first-steps.md#2-4-interference)
   * [2.5 Observation](https://docs.rhymeq.com/language-reference/02-first-steps.md#2-5-observation)
   * [2.6 Universality](https://docs.rhymeq.com/language-reference/02-first-steps.md#2-6-universality)
3. [The core of Rhyme](https://docs.rhymeq.com/language-reference/03-core-of-rhyme.md)
   * [3.1 `qobject`: the base class](https://docs.rhymeq.com/language-reference/03-core-of-rhyme#3-1-qobject-the-base-class)
   * [3.2 Attributes for naming and debugging](https://docs.rhymeq.com/language-reference/03-core-of-rhyme.md#3-2-attributes-for-naming-and-debugging)
   * [3.3 Operations inherited by quantum objects](https://docs.rhymeq.com/language-reference/03-core-of-rhyme.md#3-3-operations-inherited-by-quantum-objects)
   * [3.4 Binary helper functions](https://docs.rhymeq.com/language-reference/03-core-of-rhyme.md#3-4-binary-helper-functions)
   * [3.5 `RhymeError`](https://docs.rhymeq.com/language-reference/03-core-of-rhyme#3-5-rhymeerror)
   * [3.6 `set_amplitude_precision()`](https://docs.rhymeq.com/language-reference/03-core-of-rhyme#3-6-set_amplitude_precision)
   * [3.7 Valid quantum programs](https://docs.rhymeq.com/language-reference/03-core-of-rhyme.md#3-7-valid-quantum-programs)
4. [Quantum counterparts of Python types](https://docs.rhymeq.com/language-reference/04-quantum-python-types.md)
   * [4.1 `qint`: signed quantum integers](https://docs.rhymeq.com/language-reference/04-quantum-python-types#4-1-qint-signed-quantum-integers)
   * [4.2 `qfloat`: quantum floating-point numbers](https://docs.rhymeq.com/language-reference/04-quantum-python-types#4-2-qfloat-quantum-floating-point-numbers)
   * [4.3 `qstr`: quantum strings](https://docs.rhymeq.com/language-reference/04-quantum-python-types#4-3-qstr-quantum-strings)
   * [4.4 `qbool`: quantum booleans](https://docs.rhymeq.com/language-reference/04-quantum-python-types#4-4-qbool-quantum-booleans)
   * [4.5 `superpose`: a convenient constructor](https://docs.rhymeq.com/language-reference/04-quantum-python-types#4-5-superpose-a-convenient-constructor)
   * [4.6 Common behavior](https://docs.rhymeq.com/language-reference/04-quantum-python-types.md#4-6-common-behavior)
5. [Other quantum types](https://docs.rhymeq.com/language-reference/05-other-quantum-types.md)
   * [5.1 `quint`: unsigned quantum integers](https://docs.rhymeq.com/language-reference/05-other-quantum-types#5-1-quint-unsigned-quantum-integers)
   * [5.2 `qbit`: a single quantum bit](https://docs.rhymeq.com/language-reference/05-other-quantum-types#5-2-qbit-a-single-quantum-bit)
   * [5.3 `qchar`: quantum characters](https://docs.rhymeq.com/language-reference/05-other-quantum-types#5-3-qchar-quantum-characters)
   * [5.4 Which type should you use?](https://docs.rhymeq.com/language-reference/05-other-quantum-types.md#5-4-which-type-should-you-use)
   * [5.5 Common behavior](https://docs.rhymeq.com/language-reference/05-other-quantum-types.md#5-5-common-behavior)
6. [Beyond individual quantum objects](https://docs.rhymeq.com/language-reference/06-beyond-individual.md)
   * [6.1 Operations on joint quantum values](https://docs.rhymeq.com/language-reference/06-beyond-individual.md#6-1-operations-on-joint-quantum-values)
   * [6.2 `observe()`: obtain basis values](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-2-observe--obtain-basis-values)
   * [6.3 `measure()`: observe a label](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-3-measure--observe-a-label)
   * [6.4 `add_phase()`: rotate amplitudes](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-4-add_phase--rotate-amplitudes)
   * [6.5 `interfere()`: mix paired amplitudes](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-5-interfere--mix-paired-amplitudes)
   * [6.6 `flip()`: exchange paired amplitudes](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-6-flip--exchange-paired-amplitudes)
   * [6.7 `rotate()`: rotate paired amplitudes](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-7-rotate--rotate-paired-amplitudes)
   * [6.8 `combine()`: general mixing of paired amplitudes](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-8-combine--general-mixing-of-paired-amplitudes)
   * [6.9 `swap()` and `cswap()`: exchange basis values](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-9-swap-and-cswap--exchange-basis-values)
   * [6.10 `join()`: group quantum objects in the simulator](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-10-join--group-quantum-objects-in-the-simulator)
   * [6.11 `discard()`: make quantum values inaccessible](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-11-discard--make-quantum-values-inaccessible)
   * [6.12 `bfunc()`: evaluate a function on basis values](https://docs.rhymeq.com/language-reference/06-beyond-individual#6-12-bfunc--evaluate-a-function-on-basis-values)
   * [6.13 Putting joint operations together](https://docs.rhymeq.com/language-reference/06-beyond-individual.md#6-13-putting-joint-operations-together)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.