casacore
Loading...
Searching...
No Matches
casacore::OddPolynomial_PS< AutoDiff< T > > Class Template Reference

Partial specialization of OddPolynomial for AutoDiff More...

#include <OddPolynomial.h>

Public Member Functions

 OddPolynomial_PS ()
 Constructs one dimensional OddPolynomials.
 
 OddPolynomial_PS (uInt order)
 
 OddPolynomial_PS (const OddPolynomial_PS< AutoDiff< T > > &other)
 Copy constructor (deep copy)
 
template<class W >
 OddPolynomial_PS (const OddPolynomial_PS< W > &other)
 
OddPolynomial_PS< AutoDiff< T > > & operator= (const OddPolynomial_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy)
 
virtual ~OddPolynomial_PS ()
 Destructor.
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the polynomial and its derivatives at x wrt to the coefficients.
 
virtual Function< AutoDiff< T > > * clone () const
 Return a copy of this object from the heap.
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::OddPolynomialParam< AutoDiff< T > >
 OddPolynomialParam ()
 Constructs a first order polynomial, with a coeficcient of 0.0.
 
 OddPolynomialParam (uInt order)
 Makes a polynomial of the given order, with all coeficcients set to zero.
 
 OddPolynomialParam (const OddPolynomialParam< T > &other)
 Make this a copy of other (deep copy).
 
 OddPolynomialParam (const OddPolynomialParam< W > &other)
 
OddPolynomialParam< T > & operator= (const OddPolynomialParam< T > &other)
 
 ~OddPolynomialParam ()
 Destructor.
 
Bool operator== (const OddPolynomialParam< T > &other) const
 Comparisons.
 
Bool operator!= (const OddPolynomialParam< T > &other) const
 
virtual const Stringname () const
 Give name of function.
 
uInt order () const
 What is the order of the polynomial, i.e.
 
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.
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
 Function (const Function< W, X > &other)
 
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.
 
const T & operator[] (const uInt n) const
 
virtual T operator() () const
 Evaluate this function object at xor at x, y.
 
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.
 
const Boolmask (const uInt n) const
 
const FunctionParam< T > & parameters () const
 Return the parameter interface.
 
FunctionParam< T > & parameters ()
 
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.
 
- 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 ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< T, T >
FunctionParam< T > param_p
 The parameters and masks.
 
Vector< ArgTypearg_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::OddPolynomial_PS< AutoDiff< T > >

Partial specialization of OddPolynomial for AutoDiff

Synopsis


Warning: The name OddPolynomial_PS is only for cxx2html documentation problems; Use OddPolynomial in your code;

Definition at line 138 of file OddPolynomial.h.

Constructor & Destructor Documentation

◆ OddPolynomial_PS() [1/4]

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

Constructs one dimensional OddPolynomials.

Definition at line 145 of file OddPolynomial.h.

◆ OddPolynomial_PS() [2/4]

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

Definition at line 146 of file OddPolynomial.h.

◆ OddPolynomial_PS() [3/4]

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

Copy constructor (deep copy)

Definition at line 152 of file OddPolynomial.h.

◆ OddPolynomial_PS() [4/4]

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

Definition at line 155 of file OddPolynomial.h.

◆ ~OddPolynomial_PS()

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

Destructor.

Definition at line 164 of file OddPolynomial.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function< AutoDiff< T > > * casacore::OddPolynomial_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 177 of file OddPolynomial.h.

◆ cloneAD()

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

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

Definition at line 180 of file OddPolynomial.h.

◆ cloneNonAD()

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

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

Definition at line 184 of file OddPolynomial.h.

◆ eval()

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

Copy assignment (deep copy)

Definition at line 160 of file OddPolynomial.h.


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