Set.hh revision 6154
16145Snate@binkert.org 26145Snate@binkert.org/* 36145Snate@binkert.org * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood 46145Snate@binkert.org * All rights reserved. 56145Snate@binkert.org * 66145Snate@binkert.org * Redistribution and use in source and binary forms, with or without 76145Snate@binkert.org * modification, are permitted provided that the following conditions are 86145Snate@binkert.org * met: redistributions of source code must retain the above copyright 96145Snate@binkert.org * notice, this list of conditions and the following disclaimer; 106145Snate@binkert.org * redistributions in binary form must reproduce the above copyright 116145Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 126145Snate@binkert.org * documentation and/or other materials provided with the distribution; 136145Snate@binkert.org * neither the name of the copyright holders nor the names of its 146145Snate@binkert.org * contributors may be used to endorse or promote products derived from 156145Snate@binkert.org * this software without specific prior written permission. 166145Snate@binkert.org * 176145Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 186145Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 196145Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 206145Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 216145Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 226145Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 236145Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 246145Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 256145Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 266145Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 276145Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 286145Snate@binkert.org */ 296145Snate@binkert.org 306145Snate@binkert.org/* 316145Snate@binkert.org * Set.h 326145Snate@binkert.org * 336145Snate@binkert.org * Description: 346145Snate@binkert.org * 356145Snate@binkert.org * $Id$ 366145Snate@binkert.org * 376145Snate@binkert.org */ 386145Snate@binkert.org 396145Snate@binkert.org// Define this to use the BigSet class which is slower, but supports 406145Snate@binkert.org// sets of size larger than 32. 416145Snate@binkert.org 426145Snate@binkert.org// #define BIGSET 436145Snate@binkert.org 446145Snate@binkert.org#define OPTBIGSET 456145Snate@binkert.org 466145Snate@binkert.org#ifdef OPTBIGSET 476154Snate@binkert.org#include "mem/ruby/common/OptBigSet.hh" 486145Snate@binkert.org#else 496145Snate@binkert.org 506145Snate@binkert.org#ifdef BIGSET 516154Snate@binkert.org#include "mem/ruby/common/BigSet.hh" // code to supports sets larger than 32 526145Snate@binkert.org#else 536145Snate@binkert.org 546145Snate@binkert.org#ifndef SET_H 556145Snate@binkert.org#define SET_H 566145Snate@binkert.org 576154Snate@binkert.org#include "mem/ruby/common/Global.hh" 586154Snate@binkert.org#include "mem/gems_common/Vector.hh" 596154Snate@binkert.org#include "mem/ruby/system/NodeID.hh" 606154Snate@binkert.org#include "mem/ruby/config/RubyConfig.hh" 616145Snate@binkert.org 626145Snate@binkert.orgclass Set { 636145Snate@binkert.orgpublic: 646145Snate@binkert.org // Constructors 656145Snate@binkert.org // creates and empty set 666145Snate@binkert.org Set(); 676145Snate@binkert.org Set(int size); 686145Snate@binkert.org 696145Snate@binkert.org // used during the replay mechanism 706145Snate@binkert.org // Set(const char *str); 716145Snate@binkert.org 726145Snate@binkert.org // Set(const Set& obj); 736145Snate@binkert.org // Set& operator=(const Set& obj); 746145Snate@binkert.org 756145Snate@binkert.org // Destructor 766145Snate@binkert.org // ~Set(); 776145Snate@binkert.org 786145Snate@binkert.org // Public Methods 796145Snate@binkert.org 806145Snate@binkert.org void add(NodeID newElement); 816145Snate@binkert.org void addSet(const Set& set); 826145Snate@binkert.org void addRandom(); 836145Snate@binkert.org void remove(NodeID newElement); 846145Snate@binkert.org void removeSet(const Set& set); 856145Snate@binkert.org void clear(); 866145Snate@binkert.org void broadcast(); 876145Snate@binkert.org int count() const; 886145Snate@binkert.org bool isEqual(const Set& set); 896145Snate@binkert.org 906145Snate@binkert.org Set OR(const Set& orSet) const; // return the logical OR of this set and orSet 916145Snate@binkert.org Set AND(const Set& andSet) const; // return the logical AND of this set and andSet 926145Snate@binkert.org 936145Snate@binkert.org // Returns true if the intersection of the two sets is non-empty 946145Snate@binkert.org bool intersectionIsNotEmpty(const Set& other_set) const; 956145Snate@binkert.org 966145Snate@binkert.org // Returns true if the intersection of the two sets is empty 976145Snate@binkert.org bool intersectionIsEmpty(const Set& other_set) const; 986145Snate@binkert.org 996145Snate@binkert.org bool isSuperset(const Set& test) const; 1006145Snate@binkert.org bool isSubset(const Set& test) const { return test.isSuperset(*this); } 1016145Snate@binkert.org bool isElement(NodeID element) const; 1026145Snate@binkert.org bool isBroadcast() const; 1036145Snate@binkert.org bool isEmpty() const; 1046145Snate@binkert.org 1056145Snate@binkert.org NodeID smallestElement() const; 1066145Snate@binkert.org 1076145Snate@binkert.org // int size() const; 1086145Snate@binkert.org void setSize (int size); 1096145Snate@binkert.org 1106145Snate@binkert.org // get element for a index 1116145Snate@binkert.org NodeID elementAt(int index); 1126145Snate@binkert.org int getSize() const { return m_size; } 1136145Snate@binkert.org 1146145Snate@binkert.org // DEPRECATED METHODS 1156145Snate@binkert.org void addToSet(NodeID newElement) { add(newElement); } // Deprecated 1166145Snate@binkert.org void removeFromSet(NodeID newElement) { remove(newElement); } // Deprecated 1176145Snate@binkert.org void clearSet() { clear(); } // Deprecated 1186145Snate@binkert.org void setBroadcast() { broadcast(); } // Deprecated 1196145Snate@binkert.org bool presentInSet(NodeID element) const { return isElement(element); } // Deprecated 1206145Snate@binkert.org 1216145Snate@binkert.org void print(ostream& out) const; 1226145Snate@binkert.orgprivate: 1236145Snate@binkert.org // Private Methods 1246145Snate@binkert.org 1256145Snate@binkert.org // Data Members (m_ prefix) 1266145Snate@binkert.org int m_size; 1276145Snate@binkert.org uint32 m_bits; // Set as a bit vector 1286145Snate@binkert.org uint32 m_mask; // a 000001111 mask where the number of 1s is equal to m_size 1296145Snate@binkert.org 1306145Snate@binkert.org}; 1316145Snate@binkert.org 1326145Snate@binkert.org// Output operator declaration 1336145Snate@binkert.orgostream& operator<<(ostream& out, const Set& obj); 1346145Snate@binkert.org 1356145Snate@binkert.org// ******************* Definitions ******************* 1366145Snate@binkert.org 1376145Snate@binkert.org// Output operator definition 1386145Snate@binkert.orgextern inline 1396145Snate@binkert.orgostream& operator<<(ostream& out, const Set& obj) 1406145Snate@binkert.org{ 1416145Snate@binkert.org obj.print(out); 1426145Snate@binkert.org out << flush; 1436145Snate@binkert.org return out; 1446145Snate@binkert.org} 1456145Snate@binkert.org 1466145Snate@binkert.org#endif //SET_H 1476145Snate@binkert.org#endif //BIGSET 1486145Snate@binkert.org#endif //OPTBIGSET 1496145Snate@binkert.org 150