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

Partial specialization of EvenPolynomial for AutoDiff More...

#include <EvenPolynomial.h>

Public Member Functions

 EvenPolynomial_PS ()
 Constructs one dimensional EvenPolynomials. More...
 
 EvenPolynomial_PS (uInt order)
 
 EvenPolynomial_PS (const EvenPolynomial_PS< AutoDiff< T > > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 EvenPolynomial_PS (const EvenPolynomial_PS< W > &other)
 
EvenPolynomial_PS< AutoDiff< T > > & operator= (const EvenPolynomial_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~EvenPolynomial_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::EvenPolynomialParam< AutoDiff< T > >
 EvenPolynomialParam ()
 Constructs a zero'th order polynomial, with a coeficcient of 0.0. More...
 
 EvenPolynomialParam (uInt order)
 Makes a polynomial of the given order, with all coeficcients set to zero. More...
 
 EvenPolynomialParam (const EvenPolynomialParam< AutoDiff< T > > &other)
 Make this a copy of other (deep copy). More...
 
 EvenPolynomialParam (const EvenPolynomialParam< W > &other)
 
EvenPolynomialParam< AutoDiff< T > > & operator= (const EvenPolynomialParam< AutoDiff< T > > &other)
 
 ~EvenPolynomialParam ()
 Destructor. More...
 
Bool operator== (const EvenPolynomialParam< AutoDiff< T > > &other) const
 Comparisons. More...
 
Bool operator!= (const EvenPolynomialParam< 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< T, U >
 Function1D ()
 Constructors. More...
 
 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. More...
 
virtual uInt ndim () const
 Returns the number of dimensions of function. More...
 
- Public Member Functions inherited from casacore::Function< T, T >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
 Function (const Function< W, X > &other)
 
virtual ~Function ()
 Destructor. 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
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (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...
 
- 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::Function1D< T, U >
typedef const T * FunctionArg
 
- Public Types inherited from casacore::Function< T, T >
typedef FunctionTraits< T >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< T, T >
FunctionParam< 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::EvenPolynomial_PS< AutoDiff< T > >

Partial specialization of EvenPolynomial for AutoDiff

Synopsis


Warning: The name EvenPolynomial_PS is only for cxx2html documentation problems; Use EvenPolynomial in your code;

Definition at line 140 of file EvenPolynomial.h.

Constructor & Destructor Documentation

◆ EvenPolynomial_PS() [1/4]

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

Constructs one dimensional EvenPolynomials.

Definition at line 147 of file EvenPolynomial.h.

◆ EvenPolynomial_PS() [2/4]

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

Definition at line 148 of file EvenPolynomial.h.

◆ EvenPolynomial_PS() [3/4]

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

Copy constructor (deep copy)

Definition at line 154 of file EvenPolynomial.h.

◆ EvenPolynomial_PS() [4/4]

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

Definition at line 157 of file EvenPolynomial.h.

◆ ~EvenPolynomial_PS()

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

Destructor.

Definition at line 166 of file EvenPolynomial.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function<AutoDiff<T> >* casacore::EvenPolynomial_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< T, T >.

Definition at line 179 of file EvenPolynomial.h.

◆ cloneAD()

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

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

Definition at line 182 of file EvenPolynomial.h.

◆ cloneNonAD()

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

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

Definition at line 186 of file EvenPolynomial.h.

◆ eval()

template<class T >
virtual AutoDiff<T> casacore::EvenPolynomial_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 >
EvenPolynomial_PS<AutoDiff<T> >& casacore::EvenPolynomial_PS< AutoDiff< T > >::operator= ( const EvenPolynomial_PS< AutoDiff< T > > &  other)
inline

Copy assignment (deep copy)

Definition at line 162 of file EvenPolynomial.h.


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