irlba
A C++ library for IRLBA
Loading...
Searching...
No Matches
irlba::ParallelSparseRealizeWorkspace< EigenMatrix_, ValueArray_, IndexArray_, PointerArray_ > Class Template Referencefinal

Workspace for realizing a ParallelSparseMatrix. More...

#include <sparse.hpp>

Inheritance diagram for irlba::ParallelSparseRealizeWorkspace< EigenMatrix_, ValueArray_, IndexArray_, PointerArray_ >:
Collaboration diagram for irlba::ParallelSparseRealizeWorkspace< EigenMatrix_, ValueArray_, IndexArray_, PointerArray_ >:

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 ValueArray_, class IndexArray_, class PointerArray_>
class irlba::ParallelSparseRealizeWorkspace< EigenMatrix_, ValueArray_, IndexArray_, PointerArray_ >

Workspace for realizing a ParallelSparseMatrix.

Template Parameters
EigenMatrix_A dense floating-point Eigen::Matrix in which to store the realized matrix.
ValueArray_Array class containing the non-zero values, see ParallelSparseMatrix.
IndexArray_Array class containing indices of non-zero elements, see ParallelSparseMatrix.
PointerArray_Array class containing the pointers to the row/column boundaries, see ParallelSparseMatrix.

Typically constructed by ParallelSparseMatrix::new_known_realize_workspace().

Member Function Documentation

◆ realize()

template<class EigenMatrix_ , class ValueArray_ , class IndexArray_ , class PointerArray_ >
const EigenMatrix_ & irlba::ParallelSparseRealizeWorkspace< EigenMatrix_, ValueArray_, IndexArray_, PointerArray_ >::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: