casacore
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
casacore::CombiFunction< T > Class Template Reference

Form a linear combination of function objects. More...

#include <CombiFunction.h>

Inheritance diagram for casacore::CombiFunction< T >:
casacore::CombiParam< T > casacore::Function< T > casacore::Functional< FunctionTraits< T >::ArgType, U > casacore::Functional< Vector< FunctionTraits< T >::ArgType >, U >

Public Member Functions

 CombiFunction ()
 The default constructor – no functions, no parameters, nothing, the function operator returns a 0. More...
 
 CombiFunction (const CombiFunction< T > &other)
 Make this object a (deep) copy of other. More...
 
 CombiFunction (const CombiFunction< T > &other, Bool)
 
template<class W >
 CombiFunction (const CombiFunction< W > &other)
 
template<class W >
 CombiFunction (const CombiFunction< W > &other, Bool)
 
CombiFunction< T > & operator= (const CombiFunction< T > &other)
 Make this object a (deep) copy of other. More...
 
virtual ~CombiFunction ()
 Destructor. More...
 
virtual T eval (typename Function< T >::FunctionArg x) const
 Evaluate the function at x. More...
 
virtual Function< T > * clone () const
 Return a copy of this object from the heap. More...
 
virtual Function< typename
FunctionTraits< T >::DiffType > * 
cloneAD () const
 
virtual Function< typename
FunctionTraits< T >::BaseType > * 
cloneNonAD () const
 
- Public Member Functions inherited from casacore::CombiParam< T >
 CombiParam ()
 The default constructor – no functions, no parameters, nothing, the function operator returns a 0. More...
 
 CombiParam (const CombiParam< T > &other)
 Make this object a (deep) copy of other. More...
 
 CombiParam (const CombiParam< T > &other, Bool)
 
template<class W >
 CombiParam (const CombiParam< W > &other)
 
template<class W >
 CombiParam (const CombiParam< W > &other, Bool)
 
CombiParam< T > & operator= (const CombiParam< 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< T > &newFunction)
 Add a function. More...
 
uInt nFunctions () const
 Return the total number of functions. More...
 
const Function< T > & function (uInt which) const
 Return a reference to a specific Function in the combination. More...
 
const Function< 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< T >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< 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...
 
T & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const T & operator[] (const uInt n) const
 
virtual U operator() () const
 Evaluate this function object at xor 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
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (const uInt n) const
 
const FunctionParam< T > & parameters () const
 Return the parameter interface. More...
 
FunctionParam< 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< T >::ArgType, U >
virtual ~Functional ()
 Destructor. More...
 
virtual U operator() (const FunctionTraits< T >::ArgType &x) const =0
 Map a Domain x into a Range y value. More...
 
- Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, U >
virtual ~Functional ()
 Destructor. More...
 
virtual U operator() (const Vector< FunctionTraits< T >::ArgType > &x) const =0
 Map a Domain x into a Range y value. More...
 

Additional Inherited Members

- Public Types inherited from casacore::Function< T >
typedef FunctionTraits< T >
::ArgType 
ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::CombiParam< T >
uInt ndim_p
 Number of dimensions of underlying functions. More...
 
PtrBlock< Function< T > * > functionPtr_p
 Pointer to each added function. More...
 
- Protected Attributes inherited from casacore::Function< T >
FunctionParam< 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< T >

Form a linear combination of function objects.

Intended use:

Public interface

Review Status

Reviewed By:
UNKNOWN
Date Reviewed:
before2004/08/25
Test programs:
tCombiFunction

Prerequisite

Synopsis

Given N function objects, the class describes a linear combination of the form:

f(x) = a(0)*f(0)(x) + a(1)*f(1)(x) +... + a(N-1)*f(N-1)(x)

where a = {a(n)} are parameters. If the combi function is used in a functional fitting process (see LinearFit) these parameters canm be solved for. In all aspects they behave as FunctionParam values.

Member functions are added with the addFunction() method.


Tip: Check CompoundFunction class for a combination of functions behaving as one object;

Example

In the following example a second order polynomial is built from 3 separate polynomials.

Polynomial<Double> constant(0);
Polynomial<Double> linear(1);
Polynomial<Double> square(2);
constant.setCoefficient(0, 1.0); // 1
linear.setCoefficient(1, 1.0); // x
square[2] = 1.0; // x^2
CombiFunction<Double> combination;
// form function, e0 + e1*x + e2*x^2
combination.addFunction(constant);
combination.addFunction(linear);
combination.addFunction(square);

Template Type Argument Requirements (T)

Thrown Exceptions

Motivation

This class was created to allow specialization of the evaluation in a simple way.

To Do

Definition at line 114 of file CombiFunction.h.

Constructor & Destructor Documentation

template<class T>
casacore::CombiFunction< T >::CombiFunction ( )
inline

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

Definition at line 119 of file CombiFunction.h.

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

Make this object a (deep) copy of other.

Definition at line 122 of file CombiFunction.h.

template<class T>
casacore::CombiFunction< T >::CombiFunction ( const CombiFunction< T > &  other,
Bool   
)
inline

Definition at line 124 of file CombiFunction.h.

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

Definition at line 127 of file CombiFunction.h.

template<class T>
template<class W >
casacore::CombiFunction< T >::CombiFunction ( const CombiFunction< W > &  other,
Bool   
)
inline

Definition at line 129 of file CombiFunction.h.

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

Destructor.

Definition at line 137 of file CombiFunction.h.

Member Function Documentation

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

Return a copy of this object from the heap.

The caller is responsible for deleting the pointer.

Implements casacore::Function< T >.

Definition at line 147 of file CombiFunction.h.

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

Reimplemented from casacore::Function< T >.

Definition at line 148 of file CombiFunction.h.

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

Reimplemented from casacore::Function< T >.

Definition at line 150 of file CombiFunction.h.

References casacore::True.

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

Evaluate the function at x.

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

Make this object a (deep) copy of other.

Definition at line 133 of file CombiFunction.h.

References casacore::CombiParam< T >::operator=().


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