/usr/include/casacore/casa/Arrays/MaskedArray.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 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 | //# MaskedArray.h: A templated N-D masked array class with zero origin.
//# Copyright (C) 1993,1994,1995,1996,1997,1999,2000,2005
//# 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_MASKEDARRAY_H
#define CASA_MASKEDARRAY_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/IPosition.h>
#include <casacore/casa/Utilities/CountedPtr.h>
#include <casacore/casa/Arrays/LogiArrayFwd.h>
#include <casacore/casa/Arrays/MaskLogiArrFwd.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward declarations
//# <note role=warning>
//# Array.h cannot be included in this header file. Anything needed
//# from it must be forwarded. This is why LogicalArrayFwd.h is
//# included instead of LogicalArray.h .
//# </note>
template <class T> class Array;
class Slicer;
// <summary> Class for masking an Array for operations on that Array. </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMaskedArray tMaskArrExcp">
// </reviewed>
//
// <prerequisite>
// <li> <linkto class=Array>Array</linkto>
// <li> <linkto group="LogiArray.h#LogicalArray">LogicalArray</linkto>
// </prerequisite>
//
// <etymology>
// MaskedArray is a class for masking elements of an Array while performing
// operations on that Array.
// </etymology>
//
// <synopsis>
// A MaskedArray is an association between an Array and a mask. The mask
// selects elements of the Array. Only elements of the Array where the
// corresponding element of the mask is True are defined. Thus, operations
// on a MaskedArray only operate on those elements of the Array where the
// corresponding element of the mask is True.
//
// A MaskedArray should be thought of as a manipulator for an Array, analogous
// to an iterator. It allows one to perform whole Array operations on selected
// elements of the Array.
//
// The mask used in the constructor for the MaskedArray must conform to
// the Array, thus have the same shape.
// The internal mask is (will be) copy constructed with reference semantics
// from the input mask. Therefore, it is (will be) possible to change the
// internal mask by changing values in the input mask *after* the MaskedArray
// has been constructed. To ensure that the internal mask is independent of
// the input mask after construction, use mask.copy() as the input argument.
//
// One can explicitly construct a MaskedArray from an Array and a mask or
// a MaskedArray and a mask. One can also use operator() on an Array or
// a MaskedArray to implicitly create a MaskedArray.
//
// One can create a MaskedArray from a MaskedArray and a mask. The resulting
// MaskedArray has as its Array the Array from the original MaskedArray.
// The mask for the resulting MaskedArray is the AND of the mask from the
// original MaskedArray and the input mask.
//
// Any operation involving a MaskedArray or a set of MaskedArrays is only
// performed for those elements where the AND of the masks is True.
//
// Any operation involving a MaskedArray or a set of MaskedArrays results
// in a MaskedArray whose mask is the AND of the masks of the original
// MaskedArrays. The only exception to this is assignment, where the
// mask determines which elements of the underlying Array are assigned.
//
// Masks, which are LogicalArrays, can be constructed by logical operations
// involving Arrays. They can also, of course, be constructed by individually
// setting individual elements of an LogicalArray.
//
// MaskedArrays constructed directly from Arrays are by default writeable.
// MaskedArrays constructed indirectly from Arrays by <src>operator()</src>
// are writeable if the Array is non-const and are readonly if the
// Array is const.
// MaskedArrays constructed from other MaskedArrays, either directly by
// constructors or indirectly by <src>operator()</src>, are by default
// writeable if the input MaskedArray is writeable, and readonly if the
// input MaskedArray is readonly.
//
// A given MaskedArray can be set to be readonly. One specifies
// this in the constructor with the Bool argument <src>isreadonly</src>,
// or calls the <src>setReadOnly()</src> member function.
// A MaskedArray which would default to be readonly cannot be forced to
// be writeable. It will remain readonly even if the Bool argument
// <src>isreadonly</src> is set to be <src>False</src>.
//
// The <src>isReadOnly(),</src> member function is used to test whether
// the MaskedArray is readonly.
//
// Member functions which change the MaskedArray test to see whether
// the MaskedArray is readonly, and throw an ArrayError exception if
// it is. These member functions are:
// <ul>
// <li> <src>operator=()</src>
// <li> <src>getRWArray()</src>
// <li> <src>getRWArrayStorage()</src>
// <li> <src>putArrayStorage()</src>
// </ul>
//
// The copy() member function makes a deep copy of a MaskedArray.
// By default it returns a writeable MaskedArray, but the MaskedArray
// returned can be made readonly by using the Bool argument "isreadonly"
// to copy() (or by calling setReadOnly() on the new MaskedArray).
//
// The valid elements of the MaskedArray can be manipulated as a
// "compressed" Array which contains only the valid elements.
// The number of elements in this "compressed" Array is the number of valid
// elements in the MaskedArray, <src>nelementsValid()</src>.
// The "compressed" Array can have any shape which meets this requirement.
// The MaskedArray can have any shape.
//
// The <src>getCompressedArray()</src> member functions get a compressed
// Array from the valid members of the MaskedArray, while the
// <src>setCompressedArray()</src> member function sets the valid members
// of the MaskedArray from the input compressed Array.
//
// Many mathematical and logical global operators and functions which operate
// on MaskedArrays are defined. Typically, they are defined for all sensible
// combinations of MaskedArrays, Arrays, and scalars.
//
// Mathematical global operators and functions are defined in
// Arrays/MaskArrMath.h .
// The list is:
// <ul>
// <li> operator+= ()
// <li> operator-= ()
// <li> operator*= ()
// <li> operator/= ()
// <li> operator+ ()
// <li> operator- ()
// <li> operator* ()
// <li> operator/ ()
// <li> sin ()
// <li> cos ()
// <li> tan ()
// <li> asin ()
// <li> acos ()
// <li> atan ()
// <li> sinh ()
// <li> cosh ()
// <li> tanh ()
// <li> exp ()
// <li> log ()
// <li> log10 ()
// <li> sqrt ()
// <li> abs ()
// <li> fabs ()
// <li> ceil ()
// <li> floor ()
// <li> atan2 ()
// <li> fmod ()
// <li> pow ()
// <li> minMax ()
// <li> min ()
// <li> max ()
// <li> indgen ()
// <li> sum ()
// <li> sumsquares ()
// <li> product ()
// <li> mean ()
// <li> variance ()
// <li> stddev ()
// <li> avdev ()
// <li> median ()
// <li> square ()
// <li> cube ()
// </ul>
//
// Logical global operators and functions are defined in
// Arrays/MaskArrLogi.h .
// The list is:
// <ul>
// <li> allLE ()
// <li> allLT ()
// <li> allGE ()
// <li> allGT ()
// <li> allEQ ()
// <li> allNE ()
// <li> allAND ()
// <li> allOR ()
// <li> anyLE ()
// <li> anyLT ()
// <li> anyGE ()
// <li> anyGT ()
// <li> anyEQ ()
// <li> anyNE ()
// <li> anyAND ()
// <li> anyOR ()
// <li> operator<= ()
// <li> operator< ()
// <li> operator>= ()
// <li> operator< ()
// <li> operator== ()
// <li> operator!= ()
// <li> operator&& ()
// <li> operator|| ()
// </ul>
// </synopsis>
//
// <example>
// Use an explicit MaskedArray to limit the maximum value of an Array.
//
// <srcblock>
// Vector<Int> arr (20);
// . . .
// MaskedArray<Int> marr (arr, (arr > 5));
// marr = 5;
// </srcblock>
//
// This sets all elements of arr which are greater than 5 to 5.
// </example>
//
// <example>
// Use an implicit MaskedArray to limit the minimum value of an Array.
//
// <srcblock>
// Vector<Int> arr (20);
// . . .
// arr (arr < 0) = 0;
// </srcblock>
//
// This sets all elements of arr which are less than 0 to 0.
// </example>
//
// <example>
// It does not matter where in an expression the MaskedArrays are located.
// The operation is only performed on those elements where the AND of the
// masks is True.
//
// The following expressions are all equivalent.
// The first (and second) expressions are the most efficient, since the sum
// is only performed for those elements where ((a > 0) && (b > 0)).
// The third example is less efficient, since the sum is performed for
// all elements of a and b, and then the assignment is only performed for
// those elements where ((a > 0) && (b > 0)).
//
// <srcblock>
// Vector<Int> arr (20);
// Vector<Int> a (20);
// Vector<Int> b (20);
// . . .
// arr = a(a > 0) + b(b > 0);
//
// arr = a(b > 0) + b(a > 0);
//
// arr ((a > 0) && (b > 0)) = a + b;
//
// arr = (a + b) ((a > 0) && (b > 0));
//
// arr (a > 0) = a + b(b > 0);
//
// </srcblock>
//
// All of these expressions set those elements of arr where
// ((a > 0) && (b > 0)) to a + b. Those elements of arr where the condition
// is False are unchanged.
// </example>
//
// <example>
// This example extracts the valid elements of the MaskedArray as a
// "compressed" Vector, manipulates this Vector, and then puts the result
// back into the MaskedArray.
//
// <srcblock>
// Matrix<Int> arr (20,5);
// . . .
// MaskedArray<Int> marr (arr, (arr>0) && (arr<10));
// Vector<Int> vec (marr.getCompressedArray());
// . . .
// marr.setCompressedArray (vec);
// </srcblock>
//
// </example>
//
// <motivation>
// A MaskedArray is an association between an Array and a LogicalArray which
// masks the Array. It allows one to perform whole Array manipulations
// with a single expression, selecting those elements of the Array to modify
// based either on a logical expression, typically involving some of the
// Arrays involved in the expression, or based on a specifically set mask.
// </motivation>
//
// <todo asof="$DATE:$>
// <li> Consider whether there should be constructors for masks
// specified as Array<Bool>.
// <li> Change constructors to always do copy construction with
// reference semantics when creating the internal mask.
// </todo>
template<class T> class MaskedArray
{
public:
// Default constructor for a MaskedArray does not allocate any memory
// for the Data array or Mask. Hence the masked array
// should not be used until some data is allocated to the object using one
// of the set functions.
MaskedArray();
// Reset the data and mask of the the MaskedArray. There should perhaps be
// a whole family of setData functions with different arguements,
// analogous to the constructors. However these are sufficient for the
// moment.
void setData(const Array<T> & data, const LogicalArray & mask,
Bool isReadOnly=False);
void setData(const MaskedArray<T> & array, Bool isReadOnly=False);
// Create a MaskedArray from an Array and a LogicalArray.
//
// The internal mask is a total copy of the input mask, and is
// completely independent of the input mask.
//
// The Array is copy constructed, which means that it is a really smart
// pointer to the underlying Block, and shares this Block with the input
// Array.
//
// By default, the MaskedArray constructed is writeable. If
// <src>isreadonly</src> is <src>True</src>, then the MaskedArray
// returned is readonly.
//
// <thrown>
// <li> ArrayConformanceError
// </thrown>
//
// <group>
MaskedArray(const Array<T> &inarray, const LogicalArray &inmask,
Bool isreadonly);
MaskedArray(const Array<T> &inarray, const LogicalArray &inmask);
// </group>
// Create a MaskedArray from a MaskedArray and a LogicalArray.
//
// The internal mask is the AND of the input mask and the mask of
// the input MaskedArray.
//
// The Array from the input MaskedArray is copy constructed, which
// means that it is a really smart pointer to the underlying Block, and
// shares this Block with the Array from the input MaskedArray.
//
// By default, the MaskedArray constructed is writeable if the input
// MaskedArray is writeable, and readonly if the input MaskedArray
// is readonly. If <src>isreadonly</src> is <src>True</src>, then
// the MaskedArray returned is readonly. If <src>isreadonly</src> is
// <src>False</src> and the input MaskedArray is readonly, then the
// constructed MaskedArray is readonly.
//
// <thrown>
// <li> ArrayConformanceError
// </thrown>
//
// <group>
MaskedArray(const MaskedArray<T> &inarray, const LogicalArray &inmask,
Bool isreadonly);
MaskedArray(const MaskedArray<T> &inarray, const LogicalArray &inmask);
// </group>
// Create a MaskedArray from an Array and a MaskedLogicalArray.
//
// The internal mask is the AND of the internal LogicalArray and the
// internal mask of the MaskedLogicalArray.
//
// The Array is copy constructed, which means that it is a really smart
// pointer to the underlying Block, and shares this Block with the input
// Array.
//
// By default, the MaskedArray constructed is writeable. If
// <src>isreadonly</src> is <src>True</src>, then the MaskedArray
// returned is readonly.
//
// <thrown>
// <li> ArrayConformanceError
// </thrown>
//
// <group>
MaskedArray(const Array<T> &inarray, const MaskedLogicalArray &inmask,
Bool isreadonly);
MaskedArray(const Array<T> &inarray, const MaskedLogicalArray &inmask);
// </group>
// Create a MaskedArray from a MaskedArray and a MaskedLogicalArray.
//
// The internal mask is the AND of the internal LogicalArray and the
// internal mask of the MaskedLogicalArray, ANDed with the mask of
// the input MaskedArray.
//
// The Array from the input MaskedArray is copy constructed, which
// means that it is a really smart pointer to the underlying Block, and
// shares this Block with the Array from the input MaskedArray.
//
// By default, the MaskedArray constructed is writeable if the input
// MaskedArray is writeable, and readonly if the input MaskedArray
// is readonly. If <src>isreadonly</src> is <src>True</src>, then
// the MaskedArray returned is readonly. If <src>isreadonly</src> is
// <src>False</src> and the input MaskedArray is readonly, then the
// constructed MaskedArray is readonly.
//
// <thrown>
// <li> ArrayConformanceError
// </thrown>
//
// <group>
MaskedArray(const MaskedArray<T> &inarray,
const MaskedLogicalArray &inmask,
Bool isreadonly);
MaskedArray(const MaskedArray<T> &inarray,
const MaskedLogicalArray &inmask);
// </group>
// Copy constructor.
//
// The internal mask is a total copy of the mask from the input
// MaskedArray, and is completely independent of this input mask.
//
// The Array from the input MaskedArray is copy constructed, which
// means that it is a really smart pointer to the underlying Block, and
// shares this Block with the Array from the input MaskedArray.
//
// By default, the MaskedArray constructed is writeable if the input
// MaskedArray is writeable, and readonly if the input MaskedArray
// is readonly. If <src>isreadonly</src> is <src>True</src>, then
// the MaskedArray returned is readonly. If <src>isreadonly</src> is
// <src>False</src> and the input MaskedArray is readonly, then the
// constructed MaskedArray is readonly.
//
// <group>
MaskedArray(const MaskedArray<T> &other, Bool isreadonly);
MaskedArray(const MaskedArray<T> &other);
// </group>
~MaskedArray();
// Return a MaskedArray. The new MaskedArray is masked by the input
// LogicalArray "anded" with the mask of the original MaskedArray.
// This mask must conform to the array.
//
// The MaskedArray constructed is writeable if the input
// MaskedArray is writeable, and readonly if the input MaskedArray
// is readonly.
//
MaskedArray<T> operator() (const LogicalArray &mask) const;
// Return a MaskedArray. The new MaskedArray is masked by the input
// MaskedLogicalArray "anded" with the mask of the original MaskedArray.
// This mask must conform to the array.
//
// The MaskedArray constructed is writeable if the input
// MaskedArray is writeable, and readonly if the input MaskedArray
// is readonly.
//
MaskedArray<T> operator() (const MaskedLogicalArray &mask) const;
// Get a reference to an array part which extends from "start" to end."
// <group>
MaskedArray<T> operator()(const IPosition &start, const IPosition &end);
// Along the ith axis, every inc[i]'th element is chosen.
MaskedArray<T> operator()(const IPosition &start, const IPosition &end,
const IPosition &inc);
// </group>
// Get a reference to an array using a Slicer.
MaskedArray<T> operator()(const Slicer&);
// Make a copy of the masked array.
//
// This is a deep copy. The Array and mask components of the returned
// MaskedArray are deep copies of the Array and mask in the input
// MaskedArray pointed to by this. In other words, the Array and mask
// in the output MaskedArray are completely independent of those in
// the input MaskedArray.
//
// By default, the MaskedArray returned is writeable. If
// <src>isreadonly</src> is <src>True</src>, then the MaskedArray
// returned is readonly.
//
// <group>
MaskedArray<T> copy(Bool isreadonly) const;
MaskedArray<T> copy() const;
// </group>
// Return the internal Array.
const Array<T> & getArray() const;
// Return the internal Array, writeable.
//
// <thrown>
// <li> ArrayError
// </thrown>
//
Array<T> & getRWArray() const;
// Return the (const) internal Mask.
const LogicalArray & getMask() const;
// The dimensionality of this masked array.
uInt ndim() const;
// The number of elements of this masked array.
// This is the number of elements in the underlying Array.
// <group>
uInt nelements() const;
uInt size() const
{ return nelements(); }
// </group>
// The number of valid elements of this masked array.
// This is the number of elements of the mask which are TRUE.
uInt nelementsValid() const;
// Check to see if the masked array is consistent. This is about the same
// thing as checking for invariants. If AIPS_DEBUG is defined, this is
// invoked after construction and on entry to most member functions.
Bool ok() const;
// Are the shapes identical?
// <group>
Bool conform(const Array<T> &other) const;
Bool conform(const MaskedArray<T> &other) const;
// </group>
// The length of each axis.
const IPosition& shape() const
{ return pArray->shape(); }
// Is the array read only?
Bool isReadOnly() const
{ return isRO; }
// Set the array to be read only.
void setReadOnly() const;
// Copy the values in inarray to this, only copying those elements
// for which the corresponding mask element is True.
//
// <thrown>
// <li> ArrayConformanceError
// <li> ArrayError
// </thrown>
//
MaskedArray<T> &operator=(const Array<T> &inarray);
// Copy the values in other to this, only copying those elements
// for which the logical AND of the corresponding mask elements
// of both MaskedArrays is True.
//
// <thrown>
// <li> ArrayConformanceError
// <li> ArrayError
// </thrown>
//
// <group>
MaskedArray<T> &operator=(const MaskedArray<T> &other);
// </group>
// Set every element of this array to "value", only setting those elements
// for which the corresponding mask element is True.
// In other words, a scalar behaves as if it were a constant conformant
// array.
//
// <thrown>
// <li> ArrayError
// </thrown>
//
MaskedArray<T> &operator=(const T &value);
// Return a "compressed" Array containing only the valid
// elements of the MaskedArray. The number of elements in the
// Array will be <src>nelementsValid()</src> for the
// MaskedArray. The MaskedArray can have any shape.
// <group>
// The returned Array will have dimension one.
Array<T> getCompressedArray () const;
// The returned Array will have the input shape. This shape must
// give the returned Array the required number of elements.
//
// <thrown>
// <li> ArrayError
// </thrown>
//
Array<T> getCompressedArray (const IPosition & shape) const;
// </group>
// Fill the argument "compressed" Array with only the
// valid elements of the MaskedArray. The size of the
// Array must be <src>nelementsValid()</src> for the MaskedArray.
// The Array can have any shape which meets this requirement.
// The MaskedArray can have any shape.
//
// <thrown>
// <li> ArrayError
// </thrown>
//
void getCompressedArray (Array<T> & inarr) const;
// Set only the valid elements of the MaskedArray from the argument
// "compressed" Array. The size of the
// Array must be <src>nelementsValid()</src> for the MaskedArray.
// The Array can have any shape which meets this requirement.
// The MaskedArray can have any shape.
//
// <thrown>
// <li> ArrayError
// </thrown>
//
void setCompressedArray (const Array<T> & inarr);
// Manipulate the storage for the underlying Array.
// See the description of the corresponding Array functions
// for more information.
// <group>
const T * getArrayStorage (Bool &deleteIt) const;
//
// <thrown>
// <li> ArrayError
// </thrown>
//
T * getRWArrayStorage (Bool &deleteIt) const;
//
void freeArrayStorage(const T *&storage, Bool deleteIt) const;
//
// <thrown>
// <li> ArrayError
// </thrown>
//
void putArrayStorage(T *&storage, Bool deleteAndCopy) const;
// </group>
// Manipulate the storage for the underlying Mask.
// See the description of the corresponding Array functions
// for more information.
// <group>
const LogicalArrayElem *getMaskStorage (Bool &deleteIt) const;
//
void freeMaskStorage(const LogicalArrayElem *&storage, Bool deleteIt) const;
// </group>
protected:
// The array.
Array<T> *pArray;
// The mask.
LogicalArray *pMask;
// Cache the number of valid elements.
uInt nelemValid;
// Is the number of valid elements cache OK?
// i.e. has it been calculated?
Bool nelemValidIsOK;
// Is the array read only?
Bool isRO;
};
// <summary> General global functions for MaskedArrays, and MaskedArrays and Arrays. </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="tMaskedArray">
//
// <prerequisite>
// <li> <linkto class=Array>Array</linkto>
// <li> <linkto group="LogiArray.h#LogicalArray">LogicalArray</linkto>
// <li> <linkto class=MaskedArray>MaskedArray</linkto>
// </prerequisite>
//
// <synopsis>
// These are generally useful global functions which operate on all
// MaskedArrays, or on MaskedArrays and Arrays.
// </synopsis>
//
// <linkfrom anchor="MaskedArray general global functions" classes="MaskedArray Array Vector Matrix Cube">
// <here>MaskedArray general global functions</here> -- General global
// functions for MaskedArrays, and between MaskedArrays and Arrays.
// </linkfrom>
//
// <group name="MaskedArray general global functions">
// Test conformance for masked arrays and arrays of different types.
// Are the shapes identical?
//
// <group name=conform2>
//
template<class T, class U>
Bool conform2 (const MaskedArray<T> &left, const Array<U> &right);
template<class T, class U>
Bool conform2 (const Array<T> &left, const MaskedArray<U> &right);
template<class T, class U>
Bool conform2 (const MaskedArray<T> &left, const MaskedArray<U> &right);
//
// </group>
// </group>
} //# NAMESPACE CASACORE - END
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/casa/Arrays/MaskedArray.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|