/usr/include/casacore/casa/Arrays/ArrayLogical.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 | //# ArrayLogical.h: Element by element logical operations on arrays.
//# Copyright (C) 1993,1994,1995,1999,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//# $Id$
#ifndef CASA_ARRAYLOGICAL_H
#define CASA_ARRAYLOGICAL_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Array.h>
#include <casacore/casa/Arrays/LogiArray.h>
#include <casacore/casa/Arrays/ArrayMathBase.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
template <class T> class Vector;
template <class T> class Matrix;
template <class T> class Cube;
// <summary>
// Logical operations for Arrays.
// </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tArrayLogical">
//
// <prerequisite>
// <li> <linkto class=Array>Array</linkto>
// </prerequisite>
//
// <etymology>
// This file contains global functions which perform element by element logical
// operations on arrays.
// </etymology>
//
// <synopsis>
// These functions perform element by element logical operations on
// arrays. The two arrays must conform, except for allEQ which returns
// False if the arrays do not conform.
//
// There are two classes of functions. One class returns a LogicalArray.
// In these functions, the value of an element of the LogicalArray is
// the value of the logical operation applied to the corresponding elements
// of the input Arrays. The other class of functions returns a single
// Bool. The return value is True if the logical operation returns True for
// all elements of the input arrays for the "all" functions
// (e.g. allLE()), and returns True if the logical operation returns True for
// any elements of the input arrays for the "any" functions
// (e.g. anyLE()).
//
// For instance allLE (a, b) implies that every element of a is
// less than or equal to every element of b. Note that with this definition
// allLE (a, b) and allGE (a, b) can both be false (e.g. a = [1,0] b = [0,1]).
//
// <note role=caution> Comparison between two zero-sized arrays is not defined
// (should it throw an exception?).
// </note>
//
// </synopsis>
//
// <example>
// <srcblock>
// Vector<Int> a(10);
// Vector<Int> b(10);
// LogicalVector l(10);
// . . .
// l = a < b;
// </srcblock>
// This example sets the elements of l (a<b).
// The result of the comparison is a LogicalArray.
// </example>
//
// <example>
// <srcblock>
// Vector<Int> a(10);
// Vector<Int> b(10);
// Bool result;
// . . .
// result = allLT (a, b);
// </srcblock>
// This example sets result to True if, for all elements, a<b.
// </example>
//
// <motivation>
// One wants to be able to perform logical operations on arrays.
// </motivation>
//
// <todo asof="$DATE:$>
// <li> Reconsider where the origin of the returned LogicalArray should
// be located.
// </todo>
//
// <linkfrom anchor="Array logical operations" classes="Array Vector Matrix Cube">
// <here>Array logical operations</here> -- Logical operations for Arrays.
// </linkfrom>
//
// <group name="Array logical operations">
// Determine if the comparisons between corresponding array elements yield True.
// <group>
template<typename T, typename CompareOperator>
bool arrayCompareAll (const Array<T>& left, const Array<T>& right,
CompareOperator op);
template<typename T, typename CompareOperator>
bool arrayCompareAll (const Array<T>& left, T right,
CompareOperator op);
template<typename T, typename CompareOperator>
bool arrayCompareAll (T left, const Array<T>& right,
CompareOperator op);
// </group>
// Determine if the comparisons between corresponding array elements yield True.
// <group>
template<typename T, typename CompareOperator>
bool arrayCompareAny (const Array<T>& left, const Array<T>& right,
CompareOperator op);
template<typename T, typename CompareOperator>
bool arrayCompareAny (const Array<T>& left, T right,
CompareOperator op);
template<typename T, typename CompareOperator>
bool arrayCompareAny (T left, const Array<T>& right,
CompareOperator op);
// </group>
//
// Element by element comparisons between the "l" and "r" arrays. The result
// is true only if the comparison is true for every element of the arrays.
//
// The operator forms of array logical operations which return a single Bool
// have been replaced by these "all" functions.
// The operator forms of array logical operations now return a LogicalArray.
//
// The arrays must conform except for allEQ, which will return False if the
// arrays have different shapes.
//
// <thrown>
// <li> ArrayConformanceError
// </thrown>
//
// <group>
template<class T> Bool allLE (const Array<T> &l, const Array<T> &r);
template<class T> Bool allLT (const Array<T> &l, const Array<T> &r);
template<class T> Bool allGE (const Array<T> &l, const Array<T> &r);
template<class T> Bool allGT (const Array<T> &l, const Array<T> &r);
template<class T> Bool allEQ (const Array<T> &l, const Array<T> &r);
template<class T> Bool allNE (const Array<T> &l, const Array<T> &r);
template<class T> Bool allNear (const Array<T> &l, const Array<T> &r,
Double tol);
template<class T> Bool allNearAbs (const Array<T> &l, const Array<T> &r,
Double tol);
//
// This only makes sense if the array element type is logical valued.
// <group>
template<class T> Bool allAND (const Array<T> &l, const Array<T> &r);
template<class T> Bool allOR (const Array<T> &l, const Array<T> &r);
// </group>
//
// </group>
//
// Element by element comparisons between the "l" and "r" arrays. The result
// is a LogicalArray.
// The arrays must conform or an exception is thrown.
//
// The Vector, Matrix and Cube version are present to bypass the problems
// due to the existence of automatic comparison inline templates in standard
// algorithm library, producing a single Bool value.
//
// <group>
template<class T> LogicalArray operator <= (const Array<T> &l,
const Array<T> &r);
template<class T> LogicalArray operator < (const Array<T> &l,
const Array<T> &r);
template<class T> LogicalArray operator >= (const Array<T> &l,
const Array<T> &r);
template<class T> LogicalArray operator > (const Array<T> &l,
const Array<T> &r);
template<class T> LogicalArray operator == (const Array<T> &l,
const Array<T> &r);
template<class T> LogicalArray operator != (const Array<T> &l,
const Array<T> &r);
template<class T> LogicalArray near(const Array<T> &l, const Array<T> &r,
Double tol);
template<class T> LogicalArray nearAbs(const Array<T> &l, const Array<T> &r,
Double tol);
//
// This only makes sense if the array element type is logical valued.
// <group>
template<class T> LogicalArray operator && (const Array<T> &l, const Array<T> &r);
template<class T> LogicalArray operator || (const Array<T> &l, const Array<T> &r);
// </group>
//
// </group>
//
// Logical negation of an array. This only makes sense if the array
// element type is logical valued.
template<class T> LogicalArray operator ! (const Array<T> &l);
//
// Element by element comparisons between an array and a scalar, which
// behaves as if it were a conformant array filled with the value "val."
// The result is true only if the comparison is true for every element
// of the array.
// <group>
template<class T> Bool allLE (const Array<T> &array, const T &val);
template<class T> Bool allLE (const T &val, const Array<T> &array);
template<class T> Bool allLT (const Array<T> &array, const T &val);
template<class T> Bool allLT (const T &val, const Array<T> &array);
template<class T> Bool allGE (const Array<T> &array, const T &val);
template<class T> Bool allGE (const T &val, const Array<T> &array);
template<class T> Bool allGT (const Array<T> &array, const T &val);
template<class T> Bool allGT (const T &val, const Array<T> &array);
template<class T> Bool allEQ (const Array<T> &array, const T &val);
template<class T> Bool allEQ (const T &val, const Array<T> &array);
template<class T> Bool allNE (const Array<T> &array, const T &val);
template<class T> Bool allNE (const T &val, const Array<T> &array);
template<class T> Bool allNear (const Array<T> &array, const T &val, Double tol);
template<class T> Bool allNear (const T &val, const Array<T> &array, Double tol);
template<class T> Bool allNearAbs (const Array<T> &array, const T &val,
Double tol);
template<class T> Bool allNearAbs (const T &val, const Array<T> &array,
Double tol);
//
// This only makes sense if the array element type is logical valued.
// <group>
template<class T> Bool allAND (const Array<T> &array, const T &val);
template<class T> Bool allAND (const T &val, const Array<T> &array);
template<class T> Bool allOR (const Array<T> &array, const T &val);
template<class T> Bool allOR (const T &val, const Array<T> &array);
// </group>
//
// </group>
// Test if all elements in an array are the same.
template<class T> Bool allSame (const Array<T> &a)
{ return a.size() <= 1 || allEQ(*a.data(), a); }
// Element by element test for NaN or (In)finity.
// <group>
template<class T> LogicalArray isNaN (const Array<T> &array);
template<class T> LogicalArray isInf (const Array<T> &array);
template<class T> LogicalArray isFinite (const Array<T> &array);
// </group>
//
// Element by element comparisons between an array and a scalar, which
// behaves as if it were a conformant array filled with the value "val."
// The result is a LogicalArray.
//
// <thrown>
// <li> ArrayConformanceError
// </thrown>
//
// <group>
template<class T> LogicalArray operator <= (const Array<T> &array, const T &val);
template<class T> LogicalArray operator <= (const T &val, const Array<T> &array);
template<class T> LogicalArray operator < (const Array<T> &array, const T &val);
template<class T> LogicalArray operator < (const T &val, const Array<T> &array);
template<class T> LogicalArray operator >= (const Array<T> &array, const T &val);
template<class T> LogicalArray operator >= (const T &val, const Array<T> &array);
template<class T> LogicalArray operator > (const Array<T> &array, const T &val);
template<class T> LogicalArray operator > (const T &val, const Array<T> &array);
template<class T> LogicalArray operator == (const Array<T> &array, const T &val);
template<class T> LogicalArray operator == (const T &val, const Array<T> &array);
template<class T> LogicalArray operator != (const Array<T> &array, const T &val);
template<class T> LogicalArray operator != (const T &val, const Array<T> &array);
template<class T> LogicalArray near (const Array<T> &array, const T &val,
Double tol);
template<class T> LogicalArray near (const T &val, const Array<T> &array,
Double tol);
template<class T> LogicalArray nearAbs (const Array<T> &array, const T &val,
Double tol);
template<class T> LogicalArray nearAbs (const T &val, const Array<T> &array,
Double tol);
//
// This only makes sense if the array element type is logical valued.
// <group>
template<class T> LogicalArray operator && (const Array<T> &array, const T &val);
template<class T> LogicalArray operator && (const T &val, const Array<T> &array);
template<class T> LogicalArray operator || (const Array<T> &array, const T &val);
template<class T> LogicalArray operator || (const T &val, const Array<T> &array);
// </group>
//
// </group>
//# With two arrays, they must both conform, and the result is done element
//# by element. For instance anyLE (a, b) implies that some element of a is
//# less than or equal to the corresponding element of b.
//# NB comparison between two zero-sized arrays is not defined (should it
//# throw an exception?).
//
// Element by element comparisons between the "l" and "r" arrays. The result
// is true if the comparison is true for some element of the arrays.
//
// <thrown>
// <li> ArrayConformanceError
// </thrown>
//
// <group>
template<class T> Bool anyLE (const Array<T> &l, const Array<T> &r);
template<class T> Bool anyLT (const Array<T> &l, const Array<T> &r);
template<class T> Bool anyGE (const Array<T> &l, const Array<T> &r);
template<class T> Bool anyGT (const Array<T> &l, const Array<T> &r);
template<class T> Bool anyEQ (const Array<T> &l, const Array<T> &r);
template<class T> Bool anyNE (const Array<T> &l, const Array<T> &r);
template<class T> Bool anyNear (const Array<T> &l, const Array<T> &r,
Double tol);
template<class T> Bool anyNearAbs (const Array<T> &l, const Array<T> &r,
Double tol);
//
// This only makes sense if the array element type is logical valued.
// <group>
template<class T> Bool anyAND (const Array<T> &l, const Array<T> &r);
template<class T> Bool anyOR (const Array<T> &l, const Array<T> &r);
// </group>
//
// </group>
//
// Element by element comparisons between an array and a scalar, which
// behaves as if it were a conformant array filled with the value "val."
// The result is true if the comparison is true for some element of the array.
// At some point operators will be available that return masks where the
// comparison is true.
// <group>
template<class T> Bool anyLE (const Array<T> &array, const T &val);
template<class T> Bool anyLE (const T &val, const Array<T> &array);
template<class T> Bool anyLT (const Array<T> &array, const T &val);
template<class T> Bool anyLT (const T &val, const Array<T> &array);
template<class T> Bool anyGE (const Array<T> &array, const T &val);
template<class T> Bool anyGE (const T &val, const Array<T> &array);
template<class T> Bool anyGT (const Array<T> &array, const T &val);
template<class T> Bool anyGT (const T &val, const Array<T> &array);
template<class T> Bool anyEQ (const Array<T> &array, const T &val);
template<class T> Bool anyEQ (const T &val, const Array<T> &array);
template<class T> Bool anyNE (const Array<T> &array, const T &val);
template<class T> Bool anyNE (const T &val, const Array<T> &array);
template<class T> Bool anyNear (const Array<T> &array, const T &val, Double tol);
template<class T> Bool anyNear (const T &val, const Array<T> &array, Double tol);
template<class T> Bool anyNearAbs (const Array<T> &array, const T &val,
Double tol);
template<class T> Bool anyNearAbs (const T &val, const Array<T> &array,
Double tol);
//
// This only makes sense if the array element type is logical valued.
// <group>
template<class T> Bool anyAND (const Array<T> &array, const T &val);
template<class T> Bool anyAND (const T &val, const Array<T> &array);
template<class T> Bool anyOR (const Array<T> &array, const T &val);
template<class T> Bool anyOR (const T &val, const Array<T> &array);
// </group>
//
// </group>
// Are all elements true?
inline Bool allTrue (const Array<Bool>& array)
{ return allEQ (array, True); }
// Is any element true?
inline Bool anyTrue (const Array<Bool>& array)
{ return anyEQ (array, True); }
// The same functions as above, but for selected axes.
Array<Bool> partialAllTrue (const Array<Bool>& array,
const IPosition& collapseAxes);
Array<Bool> partialAnyTrue (const Array<Bool>& array,
const IPosition& collapseAxes);
// Determine the number of true or false elements.
// Note: it is meant for Bool arrays, but can also be used for
// e.g. Int arrays.
// <group>
// Determine it for the full array.
// <group>
template<class T> size_t nfalse (const Array<T> &array);
template<class T> size_t ntrue (const Array<T> &array)
{ return array.nelements() - nfalse(array); }
// </group>
// The same functions as above, but determine ntrue and nfalse for the
// given axes only. The result is an array with a shape formed by the
// remaining axes.
// For example, for an array with shape [3,4,5], collapsing axis 0
// results in an array with shape [4,5] containing ntrue or nfalse for
// each X line.
// Summing for axes 0 and 2 results in an array with shape [4] containing
// ntrue or nfalse for each XZ plane.
// <group>
template<class T> Array<uInt> partialNTrue (const Array<T>& array,
const IPosition& collapseAxes);
template<class T> Array<uInt> partialNFalse (const Array<T>& array,
const IPosition& collapseAxes);
// </group>
// </group>
// </group>
// Define logical Functors.
// <group>
template<typename T> class AllFunc : public ArrayFunctorBase<T,Bool> {
public:
virtual ~AllFunc() {}
virtual Bool operator() (const Array<T>& arr) const { return allTrue(arr); }
};
template<typename T> class AnyFunc : public ArrayFunctorBase<T,Bool> {
public:
virtual ~AnyFunc() {}
virtual Bool operator() (const Array<T>& arr) const { return anyTrue(arr); }
};
template<typename T> class NTrueFunc : public ArrayFunctorBase<T,uInt> {
public:
virtual uInt operator() (const Array<T>& arr) const { return ntrue(arr); }
};
template<typename T> class NFalseFunc : public ArrayFunctorBase<T,uInt> {
public:
virtual uInt operator() (const Array<T>& arr) const { return nfalse(arr); }
};
// </group>
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/casa/Arrays/ArrayLogical.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|