casacore
UnaryFunction.h
Go to the documentation of this file.
1//# UnaryFunction.h: A one dimensional unary function
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_UNARYFUNCTION_H
29#define SCIMATH_UNARYFUNCTION_H
30
31//# Includes
32#include <casacore/casa/aips.h>
33#include <casacore/scimath/Functionals/UnaryParam.h>
34#include <casacore/scimath/Functionals/Function.h>
35
36namespace casacore { //# NAMESPACE CASACORE - BEGIN
37
38//# Forward declarations
39
40// <summary> A one dimensional unary function
41// </summary>
42
43// <use visibility=export>
44
45// <reviewed reviewer="" date="" tests="tFunctionHolder"
46// demos="">
47// </reviewed>
48
49// <prerequisite>
50// <li> <linkto class="UnaryParam">UnaryParam</linkto>
51// <li> <linkto class="Function">Function</linkto>
52// </prerequisite>
53
54// <etymology>
55// A 1-dimensional unary hat.
56// </etymology>
57
58// <synopsis>
59// A <src>Unary</src> is described by a height, a center and a width
60// (halfwidth). The value is:
61// <srcblock>
62// height (|x-center| < width)
63// 0.5height (|x-center| == width)
64// 0 (|x-center| > width)
65// </srcblock>
66// The parameters are enumerated by HEIGHT, CENTER and WIDTH. They have
67// default values of (1, 0, 1).
68// </synopsis>
69//
70// <example>
71// <srcblock>
72// UnaryFunction<Double> sf(5.0, 25.0, 7);
73// sf(25); // = 5.0
74// </srcblock>
75// </example>
76
77// <templating arg=T>
78// <li> T should have standard numerical operators
79// </templating>
80
81// <thrown>
82// <li> AipsError if incorrect parameter number specified.
83// </thrown>
84//
85
86template<class T> class UnaryFunction : public UnaryParam<T>
87{
88public:
89 //# Constructors
90 // Constructs the UnaryFunction, Defaults:
91 // height=1, center=0, width=1.
92 // <note role=warning> Could not use default arguments
93 // that worked both with gcc and IRIX </note>
94 // <group>
96 explicit UnaryFunction(const T &height) :
97 UnaryParam<T>(height) {}
98 UnaryFunction(const T &height, const T &center) :
99 UnaryParam<T>(height, center) {}
100 UnaryFunction(const T &height, const T &center, const T &width) :
101 UnaryParam<T>(height, center, width) {}
102 // </group>
103
104 // Copy constructor (deep copy)
105 // <group>
106 UnaryFunction(const UnaryFunction<T> &other) : UnaryParam<T>(other) {}
107 template <class W>
108 UnaryFunction(const UnaryFunction<W> &other) : UnaryParam<T>(other) {}
109 // </group>
110 // Copy assignment (deep copy)
112 UnaryParam<T>::operator=(other); return *this; }
113
114 // Destructor
115 virtual ~UnaryFunction() {}
116
117 //# Operators
118 // Evaluate the Unary at <src>x</src>.
119 // If a vector is used as the argument only its first element is used.
120 // <group>
121 virtual T eval(typename Function<T>::FunctionArg x) const;
122 // </group>
123
124 //# Member functions
125 // Return a copy of this object from the heap. The caller is responsible
126 // for deleting this pointer.
127 // <group>
128 virtual Function<T> *clone() const { return new UnaryFunction<T>(*this); }
133 // </group>
134
135 //# Make members of parent classes known.
136protected:
137 using UnaryParam<T>::param_p;
138public:
140 using UnaryParam<T>::CENTER;
141 using UnaryParam<T>::WIDTH;
142 using UnaryParam<T>::HEIGHT;
143};
144
145
146} //# NAMESPACE CASACORE - END
147
148#ifndef CASACORE_NO_AUTO_TEMPLATES
149#include <casacore/scimath/Functionals/UnaryFunction.tcc>
150#endif //# CASACORE_NO_AUTO_TEMPLATES
151#endif
FunctionParam< T > param_p
The parameters and masks.
Definition: Function.h:332
uInt nparameters() const
Returns the number of parameters.
Definition: Function.h:230
virtual T eval(typename Function< T >::FunctionArg x) const
Evaluate the Unary at x.
UnaryFunction()
Constructs the UnaryFunction, Defaults: height=1, center=0, width=1.
Definition: UnaryFunction.h:95
UnaryFunction(const UnaryFunction< T > &other)
Copy constructor (deep copy)
UnaryFunction(const T &height, const T &center, const T &width)
virtual Function< typename FunctionTraits< T >::DiffType > * cloneAD() const
UnaryFunction(const T &height, const T &center)
Definition: UnaryFunction.h:98
virtual ~UnaryFunction()
Destructor.
virtual Function< T > * clone() const
Return a copy of this object from the heap.
virtual Function< typename FunctionTraits< T >::BaseType > * cloneNonAD() const
UnaryFunction< T > & operator=(const UnaryFunction< T > &other)
Copy assignment (deep copy)
UnaryFunction(const UnaryFunction< W > &other)
UnaryFunction(const T &height)
Definition: UnaryFunction.h:96
UnaryParam< T > & operator=(const UnaryParam< T > &other)
Copy assignment (deep copy)
this file contains all the compiler specific defines
Definition: mainpage.dox:28