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