#include <HyperPlane.h>
Public Member Functions | |
| HyperPlane (const uInt m=0) | |
| Construct an m-dimensional hyper plane which has m parameters. More... | |
| HyperPlane (const HyperPlane< T > &other) | |
| Copy constructor/assignment (deep copy) More... | |
| template<class W > | |
| HyperPlane (const HyperPlane< W > &other) | |
| HyperPlane< T > & | operator= (const HyperPlane< T > &other) |
| virtual | ~HyperPlane () |
| 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::HyperPlaneParam< T > | |
| HyperPlaneParam (uInt m=0) | |
| Construct an m-dimensional hyper plane which has m parameters. More... | |
| HyperPlaneParam (const HyperPlaneParam &other) | |
| Copy constructor (deep copy) More... | |
| template<class W > | |
| HyperPlaneParam (const HyperPlaneParam< W > &other) | |
| HyperPlaneParam< T > & | operator= (const HyperPlaneParam< T > &other) |
| Copy assignment (deep copy) More... | |
| virtual | ~HyperPlaneParam () |
| Destructor. More... | |
| Bool | operator== (const HyperPlaneParam< T > &other) const |
| Comparisons. More... | |
| Bool | operator!= (const HyperPlaneParam< T > &other) const |
| virtual const String & | name () 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, U > | |
| Function () | |
| Constructors. More... | |
| Function (const uInt n) | |
| Function (const Vector< T > &in) | |
| Function (const FunctionParam< T > &other) | |
| template<class W , class X > | |
| 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 |
| 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... | |
| Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, T > | |
| virtual | ~Functional () |
| Destructor. More... | |
| virtual T | 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 >, T > | |
| virtual | ~Functional () |
| Destructor. More... | |
| virtual T | 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, U > | |
| typedef FunctionTraits< T >::ArgType | ArgType |
| typedef const ArgType * | FunctionArg |
| Protected Attributes inherited from casacore::Function< T, U > | |
| 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::HyperPlane< T >
A hyper plane function.
Intended use:
Public interface
Review Status
- Reviewed By:
- wbrouw
- Date Reviewed:
- 2004/05/25
- Test programs:
- tHyperPlane
Prerequisite
Synopsis
This class forms a function of the form f(x0,x1,..,xm-1) = p0*x0 + p1*x1 +...
- pm-1*xm-1, where pi are coefficients (parameters) and xi are independent arguments.
f(x0,x1,..,xm-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
◆ HyperPlane() [1/3]
template<class T >
|
inlineexplicit |
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.
◆ HyperPlane() [2/3]
template<class T >
|
inline |
Copy constructor/assignment (deep copy)
Definition at line 118 of file HyperPlane.h.
◆ HyperPlane() [3/3]
template<class T >
template<class W >
|
inline |
Definition at line 120 of file HyperPlane.h.
◆ ~HyperPlane()
template<class T >
|
inlinevirtual |
Destructor.
Definition at line 126 of file HyperPlane.h.
Member Function Documentation
◆ clone()
template<class T >
|
inlinevirtual |
Return a copy of this object from the heap.
The caller is responsible for deleting the pointer.
Implements casacore::Function< T, U >.
Definition at line 136 of file HyperPlane.h.
◆ cloneAD()
template<class T >
|
inlinevirtual |
Reimplemented from casacore::Function< T, U >.
Definition at line 137 of file HyperPlane.h.
◆ cloneNonAD()
template<class T >
|
inlinevirtual |
Reimplemented from casacore::Function< T, U >.
Definition at line 139 of file HyperPlane.h.
◆ eval()
template<class T >
|
virtual |
Evaluate the hyper plane function at (x0,x1,..,xm-1).
◆ operator=()
template<class T >
|
inline |
Definition at line 121 of file HyperPlane.h.
References casacore::HyperPlaneParam< T >::operator=().
The documentation for this class was generated from the following file:
- scimath/Functionals/HyperPlane.h
