casacore
TVecLogic.h
Go to the documentation of this file.
1 //# TVecLogic.h: Internal functions for table vector logical operations
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 TABLES_TVECLOGIC_H
29 #define TABLES_TVECLOGIC_H
30 
31 //# Includes
32 #include <casacore/casa/aips.h>
33 
34 namespace casacore { //# NAMESPACE CASACORE - BEGIN
35 
36 //# Forward Declarations
37 template<class T> class TabVecRep;
38 
39 
40 
41 // <summary>
42 // Comparison between two table vectors
43 // </summary>
44 
45 // <use visibility=local>
46 
47 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
48 // </reviewed>
49 
50 // <synopsis>
51 // Element by element comparisons between two table vectors
52 // or between a table vector and a scalar.
53 // The result is true only if the comparison is true for every element
54 // of the table vectors.
55 // At some point operators will be available that return masks where the
56 // comparison is true.
57 // The left and right operands must be conformant (i.e. have equal length).
58 // The functions are the implementation of the wrapper functions
59 // defined in TabVecLogic.h.
60 // </synopsis>
61 
62 // <group name=vectorComparison>
63 template<class T>
64  Bool tabVecReptvLE (const TabVecRep<T>& left, const TabVecRep<T>& right);
65 template<class T>
66  Bool tabVecReptvLT (const TabVecRep<T>& left, const TabVecRep<T>& right);
67 template<class T>
68  Bool tabVecReptvGE (const TabVecRep<T>& left, const TabVecRep<T>& right);
69 template<class T>
70  Bool tabVecReptvGT (const TabVecRep<T>& left, const TabVecRep<T>& right);
71 template<class T>
72  Bool tabVecReptvEQ (const TabVecRep<T>& left, const TabVecRep<T>& right);
73 template<class T>
74  Bool tabVecReptvNE (const TabVecRep<T>& left, const TabVecRep<T>& right);
75 // </group>
76 
77 
78 // <summary>
79 // Comparison between a table vector and a scalar
80 // </summary>
81 
82 // <use visibility=local>
83 
84 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="">
85 // </reviewed>
86 
87 // <synopsis>
88 // Element by element comparisons between a table vector and a scalar,
89 // which behaves as if it were a conformant table vector filled with the
90 // scalar value.
91 // At some point operators will be available that return masks where the
92 // comparison is true.
93 // The functions are the implementation of the wrapper functions
94 // defined in TabVecLogic.h.
95 // </synopsis>
96 
97 // <group name=scalarComparison>
98 template<class T>
99  Bool tabVecRepvalrLE (const TabVecRep<T>& left, const T& right);
100 template<class T>
101  Bool tabVecRepvallLE (const T& left, const TabVecRep<T>& right);
102 template<class T>
103  Bool tabVecRepvalrLT (const TabVecRep<T>& left, const T& right);
104 template<class T>
105  Bool tabVecRepvallLT (const T& left, const TabVecRep<T>& right);
106 template<class T>
107  Bool tabVecRepvalrGE (const TabVecRep<T>& left, const T& right);
108 template<class T>
109  Bool tabVecRepvallGE (const T& left, const TabVecRep<T>& right);
110 template<class T>
111  Bool tabVecRepvalrGT (const TabVecRep<T>& left, const T& right);
112 template<class T>
113  Bool tabVecRepvallGT (const T& left, const TabVecRep<T>& right);
114 template<class T>
115  Bool tabVecRepvalrEQ (const TabVecRep<T>& left, const T& right);
116 template<class T>
117  Bool tabVecRepvallEQ (const T& left, const TabVecRep<T>& right);
118 template<class T>
119  Bool tabVecRepvalrNE (const TabVecRep<T>& left, const T& right);
120 template<class T>
121  Bool tabVecRepvallNE (const T& left, const TabVecRep<T>& right);
122 // </group>
123 
124 
125 
126 } //# NAMESPACE CASACORE - END
127 
128 #ifndef CASACORE_NO_AUTO_TEMPLATES
129 #include <casacore/tables/Tables/TVecLogic.tcc>
130 #endif //# CASACORE_NO_AUTO_TEMPLATES
131 #endif
Templated base class for table vectors.
Definition: TVec.h:108
this file contains all the compiler specific defines
Definition: mainpage.dox:28
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42