Merge branch 'main' into gari-pr269-B-cpp

Author: noajshu

CMakeLists.txt

@@ -132,6 +132,16 @@ pybind11_add_module(tesseract_decoder MODULE ${TESSERACT_SRC_DIR}/tesseract.pybi
 target_compile_options(tesseract_decoder PRIVATE ${OPT_COPTS})
 target_include_directories(tesseract_decoder PRIVATE ${TESSERACT_SRC_DIR})
 target_link_libraries(tesseract_decoder PRIVATE common utils simplex tesseract_lib)
+# Keep statically linked HiGHS symbols private to this extension on every
+# supported Unix platform. Mach-O uses an explicit export list because it has
+# no ELF-style --exclude-libs option; otherwise highspy can resolve symbols to
+# Tesseract's private HiGHS copy when both extensions share a process.
+if(APPLE)
+  target_link_options(tesseract_decoder PRIVATE
+    "-Wl,-exported_symbols_list,${TESSERACT_SRC_DIR}/tesseract_decoder.exports")
+elseif(UNIX)
+  target_link_options(tesseract_decoder PRIVATE "-Wl,--exclude-libs,ALL")
+endif()
 set_target_properties(tesseract_decoder PROPERTIES
     LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/src
     LIBRARY_OUTPUT_DIRECTORY_DEBUG ${PROJECT_SOURCE_DIR}/src

src/BUILD

@@ -105,6 +105,19 @@ pybind_extension(
         "tesseract.pybind.cc",
     ],
     copts = OPT_COPTS,
+    # Keep static-library symbols (notably HiGHS) private to this extension.
+    # Mach-O has no equivalent to ELF's --exclude-libs, so it needs an explicit
+    # export list; without it, highspy can see the linked HiGHS symbols.
+    additional_linker_inputs = ["tesseract_decoder.exports"],
+    linkopts = select({
+        "@platforms//os:osx": [
+            "-Wl,-exported_symbols_list,$(location :tesseract_decoder.exports)",
+        ],
+        # The ELF equivalent also hides symbols pulled from static archives.
+        "@platforms//os:linux": ["-Wl,--exclude-libs,ALL"],
+        # The default also covers Windows and non-ELF toolchains.
+        "//conditions:default": [],
+    }),
     deps = [
         ":tesseract_decoder_pybind",
     ],

src/common.cc

@@ -20,6 +20,8 @@
 #include <string>
 #include <vector>
 
+namespace {
+
 std::string vector_to_string(const std::vector<int>& vec) {
   std::stringstream ss;
   ss << "[";
@@ -34,6 +36,10 @@ std::string vector_to_string(const std::vector<int>& vec) {
   return ss.str();
 }
 
+}  // namespace
+
+namespace tesseract_decoder {
+
 std::string common::Symptom::str() const {
   std::string s = "Symptom{detectors=";
   s += vector_to_string(detectors);
@@ -255,3 +261,5 @@ stim::DetectorErrorModel common::dem_from_counts(const stim::DetectorErrorModel&
   }
   return out_dem;
 }
+
+}  // namespace tesseract_decoder

src/common.h

@@ -18,6 +18,7 @@
 
 #include "stim.h"
 
+namespace tesseract_decoder {
 namespace common {
 
 // Represents the effect of an error
@@ -113,5 +114,6 @@ stim::DetectorErrorModel dem_from_counts(const stim::DetectorErrorModel& orig_de
 double merge_weights(double a, double b);
 
 }  // namespace common
+}  // namespace tesseract_decoder
 
 #endif

src/common.pybind.h

@@ -26,6 +26,8 @@
 
 namespace py = pybind11;
 
+namespace tesseract_decoder {
+
 void add_common_module(py::module& root) {
   auto m = root.def_submodule("common", "classes commonly used by the decoder");
 
@@ -217,4 +219,6 @@ void add_common_module(py::module& root) {
       )pbdoc");
 }
 
+}  // namespace tesseract_decoder
+
 #endif

src/common.test.cc

@@ -17,6 +17,9 @@
 #include "gtest/gtest.h"
 #include "stim.h"
 
+namespace tesseract_decoder {
+namespace {
+
 TEST(common, ErrorsStructFromDemInstruction) {
   // Test a pathological DEM error instruction
   stim::DetectorErrorModel dem("error(0.1) D0 ^  D0 D1  L0 L1 L1");
@@ -194,3 +197,6 @@ TEST(CommonTest, merge_indistinguishable_errors_two_errors) {
   auto merged_dem4 = common::merge_indistinguishable_errors(dem4, error_index_map);
   ASSERT_NEAR(get_merged_probability(merged_dem4), expected_merged_p, 1e-9);
 }
+
+}  // namespace
+}  // namespace tesseract_decoder

src/simplex.cc

@@ -20,6 +20,8 @@
 #include "io/HMPSIO.h"
 #include "utils.h"
 
+namespace tesseract_decoder {
+
 constexpr size_t T_COORD = 2;
 
 std::string SimplexConfig::str() {
@@ -401,3 +403,5 @@ void SimplexDecoder::decode_shots(std::vector<stim::SparseShot>& shots,
 }
 
 SimplexDecoder::~SimplexDecoder() {}
+
+}  // namespace tesseract_decoder

src/simplex.h

@@ -24,6 +24,8 @@ struct HighsModel;
 struct Highs;
 enum class HighsStatus;
 
+namespace tesseract_decoder {
+
 struct SimplexConfig {
   stim::DetectorErrorModel dem;
   bool parallelize = false;
@@ -81,4 +83,6 @@ struct SimplexDecoder {
   void init_ilp();
 };
 
+}  // namespace tesseract_decoder
+
 #endif  // SIMPLEX_HPP

src/simplex.pybind.h

@@ -27,7 +27,9 @@
 
 namespace py = pybind11;
 
+namespace tesseract_decoder {
 namespace {
+
 // Helper function to compile the decoder.
 std::unique_ptr<SimplexDecoder> _compile_simplex_decoder_helper(const SimplexConfig& self) {
   return std::make_unique<SimplexDecoder>(self);
@@ -41,19 +43,27 @@ SimplexConfig simplex_config_maker(py::object dem, bool parallelize = false,
       {input_dem, parallelize, window_length, window_slide_length, verbose, merge_errors});
 }
 
-};  // namespace
+}  // namespace
 
 void add_simplex_module(py::module& root) {
   auto m =
       root.def_submodule("simplex", "Module containing the SimplexDecoder and related methods");
 
-  py::class_<SimplexConfig>(m, "SimplexConfig", R"pbdoc(
+  auto py_simplex_config = py::class_<SimplexConfig>(m, "SimplexConfig", R"pbdoc(
         Configuration object for the `SimplexDecoder`.
 
         This class holds all the parameters needed to initialize and configure a
         Simplex decoder instance, including the detector error model and
         decoding options.
-    )pbdoc")
+    )pbdoc");
+  auto py_simplex_decoder = py::class_<SimplexDecoder>(m, "SimplexDecoder", R"pbdoc(
+        A class that implements the Simplex decoding algorithm.
+
+        It can decode syndromes from a `stim.DetectorErrorModel` to predict
+        which observables have been flipped.
+    )pbdoc");
+
+  py_simplex_config
       .def(py::init(&simplex_config_maker), py::arg("dem"), py::arg("parallelize") = false,
            py::arg("window_length") = 0, py::arg("window_slide_length") = 0,
            py::arg("verbose") = false, py::arg("merge_errors") = true, R"pbdoc(
@@ -101,12 +111,7 @@ void add_simplex_module(py::module& root) {
                 settings.
            )pbdoc");
 
-  py::class_<SimplexDecoder>(m, "SimplexDecoder", R"pbdoc(
-        A class that implements the Simplex decoding algorithm.
-
-        It can decode syndromes from a `stim.DetectorErrorModel` to predict
-        which observables have been flipped.
-    )pbdoc")
+  py_simplex_decoder
       .def(py::init<SimplexConfig>(), py::arg("config"), R"pbdoc(
         The constructor for the `SimplexDecoder` class.
 
@@ -351,4 +356,7 @@ void add_simplex_module(py::module& root) {
             (num_shots, num_observables).
     )pbdoc");
 }
+
+}  // namespace tesseract_decoder
+
 #endif

src/simplex_main.cc

@@ -24,6 +24,8 @@
 #include "stim.h"
 #include "utils.h"
 
+using namespace tesseract_decoder;
+
 struct Args {
   std::string circuit_path;
   std::string dem_path;