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

Partial specialization of CombiFunction for AutoDiff More...

#include <CombiFunction.h>

Public Member Functions

 CombiFunction_PS ()
 The default constructor – no functions, no parameters, nothing, the function operator returns a 0. More...
 
 CombiFunction_PS (const CombiFunction_PS< AutoDiff< T > > &other)
 Make this object a (deep) copy of other. More...
 
template<class W >
 CombiFunction_PS (const CombiFunction_PS< W > &other)
 
CombiFunction_PS< AutoDiff< T > > & operator= (const CombiFunction_PS< AutoDiff< T > > &other)
 Make this object a (deep) copy of other. More...
 
virtual ~CombiFunction_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::CombiParam< AutoDiff< T > >
 CombiParam ()
 The default constructor – no functions, no parameters, nothing, the function operator returns a 0. More...
 
 CombiParam (const CombiParam< AutoDiff< T > > &other)
 Make this object a (deep) copy of other. More...
 
 CombiParam (const CombiParam< AutoDiff< T > > &other, Bool)
 
 CombiParam (const CombiParam< W > &other)
 
 CombiParam (const CombiParam< W > &other, Bool)
 
CombiParam< AutoDiff< T > > & operator= (const CombiParam< AutoDiff< T > > &other)
 Make this object a (deep) copy of other. More...
 
virtual ~CombiParam ()
 Destructor. More...
 
virtual const Stringname () const
 Give name of function. More...
 
uInt addFunction (const Function< AutoDiff< T > > &newFunction)
 Add a function. More...
 
uInt nFunctions () const
 Return the total number of functions. More...
 
const Function< AutoDiff< T > > & function (uInt which) const
 Return a reference to a specific Function in the combination. More...
 
const Function< AutoDiff< T > > & function (uInt which)
 
virtual uInt ndim () const
 Returns the dimension of functions in the linear combination. More...
 
- Public Member Functions inherited from casacore::Function< 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::Function< AutoDiff< T > >
typedef FunctionTraits< AutoDiff< T > >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::CombiParam< AutoDiff< T > >
uInt ndim_p
 Number of dimensions of underlying functions. More...
 
PtrBlock< Function< AutoDiff< T > > * > functionPtr_p
 Pointer to each added function. More...
 
- Protected Attributes inherited from casacore::Function< 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::CombiFunction_PS< AutoDiff< T > >

Partial specialization of CombiFunction for AutoDiff

Synopsis


Warning: The name CombiFunction_PS is only for cxx2html documentation problems; Use CombiFunction in your code;

Definition at line 169 of file CombiFunction.h.

Constructor & Destructor Documentation

◆ CombiFunction_PS() [1/3]

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

The default constructor – no functions, no parameters, nothing, the function operator returns a 0.

Definition at line 175 of file CombiFunction.h.

◆ CombiFunction_PS() [2/3]

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

Make this object a (deep) copy of other.

Definition at line 178 of file CombiFunction.h.

◆ CombiFunction_PS() [3/3]

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

Definition at line 181 of file CombiFunction.h.

◆ ~CombiFunction_PS()

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

Destructor.

Definition at line 190 of file CombiFunction.h.

Member Function Documentation

◆ clone()

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

Return a copy of this object from the heap.

The caller is responsible for deleting the pointer.

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

Definition at line 201 of file CombiFunction.h.

◆ cloneAD()

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

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

Definition at line 204 of file CombiFunction.h.

◆ cloneNonAD()

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

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

Definition at line 208 of file CombiFunction.h.

References casacore::True.

◆ eval()

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

Make this object a (deep) copy of other.

Definition at line 186 of file CombiFunction.h.


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