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

More...

`#include <PowerLogarithmicPolynomialParam.h>`

## 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.
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::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 87 of file PowerLogarithmicPolynomialParam.h.

## Constructor & Destructor Documentation

## PowerLogarithmicPolynomialParam() [1/5]

template<class T>

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

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

Referenced by operator!=(), operator=(), operator==(), casacore::PowerLogarithmicPolynomial< T >::PowerLogarithmicPolynomial(), casacore::PowerLogarithmicPolynomial< T >::PowerLogarithmicPolynomial(), casacore::PowerLogarithmicPolynomial< T >::PowerLogarithmicPolynomial(), casacore::PowerLogarithmicPolynomial< T >::PowerLogarithmicPolynomial(), casacore::PowerLogarithmicPolynomial< T >::PowerLogarithmicPolynomial(), PowerLogarithmicPolynomialParam(), and PowerLogarithmicPolynomialParam().

## PowerLogarithmicPolynomialParam() [2/5]

template<class T>

casacore::PowerLogarithmicPolynomialParam< T >::PowerLogarithmicPolynomialParam | ( | uInt | n | ) |

explicit

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

## PowerLogarithmicPolynomialParam() [3/5]

template<class T>

casacore::PowerLogarithmicPolynomialParam< T >::PowerLogarithmicPolynomialParam | ( | const vector< T > & | parms | ) |

## PowerLogarithmicPolynomialParam() [4/5]

template<class T>

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

Make this a copy of other (deep copy).

References PowerLogarithmicPolynomialParam().

## PowerLogarithmicPolynomialParam() [5/5]

template<class T>
template<class W>

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

inline

Definition at line 102 of file PowerLogarithmicPolynomialParam.h.

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

## ~PowerLogarithmicPolynomialParam()

template<class T>

virtual casacore::PowerLogarithmicPolynomialParam< T >::~PowerLogarithmicPolynomialParam | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## coefficient()

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 126 of file PowerLogarithmicPolynomialParam.h.

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

## coefficients()

template<class T>

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

Return all the coefficients as a vector.

Referenced by setCoefficients().

## name()

template<class T>

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

inline virtual

Give name of function.

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

Definition at line 121 of file PowerLogarithmicPolynomialParam.h.

## operator!=()

template<class T>

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

inline

Definition at line 115 of file PowerLogarithmicPolynomialParam.h.

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

## operator=()

template<class T>

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

References PowerLogarithmicPolynomialParam().

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

## operator==()

template<class T>

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

inline

Comparisons.

Definition at line 113 of file PowerLogarithmicPolynomialParam.h.

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

## setCoefficient()

template<class T>

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

inline

Set the which'th coefficient to value.

Definition at line 133 of file PowerLogarithmicPolynomialParam.h.

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

## setCoefficients()

template<class T>

void casacore::PowerLogarithmicPolynomialParam< 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/PowerLogarithmicPolynomialParam.h