tPolynomialWithBase< T > Class Template Reference

mathematical function (to be moved into tools sometime, and currently limited to linear functions) More...

#include <tPolynomialWithBase.h>

List of all members.

Public Member Functions

 tPolynomialWithBase ()
 constructor
 tPolynomialWithBase (REAL value)
 constructor
 tPolynomialWithBase (REAL coefs_[])
 constructor
 tPolynomialWithBase (const tPolynomialWithBase< T > &tf)
 constructor
 tPolynomialWithBase (const tPolynomial< T > &tf)
 constructor
virtual ~tPolynomialWithBase ()
virtual REAL evaluate (REAL argument) const
 evaluates the function
REAL operator() (REAL argument) const
 evaluation operator
void setUnadjustableOffset (REAL x)
REAL getUnadjustableOffset ()
virtual T & ReadSync (T &m)
virtual T & WriteSync (T &m) const

Protected Attributes

REAL unadjustableOffset
 offset value that is not modified by an adjustSlope

Friends

template<typename D>
bool operator== (const tPolynomialWithBase< D > &left, const tPolynomialWithBase< D > &right)

Detailed Description

template<typename T>
class tPolynomialWithBase< T >

mathematical function (to be moved into tools sometime, and currently limited to linear functions)

Definition at line 35 of file tPolynomialWithBase.h.

Constructor & Destructor Documentation

template<typename T>
tPolynomialWithBase< T >::tPolynomialWithBase (  )  [inline]

constructor

Definition at line 82 of file tPolynomialWithBase.h.

00083 : tPolynomial<T>(),
00084   unadjustableOffset(0.0)
00085 {
00086   // Empty
00087 }

template<typename T>
tPolynomialWithBase< T >::tPolynomialWithBase ( REAL  value  )  [inline]

constructor

Parameters:
value  constructor

Definition at line 90 of file tPolynomialWithBase.h.

00091 : tPolynomial<T>(value),
00092   unadjustableOffset(0.0)
00093 { 
00094   // Empty
00095 }

template<typename T>
tPolynomialWithBase< T >::tPolynomialWithBase ( REAL  coefs_[]  )  [inline]

constructor

Parameters:
coefs_  constructor

Definition at line 99 of file tPolynomialWithBase.h.

00100 : tPolynomial<T>(coefs_),
00101   unadjustableOffset(0.0)
00102 {
00103   // Empty
00104 }

template<typename T>
tPolynomialWithBase< T >::tPolynomialWithBase ( const tPolynomialWithBase< T > &  tf  )  [inline]

constructor

Parameters:
tf  constructor

Definition at line 107 of file tPolynomialWithBase.h.

00108 : tPolynomial<T>(tf),
00109   unadjustableOffset(tf.unadjustableOffset)
00110 {
00111   // Empty
00112 }

template<typename T>
tPolynomialWithBase< T >::tPolynomialWithBase ( const tPolynomial< T > &  tf  )  [inline]

constructor

Parameters:
tf  constructor

Definition at line 115 of file tPolynomialWithBase.h.

00116 : tPolynomial<T>(tf),
00117   unadjustableOffset(0.0)
00118 {
00119   // Empty
00120 }

template<typename T>
virtual tPolynomialWithBase< T >::~tPolynomialWithBase (  )  [inline, virtual]

< destructor

Definition at line 45 of file tPolynomialWithBase.h.

00045                                    { 
00046       // Empty
00047     }

Member Function Documentation

template<typename T>
REAL tPolynomialWithBase< T >::evaluate ( REAL  argument  )  const [inline, virtual]

evaluates the function

Definition at line 141 of file tPolynomialWithBase.h.

References tPolynomial< T >::evaluate(), REAL, and tPolynomialWithBase< T >::unadjustableOffset.

00142 {
00143   REAL res = tPolynomial<T>::evaluate( argument );
00144 
00145   res += unadjustableOffset;
00146   return res;
00147 }

Here is the call graph for this function:

template<typename T>
REAL tPolynomialWithBase< T >::operator() ( REAL  argument  )  const [inline]

evaluation operator

template<typename T>
void tPolynomialWithBase< T >::setUnadjustableOffset ( REAL  x  ) 

template<typename T>
REAL tPolynomialWithBase< T >::getUnadjustableOffset (  ) 

template<typename T>
T & tPolynomialWithBase< T >::ReadSync ( T &  m  )  [inline, virtual]

Definition at line 161 of file tPolynomialWithBase.h.

References tPolynomial< T >::ReadSync(), and tPolynomialWithBase< T >::unadjustableOffset.

00162 {
00163     tPolynomial<T>::ReadSync( m );
00164 
00165     // read unadjustableOffset
00166     m >> unadjustableOffset;
00167 
00168     return m;
00169 }

Here is the call graph for this function:

template<typename T>
T & tPolynomialWithBase< T >::WriteSync ( T &  m  )  const [inline, virtual]

Definition at line 150 of file tPolynomialWithBase.h.

References tPolynomialWithBase< T >::unadjustableOffset, and tPolynomial< T >::WriteSync().

00151 {
00152     tPolynomial<T>::WriteSync( m );
00153 
00154     // write unadjustableOffset
00155     m << unadjustableOffset;
00156 
00157     return m;
00158 }

Here is the call graph for this function:

Friends And Related Function Documentation

template<typename T>
template<typename D>
bool operator== ( const tPolynomialWithBase< D > &  left,
const tPolynomialWithBase< D > &  right 
) [friend]

Member Data Documentation

template<typename T>
REAL tPolynomialWithBase< T >::unadjustableOffset [protected]

offset value that is not modified by an adjustSlope

Definition at line 62 of file tPolynomialWithBase.h.

Referenced by tPolynomialWithBase< T >::evaluate(), operator==(), tPolynomialWithBase< T >::ReadSync(), and tPolynomialWithBase< T >::WriteSync().

The documentation for this class was generated from the following file:
Generated on Sat Mar 15 23:58:21 2008 for Armagetron Advanced by  doxygen 1.5.4