Loading...
Searching...
No Matches
casacore::EvenPolynomialParam< T > Class Template Reference
scimath package (libcasa_scimath) » Functionals_module

More...

`#include <EvenPolynomialParam.h>`

## Public Member Functions

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

## Additional Inherited Members

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

## Detailed Description

template<class T>
class casacore::EvenPolynomialParam< T >

Parameter handling for even polynomials

### Review Status

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

### Prerequisite

- FunctionParam class
- Function1D

### Etymology

A 1-dimensional EvenPolynomial's parameters.

### Synopsis

An EvenPolynomial is described by 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.

Since the EvenPolynomial is a Function, the derivatives can be obtained as well.

The parameter interface (see FunctionParam class), is used to provide an interface to the Fitting classes.

This class is in general used implicitly by the EvenPolynomial class only.

### 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
casacore::EvenPolynomial
Definition EvenPolynomial.h:83

### 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 of

Definition at line 94 of file EvenPolynomialParam.h.

## Constructor & Destructor Documentation

## EvenPolynomialParam() [1/4]

template<class T>

casacore::EvenPolynomialParam< T >::EvenPolynomialParam | ( |  | ) |

Constructs a zero'th order polynomial, with a coeficcient of 0.0.

Referenced by casacore::EvenPolynomial< T >::EvenPolynomial(), casacore::EvenPolynomial< T >::EvenPolynomial(), casacore::EvenPolynomial< T >::EvenPolynomial(), casacore::EvenPolynomial< T >::EvenPolynomial(), EvenPolynomialParam(), EvenPolynomialParam(), operator!=(), operator=(), and operator==().

## EvenPolynomialParam() [2/4]

template<class T>

casacore::EvenPolynomialParam< T >::EvenPolynomialParam | ( | uInt | order | ) |

explicit

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

References order().

## EvenPolynomialParam() [3/4]

template<class T>

casacore::EvenPolynomialParam< T >::EvenPolynomialParam | ( | const EvenPolynomialParam< T > & | other | ) |

Make this a copy of other (deep copy).

References EvenPolynomialParam().

## EvenPolynomialParam() [4/4]

template<class T>
template<class W>

casacore::EvenPolynomialParam< T >::EvenPolynomialParam | ( | const EvenPolynomialParam< W > & | other | ) |

inline

Definition at line 109 of file EvenPolynomialParam.h.

References EvenPolynomialParam(), and casacore::Function1D< T, U >::Function1D().

## ~EvenPolynomialParam()

template<class T>

casacore::EvenPolynomialParam< T >::~EvenPolynomialParam | ( |  | ) |

Destructor.

## Member Function Documentation

## coefficient()

template<class T>

T casacore::EvenPolynomialParam< T >::coefficient | ( | uInt | which | ) | const

inline

What is the which'th coefficient of the polynomial.

For an nth degree polynomial, which varies between zero and n/2.

Definition at line 137 of file EvenPolynomialParam.h.

References DebugAssert, order(), and casacore::Function< T, T >::param_p.

## coefficients()

template<class T>

const Vector< T > & casacore::EvenPolynomialParam< T >::coefficients | ( |  | ) | const

Return all the coefficients as a vector.

Referenced by setCoefficients().

## name()

template<class T>

virtual const String & casacore::EvenPolynomialParam< T >::name | ( |  | ) | const

inline virtual

Give name of function.

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

Definition at line 129 of file EvenPolynomialParam.h.

## operator!=()

template<class T>

Bool casacore::EvenPolynomialParam< T >::operator!= | ( | const EvenPolynomialParam< T > & | other | ) | const

inline

Definition at line 123 of file EvenPolynomialParam.h.

References EvenPolynomialParam(), casacore::Function< T, U >::param_p, and casacore::Function< T, T >::param_p.

## operator=()

template<class T>

EvenPolynomialParam< T > & casacore::EvenPolynomialParam< T >::operator= | ( | const EvenPolynomialParam< T > & | other | ) |

References EvenPolynomialParam().

Referenced by casacore::EvenPolynomial< T >::operator=().

## operator==()

template<class T>

Bool casacore::EvenPolynomialParam< T >::operator== | ( | const EvenPolynomialParam< T > & | other | ) | const

inline

Comparisons.

EvenPolynomials are equal if they are the same order

Definition at line 121 of file EvenPolynomialParam.h.

References EvenPolynomialParam(), casacore::Function< T, U >::param_p, and casacore::Function< T, T >::param_p.

## order()

template<class T>

uInt casacore::EvenPolynomialParam< T >::order | ( |  | ) | const

inline

What is the order of the polynomial, i.e.

maximum exponent of "x".

Definition at line 133 of file EvenPolynomialParam.h.

References casacore::Function< T, T >::param_p.

Referenced by coefficient(), casacore::EvenPolynomial< T >::EvenPolynomial(), EvenPolynomialParam(), and setCoefficient().

## setCoefficient()

template<class T>

void casacore::EvenPolynomialParam< T >::setCoefficient | ( | uInt | which,
|  | const T | value )

inline

Set the which'th coefficient to value.

Definition at line 144 of file EvenPolynomialParam.h.

References DebugAssert, casacore::NewDelAllocator< T >::value, order(), and casacore::Function< T, T >::param_p.

## setCoefficients()

template<class T>

void casacore::EvenPolynomialParam< T >::setCoefficients | ( | const Vector< T > & | coefficients | ) |

Set all the coefficients at once, throw away all existing coefficients.

References coefficients(), casacore::Function1D< T, U >::Function1D(), casacore::Function< T, T >::nparameters(), and casacore::Function< T, T >::param_p.

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

- scimath/Functionals/EvenPolynomialParam.h