Partial specialization of PoissonFunction for AutoDiff. More...

#include <PoissonFunction.h>

Public Member Functions
	PoissonFunction_PS ()
	Constructs one dimensional Poisson.
	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).
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).
virtual	~PoissonFunction_PS ()
	Destructor.
virtual AutoDiff< T >	eval (typename Function< AutoDiff< T > >::FunctionArg x) const
	Evaluate the Poisson and its derivatives at x.
virtual Function< AutoDiff< T > > *	clone () const
	Return a copy of this object from the heap.
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.
PoissonParam< T > &	operator= (const PoissonParam< T > &other)
	Copy assignment (deep copy).
virtual	~PoissonParam ()
	Destructor.
virtual uInt	ndim () const
	Returns the number of dimensions of function.
virtual const String &	name () const
	Give name of function.
T	lambda () const
	Get or set lambda.
void	setLambda (const T &lambda)
T	height () const
void	setHeight (const T &height)
Public Member Functions inherited from casacore::Function< T, U >
	Function ()
	Constructors.
	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.
uInt	nparameters () const
	Returns the number of parameters.
virtual U	eval (FunctionArg x) const =0
	Evaluate the function object.
T &	operator[] (const uInt n)
	Manipulate the nth parameter (0-based) with no index check.
const T &	operator[] (const uInt n) const
virtual U	operator() () const
	Evaluate this function object at xor at x, y.
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
Bool &	mask (const uInt n)
	Manipulate the mask associated with the nth parameter (e.g.
const Bool &	mask (const uInt n) const
const FunctionParam< T > &	parameters () const
	Return the parameter interface.
FunctionParam< T > &	parameters ()
const Vector< ArgType > &	argp () const
	Get arg_p and parset_p.
Bool	parsetp () const
void	lockParam ()
	Compiler cannot always find the correct 'const' version of parameter access.
void	unlockParam ()
virtual void	setMode (const RecordInterface &mode)
	get/set the function mode.
virtual void	getMode (RecordInterface &mode) const
virtual Bool	hasMode () const
	return True if the implementing function supports a mode.
ostream &	print (ostream &os) const
	Print the function (i.e.
Public Member Functions inherited from casacore::Functional< FunctionTraits< T >::ArgType, T >
virtual	~Functional ()
	Destructor.
virtual T	operator() (const FunctionTraits< T >::ArgType &x) const=0
	Map a Domain x into a Range y value.
Public Member Functions inherited from casacore::Functional< Vector< FunctionTraits< T >::ArgType >, T >
virtual	~Functional ()
	Destructor.
virtual T	operator() (const Vector< FunctionTraits< T >::ArgType > &x) const=0
	Map a Domain x into a Range y value.

Additional Inherited Members
Public Types inherited from casacore::PoissonParam< AutoDiff< T > >
enum
	Parameter numbers. More...
Public Types inherited from casacore::Function< T, U >
typedef FunctionTraits< T >::ArgType	ArgType
typedef const ArgType *	FunctionArg
Protected Attributes inherited from casacore::Function< T, U >
FunctionParam< T >	param_p
	The parameters and masks.
Vector< ArgType >	arg_p
	Aid for non-contiguous argument storage.
Bool	parset_p
	Indicate parameter written.
Bool	locked_p
	Indicate that parameters are expected to be locked from changing.

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 145 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 152 of file PoissonFunction.h.

References casacore::PoissonParam< AutoDiff< T > >::PoissonParam().

Referenced by operator=(), PoissonFunction_PS(), and PoissonFunction_PS().

◆ PoissonFunction_PS() [2/5]

template<class T>

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

inlineexplicit

Definition at line 153 of file PoissonFunction.h.

References casacore::PoissonParam< AutoDiff< T > >::lambda(), and casacore::PoissonParam< AutoDiff< T > >::PoissonParam().

◆ 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 155 of file PoissonFunction.h.

References casacore::PoissonParam< AutoDiff< T > >::height(), casacore::PoissonParam< AutoDiff< T > >::lambda(), and casacore::PoissonParam< AutoDiff< T > >::PoissonParam().

◆ 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 162 of file PoissonFunction.h.

References PoissonFunction_PS(), and casacore::PoissonParam< AutoDiff< T > >::PoissonParam().

◆ 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 165 of file PoissonFunction.h.

References PoissonFunction_PS(), and casacore::PoissonParam< AutoDiff< T > >::PoissonParam().

◆ ~PoissonFunction_PS()

template<class T>

virtual casacore::PoissonFunction_PS< AutoDiff< T > >::~PoissonFunction_PS ( )

inlinevirtual

Destructor.

Definition at line 175 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< T, U >.

Definition at line 187 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< T, U >.

Definition at line 191 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< T, U >.

Definition at line 196 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 171 of file PoissonFunction.h.

References PoissonFunction_PS().

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

scimath/Functionals/PoissonFunction.h

Public Member Functions

Additional Inherited Members

Detailed Description

Synopsis

Constructor & Destructor Documentation

◆ PoissonFunction_PS() [1/5]

◆ PoissonFunction_PS() [2/5]

◆ PoissonFunction_PS() [3/5]

◆ PoissonFunction_PS() [4/5]

◆ PoissonFunction_PS() [5/5]

◆ ~PoissonFunction_PS()

Member Function Documentation

◆ clone()

◆ cloneAD()

◆ cloneNonAD()

◆ eval()

◆ operator=()