Create a new condition that allows easy control by bitmasks and Add a new classical Update the notebook for 'Classical control' to reflect new features" #7166

NoureldinYosri · 2025-03-19T22:29:14Z

This PR creates BitMaskKeyCondition a condition that can be used to create multiqubit classical conditions with bitmasks. This will be much easier than using sympy indexedbase

cc: @ikd-sci

Examples:

Any bit from 0, 2, 3 => 0b1101 = 13

In [4]: cond = cirq.BitMaskKeyCondition('m', bitmask=13)
   ...: c = cirq.Circuit(
   ...:     cirq.H.on_each(qs),
   ...:     cirq.measure(qs, key='m'),
   ...:     cirq.Y(cirq.q(5)).with_classical_controls(cond),
   ...: 
   ...: )
   ...: c
Out[4]: 
0: ───H───M────────────────────────────
          ║
1: ───H───M────────────────────────────
          ║
2: ───H───M────────────────────────────
          ║
3: ───H───M────────────────────────────
          ║
4: ───H───M────────────────────────────
          ║
5: ───────╫───Y(conditions=[m & 13])───
          ║   ║
m: ═══════@═══^════════════════════════

Contains 0b1011 = 11 as bitmask

In [5]: cond = cirq.BitMaskKeyCondition.create_equal_mask('m', bitmask=11)
   ...: c = cirq.Circuit(
   ...:     cirq.H.on_each(qs),
   ...:     cirq.measure(qs, key='m'),
   ...:     cirq.Y(cirq.q(5)).with_classical_controls(cond),
   ...: 
   ...: )
   ...: c
Out[5]: 
0: ───H───M────────────────────────────────────
          ║
1: ───H───M────────────────────────────────────
          ║
2: ───H───M────────────────────────────────────
          ║
3: ───H───M────────────────────────────────────
          ║
4: ───H───M────────────────────────────────────
          ║
5: ───────╫───Y(conditions=[(m & 11) == 11])───
          ║   ║
m: ═══════@═══^════════════════════════════════

Doesn't contain 11 as a bitmask

In [6]: cond = cirq.BitMaskKeyCondition.create_not_equal_mask('m', bitmask=11)
   ...: c = cirq.Circuit(
   ...:     cirq.H.on_each(qs),
   ...:     cirq.measure(qs, key='m'),
   ...:     cirq.Y(cirq.q(5)).with_classical_controls(cond),
   ...: 
   ...: )
   ...: c
Out[6]: 
0: ───H───M────────────────────────────────────
          ║
1: ───H───M────────────────────────────────────
          ║
2: ───H───M────────────────────────────────────
          ║
3: ───H───M────────────────────────────────────
          ║
4: ───H───M────────────────────────────────────
          ║
5: ───────╫───Y(conditions=[(m & 11) != 11])───
          ║   ║
m: ═══════@═══^════════════════════════════════

update the notebook to reflect the upgraded sympy support from #6914 and the new bitmask condition from #7165

codecov · 2025-03-19T23:45:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.14%. Comparing base (c50ce1e) to head (c9cdc67).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #7166   +/-   ##
=======================================
  Coverage   98.14%   98.14%           
=======================================
  Files        1100     1100           
  Lines       96147    96241   +94     
=======================================
+ Hits        94365    94459   +94     
  Misses       1782     1782

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

daxfohl

Lgtm. All my concerns were addressed in previous PR.

dstrain115

LGTM minus some nits.

dstrain115 · 2025-03-30T20:14:33Z

cirq-core/cirq/protocols/json_serialization.py

+def attrs_json_dict(obj: Any) -> Dict[str, Any]:
+    """Return a dictionary suitable for `_json_dict_` from an attrs dataclass."""
+    attribute_names = [f.name for f in attrs.fields(type(obj))]
+    return obj_to_dict_helper(obj, attribute_names)


Can you add a unit test for this function?

dstrain115 · 2025-03-30T20:15:46Z

cirq-core/cirq/value/condition.py

+    """A multiqubit classical control condition with a bitmask.
+
+    The control is based on a single measurement key and allows comparing equality or inequality
+    after taking the bitwise and with a bitmask.


Should we have a short blurb about the bit order of the measurement (or a reference to the measurement code that explains)?

dstrain115 · 2025-03-30T20:16:40Z

cirq-core/cirq/value/condition.py

+    @staticmethod
+    def create_equal_mask(
+        key: 'cirq.MeasurementKey', bitmask: int, *, index: int = -1
+    ) -> 'BitMaskKeyCondition':


Add docstring.

dstrain115 · 2025-03-30T20:16:44Z

cirq-core/cirq/value/condition.py

+    @staticmethod
+    def create_not_equal_mask(
+        key: 'cirq.MeasurementKey', bitmask: int, *, index: int = -1
+    ) -> 'BitMaskKeyCondition':


Add docstring.

… new classical Update the notebook for 'Classical control' to reflect new features" (quantumlib#7166) * Create a new condition that allows easy control by bitmasks * add tests * docstring * add missing files * swith from dataclasses to attrs * mypy * Update the notebook for 'Classical control' to reflect new features * nit * nit * tests * nit * fix doc regex * format * address comments * lint

NoureldinYosri and others added 10 commits March 19, 2025 12:02

Create a new condition that allows easy control by bitmasks

65be028

add tests

5531647

docstring

c53e3fd

Merge branch 'main' into main

89fa10f

add missing files

c2891a9

swith from dataclasses to attrs

9a4a7ec

mypy

ebef9bf

Update the notebook for 'Classical control' to reflect new features

9496059

nit

039867a

Merge branch 'main' into classical_control_docs

7885d7d

NoureldinYosri changed the title ~~Update the notebook for 'Classical control' to reflect new features"~~ Create a new condition that allows easy control by bitmasks and Add a new classical Update the notebook for 'Classical control' to reflect new features" Mar 21, 2025

NoureldinYosri mentioned this pull request Mar 21, 2025

Create a new condition that allows easy control by bitmasks #7165

Merged

NoureldinYosri and others added 2 commits March 21, 2025 16:48

Merge branch 'main' into classical_control_docs

4f368bf

nit

dcc3ad9

NoureldinYosri marked this pull request as ready for review March 21, 2025 23:55

NoureldinYosri requested review from vtomole and a team as code owners March 21, 2025 23:55

NoureldinYosri requested review from maffoo, pavoljuhas and daxfohl March 21, 2025 23:55

daxfohl approved these changes Mar 22, 2025

View reviewed changes

NoureldinYosri and others added 6 commits March 25, 2025 00:30

tests

1281b9d

Merge branch 'main' into classical_control_docs

9b6b7d3

Merge branch 'main' into classical_control_docs

bc67e1f

nit

d6683be

fix doc regex

7f4a35b

format

53aaff5

dstrain115 approved these changes Mar 30, 2025

View reviewed changes

address comments

c90ec8e

Merge branch 'main' into classical_control_docs

dc19f9d

NoureldinYosri enabled auto-merge March 31, 2025 18:31

lint

c9cdc67

NoureldinYosri added this pull request to the merge queue Mar 31, 2025

Merged via the queue into quantumlib:main with commit 8a3d1ef Mar 31, 2025
38 checks passed

NoureldinYosri deleted the classical_control_docs branch March 31, 2025 19:05

mhucka mentioned this pull request Apr 18, 2025

Improve reporting of errors & efficiency of pr-size-labeler #7288

Merged

This was referenced May 30, 2025

Support serializing sweeps with numpy values #7398

Merged

Update RB to reduce the size of the generated circuits #7411

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Create a new condition that allows easy control by bitmasks and Add a new classical Update the notebook for 'Classical control' to reflect new features" #7166

Create a new condition that allows easy control by bitmasks and Add a new classical Update the notebook for 'Classical control' to reflect new features" #7166

Uh oh!

NoureldinYosri commented Mar 19, 2025 •

edited

Loading

Uh oh!

codecov bot commented Mar 19, 2025 •

edited

Loading

Uh oh!

daxfohl left a comment •

edited

Loading

Uh oh!

dstrain115 left a comment

Uh oh!

dstrain115 Mar 30, 2025

Uh oh!

NoureldinYosri Mar 31, 2025

Uh oh!

dstrain115 Mar 30, 2025

Uh oh!

NoureldinYosri Mar 31, 2025

Uh oh!

dstrain115 Mar 30, 2025

Uh oh!

NoureldinYosri Mar 31, 2025

Uh oh!

dstrain115 Mar 30, 2025

Uh oh!

NoureldinYosri Mar 31, 2025

Uh oh!

Uh oh!

Uh oh!

Create a new condition that allows easy control by bitmasks and Add a new classical Update the notebook for 'Classical control' to reflect new features" #7166

Create a new condition that allows easy control by bitmasks and Add a new classical Update the notebook for 'Classical control' to reflect new features" #7166

Uh oh!

Conversation

NoureldinYosri commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Examples:

Any bit from 0, 2, 3 => 0b1101 = 13

Contains 0b1011 = 11 as bitmask

Doesn't contain 11 as a bitmask

Uh oh!

codecov bot commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

daxfohl left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dstrain115 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

NoureldinYosri commented Mar 19, 2025 •

edited

Loading

codecov bot commented Mar 19, 2025 •

edited

Loading

daxfohl left a comment •

edited

Loading