irlba
A C++ library for IRLBA
Loading...
Searching...
No Matches
irlba::CenteredRealizeWorkspace< EigenMatrix_, Matrix_, Center_ > Class Template Referencefinal

Workspace class for realizing a CenteredMatrix. More...

#include <centered.hpp>

Inheritance diagram for irlba::CenteredRealizeWorkspace< EigenMatrix_, Matrix_, Center_ >:
Collaboration diagram for irlba::CenteredRealizeWorkspace< EigenMatrix_, Matrix_, Center_ >:

Public Member Functions

const EigenMatrix_ & realize (EigenMatrix_ &buffer)
 
- Public Member Functions inherited from irlba::RealizeWorkspace< EigenMatrix_ >
void realize_copy (EigenMatrix_ &buffer)
 

Detailed Description

template<class EigenMatrix_, class Matrix_, class Center_>
class irlba::CenteredRealizeWorkspace< EigenMatrix_, Matrix_, Center_ >

Workspace class for realizing a CenteredMatrix.

Template Parameters
EigenMatrix_A dense floating-point Eigen::Matrix in which to store the realized matrix.
Matrix_Class of the matrix to be centered, as referenced by the CenteredMatrix.
Center_An Eigen vector class, to hold the column centers.

Typically constructed by CenteredMatrix::new_realize_workspace().

Member Function Documentation

◆ realize()

template<class EigenMatrix_ , class Matrix_ , class Center_ >
const EigenMatrix_ & irlba::CenteredRealizeWorkspace< EigenMatrix_, Matrix_, Center_ >::realize ( EigenMatrix_ & buffer)
inlinevirtual
Parameters
bufferBuffer in which to optionally store the realized matrix.
Returns
Reference to a realized matrix. This may refer to buffer or some other object.

Implements irlba::RealizeWorkspace< EigenMatrix_ >.


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