SPUC::running_sum< Numeric > Class Template Reference
[SPUC templates, FIR filters]

template class running average filter consisting of a delay line, adder and subtractor More...

#include <running_sum.h>

Collaboration diagram for SPUC::running_sum< Numeric >:

[legend]List of all members.

Public Member Functions
	running_sum (long n=0)
	/ Constructor
running_sum &	operator= (const running_sum &rhs)
	Assignment.
void	set_size (long n)
	~running_sum (void)
	destructor
void	reset (void)
	Reset/clear.
Numeric	get_result ()
	return result
Numeric	update (Numeric in)
	Clock in new input sample.
Numeric	average (Numeric in)
Protected Attributes
Numeric	result
delay< Numeric >	z
long	size
float_type	inv_size

---

Detailed Description

template<class Numeric>
class SPUC::running_sum< Numeric >

template class running average filter consisting of a delay line, adder and subtractor

Author:

Tony Kirke

---

Constructor & Destructor Documentation

template<class Numeric>

SPUC::running_sum< Numeric >::running_sum

(

long

n = 0

)

[inline]

/ Constructor

template<class Numeric>

SPUC::running_sum< Numeric >::~running_sum

(

void

)

[inline]

destructor

---

Member Function Documentation

template<class Numeric>

Numeric SPUC::running_sum< Numeric >::average

(

Numeric

in

)

[inline]

template<class Numeric>

Numeric SPUC::running_sum< Numeric >::get_result

(

)

[inline]

return result

template<class Numeric>

running_sum& SPUC::running_sum< Numeric >::operator=

(

const running_sum< Numeric > &

rhs

)

[inline]

Assignment.

template<class Numeric>

void SPUC::running_sum< Numeric >::reset

(

void

)

[inline]

Reset/clear.

template<class Numeric>

void SPUC::running_sum< Numeric >::set_size

(

long

n

)

[inline]

template<class Numeric>

Numeric SPUC::running_sum< Numeric >::update

(

Numeric

in

)

[inline]

Clock in new input sample.

---

Member Data Documentation

template<class Numeric>

float_type SPUC::running_sum< Numeric >::inv_size [protected]

template<class Numeric>

Numeric SPUC::running_sum< Numeric >::result [protected]

template<class Numeric>

long SPUC::running_sum< Numeric >::size [protected]

template<class Numeric>

delay<Numeric> SPUC::running_sum< Numeric >::z [protected]

---

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

• running_sum.h

---