From 270821f8c6c3ec7160c9b93f8956b60677e19aee Mon Sep 17 00:00:00 2001 From: Craig Gidney Date: Mon, 9 Sep 2024 20:53:51 -0700 Subject: [PATCH] regen docs --- MODULE.bazel.lock | 8 ++++---- doc/python_api_reference_vDev.md | 15 ++++++++++++--- doc/stim.pyi | 15 ++++++++++++--- glue/python/src/stim/__init__.pyi | 15 ++++++++++++--- 4 files changed, 40 insertions(+), 13 deletions(-) diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock index abc083f0..4c8df156 100644 --- a/MODULE.bazel.lock +++ b/MODULE.bazel.lock @@ -40,8 +40,8 @@ "https://bcr.bazel.build/modules/rules_cc/0.0.9/MODULE.bazel": "836e76439f354b89afe6a911a7adf59a6b2518fafb174483ad78a2a2fde7b1c5", "https://bcr.bazel.build/modules/rules_cc/0.0.9/source.json": "1f1ba6fea244b616de4a554a0f4983c91a9301640c8fe0dd1d410254115c8430", "https://bcr.bazel.build/modules/rules_java/4.0.0/MODULE.bazel": "5a78a7ae82cd1a33cef56dc578c7d2a46ed0dca12643ee45edbb8417899e6f74", - "https://bcr.bazel.build/modules/rules_java/7.6.1/MODULE.bazel": "2f14b7e8a1aa2f67ae92bc69d1ec0fa8d9f827c4e17ff5e5f02e91caa3b2d0fe", - "https://bcr.bazel.build/modules/rules_java/7.6.1/source.json": "8f3f3076554e1558e8e468b2232991c510ecbcbed9e6f8c06ac31c93bcf38362", + "https://bcr.bazel.build/modules/rules_java/7.6.5/MODULE.bazel": "481164be5e02e4cab6e77a36927683263be56b7e36fef918b458d7a8a1ebadb1", + "https://bcr.bazel.build/modules/rules_java/7.6.5/source.json": "a805b889531d1690e3c72a7a7e47a870d00323186a9904b36af83aa3d053ee8d", "https://bcr.bazel.build/modules/rules_jvm_external/4.4.2/MODULE.bazel": "a56b85e418c83eb1839819f0b515c431010160383306d13ec21959ac412d2fe7", "https://bcr.bazel.build/modules/rules_jvm_external/4.4.2/source.json": "a075731e1b46bc8425098512d038d416e966ab19684a10a34f4741295642fc35", "https://bcr.bazel.build/modules/rules_license/0.0.3/MODULE.bazel": "627e9ab0247f7d1e05736b59dbb1b6871373de5ad31c3011880b4133cafd4bd0", @@ -62,8 +62,8 @@ "https://bcr.bazel.build/modules/upb/0.0.0-20220923-a547704/source.json": "f1ef7d3f9e0e26d4b23d1c39b5f5de71f584dd7d1b4ef83d9bbba6ec7a6a6459", "https://bcr.bazel.build/modules/zlib/1.2.11/MODULE.bazel": "07b389abc85fdbca459b69e2ec656ae5622873af3f845e1c9d80fe179f3effa0", "https://bcr.bazel.build/modules/zlib/1.2.12/MODULE.bazel": "3b1a8834ada2a883674be8cbd36ede1b6ec481477ada359cd2d3ddc562340b27", - "https://bcr.bazel.build/modules/zlib/1.3/MODULE.bazel": "6a9c02f19a24dcedb05572b2381446e27c272cd383aed11d41d99da9e3167a72", - "https://bcr.bazel.build/modules/zlib/1.3/source.json": "b6b43d0737af846022636e6e255fd4a96fee0d34f08f3830e6e0bac51465c37c" + "https://bcr.bazel.build/modules/zlib/1.3.1.bcr.3/MODULE.bazel": "af322bc08976524477c79d1e45e241b6efbeb918c497e8840b8ab116802dda79", + "https://bcr.bazel.build/modules/zlib/1.3.1.bcr.3/source.json": "2be409ac3c7601245958cd4fcdff4288be79ed23bd690b4b951f500d54ee6e7d" }, "selectedYankedVersions": {}, "moduleExtensions": { diff --git a/doc/python_api_reference_vDev.md b/doc/python_api_reference_vDev.md index d05fb9dc..41ba021b 100644 --- a/doc/python_api_reference_vDev.md +++ b/doc/python_api_reference_vDev.md @@ -10142,10 +10142,19 @@ def __call__( self, pauli_string: stim.PauliString, ) -> stim.PauliString: - """Returns the conjugation of a PauliString by the Tableau's Clifford operation. + """Returns the equivalent PauliString after the Tableau's Clifford operation. - The conjugation of P by C is equal to C**-1 * P * C. If P is a Pauli product - before C, then P2 = C**-1 * P * C is an equivalent Pauli product after C. + If P is a Pauli product before a Clifford operation C, then this method returns + Q = C * P * C**-1 (the conjugation of P by C). Q is the equivalent Pauli product + after C. This works because: + + C*P + = C*P * I + = C*P * (C**-1 * C) + = (C*P*C**-1) * C + = Q*C + + (Keep in mind that A*B means first B is applied, then A is applied.) Args: pauli_string: The pauli string to conjugate. diff --git a/doc/stim.pyi b/doc/stim.pyi index 8d603dd7..955834d4 100644 --- a/doc/stim.pyi +++ b/doc/stim.pyi @@ -7853,10 +7853,19 @@ class Tableau: self, pauli_string: stim.PauliString, ) -> stim.PauliString: - """Returns the conjugation of a PauliString by the Tableau's Clifford operation. + """Returns the equivalent PauliString after the Tableau's Clifford operation. - The conjugation of P by C is equal to C**-1 * P * C. If P is a Pauli product - before C, then P2 = C**-1 * P * C is an equivalent Pauli product after C. + If P is a Pauli product before a Clifford operation C, then this method returns + Q = C * P * C**-1 (the conjugation of P by C). Q is the equivalent Pauli product + after C. This works because: + + C*P + = C*P * I + = C*P * (C**-1 * C) + = (C*P*C**-1) * C + = Q*C + + (Keep in mind that A*B means first B is applied, then A is applied.) Args: pauli_string: The pauli string to conjugate. diff --git a/glue/python/src/stim/__init__.pyi b/glue/python/src/stim/__init__.pyi index 8d603dd7..955834d4 100644 --- a/glue/python/src/stim/__init__.pyi +++ b/glue/python/src/stim/__init__.pyi @@ -7853,10 +7853,19 @@ class Tableau: self, pauli_string: stim.PauliString, ) -> stim.PauliString: - """Returns the conjugation of a PauliString by the Tableau's Clifford operation. + """Returns the equivalent PauliString after the Tableau's Clifford operation. - The conjugation of P by C is equal to C**-1 * P * C. If P is a Pauli product - before C, then P2 = C**-1 * P * C is an equivalent Pauli product after C. + If P is a Pauli product before a Clifford operation C, then this method returns + Q = C * P * C**-1 (the conjugation of P by C). Q is the equivalent Pauli product + after C. This works because: + + C*P + = C*P * I + = C*P * (C**-1 * C) + = (C*P*C**-1) * C + = Q*C + + (Keep in mind that A*B means first B is applied, then A is applied.) Args: pauli_string: The pauli string to conjugate.