casacore::HyperPlane< T > Class Template Reference

A hyper plane function. More...

#include <HyperPlane.h>

Inheritance diagram for casacore::HyperPlane< T >:

List of all members.

Public Member Functions
	HyperPlane (const uInt m=0)
	Construct an m-dimensional hyper plane which has m parameters.
	HyperPlane (const HyperPlane< T > &other)
	Copy constructor/assignment (deep copy).
template<class W >
	HyperPlane (const HyperPlane< W > &other)
HyperPlane< T > &	operator= (const HyperPlane< T > &other)
	Copy assignment (deep copy).
virtual	~HyperPlane ()
	Destructor.
virtual T	eval (typename Function< T >::FunctionArg x) const
	Evaluate the hyper plane function at (x0,x1,.
virtual Function< T > *	clone () const
	Return a copy of this object from the heap.
virtual Function< typename FunctionTraits< T >::DiffType > *	cloneAD () const
virtual Function< typename FunctionTraits< T >::BaseType > *	cloneNonAD () const

---

Detailed Description

template<class T>
class casacore::HyperPlane< T >

A hyper plane function.

Intended use:

Public interface

Review Status

Reviewed By:

wbrouw

Date Reviewed:

2004/05/25

Test programs:

tHyperPlane

Prerequisite

• Function

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. Current implementation only tested for real types (and their AutoDiffs).

Thrown Exceptions

• Assertion in debug mode if attempt is made to address incorrect coefficients

Motivation

This class was created to allow the creation of linear constraint functions for the use of linear least-squares fit.

To Do

• Nothing I know of

Definition at line 109 of file HyperPlane.h.

---

Constructor & Destructor Documentation

template<class T>

casacore::HyperPlane< T >::HyperPlane

(

const uInt

m = 0

)

[inline, explicit]

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

By default, the coefficients are initialised to zero, and m=0

Definition at line 115 of file HyperPlane.h.

template<class T>

casacore::HyperPlane< T >::HyperPlane

(

const HyperPlane< T > &

other

)

[inline]

Copy constructor/assignment (deep copy).

Definition at line 118 of file HyperPlane.h.

template<class T>

template<class W >

casacore::HyperPlane< T >::HyperPlane

(

const HyperPlane< W > &

other

)

[inline]

Definition at line 120 of file HyperPlane.h.

template<class T>

virtual casacore::HyperPlane< T >::~HyperPlane

(

)

[inline, virtual]

Destructor.

Definition at line 126 of file HyperPlane.h.

---

Member Function Documentation

template<class T>

virtual Function<T>* casacore::HyperPlane< T >::clone

(

)

const [inline, virtual]

Return a copy of this object from the heap.

The caller is responsible for deleting the pointer.

Implements casacore::Function< T >.

Definition at line 136 of file HyperPlane.h.

template<class T>

virtual Function<typename FunctionTraits<T>::DiffType>* casacore::HyperPlane< T >::cloneAD

(

)

const [inline, virtual]

Reimplemented from casacore::Function< T >.

Definition at line 137 of file HyperPlane.h.

template<class T>

virtual Function<typename FunctionTraits<T>::BaseType>* casacore::HyperPlane< T >::cloneNonAD

(

)

const [inline, virtual]

Reimplemented from casacore::Function< T >.

Definition at line 139 of file HyperPlane.h.

template<class T>

virtual T casacore::HyperPlane< T >::eval

(

typename Function< T >::FunctionArg

x

)

const [virtual]

Evaluate the hyper plane function at (x₀,x₁,.

.,x_m-1).

template<class T>

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

(

const HyperPlane< T > &

other

)

[inline]

Copy assignment (deep copy).

Reimplemented from casacore::HyperPlaneParam< T >.

Definition at line 121 of file HyperPlane.h.

---

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

• casacore/scimath/Functionals/HyperPlane.h