irlba::ScaledWorkspace< EigenVector_, Matrix_, Scale_ > Class Template Reference

Workspace class for multiplying a ScaledMatrix. More...

#include <scaled.hpp>

Inheritance diagram for irlba::ScaledWorkspace< EigenVector_, Matrix_, Scale_ >:

Collaboration diagram for irlba::ScaledWorkspace< EigenVector_, Matrix_, Scale_ >:

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

Detailed Description

template<class EigenVector_, class Matrix_, class Scale_>
class irlba::ScaledWorkspace< EigenVector_, Matrix_, Scale_ >

Workspace class for multiplying a ScaledMatrix.

Template Parameters

EigenVector_	A floating-point Eigen::Vector to be used as input/output of the multiplication.
Matrix_	Class of the matrix to be scaled, as referenced by the ScaledMatrix.
Scale_	An Eigen vector class, to hold the scaling factors.

Typically constructed by ScaledMatrix::new_workspace().

Member Function Documentation

multiply()

template<class EigenVector_ , class Matrix_ , class Scale_ >

void irlba::ScaledWorkspace< EigenVector_, Matrix_, Scale_ >::multiply ( const EigenVector_ & right, EigenVector_ & output )

inlinevirtual

Parameters

[in]	right	The right-hand side of the matrix product.
[out]	output	The 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:

• irlba/Matrix/scaled.hpp