#include <SPolynomial.h>
Public Member Functions | |
| SPolynomial () | |
| Constructs a zero'th order polynomial, with a coeficcient of 0.0. More... | |
| SPolynomial (uInt order) | |
| Makes a polynomial of the given order, with all coeficcients set to zero, and height, center, width to 1,0,1. More... | |
| SPolynomial (const SPolynomial< T > &other) | |
| Copy constructor/assignment (deep copy) More... | |
| template<class W > | |
| SPolynomial (const SPolynomial< W > &other) | |
| SPolynomial< T > & | operator= (const SPolynomial< T > &other) |
| virtual | ~SPolynomial () |
| Destructor. More... | |
| virtual T | eval (typename Function< T >::FunctionArg x) const |
Evaluate the polynomial at x. More... | |
| virtual Function< T > * | clone () const |
| 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::SPolynomialParam< T > | |
| 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 > | |
| Function () | |
| Constructors. More... | |
| Function (const uInt n) | |
| Function (const Vector< T > &in) | |
| Function (const FunctionParam< T > &other) | |
| Function (const Function< W, X > &other) | |
| Function (const Function< T, T > &other) | |
| virtual | ~Function () |
| Destructor. More... | |
| virtual uInt | ndim () const=0 |
| Returns the number of dimensions of function. More... | |
| uInt | nparameters () const |
| Returns the number of parameters. More... | |
| virtual T | 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 T | operator() () const |
Evaluate this function object at xor at x, y. More... | |
| virtual T | operator() (const ArgType &x) const |
| virtual T | operator() (const Vector< ArgType > &x) const |
| virtual T | operator() (FunctionArg x) const |
| virtual T | operator() (const ArgType &x, const ArgType &y) const |
| virtual T | operator() (const ArgType &x, const ArgType &y, const ArgType &z) const |
| virtual const String & | name () const |
Specify the name associated with the function (default will be unknown) More... | |
| 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, T > * | 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 |
Additional Inherited Members | |
| Public Types inherited from casacore::Function< T > | |
| typedef FunctionTraits< T >::ArgType | ArgType |
| typedef const ArgType * | FunctionArg |
| Protected Attributes inherited from casacore::Function< T > | |
| 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::SPolynomial< T >
A one dimensional scaled polynomial class
Review Status
- Test programs:
- tSPolynomial
Prerequisite
Synopsis
A SPolynomial<T> contains a set of coefficients; its fundamental operations is evaluating itself at some "x". The number of coefficients is the order of the polynomial plus one, plus an additional 3 as height, center, width.
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 84 of file SPolynomial.h.
Constructor & Destructor Documentation
◆ SPolynomial() [1/4]
template<class T >
|
inline |
Constructs a zero'th order polynomial, with a coeficcient of 0.0.
Definition at line 91 of file SPolynomial.h.
◆ SPolynomial() [2/4]
template<class T >
|
inlineexplicit |
Makes a polynomial of the given order, with all coeficcients set to zero, and height, center, width to 1,0,1.
Definition at line 94 of file SPolynomial.h.
◆ SPolynomial() [3/4]
template<class T >
|
inline |
Copy constructor/assignment (deep copy)
Definition at line 97 of file SPolynomial.h.
◆ SPolynomial() [4/4]
template<class T >
template<class W >
|
inline |
Definition at line 99 of file SPolynomial.h.
◆ ~SPolynomial()
template<class T >
|
inlinevirtual |
Destructor.
Definition at line 105 of file SPolynomial.h.
Member Function Documentation
◆ clone()
template<class T >
|
inlinevirtual |
Return a copy of this object from the heap.
The caller is responsible for deleting the pointer.
Definition at line 116 of file SPolynomial.h.
◆ cloneAD()
template<class T >
|
inlinevirtual |
Definition at line 117 of file SPolynomial.h.
◆ cloneNonAD()
template<class T >
|
inlinevirtual |
Definition at line 119 of file SPolynomial.h.
◆ eval()
template<class T >
|
virtual |
Evaluate the polynomial at x.
◆ operator=()
template<class T >
|
inline |
Definition at line 100 of file SPolynomial.h.
References casacore::SPolynomialParam< T >::operator=().
The documentation for this class was generated from the following file:
- scimath/Functionals/SPolynomial.h
