casa::OddPolynomial< T > Class Template Reference

A one dimensional odd polynomial class. More...

#include <OddPolynomial.h>

Inheritance diagram for casa::OddPolynomial< T >:

List of all members.

Public Member Functions
	OddPolynomial ()
	Constructs a first order polynomial, with a coeficcient of 0.0.
	OddPolynomial (uInt order)
	Makes a polynomial of the given order, with all coeficcients set to zero.
	OddPolynomial (const OddPolynomial< T > &other)
	Copy constructor/assignment (deep copy)
template<class W >
	OddPolynomial (const OddPolynomial< W > &other)
OddPolynomial< T > &	operator= (const OddPolynomial< T > &other)
virtual	~OddPolynomial ()
	Destructor.
virtual T	eval (typename Function1D< T >::FunctionArg x) const
	Evaluate the polynomial at x.
virtual Function< T > *	clone () const
	Return a copy of this object from the heap.
virtual Function< typename FunctionTraits< T >::DiffType > *	cloneAD () const
virtual Function< typename FunctionTraits< T >::BaseType > *	cloneNonAD () const

---

Detailed Description

template<class T>
class casa::OddPolynomial< T >

A one dimensional odd polynomial class.

Review Status

Reviewed By:

tcornwel

Date Reviewed:

1996/02/22

Test programs:

tSpecialPolynomial

Prerequisite

• Function

Synopsis

A OddPolynomial<T> contains a set of coefficients; its fundamental operation is evaluating itself at some "x". The number of coefficients is the order of the polynomial divided by two, plus one, so is the number of available parameters.

Example

     OddPolynomial<Float> pf(3);  // Third order polynomial - coeffs 0 by default
     pf.setCoefficient(0, 1.0);
     pf[1] = 2.0;               // 2x^3 + 1x^1
     pf(2); // == 18

Template Type Argument Requirements (T)

• T should have standard numerical operators. Current implementation only tested for real types (and their AutoDiffs).

Thrown Exceptions

• Assertion in debug mode if attempt is made to address incorrect coefficients

To Do

• Nothing I know off

Definition at line 84 of file OddPolynomial.h.

---

Constructor & Destructor Documentation

template<class T>

casa::OddPolynomial< T >::OddPolynomial

(

)

[inline]

Constructs a first order polynomial, with a coeficcient of 0.0.

Definition at line 91 of file OddPolynomial.h.

template<class T>

casa::OddPolynomial< T >::OddPolynomial

(

uInt

order

)

[inline, explicit]

Makes a polynomial of the given order, with all coeficcients set to zero.

Definition at line 94 of file OddPolynomial.h.

template<class T>

casa::OddPolynomial< T >::OddPolynomial

(

const OddPolynomial< T > &

other

)

[inline]

Copy constructor/assignment (deep copy)

Definition at line 97 of file OddPolynomial.h.

template<class T>

template<class W >

casa::OddPolynomial< T >::OddPolynomial

(

const OddPolynomial< W > &

other

)

[inline]

Definition at line 100 of file OddPolynomial.h.

template<class T>

virtual casa::OddPolynomial< T >::~OddPolynomial

(

)

[inline, virtual]

Destructor.

Definition at line 107 of file OddPolynomial.h.

---

Member Function Documentation

template<class T>

virtual Function<T>* casa::OddPolynomial< T >::clone

(

)

const [inline, virtual]

Return a copy of this object from the heap.

The caller is responsible for deleting the pointer.

Implements casa::Function< T, T >.

Definition at line 117 of file OddPolynomial.h.

template<class T>

virtual Function<typename FunctionTraits<T>::DiffType>* casa::OddPolynomial< T >::cloneAD

(

)

const [inline, virtual]

Reimplemented from casa::Function< T, T >.

Definition at line 118 of file OddPolynomial.h.

template<class T>

virtual Function<typename FunctionTraits<T>::BaseType>* casa::OddPolynomial< T >::cloneNonAD

(

)

const [inline, virtual]

Reimplemented from casa::Function< T, T >.

Definition at line 120 of file OddPolynomial.h.

template<class T>

virtual T casa::OddPolynomial< T >::eval

(

typename Function1D< T >::FunctionArg

x

)

const [virtual]

Evaluate the polynomial at x.

template<class T>

OddPolynomial<T>& casa::OddPolynomial< T >::operator=

(

const OddPolynomial< T > &

other

)

[inline]

Definition at line 102 of file OddPolynomial.h.

---

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

• casacore/scimath/Functionals/OddPolynomial.h