1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
//# Function1D.h: Numerical functional interface class for 1 dimension
//# Copyright (C) 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_FUNCTION1D_H
#define SCIMATH_FUNCTION1D_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/scimath/Functionals/Function.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
// <summary> Numerical functional interface class for 1 dimension
// </summary>
// <use visibility=export>
// <reviewed reviewer="tcornwel" date="1996/02/22" tests="tGaussian1D"
// demos="">
// </reviewed>
// <prerequisite>
// <li> <linkto class="Function">Function</linkto>
// </prerequisite>
//
// <synopsis>
// A <src>Function1D</src> is used for classes which map a
// scalar or n-dimensional Vector of type <src>T</src> into a <src>T</src>.
// The object also has one parameter which can be masked
// if necessary, and be used in the <src>Fitting</src> module, and, implicitly,
// in the <linkto class=AutoDiff>AutoDiff</linkto> differentiation module.
//
// The only method implemented in <src>Function1D</src> is the
// <src>ndim()</src> method. The rest is inhereted from
// <linkto class="Function">Function</linkto>.
// </synopsis>
// <example>
// See <linkto class=Function>Function</linkto>.
// </example>
//
// <templating arg=T>
// <li> Besides the requirements set by the
// <linkto class="Functional">Functional</linkto> base class, it must be
// possible to form a <src>Vector<T></src>.
// </templating>
template<class T, class U=T> class Function1D : public Function<T,U> {
public:
//# Typedefs
typedef const T* FunctionArg;
//# Constructors
// Constructors
// <group>
Function1D() : Function<T,U>() {}
explicit Function1D(const uInt n) : Function<T,U>(n) {}
explicit Function1D(const Vector<T> &in) : Function<T,U>(in) {}
Function1D(const FunctionParam<T> &other) : Function<T,U>(other) {}
template <class W, class X>
Function1D(const Function1D<W,X> &other) : Function<T,U>(other) {}
// </group>
// Destructor
virtual ~Function1D() {}
// Returns the number of dimensions of function
virtual uInt ndim() const { return 1; }
//# Make members of parent classes known.
protected:
using Function<T,U>::param_p;
public:
using Function<T,U>::nparameters;
using Function<T,U>::setMode;
};
} //# NAMESPACE CASACORE - END
#endif
|
