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

Workspace class for multiplying a transposed CenteredMatrix. More...

#include <centered.hpp>

Inheritance diagram for irlba::CenteredAdjointWorkspace< EigenVector_, Matrix_, Center_ >:
Collaboration diagram for irlba::CenteredAdjointWorkspace< EigenVector_, Matrix_, Center_ >:

Public Member Functions

void multiply (const EigenVector_ &right, EigenVector_ &out)
 
- Public Member Functions inherited from irlba::AdjointWorkspace< EigenVector_ >

Detailed Description

template<class EigenVector_, class Matrix_, class Center_>
class irlba::CenteredAdjointWorkspace< EigenVector_, Matrix_, Center_ >

Workspace class for multiplying a transposed CenteredMatrix.

Template Parameters
EigenVector_A floating-point Eigen::Vector to be used as input/output of the multiplication.
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_adjoint_workspace().

Member Function Documentation

◆ multiply()

template<class EigenVector_ , class Matrix_ , class Center_ >
void irlba::CenteredAdjointWorkspace< EigenVector_, Matrix_, Center_ >::multiply ( const EigenVector_ & right,
EigenVector_ & output )
inlinevirtual
Parameters
[in]rightThe right-hand side of the matrix product.
[out]outputThe output vector to store the matrix product. This is filled with the product of the transpose of this matrix and rhs.

This method will be called without any explicit template arguments, so implementations do not need to use the same number/order of template parameters. EigenVector_ may also be a template parameter of the class rather than the method. depending on what is most convenient for defining the associated AdjointWorkspace.

Implements irlba::AdjointWorkspace< EigenVector_ >.


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