casa::CompoundFunction_PS< AutoDiff< T > > Class Template Reference

Partial AutoDiff specialization of CompoundFunction. More...

#include <CompoundFunction.h>

Inheritance diagram for casa::CompoundFunction_PS< AutoDiff< T > >:

List of all members.

Public Member Functions
	CompoundFunction_PS ()
	The default constructor -- no functions, no parameters, nothing, the function operator returns a 0.
	CompoundFunction_PS (const CompoundFunction_PS< AutoDiff< T > > &other)
	Make this object a (deep) copy of other.
template<class W >
	CompoundFunction_PS (const CompoundFunction_PS< W > &other)
CompoundFunction_PS< AutoDiff < T > > &	operator= (const CompoundFunction_PS< AutoDiff< T > > &other)
	Make this object a (deep) copy of other.
virtual	~CompoundFunction_PS ()
	Destructor.
virtual AutoDiff< T >	eval (typename Function< AutoDiff< T > >::FunctionArg x) const
	Evaluate the function and its derivatives at x wrt to the coefficients.
uInt	addFunction (const Function< AutoDiff< T > > &newFunction)
	Add a function to the sum.
CompoundFunction_PS< AutoDiff < T > > &	consolidate ()
	Consolidate the parameter settings.
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
Private Member Functions
void	fromParam_p () const
void	toParam_p ()
	Make the general block from local parameters.

---

Detailed Description

template<class T>
class casa::CompoundFunction_PS< AutoDiff< T > >

Partial AutoDiff specialization of CompoundFunction.

Synopsis

Warning: The name CompoundFunction_PS is only for cxx2html documentation problems; Use CompoundFunction in your code;

Definition at line 198 of file CompoundFunction.h.

---

Constructor & Destructor Documentation

template<class T >

casa::CompoundFunction_PS< AutoDiff< T > >::CompoundFunction_PS

(

)

[inline]

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

Definition at line 205 of file CompoundFunction.h.

template<class T >

casa::CompoundFunction_PS< AutoDiff< T > >::CompoundFunction_PS

(

const CompoundFunction_PS< AutoDiff< T > > &

other

)

[inline]

Make this object a (deep) copy of other.

If parameters have been set without an intervening calculation, a consolidate() could be necessary on other first.

Definition at line 210 of file CompoundFunction.h.

template<class T >

template<class W >

casa::CompoundFunction_PS< AutoDiff< T > >::CompoundFunction_PS

(

const CompoundFunction_PS< W > &

other

)

[inline]

Definition at line 213 of file CompoundFunction.h.

template<class T >

virtual casa::CompoundFunction_PS< AutoDiff< T > >::~CompoundFunction_PS

(

)

[inline, virtual]

Destructor.

Definition at line 223 of file CompoundFunction.h.

---

Member Function Documentation

template<class T >

uInt casa::CompoundFunction_PS< AutoDiff< T > >::addFunction

(

const Function< AutoDiff< T > > &

newFunction

)

Add a function to the sum.

All functions must have the same ndim() as the first one. Returns the (zero relative) number of the function just added.

Reimplemented from casa::CompoundParam< AutoDiff< T > >.

template<class T >

virtual Function<AutoDiff<T> >* casa::CompoundFunction_PS< AutoDiff< T > >::clone

(

)

const [inline, virtual]

Return a copy of this object from the heap.

The caller is responsible for deleting the pointer.

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

Definition at line 245 of file CompoundFunction.h.

template<class T >

virtual Function<typename FunctionTraits<AutoDiff<T> >::DiffType>* casa::CompoundFunction_PS< AutoDiff< T > >::cloneAD

(

)

const [inline, virtual]

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

Definition at line 248 of file CompoundFunction.h.

template<class T >

virtual Function<typename FunctionTraits<AutoDiff<T> >::BaseType>* casa::CompoundFunction_PS< AutoDiff< T > >::cloneNonAD

(

)

const [inline, virtual]

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

Definition at line 252 of file CompoundFunction.h.

References casa::True.

template<class T >

CompoundFunction_PS<AutoDiff<T> >& casa::CompoundFunction_PS< AutoDiff< T > >::consolidate

(

)

[inline]

Consolidate the parameter settings.

This could be necessary if parameters have been set, and a copy constructor called. This is necessary before and after the setting of local parameters; i.e. the parameters of the individual functions.

Definition at line 240 of file CompoundFunction.h.

template<class T >

virtual AutoDiff<T> casa::CompoundFunction_PS< AutoDiff< T > >::eval

(

typename Function< AutoDiff< T > >::FunctionArg

x

)

const [virtual]

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

template<class T >

void casa::CompoundFunction_PS< AutoDiff< T > >::fromParam_p

(

)

const [private]

Copy the local parameters to/from general block

template<class T >

CompoundFunction_PS<AutoDiff<T> >& casa::CompoundFunction_PS< AutoDiff< T > >::operator=

(

const CompoundFunction_PS< AutoDiff< T > > &

other

)

[inline]

Make this object a (deep) copy of other.

Definition at line 218 of file CompoundFunction.h.

template<class T >

void casa::CompoundFunction_PS< AutoDiff< T > >::toParam_p

(

)

[private]

Make the general block from local parameters.

---

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

• casacore/scimath/Functionals/CompoundFunction.h