#include <SPolynomialParam.h>

Public Member Functions
	SPolynomialParam ()
	Constructs a zero'th order polynomial, with a coeficcient of 0.0. More...

	SPolynomialParam (uInt order)
	Makes a polynomial of the given order, with all coeficcients set to zero. More...

	SPolynomialParam (const SPolynomialParam< T > &other)
	Make this a copy of other (deep copy). More...

template<class W >
	SPolynomialParam (const SPolynomialParam< W > &other)

SPolynomialParam< T > &	operator= (const SPolynomialParam< T > &other)

	~SPolynomialParam ()
	Destructor. More...

Bool	operator== (const SPolynomialParam< T > &other) const
	Comparisons. More...

Bool	operator!= (const SPolynomialParam< T > &other) const

virtual const String &	name () const
	Give name of function. More...

uInt	order () const
	What is the order of the polynomial, i.e. More...

T	coefficient (uInt which) const
	What is the which'th coefficient of the polynomial. More...

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...

virtual uInt	ndim () const
	Returns the dimension 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)

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 `x`or 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, 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::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::SPolynomialParam< T >

Parameter handling for scaled 1-D polynomials

Review Status

Test programs:: tSPolynomial

Prerequisite

FunctionParam class
Function

Etymology

A 1-dimensional Scaled Polynomial's parameters.

Synopsis

A SPolynomial 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 plus one, plus three, describing a height, center and width. These three parameters are the first three, and have default values of 1, 0, 1.

Since the SPolynomial 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 SPolynomial class only.

Example

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

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 99 of file SPolynomialParam.h.

Constructor & Destructor Documentation

◆ SPolynomialParam() [1/4]

template<class T >

casacore::SPolynomialParam< T >::SPolynomialParam ( )

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

◆ SPolynomialParam() [2/4]

template<class T >

casacore::SPolynomialParam< T >::SPolynomialParam ( uInt order )

explicit

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

◆ SPolynomialParam() [3/4]

template<class T >

casacore::SPolynomialParam< T >::SPolynomialParam ( const SPolynomialParam< T > & other )

Make this a copy of other (deep copy).

◆ SPolynomialParam() [4/4]

template<class T >

template<class W >

casacore::SPolynomialParam< T >::SPolynomialParam ( const SPolynomialParam< W > & other )

inline

Definition at line 114 of file SPolynomialParam.h.

◆ ~SPolynomialParam()

template<class T >

casacore::SPolynomialParam< T >::~SPolynomialParam ( )

Destructor.

Member Function Documentation

◆ coefficient()

template<class T >

T casacore::SPolynomialParam< 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 142 of file SPolynomialParam.h.

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

◆ coefficients()

template<class T >

Vector<T> casacore::SPolynomialParam< T >::coefficients ( ) const

Return all the coefficients as a vector.

◆ name()

template<class T >

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

inlinevirtual

Give name of function.

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

Definition at line 134 of file SPolynomialParam.h.

◆ ndim()

template<class T >

virtual uInt casacore::SPolynomialParam< T >::ndim ( ) const

inlinevirtual

Returns the dimension of function.

Implements casacore::Function< T, U >.

Definition at line 156 of file SPolynomialParam.h.

◆ operator!=()

template<class T >

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

inline

Definition at line 128 of file SPolynomialParam.h.

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

◆ operator=()

template<class T >

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

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

◆ operator==()

template<class T >

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

inline

Comparisons.

SPolynomials are equal if they are of the same order

Definition at line 126 of file SPolynomialParam.h.

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

◆ order()

template<class T >

uInt casacore::SPolynomialParam< T >::order ( ) const

inline

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

maximum exponent of "x".

Definition at line 138 of file SPolynomialParam.h.

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

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

◆ setCoefficient()

template<class T >

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

inline

Set the which'th coefficient to value.

Definition at line 149 of file SPolynomialParam.h.

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

◆ setCoefficients()

template<class T >

void casacore::SPolynomialParam< 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:

scimath/Functionals/SPolynomialParam.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class casacore::SPolynomialParam< T >

Review Status

Prerequisite

Etymology

Synopsis

Example

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Constructor & Destructor Documentation

◆ SPolynomialParam() [1/4]

◆ SPolynomialParam() [2/4]

◆ SPolynomialParam() [3/4]

◆ SPolynomialParam() [4/4]

◆ ~SPolynomialParam()

Member Function Documentation

◆ coefficient()

◆ coefficients()

◆ name()

◆ ndim()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ order()

◆ setCoefficient()

◆ setCoefficients()

template<class T>
class casacore::SPolynomialParam< T >