Add .close method to release the resource manually

metab0t · metab0t · commit fd502c8f0ba1 · 2025-03-19T13:47:23.000+08:00
diff --git a/include/pyoptinterface/copt_model.hpp b/include/pyoptinterface/copt_model.hpp
@@ -124,6 +124,8 @@ class COPTEnv
 	COPTEnv(COPTEnvConfig &config);
 	~COPTEnv();
 
+	void close();
+
   private:
 	copt_env *m_env;
 
@@ -166,6 +168,7 @@ class COPTModel
 	COPTModel() = default;
 	COPTModel(const COPTEnv &env);
 	void init(const COPTEnv &env);
+	void close();
 
 	void write(const std::string &filename);
 
diff --git a/include/pyoptinterface/gurobi_model.hpp b/include/pyoptinterface/gurobi_model.hpp
@@ -94,11 +94,12 @@ class GurobiEnv
 	void set_raw_parameter_string(const char *param_name, const char *value);
 
 	void start();
+	void close();
 
 	void check_error(int error);
 
   private:
-	GRBenv *m_env;
+	GRBenv *m_env = nullptr;
 
 	friend class GurobiModel;
 };
@@ -137,6 +138,7 @@ class GurobiModel
 	GurobiModel() = default;
 	GurobiModel(const GurobiEnv &env);
 	void init(const GurobiEnv &env);
+	void close();
 
 	void write(const std::string &filename);
 
diff --git a/include/pyoptinterface/highs_model.hpp b/include/pyoptinterface/highs_model.hpp
@@ -110,6 +110,7 @@ class POIHighsModel
   public:
 	POIHighsModel();
 	void init();
+	void close();
 
 	void write(const std::string &filename);
 
diff --git a/include/pyoptinterface/ipopt_model.hpp b/include/pyoptinterface/ipopt_model.hpp
@@ -45,6 +45,7 @@ struct IpoptModel
 {
 	/* Methods */
 	IpoptModel();
+	void close();
 
 	VariableIndex add_variable(double lb = -INFINITY, double ub = INFINITY, double start = 0.0,
 	                           const char *name = nullptr);
diff --git a/include/pyoptinterface/mosek_model.hpp b/include/pyoptinterface/mosek_model.hpp
@@ -103,6 +103,7 @@ class MOSEKEnv
   public:
 	MOSEKEnv();
 	~MOSEKEnv();
+	void close();
 
 	void putlicensecode(const std::vector<MSKint32t> &code);
 
@@ -126,6 +127,7 @@ class MOSEKModel
 	MOSEKModel() = default;
 	MOSEKModel(const MOSEKEnv &env);
 	void init(const MOSEKEnv &env);
+	void close();
 
 	void write(const std::string &filename);
 
diff --git a/lib/copt_model.cpp b/lib/copt_model.cpp
@@ -143,6 +143,11 @@ void COPTModel::init(const COPTEnv &env)
 	m_model = std::unique_ptr<copt_prob, COPTfreemodelT>(model);
 }
 
+void COPTModel::close()
+{
+	m_model.reset();
+}
+
 void COPTModel::write(const std::string &filename)
 {
 	int error;
@@ -1021,6 +1026,15 @@ COPTEnv::~COPTEnv()
 	check_error(error);
 }
 
+void COPTEnv::close()
+{
+	if (m_env != nullptr)
+	{
+		copt::COPT_DeleteEnv(&m_env);
+	}
+	m_env = nullptr;
+}
+
 COPTEnvConfig::COPTEnvConfig()
 {
 	if (!copt::is_library_loaded())
diff --git a/lib/copt_model_ext.cpp b/lib/copt_model_ext.cpp
@@ -20,7 +20,10 @@ NB_MODULE(copt_model_ext, m)
 
 	nb::class_<COPTEnvConfig>(m, "EnvConfig").def(nb::init<>()).def("set", &COPTEnvConfig::set);
 
-	nb::class_<COPTEnv>(m, "Env").def(nb::init<>()).def(nb::init<COPTEnvConfig &>());
+	nb::class_<COPTEnv>(m, "Env")
+	    .def(nb::init<>())
+	    .def(nb::init<COPTEnvConfig &>())
+	    .def("close", &COPTEnv::close);
 
 	nb::class_<COPTModel>(m, "_RawModelBase");
 
@@ -31,6 +34,7 @@ NB_MODULE(copt_model_ext, m)
 	    // clang-format off
 	    BIND_F(init)
 	    BIND_F(write)
+	    BIND_F(close)
 	    // clang-format on
 
 	    .def("add_variable", &COPTModelMixin::add_variable,
diff --git a/lib/gurobi_model.cpp b/lib/gurobi_model.cpp
@@ -180,6 +180,11 @@ void GurobiModel::init(const GurobiEnv &env)
 	m_model = std::unique_ptr<GRBmodel, GRBfreemodelT>(model);
 }
 
+void GurobiModel::close()
+{
+	m_model.reset();
+}
+
 void GurobiModel::write(const std::string &filename)
 {
 	int error = gurobi::GRBwrite(m_model.get(), filename.c_str());
@@ -1069,7 +1074,7 @@ GurobiEnv::GurobiEnv(bool empty)
 
 GurobiEnv::~GurobiEnv()
 {
-	gurobi::GRBfreeenv(m_env);
+	close();
 }
 
 int GurobiEnv::raw_parameter_type(const char *param_name)
@@ -1101,6 +1106,15 @@ void GurobiEnv::start()
 	check_error(error);
 }
 
+void GurobiEnv::close()
+{
+	if (m_env != nullptr)
+	{
+		gurobi::GRBfreeenv(m_env);
+	}
+	m_env = nullptr;
+}
+
 void GurobiEnv::check_error(int error)
 {
 	if (error)
diff --git a/lib/gurobi_model_ext.cpp b/lib/gurobi_model_ext.cpp
@@ -23,6 +23,7 @@ NB_MODULE(gurobi_model_ext, m)
 	    .def(nb::init<bool>(), nb::arg("empty") = false)
 	    // clang-format off
 		BIND_F(start)
+		BIND_F(close)
 		BIND_F(raw_parameter_type)
 		BIND_F(set_raw_parameter_int)
 		BIND_F(set_raw_parameter_double)
@@ -39,6 +40,7 @@ NB_MODULE(gurobi_model_ext, m)
 	    .def(nb::init<const GurobiEnv &>())
 	    // clang-format off
 		BIND_F(init)
+		BIND_F(close)
 		BIND_F(write)
 	    // clang-format on
 
diff --git a/lib/highs_model.cpp b/lib/highs_model.cpp
@@ -114,6 +114,11 @@ void POIHighsModel::init()
 	m_model = std::unique_ptr<void, HighsfreemodelT>(model);
 }
 
+void POIHighsModel::close()
+{
+	m_model.reset();
+}
+
 void POIHighsModel::write(const std::string &filename)
 {
 	auto error = highs::Highs_writeModel(m_model.get(), filename.c_str());
diff --git a/lib/highs_model_ext.cpp b/lib/highs_model_ext.cpp
@@ -40,6 +40,7 @@ NB_MODULE(highs_model_ext, m)
 	    // clang-format off
 	    BIND_F(init)
 	    BIND_F(write)
+	    BIND_F(close)
 	    // clang-format on
 
 	    .def_ro("solution", &HighsModelMixin::m_solution)
diff --git a/lib/ipopt_model.cpp b/lib/ipopt_model.cpp
@@ -62,6 +62,11 @@ IpoptModel::IpoptModel()
 	}
 }
 
+void IpoptModel::close()
+{
+	m_problem.reset();
+}
+
 VariableIndex IpoptModel::add_variable(double lb, double ub, double start, const char *name)
 {
 	VariableIndex vi(n_variables);
diff --git a/lib/ipopt_model_ext.cpp b/lib/ipopt_model_ext.cpp
@@ -42,6 +42,7 @@ NB_MODULE(ipopt_model_ext, m)
 
 	nb::class_<IpoptModelMixin>(m, "RawModel")
 	    .def(nb::init<>())
+	    .def("close", &IpoptModelMixin::close)
 	    .def_ro("m_status", &IpoptModelMixin::m_status)
 	    .def("add_variable", &IpoptModelMixin::add_variable, nb::arg("lb") = -INFINITY,
 	         nb::arg("ub") = INFINITY, nb::arg("start") = 0.0, nb::arg("name") = "")
diff --git a/lib/mosek_model.cpp b/lib/mosek_model.cpp
@@ -176,6 +176,11 @@ void MOSEKModel::init(const MOSEKEnv &env)
 	m_model = std::unique_ptr<MSKtask, MOSEKfreemodelT>(model);
 }
 
+void MOSEKModel::close()
+{
+	m_model.reset();
+}
+
 void MOSEKModel::write(const std::string &filename)
 {
 	bool is_solution = false;
@@ -1427,6 +1432,15 @@ MOSEKEnv::~MOSEKEnv()
 	check_error(error);
 }
 
+void MOSEKEnv::close()
+{
+	if (m_env != nullptr)
+	{
+		mosek::MSK_deleteenv(&m_env);
+	}
+	m_env = nullptr;
+}
+
 void MOSEKEnv::putlicensecode(const std::vector<MSKint32t> &code)
 {
 	auto error = mosek::MSK_putlicensecode(m_env, code.data());
diff --git a/lib/mosek_model_ext.cpp b/lib/mosek_model_ext.cpp
@@ -19,6 +19,7 @@ NB_MODULE(mosek_model_ext, m)
 
 	nb::class_<MOSEKEnv>(m, "Env")
 	    .def(nb::init<>())
+	    .def("close", &MOSEKEnv::close)
 	    .def("putlicensecode", &MOSEKEnv::putlicensecode);
 
 	nb::class_<MOSEKModel>(m, "_RawModelBase");
@@ -30,6 +31,7 @@ NB_MODULE(mosek_model_ext, m)
 	    // clang-format off
 	    BIND_F(init)
 	    BIND_F(write)
+	    BIND_F(close)
 	    // clang-format on
 
 	    .def("add_variable", &MOSEKModelMixin::add_variable,
diff --git a/tests/test_close.py b/tests/test_close.py
@@ -0,0 +1,22 @@
+from pyoptinterface import gurobi, copt, mosek
+
+envs = []
+models = []
+if gurobi.is_library_loaded():
+    envs.append(gurobi.Env)
+    models.append(gurobi.Model)
+if copt.is_library_loaded():
+    envs.append(copt.Env)
+    models.append(copt.Model)
+if mosek.is_library_loaded():
+    envs.append(mosek.Env)
+    models.append(mosek.Model)
+
+
+def test_close():
+    for env, model in zip(envs, models):
+        env_instance = env()
+        model_instance = model(env_instance)
+
+        model_instance.close()
+        env_instance.close()

Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,7 @@ struct IpoptModel`
`45`	`45`	`{`
`46`	`46`	`/* Methods */`
`47`	`47`	`IpoptModel();`
	`48`	`+ void close();`
`48`	`49`
`49`	`50`	`VariableIndex add_variable(double lb = -INFINITY, double ub = INFINITY, double start = 0.0,`
`50`	`51`	`const char *name = nullptr);`
Original file line number	Diff line number	Diff line change
`@@ -180,6 +180,11 @@ void GurobiModel::init(const GurobiEnv &env)`
`180`	`180`	`m_model = std::unique_ptr<GRBmodel, GRBfreemodelT>(model);`
`181`	`181`	`}`
`182`	`182`
	`183`	`+void GurobiModel::close()`
	`184`	`+{`
	`185`	`+ m_model.reset();`
	`186`	`+}`
	`187`	`+`
`183`	`188`	`void GurobiModel::write(const std::string &filename)`
`184`	`189`	`{`
`185`	`190`	`int error = gurobi::GRBwrite(m_model.get(), filename.c_str());`
`@@ -1069,7 +1074,7 @@ GurobiEnv::GurobiEnv(bool empty)`
`1069`	`1074`
`1070`	`1075`	`GurobiEnv::~GurobiEnv()`
`1071`	`1076`	`{`
`1072`		`- gurobi::GRBfreeenv(m_env);`
	`1077`	`+ close();`
`1073`	`1078`	`}`
`1074`	`1079`
`1075`	`1080`	`int GurobiEnv::raw_parameter_type(const char *param_name)`
`@@ -1101,6 +1106,15 @@ void GurobiEnv::start()`
`1101`	`1106`	`check_error(error);`
`1102`	`1107`	`}`
`1103`	`1108`
	`1109`	`+void GurobiEnv::close()`
	`1110`	`+{`
	`1111`	`+ if (m_env != nullptr)`
	`1112`	`+ {`
	`1113`	`+ gurobi::GRBfreeenv(m_env);`
	`1114`	`+ }`
	`1115`	`+ m_env = nullptr;`
	`1116`	`+}`
	`1117`	`+`
`1104`	`1118`	`void GurobiEnv::check_error(int error)`
`1105`	`1119`	`{`
`1106`	`1120`	`if (error)`
Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,11 @@ void POIHighsModel::init()`
`114`	`114`	`m_model = std::unique_ptr<void, HighsfreemodelT>(model);`
`115`	`115`	`}`
`116`	`116`
	`117`	`+void POIHighsModel::close()`
	`118`	`+{`
	`119`	`+ m_model.reset();`
	`120`	`+}`
	`121`	`+`
`117`	`122`	`void POIHighsModel::write(const std::string &filename)`
`118`	`123`	`{`
`119`	`124`	`auto error = highs::Highs_writeModel(m_model.get(), filename.c_str());`