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

Partial specialization of PowerLogarithmicPolynomial for AutoDiff More...

#include <PowerLogarithmicPolynomial.h>

Public Member Functions

 PowerLogarithmicPolynomial_PS ()
 Constructs one dimensional Polynomials. More...
 
 PowerLogarithmicPolynomial_PS (uInt n)
 
 PowerLogarithmicPolynomial_PS (const PowerLogarithmicPolynomial_PS< AutoDiff< T > > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 PowerLogarithmicPolynomial_PS (const PowerLogarithmicPolynomial_PS< W > &other)
 
PowerLogarithmicPolynomial_PS< AutoDiff< T > > & operator= (const PowerLogarithmicPolynomial_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~PowerLogarithmicPolynomial_PS ()
 Destructor. More...
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the function 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::PowerLogarithmicPolynomialParam< AutoDiff< T > >
 PowerLogarithmicPolynomialParam ()
 Constructs a function with two coefficients, both 1 (so y = x). More...
 
 PowerLogarithmicPolynomialParam (uInt n)
 Makes a polynomial of the specified number of coefficients, all set to zero. More...
 
 PowerLogarithmicPolynomialParam (const vector< AutoDiff< T > > &parms)
 
 PowerLogarithmicPolynomialParam (const PowerLogarithmicPolynomialParam< AutoDiff< T > > &other)
 Make this a copy of other (deep copy). More...
 
 PowerLogarithmicPolynomialParam (const PowerLogarithmicPolynomialParam< W > &other)
 
PowerLogarithmicPolynomialParam< AutoDiff< T > > & operator= (const PowerLogarithmicPolynomialParam< AutoDiff< T > > &other)
 
virtual ~PowerLogarithmicPolynomialParam ()
 Destructor. More...
 
Bool operator== (const PowerLogarithmicPolynomialParam< AutoDiff< T > > &other) const
 Comparisons. More...
 
Bool operator!= (const PowerLogarithmicPolynomialParam< AutoDiff< T > > &other) const
 
virtual const Stringname () const
 Give name of function. 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::PowerLogarithmicPolynomial_PS< AutoDiff< T > >

Partial specialization of PowerLogarithmicPolynomial for AutoDiff

Synopsis


Warning: The name PowerLogarithmicPolynomial_PS is only for cxx2html documentation problems; Use PowerLogarithmicPolynomial in your code;

Definition at line 137 of file PowerLogarithmicPolynomial.h.

Constructor & Destructor Documentation

◆ PowerLogarithmicPolynomial_PS() [1/4]

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

Constructs one dimensional Polynomials.

Definition at line 143 of file PowerLogarithmicPolynomial.h.

◆ PowerLogarithmicPolynomial_PS() [2/4]

template<class T >
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::PowerLogarithmicPolynomial_PS ( uInt  n)
inlineexplicit

Definition at line 144 of file PowerLogarithmicPolynomial.h.

◆ PowerLogarithmicPolynomial_PS() [3/4]

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

Copy constructor (deep copy)

Definition at line 150 of file PowerLogarithmicPolynomial.h.

◆ PowerLogarithmicPolynomial_PS() [4/4]

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

Definition at line 153 of file PowerLogarithmicPolynomial.h.

◆ ~PowerLogarithmicPolynomial_PS()

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

Destructor.

Definition at line 163 of file PowerLogarithmicPolynomial.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function< AutoDiff< T > > * casacore::PowerLogarithmicPolynomial_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 176 of file PowerLogarithmicPolynomial.h.

◆ cloneAD()

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

◆ cloneNonAD()

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

◆ eval()

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

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

◆ operator=()

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

Copy assignment (deep copy)

Definition at line 159 of file PowerLogarithmicPolynomial.h.


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