casacore::PowerLogarithmicPolynomialParam< T > Class Template Reference

Parameter handling for one-dimensional power logarithmic polynomials. More...

#include <PowerLogarithmicPolynomialParam.h>

Inheritance diagram for casacore::PowerLogarithmicPolynomialParam< T >:

List of all members.

Public Member Functions
	PowerLogarithmicPolynomialParam ()
	Constructs a function with two coefficients, both 1 (so y = x).
	PowerLogarithmicPolynomialParam (uInt n)
	Makes a polynomial of the specified number of coefficients, all set to zero.
	PowerLogarithmicPolynomialParam (const vector< T > &parms)
	PowerLogarithmicPolynomialParam (const PowerLogarithmicPolynomialParam< T > &other)
	Make this a copy of other (deep copy).
template<class W >
	PowerLogarithmicPolynomialParam (const PowerLogarithmicPolynomialParam< W > &other)
PowerLogarithmicPolynomialParam < T > &	operator= (const PowerLogarithmicPolynomialParam< T > &other)
virtual	~PowerLogarithmicPolynomialParam ()
	Destructor.
Bool	operator== (const PowerLogarithmicPolynomialParam< T > &other) const
	Comparisons.
Bool	operator!= (const PowerLogarithmicPolynomialParam< T > &other) const
virtual const String &	name () const
	Give name of function.
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.

---

Detailed Description

template<class T>
class casacore::PowerLogarithmicPolynomialParam< T >

Parameter handling for one-dimensional power logarithmic polynomials.

Review Status

Test programs:

tPowerLogarithmicPolynomial

Prerequisite

• FunctionParam class
• Function1D

Etymology

A 1-dimensional power logaritmic olynomial's parameters.

Synopsis

A power logarithmic polynomial is described by a set of coefficients; its fundamental operation is evaluating itself at some "x".

Since the power logarithmic olynomial 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 PowerLogarithmicPolynomial class only.

Example

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

Definition at line 90 of file PowerLogarithmicPolynomialParam.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::PowerLogarithmicPolynomialParam< T >::PowerLogarithmicPolynomialParam

(

)

Constructs a function with two coefficients, both 1 (so y = x).

template<class T>

casacore::PowerLogarithmicPolynomialParam< T >::PowerLogarithmicPolynomialParam

(

uInt

n

)

[explicit]

Makes a polynomial of the specified number of coefficients, all set to zero.

template<class T>

casacore::PowerLogarithmicPolynomialParam< T >::PowerLogarithmicPolynomialParam

(

const vector< T > &

parms

)

template<class T>

casacore::PowerLogarithmicPolynomialParam< T >::PowerLogarithmicPolynomialParam

(

const PowerLogarithmicPolynomialParam< T > &

other

)

Make this a copy of other (deep copy).

template<class T>

template<class W >

casacore::PowerLogarithmicPolynomialParam< T >::PowerLogarithmicPolynomialParam

(

const PowerLogarithmicPolynomialParam< W > &

other

)

[inline]

Definition at line 105 of file PowerLogarithmicPolynomialParam.h.

template<class T>

virtual casacore::PowerLogarithmicPolynomialParam< T >::~PowerLogarithmicPolynomialParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

T casacore::PowerLogarithmicPolynomialParam< 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.

Definition at line 129 of file PowerLogarithmicPolynomialParam.h.

template<class T>

const Vector<T>& casacore::PowerLogarithmicPolynomialParam< T >::coefficients

(

)

const

Return all the coefficients as a vector.

template<class T>

virtual const String& casacore::PowerLogarithmicPolynomialParam< T >::name

(

)

const [inline, virtual]

Give name of function.

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

Definition at line 124 of file PowerLogarithmicPolynomialParam.h.

template<class T>

Bool casacore::PowerLogarithmicPolynomialParam< T >::operator!=

(

const PowerLogarithmicPolynomialParam< T > &

other

)

const [inline]

Definition at line 118 of file PowerLogarithmicPolynomialParam.h.

template<class T>

PowerLogarithmicPolynomialParam<T>& casacore::PowerLogarithmicPolynomialParam< T >::operator=

(

const PowerLogarithmicPolynomialParam< T > &

other

)

Reimplemented in casacore::PowerLogarithmicPolynomial< T >.

template<class T>

Bool casacore::PowerLogarithmicPolynomialParam< T >::operator==

(

const PowerLogarithmicPolynomialParam< T > &

other

)

const [inline]

Comparisons.

Definition at line 116 of file PowerLogarithmicPolynomialParam.h.

template<class T>

void casacore::PowerLogarithmicPolynomialParam< T >::setCoefficient	(	uInt	which,
		const T	value
	)			[inline]

Set the which'th coefficient to value.

Definition at line 136 of file PowerLogarithmicPolynomialParam.h.

template<class T>

void casacore::PowerLogarithmicPolynomialParam< T >::setCoefficients

(

const Vector< T > &

coefficients

)

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

---

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

• casacore/scimath/Functionals/PowerLogarithmicPolynomialParam.h