casa::HyperPlaneParam< T > Class Template Reference

Parameter handling for a hyper plane function. More...

#include <HyperPlaneParam.h>

Inheritance diagram for casa::HyperPlaneParam< T >:

List of all members.

Public Member Functions
	HyperPlaneParam (uInt m=0)
	Construct an m-dimensional hyper plane which has m parameters.
	HyperPlaneParam (const HyperPlaneParam &other)
	Copy constructor (deep copy)
template<class W >
	HyperPlaneParam (const HyperPlaneParam< W > &other)
HyperPlaneParam< T > &	operator= (const HyperPlaneParam< T > &other)
	Copy assignment (deep copy)
virtual	~HyperPlaneParam ()
	Destructor.
Bool	operator== (const HyperPlaneParam< T > &other) const
	Comparisons.
Bool	operator!= (const HyperPlaneParam< T > &other) const
virtual const String &	name () const
	Give name of function.
virtual uInt	ndim () const
	What is the dimension of the parameter list.

---

Detailed Description

template<class T>
class casa::HyperPlaneParam< T >

Parameter handling for a hyper plane function.

Intended use:

Internal

Review Status

Reviewed By:

wbrouw

Date Reviewed:

2004/05/25

Test programs:

tHyperPlane

Prerequisite

• FunctionParam class
• Function class

Synopsis

This class forms a function of the form f(x₀,x₁,..,x_m-1) = p₀*x₀ + p₁*x₁ + ...

• p_m-1*x_m-1, where p_i are coefficients (parameters) and x_i are independent arguments.

f(x₀,x₁,..,x_m-1) represents a hyper plane of dimension m.

Since the HyperPlane is a Function, the derivatives can be obtained as well.

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 HyperPlane class only.

Example

    // form the hyper plane function of this form: 
    // 6*x0 + 2*x3 
     HyperPlane<Double> hyper(4); // 4-dim hyperplane
     hyper.parameters()[0] = 6;   
     hyper.parameters()[3] = 2;
     // Evaluate at x0=5, x3=7
     Vector<Double> x(4);
     x=0; x[0]=5; x[3]=7;
     cout << "Hypervalue: " << hyper(x) << endl;
     Hypervalue: 44

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.

Motivation

This class was created to facilitate linear constraint functions for the use of least-squares fits.

To Do

• Nothing I know of

Definition at line 108 of file HyperPlaneParam.h.

---

Constructor & Destructor Documentation

template<class T>

casa::HyperPlaneParam< T >::HyperPlaneParam

(

uInt

m = 0

)

[explicit]

Construct an m-dimensional hyper plane which has m parameters.

By default, the coefficients are initialized to zero. The default plane has m=0

template<class T>

casa::HyperPlaneParam< T >::HyperPlaneParam

(

const HyperPlaneParam< T > &

other

)

Copy constructor (deep copy)

template<class T>

template<class W >

casa::HyperPlaneParam< T >::HyperPlaneParam

(

const HyperPlaneParam< W > &

other

)

[inline]

Definition at line 123 of file HyperPlaneParam.h.

template<class T>

virtual casa::HyperPlaneParam< T >::~HyperPlaneParam

(

)

[virtual]

Destructor.

---

Member Function Documentation

template<class T>

virtual const String& casa::HyperPlaneParam< T >::name

(

)

const [inline, virtual]

Give name of function.

Reimplemented from casa::Function< T >.

Definition at line 146 of file HyperPlaneParam.h.

template<class T>

virtual uInt casa::HyperPlaneParam< T >::ndim

(

)

const [inline, virtual]

What is the dimension of the parameter list.

Implements casa::Function< T >.

Definition at line 150 of file HyperPlaneParam.h.

template<class T>

Bool casa::HyperPlaneParam< T >::operator!=

(

const HyperPlaneParam< T > &

other

)

const [inline]

Definition at line 140 of file HyperPlaneParam.h.

template<class T>

HyperPlaneParam<T>& casa::HyperPlaneParam< T >::operator=

(

const HyperPlaneParam< T > &

other

)

Copy assignment (deep copy)

template<class T>

Bool casa::HyperPlaneParam< T >::operator==

(

const HyperPlaneParam< T > &

other

)

const [inline]

Comparisons.

HyperPlanes are equal if they are of the same order and have the same parameters

Definition at line 138 of file HyperPlaneParam.h.

---

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

• casacore/scimath/Functionals/HyperPlaneParam.h