Update API name: decode_multi to decode_batch (#102)

Signed-off-by: Melody Ren <[email protected]>

Author: melody-ren

docs/sphinx/components/qec/introduction.rst

@@ -500,7 +500,7 @@ The decoder base class defines the core interface for syndrome decoding:
         virtual decoder_result decode(
             const std::vector<float_t>& syndrome) = 0;
 
-        virtual std::vector<decoder_result> decode_multi(
+        virtual std::vector<decoder_result> decode_batch(
             const std::vector<std::vector<float_t>>& syndrome);
     };
 

libs/qec/include/cudaq/qec/decoder.h

@@ -126,7 +126,7 @@ class decoder
   /// @returns 2-D vector of size `N` x `block_size` with soft probabilities of
   /// errors in each index.
   virtual std::vector<decoder_result>
-  decode_multi(const std::vector<std::vector<float_t>> &syndrome);
+  decode_batch(const std::vector<std::vector<float_t>> &syndrome);
 
   /// @brief This `get` overload supports default values.
   static std::unique_ptr<decoder>

libs/qec/lib/decoder.cpp

@@ -46,7 +46,7 @@ decoder_result decoder::decode(const cudaqx::tensor<uint8_t> &syndrome) {
 // Provide a trivial implementation of the multi-syndrome decoder. Child classes
 // should override this if they can do it more efficiently than this.
 std::vector<decoder_result>
-decoder::decode_multi(const std::vector<std::vector<float_t>> &syndrome) {
+decoder::decode_batch(const std::vector<std::vector<float_t>> &syndrome) {
   std::vector<decoder_result> result;
   result.reserve(syndrome.size());
   for (auto &s : syndrome)

libs/qec/python/bindings/py_decoder.cpp

@@ -157,10 +157,10 @@ void bindDecoder(py::module &mod) {
           },
           "Asynchronously decode the given syndrome", py::arg("syndrome"))
       .def(
-          "decode_multi",
+          "decode_batch",
           [](decoder &decoder,
              const std::vector<std::vector<float_t>> &syndrome) {
-            return decoder.decode_multi(syndrome);
+            return decoder.decode_batch(syndrome);
           },
           "Decode multiple syndromes and return the results",
           py::arg("syndrome"))

libs/qec/python/tests/test_decoder.py

@@ -30,9 +30,9 @@ def test_decoder_initialization():
 
 
 def test_decoder_api():
-    # Test decode_multi
+    # Test decode_batch
     decoder = qec.get_decoder('example_byod', H)
-    result = decoder.decode_multi(
+    result = decoder.decode_batch(
         [create_test_syndrome(), create_test_syndrome()])
     assert len(result) == 2
     for r in result:

libs/qec/unittests/test_decoders.cpp

@@ -87,7 +87,7 @@ TEST(SampleDecoder, checkAPI) {
   // Test the move constructor and move assignment operator
 
   // Multi test
-  auto dec_results = d->decode_multi({syndromes, syndromes});
+  auto dec_results = d->decode_batch({syndromes, syndromes});
   ASSERT_EQ(dec_results.size(), 2);
   for (auto &m : dec_results)
     for (auto x : m.result)