/usr/include/casacore/casa/BasicSL/Complex.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 | //# Complex.h: Single and double precision complex numbers
//# Copyright (C) 2000,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: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef CASA_COMPLEX_H
#define CASA_COMPLEX_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicSL/Complexfwd.h>
#include <casacore/casa/complex.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Single and double precision complex numbers
// </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <synopsis>
// The class <src>Complex</src> is a straight typedef as the
// standard library <src>complex<float></src>.
//
// In a similar way <src>DComplex</src> is typedef-ed as
// <src>complex<double></src>.
//
// <linkto class=IComplex>IComplex</linkto> is defined as a specific class.
// It is only used by the <src>FITS</src> classes.
//
// <src>lDComplex</src> has not been defined: <src>long double</src> is not
// part of the standard Casacore data suite (yet)
//
// A set of global functions are added for historic reasons (they were present
// in the original Casacore/gcc complex implementation).
//
// See the standard library documentation for the expected behaviour of
// the <src>Complex</src> and <src>DComplex</src> classes.
//
// <note role=tip> In the following all references to <src>Complex</src>
// can be replaced with <src>DComplex</src>. with simultaneous
// replacement of <src>Float</src> with <src>Double</src>. </note>
//
// Complex numbers may be constructed and used in the following ways:
// <dl>
// <dt>Complex x;</dt>
// <dd> Declares an uninitialized Complex. </dd>
//
// <dt>Complex x = 2; Complex y(2.0);</dt>
// <dd> Set x and y to the Complex value (2.0, 0.0); </dd>
//
// <dt>Complex x(2, 3);</dt>
// <dd> Sets x to the Complex value (2, 3); </dd>
//
// <dt>Complex u(x); Complex v = x;</dt>
// <dd> Set u and v to the same value as x. </dd>
//
// <dt>Float real(Complex& x);</dt>
// <dd> returns the real part of x. </dd>
//
// <dt>Float imag(Complex& x);</dt>
// <dd> returns the imaginary part of x. </dd>
//
// <dt>Float abs(Complex& x);</dt>
// <dd> returns the magnitude of x. </dd>
//
// <dt>Float norm(Complex& x);</dt>
// <dd> returns the square of the magnitude of x. </dd>
//
// <dt>Float arg(Complex& x);</dt>
// <dd> returns the argument (amplitude) of x. </dd>
//
// <dt>Complex polar(Float r, Float t = 0.0);</dt>
// <dd> returns a Complex with abs of r and arg of t. </dd>
//
// <dt>Complex conj(Complex& x);</dt>
// <dd> returns the complex conjugate of x </dd>
//
// <dt>Complex cos(Complex& x);</dt>
// <dd> returns the complex cosine of x. </dd>
//
// <dt>Complex sin(Complex& x);</dt>
// <dd> returns the complex sine of x. </dd>
//
// <dt>Complex cosh(Complex& x);</dt>
// <dd> returns the complex hyperbolic cosine of x. </dd>
//
// <dt>Complex sinh(Complex& x);</dt>
// <dd> returns the complex hyperbolic sine of x. </dd>
//
// <dt>Complex exp(Complex& x);</dt>
// <dd> returns the exponential of x. </dd>
//
// <dt>Complex log(Complex& x);</dt>
// <dd> returns the natural log of x. </dd>
//
// <dt>Complex pow(Complex& x, long p);</dt>
// <dd> returns x raised to the p power. </dd>
//
// <dt>Complex pow(Complex& x, Complex& p);</dt>
// <dd> returns x raised to the p power. </dd>
//
// <dt>Complex sqrt(Complex& x);</dt>
// <dd> returns the square root of x. </dd>
//
// <dt> Complex min(Complex x,Complex y);
// <dd> Returns the minumum of x,y (using operator<=, i.e. the norm).
//
// <dt> Complex max(Complex x,Complex y);
// <dd> Returns the maximum of x,y (using operator>=, i.e. the norm).
//
// <dt>Bool near(Complex val1, Complex val2, Double tol = 1.0e-5);</dt>
// <dd> returns whether val1 is relatively near val2 (see Math.h).
// (Note the Double tolerance) </dd>
//
// <dt>Bool nearAbs(Complex val1, Complex val2, Double tol = 1.0e-5);</dt>
// <dd> returns whether val1 is absolutely near val2 (see Math.h).
// (Note the Double tolerance) </dd>
//
// <dt>ostream << x;</dt>
// <dd> prints x in the form (re, im). </dd>
//
// <dt>istream >> x;</dt>
// <dd> reads x in the form (re, im), or just (re) or re in which case the
// imaginary part is set to zero. </dd>
// </dl>
// </synopsis>
//# <todo asof="2000/11/27">
//# </todo>
// <group name="Complex_desc">
// <summary>Complex NaN and Infinity</summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name="Complex NaN and Infinity">
Bool isNaN (const Complex& val);
void setNaN(Complex& val);
Bool isInf (const Complex& val);
void setInf(Complex& val);
Bool isFinite(const Complex& val);
// </group>
// <summary>Complex comparisons </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name="Complex comparisons">
//# On Linux comparing the norm does not work well in debug mode
//# for equal values. Therefore they are compared for equality first.
inline Bool operator>= (const Complex& left, const Complex& right)
{ return left==right ? True : norm(left) >= norm(right); }
inline Bool operator> (const Complex& left, const Complex& right)
{ return left==right ? False : norm(left) > norm(right); }
inline Bool operator<= (const Complex& left, const Complex& right)
{ return left==right ? True : norm(left) <= norm(right); }
inline Bool operator< (const Complex& left, const Complex& right)
{ return left==right ? False : norm(left) < norm(right); }
// </group>
// <summary>DComplex NaN and Infinity</summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name="DComplex NaN and Infinity">
Bool isNaN (const DComplex& val);
void setNaN(DComplex& val);
Bool isInf (const DComplex& val);
void setInf(DComplex& val);
Bool isFinite(const DComplex& val);
// </group>
// <summary> DComplex comparisons </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name="DComplex comparisons">
inline Bool operator>= (const DComplex& left, const DComplex& right)
{ return norm(left) >= norm(right); }
inline Bool operator> (const DComplex& left, const DComplex& right)
{ return norm(left) > norm(right); }
inline Bool operator<= (const DComplex& left, const DComplex& right)
{ return norm(left) <= norm(right); }
inline Bool operator< (const DComplex& left, const DComplex& right)
{ return norm(left) < norm(right); }
// </group>
//# Global functions
// <summary> Additional complex mathematical functions </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name=math>
inline Double fabs(const DComplex &val) { return std::abs(val); }
inline Float fabs(const Complex &val) { return std::abs(val); }
inline DComplex square(const DComplex &val) { return val*val; }
inline Complex square(const Complex &val) { return val*val; }
inline DComplex cube(const DComplex &val) { return val*val*val; }
inline Complex cube(const Complex &val) { return val*val*val; }
// The log10 should be in stl
// <group>
#if defined(NEEDS_LOG10_COMPLEX)
Complex log10(const Complex &val);
DComplex log10(const DComplex &val);
#endif
// </group>
// ArrayMath::pow needs this pow function (on SGI).
inline Complex pow(const Complex& val, Double p) { return std::pow(val,Float(p)); }
// We have to explicitly implement these for different type operands
inline DComplex operator+(const DComplex& d, const Complex& c) {
return (DComplex)c + d;
}
inline DComplex operator+(const Complex& c, const DComplex& d) {
return (DComplex)c + d;
}
inline DComplex operator-(const DComplex& d, const Complex& c) {
return d - (DComplex)c;
}
inline DComplex operator-(const Complex& c, const DComplex& d) {
return (DComplex)c - d;
}
// QMath and scimath need these operators * and /
// <group>
inline Complex operator*(const Complex& val, Double f) { return val*Float(f); }
inline Complex operator*(Double f, const Complex& val) { return val*Float(f); }
inline Complex operator/(const Complex& val, Double f) { return val/Float(f); }
inline Complex operator/(Double f, const Complex& val) { return Float(f)/val; }
// </group>
// These operators are useful, otherwise both Float and Double are applicable
// for Ints.
// <group>
inline Complex operator*(const Complex& val, Int f) { return val*Float(f); }
inline Complex operator*(Int f, const Complex& val) { return val*Float(f); }
inline Complex operator/(const Complex& val, Int f) { return val/Float(f); }
inline Complex operator/(Int f, const Complex& val) { return Float(f)/val; }
// </group>
// </group>
// <summary> The near functions </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name=near>
Bool near(const Complex &val1, const Complex &val2, Double tol=1.0e-5);
Bool near(const DComplex &val1, const DComplex &val2, Double tol=1.0e-13);
Bool nearAbs(const Complex &val1, const Complex &val2, Double tol=1.0e-5);
Bool nearAbs(const DComplex &val1, const DComplex &val2, Double tol=1.0e-13);
inline Bool allNear(const Complex &val1, const Complex &val2,
Double tol=1.0e-5)
{ return near(val1, val2, tol); }
inline Bool allNear(const DComplex &val1, const DComplex &val2,
Double tol=1.0e-13)
{ return near(val1, val2, tol); }
inline Bool allNearAbs(const Complex &val1, const Complex &val2,
Double tol=1.0e-5)
{ return nearAbs(val1, val2, tol); }
inline Bool allNearAbs(const DComplex &val1, const DComplex &val2,
Double tol=1.0e-13)
{ return nearAbs(val1, val2, tol); }
// </group>
// <summary> Max and min, floor and ceil functions </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name=maxmin>
inline Complex max(const Complex &x, const Complex &y)
{ return x >= y ? x : y; }
inline DComplex max(const DComplex &x, const DComplex &y)
{ return x >= y ? x : y; }
inline Complex min(const Complex &x, const Complex &y)
{ return x <= y ? x : y; }
inline DComplex min(const DComplex &x, const DComplex &y)
{ return x <= y ? x : y; }
inline Complex floor(const Complex &x) {
return Complex(std::floor(x.real()), std::floor(x.imag())); }
inline DComplex floor(const DComplex &x) {
return DComplex(std::floor(x.real()), std::floor(x.imag())); }
inline Complex ceil(const Complex &x) {
return Complex(std::ceil(x.real()), std::ceil(x.imag())); }
inline DComplex ceil(const DComplex &x) {
return DComplex(std::ceil(x.real()), std::ceil(x.imag())); }
// </group>
// <summary> fmod </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name=fmod>
DComplex fmod(const DComplex &in, const DComplex &f);
Complex fmod(const Complex &in, const Complex &f);
// </group>
// <summary> Inverse trigonometry </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name=inverse>
// atan not valid for z == -1
DComplex atan(const DComplex &in);
Complex atan(const Complex &in);
DComplex asin(const DComplex &in);
Complex asin(const Complex &in);
DComplex acos(const DComplex &in);
Complex acos(const Complex &in);
DComplex atan2(const DComplex &in, const DComplex &t2);
Complex atan2(const Complex &in, const Complex &t2);
// </group>
// <summary> Error function </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
// <group name=erf>
// Preliminary to get Functionals working. erf(z) will return erf(real(z))
// only for now.
DComplex erf(const DComplex &in);
Complex erf(const Complex &in);
DComplex erfc(const DComplex &in);
Complex erfc(const Complex &in);
// </group>
// </group>
} //# NAMESPACE CASACORE - END
// Define real & complex conjugation for non-complex types
// and put comparisons into std namespace.
// The new C++11 standard library already defines real and imag.
namespace std {
inline float conj(float x) { return x; }
inline double conj(double x) { return x; }
#if !(defined(AIPS_CXX11) || (defined(__APPLE_CC__) && __APPLE_CC__ > 5621))
inline float real(float x) { return x; }
inline double real(double x) { return x; }
inline float imag(float ) { return 0; }
inline double imag(double ) { return 0; }
#endif
using casacore::operator>;
using casacore::operator>=;
using casacore::operator<;
using casacore::operator<=;
}
#endif
|