Loading...
Searching...
No Matches
PowerLogarithmicPolynomial.h
Go to the documentation of this file.
//# Polynomial.h: A one dimensional polynomial class
//# Copyright (C) 1994,1995,1996,2001,2002,2005
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef SCIMATH_POWERLOGARITHMICPOLYNOMIAL_H
#define SCIMATH_POWERLOGARITHMICPOLYNOMIAL_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/PowerLogarithmicPolynomialParam.h>
#include <casacore/scimath/Functionals/Function1D.h>
#include <casacore/scimath/Mathematics/AutoDiff.h>
#include <casacore/scimath/Mathematics/AutoDiffMath.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
// <summary> A one dimensional power logarithmic polynomial class of form
// y = c_0 * x**( c_1 + c_2*ln(x) + c_3*ln(x)**2 + ... c_n*ln(x)**(n-1))
// </summary>
// <reviewed reviewer="" date="" tests="tPowerLogarithmicPolynomial"
// demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=Function>Function</linkto>
// </prerequisite>
//
// <synopsis>
// A Power Logarithmic Polynomial<T> contains a set of coefficients; its fundamental operations
// is evaluating itself at some "x".
//
// <note role=tip>
// The present implementation merely stores the coefficients in a Block. In the
// unlikely case that we need to deal with polynomials with many zero
// coefficients, a more efficient representation would be possible.
// </note>
// </synopsis>
//
// <example>
// <srcblock>
// </srcblock>
// </example>
// <templating arg=T>
// <li> T should have standard numerical operators. Current
// implementation only tested for real types (and their AutoDiffs).
// </templating>
// <thrown>
// <li> Assertion in debug mode if attempt is made to address incorrect
// coefficients
// </thrown>
template<class T> class PowerLogarithmicPolynomial: public PowerLogarithmicPolynomialParam<T> {
public:
// Constructs an empty PowerLogarithmicPolynomial
PowerLogarithmicPolynomial() : PowerLogarithmicPolynomialParam<T>() {}
// Makes a power logaritmic polynomial with the specified number of coefficients, all set to
// zero.
explicit PowerLogarithmicPolynomial(uInt n) : PowerLogarithmicPolynomialParam<T>(n) {}
// Make a function with the specified params.
PowerLogarithmicPolynomial(const vector<T>& parms) : PowerLogarithmicPolynomialParam<T>(parms) {}
// Copy constructor/assignment (deep copy)
// <group>
PowerLogarithmicPolynomial(const PowerLogarithmicPolynomial<T> &other) : PowerLogarithmicPolynomialParam<T>(other) {}
template <class W>
PowerLogarithmicPolynomial(const PowerLogarithmicPolynomial<W> &other) : PowerLogarithmicPolynomialParam<T>(other) {}
PowerLogarithmicPolynomial<T> &operator=(const PowerLogarithmicPolynomial<T> &other) {
PowerLogarithmicPolynomialParam<T>::operator=(other); return *this; }
// </group>
// Destructor
virtual ~PowerLogarithmicPolynomial() {}
//# Operators
// Evaluate the polynomial at <src>x</src>.
virtual T eval(typename Function1D<T>::FunctionArg x) const;
// Return a copy of this object from the heap. The caller is responsible for
// deleting the pointer.
// <group>
virtual Function<T> *clone() const { return new PowerLogarithmicPolynomial<T>(*this); }
virtual Function<typename FunctionTraits<T>::DiffType> *cloneAD() const {
return new PowerLogarithmicPolynomial<typename FunctionTraits<T>::DiffType>(*this); }
virtual Function<typename FunctionTraits<T>::BaseType> *cloneNonAD() const {
return new PowerLogarithmicPolynomial<typename FunctionTraits<T>::BaseType>(*this); }
// </group>
//# Make members of parent classes known.
protected:
using PowerLogarithmicPolynomialParam<T>::param_p;
public:
using PowerLogarithmicPolynomialParam<T>::nparameters;
};
#define PowerLogarithmicPolynomial_PS PowerLogarithmicPolynomial
// <summary> Partial specialization of PowerLogarithmicPolynomial for <src>AutoDiff</src>
// </summary>
// <synopsis>
// <note role=warning> The name <src>PowerLogarithmicPolynomial_PS</src> is only for cxx2html
// documentation problems. Use <src>PowerLogarithmicPolynomial</src> in your code.</note>
// </synopsis>
template <class T> class PowerLogarithmicPolynomial_PS<AutoDiff<T> > :
public PowerLogarithmicPolynomialParam<AutoDiff<T> > {
public:
//# Constructors
// Constructs one dimensional Polynomials.
// <group>
PowerLogarithmicPolynomial_PS() : PowerLogarithmicPolynomialParam<AutoDiff<T> >() {}
explicit PowerLogarithmicPolynomial_PS(uInt n) :
PowerLogarithmicPolynomialParam<AutoDiff<T> >(n) {}
// </group>
// Copy constructor (deep copy)
// <group>
PowerLogarithmicPolynomial_PS(const PowerLogarithmicPolynomial_PS<AutoDiff<T> > &other) :
PowerLogarithmicPolynomialParam<AutoDiff<T> >(other) {}
template <class W>
PowerLogarithmicPolynomial_PS(const PowerLogarithmicPolynomial_PS<W> &other) :
PowerLogarithmicPolynomialParam<AutoDiff<T> >(other) {}
// </group>
// Copy assignment (deep copy)
PowerLogarithmicPolynomial_PS<AutoDiff<T> > &
operator=(const PowerLogarithmicPolynomial_PS<AutoDiff<T> > &other) {
PowerLogarithmicPolynomialParam<AutoDiff<T> >::operator=(other); return *this; }
// Destructor
virtual ~PowerLogarithmicPolynomial_PS() {}
//# Operators
// Evaluate the function and its derivatives at <src>x</src> <em>wrt</em>
// to the coefficients.
// <group>
virtual AutoDiff<T> eval(typename Function<AutoDiff<T> >::FunctionArg x) const;
// </group>
//# Member functions
// Return a copy of this object from the heap. The caller is responsible
// for deleting this pointer.
// <group>
virtual Function<AutoDiff<T> > *clone() const {
return new PowerLogarithmicPolynomial<AutoDiff<T> >(*this); }
virtual Function<typename FunctionTraits<AutoDiff<T> >::DiffType>
*cloneAD() const {
return new PowerLogarithmicPolynomial<typename FunctionTraits<AutoDiff<T> >::DiffType>
(*this); }
virtual Function<typename FunctionTraits<AutoDiff<T> >::BaseType>
*cloneNonAD() const {
return new PowerLogarithmicPolynomial<typename FunctionTraits<AutoDiff<T> >::BaseType>
(*this); }
// </group>
//# Make members of parent classes known.
protected:
using PowerLogarithmicPolynomialParam<AutoDiff<T> >::param_p;
public:
using PowerLogarithmicPolynomialParam<AutoDiff<T> >::nparameters;
};
#undef PowerLogarithmicPolynomial_PS
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Functionals/PowerLogarithmicPolynomial.tcc>
#include <casacore/scimath/Functionals/PowerLogarithmicPolynomial2.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
PowerLogarithmicPolynomial_PS
#define PowerLogarithmicPolynomial_PS
Definition PowerLogarithmicPolynomial.h:126
casacore::AutoDiff
Definition AutoDiff.h:254
casacore::Function1D::FunctionArg
const T * FunctionArg
Definition Function1D.h:76
casacore::Function
Definition Function.h:200
casacore::Function< T, T >::param_p
FunctionParam< T > param_p
Definition Function.h:330
casacore::Function< T, T >::nparameters
uInt nparameters() const
Definition Function.h:228
casacore::PowerLogarithmicPolynomialParam
Definition PowerLogarithmicPolynomialParam.h:87
casacore::PowerLogarithmicPolynomialParam::operator=
PowerLogarithmicPolynomialParam< T > & operator=(const PowerLogarithmicPolynomialParam< T > &other)
casacore::PowerLogarithmicPolynomialParam::PowerLogarithmicPolynomialParam
PowerLogarithmicPolynomialParam()
Constructs a function with two coefficients, both 1 (so y = x).
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::PowerLogarithmicPolynomial_PS
PowerLogarithmicPolynomial_PS()
Constructs one dimensional Polynomials.
Definition PowerLogarithmicPolynomial.h:141
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::PowerLogarithmicPolynomial_PS
PowerLogarithmicPolynomial_PS(const PowerLogarithmicPolynomial_PS< W > &other)
Definition PowerLogarithmicPolynomial.h:151
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::clone
virtual Function< AutoDiff< T > > * clone() const
Return a copy of this object from the heap.
Definition PowerLogarithmicPolynomial.h:174
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::operator=
PowerLogarithmicPolynomial_PS< AutoDiff< T > > & operator=(const PowerLogarithmicPolynomial_PS< AutoDiff< T > > &other)
Copy assignment (deep copy).
Definition PowerLogarithmicPolynomial.h:157
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::PowerLogarithmicPolynomial_PS
PowerLogarithmicPolynomial_PS(uInt n)
Definition PowerLogarithmicPolynomial.h:142
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::PowerLogarithmicPolynomial_PS
PowerLogarithmicPolynomial_PS(const PowerLogarithmicPolynomial_PS< AutoDiff< T > > &other)
Copy constructor (deep copy).
Definition PowerLogarithmicPolynomial.h:148
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::eval
virtual AutoDiff< T > eval(typename Function< AutoDiff< T > >::FunctionArg x) const
Evaluate the function and its derivatives at x wrt to the coefficients.
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::cloneNonAD
virtual Function< typename FunctionTraits< AutoDiff< T > >::BaseType > * cloneNonAD() const
Definition PowerLogarithmicPolynomial.h:181
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::cloneAD
virtual Function< typename FunctionTraits< AutoDiff< T > >::DiffType > * cloneAD() const
Definition PowerLogarithmicPolynomial.h:177
casacore::PowerLogarithmicPolynomial_PS< AutoDiff< T > >::~PowerLogarithmicPolynomial_PS
virtual ~PowerLogarithmicPolynomial_PS()
Destructor.
Definition PowerLogarithmicPolynomial.h:161
casacore::PowerLogarithmicPolynomial
Definition PowerLogarithmicPolynomial.h:78
casacore::PowerLogarithmicPolynomial::cloneNonAD
virtual Function< typename FunctionTraits< T >::BaseType > * cloneNonAD() const
Definition PowerLogarithmicPolynomial.h:114
casacore::PowerLogarithmicPolynomial::eval
virtual T eval(typename Function1D< T >::FunctionArg x) const
Evaluate the polynomial at x.
casacore::PowerLogarithmicPolynomial::cloneAD
virtual Function< typename FunctionTraits< T >::DiffType > * cloneAD() const
Definition PowerLogarithmicPolynomial.h:112
casacore::PowerLogarithmicPolynomial::PowerLogarithmicPolynomial
PowerLogarithmicPolynomial()
Constructs an empty PowerLogarithmicPolynomial.
Definition PowerLogarithmicPolynomial.h:82
casacore::PowerLogarithmicPolynomial::clone
virtual Function< T > * clone() const
Return a copy of this object from the heap.
Definition PowerLogarithmicPolynomial.h:111
casacore::PowerLogarithmicPolynomial::operator=
PowerLogarithmicPolynomial< T > & operator=(const PowerLogarithmicPolynomial< T > &other)
Definition PowerLogarithmicPolynomial.h:96
casacore::PowerLogarithmicPolynomial::PowerLogarithmicPolynomial
PowerLogarithmicPolynomial(uInt n)
Makes a power logaritmic polynomial with the specified number of coefficients, all set to zero.
Definition PowerLogarithmicPolynomial.h:86
casacore::PowerLogarithmicPolynomial::PowerLogarithmicPolynomial
PowerLogarithmicPolynomial(const PowerLogarithmicPolynomial< W > &other)
Definition PowerLogarithmicPolynomial.h:95
casacore::PowerLogarithmicPolynomial::PowerLogarithmicPolynomial
PowerLogarithmicPolynomial(const PowerLogarithmicPolynomial< T > &other)
Copy constructor/assignment (deep copy).
Definition PowerLogarithmicPolynomial.h:93
casacore::PowerLogarithmicPolynomial::~PowerLogarithmicPolynomial
virtual ~PowerLogarithmicPolynomial()
Destructor.
Definition PowerLogarithmicPolynomial.h:101
casacore::PowerLogarithmicPolynomial::PowerLogarithmicPolynomial
PowerLogarithmicPolynomial(const vector< T > &parms)
Make a function with the specified params.
Definition PowerLogarithmicPolynomial.h:89
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49