求解器用户手册

命令行调用示例：

Linux以及macOS下，假设用户根据安装文档将MindOpt安装到环境变量$MINDOPT_HOME指定目录：

mindopt $MINDOPT_HOME/examples/data/afiro.mps

Windows下

mindopt %MINDOPT_HOME%\examples\data\afiro.mps

C/C++/C#/Java/Python/MATLAB语言调用示例：

V1.x.x

env = mindoptpy.Env()
env.start()
model = mindoptpy.read(filename, env)
model.optimize()
print(f"Optimal objective value is: {model.objval}")
for v in x:
    print(f"{v.VarName} = {v.X}")

MDOEnv env = new MDOEnv();
MDOModel model = new MDOModel(env, filename);
model.optimize();
System.out.println("Optimal objective value is: " + model.get(MDO.DoubleAttr.ObjVal));
MDOVar[] x = model.getVars();
for (int i = 0; i < x.length; ++i) {
    System.out.println(x[i].get(MDO.StringAttr.VarName) + " = " + x[i].get(MDO.DoubleAttr.X));
}

MDOEnv env = MDOEnv();
MDOModel model = MDOModel(env, filename);
model.optimize();
std::cout << "Optimal objective value is: " << model.get(MDO_DoubleAttr_ObjVal) << std::endl;
std::vector<MDOVar> vars = model.getVars();
for (auto v : vars) {
    std::cout << v.get(MDO_StringAttr_VarName) << " = " << v.get(MDO_DoubleAttr_X) << std::endl;
}

MDOenv* env;
MDOemptyenv(&env);
MDOstartenv(env);
MDOmodel* model;
double obj;

MDOreadmodel(env, argv[1], filename);
MDOoptimize(model);
MDOgetdblattr(model, MDO_DBL_ATTR_OBJ_VAL, &obj);
printf("Optimal objective value is: %f\n", obj);

/* Free the environment. */
MDOfreemodel(model);
MDOfreeenv(env);

MDOEnv env = new MDOEnv();
MDOModel model =new MDOModel(env, filename);
model.optimize();
Console.WriteLine($"Optimal objective value is: {model.Get(MDO.DoubleAttr.ObjVal)}");
MDOVar[] vars = model.GetVars();
for (int i = 0; i < vars.Length; i++)
{
    Console.WriteLine($"{vars[i].Get(MDO.StringAttr.VarName)} = {vars[i].Get(MDO.DoubleAttr.X)}");
}

model = mindopt_read(file);
result = mindopt(model);

for v=1:length(result.X)
    fprintf('%s %d\n', model.varnames{v}, result.X(v));
end
fprintf('Optimal objective value is: %e\n', result.ObjVal);

objval = result.ObjVal;

完整例子的代码请查看更多。

V0.x.x

# 方法1：从0.19.0版本开始引入新式的创建模型方式，云鉴权更快，消耗的并发度少
env = mindoptpy.MdoEnv()
model = mindoptpy.MdoModel(env)
model.read_prob(filename)
model.solve_prob()
model.display_results()

# 方法2：旧式的创建模型方式仍然支持
# model = mindoptpy.MdoModel()
# model.read_prob(filename)
# model.solve_prob()
# model.display_results()

//<dependency>
//    <groupId>com.alibaba.damo</groupId>
//    <artifactId>mindoptj</artifactId>
//    <version>[0.20.0,)</version>
//</dependency>
// load动态链接库，如下：
Mdo.load("c:\\mindopt\\0.20.0\\win64_x86\\lib\\mindopt_0_20_0.dll");

// 方法1：从0.19.0版本开始引入新式的创建模型方式，云鉴权更快，消耗的并发度少
//Set up environment，放在程序初始化的时候进行，例如MapReduce里的setup阶段
MdoEnv env = new MdoEnv();
//create a model
MdoModel model = env.createModel();
model.readProb(filename)
model.solveProb();
model.displayResult();
model.free();
//JAVA SDK 需要手动释放 env，放在程序结束的时候进行，例如MapReduce里的cleanup阶段
env.free();

// 方法2：旧式的创建模型方式仍然支持，但被标记为过时，将在以后的版本中移除
/*
MdoModel model = new MdoModel();
model.readProb(filename)
model.solveProb();
model.displayResult();
*/

// 方法1：从0.19.0版本开始引入新式的创建模型方式，云鉴权更快，消耗的并发度少
using mindopt::MdoEnv;
MdoEnv env;
MdoModel model(env);
model.readProb(filename);
model.solveProb();
model.displayResults();

// 方法2：旧式的创建模型方式仍然支持
/*
MdoModel model;
model.readProb(filename);
model.solveProb();
model.displayResults();
*/

// 方法1：从0.19.0版本开始引入新式的创建模型方式，云鉴权更快，消耗的并发度少
MdoEnvPtr env;
MdoMdlPtr model;
Mdo_createEnv(&env);
Mdo_createMdlWithEnv(&model, env);
Mdo_readProb(model, filename);
Mdo_solveProb(model);
Mdo_displayResults(model);
Mdo_freeMdl(&model);
// C SDK 需要手动释放 env
Mdo_freeEnv(&env);

// 方法2：旧式的创建模型方式仍然支持
/*
MdoMdlPtr model;
Mdo_createMdl(&model);
Mdo_readProb(model, filename);
Mdo_solveProb(model);
Mdo_displayResults(model);
Mdo_freeMdl(&model);
*/

完整例子的代码请查看V0.x版本文档。

方式1：文件输入

• 支持 MPS 格式和 LP 格式，如 .mps和.lp，以及对应文件的压缩文件如：.mps.gz和 .mps.bz2。

• 支持.dat-s格式, 如SDP问题示例。

• 支持.qps格式，如QP问题数据。

• mindoptampl模块支持.nl格式文件输入，如在命令行中输入mindoptampl filename.nl。

更详细的介绍请查看更多。

方式2：建模APIs输入

V1.x.x

相关联的APIs有多种，支持按行输入数据。

• Python示例简述：

  • 用 mindoptpy.Model.modelsense = MDO.MINIMIZE 将目标函数设置为最小化；

  • 用 mindoptpy.Model.addVar() 来添加优化变量，并分别定义其下界、上界、目标系数、名称和类型；

  • 用 mindoptpy.Model.addConstrs() 来添加约束。

更详细的介绍请查看更多。其中，属性描述（Attributes）列表见更多，且API章节有对应语言的完整例子。

V0.x.x

相关联的APIs有多种，同一个数据也可以有多种输入方式。

• 按行输入Python示例简述：

  • 用 mindoptpy.MdoModel.set_int_attr() 将目标函数设置为最小化；

  • 用 mindoptpy.MdoModel.add_var() 来添加四个优化变量，并分别定义其下界、上界、名称和类型；

  • 用 mindoptpy.MdoModel.add_cons() 来添加约束。

• 按列输入Python示例简述：

  • 用 mindoptpy.MdoModel.set_int_attr() 将目标函数设置为最小化；

  • 开始时调用 mindoptpy.MdoModel.add_cons() 来创建带有指定的左侧和右侧值的约束（无非零元素）；

  • 创建临时的列对象 mindoptpy.MdoCol() 来按顺序地保存约束和非零元素的值；

  • 最后调用 mindoptpy.MdoModel.add_var() 来创建新的变量，及其相应的目标函数系数、列向量中的非零元、下界和上界、变量名以及变量类型。

更详细的介绍请查看更多V0版文档。其中，模型的属性描述（Model Attributes）列表见更多V0版文档。

方式3：建模语言 MindOpt APL、 AMPL、Pyomo、PuLP、JuMP

MindOpt支持一些常见的建模工具，当前支持以下几种：

1. MindOpt APL

2022年开始支持MindOpt APL建模语言，是MindOpt团队自研的一款建模语言。

• 可免费在MindOpt云上建模求解平台通过浏览器使用建模语言和求解器，还包含案例，供快速入门。使用时，无需安装任何软件，打开浏览器即可使用。

• 语法文档见链接。

2. AMPL

使用 AMPL 调用 MindOpt 之前需要先安装 MindOpt 和 AMPL 。mindoptampl 应用位于安装包的\bin\mindoptampl。mindoptampl 提供了一些可配置的参数，用户可以通过 AMPL 的option命令设置 mindoptampl_options 参数，如：

ampl: option mindoptampl_options 'numthreads=4 maxtime=1e+4';

更详细的介绍和案例请查看更多。

3. Pyomo

使用 Pyomo 调用 MindOpt 之前需要先安装 MindOpt 和 Pyomo。调用 MindOpt 求解器的 Pyomo API 需要使用接口文件 mindopt_pyomo.py。 MindOpt 的 Pyomo 接口是继承自 Pyomo 的 DirectSolver 类，实现代码在安装包的\lib\pyomo\mindopt_pyomo.py。在 Python 代码中导入该文件：

from mindopt_pyomo import MindoDirect

更详细的介绍和案例请查看更多。

4. PuLP

使用 PuLP 调用 MindOpt 之前需要先安装 MindOpt 和 PuLP。调用 MindOpt 求解器的 PuLP API 需要使用接口文件 mindopt_pulp.py。 MindOpt 的 PuLP 接口继承自 PuLP 的 LpSolver 类，实现代码在安装包的\lib\pulp\mindopt_pulp.py。在 Python 代码中导入该文件：

from mindopt_pulp import MINDOPT

更详细的介绍和案例请查看更多。

5. JuMP

JuMP 是一个基于 Julia 编程语言的开源建模工具。使用 JuMP 调用 MindOpt 之前需要先安装 MindOpt、Julia、JuMP、AmplNLWriter。调用JuMP API来创建建模对象，并指定使用mindoptampl作为求解器。

model = Model(() -> AmplNLWriter.Optimizer(mindoptampl))

更详细的介绍和案例请查看更多。

计算设备配置参考：LP求解时不同算法特性

配置机器资源时候，不同问题结构、算法选择，耗费的机器资源会有差异，请根据需要测试选择。

关于LP求解，当前我们线性规划（LP）的求解提供了Simplex（单纯形法）、IPM（Interior Point Method，内点法）、Concurrent（并发优化）算法。在求解时候，执行流程如下文的“执行流程”图片所示，会默认选Concurrent，您可以通过设置“Method”参数来选择算法。

这3种算法的区别如下：

命令行运行

命令行运行求解时，会打印输出求解过程输出和结果的summary，同时会在求解的文件处生成同名结果文档.bas和.sol。

如下图示意运行mindopt afiro.mps后，文件夹中生成了afiro.bas和afiro.sol文件，.bas文件保存的是基，.sol文件保存的是求解的最优目标值和变量值的解。

API求解和获取结果

V1.x.x

待求解的问题输入后，可以调用optimize()的API来求解，如python的求解指令model.optimize()。

求解完后，可以调用API来获取结果，以Python为例：

• 可以调用model.status获取求解的状态。有UNKNOWN、OPTIMAL、INFEASIBLE、UNBOUNDED、INF_OR_UBD、SUB_OPTIMAL。如Python里的MDO.OPTIMAL

• 可以用model.objval获取目标值。

  • 还可以调用model.getAttr(MDO.Attr.PrimalObjVal)来获取其他的模型属性值，类似地：

    • SolutionTime对应：总执行时间（秒）

    • DualObjVal对应：对偶目标值

    • ColBasis对应：原始解的基

• 可以调用var.X来变量的解。

• 更多解的属性描述（Attributes）列表见更多。

完整的代码示例可参考安装包的example文件夹，或文档更多，和各个语言API文档最后一章，如Python的examples。

V0.x.x

待求解的问题输入后，可以调用solveProb的API来求解，如python的求解指令model.solve_prob()。

求解完后，可以调用API来获取结果，以Python为例：

• 可以调用model.display_results()来打印结果。

• 可以调用model.get_status()获取求解的状态。

• 可以调用model.get_real_attr("PrimalObjVal")来获取原始目标值，类似地：

  • "DualObjVal"对应：对偶目标值

  • "PrimalSoln"对应：原始解

  • "ColBasis"对应：原始解的基

  • 更多解的属性描述（Solution Attributes）列表在更多V0版本文档

完整的代码示例可参考安装包的example文件夹或文档。

约束不可行性分析

在建模求解过程中，会遇到由于某些约束互相冲突导致问题不可行（infeasible）的情况，分析不可行问题并识别出导致约束冲突的关键约束能有效帮助建模。这类导致问题不可行的最小约束子集被称为不可约不可行系统（IIS, irreduciable infeasible system）。

MindOpt 设计了用来计算IIS的API，当问题"INFEASIBLE"时，用户可以通过 compute IIS 的API来对不可行问题进行分析，如可依据此对IIS中的约束进行修正或移除，使得优化问题变得可行。

IIS的Python接口调用示例如下：

V1.x.x

if model.status == MDO.INFEASIBLE or model.status == MDO.INF_OR_UBD:
    idx_rows, idx_cols = model.compute_iis()

完整的 compute IIS 的说明请参阅更多。

V0.x.x

status_code, status_msg = model.get_status()
if status_msg == "INFEASIBLE":
    idx_rows, idx_cols = model.compute_iis()

完整的 compute IIS 的说明请参阅更多V0版文档。

MindOpt的执行流程：

不同的优化问题会有不同的求解方法，整体流程大致相同。以下是线性规划LP问题的调用示例，过程中有参数可以由用户选择设定。