Merge branch 'main' into unary_iteration

Author: matthagan15

dev_tools/autogenerate-bloqs-notebooks-v2.py

@@ -217,10 +217,19 @@
         ],
     ),
     NotebookSpecV2(
-        title='Swap Network',
-        module=qualtran.bloqs.swap_network,
+        title='Basic Swaps',
+        module=qualtran.bloqs.basic_gates.swap,
         bloq_specs=[
+            qualtran.bloqs.basic_gates.swap._TWO_BIT_SWAP_DOC,
+            qualtran.bloqs.basic_gates.swap._TWO_BIT_CSWAP_DOC,
+            qualtran.bloqs.basic_gates.swap._SWAP_DOC,
             qualtran.bloqs.basic_gates.swap._CSWAP_DOC,
+        ],
+    ),
+    NotebookSpecV2(
+        title='Swap Networks',
+        module=qualtran.bloqs.swap_network,
+        bloq_specs=[
             qualtran.bloqs.swap_network.cswap_approx._APPROX_CSWAP_DOC,
             qualtran.bloqs.swap_network.swap_with_zero._SWZ_DOC,
             qualtran.bloqs.swap_network.multiplexed_cswap._MULTIPLEXED_CSWAP_DOC,
@@ -499,11 +508,23 @@
             qualtran.bloqs.mod_arithmetic.mod_addition._C_MOD_ADD_DOC,
         ],
     ),
+    NotebookSpecV2(
+        title='Modular Subtraction',
+        module=qualtran.bloqs.mod_arithmetic.mod_subtraction,
+        bloq_specs=[
+            qualtran.bloqs.mod_arithmetic.mod_subtraction._MOD_NEG_DOC,
+            qualtran.bloqs.mod_arithmetic.mod_subtraction._CMOD_NEG_DOC,
+            qualtran.bloqs.mod_arithmetic.mod_subtraction._MOD_SUB_DOC,
+            qualtran.bloqs.mod_arithmetic.mod_subtraction._CMOD_SUB_DOC,
+        ],
+    ),
     NotebookSpecV2(
         title='Modular Multiplication',
-        module=qualtran.bloqs.factoring.mod_mul,
-        bloq_specs=[qualtran.bloqs.factoring.mod_mul._MODMUL_DOC],
-        directory=f'{SOURCE_DIR}/bloqs/factoring',
+        module=qualtran.bloqs.mod_arithmetic.mod_multiplication,
+        bloq_specs=[
+            qualtran.bloqs.mod_arithmetic.mod_multiplication._MOD_DBL_DOC,
+            qualtran.bloqs.mod_arithmetic.mod_multiplication._C_MOD_MUL_K_DOC,
+        ],
     ),
     NotebookSpecV2(
         title='Modular Exponentiation',
@@ -625,7 +646,15 @@
         title='Textbook Quantum Phase Estimation',
         module=qualtran.bloqs.phase_estimation.text_book_qpe,
         bloq_specs=[
-            qualtran.bloqs.phase_estimation.text_book_qpe._CC_TEXTBOOK_PHASE_ESTIMATION_DOC
+            qualtran.bloqs.phase_estimation.qpe_window_state._CC_RECTANGULAR_WINDOW_STATE_DOC,
+            qualtran.bloqs.phase_estimation.text_book_qpe._CC_TEXTBOOK_PHASE_ESTIMATION_DOC,
+        ],
+    ),
+    NotebookSpecV2(
+        title='Kaiser Window State for Quantum Phase Estimation',
+        module=qualtran.bloqs.phase_estimation.kaiser_window_state,
+        bloq_specs=[
+            qualtran.bloqs.phase_estimation.kaiser_window_state._CC_KAISER_WINDOW_STATE_DOC
         ],
     ),
     NotebookSpecV2(

dev_tools/how-to-cut-a-release.md

@@ -0,0 +1,46 @@
+# Releasing Qualtran
+
+The steps are
+
+ 1. Bump the version number to the desired release version
+ 2. Tag the release
+ 3. Follow the Python packaging guide to generate a distribution and upload it
+ 4. Bump the version number to the next "dev" version
+
+The packaging guide instructions can be found at:
+https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives
+
+## Set the version number
+
+Open a PR to edit `qualtran/_version.py` to change the version string to "x.y.z" (without any dev specifier), which
+is the desired version number.
+It should have previously been set to "x.y.z.dev0".
+The PR should be merged to the `main` branch and care should be taken not to merge any other PRs until
+the entire process is completed.
+Draft the release notes and circulate them for review.
+
+## Tag the repository
+
+Use GitHub "Releases" to tag the release with release notes. Tags for "x.y.0" minor releases should go on `main`.
+Patch releases (z > 0) should be tagged against a `vx.y` branch unless the patch immediately follows a minor release.
+
+Follow the convention for tag names. Include the "v" in the tag name. 
+
+## Package the release
+
+Make sure you're on `main` and have pulled the version-bump commit.
+It's recommended to carefully run `git clean -ndx` (change n to f to actually do it) to prepare
+a pristine repository state.
+Then, follow the guidance at 
+https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives.
+
+Modify the command to upload to the main pypi repository (rather than the test repository used for the tutorial).
+
+## Bump the version number to dev
+
+Edit `_version.py` again, and change the version number from "x.y.z" to "x.(y+1).0.dev0".
+
+## Communicate
+
+Send an email to [qualtran-announce@googlegroups.com](https://groups.google.com/g/qualtran-announce) announcing 
+the release. Congrats!

dev_tools/qualtran_dev_tools/all_call_graph.py

@@ -0,0 +1,82 @@
+#  Copyright 2024 Google LLC
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+"""Generate the library-wide call graph from all bloq examples."""
+import logging
+import warnings
+from typing import Iterable
+
+import networkx as nx
+
+from qualtran import Bloq, BloqExample, DecomposeNotImplementedError, DecomposeTypeError
+from qualtran.bloqs.basic_gates import Rx, Ry, Rz, TGate, Toffoli, XPowGate, YPowGate, ZPowGate
+from qualtran.resource_counting import SympySymbolAllocator
+from qualtran.resource_counting._call_graph import _build_call_graph
+from qualtran.resource_counting._generalization import _make_composite_generalizer
+from qualtran.resource_counting.generalizers import (
+    generalize_cvs,
+    generalize_rotation_angle,
+    ignore_alloc_free,
+    ignore_cliffords,
+    ignore_split_join,
+)
+
+logger = logging.getLogger(__name__)
+
+
+def get_all_call_graph(bes: Iterable[BloqExample]):
+    """Create a call graph that is the union of all of the bloqs in the list of bloq examples.
+
+    This applies some standard generalizers, and will stop at a larger-than-default set
+    of leaf bloqs in accordance with https://github.com/quantumlib/Qualtran/issues/873
+    """
+    generalize = _make_composite_generalizer(
+        ignore_split_join,
+        generalize_cvs,
+        generalize_rotation_angle,
+        ignore_alloc_free,
+        ignore_cliffords,
+    )
+
+    def keep(b: Bloq) -> bool:
+        if b == Toffoli():
+            return True
+
+        if b == TGate():
+            return True
+
+        if isinstance(b, (Rx, Ry, Rz, XPowGate, YPowGate, ZPowGate)):
+            return True
+
+        try:
+            _ = b.build_call_graph(SympySymbolAllocator())
+        except DecomposeTypeError:
+            return True
+        except DecomposeNotImplementedError:
+            warnings.warn(f"{b} lacks a call graph.")
+            return True
+
+        return False
+
+    g = nx.DiGraph()
+    ssa = SympySymbolAllocator()
+
+    for be in bes:
+        logger.info("Building call graph for: %s", be.name)
+        bloq = be.make()
+        _build_call_graph(
+            bloq=bloq, generalizer=generalize, ssa=ssa, keep=keep, max_depth=None, g=g, depth=0
+        )
+
+    return g

dev_tools/qualtran_dev_tools/all_call_graph_test.py

@@ -0,0 +1,29 @@
+#  Copyright 2024 Google LLC
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import networkx as nx
+import pytest
+
+from .all_call_graph import get_all_call_graph
+from .bloq_finder import get_bloq_examples
+
+
+@pytest.mark.slow
+def test_get_all_call_graph():
+    # This test generates a union of the call graphs of every bloq example in the library.
+    # This test makes sure that there aren't any bloq examples with broken call graphs.
+    bes = get_bloq_examples()
+    g = get_all_call_graph(bes)
+    res = list(nx.simple_cycles(g))
+    assert res == []

dev_tools/requirements/envs/dev.env.txt

@@ -288,7 +288,7 @@ jupyter-server==2.14.2
     #   notebook-shim
 jupyter-server-terminals==0.5.3
     # via jupyter-server
-jupyterlab==4.2.4
+jupyterlab==4.2.5
     # via notebook
 jupyterlab-pygments==0.3.0
     # via nbconvert

dev_tools/requirements/envs/docs.env.txt

@@ -340,7 +340,7 @@ jupyter-server-terminals==0.5.3
     # via
     #   -c envs/dev.env.txt
     #   jupyter-server
-jupyterlab==4.2.4
+jupyterlab==4.2.5
     # via
     #   -c envs/dev.env.txt
     #   notebook

dev_tools/requirements/envs/format.env.txt

@@ -310,7 +310,7 @@ jupyter-server-terminals==0.5.3
     # via
     #   -c envs/dev.env.txt
     #   jupyter-server
-jupyterlab==4.2.4
+jupyterlab==4.2.5
     # via
     #   -c envs/dev.env.txt
     #   notebook

dev_tools/requirements/envs/pylint.env.txt

@@ -360,7 +360,7 @@ jupyter-server-terminals==0.5.3
     # via
     #   -c envs/dev.env.txt
     #   jupyter-server
-jupyterlab==4.2.4
+jupyterlab==4.2.5
     # via
     #   -c envs/dev.env.txt
     #   notebook

dev_tools/requirements/envs/pytest.env.txt

@@ -334,7 +334,7 @@ jupyter-server-terminals==0.5.3
     # via
     #   -c envs/dev.env.txt
     #   jupyter-server
-jupyterlab==4.2.4
+jupyterlab==4.2.5
     # via
     #   -c envs/dev.env.txt
     #   notebook

dev_tools/requirements/envs/runtime.env.txt

@@ -293,7 +293,7 @@ jupyter-server-terminals==0.5.3
     # via
     #   -c envs/dev.env.txt
     #   jupyter-server
-jupyterlab==4.2.4
+jupyterlab==4.2.5
     # via
     #   -c envs/dev.env.txt
     #   notebook

docs/bloq_infra.rst

@@ -24,7 +24,8 @@ types (``Register``), and algorithms (``CompositeBloq``).
    :maxdepth: 1
    :caption: Quantum Computer Architectures:
 
-   surface_code/azure_cost_model.ipynb
+   surface_code/physical_cost_model.ipynb
+   surface_code/beverland_et_al_model.ipynb
    surface_code/thc_compilation.ipynb
    surface_code/msft_resource_estimator_interop.ipynb
 
@@ -35,6 +36,7 @@ types (``Register``), and algorithms (``CompositeBloq``).
    _infra/composite_bloq.ipynb
    cirq_interop/cirq_interop.ipynb
    cirq_interop/t_complexity.ipynb
+   qref_interop/bartiq_demo.ipynb
    _infra/gate_with_registers.ipynb
    drawing/graphviz.ipynb
    drawing/musical_score.ipynb

docs/bloqs/index.rst

@@ -34,6 +34,7 @@ Bloqs Library
     basic_gates/y_gate.ipynb
     mcmt/and_bloq.ipynb
     basic_gates/states_and_effects.ipynb
+    basic_gates/swap.ipynb
     swap_network/swap_network.ipynb
     basic_gates/global_phase.ipynb
     basic_gates/identity.ipynb
@@ -80,7 +81,8 @@ Bloqs Library
     :caption: Modular Arithmetic:
 
     mod_arithmetic/mod_addition.ipynb
-    factoring/mod_mul.ipynb
+    mod_arithmetic/mod_subtraction.ipynb
+    mod_arithmetic/mod_multiplication.ipynb
     factoring/mod_exp.ipynb
     factoring/ecc/ec_add.ipynb
     factoring/ecc/ecc.ipynb
@@ -102,6 +104,7 @@ Bloqs Library
     qft/qft_phase_gradient.ipynb
     phase_estimation/lp_resource_state.ipynb
     phase_estimation/text_book_qpe.ipynb
+    phase_estimation/kaiser_window_state.ipynb
     qubitization/qubitization_walk_operator.ipynb
     phase_estimation/qubitization_qpe.ipynb
 

qualtran/Protocols.ipynb

@@ -33,7 +33,7 @@
     "\n",
     "### Call Graph\n",
     "\n",
-    "You can get a directed-acyclic graph representing the hierarchical decomposition of bloqs by calling `bloq.call_graph()` or direct callees with `bloq.bloq_counts()`. Additional functionality is contained in the `qualtran.resource_counting` module. To implement this protocol, bloq authors can override `Bloq.build_call_graph(...)`. The default fallback uses the decomposition protocol and `build_cbloq_call_graph(...)`. See the full [call graph protocol documentation](./resource_counting/bloq_counts.ipynb) for details.\n",
+    "You can get a directed-acyclic graph representing the hierarchical decomposition of bloqs by calling `bloq.call_graph()` or direct callees with `bloq.bloq_counts()`. Additional functionality is contained in the `qualtran.resource_counting` module. To implement this protocol, bloq authors can override `Bloq.build_call_graph(...)`. The default fallback uses the decomposition protocol and `build_cbloq_call_graph(...)`. See the full [call graph protocol documentation](./resource_counting/call_graph.ipynb) for details.\n",
     "\n",
     "### Tensor\n",
     "\n",
@@ -65,7 +65,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.9"
+   "version": "3.11.8"
   }
  },
  "nbformat": 4,

qualtran/__init__.py

@@ -51,7 +51,7 @@
     QFxp,
     QIntOnesComp,
     QUInt,
-    BoundedQUInt,
+    BQUInt,
     QMontgomeryUInt,
 )