Merge pull request #179 from Argonne-National-Laboratory/kk/version

Implemented functions to query versions
Argonne-National-Laboratory · Dec 11, 2020 · 97c8863 · 97c8863
2 parents 448b4fc + 6834ee5
commit 97c8863
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 1 deletion.
diff --git a/src/DspApiEnv.h b/src/DspApiEnv.h
@@ -8,6 +8,7 @@
 #ifndef DSPAPIENV_H_
 #define DSPAPIENV_H_
 
+#include "DspConfig.h"
 #include "Solver/DecSolver.h"
 #include "Model/DecModel.h"
 #include "Utility/DspParams.h"
@@ -25,6 +26,15 @@ class DspApiEnv
 	/** A default destructore */
 	virtual ~DspApiEnv();
 
+	/** Query DSP version major */
+	int getVersionMajor() { return DSP_VERSION_MAJOR; }
+
+	/** Query DSP version minor */
+	int getVersionMinor() { return DSP_VERSION_MINOR; }
+
+	/** Query DSP version patch */
+	int getVersionPatch() { return DSP_VERSION_PATCH; }
+
 	DecSolver * solver_;   /**< A decomposition solver object */
 	DecModel * model_;     /**< A decomposition model object */
 	DspParams * par_;      /**< A parameters object */

diff --git a/src/DspCInterface.cpp b/src/DspCInterface.cpp
@@ -671,6 +671,21 @@ void printModel(DspApiEnv * env)
 	env->model_->__printData();
 }
 
+int getVersionMajor(DspApiEnv *env)
+{
+	return env->getVersionMajor();
+}
+
+int getVersionMinor(DspApiEnv *env)
+{
+	return env->getVersionMinor();
+}
+
+int getVersionPatch(DspApiEnv *env)
+{
+	return env->getVersionPatch();
+}
+
 #undef DSP_API_CHECK_MODEL
 #undef DSP_API_CHECK_ENV
 

diff --git a/src/DspCInterface.h b/src/DspCInterface.h
@@ -15,6 +15,7 @@
 #include "Utility/DspMpi.h"
 
 /** DSP */
+#include "DspConfig.h"
 #include "DspApiEnv.h"
 
 class TssModel;
@@ -242,6 +243,15 @@ void writeMps(DspApiEnv * env, const char * name);
 /** print model */
 void printModel(DspApiEnv *env);
 
+/** query the DSP version major */
+int getVersionMajor(DspApiEnv *env);
+
+/** query the DSP version minor */
+int getVersionMinor(DspApiEnv *env);
+
+/** query the DSP version patch */
+int getVersionPatch(DspApiEnv *env);
+
 #ifdef __cplusplus
 }
 #endif

diff --git a/src/DspConfig.h b/src/DspConfig.h
@@ -6,7 +6,7 @@
  */
 #define DSP_VERSION_MAJOR 1
 #define DSP_VERSION_MINOR 4
-#define DSP_VERSION_PATCH 0
+#define DSP_VERSION_PATCH 1
 
 #include <stdio.h>
 

diff --git a/src/test/src/tests-DspCInterface.cpp b/src/test/src/tests-DspCInterface.cpp
@@ -13,6 +13,17 @@ TEST_CASE("C interface functions") {
         REQUIRE(env->solver_ == NULL);
     }
 
+    SECTION("Version checks")
+    {
+        int major = getVersionMajor(env);
+        int minor = getVersionMinor(env);
+        int patch = getVersionPatch(env);
+
+        REQUIRE(major == DSP_VERSION_MAJOR);
+        REQUIRE(minor == DSP_VERSION_MINOR);
+        REQUIRE(patch == DSP_VERSION_PATCH);
+    }
+
     SECTION("freeEnv function") {
         freeEnv(env);
         REQUIRE(env == NULL);