/usr/include/casacore/casa/Arrays/Vector.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 | //# Vector.h: A 1-D Specialization of the Array Class
//# Copyright (C) 1993,1994,1995,1996,1998,1999,2000,2001,2002,2003
//# 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_VECTOR_H
#define CASA_VECTOR_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Arrays/Array.h>
//# Forward declarations
//template <class T, class U> class vector;
#if defined(WHATEVER_VECTOR_FORWARD_DEC)
WHATEVER_VECTOR_FORWARD_DEC;
#else
#include <casacore/casa/stdvector.h>
#endif
namespace casacore { //#Begin namespace casacore
// <summary> A 1-D Specialization of the Array class </summary>
// <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
// </reviewed>
//
// Vector objects are one-dimensional specializations (e.g., more convenient
// and efficient indexing) of the general Array class. You might also want
// to look at the Array documentation to see inherited functionality.
//
// Generally the member functions of Array are also available in
// Vector versions
// which take an integer where the array needs an IPosition. Since the Vector
// is one-dimensional, the IPositions are overkill, although you may
// use those versions if you want to.
// <srcblock>
// Vector<Int> vi(100); // Vector 100 elements long.
// vi.resize(50); // Now only 50 long.
// </srcblock>
//
// Slices may be taken with the Slice class. To take a slice, one "indexes"
// with Slice(start, length, inc) where end and inc are optional.
// <srcblock>
// Vector<Float> vf(100);
// //...
// vf(Slice(0,50,2)) = vf(Slice(1,50,2)); // Copy values from odd onto even
// Vector<Float> firstHalf, secondHalf;
// firstHalf.reference(vf(Slice(0,50)));
// secondHalf.reference(vf(Slice(50,50)));
// // Now we have aliases for two slices into the Vector
// </srcblock>
//
// Element-by-element arithmetic and logical operations are available (in
// aips/ArrayMath.h and aips/ArrayLogical.h) as well as dot and cross
// products (in aips/MatrixMath.h).
//
// A Vector can be constructed from an STL <src>vector</src>. The reverse
// operation (<src>Array::tovector()</src>) can construct an STL
// <src>vector</src> from any Array.
// <note role=tip> To create any other STL container from an Array (or
// the reverse), always create from/to a <src>vector</src>, and use the
// range constructor to create from/to others (like set, list, deque). </note>
//
// As with the Arrays, if the preprocessor symbol AIPS_DEBUG is
// defined at compile time invariants will be checked on entry to most
// member functions. Additionally, if AIPS_ARRAY_INDEX_CHECK is defined
// index operations will be bounds-checked. Neither of these should
// be defined for production code.
template<class T> class Vector : public Array<T>
{
public:
// A zero-length Vector.
Vector();
// A Vector with a defined length and origin of zero.
// <group>
explicit Vector(size_t Length);
Vector(size_t Length, ArrayInitPolicy initPolicy);
explicit Vector(const IPosition& Length);
Vector(const IPosition& Length, ArrayInitPolicy initPolicy);
// </group>
// A Vector with a defined length and origin of zero.
// Fill it with the initial value.
// <group>
Vector(size_t Length, const T &initialValue);
Vector(const IPosition& Length, const T &initialValue);
// </group>
// Create a Vector from the given Block "other." Make it length "nr"
// and copy over that many elements.
Vector(const Block<T> &other, Int64 nr);
// Create a Vector of length other.nelements() and copy over its values.
explicit Vector(const Block<T> &other);
// Create a reference to other.
Vector(const Vector<T> &other);
// Create a reference to the other array.
// It is always possible if the array has zero or one axes.
// If it has > 1 axes, it is only possible if the array has at most
// one axis with length > 1. In that case the degenerated axes are removed.
Vector(const Array<T> &other);
// Create an Vector of a given shape from a pointer.
Vector(const IPosition &shape, T *storage, StorageInitPolicy policy = COPY);
// Create an Vector of a given shape from a pointer.
Vector(const IPosition &shape, T *storage, StorageInitPolicy policy, AbstractAllocator<T> const &allocator);
// Create an Vector of a given shape from a pointer. Because the pointer
// is const, a copy is always made.
Vector(const IPosition &shape, const T *storage);
// Create a Vector from an STL vector (see <src>tovector()</src> in
// <linkto class=Array>Array</linkto> for the reverse operation).
// <note role=tip> Both this constructor and the tovector() are
// defined in <src>Vector2.cc</src>. </note>
// It does implicit promotion/demotion of the type U if different from T.
template <class U, class V>
Vector(const vector<U, V> &other);
// Create a Vector from a container iterator and its length.
// <note> The length is used instead of last, because the distance
// function needed to calculate the length can be expensive.
// <br>A third dummy argument is unfortunately needed to avoid ambiguity
// with another Vector constructor (taking two uInts).
// </note>
template<typename Iterator>
Vector(Iterator first, size_t size, int dummy);
// Define a destructor, otherwise the compiler makes a static one.
virtual ~Vector();
// Assign the other array (which must be of dimension one) to this vector.
// If the shapes mismatch, this array is resized.
virtual void assign (const Array<T>& other);
// Create a reference to "other", which must be of dimension one.
virtual void reference(const Array<T> &other);
// Resize this Vector to the given length.
// The default copyValues flag is False.
//# Note that the 3rd resize function is necessary, because that
//# function is virtual in the base class (otherwise it would
//# be hidden).
// Resize without argument is equal to resize(0, False).
// <group>
using Array<T>::resize;
void resize(size_t len, Bool copyValues=False)
{ Vector<T>::resize(len, copyValues, Array<T>::defaultArrayInitPolicy()); }
void resize(size_t len, Bool copyValues, ArrayInitPolicy policy)
{ if (len != this->nelements()) resize (IPosition(1,len), copyValues, policy); }
virtual void resize();
virtual void resize(const IPosition &len, Bool copyValues, ArrayInitPolicy policy);
// </group>
// Assign to this Vector. If this Vector is zero-length, then resize
// to be the same size as other. Otherwise this and other have to be
// conformant (same size).
// <br>Note that the assign function can be used to assign a
// non-conforming vector.
// <group>
Vector<T> &operator=(const Vector<T> &other);
// Other must be a 1-dimensional array.
virtual Array<T> &operator=(const Array<T> &other);
// </group>
// Set every element of this Vector to Val.
Array<T> &operator=(const T &val)
{ return Array<T>::operator=(val); }
// Copy to this those values in marray whose corresponding elements
// in marray's mask are True.
Vector<T> &operator= (const MaskedArray<T> &marray)
{ Array<T> (*this) = marray; return *this; }
// Convert a Vector to a Block, resizing the block and copying values.
// This is done this way to avoid having the simpler Block class
// containing dependencies on the Vector class.
void toBlock(Block<T> &other) const;
// Single-pixel addressing. If AIPS_ARRAY_INDEX_CHECK is defined,
// bounds checking is performed (not for [])..
// <group>
T &operator[](size_t index)
{ return (this->contiguous_p ? this->begin_p[index] : this->begin_p[index*this->inc_p(0)]); }
const T &operator[](size_t index) const
{ return (this->contiguous_p ? this->begin_p[index] : this->begin_p[index*this->inc_p(0)]); }
T &operator()(const IPosition &i)
{ return Array<T>::operator()(i); }
const T &operator()(const IPosition &i) const
{ return Array<T>::operator()(i); }
T &operator()(size_t index)
{
#if defined(AIPS_ARRAY_INDEX_CHECK)
this->validateIndex(index); //# Throws an exception on failure
#endif
return *(this->begin_p + index*this->inc_p(0));
}
const T &operator()(size_t index) const
{
#if defined(AIPS_ARRAY_INDEX_CHECK)
this->validateIndex(index); //# Throws an exception on failure
#endif
return *(this->begin_p + index*this->inc_p(0));
}
// </group>
// Take a slice of this vector. Slices are always indexed starting
// at zero. This uses reference semantics, i.e. changing a value
// in the slice changes the original.
// <srcblock>
// Vector<Double> vd(100);
// //...
// vd(Slice(0,10)) = -1.0; // First 10 elements of vd set to -1
// </srcblock>
// <group>
Vector<T> operator()(const Slice &slice);
const Vector<T> operator()(const Slice &slice) const;
// </group>
// Slice using IPositions. Required to be defined, otherwise the base
// class versions are hidden.
// <group>
Array<T> operator()(const IPosition &blc, const IPosition &trc,
const IPosition &incr)
{ return Array<T>::operator()(blc,trc,incr); }
const Array<T> operator()(const IPosition &blc, const IPosition &trc,
const IPosition &incr) const
{ return Array<T>::operator()(blc,trc,incr); }
Array<T> operator()(const IPosition &blc, const IPosition &trc)
{ return Array<T>::operator()(blc,trc); }
const Array<T> operator()(const IPosition &blc, const IPosition &trc) const
{ return Array<T>::operator()(blc,trc); }
Array<T> operator()(const Slicer& slicer)
{ return Array<T>::operator()(slicer); }
const Array<T> operator()(const Slicer& slicer) const
{ return Array<T>::operator()(slicer); }
// </group>
// The array is masked by the input LogicalArray.
// This mask must conform to the array.
// <group>
// Return a MaskedArray.
MaskedArray<T> operator() (const LogicalArray &mask) const
{ return Array<T>::operator() (mask); }
// Return a MaskedArray.
MaskedArray<T> operator() (const LogicalArray &mask)
{ return Array<T>::operator() (mask); }
// </group>
// The array is masked by the input MaskedLogicalArray.
// The mask is effectively the AND of the internal LogicalArray
// and the internal mask of the MaskedLogicalArray.
// The MaskedLogicalArray must conform to the array.
// <group>
// Return a MaskedArray.
MaskedArray<T> operator() (const MaskedLogicalArray &mask) const
{ return Array<T>::operator() (mask); }
// Return a MaskedArray.
MaskedArray<T> operator() (const MaskedLogicalArray &mask)
{ return Array<T>::operator() (mask); }
// </group>
// The length of the Vector.
const IPosition &shape() const
{ return this->length_p; }
void shape(Int &Shape) const
{ Shape = this->length_p(0); }
// Verify that dimensionality is 1 and then call Array<T>::ok()
virtual Bool ok() const;
protected:
virtual void preTakeStorage(const IPosition &shape);
// Remove the degenerate axes from other and store result in this vector.
// An exception is thrown if removing degenerate axes does not result
// in a vector.
virtual void doNonDegenerate(const Array<T> &other,
const IPosition &ignoreAxes);
private:
// Helper functions for constructors.
void initVector(const Block<T> &, Int64 nr); // copy semantics
};
//# Declare extern templates for often used types.
#ifdef AIPS_CXX11
extern template class Vector<Bool>;
extern template class Vector<Char>;
extern template class Vector<Short>;
extern template class Vector<uShort>;
extern template class Vector<Int>;
extern template class Vector<uInt>;
extern template class Vector<Int64>;
extern template class Vector<Float>;
extern template class Vector<Double>;
extern template class Vector<Complex>;
extern template class Vector<DComplex>;
extern template class Vector<String>;
#endif
} //#End namespace casacore
#ifndef CASACORE_NO_AUTO_TEMPLATES
#include <casacore/casa/Arrays/Vector.tcc>
#include <casacore/casa/Arrays/Vector2.tcc>
#endif //# CASACORE_NO_AUTO_TEMPLATES
#endif
|