casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
LogiArray.h
Go to the documentation of this file.
00001 //# LogiArray.h:  Logical valued Arrays.
00002 //# Copyright (C) 1994,1995,1999
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //# $Id: LogiArray.h 20551 2009-03-25 00:11:33Z Malte.Marquarding $
00027 
00028 #ifndef CASA_LOGIARRAY_H
00029 #define CASA_LOGIARRAY_H
00030 
00031 
00032 #include <casa/aips.h>
00033 #include <casa/Arrays/LogiArrayFwd.h>
00034 #include <casa/Arrays/Array.h>
00035 
00036 
00037 namespace casa { //# NAMESPACE CASA - BEGIN
00038 
00039 // <summary>
00040 //    Logical valued Arrays.
00041 // </summary>
00042 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
00043 //
00044 // <prerequisite>
00045 //   <li> <linkto class=Array>Array</linkto>
00046 //   <li> <linkto group="LogiArrayFwd.h#LogicalArray forwards">LogicalArrayFwd</linkto>
00047 // </prerequisite>
00048 //
00049 // <etymology>
00050 // LogicalArray declares logical valued Arrays.
00051 // </etymology>
00052 //
00053 // <synopsis>
00054 // This file contains the declarations for LogicalArrays.
00055 // </synopsis>
00056 //
00057 // <motivation>
00058 // One needs to have logical valued Arrays.  They are the result of
00059 // logical operations on Arrays.  They can also be created in other ways.
00060 // They are used as masks for MaskedArrays.
00061 //
00062 // Array<Bool> would have served the purpose.  However, it is very space
00063 // inefficient.  Instead, the concept has been abstracted.  Currently,
00064 // the implementation of LogicalArray is Array<LogicalArrayElem>, done
00065 // with typedefs.  The type of LogicalArrayElem can be changed at any time.
00066 // Later, if desired, LogicalArray can be made to be a true class, without
00067 // requiring more than a recompile of code which uses it.
00068 // </motivation>
00069 //
00070 // <todo asof="$DATE:$>
00071 //   <li> Consider making these into classes.
00072 //   <li> Consider replacing with builtin boolean class when that
00073 //          makes it into the C++ compiler.
00074 // </todo>
00075 //
00076 // <linkfrom anchor="LogicalArray" classes="Array Vector Matrix Cube MaskedArray">
00077 //    <here>LogicalArray</here> -- Logical valued Arrays.
00078 // </linkfrom>
00079 //
00080 // <group name="LogicalArray">
00081 
00082 //# This is empty.  Everything is done by the include files.
00083 
00084 // </group>
00085 
00086 
00087 } //# NAMESPACE CASA - END
00088 
00089 #endif