File: AutoDiffMath.h

package info (click to toggle)
casacore 3.8.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,912 kB
  • sloc: cpp: 471,569; fortran: 16,372; ansic: 7,416; yacc: 4,714; lex: 2,346; sh: 1,865; python: 629; perl: 531; sed: 499; csh: 201; makefile: 32
file content (229 lines) | stat: -rw-r--r-- 9,281 bytes parent folder | download | duplicates (2)
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
//# AutoDiffMath.h: Implements all mathematical functions for AutoDiff.
//# Copyright (C) 1995,1999,2001,2002,2004
//# 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_AUTODIFFMATH_H
#define SCIMATH_AUTODIFFMATH_H

//# Includes

#include <casacore/casa/aips.h>
#include <casacore/casa/BasicMath/Math.h>
#include <casacore/scimath/Mathematics/AutoDiff.h>

namespace casacore { //# NAMESPACE CASACORE - BEGIN

// <summary>
// Implements all mathematical operators and functions for AutoDiff.
// </summary>
//
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tAutoDiff" demos="">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class=AutoDiff>AutoDiff</linkto> class
// </prerequisite>
//
// <etymology>
// Implements all mathematical operators and functions for AutoDiff.
// </etymology>
//
// <todo asof="20001/08/12">
//  <li> nothing I know of
// </todo>
 
// <group name="AutoDiff mathematical operations">

// Unary arithmetic operators.
// <group>
template<class T>
AutoDiff<T> operator+(const AutoDiff<T> &other);
template<class T>
AutoDiff<T> operator-(const AutoDiff<T> &other);
// </group>

// Arithmetic on two AutoDiff objects, returning an AutoDiff object
// <group>
template<class T> 
AutoDiff<T> operator+(const AutoDiff<T> &left, const AutoDiff<T> &right);
template<class T> 
AutoDiff<T> operator-(const AutoDiff<T> &left, const AutoDiff<T> &right);
template<class T> 
AutoDiff<T> operator*(const AutoDiff<T> &left, const AutoDiff<T> &right);
template<class T> 
AutoDiff<T> operator/(const AutoDiff<T> &left, const AutoDiff<T> &right);
// </group>

// Arithmetic on an AutoDiff and a scalar, returning an AutoDiff
// <group>
template<class T> 
AutoDiff<T> operator+(const AutoDiff<T> &left, const T &right);
template<class T> 
AutoDiff<T> operator-(const AutoDiff<T> &left, const T &right);
template<class T> 
AutoDiff<T> operator*(const AutoDiff<T> &left, const T &right);
template<class T> 
AutoDiff<T> operator/(const AutoDiff<T> &left, const T &right);
// </group>

// Arithmetic between a scalar and an AutoDiff returning an AutoDiff
// <group>
template<class T> 
AutoDiff<T> operator+(const T &left, const AutoDiff<T> &right);
template<class T> 
AutoDiff<T> operator-(const T &left, const AutoDiff<T> &right);
template<class T> 
AutoDiff<T> operator*(const T &left, const AutoDiff<T> &right);
template<class T> 
AutoDiff<T> operator/(const T &left, const AutoDiff<T> &right);
// </group>

// Transcendental functions
// <group>
template<class T> AutoDiff<T> acos(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> asin(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> atan(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> atan2(const AutoDiff<T> &y, 
				    const AutoDiff<T> &x);
template<class T> AutoDiff<T> cos(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> cosh(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> exp(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> log(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> log10(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> erf(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> erfc(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> pow(const AutoDiff<T> &a, 
				  const AutoDiff<T> &b);
template<class T> AutoDiff<T> pow(const AutoDiff<T> &a, const T &b);
template<class T> AutoDiff<T> square(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> cube(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> sin(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> sinh(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> sqrt(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> tan(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> tanh(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> abs(const AutoDiff<T> &ad);
// </group>
// Floating-point remainder of x/c, with the same sign as x, where c is
// a constant.
// <group>
template<class T> AutoDiff<T> fmod(const AutoDiff<T> &x, const T &c);
template<class T> AutoDiff<T> fmod(const AutoDiff<T> &x,
				   const AutoDiff<T> &c);
// </group>
// Floor and ceil of values
// <group>
template<class T> AutoDiff<T> floor(const AutoDiff<T> &ad);
template<class T> AutoDiff<T> ceil(const AutoDiff<T> &ad);
// </group>
 
// Comparison operators.  Only the values are compared: in the actual
// functions, comparisons are used to decide on algorithms. To check
// if two AutoDiff values are equal, use comparison for both 
// value and derivatives.
// <note role=tip> To check if two AutoDiff values are equal, use the
// member method <src>equals()</src> (e.g. for debugging and testing).
// </note>
// <group>
// Compare two AutoDiff's
template<class T> Bool operator>(const AutoDiff<T> &left,
				 const AutoDiff<T> &right);
template<class T> Bool operator<(const AutoDiff<T> &left,
				 const AutoDiff<T> &right);
template<class T> Bool operator>=(const AutoDiff<T> &left,
				  const AutoDiff<T> &right);
template<class T> Bool operator<=(const AutoDiff<T> &left,
				  const AutoDiff<T> &right);
template<class T> Bool operator==(const AutoDiff<T> &left,
				  const AutoDiff<T> &right);
template<class T> Bool operator!=(const AutoDiff<T> &left,
				  const AutoDiff<T> &right);
template<class T> Bool near(const AutoDiff<T> &left,
			    const AutoDiff<T> &right);
template<class T> Bool near(const AutoDiff<T> &left,
			    const AutoDiff<T> &right, const Double tol);
template<class T> Bool allnear(const AutoDiff<T> &left,
			       const AutoDiff<T> &right, const Double tol);
template<class T> Bool nearAbs(const AutoDiff<T> &left,
			       const AutoDiff<T> &right, const Double tol);
template<class T> Bool allnearAbs(const AutoDiff<T> &left,
				  const AutoDiff<T> &right, const Double tol);
// </group>
// Compare an AutoDiff and a constant
// <group>
template<class T> Bool operator>(const AutoDiff<T> &left, const T &right);
template<class T> Bool operator<(const AutoDiff<T> &left, const T &right);
template<class T> Bool operator>=(const AutoDiff<T> &left, const T &right);
template<class T> Bool operator<=(const AutoDiff<T> &left, const T &right);
template<class T> Bool operator==(const AutoDiff<T> &left, const T &right);
template<class T> Bool operator!=(const AutoDiff<T> &left, const T &right);
template<class T> Bool near(const AutoDiff<T> &left, const T &right);
template<class T> Bool near(const AutoDiff<T> &left, const T &right,
			    const Double tol);
template<class T> Bool allnear(const AutoDiff<T> &left, const T &right,
			       const Double tol);
template<class T> Bool nearAbs(const AutoDiff<T> &left, const T &right,
			       const Double tol);
template<class T> Bool allnearAbs(const AutoDiff<T> &left, const T &right,
				  const Double tol);
// </group>
// Compare a constant and an AutoDiff
// <group>
template<class T> Bool operator>(const T &left, const AutoDiff<T> &right);
template<class T> Bool operator<(const T &left, const AutoDiff<T> &right);
template<class T> Bool operator>=(const T &left, const AutoDiff<T> &right);
template<class T> Bool operator<=(const T &left, const AutoDiff<T> &right);
template<class T> Bool operator==(const T &left, const AutoDiff<T> &right);
template<class T> Bool operator!=(const T &left, const AutoDiff<T> &right);
template<class T> Bool near(const T &left, const AutoDiff<T> &right,
			    const Double tol);
template<class T> Bool allnear(const T &left, const AutoDiff<T> &right,
			       const Double tol);
template<class T> Bool nearAbs(const T &left, const AutoDiff<T> &right,
			       const Double tol);
template<class T> Bool allnearAbs(const T &left, const AutoDiff<T> &right,
				  const Double tol);
// </group>
// Test special values
// <group>
template<class T> Bool isNaN(const AutoDiff<T> &val);
template<class T> Bool isInf(AutoDiff<T> &val);
// </group>
// Minimum/maximum
// <group>
template<class T> AutoDiff<T> min(const AutoDiff<T> &left,
				  const AutoDiff<T> &right);
template<class T> AutoDiff<T> max(const AutoDiff<T> &left,
				  const AutoDiff<T> &right);
// </group>

// </group>


} //# NAMESPACE CASACORE - END

#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/scimath/Mathematics/AutoDiffMath.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif