[Eigen中文文档] 常见的陷阱

简介: 本文将介绍一些Eigen常见的陷阱

文档总目录

英文原文(Common pitfalls)

针对模板方法的编译错误

详见下一节 C++中的template和typename关键字

混叠

详见 [Eigen中文文档] 混叠

对齐问题(运行时断言)

Eigen进行了显式向量化,虽然这受到许多用户的赞赏,但在某些特殊情况下,数据对齐会出现问题。实际上,在C++17之前,C++没有足够好的支持显式数据对齐。在这种情况下,程序会出现断言失败(即“受控崩溃”),并显示一条消息,引导你参考此页面。它包含有关如何处理该问题的每个已知原因的详细信息。

如果你不关心矢量化并且不想处理这些对齐问题,可以阅读如何避免这一情况

C++11 和 auto 关键字

简而言之:不要将 auto 关键字与 Eigen 表达式一起使用,除非你 100% 确定自己在做什么。特别是,不要使用 auto 关键字来替代 Matrix<> 类型。这是一个例子:

MatrixXd A, B;
auto C = A*B;
for(...) {
    ... w = C * v;  ...}

在这个例子中,C 的类型不是MatrixXd,而是表示矩阵乘积并存储对 AB 的引用的抽象表达式。因此,A*B 的乘积将在 for 循环的每次迭代中执行多次。此外,如果 AB 的系数在迭代过程中发生改变,那么 C 将评估为不同的值,就像以下示例一样:

MatrixXd A = ..., B = ...;
auto C = A*B;
MatrixXd R1 = C;
A = ...;
MatrixXd R2 = C;

因此我们最终得到 R1R2

如下是导致段错误的另一个示例:

auto C = ((A+B).eval()).transpose();
// do something with C

问题在于 eval() 返回一个临时对象(在本例中为MatrixXd),然后由Transpose<>表达式引用。然而,这个临时对象在第一行之后立即被删除,然后C表达式引用了一个已经不存在的对象。一个可能的解决方法是在整个表达式上应用eval()

auto C = (A+B).transpose().eval();

当 Eigen 自动计算子表达式时,可能会出现相同的问题,如下例所示:

VectorXd u, v;
auto C = u + (A*v).normalized();
// do something with C

这里,normalized() 方法必须评估耗费资源的乘积 A*v 以避免评估两次。同样,一种可能的修复方法是对整个表达式调用 .eval()

auto C = (u + (A*v).normalized()).eval();

在本例中,C 将是常规 VectorXd 对象。请注意,当底层表达式已经是普通 Matrix<> 时,DenseBase::eval() 足够智能,可以避免复制。

头文件问题(编译失败)

对于所有的库,都必须查看文档以确定要包含哪个头文件。Eigen也是如此,但略有不同的是:对于Eigen而言,一个类中的方法可能需要比类本身更多的# include。例如,如果你想在向量上使用 cross() 方法(它计算叉积),你需要:

#include<Eigen/Geometry>

三元运算符

简而言之:避免将三元运算符 (COND ? THEN : ELSE) 与 Eigen 的 THENELSE 语句表达式一起使用。要了解原因,让我们考虑以下示例:

Vector3f A;
A << 1, 2, 3;
Vector3f B = ((1 < 0) ? (A.reverse()) : A);

这个例子将返回B = 3, 2, 1。原因是在c++中,ELSE语句的类型根据THEN表达式的类型推断,以使两者的类型匹配。由于THEN是一个Reverse<Vector3f>,因此ELSE语句A被转换为一个Reverse<Vector3f>,因此编译器生成:

Vector3f B = ((1 < 0) ? (A.reverse()) : Reverse<Vector3f>(A));

在这种非常特殊的情况下,解决方法是为 THEN 语句调用 A.reverse().eval(),但最安全、最快的方法实际上是避免使用 Eigen 表达式的三元运算符并使用 if/else 构造。

按值传递

如果不知道为什么 Eigen 的值传递是错误的,请先阅读此页

虽然可能非常小心并确保所有显式使用 Eigen 类型的代码都是按引用传递的,但必须注意在编译时定义参数类型的模板。

如果一个模板有一个以按值方式传递参数的函数,并且相关的模板参数最终成为Eigen类型,那么你当然会遇到与明确定义函数以引用方式传递Eigen类型相同的对齐问题。

使用Eigen类型与其他第三方库或甚至STL一起使用可能会遇到同样的问题。例如,boost::bind 使用按值传递来存储返回的函数对象中的参数。

至少有两种方法可以解决这个问题:

  • 如果你传递的值保证在函数对象的生命周期内存在,你可以使用boost::ref()将其包装,然后传递给boost::bind。通常,对于栈上的值,这不是一个解决方案,因为如果该函数对象传递到更低的作用域或独立作用域,该对象可能已经被删除,因此在尝试使用它时会出现问题。
  • 另一种选择是让函数采用引用计数指针(如 boost::shared_ptr)作为参数。这避免了需要管理所传递对象的生命周期。

具有布尔系数的矩阵

目前使用具有布尔系数的 Matrix 的行为不一致,并且可能在 Eigen 的未来版本中发生变化,因此请谨慎使用!

这种不一致的一个简单例子是:

template<int Size>
void foo() {
   
    Eigen::Matrix<bool, Size, Size> A, B, C;
    A.setOnes();
    B.setOnes();

    C = A * B - A * B;
    std::cout << C << "\n";
}

因为调用 foo<3>() 会打印零矩阵,而调用 foo<10>() 会打印单位矩阵。

相关文章
|
C++
[Eigen中文文档] 按值将Eigen对象传递给函数
对于 Eigen,这一点更为重要:按值传递固定大小的可向量化 Eigen 对象不仅效率低下,而且可能是非法的或使程序崩溃! 原因是这些 Eigen 对象具有对齐修饰符,在按值传递时会不遵守这些修饰符。
314 0
|
XML 并行计算 算法
[Eigen中文文档] 求解稀疏线性系统
在Eigen中,有多种方法可用于求解稀疏系数矩阵的线性系统。由于此类矩阵的特殊表示,必须特别小心以获得良好的性能。本文列出了Eigen中可用的稀疏求解器。还介绍了所有这些线性求解器共同的主要步骤。根据矩阵的属性、所需的准确度,最终用户可以调整这些步骤以提高其代码的性能。请注意,并不需要深入了解这些步骤背后的内容:最后一节介绍了一个基础例程,可轻松使用以获取所有可用求解器的性能洞察。
710 0
|
存储 算法 NoSQL
[Eigen中文文档] 存储顺序
矩阵和二维数组有两种不同的存储顺序:列优先和行优先。本节解释了这些存储顺序以及如何指定应该使用哪一种。
367 0
|
存储 算法 NoSQL
[Eigen中文文档] 稀疏矩阵操作
在许多应用中(例如,有限元方法),通常要处理非常大的矩阵,其中只有少数系数不为零。在这种情况下,可以通过使用仅存储非零系数的特殊表示来减少内存消耗并提高性能。这样的矩阵称为稀疏矩阵。
772 0
|
存储 缓存
[Eigen中文文档] 深入了解 Eigen - 惰性求值与混叠(Aliasing)
Eigen具有智能的编译时机制,可以实现惰性求值并在适当的情况下删除临时变量。它会自动处理大多数情况下的混叠问题,例如矩阵乘积。自动行为可以通过使用MatrixBase::eval()和MatrixBase::noalias()方法手动覆盖。
543 0
|
存储 C语言 C++
|
存储 编译器
|
JSON 数据格式 C++
VS Code debug调试时无法查看变量内容【已解决】
VS Code debug调试时无法查看变量内容【已解决】
VS Code debug调试时无法查看变量内容【已解决】
|
存储 缓存 并行计算
[Eigen中文文档] 预处理器指令
可以通过定义预处理器宏来控制Eigen的某些方面。这些宏应该在包含任何Eigen头文件之前定义。通常最好在项目选项中设置它们。 本页面列出了Eigen支持的预处理器指令。
537 0
|
存储 并行计算 算法
[Eigen中文文档] 概述(总目录)
Eigen是基于线性代数的C ++模板库,主要用于矩阵,向量,数值求解器和相关算法。常用的Ceres、G2O等项目均是基于Eigen库。 本系列文章将通过官方文档带你了解Eigen。
2459 1