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

#include <DenseHermMatProd.h>

Public Types
using	Scalar = Scalar_

Public Member Functions
Index	cols () const
template<typename Derived >
	DenseHermMatProd (const Eigen::MatrixBase< Derived > &mat)
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::DenseHermMatProd< Scalar_, Uplo, Flags >

This class defines the matrix-vector multiplication operation on a Hermitian complex matrix , i.e., calculating for any vector . It is mainly used in the HermEigsSolver eigen solver.

Template Parameters

Scalar_	The element type of the matrix, for example, std::complex<float>, std::complex<double>, and std::complex<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 30 of file DenseHermMatProd.h.

Member Typedef Documentation

ConstGenericMatrix

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

using Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::ConstGenericMatrix = const Eigen::Ref<const Matrix>

private

Definition at line 44 of file DenseHermMatProd.h.

Index

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

using Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::Index = Eigen::Index

private

Definition at line 39 of file DenseHermMatProd.h.

MapConstVec

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

using Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::MapConstVec = Eigen::Map<const Vector>

private

Definition at line 42 of file DenseHermMatProd.h.

MapVec

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

using Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::MapVec = Eigen::Map<Vector>

private

Definition at line 43 of file DenseHermMatProd.h.

Matrix

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

using Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::Matrix = Eigen::Matrix<Scalar, Eigen::Dynamic, Eigen::Dynamic, Flags>

private

Definition at line 40 of file DenseHermMatProd.h.

Scalar

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

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

Element type of the matrix.

Definition at line 36 of file DenseHermMatProd.h.

Vector

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

using Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::Vector = Eigen::Matrix<Scalar, Eigen::Dynamic, 1>

private

Definition at line 41 of file DenseHermMatProd.h.

Constructor & Destructor Documentation

DenseHermMatProd()

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

template<typename Derived >

Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::DenseHermMatProd ( 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::MatrixXcd and Eigen::MatrixXcf), or its mapped version (e.g. Eigen::Map<Eigen::MatrixXcd>).

Definition at line 58 of file DenseHermMatProd.h.

Member Function Documentation

cols()

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

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

inline

Return the number of columns of the underlying matrix.

Definition at line 73 of file DenseHermMatProd.h.

perform_op()

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

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

inline

Perform the matrix-vector multiplication operation .

Parameters

x_in	Pointer to the vector.
y_out	Pointer to the vector.

Definition at line 82 of file DenseHermMatProd.h.

rows()

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

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

inline

Return the number of rows of the underlying matrix.

Definition at line 69 of file DenseHermMatProd.h.

Member Data Documentation

m_mat

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

ConstGenericMatrix Spectra::DenseHermMatProd< Scalar_, Uplo, Flags >::m_mat

private

Definition at line 46 of file DenseHermMatProd.h.

---

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

• DenseHermMatProd.h