src/mem/ruby/common/BigSet.hh

   1
   2 /*
   3  * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions are
   8  * met: redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer;
  10  * redistributions in binary form must reproduce the above copyright
  11  * notice, this list of conditions and the following disclaimer in the
  12  * documentation and/or other materials provided with the distribution;
  13  * neither the name of the copyright holders nor the names of its
  14  * contributors may be used to endorse or promote products derived from
  15  * this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 // NOTE: Never include this file directly, this should only be
  31 // included from Set.h
  32
  33 #ifndef SET_H
  34 #define SET_H
  35
  36 #include "Global.hh"
  37 #include "Vector.hh"
  38 #include "NodeID.hh"
  39 #include "RubyConfig.hh"
  40
  41 enum PresenceBit {NotPresent, Present};
  42
  43 class Set {
  44 public:
  45   // Constructors
  46   // creates and empty set
  47   Set();
  48   Set (int size);
  49
  50   // used during the replay mechanism
  51   //  Set(const char *str);
  52
  53   //  Set(const Set& obj);
  54   //  Set& operator=(const Set& obj);
  55
  56   // Destructor
  57   // ~Set();
  58
  59   // Public Methods
  60
  61   void add(NodeID newElement);
  62   void addSet(const Set& set);
  63   void addRandom();
  64   void remove(NodeID newElement);
  65   void removeSet(const Set& set);
  66   void clear();
  67   void broadcast();
  68   int count() const;
  69   bool isEqual(const Set& set) const;
  70
  71   Set OR(const Set& orSet) const;  // return the logical OR of this set and orSet
  72   Set AND(const Set& andSet) const;  // return the logical AND of this set and andSet
  73
  74   // Returns true if the intersection of the two sets is non-empty
  75   bool intersectionIsNotEmpty(const Set& other_set) const;
  76
  77   // Returns true if the intersection of the two sets is empty
  78   bool intersectionIsEmpty(const Set& other_set) const;
  79
  80   bool isSuperset(const Set& test) const;
  81   bool isSubset(const Set& test) const { return test.isSuperset(*this); }
  82   bool isElement(NodeID element) const;
  83   bool isBroadcast() const;
  84   bool isEmpty() const;
  85
  86   NodeID smallestElement() const;
  87
  88   //  int size() const;
  89   void setSize (int size);
  90
  91   // get element for a index
  92   NodeID elementAt(int index) const;
  93   int getSize() const { return m_bits.size(); }
  94
  95   // DEPRECATED METHODS
  96   void addToSet(NodeID newElement) { add(newElement); }  // Deprecated
  97   void removeFromSet(NodeID newElement) { remove(newElement); }  // Deprecated
  98   void clearSet() { clear(); }   // Deprecated
  99   void setBroadcast() { broadcast(); }   // Deprecated
 100   bool presentInSet(NodeID element) const { return isElement(element); }  // Deprecated
 101
 102   void print(ostream& out) const;
 103 private:
 104   // Private Methods
 105
 106   // Data Members (m_ prefix)
 107   Vector<uint8> m_bits;  // This is an vector of uint8 to reduce the size of the set
 108 };
 109
 110 // Output operator declaration
 111 ostream& operator<<(ostream& out, const Set& obj);
 112
 113 // ******************* Definitions *******************
 114
 115 // Output operator definition
 116 extern inline
 117 ostream& operator<<(ostream& out, const Set& obj)
 118 {
 119   obj.print(out);
 120   out << flush;
 121   return out;
 122 }
 123
 124 #endif //SET_H
 125