src/utils/BitSet.hpp

/*
 * Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
 *
 * The University of Notre Dame grants you ("Licensee") a
 * non-exclusive, royalty free, license to use, modify and
 * redistribute this software in source and binary code form, provided
 * that the following conditions are met:
 *
 * 1. Acknowledgement of the program authors must be made in any
 *    publication of scientific results based in part on use of the
 *    program.  An acceptable form of acknowledgement is citation of
 *    the article in which the program was described (Matthew
 *    A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
 *    J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
 *    Parallel Simulation Engine for Molecular Dynamics,"
 *    J. Comput. Chem. 26, pp. 252-271 (2005))
 *
 * 2. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 3. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 * This software is provided "AS IS," without a warranty of any
 * kind. All express or implied conditions, representations and
 * warranties, including any implied warranty of merchantability,
 * fitness for a particular purpose or non-infringement, are hereby
 * excluded.  The University of Notre Dame and its licensors shall not
 * be liable for any damages suffered by licensee as a result of
 * using, modifying or distributing the software or its
 * derivatives. In no event will the University of Notre Dame or its
 * licensors be liable for any lost revenue, profit or data, or for
 * direct, indirect, special, consequential, incidental or punitive
 * damages, however caused and regardless of the theory of liability,
 * arising out of the use of or inability to use software, even if the
 * University of Notre Dame has been advised of the possibility of
 * such damages.
 */

#ifndef UTILS_BITSET_HPP
#define UTILS_BITSET_HPP

#include <functional>
#include <vector>
namespace oopse {

/**
 * @class BitSet BitSet.hpp "BitSet.hpp"
 * @brief BitSet is a wrapper class of std::vector<char> to act as a growable std::bitset 
 */
class BitSet {
    public:
        /** */
        BitSet() {}
        /** */
        BitSet(int nbits) : bitset_(nbits) {clearAll(); }

        /** Returns the number of bits set to true in this BitSet.  */
        int countBits();

        /** Sets the bit at the specified index to to the complement of its current value. */
        void flip(int bitIndex) {  bitset_[bitIndex] = !bitset_[bitIndex];  }
 
        /** Sets each bit from the specified fromIndex(inclusive) to the specified toIndex(exclusive) to the complement of its current value. */
        void flip(int fromIndex, int toIndex); 

        /** Sets each bit to the complement of its current value. */
        void flip() { flip(0, size()); }
        
        /** Returns the value of the bit with the specified index. */
        bool get(int bitIndex) {  return bitset_[bitIndex];  }
        
        /** Returns a new BitSet composed of bits from this BitSet from fromIndex(inclusive) to toIndex(exclusive). */
        BitSet get(int fromIndex, int toIndex); 
        
        /** Returns true if any bits are set to true */
        bool any() {return !none(); }

        /** Returns true if no bits are set to true */
        bool none();
        
        /** Returns the index of the first bit that is set to false that occurs on or after the specified starting index.*/
        int nextOffBit(int fromIndex); 
         
        /** Returns the index of the first bit that is set to true that occurs on or after the specified starting index. */
        int nextOnBit(int fromIndex); 
        
        /** Performs a logical AND of this target bit set with the argument bit set. */
        void andOperator (const BitSet& bs);
       
        /** Performs a logical OR of this bit set with the bit set argument. */
        void orOperator (const BitSet& bs); 
        
        /** Performs a logical XOR of this bit set with the bit set argument. */
        void xorOperator (const BitSet& bs);        
               
        void setBitOn(int bitIndex) {  setBit(bitIndex, true);  }

        void setBitOff(int bitIndex) {  setBit(bitIndex, false);  }

        void setRangeOn(int fromIndex, int toIndex) {  setBits(fromIndex, toIndex, true);  }

        void setRangeOff(int fromIndex, int toIndex) {  setBits(fromIndex, toIndex, false);  }        

        /** Sets all of the bits in this BitSet to false. */
        void clearAll() {  setRangeOff(0, size());  }         

        void setAll() {  setRangeOn(0, size());  }        
        
        /** Returns the number of bits of space actually in use by this BitSet to represent bit values. */
        int size() const {  return bitset_.size();  }

        /** Changes the size of BitSet*/
        void resize(int nbits);
        
        BitSet& operator&= (const BitSet &bs) {  andOperator (bs); return *this; }
        BitSet& operator|= (const BitSet &bs) { orOperator (bs); return *this; }
        BitSet& operator^= (const BitSet &bs) { xorOperator (bs); return *this; }
        bool operator[] (int bitIndex) {  return bitset_[bitIndex];  }

        friend BitSet operator| (const BitSet& bs1, const BitSet& bs2);
        friend BitSet operator& (const BitSet& bs1, const BitSet& bs2);
        friend BitSet operator^ (const BitSet& bs1, const BitSet& bs2);
        friend bool operator== (const BitSet & bs1, const BitSet &bs2);

        friend std::istream& operator>> ( std::istream&, const BitSet& bs);
        friend std::ostream& operator<< ( std::ostream&, const BitSet& bs) ;

    private:

        /** Sets the bit at the specified index to the specified value. */
        void setBit(int bitIndex, bool value) { bitset_[bitIndex] = value; }
        
        /** Sets the bits from the specified fromIndex(inclusive) to the specified toIndex(exclusive) to the specified value. */
        void setBits(int fromIndex, int toIndex, bool value);
        
        std::vector<char> bitset_;
};

template<typename T>
struct logical_xor :public std::binary_function<T, T, bool> {
    double operator()(T x, T y) { return x ^ y; }
};

}
#endif
Revision:	1974
Committed:	Fri Feb 4 22:42:12 2005 UTC (19 years, 5 months ago) by tim
File size:	6407 byte(s)
Log Message:	minor change in BitSet
#	User	Rev	Content
1	tim	1961	/*
2			* Copyright (c) 2005 The University of Notre Dame. All Rights Reserved.
3			*
4			* The University of Notre Dame grants you ("Licensee") a
5			* non-exclusive, royalty free, license to use, modify and
6			* redistribute this software in source and binary code form, provided
7			* that the following conditions are met:
8			*
9			* 1. Acknowledgement of the program authors must be made in any
10			* publication of scientific results based in part on use of the
11			* program. An acceptable form of acknowledgement is citation of
12			* the article in which the program was described (Matthew
13			* A. Meineke, Charles F. Vardeman II, Teng Lin, Christopher
14			* J. Fennell and J. Daniel Gezelter, "OOPSE: An Object-Oriented
15			* Parallel Simulation Engine for Molecular Dynamics,"
16			* J. Comput. Chem. 26, pp. 252-271 (2005))
17			*
18			* 2. Redistributions of source code must retain the above copyright
19			* notice, this list of conditions and the following disclaimer.
20			*
21			* 3. Redistributions in binary form must reproduce the above copyright
22			* notice, this list of conditions and the following disclaimer in the
23			* documentation and/or other materials provided with the
24			* distribution.
25			*
26			* This software is provided "AS IS," without a warranty of any
27			* kind. All express or implied conditions, representations and
28			* warranties, including any implied warranty of merchantability,
29			* fitness for a particular purpose or non-infringement, are hereby
30			* excluded. The University of Notre Dame and its licensors shall not
31			* be liable for any damages suffered by licensee as a result of
32			* using, modifying or distributing the software or its
33			* derivatives. In no event will the University of Notre Dame or its
34			* licensors be liable for any lost revenue, profit or data, or for
35			* direct, indirect, special, consequential, incidental or punitive
36			* damages, however caused and regardless of the theory of liability,
37			* arising out of the use of or inability to use software, even if the
38			* University of Notre Dame has been advised of the possibility of
39			* such damages.
40			*/
41
42			#ifndef UTILS_BITSET_HPP
43			#define UTILS_BITSET_HPP
44
45	tim	1962	#include <functional>
46	tim	1961	#include <vector>
47			namespace oopse {
48
49			/**
50			* @class BitSet BitSet.hpp "BitSet.hpp"
51	tim	1962	* @brief BitSet is a wrapper class of std::vector<char> to act as a growable std::bitset
52	tim	1961	*/
53			class BitSet {
54			public:
55			/** */
56			BitSet() {}
57			/** */
58	tim	1974	BitSet(int nbits) : bitset_(nbits) {clearAll(); }
59	tim	1961
60			/** Returns the number of bits set to true in this BitSet. */
61			int countBits();
62
63			/** Sets the bit at the specified index to to the complement of its current value. */
64			void flip(int bitIndex) { bitset_[bitIndex] = !bitset_[bitIndex]; }
65
66			/** Sets each bit from the specified fromIndex(inclusive) to the specified toIndex(exclusive) to the complement of its current value. */
67			void flip(int fromIndex, int toIndex);
68
69			/** Sets each bit to the complement of its current value. */
70			void flip() { flip(0, size()); }
71
72			/** Returns the value of the bit with the specified index. */
73			bool get(int bitIndex) { return bitset_[bitIndex]; }
74
75			/** Returns a new BitSet composed of bits from this BitSet from fromIndex(inclusive) to toIndex(exclusive). */
76			BitSet get(int fromIndex, int toIndex);
77
78	tim	1962	/** Returns true if any bits are set to true */
79			bool any() {return !none(); }
80
81			/** Returns true if no bits are set to true */
82			bool none();
83
84	tim	1961	/** Returns the index of the first bit that is set to false that occurs on or after the specified starting index.*/
85			int nextOffBit(int fromIndex);
86
87			/** Returns the index of the first bit that is set to true that occurs on or after the specified starting index. */
88			int nextOnBit(int fromIndex);
89
90			/** Performs a logical AND of this target bit set with the argument bit set. */
91	tim	1962	void andOperator (const BitSet& bs);
92
93	tim	1961	/** Performs a logical OR of this bit set with the bit set argument. */
94	tim	1962	void orOperator (const BitSet& bs);
95	tim	1961
96			/** Performs a logical XOR of this bit set with the bit set argument. */
97	tim	1962	void xorOperator (const BitSet& bs);
98	tim	1961
99			void setBitOn(int bitIndex) { setBit(bitIndex, true); }
100
101			void setBitOff(int bitIndex) { setBit(bitIndex, false); }
102
103			void setRangeOn(int fromIndex, int toIndex) { setBits(fromIndex, toIndex, true); }
104
105			void setRangeOff(int fromIndex, int toIndex) { setBits(fromIndex, toIndex, false); }
106
107			/** Sets all of the bits in this BitSet to false. */
108	tim	1970	void clearAll() { setRangeOff(0, size()); }
109
110			void setAll() { setRangeOn(0, size()); }
111	tim	1961
112			/** Returns the number of bits of space actually in use by this BitSet to represent bit values. */
113	tim	1962	int size() const { return bitset_.size(); }
114	tim	1961
115			/** Changes the size of BitSet*/
116	tim	1970	void resize(int nbits);
117	tim	1961
118	tim	1962	BitSet& operator&= (const BitSet &bs) { andOperator (bs); return *this; }
119			BitSet& operator\|= (const BitSet &bs) { orOperator (bs); return *this; }
120			BitSet& operator^= (const BitSet &bs) { xorOperator (bs); return *this; }
121	tim	1961	bool operator[] (int bitIndex) { return bitset_[bitIndex]; }
122
123	tim	1962	friend BitSet operator\| (const BitSet& bs1, const BitSet& bs2);
124			friend BitSet operator& (const BitSet& bs1, const BitSet& bs2);
125			friend BitSet operator^ (const BitSet& bs1, const BitSet& bs2);
126	tim	1961	friend bool operator== (const BitSet & bs1, const BitSet &bs2);
127
128	tim	1962	friend std::istream& operator>> ( std::istream&, const BitSet& bs);
129	tim	1961	friend std::ostream& operator<< ( std::ostream&, const BitSet& bs) ;
130
131			private:
132
133			/** Sets the bit at the specified index to the specified value. */
134			void setBit(int bitIndex, bool value) { bitset_[bitIndex] = value; }
135
136			/** Sets the bits from the specified fromIndex(inclusive) to the specified toIndex(exclusive) to the specified value. */
137	tim	1962	void setBits(int fromIndex, int toIndex, bool value);
138	tim	1961
139			std::vector<char> bitset_;
140			};
141
142	tim	1962	template<typename T>
143			struct logical_xor :public std::binary_function<T, T, bool> {
144			double operator()(T x, T y) { return x ^ y; }
145			};
146
147	tim	1961	}
148			#endif