casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casacore::EvenPolynomial< T > Class Template Reference

A one dimensional odd polynomial class. More...

#include <EvenPolynomial.h>

Inheritance diagram for casacore::EvenPolynomial< T >:
casacore::EvenPolynomialParam< T > casacore::Function1D< T > casacore::Function< T, T > casacore::Functional< FunctionTraits< T >::ArgType, T > casacore::Functional< Vector< FunctionTraits< T >::ArgType >, T >

Public Member Functions

 EvenPolynomial ()
 Constructs a zeroth order polynomial, with a coeficcient of 0.0. More...
 
 EvenPolynomial (uInt order)
 Makes a polynomial of the given order, with all coeficcients set to zero. More...
 
 EvenPolynomial (const EvenPolynomial< T > &other)
 Copy constructor/assignment (deep copy) More...
 
template<class W >
 EvenPolynomial (const EvenPolynomial< W > &other)
 
EvenPolynomial< T > & operator= (const EvenPolynomial< T > &other)
 
virtual ~EvenPolynomial ()
 Destructor. More...
 
virtual T eval (typename Function1D< T >::FunctionArg x) const
 Evaluate the polynomial at x. More...
 
virtual Function< T > * clone () const
 Return a copy of this object from the heap. More...
 
virtual Function< typename
FunctionTraits< T >::DiffType > * 
cloneAD () const
 
virtual Function< typename
FunctionTraits< T >::BaseType > * 
cloneNonAD () const
 
- Public Member Functions inherited from casacore::EvenPolynomialParam< T >
 EvenPolynomialParam ()
 Constructs a zero'th order polynomial, with a coeficcient of 0.0. More...
 
 EvenPolynomialParam (uInt order)
 Makes a polynomial of the given order, with all coeficcients set to zero. More...
 
 EvenPolynomialParam (const EvenPolynomialParam< T > &other)
 Make this a copy of other (deep copy). More...
 
template<class W >
 EvenPolynomialParam (const EvenPolynomialParam< W > &other)
 
EvenPolynomialParam< T > & operator= (const EvenPolynomialParam< T > &other)
 
 ~EvenPolynomialParam ()
 Destructor. More...
 
Bool operator== (const EvenPolynomialParam< T > &other) const
 Comparisons. More...
 
Bool operator!= (const EvenPolynomialParam< T > &other) const
 
virtual const Stringname () const
 Give name of function. More...
 
uInt order () const
 What is the order of the polynomial, i.e. More...
 
coefficient (uInt which) const
 What is the which'th coefficient of the polynomial. More...
 
const Vector< T > & coefficients () const
 Return all the coefficients as a vector. More...
 
void setCoefficient (uInt which, const T value)
 Set the which'th coefficient to value. More...
 
void setCoefficients (const Vector< T > &coefficients)
 Set all the coefficients at once, throw away all existing coefficients. More...
 
- Public Member Functions inherited from casacore::Function1D< T >
 Function1D ()
 Constructors. More...
 
 Function1D (const uInt n)
 
 Function1D (const Vector< T > &in)
 
 Function1D (const FunctionParam< T > &other)
 
 Function1D (const Function1D< W, X > &other)
 
virtual ~Function1D ()
 Destructor. More...
 
virtual uInt ndim () const
 Returns the number of dimensions of function. More...
 
- Public Member Functions inherited from casacore::Function< T, T >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
 Function (const Function< W, X > &other)
 
virtual ~Function ()
 Destructor. More...
 
uInt nparameters () const
 Returns the number of parameters. More...
 
virtual T eval (FunctionArg x) const =0
 Evaluate the function object. More...
 
T & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const T & operator[] (const uInt n) const
 
virtual T operator() () const
 Evaluate this function object at xor at x, y. More...
 
virtual T operator() (const ArgType &x) const
 
virtual T operator() (const Vector< ArgType > &x) const
 
virtual T operator() (FunctionArg x) const
 
virtual T operator() (const ArgType &x, const ArgType &y) const
 
virtual T operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (const uInt n) const
 
const FunctionParam< T > & parameters () const
 Return the parameter interface. More...
 
FunctionParam< T > & parameters ()
 
const Vector< ArgType > & argp () const
 Get arg_p and parset_p. More...
 
Bool parsetp () const
 
void lockParam ()
 Compiler cannot always find the correct 'const' version of parameter access. More...
 
void unlockParam ()
 
virtual void setMode (const RecordInterface &mode)
 get/set the function mode. More...
 
virtual void getMode (RecordInterface &mode) const
 
virtual Bool hasMode () const
 return True if the implementing function supports a mode. More...
 
ostream & print (ostream &os) const
 Print the function (i.e. More...
 
- Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, T >
virtual ~Functional ()
 Destructor. More...
 
virtual T operator() (const FunctionTraits< T >::ArgType &x) const =0
 Map a Domain x into a Range y value. More...
 
- Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, T >
virtual ~Functional ()
 Destructor. More...
 
virtual T operator() (const Vector< FunctionTraits< T >::ArgType > &x) const =0
 Map a Domain x into a Range y value. More...
 

Additional Inherited Members

- Public Types inherited from casacore::Function1D< T >
typedef const T * FunctionArg
 
- Public Types inherited from casacore::Function< T, T >
typedef FunctionTraits< T >
::ArgType 
ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< T, T >
FunctionParam< T > param_p
 The parameters and masks. More...
 
Vector< ArgTypearg_p
 Aid for non-contiguous argument storage. More...
 
Bool parset_p
 Indicate parameter written. More...
 
Bool locked_p
 Indicate that parameters are expected to be locked from changing. More...
 

Detailed Description

template<class T>
class casacore::EvenPolynomial< T >

A one dimensional odd polynomial class.

Review Status

Reviewed By:
tcornwel
Date Reviewed:
1996/02/22
Test programs:
tSpecialPolynomial

Prerequisite

Synopsis

An EvenPolynomial<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

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

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Definition at line 84 of file EvenPolynomial.h.

Constructor & Destructor Documentation

template<class T>
casacore::EvenPolynomial< T >::EvenPolynomial ( )
inline

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

Definition at line 91 of file EvenPolynomial.h.

template<class T>
casacore::EvenPolynomial< T >::EvenPolynomial ( uInt  order)
inlineexplicit

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

Definition at line 94 of file EvenPolynomial.h.

template<class T>
casacore::EvenPolynomial< T >::EvenPolynomial ( const EvenPolynomial< T > &  other)
inline

Copy constructor/assignment (deep copy)

Definition at line 97 of file EvenPolynomial.h.

template<class T>
template<class W >
casacore::EvenPolynomial< T >::EvenPolynomial ( const EvenPolynomial< W > &  other)
inline

Definition at line 100 of file EvenPolynomial.h.

template<class T>
virtual casacore::EvenPolynomial< T >::~EvenPolynomial ( )
inlinevirtual

Destructor.

Definition at line 107 of file EvenPolynomial.h.

Member Function Documentation

template<class T>
virtual Function<T>* casacore::EvenPolynomial< T >::clone ( ) const
inlinevirtual

Return a copy of this object from the heap.

The caller is responsible for deleting the pointer.

Implements casacore::Function< T, T >.

Definition at line 117 of file EvenPolynomial.h.

template<class T>
virtual Function<typename FunctionTraits<T>::DiffType>* casacore::EvenPolynomial< T >::cloneAD ( ) const
inlinevirtual

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

Definition at line 118 of file EvenPolynomial.h.

template<class T>
virtual Function<typename FunctionTraits<T>::BaseType>* casacore::EvenPolynomial< T >::cloneNonAD ( ) const
inlinevirtual

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

Definition at line 120 of file EvenPolynomial.h.

template<class T>
virtual T casacore::EvenPolynomial< T >::eval ( typename Function1D< T >::FunctionArg  x) const
virtual

Evaluate the polynomial at x.

template<class T>
EvenPolynomial<T>& casacore::EvenPolynomial< T >::operator= ( const EvenPolynomial< T > &  other)
inline

Definition at line 102 of file EvenPolynomial.h.

References casacore::EvenPolynomialParam< T >::operator=().


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