home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.2 (Developer) / NS_dev_3.2.iso / NextDeveloper / Headers / g++ / BitSet.h < prev    next >
C/C++ Source or Header  |  1993-06-29  |  9KB  |  372 lines
  1. // This may look like C code, but it is really -*- C++ -*-
  2. /* 
  3. Copyright (C) 1988 Free Software Foundation
  4.     written by Doug Lea (dl@rocky.oswego.edu)
  5.  
  6. This file is part of the GNU C++ Library.  This library is free
  7. software; you can redistribute it and/or modify it under the terms of
  8. the GNU Library General Public License as published by the Free
  9. Software Foundation; either version 2 of the License, or (at your
  10. option) any later version.  This library is distributed in the hope
  11. that it will be useful, but WITHOUT ANY WARRANTY; without even the
  12. implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  13. PURPOSE.  See the GNU Library General Public License for more details.
  14. You should have received a copy of the GNU Library General Public
  15. License along with this library; if not, write to the Free Software
  16. Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  17. */
  18.  
  19. #ifndef _BitSet_h
  20. #ifdef __GNUG__
  21. #pragma interface
  22. #endif
  23.  
  24. #define _BitSet_h 1
  25.  
  26. #include <stream.h>
  27. #include <limits.h>
  28.  
  29. #define BITSETBITS  (sizeof(short) * CHAR_BIT)
  30.  
  31. struct BitSetRep
  32. {
  33.   unsigned short  len;          // number of shorts in s
  34.   unsigned short  sz;           // allocated slots
  35.   unsigned short  virt;         // virtual 0 or 1
  36.   unsigned short  s[1];         // bits start here
  37. };
  38.  
  39. extern BitSetRep*   BitSetalloc(BitSetRep*, const unsigned short*, 
  40.                                 int, int, int);
  41. extern BitSetRep*   BitSetcopy(BitSetRep*, const BitSetRep*);
  42. extern BitSetRep*   BitSetresize(BitSetRep*, int);
  43. extern BitSetRep*   BitSetop(const BitSetRep*, const BitSetRep*, 
  44.                              BitSetRep*, char);
  45. extern BitSetRep*   BitSetcmpl(const BitSetRep*, BitSetRep*);
  46.  
  47.  
  48. extern BitSetRep    _nilBitSetRep;
  49.  
  50. class BitSet;
  51.  
  52. class BitSetBit
  53. {
  54. protected:
  55.   BitSet*            src;
  56.   unsigned long      pos;
  57.  
  58.  public:
  59.                      BitSetBit(BitSet* v, int p);
  60.                      BitSetBit(const BitSetBit& b);
  61.                     ~BitSetBit();
  62.                      operator int();
  63.   int                operator = (int b);
  64.   int                operator == (int b);
  65.   int                operator != (int b);
  66. };
  67.  
  68. class BitSet
  69. {
  70. protected:
  71.   BitSetRep*          rep;
  72.  
  73.   
  74. public:
  75.  
  76. // constructors
  77.                      BitSet();
  78.                      BitSet(const BitSet&);
  79.  
  80.                     ~BitSet();
  81.  
  82.   void               operator =  (const BitSet& y);
  83.  
  84. // equality & subset tests
  85.  
  86.   friend int         operator == (const BitSet& x, const BitSet& y);
  87.   friend int         operator != (const BitSet& x, const BitSet& y);
  88.   friend int         operator <  (const BitSet& x, const BitSet& y);
  89.   friend int         operator <= (const BitSet& x, const BitSet& y);
  90.   friend int         operator >  (const BitSet& x, const BitSet& y);
  91.   friend int         operator >= (const BitSet& x, const BitSet& y);
  92.  
  93.  
  94. // operations on self
  95.  
  96.   void               operator |= (const BitSet& y);
  97.   void               operator &= (const BitSet& y);
  98.   void               operator -= (const BitSet& y);
  99.   void               operator ^= (const BitSet& y);
  100.  
  101.   void               complement();
  102.  
  103. // individual bit manipulation
  104.  
  105.   void               set(int pos);
  106.   void               set(int from, int to);
  107.   void               set(); // set all
  108.  
  109.   void               clear(int pos);
  110.   void               clear(int from, int to);
  111.   void               clear(); // clear all
  112.  
  113.   void               invert(int pos);
  114.   void               invert(int from, int to);
  115.  
  116.   int                test(int pos) const;
  117.   int                test(int from, int to) const;
  118.  
  119.   BitSetBit          operator [] (int i);
  120.   
  121. // iterators
  122.  
  123.   int                first(int b = 1) const;
  124.   int                last(int b = 1) const;
  125.  
  126.   int                next(int pos, int b = 1) const;
  127.   int                previous(int pos, int b = 1) const;
  128.  
  129. // status
  130.  
  131.   int                empty() const;
  132.   int                virtual_bit() const;
  133.   int                count(int b = 1) const;
  134.   
  135. // convertors & IO
  136.  
  137.   friend BitSet      atoBitSet(const char* s, 
  138.                                char f='0', char t='1', char star='*');
  139.   // BitSettoa is deprecated; do not use in new programs.
  140.   friend const char* BitSettoa(const BitSet& x, 
  141.                                char f='0', char t='1', char star='*');
  142.  
  143.   friend BitSet      shorttoBitSet(unsigned short w);
  144.   friend BitSet      longtoBitSet(unsigned long w);
  145.  
  146.   friend ostream&    operator << (ostream& s, const BitSet& x);
  147.   void             printon(ostream& s,
  148.                  char f='0', char t='1', char star='*') const;
  149.  
  150. // procedural versions of operators
  151.  
  152.   friend void        and(const BitSet& x, const BitSet& y, BitSet& r);
  153.   friend void        or(const BitSet& x, const BitSet& y, BitSet& r);
  154.   friend void        xor(const BitSet& x, const BitSet& y, BitSet& r);
  155.   friend void        diff(const BitSet& x, const BitSet& y, BitSet& r);
  156.   friend void        complement(const BitSet& x, BitSet& r);
  157.  
  158. // misc
  159.  
  160.   void      error(const char* msg) const;
  161.   int                OK() const;
  162. };
  163.  
  164.  
  165. typedef BitSet BitSetTmp;
  166.  
  167.  
  168.   BitSet      operator |  (const BitSet& x, const BitSet& y);
  169.   BitSet      operator &  (const BitSet& x, const BitSet& y);
  170.   BitSet      operator -  (const BitSet& x, const BitSet& y);
  171.   BitSet      operator ^  (const BitSet& x, const BitSet& y);
  172.  
  173.   BitSet      operator ~  (const BitSet& x);
  174.  
  175. // These are inlined regardless of optimization
  176.  
  177. inline int BitSet_index(int l)
  178. {
  179.   return (unsigned)(l) / BITSETBITS;
  180. }
  181.  
  182. inline int BitSet_pos(int l)
  183. {
  184.   return l & (BITSETBITS - 1);
  185. }
  186.  
  187.  
  188. inline BitSet::BitSet() : rep(&_nilBitSetRep) {}
  189.  
  190. inline BitSet::BitSet(const BitSet& x) :rep(BitSetcopy(0, x.rep)) {}
  191.  
  192. inline BitSet::~BitSet() { if (rep != &_nilBitSetRep) delete rep; }
  193.  
  194. inline void BitSet::operator =  (const BitSet& y)
  195. { 
  196.   rep = BitSetcopy(rep, y.rep);
  197. }
  198.  
  199. inline int operator != (const BitSet& x, const BitSet& y) { return !(x == y); }
  200.  
  201. inline int operator >  (const BitSet& x, const BitSet& y) { return y < x; }
  202.  
  203. inline int operator >= (const BitSet& x, const BitSet& y) { return y <= x; }
  204.  
  205. inline void and(const BitSet& x, const BitSet& y, BitSet& r)
  206. {
  207.   r.rep =  BitSetop(x.rep, y.rep, r.rep, '&');
  208. }
  209.  
  210. inline void or(const BitSet& x, const BitSet& y, BitSet& r)
  211. {
  212.   r.rep =  BitSetop(x.rep, y.rep, r.rep, '|');
  213. }
  214.  
  215. inline void xor(const BitSet& x, const BitSet& y, BitSet& r)
  216. {
  217.   r.rep =  BitSetop(x.rep, y.rep, r.rep, '^');
  218. }
  219.  
  220. inline void diff(const BitSet& x, const BitSet& y, BitSet& r)
  221. {
  222.   r.rep =  BitSetop(x.rep, y.rep, r.rep, '-');
  223. }
  224.  
  225. inline void complement(const BitSet& x, BitSet& r)
  226. {
  227.   r.rep = BitSetcmpl(x.rep, r.rep);
  228. }
  229.  
  230. #if defined(__GNUG__) && !defined(NO_NRV)
  231.  
  232. inline BitSet operator & (const BitSet& x, const BitSet& y) return r
  233. {
  234.   and(x, y, r);
  235. }
  236.  
  237. inline BitSet operator | (const BitSet& x, const BitSet& y) return r
  238. {
  239.   or(x, y, r);
  240. }
  241.  
  242. inline BitSet operator ^ (const BitSet& x, const BitSet& y) return r
  243. {
  244.   xor(x, y, r);
  245. }
  246.  
  247. inline BitSet operator - (const BitSet& x, const BitSet& y) return r
  248. {
  249.   diff(x, y, r);
  250. }
  251.  
  252. inline BitSet operator ~ (const BitSet& x) return r
  253. {
  254.   ::complement(x, r);
  255. }
  256.  
  257. #else /* NO_NRV */
  258.  
  259. inline BitSet operator & (const BitSet& x, const BitSet& y) 
  260. {
  261.   BitSet r; and(x, y, r); return r;
  262. }
  263.  
  264. inline BitSet operator | (const BitSet& x, const BitSet& y) 
  265. {
  266.   BitSet r; or(x, y, r); return r;
  267. }
  268.  
  269. inline BitSet operator ^ (const BitSet& x, const BitSet& y) 
  270. {
  271.   BitSet r; xor(x, y, r); return r;
  272. }
  273.  
  274. inline BitSet operator - (const BitSet& x, const BitSet& y) 
  275. {
  276.   BitSet r; diff(x, y, r); return r;
  277. }
  278.  
  279. inline BitSet operator ~ (const BitSet& x) 
  280. {
  281.   BitSet r; ::complement(x, r); return r;
  282. }
  283.  
  284. #endif
  285.  
  286. inline void BitSet::operator &= (const BitSet& y)
  287. {
  288.   and(*this, y, *this);
  289. }
  290.  
  291. inline void BitSet::operator |= (const BitSet& y)
  292. {
  293.   or(*this, y, *this);
  294. }
  295.  
  296. inline void BitSet::operator ^= (const BitSet& y)
  297. {
  298.   xor(*this, y, *this);
  299. }
  300.  
  301. inline void BitSet::operator -= (const BitSet& y)
  302. {
  303.   diff(*this, y, *this);
  304. }
  305.  
  306.  
  307. inline void BitSet::complement()
  308. {
  309.   ::complement(*this, *this);
  310. }
  311.  
  312. inline int BitSet::virtual_bit() const
  313. {
  314.   return rep->virt;
  315. }
  316.  
  317. inline int BitSet::first(int b) const
  318. {
  319.   return next(-1, b);
  320. }
  321.  
  322. inline int BitSet::test(int p) const
  323. {
  324.   if (p < 0) error("Illegal bit index");
  325.   int index = BitSet_index(p);
  326.   return (index >= rep->len)? rep->virt : 
  327.          ((rep->s[index] & (1 << BitSet_pos(p))) != 0);
  328. }
  329.  
  330.  
  331. inline void BitSet::set()
  332. {
  333.   rep = BitSetalloc(rep, 0, 0, 1, 0);
  334. }
  335.  
  336. inline BitSetBit::BitSetBit(const BitSetBit& b) :src(b.src), pos(b.pos) {}
  337.  
  338. inline BitSetBit::BitSetBit(BitSet* v, int p)
  339. {
  340.   src = v;  pos = p;
  341. }
  342.  
  343. inline BitSetBit::~BitSetBit() {}
  344.  
  345. inline BitSetBit::operator int()
  346. {
  347.   return src->test(pos);
  348. }
  349.  
  350. inline int BitSetBit::operator = (int b)
  351. {
  352.   if (b) src->set(pos); else src->clear(pos); return b;
  353. }
  354.  
  355. inline int BitSetBit::operator == (int b)
  356. {
  357.   return src->test(pos) == b;
  358. }
  359.  
  360. inline int BitSetBit::operator != (int b)
  361. {
  362.   return src->test(pos) != b;
  363. }
  364.  
  365. inline BitSetBit BitSet::operator [] (int i)
  366. {
  367.   if (i < 0) error("illegal bit index");
  368.   return BitSetBit(this, i);
  369. }
  370.  
  371. #endif
  372.