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. | |
| CombiFunction_PS (const CombiFunction_PS< AutoDiff< T > > &other) | |
| Make this object a (deep) copy of other. | |
| 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. | |
| virtual | ~CombiFunction_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. | |
| 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::CombiParam< AutoDiff< T > > | |
| CombiParam () | |
| The default constructor – no functions, no parameters, nothing, the function operator returns a 0. | |
| CombiParam< T > & | operator= (const CombiParam< T > &other) |
| Make this object a (deep) copy of other. | |
| virtual | ~CombiParam () |
| Destructor. | |
| virtual const String & | name () const |
| Give name of function. | |
| uInt | addFunction (const Function< T > &newFunction) |
| Add a function. | |
| uInt | nFunctions () const |
| Return the total number of functions. | |
| const Function< T > & | function (uInt which) const |
| Return a reference to a specific Function in the combination. | |
| virtual uInt | ndim () const |
| Returns the dimension of functions in the linear combination. | |
| Public Member Functions inherited from casacore::Function< T, U > | |
| Function () | |
| Constructors. | |
| Function (const uInt n) | |
| Function (const Vector< T > &in) | |
| Function (const FunctionParam< T > &other) | |
| template<class W, class X> | |
| Function (const Function< W, X > &other) | |
| virtual | ~Function () |
| Destructor. | |
| uInt | nparameters () const |
| Returns the number of parameters. | |
| virtual U | 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 U | operator() () const |
| Evaluate this function object at xor at x, y. | |
| 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. | |
| const Bool & | mask (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::Function< T, U > | |
| typedef FunctionTraits< T >::ArgType | ArgType |
| typedef const ArgType * | FunctionArg |
| Protected Attributes inherited from casacore::CombiParam< AutoDiff< T > > | |
| uInt | ndim_p |
| Number of dimensions of underlying functions. | |
| PtrBlock< Function< T > * > | functionPtr_p |
| Pointer to each added function. | |
| Protected Attributes inherited from casacore::Function< T, U > | |
| FunctionParam< T > | param_p |
| The parameters and masks. | |
| Vector< ArgType > | arg_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
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 166 of file CombiFunction.h.
Constructor & Destructor Documentation
◆ CombiFunction_PS() [1/3]
|
inline |
The default constructor – no functions, no parameters, nothing, the function operator returns a 0.
Definition at line 172 of file CombiFunction.h.
References casacore::CombiParam< AutoDiff< T > >::CombiParam().
Referenced by clone(), CombiFunction_PS(), CombiFunction_PS(), and operator=().
◆ CombiFunction_PS() [2/3]
|
inline |
Make this object a (deep) copy of other.
Definition at line 175 of file CombiFunction.h.
References CombiFunction_PS(), and casacore::CombiParam< AutoDiff< T > >::CombiParam().
◆ CombiFunction_PS() [3/3]
|
inline |
Definition at line 178 of file CombiFunction.h.
References CombiFunction_PS(), and casacore::CombiParam< AutoDiff< T > >::CombiParam().
◆ ~CombiFunction_PS()
|
inlinevirtual |
Destructor.
Definition at line 187 of file CombiFunction.h.
Member Function Documentation
◆ clone()
|
inlinevirtual |
Return a copy of this object from the heap.
The caller is responsible for deleting the pointer.
Implements casacore::Function< T, U >.
Definition at line 198 of file CombiFunction.h.
References CombiFunction_PS().
◆ cloneAD()
|
inlinevirtual |
Reimplemented from casacore::Function< T, U >.
Definition at line 201 of file CombiFunction.h.
◆ cloneNonAD()
|
inlinevirtual |
Reimplemented from casacore::Function< T, U >.
Definition at line 205 of file CombiFunction.h.
References casacore::True.
◆ eval()
|
virtual |
Evaluate the function and its derivatives at x wrt to the coefficients.
◆ operator=()
|
inline |
Make this object a (deep) copy of other.
Definition at line 183 of file CombiFunction.h.
References CombiFunction_PS(), and casacore::CombiParam< AutoDiff< T > >::CombiParam().
The documentation for this class was generated from the following file:
- scimath/Functionals/CombiFunction.h
Generated by
1.15.0