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

A constant function. More...

#include <ConstantND.h>

Inheritance diagram for casacore::ConstantND< T >:
casacore::ConstantNDParam< T > casacore::Function< T > casacore::Functional< FunctionTraits< T >::ArgType, U > casacore::Functional< Vector< FunctionTraits< T >::ArgType >, U >

Public Member Functions

 ConstantND (const uInt m=0)
 Construct a constant in an a space of dimensionality m. More...
 
 ConstantND (const ConstantND< T > &other)
 Copy constructor/assignment (deep copy) More...
 
template<class W >
 ConstantND (const ConstantND< W > &other)
 
ConstantND< T > & operator= (const ConstantND< T > &other)
 
virtual ~ConstantND ()
 Destructor. More...
 
virtual T eval (typename Function< T >::FunctionArg x) const
 Evaluate the hyper plane function at (x0,x1,..,xm-1). 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::ConstantNDParam< T >
 ConstantNDParam (uInt m=0)
 Construct a constant in m-dimensional space. More...
 
 ConstantNDParam (const ConstantNDParam &other)
 Copy constructor (deep copy) More...
 
template<class W >
 ConstantNDParam (const ConstantNDParam< W > &other)
 
ConstantNDParam< T > & operator= (const ConstantNDParam< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~ConstantNDParam ()
 Destructor. More...
 
Bool operator== (const ConstantNDParam< T > &other) const
 Comparisons. More...
 
Bool operator!= (const ConstantNDParam< T > &other) const
 
virtual const Stringname () const
 Give name of function. More...
 
virtual uInt ndim () const
 What is the dimension of the parameter list. 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::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::ConstantND< T >

A constant function.

Intended use:

Public interface

Review Status

Test programs:
tConstant

Prerequisite

Synopsis

This class represents a constant function in a space of arbitrary dimension f(x0,x1,..,xm-1) = constant where xi are independent arguments and m is the number of dimensions of the space.

Since the Constant is a Function, the derivatives can be obtained as well (and are in fact 0 of course).

The parameter interface (see FunctionParam class), is used to provide an interface to the Fitting classes.

This class is in general used implicitly by the Constant class only.

Example

// form the constant function in 4-D space
Constant<Double> constant(4); // 4-dim hyperplane
constant.parameters()[0] = 22;
// Evaluate at x0=5, x3=7
Vector<Double> x(4);
x=0; x[0]=5; x[3]=7;
cout << "constant value: " << constant(x) << endl;
constant value: 22

Template Type Argument Requirements (T)

Thrown Exceptions

Motivation

This class was created because HyperPlane does not support a constant offset and modifying that class really required an interface change (ie that the constant offset be at the beginning of the parameter vector and that the parameter vector increase by one) so rather than breaking any code that already used HyperPlane I simply made a trivial Constant class.

To Do

Definition at line 108 of file ConstantND.h.

Constructor & Destructor Documentation

template<class T>
casacore::ConstantND< T >::ConstantND ( const uInt  m = 0)
inlineexplicit

Construct a constant in an a space of dimensionality m.

By default, the constant value is initialised to zero, and m=0

Definition at line 114 of file ConstantND.h.

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

Copy constructor/assignment (deep copy)

Definition at line 117 of file ConstantND.h.

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

Definition at line 119 of file ConstantND.h.

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

Destructor.

Definition at line 125 of file ConstantND.h.

Member Function Documentation

template<class T>
virtual Function<T>* casacore::ConstantND< 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 135 of file ConstantND.h.

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

Reimplemented from casacore::Function< T >.

Definition at line 136 of file ConstantND.h.

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

Reimplemented from casacore::Function< T >.

Definition at line 138 of file ConstantND.h.

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

Evaluate the hyper plane function at (x0,x1,..,xm-1).

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

Definition at line 120 of file ConstantND.h.

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


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