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

Partial specialization of PoissonFunction for AutoDiff More...

#include <PoissonFunction.h>

Public Member Functions

 PoissonFunction_PS ()
 Constructs one dimensional Poisson. More...
 
 PoissonFunction_PS (const AutoDiff< T > &lambda)
 
 PoissonFunction_PS (const AutoDiff< T > &lambda, const AutoDiff< T > &height)
 
 PoissonFunction_PS (const PoissonFunction_PS &other)
 Copy constructor (deep copy) More...
 
template<class W >
 PoissonFunction_PS (const PoissonFunction_PS< W > &other)
 
PoissonFunction_PS< AutoDiff< T > > & operator= (const PoissonFunction_PS< AutoDiff< T > > &other)
 Copy assignment (deep copy) More...
 
virtual ~PoissonFunction_PS ()
 Destructor. More...
 
virtual AutoDiff< T > eval (typename Function< AutoDiff< T > >::FunctionArg x) const
 Evaluate the Poisson and its derivatives at x. 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::PoissonParam< AutoDiff< T > >
 PoissonParam ()
 Constructs the Poisson, Defaults: lambda=1. More...
 
 PoissonParam (const AutoDiff< T > &lambda)
 
 PoissonParam (const AutoDiff< T > &lambda, const AutoDiff< T > &height)
 
 PoissonParam (const PoissonParam< AutoDiff< T > > &other)
 Copy constructor (deep copy) More...
 
 PoissonParam (const PoissonParam< W > &other)
 
PoissonParam< AutoDiff< T > > & operator= (const PoissonParam< AutoDiff< 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...
 
AutoDiff< T > lambda () const
 Get or set lambda. More...
 
void setLambda (const AutoDiff< T > &lambda)
 
AutoDiff< T > height () const
 
void setHeight (const AutoDiff< T > &height)
 
- 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::PoissonParam< AutoDiff< T > >
enum  
 Parameter numbers. More...
 
- 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::PoissonFunction_PS< AutoDiff< T > >

Partial specialization of PoissonFunction for AutoDiff

Synopsis


Warning: The name PoissonFunction_PS is only for cxx2html documentation problems; Use PoissonFunction in your code;

Definition at line 147 of file PoissonFunction.h.

Constructor & Destructor Documentation

◆ PoissonFunction_PS() [1/5]

template<class T >
casacore::PoissonFunction_PS< AutoDiff< T > >::PoissonFunction_PS ( )
inline

Constructs one dimensional Poisson.

Definition at line 154 of file PoissonFunction.h.

◆ PoissonFunction_PS() [2/5]

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

Definition at line 155 of file PoissonFunction.h.

◆ PoissonFunction_PS() [3/5]

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

Definition at line 157 of file PoissonFunction.h.

◆ PoissonFunction_PS() [4/5]

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

Copy constructor (deep copy)

Definition at line 164 of file PoissonFunction.h.

◆ PoissonFunction_PS() [5/5]

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

Definition at line 167 of file PoissonFunction.h.

◆ ~PoissonFunction_PS()

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

Destructor.

Definition at line 177 of file PoissonFunction.h.

Member Function Documentation

◆ clone()

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

Return a copy of this object from the heap.

The caller is responsible for deleting this pointer.

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

Definition at line 189 of file PoissonFunction.h.

◆ cloneAD()

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

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

Definition at line 193 of file PoissonFunction.h.

◆ cloneNonAD()

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

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

Definition at line 198 of file PoissonFunction.h.

◆ eval()

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

Evaluate the Poisson and its derivatives at x.

◆ operator=()

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

Copy assignment (deep copy)

Definition at line 173 of file PoissonFunction.h.


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