Partial specialization of ChebyshevParamModeImpl for AutoDiff More...

#include <ChebyshevParam.h>

Public Member Functions
	ChebyshevParamModeImpl_PS ()

	ChebyshevParamModeImpl_PS (const uInt n)

	ChebyshevParamModeImpl_PS (const AutoDiff< T > &min, const AutoDiff< T > &max, typename ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const AutoDiff< T > &defval=AutoDiff< T >(0))

	ChebyshevParamModeImpl_PS (const Vector< AutoDiff< T > > &coeffs, const AutoDiff< T > &min, const AutoDiff< T > &max, typename ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const AutoDiff< T > &defval=AutoDiff< T >(0))

	ChebyshevParamModeImpl_PS (uInt order, const RecordInterface &mode)

	ChebyshevParamModeImpl_PS (const Vector< AutoDiff< T > > &coeffs, const RecordInterface &mode)

	ChebyshevParamModeImpl_PS (const ChebyshevParamModeImpl_PS &other)

virtual void	setMode (const RecordInterface &mode)
	get/set the function mode.

virtual void	getMode (RecordInterface &mode) const

Public Member Functions inherited from casacore::ChebyshevParam< AutoDiff< T > >
	ChebyshevParam ()
	create a zero-th order Chebyshev polynomial with the first coefficient equal to zero.

	ChebyshevParam (const uInt n)
	create an n-th order Chebyshev polynomial with the coefficients equal to zero.

	ChebyshevParam (const AutoDiff< T > &min, const AutoDiff< T > &max, ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const AutoDiff< T > &defval=AutoDiff< T >(0))
	create a zero-th order Chebyshev polynomical with the first coefficient equal to one.

	ChebyshevParam (const Vector< AutoDiff< T > > &coeffs, const AutoDiff< T > &min, const AutoDiff< T > &max, ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const AutoDiff< T > &defval=AutoDiff< T >(0))
	create a fully specified Chebyshev polynomial.

	ChebyshevParam (uInt order, const RecordInterface &mode)
	create a fully specified Chebyshev polynomial.

	ChebyshevParam (const Vector< AutoDiff< T > > &coeffs, const RecordInterface &mode)

	ChebyshevParam (const ChebyshevParam &other)
	create a deep copy of another Chebyshev polynomial

	ChebyshevParam (const ChebyshevParam< W > &other)

ChebyshevParam< AutoDiff< T > > &	operator= (const ChebyshevParam< AutoDiff< T > > &other)
	make a (deep) copy of another Chebyshev polynomial

virtual	~ChebyshevParam ()
	Destructor.

void	setCoefficients (const Vector< AutoDiff< T > > &coeffs)
	set the Chebyshev coefficients.

void	setCoefficient (const uInt which, const AutoDiff< T > &value)
	set a particular Chebyshev coefficient.

const Vector< AutoDiff< T > > &	getCoefficients () const
	return the current set of coefficients into a given Vector.

AutoDiff< T >	getCoefficient (const uInt which) const
	return a particular coefficient.

uInt	nCoefficients () const
	return the number of coeefficients currently loaded.

void	setInterval (AutoDiff< T > xmin, AutoDiff< T > xmax)
	set the Chebyshev interval for this function.

AutoDiff< T >	getIntervalMin () const
	return the minimum value for the currently Chebyshev interval.

AutoDiff< T >	getIntervalMax () const
	return the maximum value for the currently Chebyshev interval.

void	setOutOfIntervalMode (ChebyshevEnums::OutOfIntervalMode mode)
	set the behavior of this function when it is evaluated outside its Chebyshev interval

ChebyshevEnums::OutOfIntervalMode	getOutOfIntervalMode () const
	return the behavior of this function when it is evaluated outside of its Chebyshev interval.

void	setDefault (const AutoDiff< T > &val)
	set the default value of this function.

const AutoDiff< T > &	getDefault () const
	return the currently set default value.

uInt	order () const
	return the order of this polynomial.

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

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 Bool	hasMode () const
	return True if the implementing function supports a mode.

ostream &	print (ostream &os) const
	Print the function (i.e.

virtual Function< T, U > *	clone () const =0
	Return a copy of this object from the heap.

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

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

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::Function1D< T, U >
typedef const T *	FunctionArg

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

typedef const ArgType *	FunctionArg

Static Public Member Functions inherited from casacore::ChebyshevParam< AutoDiff< T > >
static void	derivativeCoeffs (Vector< AutoDiff< T > > &coeffs, const AutoDiff< T > &xmin=AutoDiff< T >(-1), const AutoDiff< T > &xmax=AutoDiff< T >(1))
	transform a set of Chebyshev polynomial coefficients into a set representing the series' derivative.

static void	chebyshevToPower (Vector< AutoDiff< T > > &coeffs)
	convert a set of Chebyshev polynomial coefficients to power series coefficients.

static void	powerToChebyshev (Vector< AutoDiff< T > > &coeffs)
	convert a set of power series coefficients to Chebyshev polynomial coefficients.

Protected Attributes inherited from casacore::ChebyshevParam< AutoDiff< T > >
AutoDiff< T >	def_p
	Default value if outside interval.

AutoDiff< T >	minx_p
	Lowest interval bound.

AutoDiff< T >	maxx_p
	Highest inetrval bound.

ChebyshevEnums::OutOfIntervalMode	mode_p
	Out-of-interval handling type.

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.

Static Protected Attributes inherited from casacore::ChebyshevParam< AutoDiff< T > >
static Vector< String >	modes_s

Detailed Description

template<class T>
class casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >

Partial specialization of ChebyshevParamModeImpl for AutoDiff

Synopsis

Warning: The name ChebyshevParamModeImpl_PS is only for cxx2html limitations;

Definition at line 441 of file ChebyshevParam.h.

Constructor & Destructor Documentation

◆ ChebyshevParamModeImpl_PS() [1/7]

template<class T >

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

inline

Definition at line 445 of file ChebyshevParam.h.

◆ ChebyshevParamModeImpl_PS() [2/7]

template<class T >

casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >::ChebyshevParamModeImpl_PS ( const uInt n )

inlineexplicit

Definition at line 447 of file ChebyshevParam.h.

◆ ChebyshevParamModeImpl_PS() [3/7]

template<class T >

casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >::ChebyshevParamModeImpl_PS	(	const AutoDiff< T > &	min,
		const AutoDiff< T > &	max,
		typename ChebyshevEnums::OutOfIntervalMode	mode = `ChebyshevEnums::CONSTANT`,
		const AutoDiff< T > &	defval = `AutoDiff<T>(0)`
	)

inline

Definition at line 450 of file ChebyshevParam.h.

References casacore::max(), and casacore::min().

◆ ChebyshevParamModeImpl_PS() [4/7]

template<class T >

casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >::ChebyshevParamModeImpl_PS	(	const Vector< AutoDiff< T > > &	coeffs,
		const AutoDiff< T > &	min,
		const AutoDiff< T > &	max,
		typename ChebyshevEnums::OutOfIntervalMode	mode = `ChebyshevEnums::CONSTANT`,
		const AutoDiff< T > &	defval = `AutoDiff<T>(0)`
	)

inline

Definition at line 455 of file ChebyshevParam.h.

References casacore::max(), and casacore::min().

◆ ChebyshevParamModeImpl_PS() [5/7]

template<class T >

casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >::ChebyshevParamModeImpl_PS	(	uInt	order,
		const RecordInterface &	mode
	)

inline

Definition at line 461 of file ChebyshevParam.h.

◆ ChebyshevParamModeImpl_PS() [6/7]

template<class T >

casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >::ChebyshevParamModeImpl_PS	(	const Vector< AutoDiff< T > > &	coeffs,
		const RecordInterface &	mode
	)

inline

Definition at line 463 of file ChebyshevParam.h.

◆ ChebyshevParamModeImpl_PS() [7/7]

template<class T >

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

inline

Definition at line 467 of file ChebyshevParam.h.

Member Function Documentation

◆ getMode()

template<class T >

virtual void casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >::getMode ( RecordInterface & mode ) const

virtual

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

◆ setMode()

template<class T >

virtual void casacore::ChebyshevParamModeImpl_PS< AutoDiff< T > >::setMode ( const RecordInterface & mode )

virtual

get/set the function mode.

These provide an interface to function-specific configuration or state that controls how the function calculates its values but otherwise does not qualify as a parameter. Some part of the state, for example, might have a type different from that of T. The state is passed as fields of a record, mode–the names, types and values of which are specific to the implementing function and should be documented in the implementing class. It is recommended that all possible inputs passed to this function via setMode() be considered optional such that if the record omits a legal field, that part of the state is left unchanged. Fields not recognized by the implementing class should be ignored. An exception should be thrown if a recognized field contains illegal data. The default implementations for both getMode() and setMode() ignore the input record.

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

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

scimath/Functionals/ChebyshevParam.h

Public Member Functions

Additional Inherited Members

Detailed Description

Synopsis

Constructor & Destructor Documentation

◆ ChebyshevParamModeImpl_PS() [1/7]

◆ ChebyshevParamModeImpl_PS() [2/7]

◆ ChebyshevParamModeImpl_PS() [3/7]

◆ ChebyshevParamModeImpl_PS() [4/7]

◆ ChebyshevParamModeImpl_PS() [5/7]

◆ ChebyshevParamModeImpl_PS() [6/7]

◆ ChebyshevParamModeImpl_PS() [7/7]

Member Function Documentation

◆ getMode()

◆ setMode()