Loading...
Searching...
No Matches
casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > > Class Template Reference
scimath package (libcasa_scimath) » Functionals_module

Partial specialization of ChebyshevParamModeImpl for AutoDiff. More...

`#include <ChebyshevParam.h>`

## Public Member Functions

| ChebyshevParamModeImpl_PSA ()
| ChebyshevParamModeImpl_PSA (const uInt n)
| ChebyshevParamModeImpl_PSA (const AutoDiffA< T > &min, const AutoDiffA< T > &max, typename ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const AutoDiffA< T > &defval=AutoDiffA< T >(0))
| ChebyshevParamModeImpl_PSA (const Vector< AutoDiffA< T > > &coeffs, const AutoDiffA< T > &min, const AutoDiffA< T > &max, typename ChebyshevEnums::OutOfIntervalMode mode=ChebyshevEnums::CONSTANT, const AutoDiffA< T > &defval=AutoDiffA< T >(0))
| ChebyshevParamModeImpl_PSA (uInt order, const RecordInterface &mode)
| ChebyshevParamModeImpl_PSA (const Vector< AutoDiffA< T > > &coeffs, const RecordInterface &mode)
| ChebyshevParamModeImpl_PSA (const ChebyshevParamModeImpl_PSA &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< AutoDiffA< T > >
| ChebyshevParam ()
| create a zero-th order Chebyshev polynomial with the first coefficient equal to zero.
ChebyshevParam< T > & | operator= (const ChebyshevParam< T > &other)
| make a (deep) copy of another Chebyshev polynomial
virtual | ~ChebyshevParam ()
| Destructor.
void | setCoefficients (const Vector< T > &coeffs)
| set the Chebyshev coefficients.
void | setCoefficient (const uInt which, const T &value)
| set a particular Chebyshev coefficient.
const Vector< T > & | getCoefficients () const
| return the current set of coefficients into a given Vector.
T | getCoefficient (const uInt which) const
| return a particular coefficient.
uInt | nCoefficients () const
| return the number of coeefficients currently loaded.
void | setInterval (T xmin, T xmax)
| set the Chebyshev interval for this function.
T | getIntervalMin () const
| return the minimum value for the currently Chebyshev interval.
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 T &val)
| set the default value of this function.
const 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, T >
| Function ()
| Constructors.
virtual | ~Function ()
| Destructor.
uInt | nparameters () const
| Returns the number of parameters.
virtual T | eval (FunctionArg x) const=0
| Evaluate the function object.
T & | operator[] (const uInt n)
| Manipulate the nth parameter (0-based) with no index check.
virtual T | operator() () const
| Evaluate this function object at xor at x, y.
Bool & | mask (const uInt n)
| Manipulate the mask associated with the nth parameter (e.g.
const FunctionParam< T > & | parameters () const
| Return the parameter interface.
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, T > * | 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< 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::Function1D< T, U >
typedef const T * | FunctionArg
Public Types inherited from casacore::Function< T, T >
typedef FunctionTraits< T >::ArgType | ArgType
typedef const ArgType * | FunctionArg
Static Public Member Functions inherited from casacore::ChebyshevParam< AutoDiffA< T > >
static void | derivativeCoeffs (Vector< T > &coeffs, const T &xmin=T(-1), const T &xmax=T(1))
| transform a set of Chebyshev polynomial coefficients into a set representing the series' derivative.
static void | chebyshevToPower (Vector< T > &coeffs)
| convert a set of Chebyshev polynomial coefficients to power series coefficients.
static void | powerToChebyshev (Vector< T > &coeffs)
| convert a set of power series coefficients to Chebyshev polynomial coefficients.
Protected Attributes inherited from casacore::ChebyshevParam< AutoDiffA< T > >
T | def_p
| Default value if outside interval.
T | minx_p
| Lowest interval bound.
T | maxx_p
| Highest inetrval bound.
ChebyshevEnums::OutOfIntervalMode | mode_p
| Out-of-interval handling type.
Protected Attributes inherited from casacore::Function< T, T >
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< AutoDiffA< T > >
static Vector< String > | modes_s

## Detailed Description

template<class T>
class casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >

Partial specialization of ChebyshevParamModeImpl for AutoDiff.

### Synopsis

Warning: The name ChebyshevParamModeImpl_PS is only for cxx2html limitations;

Definition at line 496 of file ChebyshevParam.h.

## Constructor & Destructor Documentation

## ChebyshevParamModeImpl_PSA() [1/7]

template<class T>

casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::ChebyshevParamModeImpl_PSA | ( |  | ) |

inline

Definition at line 500 of file ChebyshevParam.h.

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam().

Referenced by ChebyshevParamModeImpl_PSA().

## ChebyshevParamModeImpl_PSA() [2/7]

template<class T>

casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::ChebyshevParamModeImpl_PSA | ( | const uInt | n | ) |

inline explicit

Definition at line 502 of file ChebyshevParam.h.

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam().

## ChebyshevParamModeImpl_PSA() [3/7]

template<class T>

casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::ChebyshevParamModeImpl_PSA | ( | const AutoDiffA< T > & | min,
|  | const AutoDiffA< T > & | max,
|  | typename ChebyshevEnums::OutOfIntervalMode | mode = ChebyshevEnums::CONSTANT,
|  | const AutoDiffA< T > & | defval = AutoDiffA<T>(0) )

inline

Definition at line 505 of file ChebyshevParam.h.

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam(), casacore::ChebyshevEnums::CONSTANT, casacore::max(), and casacore::min().

## ChebyshevParamModeImpl_PSA() [4/7]

template<class T>

casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::ChebyshevParamModeImpl_PSA | ( | const Vector< AutoDiffA< T > > & | coeffs,
|  | const AutoDiffA< T > & | min,
|  | const AutoDiffA< T > & | max,
|  | typename ChebyshevEnums::OutOfIntervalMode | mode = ChebyshevEnums::CONSTANT,
|  | const AutoDiffA< T > & | defval = AutoDiffA<T>(0) )

inline

Definition at line 511 of file ChebyshevParam.h.

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam(), casacore::ChebyshevEnums::CONSTANT, casacore::max(), and casacore::min().

## ChebyshevParamModeImpl_PSA() [5/7]

template<class T>

casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::ChebyshevParamModeImpl_PSA | ( | uInt | order,
|  | const RecordInterface & | mode )

inline

Definition at line 518 of file ChebyshevParam.h.

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam(), casacore::ChebyshevParam< AutoDiffA< T > >::order(), and casacore::RecordInterface().

## ChebyshevParamModeImpl_PSA() [6/7]

template<class T>

casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::ChebyshevParamModeImpl_PSA | ( | const Vector< AutoDiffA< T > > & | coeffs,
|  | const RecordInterface & | mode )

inline

Definition at line 520 of file ChebyshevParam.h.

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam(), and casacore::RecordInterface().

## ChebyshevParamModeImpl_PSA() [7/7]

template<class T>

casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::ChebyshevParamModeImpl_PSA | ( | const ChebyshevParamModeImpl_PSA< AutoDiffA< T > > & | other | ) |

inline

Definition at line 524 of file ChebyshevParam.h.

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam(), and ChebyshevParamModeImpl_PSA().

## Member Function Documentation

## getMode()

template<class T>

virtual void casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< T > >::getMode | ( | RecordInterface & | mode | ) | const

virtual

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

References casacore::ChebyshevParam< AutoDiffA< T > >::ChebyshevParam(), casacore::ChebyshevParam< AutoDiffA< T > >::getDefault(), casacore::ChebyshevParam< AutoDiffA< T > >::getIntervalMax(), casacore::ChebyshevParam< AutoDiffA< T > >::getIntervalMin(), casacore::ChebyshevParam< AutoDiffA< T > >::getOutOfIntervalMode(), casacore::ChebyshevParam< AutoDiffA< T > >::modes_s, casacore::RecordInterface(), and casacore::ChebyshevParam< AutoDiffA< T > >::setOutOfIntervalMode().

## setMode()

template<class T>

virtual void casacore::ChebyshevParamModeImpl_PSA< AutoDiffA< 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, T >.

References casacore::RecordInterface().

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

- scimath/Functionals/ChebyshevParam.h