![]() |
Eigen
5.0.1-dev+master
|
#include <Eigen/src/Core/SelfAdjointView.h>
Expression of a selfadjoint matrix from a triangular part of a dense matrix.
| MatrixType | the type of the dense matrix storing the coefficients |
| TriangularPart | can be either Lower or Upper |
This class is an expression of a selfadjoint matrix from a triangular part of a matrix with given dense storage of the coefficients. It is the return type of MatrixBase::selfadjointView() and most of the time this is the only way that it is used.
Inheritance diagram for Eigen::SelfAdjointView< MatrixType_, UpLo >:Public Types | |
| using | EigenvaluesReturnType |
| using | RealScalar |
| using | Scalar |
| The type of coefficients in this matrix. | |
Public Types inherited from Eigen::TriangularBase< SelfAdjointView< MatrixType_, UpLo > > | |
Public Types inherited from Eigen::EigenBase< SelfAdjointView< MatrixType_, UpLo > > | |
| using | Index |
| The interface type of indices. | |
Public Member Functions | |
| template<typename PermutationDerived> | |
| SelfAdjointView & | applyPermutation (const InverseImpl< PermutationDerived, PermutationStorage > &permutation) |
| template<typename PermutationDerived> | |
| SelfAdjointView & | applyPermutation (const PermutationBase< PermutationDerived > &permutation) |
| template<typename TranspositionsDerived> | |
| SelfAdjointView & | applyPermutation (const Transpose< TranspositionsBase< TranspositionsDerived > > &transpositions) |
| template<typename TranspositionsDerived> | |
| SelfAdjointView & | applyPermutation (const TranspositionsBase< TranspositionsDerived > &transpositions) |
| SelfAdjointView & | applyTransposition (Index i, Index j) |
| BunchKaufman< PlainObject, UpLo > | bunchKaufman () const |
| MatrixType::ConstDiagonalReturnType | diagonal () const |
| EigenvaluesReturnType | eigenvalues () const |
| Computes the eigenvalues of a matrix. | |
| RealScalar | l1Norm () const |
| LDLT< PlainObject, UpLo > | ldlt () const |
| LLT< PlainObject, UpLo > | llt () const |
| const Product< SelfAdjointView, Inverse< OtherDerived > > | operator* (const InverseImpl< OtherDerived, PermutationStorage > &rhs) const |
| const Product< SelfAdjointView, OtherDerived > | operator* (const PermutationBase< OtherDerived > &rhs) const |
| const Product< SelfAdjointView, OtherDerived > | operator* (const TriangularBase< OtherDerived > &rhs) const |
| SelfAdjointView & | operator*= (const Scalar &other) |
| template<typename OtherDerived> | |
| SelfAdjointView & | operator+= (const DenseBase< OtherDerived > &other) |
| template<typename OtherDerived> | |
| SelfAdjointView & | operator-= (const DenseBase< OtherDerived > &other) |
| SelfAdjointView & | operator/= (const Scalar &other) |
| template<typename OtherDerived> | |
| SelfAdjointView & | operator= (const MatrixBase< OtherDerived > &other) |
| template<typename OtherDerived> | |
| SelfAdjointView & | operator= (const TriangularBase< OtherDerived > &other) |
| RealScalar | operatorNorm () const |
| Computes the L2 operator norm. | |
| template<typename DerivedU, typename DerivedV> | |
| SelfAdjointView & | rankUpdate (const MatrixBase< DerivedU > &u, const MatrixBase< DerivedV > &v, const Scalar &alpha=Scalar(1)) |
| template<typename DerivedU> | |
| SelfAdjointView & | rankUpdate (const MatrixBase< DerivedU > &u, const Scalar &alpha=Scalar(1)) |
| template<unsigned int TriMode> | |
| std::conditional_t<(TriMode &(Upper|Lower))==(UpLo &(Upper|Lower)), TriangularView< MatrixType, TriMode >, TriangularView< typename MatrixType::AdjointReturnType, TriMode > > | triangularView () const |
Public Member Functions inherited from Eigen::TriangularBase< SelfAdjointView< MatrixType_, UpLo > > | |
| const AdjointReturnType | adjoint () const |
| Scalar | coeff (Index row, Index col) const |
| Scalar & | coeffRef (Index row, Index col) |
| const ConjugateReturnType | conjugate () const |
| std::conditional_t< Cond, ConjugateReturnType, ConstView > | conjugateIf () const |
| void | copyCoeff (Index row, Index col, Other &other) |
| void | evalTo (MatrixBase< DenseDerived > &other) const |
| void | evalToLazy (MatrixBase< DenseDerived > &other) const |
| void | fill (const Scalar &value) |
| Scalar & | operator() (Index row, Index col) |
| Scalar | operator() (Index row, Index col) const |
| const Product< SelfAdjointView< MatrixType_, UpLo >, Inverse< OtherDerived > > | operator* (const InverseImpl< OtherDerived, PermutationStorage > &rhs) const |
| const Product< SelfAdjointView< MatrixType_, UpLo >, OtherDerived > | operator* (const PermutationBase< OtherDerived > &rhs) const |
| const Product< SelfAdjointView< MatrixType_, UpLo >, OtherDerived > | operator* (const TriangularBase< OtherDerived > &rhs) const |
| auto | operator+ (const DiagonalBase< OtherDerived > &other) const |
| auto | operator- (const DiagonalBase< OtherDerived > &other) const |
| SelfAdjointView< MatrixType_, UpLo > & | setConstant (const Scalar &value) |
| SelfAdjointView< MatrixType_, UpLo > & | setIdentity () |
| SelfAdjointView< MatrixType_, UpLo > & | setOnes () |
| SelfAdjointView< MatrixType_, UpLo > & | setRandom () |
| SelfAdjointView< MatrixType_, UpLo > & | setZero () |
| TransposeReturnType | transpose () |
| const ConstTransposeReturnType | transpose () const |
Public Member Functions inherited from Eigen::EigenBase< SelfAdjointView< MatrixType_, UpLo > > | |
| constexpr Index | cols () const noexcept |
| constexpr SelfAdjointView< MatrixType_, UpLo > & | derived () |
| constexpr const SelfAdjointView< MatrixType_, UpLo > & | derived () const |
| constexpr Index | rows () const noexcept |
| constexpr Index | size () const noexcept |
| using Eigen::SelfAdjointView< MatrixType_, UpLo >::EigenvaluesReturnType |
Return type of eigenvalues()
| using Eigen::SelfAdjointView< MatrixType_, UpLo >::RealScalar |
Real part of Scalar
|
inline |
Applies an inverse (or transposed) permutation in place.
|
inline |
Replaces this view's matrix \( S \) by \( P S P^T \) in place, where permutation represents \( P \). Only the referenced triangle is read or written; the opposite triangle is unchanged. Complex coefficients crossing the diagonal are conjugated. The matrix must be square and the permutation must have matching size. The operation takes \( O(n^2) \) time and \( O(n) \) auxiliary storage for a copy of the permutation.
*this, retaining its self-adjoint structure.
|
inline |
Applies an inverse (or transposed) sequence of transpositions in place.
|
inline |
Applies the permutation represented by a sequence of transpositions in place. The indices are copied before any matrix writes, including when they alias the matrix. The operation takes \( O(n^2) \) time and \( O(n) \) auxiliary storage.
|
inline |
Interchanges rows and columns i and j of this self-adjoint view in place. Only the referenced triangle is read or written; complex coefficients crossing the diagonal are conjugated. The matrix must be square and both indices must lie in [0, rows()). Equal indices leave the view unchanged. The operation takes \( O(n) \) time and \( O(1) \) auxiliary storage, without heap allocation.
*this.
|
inline |
This is defined in the Cholesky module.
*this
|
inline |
*this This method simply returns the diagonal of the nested expression, thus by-passing the SelfAdjointView decorator.
|
inline |
Computes the eigenvalues of a matrix.
This is defined in the Eigenvalues module.
This function computes the eigenvalues with the help of the SelfAdjointEigenSolver class. The eigenvalues are repeated according to their algebraic multiplicity, so there are as many eigenvalues as rows in the matrix.
Example:
Output:
The eigenvalues of the 3x3 matrix of ones are:
-2.22e-16
0
3
|
inline |
|
inline |
This is defined in the Cholesky module.
*this
|
inline |
This is defined in the Cholesky module.
*this
|
inline |
*this with the inverse permutation rhs applied to its columns.
|
inline |
*this with the permutation rhs applied to its columns.
|
inline |
*this by the triangular or self-adjoint view rhs.The right factor is evaluated into a dense temporary and the product runs the kernel of *this times a dense matrix. The result is a plain dense expression even when the structure would be preserved, as for two upper triangular factors.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Assigns a matrix expression to the referenced triangular part of the selfadjoint matrix.
|
inline |
Assigns a triangular or selfadjoint expression without materializing a dense temporary.
|
inline |
Computes the L2 operator norm.
This is defined in the Eigenvalues module.
This function computes the L2 operator norm of a self-adjoint matrix. For a self-adjoint matrix, the operator norm is the largest eigenvalue.
The current implementation uses the eigenvalues of the matrix, as computed by eigenvalues(), to compute the operator norm of the matrix.
Example:
Output:
The operator norm of the 3x3 matrix of ones is 3
| SelfAdjointView & Eigen::SelfAdjointView< MatrixType_, UpLo >::rankUpdate | ( | const MatrixBase< DerivedU > & | u, |
| const MatrixBase< DerivedV > & | v, | ||
| const Scalar & | alpha = Scalar(1) ) |
Perform a symmetric rank 2 update of the selfadjoint matrix *this: \( this = this + \alpha u v^* + conj(\alpha) v u^* \)
*this The vectors u and v must be column vectors, however they can be an adjoint expression without any overhead. Only the meaningful triangular part of the matrix is updated, the rest is left unchanged.
| SelfAdjointView & Eigen::SelfAdjointView< MatrixType_, UpLo >::rankUpdate | ( | const MatrixBase< DerivedU > & | u, |
| const Scalar & | alpha = Scalar(1) ) |
Perform a symmetric rank K update of the selfadjoint matrix *this: \( this = this + \alpha ( u u^* ) \) where u is a vector or matrix.
*this Note that to perform \( this = this + \alpha ( u^* u ) \) you can simply call this function with u.adjoint().
|
inline |
The parameter TriMode can have the following values: Upper, StrictlyUpper, UnitUpper, Lower, StrictlyLower, UnitLower.
If TriMode references the same triangular part than *this, then this method simply return a TriangularView of the nested expression, otherwise, the nested expression is first transposed, thus returning a TriangularView<Transpose<MatrixType>> object.