casacore::WrapperParam< T > Class Template Reference

Parameter handling for wrapped function objects. More...

#include <WrapperParam.h>

Inheritance diagram for casacore::WrapperParam< T >:

Public Member Functions
	WrapperParam ()
	Construct with the given parameters. More...
	WrapperParam (const T &par)
	WrapperParam (const Vector< T > &par)
	WrapperParam (const WrapperParam< T > &other)
	Copy constructor (deep copy) More...
WrapperParam< T > &	operator= (const WrapperParam< T > &other)
	Copy assignment (deep copy) More...
virtual	~WrapperParam ()
	Destructor. More...
virtual const String &	name () const
	Give name of function. 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...
virtual uInt	ndim () const =0
	Returns the number of dimensions of function. 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
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< 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...

Additional Inherited Members
Public Types inherited from casacore::Function< T >
typedef FunctionTraits< T > ::ArgType	ArgType
typedef const ArgType *	FunctionArg
Protected Attributes inherited from casacore::Function< T >
FunctionParam< 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...

Detailed Description

template<class T>
class casacore::WrapperParam< T >

Parameter handling for wrapped function objects.

Intended use:

Internal

Review Status

Reviewed By:

UNKNOWN

Date Reviewed:

before2004/08/25

Prerequisite

• Function class
• FunctionWrapper

Synopsis

This class is provided to enable easy specialization for the actual FunctionWrapper class.

Example

Float func(const Vector<Float>& x) {return x(0)*x(1);}        // x*y
// Convert C++ functions to Function
FunctionWrapper<Float> Func(func, 2);

Template Type Argument Requirements (T)

• T should have standard numerical operators and exp() function. Current implementation only tested for real types (and their AutoDiffs).

Thrown Exceptions

• Assertion in debug mode if attempt is made to set a negative width
• AipsError if incorrect parameter number specified.

To Do

• Nothing I know of

Definition at line 81 of file WrapperParam.h.

Constructor & Destructor Documentation

template<class T>

casacore::WrapperParam< T >::WrapperParam

(

)

Construct with the given parameters.

template<class T>

casacore::WrapperParam< T >::WrapperParam ( const T &  par )

explicit

template<class T>

casacore::WrapperParam< T >::WrapperParam ( const Vector< T > &  par )

explicit

template<class T>

casacore::WrapperParam< T >::WrapperParam

(

const WrapperParam< T > &

other

)

Copy constructor (deep copy)

template<class T>

virtual casacore::WrapperParam< T >::~WrapperParam ( )

virtual

Destructor.

Member Function Documentation

template<class T>

virtual const String& casacore::WrapperParam< T >::name ( ) const

inlinevirtual

Give name of function.

Reimplemented from casacore::Function< T >.

Definition at line 106 of file WrapperParam.h.

template<class T>

WrapperParam<T>& casacore::WrapperParam< T >::operator=

(

const WrapperParam< T > &

other

)

Copy assignment (deep copy)

---

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

• casa/casacore/scimath/Functionals/WrapperParam.h