Eigen::Matrix

template<typename _Scalar, int _Rows, int _Cols, int _Options, int _MaxRows, int _MaxCols>
class Eigen::Matrix< _Scalar, _Rows, _Cols, _Options, _MaxRows, _MaxCols >

Класс матриц, также используемый для векторов и строковых векторов.

Класс Matrix является основным классом для всех плотных (примечание) матриц и векторов в библиотеке Eigen. Векторы являются матрицами с одним столбцом, а строковые векторы — матрицами с одной строкой.

Класс Matrix охватывает как объекты фиксированного размера, так и объекты динамического размера (примечание).

Первые три параметра шаблона обязательны:

Параметры шаблона

_Scalar	Числовой тип, например, float, double, int или std::complex<float>. Поддерживаются также пользовательские типы скаляров (см. здесь).
_Rows	Количество строк или Dynamic
_Cols	Количество столбцов или Dynamic

Остальные параметры шаблона являются необязательными — в большинстве случаев вам не нужно беспокоиться о них.

Параметры шаблона

_Options	Сочетание RowMajor или ColMajor, и AutoAlign или DontAlign. Первый параметр управляет порядком хранения и по умолчанию равен column-major. Последний параметр управляет выравниванием, которое необходимо для векторизации. По умолчанию матрицы выравниваются, за исключением фиксированных размеров, которые не кратны размеру пакета.
_MaxRows	Максимальное количество строк. По умолчанию равно _Rows (примечание).
_MaxCols	Максимальное количество столбцов. По умолчанию равно _Cols (примечание).

Eigen предоставляет несколько псевдонимов типов, охватывающих обычные случаи. Вот несколько примеров:

• Matrix2d — это квадратная матрица 2x2 с типом double (Matrix<double, 2, 2>)
• Vector4f — это вектор из 4 чисел с плавающей точкой (Matrix<float, 4, 1>)
• RowVector3i — это строковый вектор из 3 целых чисел (Matrix<int, 1, 3>)

• MatrixXf — это матрица динамического размера с типом float (Matrix<float, Dynamic, Dynamic>)
• VectorXf — это вектор динамического размера с типом float (Matrix<float, Dynamic, 1>)

• Matrix2Xf — это матрица частично фиксированного размера (динамического размера) с типом float (Matrix<float, 2, Dynamic>)
• MatrixX3d — это матрица частично динамического размера (фиксированного размера) с типом double (Matrix<double, Dynamic, 3>)

См. эту страницу для полного списка предопределенных псевдонимов типов Matrix и Vector.

Вы можете получить доступ к элементам векторов и матриц с помощью обычного индексирования:

Eigen::VectorXd v(10);
v[0] = 0.1;
v[1] = 0.2;
v(0) = 0.3;
v(1) = 0.4;
 
Eigen::MatrixXi m(10, 10);
m(0, 1) = 1;
m(0, 2) = 2;
m(0, 3) = 3;

Этот класс может быть расширен с помощью механизма плагинов, описанного на странице Расширение MatrixBase (и других классов), определив препроцессорный символ EIGEN_MATRIX_PLUGIN.

Некоторые замечания:

Плотность против разреженности:

Этот класс Matrix обрабатывает плотные, а не разреженные матрицы и векторы. Для разреженных матриц и векторов см. модуль Sparse.

Плотныe матрицы и векторы представляют собой обычные массивы коэффициентов. Все коэффициенты хранятся в обычном смежном массиве. В отличие от разреженных матриц и векторов, где коэффициенты хранятся как список ненулевых коэффициентов.

Фиксированный размер против динамического размера:

Фиксированный размер означает, что количество строк и столбцов известно на этапе компиляции. В этом случае Eigen выделяет массив коэффициентов как массив фиксированного размера в качестве члена класса. Это имеет смысл для очень маленьких матриц, обычно до 4x4, иногда до 16x16. Более крупные матрицы следует объявлять как динамического размера, даже если их размер известен на этапе компиляции.

Динамический размер означает, что количество строк или столбцов не обязательно известно на этапе компиляции. В этом случае они являются переменными во время выполнения, и массив коэффициентов выделяется динамически в куче.

Обратите внимание, что плотные матрицы, будь то фиксированного или динамического размера, не расширяются динамически в смысле std::map. Если вам нужно такое поведение, см. модуль Sparse.

_MaxRows и _MaxCols:

В большинстве случаев эти параметры оставляют по умолчанию. Эти параметры обозначают максимальный размер строк и столбцов, которые может иметь матрица. Они полезны в тех случаях, когда точное количество строк и столбцов неизвестно на этапе компиляции, но известно, что они не могут превысить определенного значения. Это происходит при взятии блоков динамического размера внутри матриц фиксированного размера: в этом случае _MaxRows и _MaxCols — это размеры исходной матрицы, а _Rows и _Cols — Dynamic.

ABI и структура хранения

В таблице ниже обобщается ABI некоторых возможных экземпляров Matrix, которые являются постоянными на протяжении всего срока службы Eigen 3.

Matrix<T,Dynamic,Dynamic> 

struct {
  T *data;                  // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
  Eigen::Index rows, cols;
 };

Matrix<T,Dynamic,1>
Matrix<T,1,Dynamic> 

struct {
  T *data;                  // with (size_t(data)%EIGEN_MAX_ALIGN_BYTES)==0
  Eigen::Index size;
 };

Matrix<T,Rows,Cols> 

struct {
  T data[Rows*Cols];        // with (size_t(data)%A(Rows*Cols*sizeof(T)))==0
 };

Matrix<T,Dynamic,Dynamic,0,MaxRows,MaxCols> 

struct {
  T data[MaxRows*MaxCols];  // with (size_t(data)%A(MaxRows*MaxCols*sizeof(T)))==0
  Eigen::Index rows, cols;
 };

Обратите внимание, что в этой таблице Rows, Cols, MaxRows и MaxCols — все положительные целые числа. A(S) определяется как наибольшая возможная степень двойки, меньшая EIGEN_MAX_STATIC_ALIGN_BYTES.

См. также

MatrixBase для большинства методов API для матриц, Иерархия классов, Порядки хранения