bit_vector.h

Go to the documentation of this file.

#ifndef BIT_VECTOR_CLASS
#define BIT_VECTOR_CLASS
 
/*****************************************************************************\
*                                                                             *
*  Name   : bit_vector                                                        *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1990-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/
 
#include <basis/astring.h>
#include <basis/definitions.h>
 
namespace structures {
 
 
class bit_vector
{
public:
  bit_vector();
 
  bit_vector(int size, const basis::abyte *initial = NULL_POINTER);
 
  bit_vector(const bit_vector &to_copy);
 
  ~bit_vector();
 
  bit_vector &operator =(const bit_vector &to_copy);
 
  int bits() const;
 
  bool operator [] (int position) const;
 
  bool on(int position) const;
 
  bool off(int position) const;
 
  void set_bit(int position, bool value);
 
  bool whole() const;
 
  bool empty() const;
 
  int find_first(bool to_find) const;
 
  void light(int position);
 
  void clear(int position);
 
  void resize(int size);
 
  void reset(int size);
 
  bool compare(const bit_vector &that, int start, int stop) const;
 
  bool operator == (const bit_vector &that) const;
 
  basis::astring text_form() const;
 
  bit_vector subvector(int start, int end) const;
 
  bool overwrite(int start, const bit_vector &to_write);
 
  basis::un_int get(int start, int size) const;
 
  bool set(int start, int size, basis::un_int source);
 
  operator const basis::byte_array &() const;
 
private:
  basis::byte_array *_implementation;  
  int _number_of_bits;  
 
  struct two_dim_location { int c_byte; int c_offset; };
 
  two_dim_location into_two_dim(int position) const;
  bool get_bit(const two_dim_location &pos_in2) const;
  void set_bit(const two_dim_location &pos_in2, bool value);
};
 
 
// NOTE: these are operations on numbers, NOT on bit_vectors.
 
template <class type>
void SET(type &to_modify, type bits) { to_modify |= bits; }
 
template <class type>
void CLEAR(type &to_modify, type bits) { to_modify &= (type)~bits; }
 
template <class type>
bool TEST(type to_test, type bits) { return bool(!(!(to_test & bits))); }
 
 
} //namespace.
 
#endif