/usr/include/casacore/casa/Utilities/BitVector.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 | //# BitVector.h: Bit vectors of any size
//# Copyright (C) 1993,1994,1995,1999,2000,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_BITVECTOR_H
#define CASA_BITVECTOR_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Containers/Block.h>
#include <casacore/casa/Utilities/Assert.h>
#include <casacore/casa/iosfwd.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class BitVectorHelper;
// The size of a unsigned Integer ( assumes 8-bit char )
const uInt WORDSIZE = sizeof(uInt)*8;
// <summary>
// Bit vectors of any size
// </summary>
// <use visibility=export>
// <reviewed reviewer="Friso Olnon" date="1995/03/13" tests="tBitVector" demos="">
// <etymology>
// A variable utilized as a discrete collection of bits is referred
// to as a bit vector.
// </etymology>
// <synopsis>
// Bit vectors are an efficent method of keeping <em>True/False</em>
// information on a set of items or conditions. Class BitVector
// provides functions to manipulate individual bits in the vector and
// to perform logical operations on whole bit vectors.
// </synopsis>
// <example>
// <srcblock>
// // Create a bit vector with 20 bits (and set them all to False).
// BitVector bv (20, False);
//
// // Change some individual bits:
// // Turn On (make True) bit 19.
// bv.setBit (19);
// // Turn Off (make False) bit 12 (superfluous here).
// bv.clearBit (12);
// // Toggle bit 5 (here: change value from 0 (False) to 1 (True)).
// bv.toggleBit (5)
// // Another way of setting a bit using the index operator.
// bv[0] = True;
// // Assign the value of bit 0 to bit 1 (in three ways).
// bv[1] = bv.getBit(0);
// bv[1] = bv[0];
// bv.putBit (1, bv.getBit(0));
//
// // Show the bit vector size and its value on standard output.
// cout << "Size of bit vector: "<< b.nbits() <<"\n";
// cout << "Value of bit vector: "<< bv <<"\n";
//
// // Perform logical operations on bit vectors.
// // Create two more bit vectors.
// BitVector bv2 (40, False);
// BitVector bv3 (40, True);
// // bitwise OR
// bv = bv2 | bv3;
// // bitwise AND
// bv = bv2 & bv3;
// // bitwise XOR
// bv = bv2 ^ bv3;
// // bitwise NOT
// bv = ~bv2;
//
// // Reset all bits to False, and then to True
// bv = False;
// bv.set (True);
// // Change the vector's size to 10 (and copy the old values).
// bv.resize (10);
// // Change back to original size and set all bits to True.
// void bv.resize (size, True, False);
// </srcblock>
// </example>
class BitVector
{
public:
// BitVectorHelper is a helper class.
friend class BitVectorHelper;
// Create a bit vector of length 0.
BitVector ();
// Create a bit vector with <src>length</src> bits
// and set all bits to to the specified state.
BitVector (uInt length, Bool state);
// Copy constructor (copy semantics).
BitVector (const BitVector& that);
// Delete the bit vector.
~BitVector ();
// Assignment (copy semantics).
BitVector& operator= (const BitVector& that);
// Set all bits to the given state.
BitVector& operator= (Bool state);
// Return the number of bits in the bitvector.
uInt nbits() const;
// Set a bit at the given position (0-relative).
// In debug-mode an exception is thrown when the position is invalid.
void setBit (uInt pos);
// Clear a bit at the given position (0-relative).
// In debug-mode an exception is thrown when the position is invalid.
void clearBit (uInt pos);
// Toggle a bit at the given position (0-relative).
// It returns the original state.
// In debug-mode an exception is thrown when the position is invalid.
Bool toggleBit (uInt pos);
// Get a bit at the given position (0-relative).
// In debug-mode an exception is thrown when the position is invalid.
Bool getBit (uInt pos) const;
// Set a bit at the given position (0-relative) to the given state.
// In debug-mode an exception is thrown when the position is invalid.
void putBit (uInt pos, Bool state);
// Index operator to access the specified bit.
// In debug-mode an exception is thrown when the position is invalid.
// <group>
Bool operator[] (uInt pos) const;
BitVectorHelper operator[] (uInt pos);
// </group>
// Logical operations on whole bit vectors.
// The binary operators <src>&</src> (bitwise
// AND), <src>|</src> (bitwise OR) and <src>^</src> (bitwise XOR),
// and the unary operator <src>~</src> (bitwise NOT) are provided.
// An exception is thrown if the lengths of the vectors differ.
// <group>
BitVector operator& (const BitVector& that) const;
BitVector operator| (const BitVector& that) const;
BitVector operator^ (const BitVector& that) const;
BitVector operator~ () const;
// </group>
// Logical in-place operations on whole bit vectors.
// The binary operators <src>&</src> (bitwise
// AND), <src>|</src> (bitwise OR) and <src>^</src> (bitwise XOR),
// and the unary operator <src>reverse</src> (bitwise NOT) are provided.
// An exception is thrown if the lengths of the vectors differ.
// <group>
void operator&= (const BitVector& that);
void operator|= (const BitVector& that);
void operator^= (const BitVector& that);
void reverse ();
// </group>
// Returns True if all bits are equal.
// An exception is thrown if the lengths of the vectors differ.
Bool operator== (const BitVector& that) const;
// Returns True if a bit differs.
// An exception is thrown if the lengths of the vectors differ.
Bool operator!= (const BitVector& that) const;
// Resize the bit vector to the new length.
// By default the original bits are copied.
// The remaining bits (or all bits in case of no copy) are
// set the the given state.
void resize (uInt length, Bool state=False, Bool copy=True);
// Set all bits of the bit vector to the specified state.
void set (Bool state);
// Set <src>length</src> bits starting at the start position
// (0-relative) to the given state.
// An exception is thrown if start+length exceeds the length
// of the vector.
void set (uInt start, uInt length, Bool state);
// Copy <src>length</src> bits starting at thatStart in the
// other BitVector to this BitVector starting at thisStart.
void copy (uInt thisStart, uInt length, const BitVector& that,
uInt thatStart);
// Write a representation of the bit vector (a list of
// <em>zeros</em> and <em>ones</em> enclosed in square
// parentheses) to ostream.
friend ostream& operator<< (ostream&, const BitVector& vector);
private:
// Number of bits in the BitVector object.
uInt size_p;
// Pointer to the actual bit vector, stored as a contiguous
// sequence of one or more unsigned integers.
Block<uInt> bits_p;
};
// <summary> Helper class for BitVector </summary>
// <use visibility=local>
// <reviewed reviewer="Friso Olnon" date="1995/03/13" tests="tBitVector" demos="">
// <prerequisite>
// <li> class <linkto class=BitVector>BitVector</linkto>
// </prerequisite>
// <synopsis>
// Helper class for class <linkto class=BitVector>BitVector</linkto>.
// For all practical purposes a BitVectorHelper object is the individual bit in
// a bit vector. It is the object returned by the index operator of
// BitVector.
// </synopsis>
class BitVectorHelper
{
friend class BitVector;
public:
// Copy constructor has to be public.
BitVectorHelper (const BitVectorHelper& that);
// Set the bit to the state of the bit in the other BitVector.
// Thus assignment has not the usual copy semantics, but affects
// the underlying BitVector bit.
const BitVectorHelper& operator= (const BitVectorHelper& that) const;
// Set to a state.
const BitVectorHelper& operator= (Bool state) const;
// Defines the conversion from <src>BitVectorHelper</src> to
// <src>Bool</src>.
operator Bool() const;
private:
uInt bitNumber_p;
// Pointer back to the original vector.
BitVector* vecPtr_p;
// The constructor we actually use.
BitVectorHelper (uInt bitNumber, BitVector* vector);
};
inline void BitVector::setBit (uInt pos)
{
DebugAssert (pos < size_p, AipsError);
uInt index = pos/WORDSIZE;
bits_p[index] |= (1 << (pos - index*WORDSIZE));
}
inline void BitVector::clearBit (uInt pos)
{
DebugAssert (pos < size_p, AipsError);
uInt index = pos/WORDSIZE;
bits_p[index] &= (~ (1 << (pos - index*WORDSIZE)));
}
inline Bool BitVector::operator[] (uInt pos) const
{
return getBit (pos);
}
inline uInt BitVector::nbits() const
{
return size_p;
}
inline BitVectorHelper::BitVectorHelper (uInt bitNumber, BitVector* vector)
: bitNumber_p (bitNumber),
vecPtr_p (vector)
{}
inline BitVectorHelper BitVector::operator[] (uInt pos)
{
return BitVectorHelper (pos, this);
}
inline BitVectorHelper::BitVectorHelper (const BitVectorHelper& that)
: bitNumber_p (that.bitNumber_p),
vecPtr_p (that.vecPtr_p)
{}
inline const BitVectorHelper& BitVectorHelper::operator= (Bool state) const
{
vecPtr_p->putBit (bitNumber_p, state);
return *this;
}
inline BitVectorHelper::operator Bool() const
{
return vecPtr_p->getBit (bitNumber_p);
}
inline const BitVectorHelper& BitVectorHelper::operator=
(const BitVectorHelper& that) const
{
vecPtr_p->putBit (bitNumber_p, that.vecPtr_p->getBit (that.bitNumber_p));
return *this;
}
} //# NAMESPACE CASACORE - END
#endif
|