IT++ Logo Newcom Logo

itpp::Filter< T1, T2, T3 > Class Template Reference
[Filter Classes and Functions]

Virtual Filter Base Class. More...

#include <itpp/base/filter.h>

Inheritance diagram for itpp::Filter< T1, T2, T3 >:

itpp::AR_Filter< T1, T2, T3 > itpp::ARMA_Filter< T1, T2, T3 > itpp::MA_Filter< T1, T2, T3 > itpp::MA_Filter< T1, double, T1 > List of all members.

Public Member Functions

 Filter ()
 Default constructor.
virtual T3 operator() (const T1 Sample)
 Filter a single sample.
virtual Vec< T3 > operator() (const Vec< T1 > &v)
 Filter a vector.
virtual ~Filter ()
 Virtual destructor.

Protected Member Functions

virtual T3 filter (const T1 Sample)=0
 Pure virtual filter function. This is where the real filtering is done. Implement this function to create a new filter.

Detailed Description

template<class T1, class T2, class T3>
class itpp::Filter< T1, T2, T3 >

Virtual Filter Base Class.

The class is templated as follows:

Definition at line 57 of file filter.h.


Constructor & Destructor Documentation

template<class T1, class T2, class T3>
itpp::Filter< T1, T2, T3 >::Filter (  )  [inline]

Default constructor.

Definition at line 60 of file filter.h.

template<class T1, class T2, class T3>
virtual itpp::Filter< T1, T2, T3 >::~Filter (  )  [inline, virtual]

Virtual destructor.

Definition at line 66 of file filter.h.


Member Function Documentation

template<class T1, class T2, class T3>
virtual T3 itpp::Filter< T1, T2, T3 >::operator() ( const T1  Sample  )  [inline, virtual]

Filter a single sample.

Definition at line 62 of file filter.h.

template<class T1, class T2, class T3>
Vec< T3 > itpp::Filter< T1, T2, T3 >::operator() ( const Vec< T1 > &  v  )  [inline, virtual]

Filter a vector.

Definition at line 313 of file filter.h.

References itpp::Filter< T1, T2, T3 >::filter(), and itpp::Vec< Num_T >::length().

template<class T1, class T2, class T3>
virtual T3 itpp::Filter< T1, T2, T3 >::filter ( const T1  Sample  )  [protected, pure virtual]

Pure virtual filter function. This is where the real filtering is done. Implement this function to create a new filter.

Referenced by itpp::Filter< T1, T2, T3 >::operator()(), and itpp::Filter< std::complex< double >, double, std::complex< double > >::operator()().


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

Generated on Fri Jun 8 01:07:22 2007 for IT++ by Doxygen 1.5.2