casacore
Public Member Functions | List of all members
casacore::Polynomial_PS< AutoDiff< T > > Class Template Reference

Partial specialization of Polynomial for AutoDiff More...

#include <Polynomial.h>

Public Member Functions

 Polynomial_PS ()
 Constructs one dimensional Polynomials. More...
 
 Polynomial_PS (uInt order)
 
 Polynomial_PS (const Polynomial_PS< AutoDiff< T > > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 Polynomial_PS (const Polynomial_PS< W > &other)
 
Polynomial_PS< AutoDiff< T > > & operator= (const Polynomial_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~Polynomial_PS ()
 Destructor. More...
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the polynomial and its derivatives at x wrt to the coefficients. More...
 
virtual Function< AutoDiff< T > > * clone () const
 Return a copy of this object from the heap. More...
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::PolynomialParam< AutoDiff< T > >
 PolynomialParam ()
 Constructs a zero'th order polynomial, with a coeficcient of 0.0. More...
 
 PolynomialParam (uInt order)
 Makes a polynomial of the given order, with all coeficcients set to zero. More...
 
 PolynomialParam (const PolynomialParam< AutoDiff< T > > &other)
 Make this a copy of other (deep copy). More...
 
 PolynomialParam (const PolynomialParam< W > &other)
 
PolynomialParam< AutoDiff< T > > & operator= (const PolynomialParam< AutoDiff< T > > &other)
 
 ~PolynomialParam ()
 Destructor. More...
 
Bool operator== (const PolynomialParam< AutoDiff< T > > &other) const
 Comparisons. More...
 
Bool operator!= (const PolynomialParam< AutoDiff< T > > &other) const
 
virtual const Stringname () const
 Give name of function. More...
 
uInt order () const
 What is the order of the polynomial, i.e. More...
 
AutoDiff< T > coefficient (uInt which) const
 What is the which'th coefficient of the polynomial. More...
 
const Vector< AutoDiff< T > > & coefficients () const
 Return all the coefficients as a vector. More...
 
void setCoefficient (uInt which, const AutoDiff< T > value)
 Set the which'th coefficient to value. More...
 
void setCoefficients (const Vector< AutoDiff< T > > &coefficients)
 Set all the coefficients at once, throw away all existing coefficients. More...
 
- Public Member Functions inherited from casacore::Function1D< AutoDiff< T > >
 Function1D ()
 Constructors. More...
 
 Function1D (const uInt n)
 
 Function1D (const Vector< AutoDiff< T > > &in)
 
 Function1D (const FunctionParam< AutoDiff< 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< AutoDiff< T >, AutoDiff< T > >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< AutoDiff< T > > &in)
 
 Function (const FunctionParam< AutoDiff< T > > &other)
 
 Function (const Function< W, X > &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 AutoDiff< T > eval (FunctionArg x) const=0
 Evaluate the function object. More...
 
AutoDiff< T > & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const AutoDiff< T > & operator[] (const uInt n) const
 
virtual AutoDiff< T > operator() () const
 Evaluate this function object at xor at x, y. More...
 
virtual AutoDiff< T > operator() (const ArgType &x) const
 
virtual AutoDiff< T > operator() (const Vector< ArgType > &x) const
 
virtual AutoDiff< T > operator() (FunctionArg x) const
 
virtual AutoDiff< T > operator() (const ArgType &x, const ArgType &y) const
 
virtual AutoDiff< T > operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
 
virtual const Stringname () const
 Specify the name associated with the function (default will be unknown) More...
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (const uInt n) const
 
const FunctionParam< AutoDiff< T > > & parameters () const
 Return the parameter interface. More...
 
FunctionParam< AutoDiff< 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< AutoDiff< T >, AutoDiff< T > > * clone () const=0
 Return a copy of this object from the heap. More...
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::Functional< FunctionTraits< AutoDiff< T > >::ArgType, AutoDiff< T > >
virtual ~Functional ()
 Destructor. More...
 
virtual AutoDiff< T > operator() (const FunctionTraits< AutoDiff< T > >::ArgType &x) const=0
 Map a Domain x into a Range y value. More...
 
- Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< AutoDiff< T > >::ArgType >, AutoDiff< T > >
virtual ~Functional ()
 Destructor. More...
 
virtual AutoDiff< T > operator() (const Vector< FunctionTraits< AutoDiff< T > >::ArgType > &x) const=0
 Map a Domain x into a Range y value. More...
 

Additional Inherited Members

- Public Types inherited from casacore::Function1D< AutoDiff< T > >
typedef const AutoDiff< T > * FunctionArg
 
- Public Types inherited from casacore::Function< AutoDiff< T >, AutoDiff< T > >
typedef FunctionTraits< AutoDiff< T > >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< AutoDiff< T >, AutoDiff< T > >
FunctionParam< AutoDiff< T > > param_p
 The parameters and masks. More...
 
Vector< ArgTypearg_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::Polynomial_PS< AutoDiff< T > >

Partial specialization of Polynomial for AutoDiff

Synopsis


Warning: The name Polynomial_PS is only for cxx2html documentation problems; Use Polynomial in your code;

Definition at line 149 of file Polynomial.h.

Constructor & Destructor Documentation

◆ Polynomial_PS() [1/4]

template<class T >
casacore::Polynomial_PS< AutoDiff< T > >::Polynomial_PS ( )
inline

Constructs one dimensional Polynomials.

Definition at line 155 of file Polynomial.h.

◆ Polynomial_PS() [2/4]

template<class T >
casacore::Polynomial_PS< AutoDiff< T > >::Polynomial_PS ( uInt  order)
inlineexplicit

Definition at line 156 of file Polynomial.h.

◆ Polynomial_PS() [3/4]

template<class T >
casacore::Polynomial_PS< AutoDiff< T > >::Polynomial_PS ( const Polynomial_PS< AutoDiff< T > > &  other)
inline

Copy constructor (deep copy)

Definition at line 162 of file Polynomial.h.

◆ Polynomial_PS() [4/4]

template<class T >
template<class W >
casacore::Polynomial_PS< AutoDiff< T > >::Polynomial_PS ( const Polynomial_PS< W > &  other)
inline

Definition at line 165 of file Polynomial.h.

◆ ~Polynomial_PS()

template<class T >
virtual casacore::Polynomial_PS< AutoDiff< T > >::~Polynomial_PS ( )
inlinevirtual

Destructor.

Definition at line 175 of file Polynomial.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function< AutoDiff< T > > * casacore::Polynomial_PS< AutoDiff< T > >::clone ( ) const
inlinevirtual

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Implements casacore::Function< AutoDiff< T >, AutoDiff< T > >.

Definition at line 188 of file Polynomial.h.

◆ cloneAD()

template<class T >
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * casacore::Polynomial_PS< AutoDiff< T > >::cloneAD ( ) const
inlinevirtual

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

Definition at line 191 of file Polynomial.h.

◆ cloneNonAD()

template<class T >
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * casacore::Polynomial_PS< AutoDiff< T > >::cloneNonAD ( ) const
inlinevirtual

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

Definition at line 195 of file Polynomial.h.

◆ eval()

template<class T >
virtual AutoDiff< T > casacore::Polynomial_PS< AutoDiff< T > >::eval ( typename Function< AutoDiff< T > >::FunctionArg  x) const
virtual

Evaluate the polynomial and its derivatives at x wrt to the coefficients.

◆ operator=()

template<class T >
Polynomial_PS< AutoDiff< T > > & casacore::Polynomial_PS< AutoDiff< T > >::operator= ( const Polynomial_PS< AutoDiff< T > > &  other)
inline

Copy assignment (deep copy)

Definition at line 171 of file Polynomial.h.


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