casacore::PowerLogarithmicPolynomialParam< T > Class Template Reference

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

#include <PowerLogarithmicPolynomialParam.h>

Inheritance diagram for casacore::PowerLogarithmicPolynomialParam< T >:

Public Member Functions
	PowerLogarithmicPolynomialParam ()
	Constructs a function with two coefficients, both 1 (so y = x). More...
	PowerLogarithmicPolynomialParam (uInt n)
	Makes a polynomial of the specified number of coefficients, all set to zero. More...
	PowerLogarithmicPolynomialParam (const vector< T > &parms)
	PowerLogarithmicPolynomialParam (const PowerLogarithmicPolynomialParam< T > &other)
	Make this a copy of other (deep copy). More...
template<class W >
	PowerLogarithmicPolynomialParam (const PowerLogarithmicPolynomialParam< W > &other)
PowerLogarithmicPolynomialParam < T > &	operator= (const PowerLogarithmicPolynomialParam< T > &other)
virtual	~PowerLogarithmicPolynomialParam ()
	Destructor. More...
Bool	operator== (const PowerLogarithmicPolynomialParam< T > &other) const
	Comparisons. More...
Bool	operator!= (const PowerLogarithmicPolynomialParam< T > &other) const
virtual const String &	name () const
	Give name of function. More...
T	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< T, 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, U >
	Function ()
	Constructors. More...
	Function (const uInt n)
	Function (const Vector< T > &in)
	Function (const FunctionParam< T > &other)
template<class W , class X >
	Function (const Function< W, X > &other)
	Function (const Function< T, U > &other)
virtual	~Function ()
	Destructor. More...
uInt	nparameters () const
	Returns the number of parameters. More...
virtual U	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 U	operator() () const
	Evaluate this function object at xor at x, y. More...
virtual U	operator() (const ArgType &x) const
virtual U	operator() (const Vector< ArgType > &x) const
virtual U	operator() (FunctionArg x) const
virtual U	operator() (const ArgType &x, const ArgType &y) const
virtual U	operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
Bool &	mask (const uInt n)
	Manipulate the mask associated with the nth parameter (e.g. More...
const Bool &	mask (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...
virtual Function< T, U > *	clone () const =0
	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::Functional< FunctionTraits< T >::ArgType, U >
virtual	~Functional ()
	Destructor. More...
virtual U	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 >, U >
virtual	~Functional ()
	Destructor. More...
virtual U	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, U >
typedef FunctionTraits< T > ::ArgType	ArgType
typedef const ArgType *	FunctionArg
Protected Attributes inherited from casacore::Function< T, U >
FunctionParam< T >	param_p
	The parameters and masks. More...
Vector< ArgType >	arg_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::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

inlinevirtual

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

)

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

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:

• casa/casacore/scimath/Functionals/PowerLogarithmicPolynomialParam.h