casacore
SPolynomialParam.h
Go to the documentation of this file.
1 //# SPolynomialParam.h: Parameter handling for scaled 1-D polynomials
2 //# Copyright (C) 2002,2005
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be addressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //# $Id$
27 
28 #ifndef SCIMATH_SPOLYNOMIALPARAM_H
29 #define SCIMATH_SPOLYNOMIALPARAM_H
30 
31 //# Includes
32 #include <casacore/casa/aips.h>
33 #include <casacore/scimath/Functionals/Function.h>
34 #include <casacore/casa/BasicSL/String.h>
35 #include <casacore/casa/Utilities/Assert.h>
36 #include <casacore/casa/Arrays/ArrayFwd.h>
37 
38 namespace casacore { //# NAMESPACE CASACORE - BEGIN
39 
40 // <summary> Parameter handling for scaled 1-D polynomials
41 // </summary>
42 
43 // <reviewed reviewer="" date="" tests="tSPolynomial"
44 // demos="">
45 // </reviewed>
46 
47 // <prerequisite>
48 // <li> <linkto class="FunctionParam">FunctionParam</linkto> class
49 // <li> <linkto class=Function>Function</linkto>
50 // </prerequisite>
51 
52 // <etymology>
53 // A 1-dimensional Scaled Polynomial's parameters.
54 // </etymology>
55 //
56 // <synopsis>
57 // A <src>SPolynomial</src> is described by a set of coefficients;
58 // its fundamental operation is evaluating itself at some "x".
59 // The number of coefficients is the order of the polynomial plus one,
60 // plus three, describing a height, center and width. These three parameters
61 // are the first three, and have default values of 1, 0, 1.
62 //
63 // Since the <src>SPolynomial</src> is a <src>Function</src>, the derivatives
64 // can be obtained as well.
65 //
66 // The parameter interface (see
67 // <linkto class="FunctionParam">FunctionParam</linkto> class),
68 // is used to provide an interface to the
69 // <linkto module="Fitting">Fitting</linkto> classes.
70 //
71 // This class is in general used implicitly by the <src>SPolynomial</src>
72 // class only.
73 // </synopsis>
74 //
75 // <example>
76 // <srcblock>
77 // SPolynomial<Float> pf(3); // Third order polynomial - coeffs 0 by default
78 // pf.setCoefficient(1, 1.0);
79 // pf[5] = 2.0;
80 // pf.setCoefficient(3, 3.0); // 3x^3 + 2x^2 + x
81 // pf(2); // == 34
82 // </srcblock>
83 // </example>
84 
85 // <templating arg=T>
86 // <li> T should have standard numerical operators. Current
87 // implementation only tested for real types (and their AutoDiffs).
88 // </templating>
89 
90 // <thrown>
91 // <li> Assertion in debug mode if attempt is made to address incorrect
92 // coefficients
93 // </thrown>
94 
95 // <todo asof="2002/05/20">
96 // <li> Nothing I know of
97 // </todo>
98 
99 template<class T> class SPolynomialParam: public Function<T>
100 {
101 public:
102  //# Constructors
103  // Constructs a zero'th order polynomial, with a coeficcient of 0.0.
105 
106  // Makes a polynomial of the given order, with all coeficcients set to
107  // zero.
109 
110  // Make this a copy of other (deep copy).
111  // <group>
113  template <class W>
115  Function<T>(other) {}
117  // </group>
118 
119  // Destructor
121 
122  //# Operators
123  // Comparisons.
124  // SPolynomials are equal if they are of the same order
125  // <group>
126  Bool operator==(const SPolynomialParam<T> &other) const {
127  return (param_p == other.param_p); }
128  Bool operator!=(const SPolynomialParam<T> &other) const {
129  return (param_p != other.param_p); }
130  // </group>
131 
132  //# Member functions
133  // Give name of function
134  virtual const String &name() const { static String x("spolynomial");
135  return x; }
136 
137  // What is the order of the polynomial, i.e. maximum exponent of "x".
138  uInt order() const { return param_p.nelements() - 4; }
139 
140  // What is the <em>which</em>'th coefficient of the polynomial. For an nth
141  // degree polynomial, <em>which</em> varies between zero and n.
142  T coefficient(uInt which) const {
143  DebugAssert(which<=order(), AipsError); return param_p[which+3]; }
144 
145  // Return all the coefficients as a vector.
147 
148  // Set the <em>which</em>'th coefficient to <em>value</em>.
149  void setCoefficient(uInt which, const T value) {
150  DebugAssert(which<=order(), AipsError); param_p[which+3] = value; }
151 
152  // Set all the coefficients at once, throw away all existing coefficients.
154 
155  // Returns the dimension of function
156  virtual uInt ndim() const { return 1; }
157 
158  //# Make members of parent classes known.
159 protected:
160  using Function<T>::param_p;
161 public:
163  using Function<T>::mask;
164 };
165 
166 
167 } //# NAMESPACE CASACORE - END
168 
169 #ifndef CASACORE_NO_AUTO_TEMPLATES
170 #include <casacore/scimath/Functionals/SPolynomialParam.tcc>
171 #endif //# CASACORE_NO_AUTO_TEMPLATES
172 #endif
#define DebugAssert(expr, exception)
Definition: Assert.h:185
FunctionParam< T > param_p
The parameters and masks.
Definition: Function.h:332
Vector< T > coefficients() const
Return all the coefficients as a vector.
T coefficient(uInt which) const
What is the which'th coefficient of the polynomial.
virtual uInt ndim() const
Returns the dimension of function.
SPolynomialParam(uInt order)
Makes a polynomial of the given order, with all coeficcients set to zero.
~SPolynomialParam()
Destructor.
void setCoefficient(uInt which, const T value)
Set the which'th coefficient to value.
Bool operator==(const SPolynomialParam< T > &other) const
Comparisons.
SPolynomialParam(const SPolynomialParam< T > &other)
Make this a copy of other (deep copy).
Bool operator!=(const SPolynomialParam< T > &other) const
uInt order() const
What is the order of the polynomial, i.e.
SPolynomialParam()
Constructs a zero'th order polynomial, with a coeficcient of 0.0.
SPolynomialParam< T > & operator=(const SPolynomialParam< T > &other)
SPolynomialParam(const SPolynomialParam< W > &other)
virtual const String & name() const
Give name of function.
void setCoefficients(const Vector< T > &coefficients)
Set all the coefficients at once, throw away all existing coefficients.
String: the storage and methods of handling collections of characters.
Definition: String.h:225
this file contains all the compiler specific defines
Definition: mainpage.dox:28
unsigned int uInt
Definition: aipstype.h:51
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
LatticeExprNode value(const LatticeExprNode &expr)
This function returns the value of the expression without a mask.