Finish CQiree interface and test

Author: sethrj

src/cqiree/CQiree.cc

@@ -78,6 +78,8 @@ qiree_max_result_items(CQiree* manager, int num_shots, size_t* result)
 {
     if (!manager)
         return QIREE_NOT_READY;
+    if (!result)
+        return QIREE_INVALID_INPUT;
 
     auto* cpp_manager = reinterpret_cast<QM*>(manager);
     return static_cast<QireeReturnCode>(
@@ -113,8 +115,8 @@ QireeReturnCode qiree_execute(CQiree* manager, int num_shots)
 }
 
 QireeReturnCode qiree_save_result_items(CQiree* manager,
-                                        size_t max_items,
-                                        CQireeResultRecord* encoded)
+                                        CQireeResultRecord* encoded,
+                                        size_t max_items)
 {
     if (!manager)
         return QIREE_NOT_READY;
@@ -126,7 +128,7 @@ QireeReturnCode qiree_save_result_items(CQiree* manager,
     auto* cpp_manager = reinterpret_cast<QM*>(manager);
     auto* encoded_tuples = reinterpret_cast<QM::ResultRecord*>(encoded);
     return static_cast<QireeReturnCode>(
-        cpp_manager->save_result_items(max_items, encoded_tuples));
+        cpp_manager->save_result_items(encoded_tuples, max_items));
 }
 
 void qiree_destroy(CQiree* manager)

src/cqiree/CQiree.h

@@ -49,7 +49,7 @@ qiree_load_module_from_file(CQiree* manager, char const* filename);
 QireeReturnCode qiree_num_quantum_reg(CQiree* manager, int* result);
 QireeReturnCode qiree_num_classical_reg(CQiree* manager, int* result);
 
-/* Amount of memory needed to store result (bytes) */
+/* Number of records needed to store result, including capacity */
 QireeReturnCode
 qiree_max_result_items(CQiree* manager, int num_shots, size_t* result);
 
@@ -76,8 +76,8 @@ QireeReturnCode qiree_execute(CQiree* manager, int num_shots);
  * - 10: number of samples
  */
 QireeReturnCode qiree_save_result_items(CQiree* manager,
-                                        size_t max_items,
-                                        CQireeResultRecord* encoded);
+                                        CQireeResultRecord* encoded,
+                                        size_t encoded_size);
 
 /* Cleanly destroy a QireeManager instance */
 void qiree_destroy(CQiree* manager);

src/cqiree/QireeManager.cc

@@ -33,8 +33,8 @@
 namespace qiree
 {
 //---------------------------------------------------------------------------//
-QireeManager::QireeManager() = default;
-QireeManager::~QireeManager() = default;
+QireeManager::QireeManager() throw() = default;
+QireeManager::~QireeManager() throw() = default;
 
 //---------------------------------------------------------------------------//
 QireeManager::ReturnCode
@@ -127,6 +127,9 @@ QireeManager::max_result_items(int num_shots, std::size_t& result) const
     auto num_registers = attrs.required_num_results;
     result = std::min<std::size_t>(1 << num_registers, num_shots);
 
+    // Add one for the "count" record at the beginning
+    result++;
+
     return ReturnCode::success;
 }
 
@@ -202,9 +205,9 @@ QireeManager::setup_executor(std::string_view backend,
 //---------------------------------------------------------------------------//
 QireeManager::ReturnCode QireeManager::execute(int num_shots) throw()
 {
-    if (execute_)
+    if (!execute_)
     {
-        CQIREE_FAIL(not_ready, "cannot create executor again");
+        CQIREE_FAIL(not_ready, "setup_executor was not created");
     }
 
     if (num_shots <= 0)
@@ -231,17 +234,20 @@ QireeManager::ReturnCode QireeManager::execute(int num_shots) throw()
 }
 //---------------------------------------------------------------------------//
 QireeManager::ReturnCode
-QireeManager::save_result_items(std::size_t num_items,
-                                ResultRecord* encoded) throw()
+QireeManager::save_result_items(ResultRecord* encoded,
+                                std::size_t max_count) throw()
 {
     if (!result_)
     {
         CQIREE_FAIL(not_ready, "execute has not been called");
     }
 
-    if (num_items < result_->size())
+    if (max_count < result_->size() + 1)
     {
-        CQIREE_FAIL(fail_load, "insufficient capacity for result items");
+        CQIREE_FAIL(fail_load,
+                    "insufficient capacity " << max_count
+                                             << " for result items: need "
+                                             << result_->size() + 1);
     }
 
     try

src/cqiree/QireeManager.hh

@@ -43,8 +43,8 @@ class QireeManager
     using ResultRecord = std::array<std::uint64_t, 2>;
 
   public:
-    QireeManager();
-    ~QireeManager();
+    QireeManager() throw();
+    ~QireeManager() throw();
 
     ReturnCode load_module(std::string_view data_contents) throw();
     ReturnCode load_module(std::string filename) throw();
@@ -59,7 +59,7 @@ class QireeManager
     ReturnCode execute(int num_shots) throw();
 
     ReturnCode
-    save_result_items(std::size_t num_items, ResultRecord* encoded) throw();
+    save_result_items(ResultRecord* encoded, std::size_t size) throw();
 
   private:
     std::unique_ptr<Module> module_;

test/CMakeLists.txt

@@ -4,9 +4,23 @@
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 #----------------------------------------------------------------------------#
 
+# Generate a file with configure-time paths
 file(TO_CMAKE_PATH "${PROJECT_SOURCE_DIR}" QIREE_SOURCE_DIR)
 configure_file(qiree_test_config.h.in qiree_test_config.h @ONLY)
 
+# Generate a file with generate-time paths
+file(
+  GENERATE 
+  OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/qiree_targets.h"
+  CONTENT [[
+#ifndef qiree_targets_h
+#define qiree_targets_h
+
+static char const cqiree_library_path[] = "$<TARGET_FILE:cqiree>";
+
+#endif /* qiree_targets_h */
+]])
+
 #---------------------------------------------------------------------------##
 # LIBRARY
 #---------------------------------------------------------------------------##
@@ -31,11 +45,14 @@ function(qiree_add_test ns name)
   add_executable(${_target}
     ${ns}/${name}.test.cc
   )
-  target_link_libraries(${_target}
-    QIREE::${ns}
+  set(_libs
     qiree_test_lib
     GTest::gtest_main
   )
+  if(NOT ns STREQUAL "cqiree")
+    list(APPEND _libs QIREE::${ns})
+  endif()
+  target_link_libraries(${_target} ${_libs})
   add_test(NAME test/${ns}/${name} COMMAND "$<TARGET_FILE:${_target}>")
 endfunction()
 
@@ -47,6 +64,13 @@ qiree_add_test(qiree Executor)
 qiree_add_test(qiree Module)
 qiree_add_test(qiree ResultDistribution)
 
+#---------------------------------------------------------------------------##
+# CQIREE TESTS
+#---------------------------------------------------------------------------##
+
+qiree_add_test(cqiree cqiree)
+add_dependencies(cqiree_cqireeTest cqiree)
+
 #---------------------------------------------------------------------------##
 # QIRXACC TESTS
 #---------------------------------------------------------------------------##
@@ -55,8 +79,6 @@ if(QIREE_USE_XACC)
   qiree_add_test(qirxacc XaccQuantum)
 endif()
 
-#---------------------------------------------------------------------------##
-
 #---------------------------------------------------------------------------##
 # QIRQSIM TESTS
 #---------------------------------------------------------------------------##