Spectra::DenseCholesky< Scalar_, Uplo, Flags > Class Template Reference

#include <Spectra/MatOp/DenseCholesky.h>

Public Types
using	Scalar = Scalar_

Public Member Functions
template<typename Derived >
	DenseCholesky (const Eigen::MatrixBase< Derived > &mat)
Index	rows () const
Index	cols () const
CompInfo	info () const
void	lower_triangular_solve (const Scalar *x_in, Scalar *y_out) const
void	upper_triangular_solve (const Scalar *x_in, Scalar *y_out) const

Detailed Description

template<typename Scalar_, int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
class Spectra::DenseCholesky< Scalar_, Uplo, Flags >

This class defines the operations related to Cholesky decomposition on a positive definite matrix, \(B=LL'\), where \(L\) is a lower triangular matrix. It is mainly used in the SymGEigsSolver generalized eigen solver in the Cholesky decomposition mode.

Template Parameters

Scalar_	The element type of the matrix, for example, float, double, and long double.
Uplo	Either Eigen::Lower or Eigen::Upper, indicating which triangular part of the matrix is used.
Flags	Either Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.

Definition at line 34 of file DenseCholesky.h.

Member Typedef Documentation

Scalar

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>

using Spectra::DenseCholesky< Scalar_, Uplo, Flags >::Scalar = Scalar_

Element type of the matrix.

Definition at line 40 of file DenseCholesky.h.

Constructor & Destructor Documentation

DenseCholesky()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>

template<typename Derived >

Spectra::DenseCholesky< Scalar_, Uplo, Flags >::DenseCholesky ( const Eigen::MatrixBase< Derived > &  mat )

inline

Constructor to create the matrix operation object.

Parameters

mat	An Eigen matrix object, whose type can be Eigen::Matrix<Scalar, ...> (e.g. Eigen::MatrixXd and Eigen::MatrixXf), or its mapped version (e.g. Eigen::Map<Eigen::MatrixXd>).

Definition at line 63 of file DenseCholesky.h.

Member Function Documentation

rows()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>

Index Spectra::DenseCholesky< Scalar_, Uplo, Flags >::rows ( ) const

inline

Returns the number of rows of the underlying matrix.

Definition at line 82 of file DenseCholesky.h.

cols()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>

Index Spectra::DenseCholesky< Scalar_, Uplo, Flags >::cols ( ) const

inline

Returns the number of columns of the underlying matrix.

Definition at line 86 of file DenseCholesky.h.

info()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>

CompInfo Spectra::DenseCholesky< Scalar_, Uplo, Flags >::info ( ) const

inline

Returns the status of the computation. The full list of enumeration values can be found in Enumerations.

Definition at line 92 of file DenseCholesky.h.

lower_triangular_solve()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>

void Spectra::DenseCholesky< Scalar_, Uplo, Flags >::lower_triangular_solve ( const Scalar *  x_in, Scalar *  y_out  ) const

inline

Performs the lower triangular solving operation \(y=L^{-1}x\).

Parameters

x_in	Pointer to the \(x\) vector.
y_out	Pointer to the \(y\) vector.

Definition at line 101 of file DenseCholesky.h.

upper_triangular_solve()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>

void Spectra::DenseCholesky< Scalar_, Uplo, Flags >::upper_triangular_solve ( const Scalar *  x_in, Scalar *  y_out  ) const

inline

Performs the upper triangular solving operation \(y=(L')^{-1}x\).

Parameters

x_in	Pointer to the \(x\) vector.
y_out	Pointer to the \(y\) vector.

Definition at line 115 of file DenseCholesky.h.

---

The documentation for this class was generated from the following file:

• Spectra/MatOp/DenseCholesky.h