casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
casacore::CombiParam< T > Class Template Reference

Parameters for a linear combination of function objects. More...

#include <CombiParam.h>

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

Public Member Functions

 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)
 
 Function (const Function< T, U > &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...
 
virtual Function< T, U > * clone () const =0
 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::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...
 

Protected Attributes

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...
 

Additional Inherited Members

- Public Types inherited from casacore::Function< T >
typedef FunctionTraits< T >
::ArgType 
ArgType
 
typedef const ArgTypeFunctionArg
 

Detailed Description

template<class T>
class casacore::CombiParam< T >

Parameters for a linear combination of function objects.

Intended use:

Internal

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.

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
CombiParam<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 111 of file CombiParam.h.

Constructor & Destructor Documentation

template<class T>
casacore::CombiParam< T >::CombiParam ( )

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

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

Make this object a (deep) copy of other.

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

Definition at line 121 of file CombiParam.h.

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

Definition at line 129 of file CombiParam.h.

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

Definition at line 137 of file CombiParam.h.

template<class T>
virtual casacore::CombiParam< T >::~CombiParam ( )
virtual

Destructor.

Member Function Documentation

template<class T>
uInt casacore::CombiParam< T >::addFunction ( const Function< T > &  newFunction)

Add a function.

All functions must have the same ndim() as the first one. Returns the (zero relative) number (i) of the function just added. The default initial parameter value (a(i)) is initialized to 1. The parameter mask is set True.

template<class T>
const Function<T>& casacore::CombiParam< T >::function ( uInt  which) const
inline

Return a reference to a specific Function in the combination.

Definition at line 170 of file CombiParam.h.

Referenced by casacore::CombiParam< AutoDiff< T > >::CombiParam().

template<class T>
const Function<T>& casacore::CombiParam< T >::function ( uInt  which)
inline

Definition at line 173 of file CombiParam.h.

template<class T>
virtual const String& casacore::CombiParam< T >::name ( ) const
inlinevirtual

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 154 of file CombiParam.h.

template<class T>
virtual uInt casacore::CombiParam< T >::ndim ( ) const
inlinevirtual

Returns the dimension of functions in the linear combination.

Implements casacore::Function< T >.

Definition at line 179 of file CombiParam.h.

template<class T>
uInt casacore::CombiParam< T >::nFunctions ( ) const
inline

Return the total number of functions.

The number is equal to the number of functions that have been added.

Definition at line 166 of file CombiParam.h.

Referenced by casacore::CombiParam< AutoDiff< T > >::CombiParam(), and casacore::CombiParam< AutoDiff< T > >::function().

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

Make this object a (deep) copy of other.

Referenced by casacore::CombiFunction< T >::operator=().

Member Data Documentation

template<class T>
PtrBlock<Function<T> *> casacore::CombiParam< T >::functionPtr_p
protected

Pointer to each added function.

Definition at line 187 of file CombiParam.h.

Referenced by casacore::CombiParam< AutoDiff< T > >::CombiParam(), and casacore::CombiParam< AutoDiff< T > >::function().

template<class T>
uInt casacore::CombiParam< T >::ndim_p
protected

Number of dimensions of underlying functions.

Definition at line 184 of file CombiParam.h.

Referenced by casacore::CombiParam< AutoDiff< T > >::ndim().


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