CMake构建学习笔记29-SuiteSparse库的构建

1 介绍

在上一篇文章《CMake构建学习笔记26-OpenBLAS库的构建》中介绍的OpenBLAS是用来解决稠密矩阵相关问题的，例如数值优化中的最小二乘问题。但是如果问题模型中的已知参数太多，就会导致求解的矩阵中存在大量的零值，直接使用常规的稠密矩阵方法求解不仅速度慢，对内存资源的消耗也是一个问题。这种存在大量的零值的矩阵就是稀疏矩阵，会采用一些专门的方法优化这一类问题的求解。

SuiteSparse 就是一个用于高效求解稀疏矩阵相关的问题的开源软件包集合。它由 Timothy A. Davis 教授开发和维护，被广泛应用于科学计算、工程仿真、图论、机器学习等领域。

2 构建

SuiteSparse需要3个依赖库：OpenBLAS、gmp 和 mpfr ，正好这三个依赖库我们在前面的文章《CMake构建学习笔记26-OpenBLAS库的构建》和《CMake构建学习笔记28-gmp&mpfr库的构建》中都介绍过，这里就不再赘叙了。

还是使用本系列文章(《CMake构建学习笔记-目录》)实现的自动化工具 BuildCppDependency 来构建 SuiteSparse。在 Windows 平台下输入指令：

./BuildCppDependency.ps1 `
  -Generator "Visual Studio 16 2019" `
  -InstallDir "$env:GISBasic" `
  -SymbolDir "$env:GISBasic/symbols" `
  -Install SuiteSparse

在 Linux (Ubuntu) 平台下输入指令：

./build.sh -install SuiteSparse -installdir "$GISBasic"

进一步看一下 Windows 下的构建脚本，主要是为了看一下 CMake 构建参数：

# SuiteSparse.ps1
param(    
    [string]$Name = "SuiteSparse-7.11.0",
    [string]$SourceDir = "../Source",
    [string]$Generator,
    [string]$InstallDir,  
    [string]$SymbolDir,  
    [bool]$Force = $false,        # 是否强制重新构建
    [bool]$Cleanup = $true        # 是否在构建完成后删除源码和构建目录
)

# 目标文件
$DllPath = "$InstallDir/bin/umfpack.dll"

# 依赖库数组
$Librarys = @("OpenBLAS", "gmp", "mpfr")  

# 符号库文件
$PdbFiles = @(
    "SuiteSparse_config/RelWithDebInfo/suitesparseconfig.pdb"
    "Mongoose/RelWithDebInfo/suitesparse_mongoose.pdb"
    "AMD/RelWithDebInfo/amd.pdb"
    "BTF/RelWithDebInfo/btf.pdb"
    "CAMD/RelWithDebInfo/camd.pdb"
    "CCOLAMD/RelWithDebInfo/ccolamd.pdb"
    "CHOLMOD/RelWithDebInfo/cholmod.pdb"
    "COLAMD/RelWithDebInfo/colamd.pdb"
    "CXSparse/RelWithDebInfo/cxsparse.pdb"
    "GraphBLAS/RelWithDebInfo/graphblas.pdb"    
    "KLU/RelWithDebInfo/klu.pdb"
    "LAGraph/dlls/RelWithDebInfo/lagraph.pdb"
    "LAGraph/dlls/RelWithDebInfo/lagraphx.pdb"
    "LDL/RelWithDebInfo/ldl.pdb"
    "ParU/RelWithDebInfo/paru.pdb"
    "RBio/RelWithDebInfo/rbio.pdb"
    "SPEX/RelWithDebInfo/spex.pdb"
    "SPEX/RelWithDebInfo/spexpython.pdb"
    "SPQR/RelWithDebInfo/spqr.pdb"
    "UMFPACK/RelWithDebInfo/umfpack.pdb"
) 

# 额外构建参数
$CMakeCacheVariables = @{
    SUITESPARSE_REQUIRE_BLAS = "ON"
    SUITESPARSE_USE_64BIT_BLAS = "ON"   
    BUILD_TESTING = "OFF"
    BUILD_STATIC_LIBS = "OFF"
    BUILD_SHARED_LIBS = "ON"
    SUITESPARSE_USE_FORTRAN = "ON"
    SUITESPARSE_C_TO_FORTRAN = "(name,NAME) name##_"
}

. ./build-common.ps1 -Name $Name `
    -SourceDir $SourceDir `
    -InstallDir $InstallDir `
    -SymbolDir $SymbolDir `
    -Generator $Generator `
    -TargetDll $DllPath `
    -PdbFiles $PdbFiles `
    -CMakeCacheVariables $CMakeCacheVariables `
    -MultiConfig $true `
    -Force $Force `
    -Cleanup $Cleanup `
    -Librarys $Librarys

这几个构建参数比较关键，否者容易构建失败，这里就详细说明一下：

1. SUITESPARSE_REQUIRE_BLAS = "ON"：强制要求在构建 SuiteSparse 时链接 BLAS/LAPACK 库。
2. SUITESPARSE_USE_64BIT_BLAS = "ON"：启用对 64 位整数索引的 BLAS/LAPACK 接口 的支持（也称为 ILP64 模式）。默认的 BLAS/LAPACK 使用 32 位整数，当处理超大规模稀疏矩阵时，链接的 OpenBLAS 必须编译为 ILP64 版本，否则会出现链接错误或运行时崩溃。
3. BUILD_TESTING = "OFF"：禁用测试程序的构建。
4. BUILD_STATIC_LIBS = "OFF"/BUILD_SHARED_LIBS = "ON"：只构建动态链接库，不构建静态库。
5. SUITESPARSE_USE_FORTRAN = "ON"：使用传统的 Fortran 风格 BLAS/LAPACK 接口（如函数名为 dgemm_, dpotrf_ 等）来链接外部库。
6. SUITESPARSE_C_TO_FORTRAN = "(name,NAME) name##_"：定义 C 函数如何调用 Fortran 子程序的命名转换规则。

尽管在构建 OpenBLAS 的时候，没有使用 Fortran 来构建，但是处于兼容性，OpenBLAS还是会提供 Fortran 接口。这里设置了使用传统的 Fortran 风格来调用 BLAS/LAPACK 接口，但是 SuiteSparse 本身是 C 实现的，因此调用 Fortran 接口需要对接口命名进行转换。

3. 其他

系列文章：《CMake构建学习笔记-目录》
构建工具: Github地址，GitCode地址
二进制构建结果：Github地址，GitCode地址