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

A one dimensional Dirac delta function. More...

#include <DiracDFunction.h>

Public Member Functions

 DiracDFunction ()
 Constructs the DiracDFunction, Defaults: height=1, center=0. More...
 
 DiracDFunction (const T &height)
 
 DiracDFunction (const T &height, const T &center)
 
 DiracDFunction (const DiracDFunction< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 DiracDFunction (const DiracDFunction< W > &other)
 
DiracDFunction< T > & operator= (const DiracDFunction< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~DiracDFunction ()
 Destructor. More...
 
virtual T eval (typename Function< T >::FunctionArg x) const
 Evaluate the DiracD at x. 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::DiracDParam< T >
 DiracDParam ()
 Constructs the DiracD, Defaults: height=1, center=0. More...
 
 DiracDParam (const T &height)
 
 DiracDParam (const T &height, const T &center)
 
 DiracDParam (const DiracDParam< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 DiracDParam (const DiracDParam< W > &other)
 
DiracDParam< T > & operator= (const DiracDParam< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~DiracDParam ()
 Destructor. More...
 
virtual uInt ndim () const
 
virtual const Stringname () const
 Give name of function. More...
 
- Public Member Functions inherited from casacore::Function< T >
 Function ()
 Constructors. More...
 
 Function (const uInt n)
 
 Function (const Vector< T > &in)
 
 Function (const FunctionParam< T > &other)
 
 Function (const Function< W, X > &other)
 
 Function (const Function< T, T > &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 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
 

Additional Inherited Members

- Public Types inherited from casacore::DiracDParam< T >
enum  {
  HEIGHT,
  CENTER
}
 Parameter numbers. More...
 
- Public Types inherited from casacore::Function< T >
typedef FunctionTraits< T >::ArgType ArgType
 
- Public Attributes inherited from casacore::Function< T >
const typedef ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< 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 casacore::DiracDFunction< T >

A one dimensional Dirac delta function.

Intended use:

Public interface

Review Status

Test programs:
tFunctionHolder

Prerequisite

Etymology

A 1-dimensional Dirac delta.

Synopsis

A DiracD is described by a height, a center and a width (halfwidth). The value is:

height (|x-center| == 0.0)
0 (|x-center| != 0.0)

The parameters are enumerated by HEIGHT, CENTER and WIDTH. They have default values of (1, 0).

Example

DiracDFunction<Double> sf(5.0, 25.0);
sf(25); // = 5.0

Template Type Argument Requirements (T)

Thrown Exceptions

Definition at line 85 of file DiracDFunction.h.

Constructor & Destructor Documentation

◆ DiracDFunction() [1/5]

template<class T >
casacore::DiracDFunction< T >::DiracDFunction ( )
inline

Constructs the DiracDFunction, Defaults: height=1, center=0.


Warning: Could not use default arguments that worked both with gcc and IRIX

Definition at line 94 of file DiracDFunction.h.

◆ DiracDFunction() [2/5]

template<class T >
casacore::DiracDFunction< T >::DiracDFunction ( const T &  height)
inlineexplicit

Definition at line 95 of file DiracDFunction.h.

◆ DiracDFunction() [3/5]

template<class T >
casacore::DiracDFunction< T >::DiracDFunction ( const T &  height,
const T &  center 
)
inline

Definition at line 97 of file DiracDFunction.h.

◆ DiracDFunction() [4/5]

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

Copy constructor (deep copy)

Definition at line 103 of file DiracDFunction.h.

◆ DiracDFunction() [5/5]

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

Definition at line 105 of file DiracDFunction.h.

◆ ~DiracDFunction()

template<class T >
virtual casacore::DiracDFunction< T >::~DiracDFunction ( )
inlinevirtual

Destructor.

Definition at line 113 of file DiracDFunction.h.

Member Function Documentation

◆ clone()

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

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Definition at line 126 of file DiracDFunction.h.

◆ cloneAD()

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

Definition at line 127 of file DiracDFunction.h.

◆ cloneNonAD()

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

Definition at line 129 of file DiracDFunction.h.

◆ eval()

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

Evaluate the DiracD at x.

If a vector is used as the argument only its first element is used.

◆ operator=()

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

Copy assignment (deep copy)

Definition at line 109 of file DiracDFunction.h.

References casacore::DiracDParam< T >::operator=().


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