casacore
BasicMath.h
Go to the documentation of this file.
1 //# BasicMath.h: Basic math related classes.
2 //# Copyright (C) 2005
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 
29 #ifndef CASA_BASICMATH_H
30 #define CASA_BASICMATH_H
31 
32 #include <casacore/casa/aips.h>
33 
34 #include <casacore/casa/BasicMath/ConvertScalar.h>
35 #include <casacore/casa/BasicMath/Functional.h>
36 #include <casacore/casa/BasicMath/Math.h>
37 #include <casacore/casa/BasicMath/Random.h>
38 #include <casacore/casa/BasicMath/Primes.h>
39 
40 namespace casacore { //# NAMESPACE CASACORE - BEGIN
41 
42 // <module>
43 //
44 // <summary> Classes and global functions for basic math use </summary>
45 
46 // <reviewed reviewer="" date="" demos="">
47 // </reviewed>
48 
49 // <synopsis>
50 //
51 // This module is a bag of related basic math classes and
52 // global functions.
53 //
54 // The following functionality is available:
55 // <ul>
56 // <li> Templated functors that can be used with <src>std::transform</src>
57 // to apply functions like sin, near, sqrt, etc. to iterators on
58 // sequences like Array, Block, std::vector, etc.
59 // <li> Templated functions <linkto group="ConvertScalar.h#Scalar conversion">
60 // ConvertScalar</linkto>
61 // to convert scalars from one type to another.
62 // <li> Class <linkto class=Functional:description>
63 // Functional</linkto>
64 // to map a domain object into a range object.
65 // <li> Functions <linkto group="Math.h#Math interface for casacore>
66 // Math</linkto>
67 // to interface to math.h and other scalar math functions.
68 // <li> Class <linkto class=Random:description>
69 // Random</linkto>
70 // to offer random number generators.
71 // <li> <linkto class="Primes">Prime</linkto> numbers
72 // </ul>
73 //
74 // <note role=tip> You may want to look at the individual header files
75 // to see whether you might not prefer to include only the header
76 // files you really need; it may be more efficient to do so.
77 // </note>
78 //
79 // </synopsis>
80 
81 //# <todo asof="2005/06/08">
82 //# <li>
83 //# </todo>
84 
85 // </module>
86 
87 
88 } //# NAMESPACE CASACORE - END
89 
90 #endif
91 
this file contains all the compiler specific defines
Definition: mainpage.dox:28