C++用户的Cplex使用指南（一）——在VS2019中运行Cplex程序

C++用户的Cplex使用指南-1在VS2019中运行Cplex程序

前言

Cplex是IBM开发并仍在维护更新的商业求解器，也是目前使用人数最多的求解器，类似的还有Gurobi，两者各有各的特点（两家颇有渊源，感兴趣的可以了解一下）。

Cplex的一些基本概念

求解问题类型

• 线性规划问题（Linear Programming，LP）
• 网络流问题，是 LP 的一种特殊情况，CPLEX 可以通过利用问题结构以快得多的速度对其求解。
• 二次规划 (QP) 问题，其中 LP 目标函数扩展为包括二次项。
• 二次约束规划 (QCP) 问题，在约束中包括二次项。 实际上，CPLEX 可对二阶锥规划 (SOCP) 问题求解。
• 混合整数规划 (MIP) 问题，其中任意或所有 LP、QP 或 QCP 变量都进一步限制为采用最优解法中的整数值，并且 MIP 自身扩展为包括诸如特殊有序集合 (SOS) 和半连续变量之类的构造。

Cplex官方文档

Cplex没有系统的课程，互联网上的资料又鱼龙混杂，通过官方文档学习是最可靠的途径。Cplex的官方文档主要包括：

1. 《CPLEX 用户手册》说明 Interactive Optimizer 和 Component Library 之间的关系。 它详述使用 CPLEX 进行线性规划的各方面，并且说明如何处理二次规划 (QP) 问题、二次约束规划 (QCP) 问题、二阶锥规划 (SOCP)问题以及混合整数规划 (MIP) 问题。 它指示如何控制 CPLEX 参数，调试应用程序以及高效管理输入和输出。 它还说明如何使用并行CPLEX 优化器。
2. 《CPLEX Callable Library 参考手册》记录 Callable Library 例程及其参数。本手册还包含有关错误代码、解法质量和解法状态的其他文档。
3. 《CPLEX C++ API 参考手册》记录 Concert Technology 类、方法和函数的 C++ API。
4. 《CPLEX Java API 参考手册》提供 Concert Technology 接口和 CPLEX Java 类的详细定义。
5. 《CPLEX .NET 参考手册》记录 CPLEX 的 .NET API。
6. 《CPLEX Python API 参考手册》记录 CPLEX 的 Python API。
7. 《CPLEX 参数》参考手册包含可由参数例程修改的参数的文档。 它是 CPLEX 参数的用途和可允许设置的权威参考手册。
8. 《CPLEX 文件格式》参考手册包含 CPLEX 支持的文件格式列表以及有关在应用程序中使用这些文件格式的详细信息。
9. CPLEX Interactive Optimizer 参考手册包含 Interactive Optimizer命令，以及这些命令在《CPLEX 用户手册》中相关用例的命令选项和链接。
10. 为 MATLAB 的 CPLEX 接口提供了一整套文档，包括用户手册和语言参考手册。 可在 MATLAB会话中以交互方式使用或联机使用。
    尽管官方声称这些文档都可以通过网络下载，但实际上非常难找，或是只找得到较老的版本。

Visual Studio 2019中Cplex运行环境的配置

首先确保VS和IBM ILOG CPLEX Optimization Studio的正确安装。Cplex的安装包在官网有下载链接，但实际上很难下成功，建议通过其他途径找包。笔者常用C++，IDE是Visual studio community 2019，Cplex版本为IBM ILOG CPLEX Optimization Studio (64 bit) 12.8.0（目前最新版本为12.10，不建议采用最新版本，因为IDE可能还不兼容）。Cplex安装完后可以在安装目录的lib文件夹下看到x64_windows_vs2015和x64_windows_vs2017，因为VS版本较新，所以我们一般采用2017的文件。
安装完按照IBM的官方文档还需要配置环境变量，实际使用发现不配置也没关系。如果有发现存在配置环境变量需要的可以参考官方文档。

新建项目

按照正常方式在VS中新建一个项目。具体步骤如下：

1. 在VS2019中选择“文件-新建-项目- C++ -空项目”，然后在“名称”一栏自定义输入项目名称，比如"Cplex_TestCode"，再自定义项目文件的“位置”。
2. 在解决方案Cplex_TestCode的源文件夹下，新建一个cpp文件，起名为“TestCode.cpp”，并粘贴测试代码。
   这里采用 IBM官方文档中给的测试代码进行演示：

#include 
#include 
using namespace std;

ILOSTLBEGIN
int
main(void *) {
	IloEnv env;
	try {
	IloModel model(env);
	IloNumVarArray vars(env);
	vars.add(IloNumVar(env, 0.0, 40.0));  // 0 <= x1 <= 40
	vars.add(IloNumVar(env));  // 0 <= x2
	vars.add(IloNumVar(env));  // 0 <= x3
model.add(IloMaximize(env, vars[0] + 2 * vars[1] + 3 * vars[2])); //maximize x1 + 2 x2 + 3 x3
	model.add(-vars[0] + vars[1] + vars[2] <= 20);//subject to -x1 + x2 + x3 <= 20
	model.add(vars[0] - 3 * vars[1] + vars[2] <= 30);//x1 - 3 x2 + x3 <=30
IloCplex cplex(model);
		if (!cplex.solve()) {
			env.error() << "Failed to optimize LP." << endl;
			throw(-1);  }
		IloNumArray vals(env);
		env.out() << "Solution status = " << cplex.getStatus() << endl;
		env.out() << "Solution value = " << cplex.getObjValue() << endl;
		cplex.getValues(vals, vars);
		env.out() << "Values = " << vals << endl;
	}
	catch (IloException & e) { cerr << "Concert exception caught: " << e << endl; }
	catch (...) { cerr << "Unknown exception caught" << endl; }
	env.end();
system("pause");
	return 0;
}

此时程序还不能调试，先保存，进行下一步。

Cplex环境配置

首先用户需要知道Cplex的安装位置，一般来说默认安装位置为C:\Program Files\IBM\ILOG\CPLEX_Studio_128，下面将该位置简化为 ，视具体用户安装位置而定。

1. 将VS中的配置改为“Release”，活动平台改为“x64”。
2. 在解决方案资源管理器中右击项目并选择其属性，打开属性窗口，同时确保此时配置仍为“Release”，活动平台改为“x64”。
3. 属性页中，依次选择：“C/C++”—“常规”—“附加包含目录”，然后点开下拉选框，分别选择以下两个文件夹，也可以直接输入其位置,然后，选“确定”，再选“应用”。

\concert\include
\cplex\include

4. 属性页中，依次选择：“C/C++”—“预处理器”—“预处理器定义”，输入如下三个定义“NDEBUG”,"_CONSOLE",“IL_STD”，一行一个，注意下划线和大写（很多时候前两个已经有了，只要输入最后一个即可）。然后，选“确定”，再选“应用”。
5. 属性页中，依次选择：“c/c++” -“代码生成”-“运行库”，确认设置为“多线程 DLL (/MD)”。
6. 属性页中，依次选择：“链接器"-“常规”-“附加库目录”,选择或输入两个文件夹：

\concert\lib\x64_windows_vs2017\stat_mda
\cplex\lib\x64_windows_vs2017\stat_mda

7. 属性页中，依次选择：“链接器"-“输入”-“附加依赖项”，然后输入如下三个文件的路径，确认。

\cplex\lib\x64_windows_vs2017\stat_mda\cplex1280.lib
\cplex\lib\x64_windows_vs2017\stat_mda\ilocplex.lib
\concert\lib\x64_windows_vs2017\stat_mda\concert.lib

8. 一般到这Cplex环境就配置好了，但在实际使用中仍存在问题，比如遇到“意外的令牌”错误而无法运行，此时需要在属性页中，依次选择：“C/C++”-“语言”-“符合模式”，改成"否"。调试过程中若出现”warning LNK4099: 未找到 PDB“concert.pdb”的警告，事实上这个并不会影响程序的运行结果，我们可以将其屏蔽，处理办法为： 链接器—调试—“生成调试信息”选择“否”。
   至此，VS中的Cplex环境配置完成。

运行测试代码

调试运行测试代码。该代码求解线性规划问题如下：
$$\begin{gathered} min{x}_1+2x_2+3x_3 \\ -x_1+x_2+x_3\le 20 \\ {x}_1-3x_2+x_3\le 30 \\ 0\le x_1\le 40 \\ {x}_2\ge 0 \\ {x}_3\ge 0 \end{gathered}$$
运行结果如下：

至此，就能愉快地在VS中写Cplex的代码。

下回预告

随缘更新，准备结合Cplex自带的示例程序讲讲怎么用C++编写Cplex的求解程序。