Add `BasePass.get_pre_conditions` and `BasePass.get_post_conditions` #1689

sjdilkes · 2024-11-21T11:48:25Z

Adds two new methods to BasePass in passes.cpp to expose pre conditions and post conditions for a pass to the python layer as List[Predicate].

Related issues

#1675

Checklist

I have performed a self-review of my code.
I have commented hard-to-understand parts of my code.
I have made corresponding changes to the public API documentation.
I have added tests that prove my fix is effective or that my feature works.
I have updated the changelog with any user-facing changes.

pytket/binders/passes.cpp

cqc-alec · 2024-11-21T13:34:58Z

pytket/binders/passes.cpp

+            }
+            return pre_conditions;
+          },
+          "Returns the pre condition Predicates for the given pass."


Suggested change

"Returns the pre condition Predicates for the given pass."

"Returns the precondition Predicates for the given pass."

cqc-alec · 2024-11-21T13:35:22Z

pytket/binders/passes.cpp

+          "Returns the pre condition Predicates for the given pass."
+          "\n:return: A list of Predicate")
+      .def(
+          "get_post_conditions",


Suggested change

"get_post_conditions",

"get_postconditions",

cqc-alec · 2024-11-21T13:35:30Z

pytket/binders/passes.cpp

+            }
+            return post_conditions;
+          },
+          "Returns the post condition Predicates for the given pass."


Suggested change

"Returns the post condition Predicates for the given pass."

"Returns the postcondition Predicates for the given pass."

pytket/binders/passes.cpp

cqc-alec · 2024-11-21T13:40:22Z

pytket/binders/passes.cpp

I think it is also worth adding a function specifically to get the gate-set requirements of a pass; i.e. which gets the preconditions, checks for any GateSetPredicates, and returns the set intersection of their gate sets (or None if there are no GateSetPredicates.)

cqc-alec · 2024-11-21T13:41:23Z

tket/conanfile.py

@@ -23,7 +23,7 @@

 class TketConan(ConanFile):
    name = "tket"
-    version = "1.3.48"
+    version = "1.3.49"


This version bump shouldn't be necessary as the change only touches pytket.

oops ofc - will revert

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

cqc-alec · 2024-11-25T10:11:51Z

pytket/binders/passes.cpp

+  OpTypeSet allowed_ops;
+  for (const std::pair<const std::type_index, std::shared_ptr<tket::Predicate>>
+           &p : base_pass.get_conditions().first) {
+    if (p.second->to_string().substr(0, 17) == "GateSetPredicate:") {


I don't think this check is necessary. We can just use dynamic_cast and ignore it if it returns nullptr.

cqc-alec · 2024-11-25T10:14:31Z

pytket/binders/passes.cpp

+    if (p.second->to_string().substr(0, 17) == "GateSetPredicate:") {
+      std::shared_ptr<GateSetPredicate> gsp_ptr =
+          std::dynamic_pointer_cast<GateSetPredicate>(p.second);
+      if (allowed_ops.empty()) {


This will end up giving the wrong result in the (admittedly unlikely) case that we have already encountered two GateSetPredicates with empty intersection. I suggest using a std::optional<OpTypeSet>, where no-value means all all ops are allowed.

done (I think)

cqc-alec · 2024-11-25T10:18:01Z

pytket/binders/passes.cpp

+          "Returns the intersection of all set of OpType for all "
+          "GateSetPredicate in the `BasePass` preconditions.",
+          "\n\n:return: A set of allowed OpType")


Suggested change

"Returns the intersection of all set of OpType for all "

"GateSetPredicate in the `BasePass` preconditions.",

"\n\n:return: A set of allowed OpType")

"Returns the intersection of all set of OpType for all "

"GateSetPredicate in the `BasePass` preconditions, or `None` if there are no gate-set predicares.",

"\n\n:return: A set of allowed OpType, or `None`")

cqc-alec · 2024-11-25T10:18:37Z

pytket/conanfile.py

@@ -38,7 +38,7 @@ def requirements(self):
        self.requires("pybind11_json/0.2.14")
        self.requires("symengine/0.13.0")
        self.requires("tkassert/0.3.4@tket/stable")
-        self.requires("tket/1.3.49@tket/stable")
+        self.requires("tket/1.3.50@tket/stable")


This shouldn't need updating.

I've reverted - let's see if the same issue comes up

cqc-alec · 2024-11-25T10:20:08Z

pytket/tests/predicates_test.py

+    assert OpType.CX in gate_set  # type: ignore
+    assert OpType.Measure in gate_set  # type: ignore


Should be able to avoid the type: ignores by first asserting that gate_set is not None.

cqc-alec · 2024-11-25T10:20:26Z

tket/conanfile.py

@@ -23,7 +23,7 @@

 class TketConan(ConanFile):
    name = "tket"
-    version = "1.3.49"
+    version = "1.3.50"


Shouldn't be needed.

…1689) * Add new methods for getting predicates from python passes * bump * Update predicates_test.py * Update pytket/binders/passes.cpp Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com> * Update pytket/binders/passes.cpp Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com> * add get gate_set, check tests * Update predicates_test.py * Update predicates_test.py * Update predicates_test.py * bump, fix ruff issue * regen stubs * Update predicates_test.py * Update predicates_test.py * Update predicates_test.py * addresss comments * Update predicates_test.py --------- Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

sjdilkes added 3 commits November 21, 2024 11:47

Add new methods for getting predicates from python passes

e494551

bump

da64baa

Update predicates_test.py

135fa39

sjdilkes marked this pull request as ready for review November 21, 2024 13:28

sjdilkes requested a review from cqc-alec November 21, 2024 13:28

cqc-alec reviewed Nov 21, 2024

View reviewed changes

sjdilkes and others added 6 commits November 21, 2024 14:12

Update pytket/binders/passes.cpp

801bb2a

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

Update pytket/binders/passes.cpp

297cd4e

Co-authored-by: Alec Edgington <54802828+cqc-alec@users.noreply.github.com>

add get gate_set, check tests

34ed2c2

Merge branch 'main' into gateset-from-GateSetPredicate

b07b052

Update predicates_test.py

04d318b

Update predicates_test.py

ea9700d

sjdilkes requested a review from cqc-alec November 22, 2024 11:26

sjdilkes and others added 8 commits November 22, 2024 13:05

Update predicates_test.py

3ca2716

bump, fix ruff issue

e94838a

regen stubs

a94fa69

Merge branch 'main' into gateset-from-GateSetPredicate

c41dab2

Update predicates_test.py

376d87c

Update predicates_test.py

d104331

Update predicates_test.py

2e4ca31

Merge branch 'main' into gateset-from-GateSetPredicate

dc05f2f

cqc-alec requested changes Nov 25, 2024

View reviewed changes

sjdilkes added 2 commits November 25, 2024 11:43

addresss comments

ed275e6

Update predicates_test.py

f0fb617

sjdilkes requested a review from cqc-alec November 25, 2024 11:58

cqc-alec approved these changes Nov 25, 2024

View reviewed changes

sjdilkes merged commit ba0f7c0 into main Nov 25, 2024
30 checks passed

sjdilkes deleted the gateset-from-GateSetPredicate branch November 25, 2024 12:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `BasePass.get_pre_conditions` and `BasePass.get_post_conditions` #1689

Add `BasePass.get_pre_conditions` and `BasePass.get_post_conditions` #1689

sjdilkes commented Nov 21, 2024 •

edited

Loading

cqc-alec Nov 21, 2024

sjdilkes Nov 21, 2024

cqc-alec Nov 21, 2024

sjdilkes Nov 21, 2024

cqc-alec Nov 21, 2024

sjdilkes Nov 21, 2024

cqc-alec Nov 21, 2024

sjdilkes Nov 21, 2024

cqc-alec Nov 21, 2024

sjdilkes Nov 21, 2024

cqc-alec Nov 25, 2024

cqc-alec Nov 25, 2024

sjdilkes Nov 25, 2024

cqc-alec Nov 25, 2024

sjdilkes Nov 25, 2024

cqc-alec Nov 25, 2024

sjdilkes Nov 25, 2024

cqc-alec Nov 25, 2024

sjdilkes Nov 25, 2024

cqc-alec Nov 25, 2024

	"Returns the pre condition Predicates for the given pass."
	"Returns the precondition Predicates for the given pass."

	"Returns the post condition Predicates for the given pass."
	"Returns the postcondition Predicates for the given pass."

		assert OpType.CX in gate_set # type: ignore
		assert OpType.Measure in gate_set # type: ignore

Add BasePass.get_pre_conditions and BasePass.get_post_conditions #1689

Add BasePass.get_pre_conditions and BasePass.get_post_conditions #1689

Conversation

sjdilkes commented Nov 21, 2024 • edited Loading

Related issues

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `BasePass.get_pre_conditions` and `BasePass.get_post_conditions` #1689

Add `BasePass.get_pre_conditions` and `BasePass.get_post_conditions` #1689

sjdilkes commented Nov 21, 2024 •

edited

Loading