irlba::ScaledRealizeWorkspace< EigenMatrix_, Matrix_, Scale_ > Class Template Reference

Workspace class for realizing a ScaledMatrix. More...

#include <scaled.hpp>

Inheritance diagram for irlba::ScaledRealizeWorkspace< EigenMatrix_, Matrix_, Scale_ >:

Collaboration diagram for irlba::ScaledRealizeWorkspace< EigenMatrix_, Matrix_, Scale_ >:

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 Scale_>
class irlba::ScaledRealizeWorkspace< EigenMatrix_, Matrix_, Scale_ >

Workspace class for realizing a ScaledMatrix.

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 ScaledMatrix.
Scale_	An Eigen vector class, to hold the scaling factors.

Typically constructed by ScaledMatrix::new_realize_workspace().

Member Function Documentation

realize()

template<class EigenMatrix_ , class Matrix_ , class Scale_ >

const EigenMatrix_ & irlba::ScaledRealizeWorkspace< EigenMatrix_, Matrix_, Scale_ >::realize ( EigenMatrix_ & buffer )

inlinevirtual

Parameters

buffer

Buffer 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:

• irlba/Matrix/scaled.hpp