Partial specialization of Lorentzian1D for AutoDiff More...

#include <Lorentzian1D.h>

Public Member Functions
	Lorentzian1D_PS ()
	Constructs one dimensional Lorentzians.

	Lorentzian1D_PS (const AutoDiff< T > &height)

	Lorentzian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > &center)

	Lorentzian1D_PS (const AutoDiff< T > &height, const AutoDiff< T > &center, const AutoDiff< T > &width)

	Lorentzian1D_PS (const Lorentzian1D_PS &other)
	Copy constructor (deep copy)

template<class W >
	Lorentzian1D_PS (const Lorentzian1D_PS< W > &other)

Lorentzian1D_PS< AutoDiff< T > > &	operator= (const Lorentzian1D_PS< AutoDiff< T > > &other)
	Copy assignment (deep copy)

virtual	~Lorentzian1D_PS ()
	Destructor.

virtual AutoDiff< T >	eval (typename Function< AutoDiff< T > >::FunctionArg x) const
	Evaluate the Lorentzian 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::Lorentzian1DParam< AutoDiff< T > >
	Lorentzian1DParam ()
	Constructs the one dimensional Lorentzians.

	Lorentzian1DParam (const AutoDiff< T > &height)

	Lorentzian1DParam (const AutoDiff< T > &height, const AutoDiff< T > &center)

	Lorentzian1DParam (const AutoDiff< T > &height, const AutoDiff< T > &center, const AutoDiff< T > &width)

	Lorentzian1DParam (const Lorentzian1DParam< AutoDiff< T > > &other)
	Copy constructor (deep copy)

	Lorentzian1DParam (const Lorentzian1DParam< W > &other)

Lorentzian1DParam< AutoDiff< T > > &	operator= (const Lorentzian1DParam< AutoDiff< T > > &other)
	Copy assignment (deep copy)

virtual	~Lorentzian1DParam ()
	Destructor.

virtual const String &	name () const
	Give name of function.

AutoDiff< T >	height () const
	Get or set the peak height of the Lorentzian.

void	setHeight (const AutoDiff< T > &height)

AutoDiff< T >	flux () const
	Get or set the analytical integrated area underneath the Lorentzian.

void	setFlux (const AutoDiff< T > &flux)

AutoDiff< T >	center () const
	Get or set the center ordinate of the Lorentzian.

void	setCenter (const AutoDiff< T > &cnter)

AutoDiff< T >	width () const
	Get or set the FWHM of the Lorentzian.

void	setWidth (const AutoDiff< T > &width)

Public Member Functions inherited from casacore::Function1D< T, U >
	Function1D ()
	Constructors.

	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.

virtual uInt	ndim () const
	Returns the number of dimensions of function.

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 `x`or 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< Domain, Range >
virtual	~Functional ()
	Destructor.

virtual Range	operator() (const Domain &x) const =0
	Map a Domain `x` into a Range `y` value.

Additional Inherited Members
Public Types inherited from casacore::Lorentzian1DParam< AutoDiff< T > >
enum

Public Types inherited from casacore::Function1D< T, U >
typedef const T *	FunctionArg

Public Types inherited from casacore::Function< T, U >
typedef FunctionTraits< T >::ArgType	ArgType

typedef const ArgType *	FunctionArg

Protected Attributes inherited from casacore::Lorentzian1DParam< AutoDiff< T > >
AutoDiff< T >	fwhm2int
	Constant to scale halfwidth at 1/e to FWHM.

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::Lorentzian1D_PS< AutoDiff< T > >

Partial specialization of Lorentzian1D for AutoDiff

Synopsis

Warning: The name Lorentzian1D_PS is only for cxx2html documentation problems; Use Lorentzian1D in your code;

Definition at line 203 of file Lorentzian1D.h.

Constructor & Destructor Documentation

◆ Lorentzian1D_PS() [1/6]

template<class T >

casacore::Lorentzian1D_PS< AutoDiff< T > >::Lorentzian1D_PS ( )

inline

Constructs one dimensional Lorentzians.

Definition at line 210 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [2/6]

template<class T >

casacore::Lorentzian1D_PS< AutoDiff< T > >::Lorentzian1D_PS ( const AutoDiff< T > & height )

inlineexplicit

Definition at line 211 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [3/6]

template<class T >

casacore::Lorentzian1D_PS< AutoDiff< T > >::Lorentzian1D_PS	(	const AutoDiff< T > &	height,
		const AutoDiff< T > &	center
	)

inline

Definition at line 213 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [4/6]

template<class T >

casacore::Lorentzian1D_PS< AutoDiff< T > >::Lorentzian1D_PS	(	const AutoDiff< T > &	height,
		const AutoDiff< T > &	center,
		const AutoDiff< T > &	width
	)

inline

Definition at line 215 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [5/6]

template<class T >

casacore::Lorentzian1D_PS< AutoDiff< T > >::Lorentzian1D_PS ( const Lorentzian1D_PS< AutoDiff< T > > & other )

inline

Copy constructor (deep copy)

Definition at line 222 of file Lorentzian1D.h.

◆ Lorentzian1D_PS() [6/6]

template<class T >

template<class W >

casacore::Lorentzian1D_PS< AutoDiff< T > >::Lorentzian1D_PS ( const Lorentzian1D_PS< W > & other )

inline

Definition at line 225 of file Lorentzian1D.h.

◆ ~Lorentzian1D_PS()

template<class T >

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

inlinevirtual

Destructor.

Definition at line 235 of file Lorentzian1D.h.

Member Function Documentation

◆ clone()

template<class T >

virtual Function< AutoDiff< T > > * casacore::Lorentzian1D_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 247 of file Lorentzian1D.h.

◆ cloneAD()

template<class T >

virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * casacore::Lorentzian1D_PS< AutoDiff< T > >::cloneAD ( ) const

inlinevirtual

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

Definition at line 250 of file Lorentzian1D.h.

◆ cloneNonAD()

template<class T >

virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * casacore::Lorentzian1D_PS< AutoDiff< T > >::cloneNonAD ( ) const

inlinevirtual

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

Definition at line 254 of file Lorentzian1D.h.

◆ eval()

template<class T >

virtual AutoDiff< T > casacore::Lorentzian1D_PS< AutoDiff< T > >::eval ( typename Function< AutoDiff< T > >::FunctionArg x ) const

virtual

Evaluate the Lorentzian and its derivatives at x.

◆ operator=()

template<class T >

Lorentzian1D_PS< AutoDiff< T > > & casacore::Lorentzian1D_PS< AutoDiff< T > >::operator= ( const Lorentzian1D_PS< AutoDiff< T > > & other )

inline

Copy assignment (deep copy)

Definition at line 231 of file Lorentzian1D.h.

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

scimath/Functionals/Lorentzian1D.h

Public Member Functions

Additional Inherited Members

Detailed Description

Synopsis

Constructor & Destructor Documentation

◆ Lorentzian1D_PS() [1/6]

◆ Lorentzian1D_PS() [2/6]

◆ Lorentzian1D_PS() [3/6]

◆ Lorentzian1D_PS() [4/6]

◆ Lorentzian1D_PS() [5/6]

◆ Lorentzian1D_PS() [6/6]

◆ ~Lorentzian1D_PS()

Member Function Documentation

◆ clone()

◆ cloneAD()

◆ cloneNonAD()

◆ eval()

◆ operator=()