casacore
EvenPolynomialParam.h
Go to the documentation of this file.
1 //# EvenPolynomialParam.h: Parameter handling for even 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_EVENPOLYNOMIALPARAM_H
29 #define SCIMATH_EVENPOLYNOMIALPARAM_H
30 
31 //# Includes
32 #include <casacore/casa/aips.h>
33 #include <casacore/casa/Arrays/ArrayFwd.h>
34 #include <casacore/scimath/Functionals/Function1D.h>
35 #include <casacore/casa/Utilities/Assert.h>
36 
37 namespace casacore { //# NAMESPACE CASACORE - BEGIN
38 
39 // <summary> Parameter handling for even polynomials
40 // </summary>
41 
42 // <reviewed reviewer="tcornwel" date="1996/02/22" tests="tSpecialPolynomial"
43 // demos="">
44 // </reviewed>
45 
46 // <prerequisite>
47 // <li> <linkto class="FunctionParam">FunctionParam</linkto> class
48 // <li> <linkto class=Function1D>Function1D</linkto>
49 // </prerequisite>
50 
51 // <etymology>
52 // A 1-dimensional EvenPolynomial's parameters.
53 // </etymology>
54 //
55 // <synopsis>
56 // An <src>EvenPolynomial</src> is described by a set of coefficients;
57 // its fundamental operation is evaluating itself at some "x".
58 // The number of coefficients is the order of the polynomial divided
59 // by two, plus one.
60 //
61 // Since the <src>EvenPolynomial</src> is a <src>Function</src>,
62 // the derivatives can be obtained as well.
63 //
64 // The parameter interface (see
65 // <linkto class="FunctionParam">FunctionParam</linkto> class),
66 // is used to provide an interface to the
67 // <linkto module="Fitting">Fitting</linkto> classes.
68 //
69 // This class is in general used implicitly by the <src>EvenPolynomial</src>
70 // class only.
71 // </synopsis>
72 //
73 // <example>
74 // <srcblock>
75 // EvenPolynomial<Float> pf(3); // Second order polynomial - coeffs 0 by default
76 // pf.setCoefficient(0, 1.0);
77 // pf[1] = 2.0; // 2x^2 + 1x^0
78 // pf(2); // == 8
79 // </srcblock>
80 // </example>
81 
82 // <templating arg=T>
83 // <li> T should have standard numerical operators. Current
84 // implementation only tested for real types (and their AutoDiffs).
85 // </templating>
86 
87 // <thrown>
88 // <li> Assertion in debug mode if attempt is made to address incorrect
89 // coefficients
90 // </thrown>
91 
92 // <todo asof="2002/02/26">
93 // <li> Nothing I know of
94 // </todo>
95 
96 template<class T> class EvenPolynomialParam: public Function1D<T>
97 {
98 public:
99  //# Constructors
100  // Constructs a zero'th order polynomial, with a coeficcient of 0.0.
102 
103  // Makes a polynomial of the given order, with all coeficcients set to
104  // zero.
106 
107  // Make this a copy of other (deep copy).
108  // <group>
110  template <class W>
112  Function1D<T>(other) {}
114  // </group>
115 
116  // Destructor
118 
119  //# Operators
120  // Comparisons.
121  // EvenPolynomials are equal if they are the same order
122  // <group>
123  Bool operator==(const EvenPolynomialParam<T> &other) const {
124  return (param_p == other.param_p); }
125  Bool operator!=(const EvenPolynomialParam<T> &other) const {
126  return (param_p != other.param_p); }
127  // </group>
128 
129  //# Member functions
130  // Give name of function
131  virtual const String &name() const { static String x("evenpolynomial");
132  return x; }
133 
134  // What is the order of the polynomial, i.e. maximum exponent of "x".
135  uInt order() const { return 2*param_p.nelements() - 2; }
136 
137  // What is the <em>which</em>'th coefficient of the polynomial. For an nth
138  // degree polynomial, <em>which</em> varies between zero and n/2.
139  T coefficient(uInt which) const {
140  DebugAssert(which<=order(), AipsError); return param_p[which]; }
141 
142  // Return all the coefficients as a vector.
143  const Vector<T> &coefficients() const;
144 
145  // Set the <em>which</em>'th coefficient to <em>value</em>.
146  void setCoefficient(uInt which, const T value) {
147  DebugAssert(which<=order(), AipsError); param_p[which] = value; }
148 
149  // Set all the coefficients at once, throw away all existing coefficients.
151 
152  //# Make members of parent classes known.
153 protected:
155 public:
157 };
158 
159 
160 } //# NAMESPACE CASACORE - END
161 
162 #ifndef CASACORE_NO_AUTO_TEMPLATES
163 #include <casacore/scimath/Functionals/EvenPolynomialParam.tcc>
164 #endif //# CASACORE_NO_AUTO_TEMPLATES
165 #endif
#define DebugAssert(expr, exception)
Definition: Assert.h:185
Bool operator==(const EvenPolynomialParam< T > &other) const
Comparisons.
Bool operator!=(const EvenPolynomialParam< T > &other) const
T coefficient(uInt which) const
What is the which'th coefficient of the polynomial.
EvenPolynomialParam< T > & operator=(const EvenPolynomialParam< T > &other)
const Vector< T > & coefficients() const
Return all the coefficients as a vector.
EvenPolynomialParam(const EvenPolynomialParam< T > &other)
Make this a copy of other (deep copy).
void setCoefficient(uInt which, const T value)
Set the which'th coefficient to value.
EvenPolynomialParam(const EvenPolynomialParam< W > &other)
EvenPolynomialParam()
Constructs a zero'th order polynomial, with a coeficcient of 0.0.
uInt order() const
What is the order of the polynomial, i.e.
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.
EvenPolynomialParam(uInt order)
Makes a polynomial of the given order, with all coeficcients set to zero.
FunctionParam< T > param_p
The parameters and masks.
Definition: Function.h:332
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.