casacore
Public Member Functions | List of all members
casacore::HyperPlane_PS< AutoDiff< T > > Class Template Reference

Partial specialization of HyperPlane for AutoDiff More...

#include <HyperPlane.h>

Public Member Functions

 HyperPlane_PS (const uInt m=0)
 Constructors an m-dimensional hyper plane which has m parameters. More...
 
 HyperPlane_PS (const HyperPlane_PS< AutoDiff< T > > &other)
 Copy constructor/assignment (deep copy) More...
 
template<class W >
 HyperPlane_PS (const HyperPlane_PS< W > &other)
 
HyperPlane_PS< AutoDiff< T > > & operator= (const HyperPlane_PS< AutoDiff< T > > &other)
 
virtual ~HyperPlane ()
 Destructor. More...
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the hyper plane function at (x0,x1,..,xm-1). More...
 
virtual Function< AutoDiff< T > > * clone () const
 Return a copy of this object from the heap. More...
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::HyperPlaneParam< AutoDiff< 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...
 
 HyperPlaneParam (const HyperPlaneParam< W > &other)
 
HyperPlaneParam< AutoDiff< T > > & operator= (const HyperPlaneParam< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~HyperPlaneParam ()
 Destructor. More...
 
Bool operator== (const HyperPlaneParam< AutoDiff< T > > &other) const
 Comparisons. More...
 
Bool operator!= (const HyperPlaneParam< AutoDiff< 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< AutoDiff< T > >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< AutoDiff< T > > &in)
 
 Function (const FunctionParam< AutoDiff< T > > &other)
 
 Function (const Function< W, X > &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 AutoDiff< T > eval (FunctionArg x) const=0
 Evaluate the function object. More...
 
AutoDiff< T > & operator[] (const uInt n)
 Manipulate the nth parameter (0-based) with no index check. More...
 
const AutoDiff< T > & operator[] (const uInt n) const
 
virtual AutoDiff< T > operator() () const
 Evaluate this function object at xor at x, y. More...
 
virtual AutoDiff< T > operator() (const ArgType &x) const
 
virtual AutoDiff< T > operator() (const Vector< ArgType > &x) const
 
virtual AutoDiff< T > operator() (FunctionArg x) const
 
virtual AutoDiff< T > operator() (const ArgType &x, const ArgType &y) const
 
virtual AutoDiff< T > operator() (const ArgType &x, const ArgType &y, const ArgType &z) const
 
virtual const Stringname () const
 Specify the name associated with the function (default will be unknown) More...
 
Boolmask (const uInt n)
 Manipulate the mask associated with the nth parameter (e.g. More...
 
const Boolmask (const uInt n) const
 
const FunctionParam< AutoDiff< T > > & parameters () const
 Return the parameter interface. More...
 
FunctionParam< AutoDiff< 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< AutoDiff< T >, AutoDiff< T > > * clone () const=0
 Return a copy of this object from the heap. More...
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD () const
 
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD () const
 
- Public Member Functions inherited from casacore::Functional< FunctionTraits< AutoDiff< T > >::ArgType, AutoDiff< T > >
virtual ~Functional ()
 Destructor. More...
 
virtual AutoDiff< T > operator() (const FunctionTraits< AutoDiff< T > >::ArgType &x) const=0
 Map a Domain x into a Range y value. More...
 
- Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< AutoDiff< T > >::ArgType >, AutoDiff< T > >
virtual ~Functional ()
 Destructor. More...
 
virtual AutoDiff< T > operator() (const Vector< FunctionTraits< AutoDiff< T > >::ArgType > &x) const=0
 Map a Domain x into a Range y value. More...
 

Additional Inherited Members

- Public Types inherited from casacore::Function< AutoDiff< T > >
typedef FunctionTraits< AutoDiff< T > >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< AutoDiff< T > >
FunctionParam< AutoDiff< 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::HyperPlane_PS< AutoDiff< T > >

Partial specialization of HyperPlane for AutoDiff

Synopsis


Warning: The name HyperPlane_PS is only for cxx2html documentation problems; Use HyperPlane in your code;

Definition at line 159 of file HyperPlane.h.

Constructor & Destructor Documentation

◆ HyperPlane_PS() [1/3]

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

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

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

Definition at line 166 of file HyperPlane.h.

◆ HyperPlane_PS() [2/3]

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

Copy constructor/assignment (deep copy)

Definition at line 170 of file HyperPlane.h.

◆ HyperPlane_PS() [3/3]

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

Definition at line 173 of file HyperPlane.h.

◆ ~HyperPlane()

template<class T >
virtual casacore::HyperPlane_PS< AutoDiff< T > >::~HyperPlane ( )
inlinevirtual

Destructor.

Definition at line 181 of file HyperPlane.h.

Member Function Documentation

◆ clone()

template<class T >
virtual Function< AutoDiff< T > > * casacore::HyperPlane_PS< AutoDiff< T > >::clone ( ) const
inlinevirtual

Return a copy of this object from the heap.

The caller is responsible for deleting the pointer.

Implements casacore::Function< AutoDiff< T > >.

Definition at line 192 of file HyperPlane.h.

◆ cloneAD()

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

Reimplemented from casacore::Function< AutoDiff< T > >.

Definition at line 195 of file HyperPlane.h.

◆ cloneNonAD()

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

Reimplemented from casacore::Function< AutoDiff< T > >.

Definition at line 199 of file HyperPlane.h.

◆ eval()

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

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

◆ operator=()

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

Definition at line 176 of file HyperPlane.h.


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