casacore
LogiArray.h
Go to the documentation of this file.
1 //# LogiArray.h: Logical valued Arrays.
2 //# Copyright (C) 1994,1995,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 CASA_LOGIARRAY_2_H
29 #define CASA_LOGIARRAY_2_H
30 
31 #include "Array.h"
32 
33 namespace casacore { //# NAMESPACE CASACORE - BEGIN
34 
35 // <summary>
36 // Logical valued Arrays.
37 // </summary>
38 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
39 //
40 // <prerequisite>
41 // <li> <linkto class=Array>Array</linkto>
42 // </prerequisite>
43 //
44 // <etymology>
45 // LogicalArray declares logical valued Arrays.
46 // </etymology>
47 //
48 // <synopsis>
49 // This file contains the declarations for LogicalArrays.
50 // </synopsis>
51 //
52 // <motivation>
53 // One needs to have logical valued Arrays. They are the result of
54 // logical operations on Arrays. They can also be created in other ways.
55 // They are used as masks for MaskedArrays.
56 //
57 // Array<bool> would have served the purpose. However, it is very space
58 // inefficient. Instead, the concept has been abstracted. Currently,
59 // the implementation of LogicalArray is Array<LogicalArrayElem>, done
60 // with typedefs. The type of LogicalArrayElem can be changed at any time.
61 // Later, if desired, LogicalArray can be made to be a true class, without
62 // requiring more than a recompile of code which uses it.
63 // </motivation>
64 //
65 // <todo asof="$DATE:$>
66 // <li> Consider making these into classes.
67 // <li> Consider replacing with builtin boolean class when that
68 // makes it into the C++ compiler.
69 // </todo>
70 //
71 // <linkfrom anchor="LogicalArray" classes="Array Vector Matrix Cube MaskedArray">
72 // <here>LogicalArray</here> -- Logical valued Arrays.
73 // </linkfrom>
74 //
75 // <group name="LogicalArray">
76 
77 //# This is empty. Everything is done by the include files.
78 
79 // </group>
80 
81 
82 } //# NAMESPACE CASACORE - END
83 
84 #endif
this file contains all the compiler specific defines
Definition: mainpage.dox:28