casacore
Mathematics.h
Go to the documentation of this file.
1 //# Mathematics.h: Module header for Mathematical operations
2 //# Copyright (C) 1995,1996,1997,1998,1999
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_MATHEMATICS_H
29 #define SCIMATH_MATHEMATICS_H
30 
31 #include <casacore/casa/aips.h>
32 #include <casacore/casa/BasicSL/Complex.h>
33 #include <casacore/casa/BasicSL/Constants.h>
34 #include <casacore/scimath/Mathematics/Convolver.h>
35 #include <casacore/scimath/Mathematics/FFTServer.h>
36 #include <casacore/casa/BasicMath/Math.h>
37 #include <casacore/scimath/Mathematics/NumericTraits.h>
38 #include <casacore/casa/BasicMath/Random.h>
39 
40 namespace casacore { //# NAMESPACE CASACORE - BEGIN
41 
42 // <module>
43 
44 // <summary> Mathematical types, constants, operations </summary>
45 
46 // <prerequisite>
47 // <li> At least high school (and preferably undergraduate
48 // level) understanding of mathematics.
49 // </prerequisite>
50 
51 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" demos="">
52 // </reviewed>
53 
54 // <etymology>
55 // Mathematicians may argue that everything is mathematics, and hence all of
56 // Casacore should be in this module. However this module will only contain
57 // core mathematical operations that are independent of astronomical
58 // applications.
59 // </etymology>
60 
61 // <synopsis>
62 
63 // The Mathematics module has a variety of mathematical classes and functions.
64 // Not all numerical operations are found herein. Very complicated operations
65 // might be in their own module. such as deconvolution.
66 // Many whole array operations
67 // are in the <linkto file="ArrayMath.h">ArrayMath</linkto> global functions
68 // (part of the <linkto module="Arrays">Arrays</linkto> module). Mathematical
69 // operations on Lattices are found in the <linkto
70 // module="Lattices">Lattices</linkto> module. A wide variety of special
71 // Mathematical functions is planned for the <linkto
72 // module="Functionals">Functionals</linkto> module.
73 //
74 // The classes presently in this module fall into the following categories:
75 // <ul>
76 // <li> A wrapper around the system math.h functions called
77 // <linkto file="Math.h">Math.h</linkto>. This contains generic
78 // mathematical functions. It is required that you always include this
79 // file rather than the system math.h file as deficiencies in the system
80 // math.h file will be implemented here.
81 // <li> <linkto file=NumericTraits.h>Relationships</linkto>
82 // between different numerical data types.
83 // <li> Multi-dimensional Fourier transforms are done in the
84 // <linkto class="FFTServer">FFTServer</linkto> class. This decomposes
85 // the transforms into a one-dimensional transforms.
86 // <li> Numerical <linkto class="Convolver">Convolution</linkto>
87 // (both linear and circular) of multi-dimensional Arrays.
88 // <li> <linkto file="Random.h">Random</linkto> numbers in a wide
89 // variety of distributions.
90 // <li> Interpolation in one dimension is performed by the
91 // <linkto class="Interpolate1D">Interpolate1D</linkto> class in
92 // the <linkto module="Functionals">Functionals</linkto> module
93 // </ul>
94 // </synopsis>
95 
96 // </module>
97 
98 
99 } //# NAMESPACE CASACORE - END
100 
101 #endif
this file contains all the compiler specific defines
Definition: mainpage.dox:28