Loading...
Searching...
No Matches
OddPolynomialParam.h
Go to the documentation of this file.
//# OddPolynomialParam.h: Parameter handling for odd polynomials
//# Copyright (C) 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_ODDPOLYNOMIALPARAM_H
#define SCIMATH_ODDPOLYNOMIALPARAM_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/ArrayFwd.h>
#include <casacore/scimath/Functionals/Function1D.h>
#include <casacore/casa/BasicSL/String.h>
#include <casacore/casa/Utilities/Assert.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary> Parameter handling for odd polynomials
// </summary>
// <reviewed reviewer="tcornwel" date="1996/02/22" tests="tSpecialPolynomial"
// demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="FunctionParam">FunctionParam</linkto> class
// <li> <linkto class=Function1D>Function1D</linkto>
// </prerequisite>
// <etymology>
// A 1-dimensional OddPolynomial's parameters.
// </etymology>
//
// <synopsis>
// An <src>OddPolynomial</src> is described by a set of coefficients;
// its fundamental operation is evaluating itself at some "x".
// The number of coefficients is the order of the polynomial divided
// by two, plus one.
//
// Since the <src>OddPolynomial</src> is a <src>Function</src>, the derivatives
// can be obtained as well.
//
// The parameter interface (see
// <linkto class="FunctionParam">FunctionParam</linkto> class),
// is used to provide an interface to the
// <linkto module="Fitting">Fitting</linkto> classes.
//
// This class is in general used implicitly by the <src>OddPolynomial</src>
// class only.
// </synopsis>
//
// <example>
// <srcblock>
// OddPolynomial<Float> pf(3); // Third order polynomial - coeffs 0 by default
// pf.setCoefficient(0, 1.0);
// pf[1] = 2.0; // 2x^3 + 1x^1
// pf(2); // == 18
// </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>
// <todo asof="2002/02/26">
// <li> Nothing I know off
// </todo>
template<class T> class OddPolynomialParam: public Function1D<T>
{
public:
//# Constructors
// Constructs a first order polynomial, with a coeficcient of 0.0.
OddPolynomialParam();
// Makes a polynomial of the given order, with all coeficcients set to
// zero.
explicit OddPolynomialParam(uInt order);
// Make this a copy of other (deep copy).
// <group>
OddPolynomialParam(const OddPolynomialParam<T> &other);
template <class W>
OddPolynomialParam(const OddPolynomialParam<W> &other) :
Function1D<T>(other) {}
OddPolynomialParam<T> &operator=(const OddPolynomialParam<T> &other);
// </group>
// Destructor
~OddPolynomialParam();
//# Operators
// Comparisons.
// OddPolynomials are equal if they are the same order
// <group>
Bool operator==(const OddPolynomialParam<T> &other) const {
return (param_p == other.param_p); }
Bool operator!=(const OddPolynomialParam<T> &other) const {
return (param_p != other.param_p); }
// </group>
//# Member functions
// Give name of function
virtual const String &name() const { static String x("oddpolynomial");
return x; }
// What is the order of the polynomial, i.e. maximum exponent of "x".
uInt order() const { return 2*param_p.nelements() - 1; }
// What is the <em>which</em>'th coefficient of the polynomial. For an nth
// degree polynomial, <em>which</em> varies between zero and n/2.
T coefficient(uInt which) const {
DebugAssert(which<=order(), AipsError); return param_p[which]; }
// Return all the coefficients as a vector.
const Vector<T> &coefficients() const;
// Set the <em>which</em>'th coefficient to <em>value</em>.
void setCoefficient(uInt which, const T value) {
DebugAssert(which<=order(), AipsError); param_p[which] = value; }
// Set all the coefficients at once, throw away all existing coefficients.
void setCoefficients(const Vector<T> &coefficients);
//# Make members of parent classes known.
protected:
using Function1D<T>::param_p;
public:
using Function1D<T>::nparameters;
};
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Functionals/OddPolynomialParam.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
DebugAssert
#define DebugAssert(expr, exception)
Definition Assert.h:183
casacore::AipsError
Definition Error.h:133
casacore::Function1D::Function1D
Function1D()
Constructors.
Definition Function1D.h:81
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::OddPolynomialParam::OddPolynomialParam
OddPolynomialParam(const OddPolynomialParam< T > &other)
Make this a copy of other (deep copy).
casacore::OddPolynomialParam::operator==
Bool operator==(const OddPolynomialParam< T > &other) const
Comparisons.
Definition OddPolynomialParam.h:122
casacore::OddPolynomialParam::setCoefficient
void setCoefficient(uInt which, const T value)
Set the which'th coefficient to value.
Definition OddPolynomialParam.h:145
casacore::OddPolynomialParam::setCoefficients
void setCoefficients(const Vector< T > &coefficients)
Set all the coefficients at once, throw away all existing coefficients.
casacore::OddPolynomialParam::OddPolynomialParam
OddPolynomialParam(uInt order)
Makes a polynomial of the given order, with all coeficcients set to zero.
casacore::OddPolynomialParam::order
uInt order() const
What is the order of the polynomial, i.e.
Definition OddPolynomialParam.h:134
casacore::OddPolynomialParam::operator=
OddPolynomialParam< T > & operator=(const OddPolynomialParam< T > &other)
casacore::OddPolynomialParam::coefficient
T coefficient(uInt which) const
What is the which'th coefficient of the polynomial.
Definition OddPolynomialParam.h:138
casacore::OddPolynomialParam::OddPolynomialParam
OddPolynomialParam()
Constructs a first order polynomial, with a coeficcient of 0.0.
casacore::OddPolynomialParam::name
virtual const String & name() const
Give name of function.
Definition OddPolynomialParam.h:130
casacore::OddPolynomialParam::~OddPolynomialParam
~OddPolynomialParam()
Destructor.
casacore::OddPolynomialParam::coefficients
const Vector< T > & coefficients() const
Return all the coefficients as a vector.
casacore::OddPolynomialParam::operator!=
Bool operator!=(const OddPolynomialParam< T > &other) const
Definition OddPolynomialParam.h:124
casacore::OddPolynomialParam::OddPolynomialParam
OddPolynomialParam(const OddPolynomialParam< W > &other)
Definition OddPolynomialParam.h:110
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::value
NewDelAllocator< T > NewDelAllocator< T >::value
Definition Allocator.h:368