Eigen库学习教程(全)
说明：本教程主要是对eigen官网文档做了一个简要的翻译，参考了eigen官网以及一些博主的技术贴，在此表示感谢。
Eigen是一个高层次的C ++库，有效支持线性代数，矩阵和矢量运算，数值分析及其相关的算法。Eigen是一个开源库，从3.1.1版本开始遵从MPL2许可。
1.Eigen安装及使用
1.1 安装
eigen3在linux下的安装教程可以参考下面链接：
eigen安装教程
1.2 CMakeLists.txt编写
eigen库采用模板编程技术，仅由一些头文件组成，运行速度快。用cmake管理项目的时候，只需要在CMakeLists.txt里面头文件的路径即可：
find_package(Eigen3 REQUIRED)
include_directories(${EIGEN3_INCLUDE_DIR})
1.3 版本查看
终端输入命令：
tac /usr/include/eigen3/Eigen/src/Core/util/Macros.h # tac表示从文本的后面往前输出，
输出：
可以看到我的电脑安装的版本是3.2.92.
1.4 Eigen每个头文件的作用
模块和头文件详细介绍
Eigen所有的头文件及头文件里面的类的作用见下表：
一般为了省事，可以直接导入#include
2.Eigen官方教程
eigen官网链接：http://eigen.tuxfamily.org/index.php?title=Main_Page
文档：http://eigen.tuxfamily.org/dox/
3.Eigen使用基础
3.1 Eigen入门-hello Eigen
先来一个最简单的eigen程序体验下：
#include 包含Eigen库里面所有的函数和类
int main()
{
Eigen::MatrixXd m(2,2); // MatrixXd 表示的是动态数组，初始化的时候指定数组的行数和列数
m(0,0) = 3; //m(i,j) 表示第i行第j列的值，这里对数组进行初始化
m(1,0) = 2.5;
m(0,1) = -1;
m(1,1) = m(1,0) + m(0,1);
std::cout << m << std::endl; // eigen重载了<<运算符，可以直接输出eigen矩阵的值
}
输出：
3 -1
2.5 1.5
3.2 Matrices and vectors
//
// Created by fuhong on 20-7-12.
//
#include 输出：
m =
94.0188 89.844 43.5223
49.4383 101.165 86.823
88.3099 29.7551 37.7775
m * v =
404.274
512.237
261.153
3.3 逗号初始化 comma-initializer
关于Eigen逗号初始化的说明见文档：
Eigen逗号初始化
下面是逗号初始化的简单说明：
Eigen提供了一种逗号初始化器语法，该语法使用户可以轻松设置矩阵，向量或数组的所有系数。只需列出系数，从左上角开始，从左到右，从上到下移动。需要预先指定对象的大小。如果列出的系数太少或太多，编译器就会报错。
此外，初始化列表的元素本身可以是向量或矩阵。通常的用途是将向量或矩阵连接在一起。例如，这是如何将两个行向量连接在一起。请记住，必须先设置大小，然后才能使用逗号初始化程序。
RowVectorXd vec1(3);
vec1 << 1, 2, 3;
std::cout << "vec1 = " << vec1 << std::endl;
RowVectorXd vec2(4);
vec2 << 1, 4, 9, 16;
std::cout << "vec2 = " << vec2 << std::endl;
RowVectorXd joined(7);
joined << vec1, vec2;
std::cout << "joined = " << joined << std::endl;
3.4 一些常用的初始化方法(初始化为0，初始化为1，初始化为单位矩阵)
//
// Created by fuhong on 20-7-12.
//
#include 输出：
m0 =
0.680375 0.59688 -0.329554
-0.211234 0.823295 0.536459
0.566198 -0.604897 -0.444451
m1 =
2.4 2.4 2.4
2.4 2.4 2.4
2.4 2.4 2.4
m2 =
0 0
0 0
m3 =
1 1 1
1 1 1
1 1 1
m4 =
1 0 0 0
0 1 0 0
0 0 1 0
0 0 0 1
m5 =
1 2 3
4 5 6
7 8 9
before:
1 1 1
1 1 1
after:
1 1 1
2 2 2
3.5 调整矩阵大小
矩阵的当前大小可以通过rows（），cols（）和size（）检索。这些方法分别返回行数，列数和系数数。调整动态大小矩阵的大小是通过resize（）方法完成的。
动态矩阵可以随意调整矩阵大小，固定尺寸的矩阵无法调整大小。
//
// Created by fuhong on 20-7-13.
//
#include 输出：
The matrix m is of size 4x3
It has 12 coefficients
The vector v is of size 5
As a matrix, v is of size 5x1
3.6 固定尺寸与动态尺寸的选择(Fixed vs. Dynamic size)
什么时候应该使用固定尺寸（例如Matrix4f），什么时候应该使用动态尺寸（例如MatrixXf）？简单的答案是：在可能的地方使用固定尺寸来显示非常小的尺寸，在需要的地方使用动态尺寸来显示较大的尺寸。对于小尺寸，尤其是对于小于（大约）16的尺寸，使用固定尺寸对性能有极大的好处，因为它使Eigen避免了动态内存分配并展开了循环。在内部，固定大小的本征矩阵只是一个简单的数组，即
Matrix4f mymatrix;
等同于： float mymatrix[16];
因此，这确实具有零运行时间成本。相比之下，动态大小矩阵的数组始终分配在堆上，因此
MatrixXf mymatrix(rows,columns);
等同于： float mymatrix = new float[rowscolumns];
4.矩阵类(The Matrix class)
在Eigen中，所有matrices和vectors都是Matrix模板类的对象。vectors只是matrices的一种特殊情况，具有1行或1列。
4.1 Matrix的前三个模板参数
该矩阵类需要六个模板参数，但一般只需了解前三个参数即可。剩下的三个参数具有默认值，现在我们将保持不变，下面将进行讨论。关于后面三个参数的详细解释见：点我
Matrix的三个必需模板参数是：
Matrix
Scalar 是标量类型，即系数的类型。也就是说，如果要使用浮点数矩阵，请在此处选择float。有关所有受支持的标量类型的列表以及如何将支持扩展到新类型的信息，请参见标量类型。
RowsAtCompileTime和ColsAtCompileTime是在编译时已知的矩阵的行数和列数（如果在编译时不知道该数，该怎么办）请参见下文。
我们提供了许多方便的typedef来覆盖通常的情况。例如，Matrix4f是一个4x4的浮点矩阵。这是Eigen定义的：
typedef Matrix <float，4，4> Matrix4f;
Eigen里面用到了很多的typedef简化名称长度，例如下面：
typedef Matrix<float, 3, 1> Vector3f;
typedef Matrix<int, 1, 2> RowVector2i;
typedef Matrix<double, Dynamic, Dynamic> MatrixXd;
typedef Matrix<int, Dynamic, 1> VectorXi;
typedef Array<float,Dynamic,Dynamic> ArrayXXf
typedef Array<double,Dynamic,1> ArrayXd
typedef Array<int,1,Dynamic> RowArrayXi
typedef Array<float,3,3> Array33f
typedef Array<float,4,1> Array4f
......
4.2 vectors
在Eigen中，vectors只是Matrix的一种特殊情况，具有1行或1列。他们只有1列的情况最为常见；这样的向量称为列向量，通常缩写为向量。在另一行有1行的情况下，它们称为行向量。
typedef Matrix
4.3 动态矩阵
动态矩阵在编译的时候不知道其大小，需要在运行的时候才能确定其大小。
typedef Matrix
例如我们可以这样定义一个动态矩阵：
MatrixXd m(3,4) ; // 指定矩阵大小为3X4，也可以不指定
5.Array类的介绍
Eigen 不仅提供了Matrix和Vector结构，还提供了Array结构。区别如下，Matrix和Vector就是线性代数中定义的矩阵和向量，所有的数学运算都和数学上一致。但是存在一个问题是数学上的定义并不一定能完全满足现实需求。比如，数学上并没有定义一个矩阵和一个标量的加法运算。但是如果我们想给一个矩阵的每个元素都加上同一个数，那么这个操作就需要我们自己去实现，这显然并不方便。
Array 提供了一个Array类，为我们提供了大量的矩阵未定义的操作，且Array和Matrix之间很容易相互转换 ，所以相当于给矩阵提供更多的方法。也为使用者的不同需求提供了更多的选择。
下面看一下Array类的实现。Array类和Matrix有相同的参数。
Array
1
上面参数的意义和Matrix中参数的意义是相同的。
Array也对常用的情况作了一些类型定义。
typedef Array
typedef Array
typedef Array
typedef Array
5.1 Array初始化，加减乘除操作
Eigen::Array类重载了+ ， - ，* ,/ 运算符，可以直接用这些运算符对Array对象进行操作。相乘操作是对应的数字相乘，相除是对应的元素相除。
//
// Created by fuhong on 20-7-13.
//
#include 输出如下：
a + b =
2 4 6
5 7 9
8 10 12
a - 2 =
-1 0 1
2 3 4
5 6 7
a * b =
1 4 9
4 10 18
7 16 27
a / b =
1 1 1
4 2.5 2
7 4 3
5.2 Array类的其他操作
Array 还定义了 绝对值 abs() ，开平方根sqrt() , 以及找对应元素最小值操作 min() ;
//
// Created by fuhong on 20-7-13.
//
#include 输出：
a =
1.36075 1.1324
-0.422468 1.19376
a.abs() =
1.36075 1.1324
0.422468 1.19376
a.abs().sqrt() =
1.16651 1.06414
0.649976 1.09259
a.min(a.abs().sqrt()) =
1.16651 1.06414
-0.422468 1.09259
Array 和 Matrix 之间可以方便地进行转换。
Array 有 .matrix( ) 方法。
Matrix 有 .array( )方法。详细用法见下一小节。
6.Matrix和Array之间的相互转换
Matrix类和Array类之间可以相互转换，必须显式转换，才能对他们进行加减乘除运算。
//
// Created by fuhong on 20-7-13.
//
#include 7 矩阵转置，共轭，共轭转置
下面介绍矩阵的一些操作：
7.1 转置和共轭
对矩阵的转置、共轭和共轭转置由成员函数transpose(),conjugate(),adjoint()实现
MatrixXcf a = MatrixXcf::Random(2,2);
cout << "Here is the matrix a\n" << a << endl;
cout << "Here is the matrix a^T\n" << a.transpose() << endl;
cout << "Here is the conjugate of a\n" << a.conjugate() << endl;
cout << "Here is the matrix a^*\n" << a.adjoint() << endl;
输出：
Here is the matrix a
(-0.211,0.68) (-0.605,0.823)
(0.597,0.566) (0.536,-0.33)
Here is the matrix a^T
(-0.211,0.68) (0.597,0.566)
(-0.605,0.823) (0.536,-0.33)
Here is the conjugate of a
(-0.211,-0.68) (-0.605,-0.823)
(0.597,-0.566) (0.536,0.33)
Here is the matrix a^*
(-0.211,-0.68) (0.597,-0.566)
(-0.605,-0.823) (0.536,0.33)
7.2转置需要注意的事项
a = a.transpose();无法运行，这称为别名问题，在debug模式下当assertions没有禁止时，这种问题会被自动检测到。要避免错误，可以使用in-place转置。类似的还有adjointInPlace()。所以正确的操作见下面程序：
//
// Created by fuhong on 20-7-13.
//
#include 输出：
Here is the matrix a:
1 2
3 4
and the result of the aliasing effect:
1 3
2 4
8 点积和叉积
对于点积和叉积，直接使用dot()和cross()方法
#include 输出：
Dot product: 8
Dot product via a matrix product: 8
Cross product:
1
-2
1
注意：记住叉积仅仅用于尺寸为3的向量！点积可以用于任意尺寸的向量，当使用复数时，Eigen的点积操作是第一个变量为共轭线性的，第二个为线性的。
9 矩阵的基础的算术(求和,平均值等)
Eigen提供了一些对于矩阵或向量的规约操作，如sum(),prod(),maxCoeff()和minCoeff()
#include 输出：
Here is mat.sum(): 10
Here is mat.prod(): 24
Here is mat.mean(): 2.5
Here is mat.minCoeff(): 1
Here is mat.maxCoeff(): 4
Here is mat.trace(): 5
trace为矩阵的迹，也可以由a.diagonal().sum()得到。
minCoeff和maxCoeff函数也可以返回相应的元素的位置信息
Matrix3f m = Matrix3f::Random();
std::ptrdiff_t i, j;
float minOfM = m.minCoeff(&i,&j);
cout << "Here is the matrix m:\n" << m << endl;
cout << "Its minimum coefficient (" << minOfM
<< ") is at position (" << i << "," << j << ")\n\n";
RowVector4i v = RowVector4i::Random();
int maxOfV = v.maxCoeff(&i);
cout << "Here is the vector v: " << v << endl;
cout << "Its maximum coefficient (" << maxOfV
<< ") is at position " << i << endl;
输出：
Here is the matrix m:
0.68 0.597 -0.33
-0.211 0.823 0.536
0.566 -0.605 -0.444
Its minimum coefficient (-0.605) is at position (2,1)
Here is the vector v: 1 0 3 -3
Its maximum coefficient (3) is at position 2
10 Eigen 块操作
10.1块基本操作
块指的是矩阵或数组中的一个矩形区域，块表达式可以用于左值或者右值，同样不会耗费运行时间，由编译器优化。
Eigen中最常用的块操作是block()方法，共有两个版本
索引从0开始。两个版本都可用于固定尺寸或者动态尺寸的矩阵和数组。这两个表达式语义上相同，唯一的区别是如果块的尺寸比较小的话固定尺寸版本的块操作运行更快，但是需要在编译阶段知道大小。
//
// Created by fuhong on 20-7-14.
//
#include (a,b) 表示从第(a+1)行(b+1)列开始,截图i行,j列
for (int i = 1; i <= 3; ++i) {
cout << "Block of size " << i << "x" << i << endl;
cout << m.block(0, 0, i, i) << endl << endl; //m.block(a,b,i,j) 表示从第(a+1)行(b+1)列开始,截图i行,j列
}
}
输出:
m:
1 2 3 4
5 6 7 8
9 10 11 12
13 14 15 16
Block in the middle
6 7
10 11
Block of size 1x1
1
Block of size 2x2
1 2
5 6
Block of size 3x3
1 2 3
5 6 7
9 10 11
注意:m.block
m.block(a,b,i,j) 表示从第(a+1)行(b+1)列开始,截图i行,j列
上述例子中的块操作方法作为表达式的右值，意味着是只读形式的，然而，块操作也可以作为左值使用，意味着你可以给他赋值。下面的例子说明了这一点，当然对于矩阵的操作是一样的。
//
// Created by fuhong on 20-7-14.
//
#include 输出:
Here is the array a:
0.6 0.6 0.6 0.6
0.6 0.6 0.6 0.6
0.6 0.6 0.6 0.6
0.6 0.6 0.6 0.6
Here is now a with m copied into its central 2x2 block:
0.6 0.6 0.6 0.6
0.6 1 2 0.6
0.6 3 4 0.6
0.6 0.6 0.6 0.6
Here is now a with bottom-right 2x3 block copied into top-left 2x2 block:
3 4 0.6 0.6
0.6 0.6 0.6 0.6
0.6 3 4 0.6
0.6 0.6 0.6 0.6
尽管block()方法可用于任何形式的块操作，还是有特殊的方法API用于特殊情况的，主要是为了更好的性能。说到性能，最重要的是在编译阶段给Eigen尽可能多的信息。比如，如果你的块是一个矩阵中的一列，那么使用col()方法会更好。本节其余的介绍都是关于这些特殊的方法的。
10.2行和列(cols and rows)
行和列是一中特殊的块。Eigen提供了特殊的方法：col() 列 row() 行。
//
// Created by fuhong on 20-7-14.
//
#include 输出:
Here is the matrix m:
1 2 3 4
5 6 7 8
9 10 11 12
13 14 15 16
2nd Row: 5 6 7 8
After adding 3 times the first column into the third column, the matrix m is:
1 2 6 4
5 6 22 8
9 10 38 12
13 14 54 16
10.3 边角相关的操作
Eigen同样提供了对于挨着矩阵或数组的边、角的特殊操作方法，比如topLeftCorner()方法可用于操作矩阵左上角的区域。总结如下：
//
// Created by fuhong on 20-7-14.
//
#include 输出:
m.leftCols(2) =
1 2
5 6
9 10
13 14
m.bottomRows<2>() =
9 10 11 12
13 14 15 16
After assignment, m =
8 12 16 4
5 6 7 8
9 10 11 12
13 14 15 16
10.4 对于向量的块操作
Eigen也提供了一些针对向量和一维数组的块操作方法：
//
// Created by fuhong on 20-7-14.
//
#include 输出:
v.head(3) =
1
2
3
v.tail<3>() =
4
5
6
after 'v.segment(1,4) *= 2', v =
1
4
6
8
10
6
11 范数计算
向量的平方范数由squaredNorm()获得，等价于向量对自身做点积，也等同于所有元素额平方和。Eigen也提供了norm()范数，返回的是squaredNorm()的根。这些操作也适用于矩阵。如果想使用其他元素级的范数，使用lpNorm
()方法，当求无穷范数时，模板参数p可以取特殊值Infinity，得到的是所有元素的最大绝对值。
//
// Created by fuhong on 20-7-14.
//
#include () = " << v.lpNorm<Infinity>() << endl;
cout << endl;
cout << "m.squaredNorm() = " << m.squaredNorm() << endl;
cout << "m.norm() = " << m.norm() << endl;
cout << "m.lpNorm<1>() = " << m.lpNorm<1>() << endl;
cout << "m.lpNorm() = " << m.lpNorm<Infinity>() << endl;
}
输出:
v.squaredNorm() = 5
v.norm() = 2.23607
v.lpNorm<1>() = 3
v.lpNorm<Infinity>() = 2
m.squaredNorm() = 30
m.norm() = 5.47723
m.lpNorm<1>() = 10
m.lpNorm<Infinity>() = 4
矩阵的1范数和无穷范数也可以用下面的方法计算：
#include 输出:
1-norm(m) = 6 == 6
infty-norm(m) = 7 == 7
12 布尔规约
如下的操作得到的是布尔值
all()返回真，如果矩阵或数组的所有元素为真
any()返回真，如果矩阵或数组至少有一个元素为真
count()返回元素为真的个数
#include 输出:
(a > 0).all() = 1
(a > 0).any() = 1
(a > 0).count() = 4
(a > 2).all() = 0
(a > 2).any() = 1
(a > 2).count() = 2
13迭代
当需要获得元素在矩阵或数组中的位置时使用迭代。
#include 输出:
Max: 4, at: 1,1
Min: 1, at: 0,0
14 部分规约
部分规约指的是对矩阵或数组按行或列进行的操作，对每一列或者行进行规约操作时得到的是一个列或者行向量。如下例子得到矩阵每一列的最大值并存入一个行向量中
#include 输出：
Column's maximum:
3 2 7 9
同样也可以得到每一行的最大值，返回一个列向量
#include 输出:
Row's maximum:
9
7
部分规约和其他操作的结合
使用部分规约操作得到的结果去做其他的操作也是可以的，如下例子用于得到矩阵中元素和最大的一列
#include 输出:
Maximum sum at position 2
The corresponding vector is:
6
7
And its sum is is: 13
通过colwise()迭代，应用sum()对每一列规约操作得到一个新的1x4的矩阵，因此如果
那么,
最终执行maxCoeff()操作获得元素和最大的列的索引。
15 广播机制
广播的概念类似于部分规约，不同之处在于广播通过对向量在一个方向上的复制，将向量解释成矩阵。如下例子将一个列向量加到矩阵的每一列中
#include 输出:
Broadcasting result:
1 2 6 9
4 2 8 3
可以将mat.colwise()+=v理解成两种等价的方式，它将列向量加到矩阵的每一列中；或者将列向量复制4次的得到一个2x4的矩阵，之后进行矩阵的相加运算：
+=、+和-运算符也可以按列或行操作。在数组中也可以用*=、/=、和/运算符执行元素级的按行或列乘除运算。但不能用在矩阵上，如果想用v(0)乘以矩阵的第0列，v(1)乘以矩阵的第1列…使用mat = mat*v.asDiagonal()。
结合广播和其他操作
广播也可以和其他操作结合，比如矩阵或数组的运算、规约和部分规约操作。下面介绍一个更加复杂的例子，演示了在矩阵中找到和给定向量最接近的一列，使用到了欧氏距离。
#include 输出:
Nearest neighbour is column 0:
1
3
其中
(m.colwise() - v).colwise().squaredNorm().minCoeff(&index);
这句话做的工作是：
（1）m.colwise()-v是一个广播操作，矩阵m的每一列减去v，得到一个新的矩阵
（2）(m.colwise() - v).colwise().squareNorm()是部分规约操作，按列计算矩阵的平方范数，得到一个行向量
（3）最终minCoeff(&index)根据欧氏距离获得矩阵中最接近v的一列的索引。
16几何模块的实践(Geometry)
详细说明参考官网:点我
Eigen的几何模块用来表达空间的旋转、平移等变换。3维空间中刚体的运动有六个自由度，分别是绕3个轴的旋转运动和沿着3个轴的平移运动。对于旋转可以用3x3的旋转矩阵R表示，旋转矩阵描述了刚体经过矩阵作用后的姿态信息，旋转矩阵是一个正交矩阵；然而旋转矩阵有9个参数，9个参数描述6自由度的旋转，有点冗余了。因此旋转还可以用旋转向量来表示，空间中物体的旋转可以看作是绕这某个轴转过一定的角度完成，因此旋转矩阵是个3维向量，其方向代表转轴的方向，其大小代表旋转的角度。
实际中物体不光有旋转，还有平移运动，如果用t表示平移向量，那么R*p+t可以描述刚体p的旋转加平移运动，然而当连续多次运动时整个表达式将会变得非常复杂，比如R1*(R*p+t)+t1描述连续两次的运动，因此为了简化书写形式引入齐次坐标的概念，将坐标扩充到4维，将旋转矩阵和平移向量写入一个4x4的变换矩阵中，简化了连续运动公式的形式，但是结果是16个参数描述一个6自由度的运动，更加冗余了。在旋转向量的后面增加3维代表平移向量，即用6维的旋转向量描述旋转和平移运动，看起来比较紧凑了，但是像欧拉角一样也会遇到万向锁问题，导致奇异性；最终即不冗余又紧凑又没有万向锁问题的解决方案是使用四元数描述旋转问题，这也是很多飞控代码中用到的方案。
// Created by 开机烫手 on 2018/4/8.
#include 输出:
rotation vector: Angle is: 45 Axis is: 0 0 1
rotation matrix =
0.707 -0.707 0
0.707 0.707 0
0 0 1
(1,0,0) after rotation = 0.707 0.707 0
(1,0,0) after rotation = 0.707 0.707 0
yaw pitch roll = 45 -0 0
Transform matrix =
0.707 -0.707 0 0
0.707 0.707 0 0
0 0 1 3
0 0 0 1
v transformed = 0.707 0.707 3
quaternion =
0
0
0.383
0.924
quaternion =
0
0
0.383
0.924
(1,0,0) after rotation = 0.707 0.707 0
17 稠密问题之线性代数和分解
官网: http://eigen.tuxfamily.org/dox/group__DenseLinearSolvers__chapter.html
参考链接: https://blog.csdn.net/u012936940/article/details/79871941
未完待续。。。。