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

Threshold-based filter. More...

#include <RBGen_Filter.hpp>

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

Public Member Functions

Constructor/Destructor.
 ThreshFilter (SortType which, bool absthresh, typename Teuchos::ScalarTraits< ScalarType >::magnitudeType thresh)
 Default constructor. More...
 
virtual ~ThreshFilter ()
 Destructor. More...
 
Filter Method
std::vector< int > filter (const std::vector< ScalarType > &svals)
 Return an index for the singular values falling within the threshold. More...
 
- Public Member Functions inherited from RBGen::Filter< ScalarType >
 Filter (SortType which=LARGEST)
 Default constructor. More...
 
virtual ~Filter ()
 Destructor. More...
 

Detailed Description

template<class ScalarType>
class RBGen::ThreshFilter< ScalarType >

Threshold-based filter.

Definition at line 108 of file RBGen_Filter.hpp.

Constructor & Destructor Documentation

template<class ScalarType >
RBGen::ThreshFilter< ScalarType >::ThreshFilter ( SortType  which,
bool  absthresh,
typename Teuchos::ScalarTraits< ScalarType >::magnitudeType  thresh 
)
inline

Default constructor.

The threshold definition depends on which:

  • LARGEST: value cand passes the filter if $cand \geq tval$
  • SMALLEST: value cand passes the filter if $cand \leq tval$ where tval depends on absthresh:
  • false:
    • $tval \doteq thresh \cdot max(svals)$
    • $tval \doteq thresh \cdot min(svals)$
  • true: $tval \doteq thresh$

Definition at line 124 of file RBGen_Filter.hpp.

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

Destructor.

Definition at line 133 of file RBGen_Filter.hpp.

Member Function Documentation

template<class ScalarType >
std::vector<int> RBGen::ThreshFilter< ScalarType >::filter ( const std::vector< ScalarType > &  svals)
inlinevirtual

Return an index for the singular values falling within the threshold.

Note
It is assumed that svals are sorted in decreasing order.

Implements RBGen::Filter< ScalarType >.

Definition at line 144 of file RBGen_Filter.hpp.


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