Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
Spectra::DenseSymMatProd< Scalar_, Uplo, Flags > Class Template Reference
Matrix Operations

#include <DenseSymMatProd.h>

Public Types

using Scalar = Scalar_
 

Public Member Functions

Index cols () const
 
template<typename Derived >
 DenseSymMatProd (const Eigen::MatrixBase< Derived > &mat)
 
Scalar operator() (Index i, Index j) const
 
Matrix operator* (const Eigen::Ref< const Matrix > &mat_in) const
 
void perform_op (const Scalar *x_in, Scalar *y_out) const
 
Index rows () const
 

Private Types

using ConstGenericMatrix = const Eigen::Ref< const Matrix >
 
using Index = Eigen::Index
 
using MapConstVec = Eigen::Map< const Vector >
 
using MapVec = Eigen::Map< Vector >
 
using Matrix = Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic, Flags >
 
using Vector = Eigen::Matrix< Scalar, Eigen::Dynamic, 1 >
 

Private Attributes

ConstGenericMatrix m_mat
 

Detailed Description

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

This class defines the matrix-vector multiplication operation on a symmetric real matrix $A$, i.e., calculating $y=Ax$ for any vector $x$. It is mainly used in the SymEigsSolver eigen solver.

Template Parameters
Scalar_The element type of the matrix, for example, float, double, and long double.
UploEither Eigen::Lower or Eigen::Upper, indicating which triangular part of the matrix is used.
FlagsEither Eigen::ColMajor or Eigen::RowMajor, indicating the storage format of the input matrix.

Definition at line 29 of file DenseSymMatProd.h.

Member Typedef Documentation

◆ ConstGenericMatrix

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::ConstGenericMatrix = const Eigen::Ref<const Matrix>
private

Definition at line 43 of file DenseSymMatProd.h.

◆ Index

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::Index = Eigen::Index
private

Definition at line 38 of file DenseSymMatProd.h.

◆ MapConstVec

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::MapConstVec = Eigen::Map<const Vector>
private

Definition at line 41 of file DenseSymMatProd.h.

◆ MapVec

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::MapVec = Eigen::Map<Vector>
private

Definition at line 42 of file DenseSymMatProd.h.

◆ Matrix

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic, Flags>
private

Definition at line 39 of file DenseSymMatProd.h.

◆ Scalar

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::Scalar = Scalar_

Element type of the matrix.

Definition at line 35 of file DenseSymMatProd.h.

◆ Vector

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
using Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::Vector = Eigen::Matrix<Scalar, Eigen::Dynamic, 1>
private

Definition at line 40 of file DenseSymMatProd.h.

Constructor & Destructor Documentation

◆ DenseSymMatProd()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
template<typename Derived >
Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::DenseSymMatProd ( const Eigen::MatrixBase< Derived > &  mat)
inline

Constructor to create the matrix operation object.

Parameters
matAn 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 57 of file DenseSymMatProd.h.

Member Function Documentation

◆ cols()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
Index Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::cols ( ) const
inline

Return the number of columns of the underlying matrix.

Definition at line 72 of file DenseSymMatProd.h.

◆ operator()()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
Scalar Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::operator() ( Index  i,
Index  j 
) const
inline

Extract (i,j) element of the underlying matrix.

Definition at line 99 of file DenseSymMatProd.h.

◆ operator*()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
Matrix Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::operator* ( const Eigen::Ref< const Matrix > &  mat_in) const
inline

Perform the matrix-matrix multiplication operation $y=Ax$.

Definition at line 91 of file DenseSymMatProd.h.

◆ perform_op()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
void Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::perform_op ( const Scalar *  x_in,
Scalar *  y_out 
) const
inline

Perform the matrix-vector multiplication operation $y=Ax$.

Parameters
x_inPointer to the $x$ vector.
y_outPointer to the $y$ vector.

Definition at line 81 of file DenseSymMatProd.h.

◆ rows()

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
Index Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::rows ( ) const
inline

Return the number of rows of the underlying matrix.

Definition at line 68 of file DenseSymMatProd.h.

Member Data Documentation

◆ m_mat

template<typename Scalar_ , int Uplo = Eigen::Lower, int Flags = Eigen::ColMajor>
ConstGenericMatrix Spectra::DenseSymMatProd< Scalar_, Uplo, Flags >::m_mat
private

Definition at line 45 of file DenseSymMatProd.h.

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

gtsam
Author(s):
autogenerated on Wed May 28 2025 03:15:49