Ceres Solver 在Windows下安装配置笔记

引子

因为项目需要用到Ceres Solver这个库实现非线性优化，这几天投入了很多时间来学习研究。没想到的是，这个库的安装就非常繁琐。官方的安装指南写的却过于简略。尤其是在Windows环境下，问题bug不断，很多坑。经过三天努力，今天终于成功hello world。高兴之余赶快趁机把安装过程记录下来，以便备忘。本文除了记录Ceres Solver的安装过程之外，还详细记录了gflags，glog，SuiteSpares的安装过程，尤其是一些配置选项。希望能对其他人有些许的帮助。

Ceres Solver是一个C++环境下的非线性最小二乘问题的求解工具包，可用来建模并解决大型复杂的非线性最小二乘问题。这个工具包已经广泛被用于很多商业软件中。在google project里面有它的主页： http://code.google.com/p/ceres-solver/。

环境

• Windows 10 Pro
• Visual Studio 2015
• Cmake GUI 3.10.2

安装前的准备

• Ceres-solver 1.13.0
  
  • 下载地址：https://ceres-solver.googlesource.com/ceres-solver/+/1.13.0
  • 点击【tgz】下载，下载后需要解压两层才能获得Ceres源代码。
• Eigen 3.3.4
  
  • 下载地址：http://eigen.tuxfamily.org/index.php?title=Main_Page
  • 著名的矩阵运算库。
• gflags 2.2.1
  
  • 下载地址：https://github.com/gflags/gflags
  • GFlags是Google开源的一个命令行flag（区别于参数）库。
• glog
  
  • 下载地址：https://github.com/google/glog
  • Google Glog是Google的一个开源库，用于实现应用级别的logging。 它提供了一系列类似于C++流风格的logging API，以及一些预定义的宏。它有点类似于C里面的assert，但是比它具备更丰富的输出信息以及使用灵活性。
  • 我用的是 2018年2月27日的commit版本。相比最新的release 0.3.5 （发布于2017年5月），此commit版去掉了已经生成VS的工程文件（.sln）。安装过程更可控。
• suitesparse-metis-for-windows Release 1.3.1
  
  • 下载地址：https://github.com/jlblancoc/suitesparse-metis-for-windows
  • 这个并不是必须安装的依赖库。但是如果装上将会提高Ceres对稀疏矩阵的计算性能，提供更多可用的优化算法。所以虽然加入这个库之后Ceres的安装过程会更加繁琐，但是仍然推荐安装。这个库的原生版本本身对Windows的支持不好，所以在Windows上要使用这个专门针对Windows的衍生版本。另外，这个库还存在一个名为CXSparse的简化版本。

建立一个文件夹，如C:\Ceres_Install，并在此文件夹内为每个依赖库建立一个子文件夹存放源代码。然后把所有源代码解压放到对应的子文件夹内。另外为每个库再建立一个按照”库名-build”命名的文件夹，盛放生成后的工程文件。

安装Eigen

Eigen库本身是并不需要安装的，解压放在某文件夹内即可。但是我更希望将他们这些库放在同一位置方便管理，如C:\Program Files。这样也方便其他库的定位。

启动CMake GUI。指定源代码位置为C:/Ceres_Install/eigen-eigen，输出位置为C:/Ceres_Install/eigen-build。编译平台根据系统环境选择“Visual Studio 14 2015 Win64”，下同。

配置选项中：
* 取消所有的Test类项。
* CMAKE_INSTALL_PREFIX = C:/Program Files/Eigen3

因为要安装目录位于C:/Program Files/，所以必须以管理员身份运行Visual Studio 2015，否则没有读写权限。然后打开C:/Ceres_Install/eigen-build/Eigen3.sln解决方案。分别以Debug和Release模式（x64）生成INSTALL项目以完成安装。

安装gflags

启动CMake GUI。指定源代码位置为C:/Ceres_Install/gflags，输出位置为C:/Ceres_Install/gflags-build。同样Configure->选择平台VS2015 x64->设置配置选项->Generate。

配置选项中：
* 取消选中BUILD_Testing
* CMAKE_INSTALL_PREFIX = C:/Program Files/gflags
* !!! 选中BUILD_SHARED_LIBS 以便生成.dll文件

以管理员身份运行Visual Studio 2015，打开刚生成的对应解决方案gflags.sln。分别以Debug和Release模式（x64）生成ALL_BUILD项目以编译生成二进制文件。然后分别以Debug和Release模式（x64）生成INSTALL项目以完成安装。

安装glog

同样的过程，使用CMake将glog的源代码生成为VS工程文件放入glog-build文件夹。同样也要注意CMake配置选项。

配置选项中：
* 取消选中BUILD_TESTING
* CMAKE_INSTALL_PREFIX = C:/Program Files/glog (如果用release 0.3.5 默认google-glog)
* 选中WITH_GFLAGS
* gflags_DIR = C:/Program Files/gflags/lib/cmake/gflags
* !!! 选中BUILD_SHARED_LIBS以便生成.dll文件。如果该项不存在通过“Add Entry”手动加入。

以管理员身份运行Visual Studio 2015，打开刚生成的对应解决方案glog.sln。分别以Debug和Release模式（x64）生成ALL_BUILD项目和INSTALL项目。

安装SuiteSparse (optional)

SuiteSparse 的安装就相对前两个库麻烦一点。
首先依然是cmake-configure-generate。

配置选项中：
* 取消选中BUILD_METIS，否则在编译METIS库是会发生很多莫名其妙的错误。
* 取消选中HAVE_COMPLEX，否则也会有很多莫名其妙的错误，这些错误和平台的兼容性有关。
* SUITESPARES_INSTALL_PREFIX = C:/Program Files/suitesparse (!!!默认C:/Ceres_Install/suitesparse-build/install)。
* !!! 取消选中SHARED。如果选中会报错，宣称缺少一系列.lib文件。
* OPENMP根据需要设置。

以管理员身份运行Visual Studio 2015，打开刚生成的对应解决方案SuiteSparseProject.sln。分别以Debug和Release模式（x64）生成ALL_BUILD项目和INSTALL项目 。虽然很多警告，但是仍然可以成功编译。但是目前只生成了静态库文件，我们还需要动态链接库，即.dll文件。

下面我们在刚才的CMake中， 重新选中SHARED项，其他项不变，再次点击generate。之后用Visual Studio重新打开此解决方案。然后此时重新以Debug和Release模式（x64）分别再次生成ALL_BUILD项目和INSTALL项目。因为再上一过程中.lib文件已经被生成并且安装（上一轮编译一定要生成INSTALL），所以这时不会再报错说缺少.lib文件了。此时四个依赖库都安装完毕，下面是主角Ceres了。

安装Ceres-Solver

安装Ceres的主要困难在于复杂的CMakeList配置程序。在第一次Configure会得到一个长长的属性列表。因为Ceres默认使用的是SuiteSparse库，而经过改造的suitesparse-metis-for-windows的配置文件所给出的很多CMake变量（对外接口）与Ceres的接口对不上。因此需要手动添加很多内容，这也是最坑爹之处。

根据长时间的摸索，不断地实验和对CMakeList文档的研究，得出以下可行配置。

配置选项中：
* 取消选中BUILD_EXAMPLES。为了节省后续编译时间。
* 取消选中BUILD_TESTING。为了节省后续编译时间。
* 选中BUILD_SHARED_LIBS，以便生成动态链接库文件。
* CMAKE_BUILD_TYPE 设为 Release。
* 选中CUSTOM_BLAS。
* 添加BLAS_LIBRARIES项（FILEPATH类）赋值 C:/Program Files/suitesparse/lib64/lapack_blas_windows/libblas.lib
* 选中LAPACK。
* 添加LAPACK_LIBRARIES项（FILEPATH类）赋值 C:/Program Files/suitesparse/lib64/lapack_blas_windows/liblapack.lib。
* 选中EIGENSPARSE。如果之前没有安装Eigen，只是解压。这里还需要手动配置EIGEN_INCLUDE_DIR项或Eigen3_DIR。
* GFLAGS和GLOG是否被选中，并且正确定位。如果安装在C盘Program FIles应该可以自动定位。
* 选中SUITESPARSE，注意这一选项会自动取消选中。
* 添加SUITESPARSE_CHECK_INCLUDE_DIRS项（PATH类）赋值 C:/Program Files/suitesparse/include ，提示suitesparse组件头文件位置。
* 添加SUITESPARSE_CHECK_LIBRARY_DIRS项（PATH类）赋值 C:/Program Files/suitesparse/lib64，提示suitesparse组件库文件位置。
* !!! 添加CMAKE_INSTALL_PREFIX 赋值 C:/Program Files/Ceres。

用管理员身份启动VS，打开刚刚生成的Ceres解决方案。切换编译器为Release模式。然后生成ALL_BUILD和INSTALL项目，完成Release模式的编译和安装过程。

现在切换到Debug模式。然后右键单击“ceres”项目->属性->C/C++->链接器->输入->附加依赖项。这里要注意属性管理也应设为Debug模式。

将下列库：

C:\Program Files\suitesparse\lib64\libspqr.lib
C:\Program Files\suitesparse\lib64\libcholmod.lib
C:\Program Files\suitesparse\lib64\libccolamd.lib
C:\Program Files\suitesparse\lib64\libcamd.lib
C:\Program Files\suitesparse\lib64\libcolamd.lib
C:\Program Files\suitesparse\lib64\libamd.lib
C:\Program Files\suitesparse\lib64\suitesparseconfig.lib

改为（文件名后加d表示debug模式对应的库）：

C:\Program Files\suitesparse\lib64\libspqrd.lib
C:\Program Files\suitesparse\lib64\libcholmodd.lib
C:\Program Files\suitesparse\lib64\libccolamdd.lib
C:\Program Files\suitesparse\lib64\libcamdd.lib
C:\Program Files\suitesparse\lib64\libcolamdd.lib
C:\Program Files\suitesparse\lib64\libamdd.lib
C:\Program Files\suitesparse\lib64\suitesparseconfigd.lib

其他库和设置保持原样。
此时重新生成ALL_BUILD和INSTALL。完成Debug模式的编译和安装。

关于这一部分的配置也可以通过修改CMakeList实现，如果对cmake编程熟练甚至可以重写FindSuiteSparse以实现自动配置。这里推荐这篇文章《Ceres-Solver库使用（一）–windows下安装配置》。

配置环境变量

我的电脑->属性->更改设置->高级->环境变量->系统变量->Path->编辑。注意设置完环境变量之后需要重启Visual Studio以生效。

在PATH中加入以下五个地址：

C:\Program Files\Ceres\bin
C:\Program Files\gflags\bin
C:\Program Files\glog\bin
C:\Program Files\suitesparse\bin
C:\Program Files\suitesparse\lib64\lapack_blas_windows

至此，Ceres（含SuiteSparse）安装过程完成。

测试

在C:/Ceres_Install/ceres-solver/examples有很多实例。我一般使用VS新建工程然后复制C++源代码的形式测试。这样各个项目不会互相影响。不建议用CMake。
要记得在属性中加入各种库Include路径和Lib文件路径。包括涉及到的各种库：Ceres、Eigen、SuiteSparse、gflags、glog等等。最好Debug和Release模式分别测试一下运行状况。

主要参考资料

*ceres-solver库编译说明 http://blog.csdn.net/liminlu0314/article/details/15860677
*Eigen+suitesparse for windows 安装 http://blog.csdn.net/xiamentingtao/article/details/50100549
*官方安装指南 http://ceres-solver.org/installation.html#windows