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

Workspace for multiplication of a ParallelSparseMatrix. More...

#include <sparse.hpp>

Inheritance diagram for irlba::ParallelSparseWorkspace< EigenVector_, ValueArray_, IndexArray_, PointerArray_ >:
Collaboration diagram for irlba::ParallelSparseWorkspace< EigenVector_, ValueArray_, IndexArray_, PointerArray_ >:

Public Member Functions

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

Detailed Description

template<class EigenVector_, class ValueArray_, class IndexArray_, class PointerArray_>
class irlba::ParallelSparseWorkspace< EigenVector_, ValueArray_, IndexArray_, PointerArray_ >

Workspace for multiplication of a ParallelSparseMatrix.

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

Member Function Documentation

◆ multiply()

template<class EigenVector_ , class ValueArray_ , class IndexArray_ , class PointerArray_ >
void irlba::ParallelSparseWorkspace< EigenVector_, ValueArray_, IndexArray_, PointerArray_ >::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 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 Workspace.

Implements irlba::Workspace< EigenVector_ >.


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