RBGen  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
List of all members
RBGen::Filter< ScalarType > Class Template Referenceabstract

Class for selecting desired singular values. More...

#include <RBGen_Filter.hpp>

Inheritance diagram for RBGen::Filter< ScalarType >:
RBGen::CompFilter< ScalarType > RBGen::RangeFilter< ScalarType > RBGen::ThreshFilter< ScalarType >

Public Member Functions

Constructor/Destructor.
 Filter (SortType which=LARGEST)
 Default constructor. More...
 
virtual ~Filter ()
 Destructor. More...
 
Filter Method
virtual std::vector< int > filter (const std::vector< ScalarType > &svals)=0
 Selects targetted singular values. More...
 

Detailed Description

template<class ScalarType>
class RBGen::Filter< ScalarType >

Class for selecting desired singular values.

Definition at line 22 of file RBGen_Filter.hpp.

Constructor & Destructor Documentation

template<class ScalarType >
RBGen::Filter< ScalarType >::Filter ( SortType  which = LARGEST)
inline

Default constructor.

Definition at line 29 of file RBGen_Filter.hpp.

template<class ScalarType >
virtual RBGen::Filter< ScalarType >::~Filter ( )
inlinevirtual

Destructor.

Definition at line 32 of file RBGen_Filter.hpp.

Member Function Documentation

template<class ScalarType >
virtual std::vector<int> RBGen::Filter< ScalarType >::filter ( const std::vector< ScalarType > &  svals)
pure virtual

Selects targetted singular values.

This method accepts a list of singular values (in decreasing order, as returned by GESVD) and returns a list of indices consisting of the values allowed through the filter.

Parameters
svals[in] Singular values under consideration by the filter.
Returns
A vector of ints, corresponding to the indices of the targetted singular values. The indices are in ascending order and employ zero-based indexing.

Implemented in RBGen::CompFilter< ScalarType >, RBGen::ThreshFilter< ScalarType >, and RBGen::RangeFilter< ScalarType >.


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