casacore
Public Types | Public Member Functions | List of all members
casacore::Function1D< T, U > Class Template Reference

More...

#include <Function1D.h>

Public Types

typedef const T * FunctionArg
 
- Public Types inherited from casacore::Function< T, T >
typedef FunctionTraits< T >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 

Public Member Functions

 Function1D ()
 Constructors. More...
 
 Function1D (const uInt n)
 
 Function1D (const Vector< T > &in)
 
 Function1D (const FunctionParam< T > &other)
 
template<class W , class X >
 Function1D (const Function1D< W, X > &other)
 
virtual ~Function1D ()
 Destructor. More...
 
virtual uInt ndim () const
 Returns the number of dimensions of function. More...
 
- Public Member Functions inherited from casacore::Function< T, 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 T 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 T operator() () const
 Evaluate this function object at xor at x, y. More...
 
virtual T operator() (const ArgType &x) const
 
virtual T operator() (const Vector< ArgType > &x) const
 
virtual T operator() (FunctionArg x) const
 
virtual T operator() (const ArgType &x, const ArgType &y) const
 
virtual 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< 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...
 
virtual Function< T, T > * clone () const=0
 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::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

- Protected Attributes inherited from casacore::Function< T, 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 U = T>
class casacore::Function1D< T, U >

Numerical functional interface class for 1 dimension

Intended use:

Public interface

Review Status

Reviewed By:
tcornwel
Date Reviewed:
1996/02/22
Test programs:
tGaussian1D

Prerequisite

Synopsis

A Function1D is used for classes which map a scalar or n-dimensional Vector of type T into a T. The object also has one parameter which can be masked if necessary, and be used in the Fitting module, and, implicitly, in the AutoDiff differentiation module.

The only method implemented in Function1D is the ndim() method. The rest is inhereted from Function.

Example

See Function.

Template Type Argument Requirements (T)

Definition at line 75 of file Function1D.h.

Member Typedef Documentation

◆ FunctionArg

template<class T , class U = T>
typedef const T* casacore::Function1D< T, U >::FunctionArg

Definition at line 78 of file Function1D.h.

Constructor & Destructor Documentation

◆ Function1D() [1/5]

template<class T , class U = T>
casacore::Function1D< T, U >::Function1D ( )
inline

Constructors.

Definition at line 83 of file Function1D.h.

◆ Function1D() [2/5]

template<class T , class U = T>
casacore::Function1D< T, U >::Function1D ( const uInt  n)
inlineexplicit

Definition at line 84 of file Function1D.h.

◆ Function1D() [3/5]

template<class T , class U = T>
casacore::Function1D< T, U >::Function1D ( const Vector< T > &  in)
inlineexplicit

Definition at line 85 of file Function1D.h.

◆ Function1D() [4/5]

template<class T , class U = T>
casacore::Function1D< T, U >::Function1D ( const FunctionParam< T > &  other)
inline

Definition at line 86 of file Function1D.h.

◆ Function1D() [5/5]

template<class T , class U = T>
template<class W , class X >
casacore::Function1D< T, U >::Function1D ( const Function1D< W, X > &  other)
inline

Definition at line 88 of file Function1D.h.

◆ ~Function1D()

template<class T , class U = T>
virtual casacore::Function1D< T, U >::~Function1D ( )
inlinevirtual

Destructor.

Definition at line 92 of file Function1D.h.

Member Function Documentation

◆ ndim()

template<class T , class U = T>
virtual uInt casacore::Function1D< T, U >::ndim ( ) const
inlinevirtual

Returns the number of dimensions of function.

Implements casacore::Function< T, T >.

Definition at line 95 of file Function1D.h.


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