Add Var::getVar

scipopt · Nov 8, 2024 · 71e7a59 · 71e7a59
1 parent bb9f30d
commit 71e7a59
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 1 deletion.
diff --git a/include/scippp/var.hpp b/include/scippp/var.hpp
@@ -15,8 +15,27 @@ struct Solution;
  * @since 1.0.0
  */
 struct Var {
-    //! Pointer to the underlying %SCIP variable.
+    /**
+     * Pointer to the underlying %SCIP variable.
+     * @deprecated since 1.3.0: Use #getVar() instead
+     */
     SCIP_Var* var { nullptr };
+
+    /**
+     * Pointer to the underlying %SCIP variable.
+     * @since 1.3.0
+     * @return underlying %SCIP variable.
+     */
+    [[nodiscard]] SCIP_Var* getVar();
+
+    /**
+     * Pointer to the underlying %SCIP variable.
+     *
+     * @since 1.3.0
+     * @return underlying %SCIP variable.
+     */
+    [[nodiscard]] const SCIP_Var* getVar() const;
+
     /**
      * Get the assigned value in the solution.
      * @since 1.0.0

diff --git a/source/var.cpp b/source/var.cpp
@@ -1,11 +1,22 @@
 #include "scippp/var.hpp"
 
 #include "scippp/solution.hpp"
+
 #include <scip/scip_numerics.h>
 #include <scip/scip_sol.h>
 
 namespace scippp {
 
+SCIP_Var* Var::getVar()
+{
+    return var;
+}
+
+const SCIP_Var* Var::getVar() const
+{
+    return var;
+}
+
 double Var::getSolVal(const Solution& sol) const
 {
     return SCIPgetSolVal(sol.scip, sol.sol, var);