irlba::RealizeWorkspace< EigenMatrix_ > Class Template Reference

Workspace class for realizing a Matrix. More...

#include <interface.hpp>

Inheritance diagram for irlba::RealizeWorkspace< EigenMatrix_ >:

Public Member Functions
virtual const EigenMatrix_ &	realize (EigenMatrix_ &buffer)=0
void	realize_copy (EigenMatrix_ &buffer)

Detailed Description

template<class EigenMatrix_>
class irlba::RealizeWorkspace< EigenMatrix_ >

Workspace class for realizing a Matrix.

Template Parameters

EigenMatrix_

A floating-point Eigen::Matrix.

Typically constructed by Matrix::new_realize_workspace(). The lifetime of this object should not exceed that of the Matrix instance used to construct it.

Member Function Documentation

realize()

template<class EigenMatrix_ >

virtual const EigenMatrix_ & irlba::RealizeWorkspace< EigenMatrix_ >::realize ( EigenMatrix_ & buffer )

pure virtual

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.

Implemented in irlba::CenteredRealizeWorkspace< EigenMatrix_, Matrix_, Center_ >, irlba::ParallelSparseRealizeWorkspace< EigenMatrix_, ValueArray_, IndexArray_, PointerArray_ >, irlba::ScaledRealizeWorkspace< EigenMatrix_, Matrix_, Scale_ >, and irlba::SimpleRealizeWorkspace< EigenMatrix_, Simple_ >.

realize_copy()

template<class EigenMatrix_ >

void irlba::RealizeWorkspace< EigenMatrix_ >::realize_copy ( EigenMatrix_ & buffer )

inline

Parameters

[out]

buffer

Buffer in which to store the realized matrix. Unlike realize(), this is guaranteed to contain the contents of the realized matrix.

---

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

• irlba/Matrix/interface.hpp