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

More...

#include <PoissonFunction.h>

Public Member Functions

 PoissonFunction ()
 Constructs the PoissonFunction, Defaults: lambda=1. More...
 
 PoissonFunction (const T &lambda)
 
 PoissonFunction (const T &lambda, const T &height)
 
 PoissonFunction (const PoissonFunction< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 PoissonFunction (const PoissonFunction< W > &other)
 
PoissonFunction< T > & operator= (const PoissonFunction< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~PoissonFunction ()
 Destructor. More...
 
virtual T eval (typename Function< T >::FunctionArg x) const
 Evaluate the Poisson 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::PoissonParam< T >
 PoissonParam ()
 Constructs the Poisson, Defaults: lambda=1. More...
 
 PoissonParam (const T &lambda)
 
 PoissonParam (const T &lambda, const T &height)
 
 PoissonParam (const PoissonParam< T > &other)
 Copy constructor (deep copy) More...
 
template<class W >
 PoissonParam (const PoissonParam< W > &other)
 
PoissonParam< T > & operator= (const PoissonParam< T > &other)
 Copy assignment (deep copy) More...
 
virtual ~PoissonParam ()
 Destructor. More...
 
virtual uInt ndim () const
 Returns the number of dimensions of function. More...
 
virtual const Stringname () const
 Give name of function. More...
 
lambda () const
 Get or set lambda. More...
 
void setLambda (const T &lambda)
 
height () const
 
void setHeight (const T &height)
 
- 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
 
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...
 
- 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::PoissonParam< T >
enum  {
  LAMBDA ,
  HEIGHT
}
 Parameter numbers. More...
 
- Public Types inherited from casacore::Function< T, U >
typedef FunctionTraits< T >::ArgType ArgType
 
typedef const ArgTypeFunctionArg
 
- Protected Attributes inherited from casacore::Function< T, U >
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::PoissonFunction< T >

A one dimensional Poisson function

Intended use:

Public interface

Review Status

Test programs:
tFunctionHolder

Prerequisite

Etymology

A 1-dimensional Poisson.

Synopsis

A Poisson is described by lambda. The parameters are enumerated by LAMBDA. They have default values of 1.

Example

PoissonFunction<Double> sf(5.0);
sf(25); // = 5.0

Template Type Argument Requirements (T)

Thrown Exceptions

Definition at line 79 of file PoissonFunction.h.

Constructor & Destructor Documentation

◆ PoissonFunction() [1/5]

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

Constructs the PoissonFunction, Defaults: lambda=1.


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

Definition at line 88 of file PoissonFunction.h.

◆ PoissonFunction() [2/5]

template<class T >
casacore::PoissonFunction< T >::PoissonFunction ( const T &  lambda)
inlineexplicit

Definition at line 89 of file PoissonFunction.h.

◆ PoissonFunction() [3/5]

template<class T >
casacore::PoissonFunction< T >::PoissonFunction ( const T &  lambda,
const T &  height 
)
inline

Definition at line 91 of file PoissonFunction.h.

◆ PoissonFunction() [4/5]

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

Copy constructor (deep copy)

Definition at line 97 of file PoissonFunction.h.

◆ PoissonFunction() [5/5]

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

Definition at line 99 of file PoissonFunction.h.

◆ ~PoissonFunction()

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

Destructor.

Definition at line 107 of file PoissonFunction.h.

Member Function Documentation

◆ clone()

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

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

Implements casacore::Function< T, U >.

Definition at line 120 of file PoissonFunction.h.

◆ cloneAD()

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

Reimplemented from casacore::Function< T, U >.

Definition at line 121 of file PoissonFunction.h.

◆ cloneNonAD()

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

Reimplemented from casacore::Function< T, U >.

Definition at line 123 of file PoissonFunction.h.

◆ eval()

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

Evaluate the Poisson at x.

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

◆ operator=()

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

Copy assignment (deep copy)

Definition at line 103 of file PoissonFunction.h.

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


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