irlba
A C++ library for IRLBA
Loading...
Searching...
No Matches
Public Member Functions | List of all members
irlba::Centered< Matrix_, EigenVector_ > Class Template Reference

Wrapper for a centered matrix. More...

#include <wrappers.hpp>

Public Member Functions

 Centered (const Matrix_ &matrix, const EigenVector_ &center)
 

Detailed Description

template<class Matrix_, class EigenVector_>
class irlba::Centered< Matrix_, EigenVector_ >

Wrapper for a centered matrix.

Template Parameters
Matrix_Class satisfying the MockMatrix interface, or a floating-point Eigen::Matrix.
EigenVector_A floating-point Eigen::Vector class for the column centers and matrix-vector product.

This class computes the matrix-vector product after centering all columns in Matrix_, i.e., subtracting the mean of each column from the values of that column. Naively doing such an operation would involve loss of sparsity, which we avoid by deferring the subtraction into the subspace defined by rhs.

This class satisfies the MockMatrix interface and implements all of its methods/typedefs.

Constructor & Destructor Documentation

◆ Centered()

irlba::Centered< Matrix_, EigenVector_ >::Centered ( const Matrix_ matrix,
const EigenVector_ center 
)
inline
Parameters
matrixMatrix to be column-centered.
centerVector of length equal to the number of columns of matrix, containing the value to subtract from each column.

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