casacore
|
Partial AutoDiff
specialization of CompoundFunction.
More...
#include <CompoundFunction.h>
Public Member Functions | |
CompoundFunction_PS () | |
The default constructor – no functions, no parameters, nothing, the function operator returns a 0. More... | |
CompoundFunction_PS (const CompoundFunction_PS< AutoDiff< T > > &other) | |
Make this object a (deep) copy of other. More... | |
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. More... | |
virtual | ~CompoundFunction_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... | |
uInt | addFunction (const Function< AutoDiff< T > > &newFunction) |
Add a function to the sum. More... | |
CompoundFunction_PS< AutoDiff < T > > & | consolidate () |
Consolidate the parameter settings. 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::CompoundParam< AutoDiff< T > > | |
CompoundParam () | |
The default constructor – no functions, no parameters, nothing, the function operator returns a 0. More... | |
CompoundParam (const CompoundParam< AutoDiff< T > > &other) | |
Make this object a (deep) copy of other. More... | |
CompoundParam (const CompoundParam< AutoDiff< T > > &other, Bool) | |
CompoundParam (const CompoundParam< W > &other) | |
CompoundParam (const CompoundParam< W > &other, Bool) | |
CompoundParam< AutoDiff< T > > & | operator= (const CompoundParam< AutoDiff< T > > &other) |
virtual | ~CompoundParam () |
virtual const String & | name () const |
Give name of function. More... | |
uInt | addFunction (const Function< AutoDiff< T > > &newFunction) |
Add a function to the sum. More... | |
uInt | nFunctions () const |
Return the number of functions in the sum. More... | |
const Function< AutoDiff< T > > & | function (uInt which) const |
Return a reference to a specific Function. More... | |
uInt | parameterOffset (uInt which) const |
Get the offset in function parameterlist for function which. More... | |
uInt | parameterFunction (uInt which) const |
Get the function number belonging to parameter list element which. More... | |
uInt | parameterLocation (uInt which) const |
Return locpar. More... | |
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... | |
uInt | nparameters () const |
Returns the number of parameters. More... | |
virtual U | 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 U | operator() () const |
Evaluate this function object at x or at x, y . More... | |
virtual U | operator() (const ArgType &x) const |
virtual U | operator() (const Vector< ArgType > &x) const |
virtual U | operator() (FunctionArg x) const |
virtual U | operator() (const ArgType &x, const ArgType &y) const |
virtual U | operator() (const ArgType &x, const ArgType &y, const ArgType &z) const |
Bool & | mask (const uInt n) |
Manipulate the mask associated with the nth parameter (e.g. More... | |
const Bool & | mask (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... | |
Public Member Functions inherited from casacore::Functional< FunctionTraits< AutoDiff< T > >::ArgType, U > | |
virtual | ~Functional () |
Destructor. More... | |
virtual U | 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 >, U > | |
virtual | ~Functional () |
Destructor. More... | |
virtual U | operator() (const Vector< FunctionTraits< AutoDiff< T > >::ArgType > &x) const =0 |
Map a Domain x into a Range y value. More... | |
Private Member Functions | |
void | fromParam_p () const |
Copy the local parameters to/from general block. More... | |
void | toParam_p () |
Make the general block from local parameters. More... | |
Additional Inherited Members | |
Public Types inherited from casacore::Function< AutoDiff< T > > | |
typedef FunctionTraits < AutoDiff< T > >::ArgType | ArgType |
typedef const ArgType * | FunctionArg |
Protected Attributes inherited from casacore::CompoundParam< AutoDiff< T > > | |
PtrBlock< Function< AutoDiff < T > > * > | functionPtr_p |
Pointer to each added function. More... | |
Block< uInt > | paroff_p |
Index of offset for each function to its parameters in general list. More... | |
Block< uInt > | funpar_p |
Index of function belonging to parameter. More... | |
Block< uInt > | locpar_p |
Index of local parameter. More... | |
Protected Attributes inherited from casacore::Function< AutoDiff< T > > | |
FunctionParam< AutoDiff< T > > | param_p |
The parameters and masks. More... | |
Vector< ArgType > | arg_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... | |
Partial AutoDiff
specialization of CompoundFunction.
Warning: The name CompoundFunction_PS
is only for cxx2html documentation problems; Use CompoundFunction
in your code;
Definition at line 198 of file CompoundFunction.h.
|
inline |
The default constructor – no functions, no parameters, nothing, the function operator returns a 0.
Definition at line 205 of file CompoundFunction.h.
|
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.
|
inline |
Definition at line 213 of file CompoundFunction.h.
|
inlinevirtual |
Destructor.
Definition at line 223 of file CompoundFunction.h.
uInt casacore::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.
|
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 245 of file CompoundFunction.h.
|
inlinevirtual |
Reimplemented from casacore::Function< AutoDiff< T > >.
Definition at line 248 of file CompoundFunction.h.
|
inlinevirtual |
Reimplemented from casacore::Function< AutoDiff< T > >.
Definition at line 252 of file CompoundFunction.h.
References casacore::True.
|
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.
|
virtual |
Evaluate the function and its derivatives at x
wrt to the coefficients.
|
private |
Copy the local parameters to/from general block.
|
inline |
Make this object a (deep) copy of other.
Definition at line 218 of file CompoundFunction.h.
|
private |
Make the general block from local parameters.