Skip to content

docs: add coherent QROM lookup tutorial - #83

Draft
wsttiger wants to merge 2 commits into
mainfrom
codex/v02-02-qrom-lookup
Draft

wsttiger wants to merge 2 commits into
mainfrom
codex/v02-02-qrom-lookup

Conversation

@wsttiger

@wsttiger wsttiger commented Nov 8, 2026

Copy link
Copy Markdown
Collaborator

Adds a self-verifying QROM tutorial with a five-entry table, padded addresses, nonzero XOR outputs, coherent lookup/use/unlookup, and native versus wrapped external control. Complete complex-amplitude references verify restored workspace for SELECT, SELECT-SWAP, and auto. Compiler checks distinguish Toffolis from higher-controlled X, and resource-only tables show strategy and controlled-geometry tradeoffs.

Validation on CUDA-Q 0.16.0, Python 3.12.3, qpp-cpu:

  • Standalone example passed; maximum 15 executed qubits, 18.80 s in the initial direct run.
  • python3 -m pytest tests/python/test_examples.py -k qrom_lookup -q: 1 passed.
  • python3 -m sphinx -W --keep-going -b html docs/sphinx docs/sphinx/_build/html: passed.
  • YAPF 0.43.0 and whitespace checks passed.

Independent plan 02 PR against main; its guide, examples page, and navigation are included. No other proposed tutorial or new dependency is required.

Signed-off-by: Scott Thornton <wsttiger@gmail.com>
The guide now states how a forced select_swap chooses its block size
and links the constructor contract in the API reference. The example's
phase reference notes that it describes a zero output word.

Signed-off-by: Scott Thornton <wsttiger@gmail.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant