TVecLogic.h

Go to the documentation of this file.
00001 //# TVecLogic.h: Internal functions for table vector logical operations
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$
00027 
00028 #ifndef TABLES_TVECLOGIC_H
00029 #define TABLES_TVECLOGIC_H
00030 
00031 //# Includes
00032 #include <casacore/casa/aips.h>
00033 
00034 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00035 
00036 //# Forward Declarations
00037 template<class T> class TabVecRep;
00038 
00039 
00040 
00041 // <summary>
00042 // Comparison between two table vectors
00043 // </summary>
00044 
00045 // <use visibility=local>
00046 
00047 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
00048 // </reviewed>
00049 
00050 // <synopsis>
00051 // Element by element comparisons between two table vectors
00052 // or between a table vector and a scalar.
00053 // The result is true only if the comparison is true for every element
00054 // of the table vectors.
00055 // At some point operators will be available that return masks where the
00056 // comparison is true.
00057 // The left and right operands must be conformant (i.e. have equal length).
00058 // The functions are the implementation of the wrapper functions
00059 // defined in TabVecLogic.h.
00060 // </synopsis>
00061 
00062 // <group name=vectorComparison>
00063 template<class T>
00064     Bool tabVecReptvLE (const TabVecRep<T>& left, const TabVecRep<T>& right);
00065 template<class T>
00066     Bool tabVecReptvLT (const TabVecRep<T>& left, const TabVecRep<T>& right);
00067 template<class T>
00068     Bool tabVecReptvGE (const TabVecRep<T>& left, const TabVecRep<T>& right);
00069 template<class T>
00070     Bool tabVecReptvGT (const TabVecRep<T>& left, const TabVecRep<T>& right);
00071 template<class T>
00072     Bool tabVecReptvEQ (const TabVecRep<T>& left, const TabVecRep<T>& right);
00073 template<class T>
00074     Bool tabVecReptvNE (const TabVecRep<T>& left, const TabVecRep<T>& right);
00075 // </group>
00076 
00077 
00078 // <summary>
00079 // Comparison between a table vector and a scalar
00080 // </summary>
00081 
00082 // <use visibility=local>
00083 
00084 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
00085 // </reviewed>
00086 
00087 // <synopsis>
00088 // Element by element comparisons between a table vector and a scalar,
00089 // which behaves as if it were a conformant table vector filled with the
00090 // scalar value.
00091 // At some point operators will be available that return masks where the
00092 // comparison is true.
00093 // The functions are the implementation of the wrapper functions
00094 // defined in TabVecLogic.h.
00095 // </synopsis>
00096 
00097 // <group name=scalarComparison>
00098 template<class T>
00099     Bool tabVecRepvalrLE (const TabVecRep<T>& left, const T& right);
00100 template<class T>
00101     Bool tabVecRepvallLE (const T& left, const TabVecRep<T>& right);
00102 template<class T>
00103     Bool tabVecRepvalrLT (const TabVecRep<T>& left, const T& right);
00104 template<class T>
00105     Bool tabVecRepvallLT (const T& left, const TabVecRep<T>& right);
00106 template<class T>
00107     Bool tabVecRepvalrGE (const TabVecRep<T>& left, const T& right);
00108 template<class T>
00109     Bool tabVecRepvallGE (const T& left, const TabVecRep<T>& right);
00110 template<class T>
00111     Bool tabVecRepvalrGT (const TabVecRep<T>& left, const T& right);
00112 template<class T>
00113     Bool tabVecRepvallGT (const T& left, const TabVecRep<T>& right);
00114 template<class T>
00115     Bool tabVecRepvalrEQ (const TabVecRep<T>& left, const T& right);
00116 template<class T>
00117     Bool tabVecRepvallEQ (const T& left, const TabVecRep<T>& right);
00118 template<class T>
00119     Bool tabVecRepvalrNE (const TabVecRep<T>& left, const T& right);
00120 template<class T>
00121     Bool tabVecRepvallNE (const T& left, const TabVecRep<T>& right);
00122 // </group>
00123 
00124 
00125 
00126 } //# NAMESPACE CASACORE - END
00127 
00128 #ifndef CASACORE_NO_AUTO_TEMPLATES
00129 #include <casacore/tables/Tables/TVecLogic.tcc>
00130 #endif //# CASACORE_NO_AUTO_TEMPLATES
00131 #endif