Implement Kikuchi guiding state preparation (#1504)

* Add list primitives from Quartic speedups paper

* notebook

* fix tests

* Implement Kikuchi guiding state preparation

* rename folder

* rename `kikuchi_guiding_state.py`

* add notebook spec

---------

Co-authored-by: Tanuj Khattar <tanujkhattar@google.com>

dev_tools/qualtran_dev_tools/notebook_specs.py

@@ -104,6 +104,7 @@
 import qualtran.bloqs.multiplexers.black_box_select
 import qualtran.bloqs.multiplexers.select_base
 import qualtran.bloqs.multiplexers.select_pauli_lcu
+import qualtran.bloqs.optimization.k_xor_sat.kikuchi_guiding_state
 import qualtran.bloqs.phase_estimation.lp_resource_state
 import qualtran.bloqs.phase_estimation.qubitization_qpe
 import qualtran.bloqs.phase_estimation.text_book_qpe
@@ -796,6 +797,20 @@
     ),
 ]
 
+# --------------------------------------------------------------------------
+# -----   Optimization   ---------------------------------------------------
+# --------------------------------------------------------------------------
+OPTIMIZATION: List[NotebookSpecV2] = [
+    NotebookSpecV2(
+        title='Planted Noisy kXOR - Kikuchi Guiding State',
+        module=qualtran.bloqs.optimization.k_xor_sat.kikuchi_guiding_state,
+        bloq_specs=[
+            qualtran.bloqs.optimization.k_xor_sat.kikuchi_guiding_state._SIMPLE_GUIDING_STATE_DOC,
+            qualtran.bloqs.optimization.k_xor_sat.kikuchi_guiding_state._GUIDING_STATE_DOC,
+        ],
+    )
+]
+
 # --------------------------------------------------------------------------
 # -----   Other   ----------------------------------------------------------
 # --------------------------------------------------------------------------
@@ -912,5 +927,6 @@
     ('GF Arithmetic', GF_ARITHMETIC),
     ('Rotations', ROT_QFT_PE),
     ('Block Encoding', BLOCK_ENCODING),
+    ('Optimization', OPTIMIZATION),
     ('Other', OTHER),
 ]

docs/bloqs/index.rst

@@ -137,6 +137,12 @@ Bloqs Library
     block_encoding/chebyshev_polynomial.ipynb
     block_encoding/lcu_block_encoding.ipynb
 
+.. toctree::
+    :maxdepth: 2
+    :caption: Optimization:
+
+    optimization/k_xor_sat/kikuchi_guiding_state.ipynb
+
 .. toctree::
     :maxdepth: 2
     :caption: Other:

qualtran/bloqs/optimization/k_xor_sat/__init__.py

@@ -0,0 +1,15 @@
+#  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.
+from .kikuchi_guiding_state import GuidingState, SimpleGuidingState
+from .kxor_instance import Constraint, KXorInstance