Eigen::MatrixBase

Эта функция требует модуля MatrixFunctions. Для вычисления покомпонентного обратного гиперболического косинуса используйте ArrayBase::acosh .

Возвращает

выражение обратного гиперболического косинуса матрицы *this.

Возвращает

выражение сопряжённой транспонированной матрицы *this.

Пример:

Matrix2cf m = Matrix2cf::Random();
cout << "Here is the 2x2 complex matrix m:" << endl << m << endl;
cout << "Here is the adjoint of m:" << endl << m.adjoint() << endl;

Вывод:

Here is the 2x2 complex matrix m:
 (-0.211,0.68) (-0.605,0.823)
 (0.597,0.566)  (0.536,-0.33)
Here is the adjoint of m:
 (-0.211,-0.68)  (0.597,-0.566)
(-0.605,-0.823)    (0.536,0.33)

Предупреждение

Если вы хотите заменить матрицу её сопряжённой транспонированной, НЕ делайте это:

m = m.adjoint(); // bug!!! caused by aliasing effect

Вместо этого используйте метод adjointInPlace():

m.adjointInPlace();

Это даёт библиотеке Eigen хорошие возможности для оптимизации, или же вы можете сделать следующее:

m = m.adjoint().eval();

См. также

adjointInPlace(), transpose(), conjugate(), класс Transpose, класс internal::scalar_conjugate_op

Это "локальная" версия adjoint(): она заменяет *this своей собственной транспонированной матрицей. Таким образом, выполнение

m.adjointInPlace();

имеет тот же эффект на m, что и выполнение

m = m.adjoint().eval();

и является быстрее и безопаснее, так как в последней строке кода, забыв о eval(), приводит к ошибке, вызванной алиасированием.

Однако, обратите внимание, что этот метод полезен только если вы хотите заменить матрицу её собственной сопряжённой транспонированной. Если вам нужна только сопряжённая транспонированная матрица, используйте adjoint().

Примечание

если матрица не квадратная, то *this должна быть изменяемой матрицей. Это исключает (неквадратные) фиксированные матрицы, блочные выражения и отображения.

См. также

transpose(), adjoint(), transposeInPlace()

Применяет элементарный отражатель H, заданный \( H = I - tau v v^*\) с \( v^T = [1 essential^T] \) слева к вектору или матрице.

На входе:

Параметры

essential	существенная часть вектора v
tau	коэффициент масштабирования преобразования Хаусхолдера
workspace	указатель на рабочее пространство с по крайней мере this->cols() элементами

См. также

MatrixBase::makeHouseholder(), MatrixBase::makeHouseholderInPlace(), MatrixBase::applyHouseholderOnTheRight()

Применяет элементарный отражатель H, заданный \( H = I - tau v v^*\) с \( v^T = [1 essential^T] \) справа к вектору или матрице.

На входе:

Параметры

essential	существенная часть вектора v
tau	коэффициент масштабирования преобразования Хаусхолдера
workspace	указатель на рабочее пространство с по крайней мере this->rows() элементами

См. также

MatrixBase::makeHouseholder(), MatrixBase::makeHouseholderInPlace(), MatrixBase::applyHouseholderOnTheLeft()

заменяет *this на other * *this.

Пример:

Matrix3f A = Matrix3f::Random(3,3), B;
B << 0,1,0,  
     0,0,1,  
     1,0,0;
cout << "At start, A = " << endl << A << endl;
A.applyOnTheLeft(B); 
cout << "After applyOnTheLeft, A = " << endl << A << endl;

Вывод:

At start, A = 
  0.68  0.597  -0.33
-0.211  0.823  0.536
 0.566 -0.605 -0.444
After applyOnTheLeft, A = 
-0.211  0.823  0.536
 0.566 -0.605 -0.444
  0.68  0.597  -0.33

Определяется в модуле Jacobi.

#include <Eigen/Jacobi> 

Применяет вращение в плоскости j к строкам p и q матрицы *this, т.е., вычисляет B = J * B, где \( B = \left ( \begin{array}{cc} \text{*this.row}(p) \\ \text{*this.row}(q) \end{array} \right ) \).

См. также

класс JacobiRotation, MatrixBase::applyOnTheRight(), internal::apply_rotation_in_the_plane()

заменяет *this на *this * other. Эквивалентно MatrixBase::operator*=().

Пример:

Matrix3f A = Matrix3f::Random(3,3), B;
B << 0,1,0,  
     0,0,1,  
     1,0,0;
cout << "At start, A = " << endl << A << endl;
A *= B;
cout << "After A *= B, A = " << endl << A << endl;
A.applyOnTheRight(B);  // equivalent to A *= B
cout << "After applyOnTheRight, A = " << endl << A << endl;

Вывод:

At start, A = 
  0.68  0.597  -0.33
-0.211  0.823  0.536
 0.566 -0.605 -0.444
After A *= B, A = 
 -0.33   0.68  0.597
 0.536 -0.211  0.823
-0.444  0.566 -0.605
After applyOnTheRight, A = 
 0.597  -0.33   0.68
 0.823  0.536 -0.211
-0.605 -0.444  0.566

Возвращает

выражение типа Array этой матрицы

См. также

ArrayBase::matrix()

Возвращает

выражение типа const Array этой матрицы

См. также

ArrayBase::matrix()

Возвращает

псевдовыражение диагональной матрицы с *this в качестве вектора диагональных коэффициентов

Это только для векторов (строковых или столбцовых векторов), т.е. матриц, которые известны во время компиляции как имеющие одну строку или один столбец.

Пример:

cout << Matrix3i(Vector3i(2,5,6).asDiagonal()) << endl;

Вывод:

2 0 0
0 5 0
0 0 6

См. также

класс DiagonalWrapper, класс DiagonalMatrix, diagonal(), isDiagonal()

Для этой функции требуется модуль unsupported MatrixFunctions. Для вычисления коэффициентно-wise обратной гиперболической синуса используйте ArrayBase::asinh .

Возвращает

выражение матрицы обратной гиперболической синуса *this.

Для этой функции требуется модуль unsupported MatrixFunctions. Для вычисления коэффициентно-wise обратной гиперболической косинуса используйте ArrayBase::atanh .

Возвращает

выражение матрицы обратной гиперболической косинуса *this.

Это определено в модуле SVD.

#include <Eigen/SVD> 

Возвращает

разложение по сингулярным значениям *this, вычисленное по алгоритму Divide & Conquer

См. также

класс BDCSVD

Возвращает

l2 норму *this с использованием алгоритма Blue's. Портативная Fortran-программа для нахождения евклидовой нормы вектора, ACM TOMS, том 4, выпуск 1, 1978.

Для архитектуры/типов скаляров без векторизации эта версия намного быстрее, чем stableNorm(). В противном случае stableNorm() быстрее.

См. также

norm(), stableNorm(), hypotNorm()

Возвращает

разложение по столбцам QR с помощью преобразования Хаусхолдера *this.

См. также

класс ColPivHouseholderQR

Возвращает

полное ортогональное разложение *this.

См. также

класс CompleteOrthogonalDecomposition

Это определено в модуле LU.

#include <Eigen/LU> 

Вычисление обратной матрицы и определителя с проверкой обратимости.

Только для квадратных матриц фиксированного размера до 4x4.

Обратите внимание, что при попытке выполнить обращение на месте это приведет к копированию входной матрицы.

Параметры

inverse	Ссылка на матрицу, в которую нужно сохранить обратную матрицу.
determinant	Ссылка на переменную, в которую нужно сохранить определитель.
invertible	Ссылка на bool переменную, в которую нужно сохранить, обратима ли матрица.
absDeterminantThreshold	Необязательный параметр, контролирующий проверку обратимости. Матрица будет объявлена обратимой, если абсолютное значение ее определителя больше этого порога.

Пример:

Matrix3d m = Matrix3d::Random();
cout << "Here is the matrix m:" << endl << m << endl;
Matrix3d inverse;
bool invertible;
double determinant;
m.computeInverseAndDetWithCheck(inverse,determinant,invertible);
cout << "Its determinant is " << determinant << endl;
if(invertible) {
  cout << "It is invertible, and its inverse is:" << endl << inverse << endl;
}
else {
  cout << "It is not invertible." << 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 determinant is 0.209
It is invertible, and its inverse is:
-0.199   2.23   2.84
  1.01 -0.555  -1.42
 -1.62   3.59   3.29

См. также

inverse(), computeInverseWithCheck()

Это определено в модуле LU.

#include <Eigen/LU> 

Вычисление обратной матрицы с проверкой обратимости.

Только для квадратных матриц фиксированного размера до 4x4.

Обратите внимание, что при попытке выполнить обращение на месте это приведет к копированию входной матрицы.

Параметры

inverse	Ссылка на матрицу, в которую нужно сохранить обратную матрицу.
invertible	Ссылка на bool переменную, в которую нужно сохранить, обратима ли матрица.
absDeterminantThreshold	Необязательный параметр, контролирующий проверку обратимости. Матрица будет объявлена обратимой, если абсолютное значение ее определителя больше этого порога.

Пример:

Matrix3d m = Matrix3d::Random();
cout << "Here is the matrix m:" << endl << m << endl;
Matrix3d inverse;
bool invertible;
m.computeInverseWithCheck(inverse,invertible);
if(invertible) {
  cout << "It is invertible, and its inverse is:" << endl << inverse << endl;
}
else {
  cout << "It is not invertible." << endl;
}

Вывод:

Here is the matrix m:
  0.68  0.597  -0.33
-0.211  0.823  0.536
 0.566 -0.605 -0.444
It is invertible, and its inverse is:
-0.199   2.23   2.84
  1.01 -0.555  -1.42
 -1.62   3.59   3.29

См. также

inverse(), computeInverseAndDetWithCheck()

Для этой функции требуется модуль unsupported MatrixFunctions. Для вычисления коэффициентно-wise косинуса используйте ArrayBase::cos .

Возвращает

выражение матрицы косинуса *this.

Эта функция требует модуля unsupported MatrixFunctions. Для вычисления поэлементного гиперболического косинуса используйте ArrayBase::cosh.

Возвращает

выражение матричного гиперболического косинуса *this.

Это определено в модуле LU.

#include <Eigen/LU> 

Возвращает

определитель этой матрицы

Возвращает

выражение главной диагонали матрицы *this

Матрица не обязана быть квадратной.

Пример:

Matrix3i m = Matrix3i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here are the coefficients on the main diagonal of m:" << endl
     << m.diagonal() << endl;

Вывод:

Here is the matrix m:
 7  6 -3
-2  9  6
 6 -6 -5
Here are the coefficients on the main diagonal of m:
 7
 9
-5

См. также

класс Diagonal

Возвращает

выражение DiagIndex-й под- или наддиагонали матрицы *this

Матрица не обязана быть квадратной.

Шаблонный параметр DiagIndex представляет наддиагональ, если DiagIndex > 0, и поддиагональ в противном случае. DiagIndex == 0 эквивалентно главной диагонали.

Пример:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here are the coefficients on the 1st super-diagonal and 2nd sub-diagonal of m:" << endl
     << m.diagonal<1>().transpose() << endl
     << m.diagonal<-2>().transpose() << endl;

Вывод:

Here is the matrix m:
 7  9 -5 -3
-2 -6  1  0
 6 -3  0  9
 6  6  3  9
Here are the coefficients on the 1st super-diagonal and 2nd sub-diagonal of m:
9 1 9
6 6

См. также

MatrixBase::diagonal(), класс Diagonal

Это константная версия diagonal().

Это константная версия diagonal<int>().

Возвращает

выражение DiagIndex-й под- или наддиагонали матрицы *this

Матрица не обязана быть квадратной.

Шаблонный параметр DiagIndex представляет наддиагональ, если DiagIndex > 0, и поддиагональ в противном случае. DiagIndex == 0 эквивалентно главной диагонали.

Пример:

Matrix4i m = Matrix4i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here are the coefficients on the 1st super-diagonal and 2nd sub-diagonal of m:" << endl
     << m.diagonal(1).transpose() << endl
     << m.diagonal(-2).transpose() << endl;

Вывод:

Here is the matrix m:
 7  9 -5 -3
-2 -6  1  0
 6 -3  0  9
 6  6  3  9
Here are the coefficients on the 1st super-diagonal and 2nd sub-diagonal of m:
9 1 9
6 6

См. также

MatrixBase::diagonal(), класс Diagonal

Это константная версия diagonal(Index).

Возвращает

размер главной диагонали, который равен min(rows(),cols()).

См. также

rows(), cols(), SizeAtCompileTime.

Возвращает

скалярное произведение *this и other.

Эта функция предназначена только для векторов (строковых или столбцовых), то есть для матриц, у которых размерности известны на этапе компиляции и которые имеют одну строку или один столбец.

Примечание

Если тип скаляра - комплексные числа, то эта функция возвращает эрмитово (сесквилярное) скалярное произведение, конъюгатно-линейное по первому аргументу и линейное по второму.

См. также

squaredNorm(), norm()

Вычисляет собственные значения матрицы.

Возвращает

Столбец со значениями собственных значений.

Это определено в модуле Eigenvalues.

#include <Eigen/Eigenvalues> 

Эта функция вычисляет собственные значения с помощью класса EigenSolver (для вещественных матриц) или класса ComplexEigenSolver (для комплексных матриц).

Собственные значения повторяются в соответствии с их алгебраической кратностью, поэтому их количество равно числу строк в матрице.

Класс SelfAdjointView предоставляет лучший алгоритм для эрмитовых матриц.

Пример:

MatrixXd ones = MatrixXd::Ones(3,3);
VectorXcd eivals = ones.eigenvalues();
cout << "The eigenvalues of the 3x3 matrix of ones are:" << endl << eivals << endl;

Вывод:

The eigenvalues of the 3x3 matrix of ones are:
(-5.31e-17,0)
        (3,0)
        (0,0)

См. также

EigenSolver::eigenvalues(), ComplexEigenSolver::eigenvalues(), SelfAdjointView::eigenvalues()

Эта функция требует модуля unsupported MatrixFunctions. Для вычисления поэлементного экспоненциального значения используйте ArrayBase::exp.

Возвращает

выражение матричной экспоненты *this.

Возвращает

выражение *this с принудительным выравниванием доступа

См. также

forceAlignedAccessIf(), класс ForceAlignedAccess

Возвращает

выражение *this с принудительным выравниванием доступа

См. также

forceAlignedAccessIf(),класс ForceAlignedAccess

Возвращает

выражение *this с принудительным выравниванием доступа, если Enable истинно.

См. также

forceAlignedAccess(), класс ForceAlignedAccess

Возвращает

выражение *this с принудительным выравниванием доступа, если Enable истинно.

См. также

forceAlignedAccess(), класс ForceAlignedAccess

Возвращает

полное разложение QR с выбором главного элемента методом Хаусхолдера для *this.

См. также

класс FullPivHouseholderQR

Определяется в модуле LU.

#include <Eigen/LU> 

Возвращает

полное разложение LU с выбором главного элемента для *this.

См. также

класс FullPivLU

Возвращает

разложение QR методом Хаусхолдера для *this.

См. также

класс HouseholderQR

Возвращает

l2 норму *this, избегая недолива и переполнения. Этот вариант использует цепочку вызовов hypot(), и он очень медленный.

См. также

norm(), stableNorm()

Возвращает

выражение единичной матрицы (не обязательно квадратной).

Этот вариант подходит только для MatrixBase типов фиксированного размера. Для типов динамического размера необходимо использовать вариант с аргументами размера.

Пример:

cout << Matrix<double, 3, 4>::Identity() << endl;

Вывод:

1 0 0 0
0 1 0 0
0 0 1 0

См. также

Identity(Index,Index), setIdentity(), isIdentity()

Возвращает

выражение единичной матрицы (не обязательно квадратной).

Параметры rows и cols — количество строк и столбцов возвращаемой матрицы. Должны быть совместимы с типом MatrixBase.

Этот вариант предназначен для типов матриц динамического размера. Для типов фиксированного размера передача rows и cols избыточна, поэтому следует использовать Identity().

Пример:

cout << MatrixXd::Identity(4, 3) << endl;

Вывод:

1 0 0
0 1 0
0 0 1
0 0 0

См. также

Identity(), setIdentity(), isIdentity()

Определяется в модуле LU.

#include <Eigen/LU> 

Возвращает

обратную матрицу к данной.

Для небольших фиксированных размеров до 4x4 этот метод использует алгебраические дополнения. В общем случае этот метод использует класс PartialPivLU.

Примечание

Данная матрица должна быть обратимой, в противном случае результат неопределён. Если вам нужна проверка обратимости, выполните следующее:

• для фиксированных размеров до 4x4 используйте computeInverseAndDetWithCheck().
• для общего случая используйте класс FullPivLU.

Пример:

Matrix3d m = Matrix3d::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Its inverse is:" << endl << m.inverse() << 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 inverse is:
-0.199   2.23   2.84
  1.01 -0.555  -1.42
 -1.62   3.59   3.29

См. также

computeInverseAndDetWithCheck()

Возвращает

true, если *this приблизительно равен диагональной матрице с точностью, заданной параметром prec.

Пример:

Matrix3d m = 10000 * Matrix3d::Identity();
m(0,2) = 1;
cout << "Here's the matrix m:" << endl << m << endl;
cout << "m.isDiagonal() returns: " << m.isDiagonal() << endl;
cout << "m.isDiagonal(1e-3) returns: " << m.isDiagonal(1e-3) << endl;
 

Вывод:

Here's the matrix m:
1e+04     0     1
    0 1e+04     0
    0     0 1e+04
m.isDiagonal() returns: 0
m.isDiagonal(1e-3) returns: 1

См. также

asDiagonal()

Возвращает

true, если *this приблизительно равен единичной матрице (не обязательно квадратной) с точностью, заданной параметром prec.

Пример:

Matrix3d m = Matrix3d::Identity();
m(0,2) = 1e-4;
cout << "Here's the matrix m:" << endl << m << endl;
cout << "m.isIdentity() returns: " << m.isIdentity() << endl;
cout << "m.isIdentity(1e-3) returns: " << m.isIdentity(1e-3) << endl;

Вывод:

Here's the matrix m:
     1      0 0.0001
     0      1      0
     0      0      1
m.isIdentity() returns: 0
m.isIdentity(1e-3) returns: 1

См. также

класс CwiseNullaryOp, Identity(), Identity(Index,Index), setIdentity()

Возвращает

true, если *this приблизительно равен нижней треугольной матрице с точностью, заданной параметром prec.

См. также

isUpperTriangular()

Возвращает

true, если *this приблизительно ортогональна other с точностью, заданной параметром prec.

Пример:

Vector3d v(1,0,0);
Vector3d w(1e-4,0,1);
cout << "Here's the vector v:" << endl << v << endl;
cout << "Here's the vector w:" << endl << w << endl;
cout << "v.isOrthogonal(w) returns: " << v.isOrthogonal(w) << endl;
cout << "v.isOrthogonal(w,1e-3) returns: " << v.isOrthogonal(w,1e-3) << endl;

Вывод:

Here's the vector v:
1
0
0
Here's the vector w:
0.0001
     0
     1
v.isOrthogonal(w) returns: 0
v.isOrthogonal(w,1e-3) returns: 1

Возвращает

true, если *this приблизительно является унитарной матрицей с точностью, заданной параметром prec. В случае, если тип Scalar - вещественные числа, унитарная матрица является ортогональной матрицей.

Примечание

Это можно использовать для проверки того, образует ли семейство векторов ортонормированный базис. Действительно, m.isUnitary() возвращает true тогда и только тогда, когда столбцы (соответственно, строки) m образуют ортонормированный базис.

Пример:

Matrix3d m = Matrix3d::Identity();
m(0,2) = 1e-4;
cout << "Here's the matrix m:" << endl << m << endl;
cout << "m.isUnitary() returns: " << m.isUnitary() << endl;
cout << "m.isUnitary(1e-3) returns: " << m.isUnitary(1e-3) << endl;

Вывод:

Here's the matrix m:
     1      0 0.0001
     0      1      0
     0      0      1
m.isUnitary() returns: 0
m.isUnitary(1e-3) returns: 1

Возвращает

true, если *this приблизительно равен верхней треугольной матрице с точностью, заданной параметром prec.

См. также

isLowerTriangular()

Определяется в модуле SVD.

#include <Eigen/SVD> 

Возвращает

разложение по сингулярным значениям *this, вычисленное с помощью двусторонних преобразований Якоби.

См. также

класс JacobiSVD

Возвращает

выражение матричного произведения *this и other без неявного вычисления.

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

Предупреждение

Этот вариант матричного произведения может быть намного медленнее. Используйте его только если знаете, что делаете, и измерили реальное улучшение скорости.

См. также

operator*(const MatrixBase&)

Определяется в модуле Cholesky.

#include <Eigen/Cholesky> 

Возвращает

разложение Холецкого с полным поворотом без квадратного корня из *this

См. также

SelfAdjointView::ldlt()

Определяется в модуле Cholesky.

#include <Eigen/Cholesky> 

Возвращает

разложение LLT для *this

См. также

SelfAdjointView::llt()

Эта функция требует модуля unsupported MatrixFunctions. Для вычисления коэффициентного логарифма используйте ArrayBase::log .

Возвращает

выражение матричного логарифма *this.

Возвращает

коэффициентное \( \ell^p \) норма *this, то есть возвращает p-й корень суммы p-х степеней абсолютных значений коэффициентов *this. Если p - специальное значение Eigen::Infinity, эта функция возвращает \( \ell^\infty \) норму, то есть максимальное из абсолютных значений коэффициентов *this.

Во всех случаях, если *this пусто, то возвращается значение 0.

Примечание

Для матриц эта функция не вычисляет операторную норму. То есть, если *this - матрица, то её коэффициенты интерпретируются как 1D вектор. Тем не менее, вы можете легко вычислить 1-норму и \(\infty\)-норму операторных норм матрицы, используя частичные сокращения.

См. также

norm()

Это определено в модуле LU.

#include <Eigen/LU> 

Синоним для partialPivLu().

Возвращает

частичное разложение LU с выбором главного элемента для *this.

См. также

класс PartialPivLU

Вычисляет элементарный отражатель H такой, что: \( H *this = [ beta 0 ... 0]^T \), где преобразование H задаётся как: \( H = I - tau v v^*\) и вектор v определяется как: \( v^T = [1 essential^T] \)

На выходе:

Параметры

essential	существенная часть вектора v
tau	коэффициент масштабирования преобразования Хаусхолдера
beta	результат H * *this

См. также

MatrixBase::makeHouseholderInPlace(), MatrixBase::applyHouseholderOnTheLeft(), MatrixBase::applyHouseholderOnTheRight()

Вычисляет элементарный отражатель H такой, что: \( H *this = [ beta 0 ... 0]^T \), где преобразование H задаётся как: \( H = I - tau v v^*\) и вектор v определяется как: \( v^T = [1 essential^T] \)

Существенная часть вектора v хранится в *this.

На выходе:

Параметры

tau	коэффициент масштабирования преобразования Хаусхолдера
beta	результат H * *this

См. также

MatrixBase::makeHouseholder(), MatrixBase::applyHouseholderOnTheLeft(), MatrixBase::applyHouseholderOnTheRight()

Возвращает

псевдовыражение для *this с оператором =, предполагающим отсутствие алиасинга между *this и исходным выражением.

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

Вот несколько примеров, где noalias полезно:

D.noalias()  = A * B;
D.noalias() += A.transpose() * B;
D.noalias() -= 2 * A * B.adjoint();

С другой стороны, следующий пример приведёт к неправильному результату:

A.noalias() = A * B;

потому что результирующая матрица A также является операндом произведения матриц. Поэтому нет альтернативы, кроме как вычислить A * B во временной переменной, что является стандартным поведением при записи:

A = A * B;

См. также

класс NoAlias

Возвращает

для векторов, l2-норму *this, и для матриц — норму Фробениуса. В обоих случаях это квадратный корень из суммы квадратов всех элементов матрицы. Для векторов это также равно квадратному корню из скалярного произведения *this на себя.

См. также

lpNorm(), dot(), squaredNorm()

Нормализует вектор, т.е. делит его на его собственную норму.

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

Предупреждение

Если входной вектор слишком мал (т.е., this->norm()==0), то *this остается без изменений.

См. также

norm(), normalized()

Возвращает

выражение, равное отношению *this к его собственной норме.

Предупреждение

Если входной вектор слишком мал (т.е., this->norm()==0), то эта функция возвращает копию входных данных.

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

См. также

norm(), normalize()

Возвращает

true, если хотя бы одна пара коэффициентов *this и other не равны друг другу.

Предупреждение

При использовании скаляров с плавающей точкой, вам, вероятно, следует использовать приближенное сравнение, такое как isApprox()

См. также

isApprox(), operator==

Возвращает

произведение диагональной матрицы *this на диагональную матрицу diagonal.

Возвращает

матричное произведение *this и other.

Примечание

Если вместо матричного произведения требуется поэлементное произведение, см. Cwise::operator*().

См. также

lazyProduct(), operator*=(const MatrixBase&), Cwise::operator*()

заменяет *this на *this * other.

Возвращает

ссылку на *this

Пример:

Matrix3f A = Matrix3f::Random(3,3), B;
B << 0,1,0,  
     0,0,1,  
     1,0,0;
cout << "At start, A = " << endl << A << endl;
A *= B;
cout << "After A *= B, A = " << endl << A << endl;
A.applyOnTheRight(B);  // equivalent to A *= B
cout << "After applyOnTheRight, A = " << endl << A << endl;

Вывод:

At start, A = 
  0.68  0.597  -0.33
-0.211  0.823  0.536
 0.566 -0.605 -0.444
After A *= B, A = 
 -0.33   0.68  0.597
 0.536 -0.211  0.823
-0.444  0.566 -0.605
After applyOnTheRight, A = 
 0.597  -0.33   0.68
 0.823  0.536 -0.211
-0.605 -0.444  0.566

заменяет *this на *this + other.

Возвращает

ссылку на *this

заменяет *this на *this - other.

Возвращает

ссылку на *this

Особый случай шаблона operator=, чтобы предотвратить генерацию компилятором стандартного operator= (проблема с g++ 4.1)

Возвращает

true, если все коэффициенты *this и other строго равны.

Предупреждение

При использовании чисел с плавающей точкой, лучше использовать приближенное сравнение, такое как isApprox()

См. также

isApprox(), operator!=

Вычисляет норму оператора L2.

Возвращает

Норму оператора матрицы.

Определено в модуле Eigenvalues.

#include <Eigen/Eigenvalues> 

Эта функция вычисляет норму оператора L2 матрицы, также известную как спектральная норма. Норма матрицы \( A \) определяется как

\[ \|A\|_2 = \max_x \frac{\|Ax\|_2}{\|x\|_2} \]

где максимум берется по всем векторам, а норма справа — евклидова векторная норма. Норма равна наибольшему сингулярному значению, которое является квадратным корнем наибольшего собственного значения положительно полуопределённой матрицы \( A^*A \).

Текущая реализация использует собственные значения \( A^*A \), вычисленные с помощью SelfAdjointView::eigenvalues(), для вычисления нормы оператора матрицы. Класс SelfAdjointView предлагает более эффективный алгоритм для самосопряжённых матриц.

Пример:

MatrixXd ones = MatrixXd::Ones(3,3);
cout << "The operator norm of the 3x3 matrix of ones is "
     << ones.operatorNorm() << endl;

Вывод:

The operator norm of the 3x3 matrix of ones is 3

См. также

SelfAdjointView::eigenvalues(), SelfAdjointView::operatorNorm()

Определено в модуле LU.

#include <Eigen/LU> 

Возвращает

разложение LU с частичным выбором ведущих элементов для *this.

См. также

класс PartialPivLU

Для данной функции требуется модуль unsupported MatrixFunctions. Для вычисления поэлементной степени p используйте ArrayBase::pow .

Возвращает

выражение степени матрицы в степени p для *this.

Для данной функции требуется модуль unsupported MatrixFunctions. Для вычисления поэлементной степени p используйте ArrayBase::pow .

Возвращает

выражение степени матрицы в степени p для *this.

Возвращает

выражение симметричного/самосопряжённого вида, извлечённого из верхней или нижней треугольной части текущей матрицы

Параметр UpLo может быть либо Upper либо Lower

Пример:

Matrix3i m = Matrix3i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the symmetric matrix extracted from the upper part of m:" << endl
     << Matrix3i(m.selfadjointView<Upper>()) << endl;
cout << "Here is the symmetric matrix extracted from the lower part of m:" << endl
     << Matrix3i(m.selfadjointView<Lower>()) << endl;

Вывод:

Here is the matrix m:
 7  6 -3
-2  9  6
 6 -6 -5
Here is the symmetric matrix extracted from the upper part of m:
 7  6 -3
 6  9  6
-3  6 -5
Here is the symmetric matrix extracted from the lower part of m:
 7 -2  6
-2  9 -6
 6 -6 -5

См. также

класс SelfAdjointView

Это версия MatrixBase::selfadjointView() с ключевым словом const

Записывает единичное выражение (не обязательно квадратное) в *this.

Пример:

Matrix4i m = Matrix4i::Zero();
m.block<3,3>(1,0).setIdentity();
cout << m << endl;

Вывод:

0 0 0 0
1 0 0 0
0 1 0 0
0 0 1 0

См. также

класс CwiseNullaryOp, Identity(), Identity(Index,Index), isIdentity()

Изменяет размер до указанного размера и записывает единичное выражение (не обязательно квадратное) в *this.

Параметры

rows	новое количество строк
cols	новое количество столбцов

Пример:

MatrixXf m;
m.setIdentity(3, 3);
cout << m << endl;

Вывод:

1 0 0
0 1 0
0 0 1

См. также

MatrixBase::setIdentity(), класс CwiseNullaryOp, MatrixBase::Identity()

Устанавливает коэффициенты *this в i-й единичный (базисный) вектор.

Параметры

i	индекс уникального коэффициента, который необходимо установить в 1

Это относится только к векторам (строковым или столбцовым векторам), т.е. матрицам, у которых в момент компиляции известно, что у них либо одна строка, либо один столбец.

См. также

MatrixBase::setIdentity(), класс CwiseNullaryOp, MatrixBase::Unit(Index,Index)

Изменяет размер до заданного newSize и записывает i-й единичный (базисный) вектор в *this.

Параметры

newSize	новый размер вектора
i	индекс уникального коэффициента, который нужно установить в 1

Это относится только к векторам (строковым или столбцовым векторам), т.е. матрицам, у которых в момент компиляции известно, что у них либо одна строка, либо один столбец.

См. также

MatrixBase::setIdentity(), класс CwiseNullaryOp, MatrixBase::Unit(Index,Index)

Эта функция требует модуля unsupported MatrixFunctions. Для вычисления синуса по коэффициентам используйте ArrayBase::sin .

Возвращает

выражение синуса матрицы *this.

Эта функция требует модуля unsupported MatrixFunctions. Для вычисления гиперболического синуса по коэффициентам используйте ArrayBase::sinh .

Возвращает

выражение гиперболического синуса матрицы *this.

Эта функция требует модуля unsupported MatrixFunctions. Для вычисления квадратного корня по коэффициентам используйте ArrayBase::sqrt .

Возвращает

выражение квадратного корня матрицы *this.

Возвращает

для векторов, квадрат норму l2 *this, а для матриц — квадрат норму Фробениуса. В обоих случаях, это сумма квадратов всех элементов матрицы. Для векторов это также равно скалярному произведению *this на себя.

См. также

dot(), norm(), lpNorm()

Возвращает

норму l2 *this, избегая подпотока и переполнения. Эта версия использует алгоритм блочного двухпроходного: 1 - найти абсолютный наибольший коэффициент s 2 - вычислить \( s \Vert \frac{*this}{s} \Vert \) стандартным способом

Для архитектур/типов скаляров, поддерживающих векторизацию, эта версия быстрее, чем blueNorm(). В противном случае blueNorm() намного быстрее.

См. также

norm(), blueNorm(), hypotNorm()

Нормализует вектор, избегая подпотока и переполнения

Это относится только к векторам (строковым или столбцовым векторам), т.е. матрицам, у которых в момент компиляции известно, что у них либо одна строка, либо один столбец.

Этот метод аналогичен методу normalize(), но он снижает риск подпотока и переполнения при вычислении нормы.

Предупреждение

Если входной вектор слишком мал (т.е., this->norm()==0), то *this остается неизменным.

См. также

stableNorm(), stableNormalized(), normalize()

Возвращает

выражение частного от *this к его собственной норме, избегая подпотоков и переполнений.

Это предназначено только для векторов (строчных или столбцовых), то есть матриц, которые на этапе компиляции известны как имеющие одну строку или один столбец.

Этот метод аналогичен методу normalized(), но он снижает риск подпотоков и переполнений при вычислении нормы.

Предупреждение

Если входной вектор слишком мал (т. е., this->norm()==0), то эта функция возвращает копию входного значения.

См. также

stableNorm(), stableNormalize(), normalized()

Возвращает

след *this, т. е. сумму коэффициентов по главной диагонали.

*this может быть любой матрицей, необязательно квадратной.

См. также

diagonal(), sum()

Возвращает

выражение треугольного вида, извлеченного из текущей матрицы

Параметр Mode может иметь следующие значения: Upper, StrictlyUpper, UnitUpper, Lower, StrictlyLower, UnitLower.

Пример:

Matrix3i m = Matrix3i::Random();
cout << "Here is the matrix m:" << endl << m << endl;
cout << "Here is the upper-triangular matrix extracted from m:" << endl
     << Matrix3i(m.triangularView<Eigen::Upper>()) << endl;
cout << "Here is the strictly-upper-triangular matrix extracted from m:" << endl
     << Matrix3i(m.triangularView<Eigen::StrictlyUpper>()) << endl;
cout << "Here is the unit-lower-triangular matrix extracted from m:" << endl
     << Matrix3i(m.triangularView<Eigen::UnitLower>()) << endl;
// FIXME need to implement output for triangularViews (Bug 885)

Вывод:

Here is the matrix m:
 7  6 -3
-2  9  6
 6 -6 -5
Here is the upper-triangular matrix extracted from m:
 7  6 -3
 0  9  6
 0  0 -5
Here is the strictly-upper-triangular matrix extracted from m:
 0  6 -3
 0  0  6
 0  0  0
Here is the unit-lower-triangular matrix extracted from m:
 1  0  0
-2  1  0
 6 -6  1

См. также

класс TriangularView

Это версия MatrixBase::triangularView() с const.

Возвращает

выражение i-го единичного (базисного) вектора.

Это предназначено только для векторов (строчных или столбцовых), то есть матриц, которые на этапе компиляции известны как имеющие одну строку или один столбец.

Этот вариант предназначен только для векторов фиксированного размера.

См. также

MatrixBase::Unit(Index,Index), MatrixBase::UnitX(), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()

Возвращает

выражение i-го единичного (базисного) вектора.

Это предназначено только для векторов (строчных или столбцовых), то есть матриц, которые на этапе компиляции известны как имеющие одну строку или один столбец.

См. также

MatrixBase::Unit(Index), MatrixBase::UnitX(), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()

Возвращает

выражение единичного вектора оси W (0,0,0,1)

Это предназначено только для векторов (строчных или столбцовых), то есть матриц, которые на этапе компиляции известны как имеющие одну строку или один столбец.

См. также

MatrixBase::Unit(Index,Index), MatrixBase::Unit(Index), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()

Возвращает

выражение единичного вектора оси X (1{,0}^*)

Это предназначено только для векторов (строчных или столбцовых), то есть матриц, которые на этапе компиляции известны как имеющие одну строку или один столбец.

См. также

MatrixBase::Unit(Index,Index), MatrixBase::Unit(Index), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()

Возвращает

выражение единичного вектора оси Y (0,1{,0}^*)

Это предназначено только для векторов (строчных или столбцовых), то есть матриц, которые на этапе компиляции известны как имеющие одну строку или один столбец.

См. также

MatrixBase::Unit(Index,Index), MatrixBase::Unit(Index), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()

Возвращает

выражение единичного вектора оси Z (0,0,1{,0}^*)

Это предназначено только для векторов (строчных или столбцовых), то есть матриц, которые на этапе компиляции известны как имеющие одну строку или один столбец.

См. также

MatrixBase::Unit(Index,Index), MatrixBase::Unit(Index), MatrixBase::UnitY(), MatrixBase::UnitZ(), MatrixBase::UnitW()