Set.hh revision 10348:c91b23c72d5e 
1/*
2 * Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29// modified by Dan Gibson on 05/20/05 to accomidate FASTER
30// >32 set lengths, using an array of ints w/ 32 bits/int
31
32#ifndef __MEM_RUBY_COMMON_SET_HH__
33#define __MEM_RUBY_COMMON_SET_HH__
34
35#include <iostream>
36#include <limits>
37
38#include "mem/ruby/common/TypeDefines.hh"
39
40/*
41 * This defines the number of longs (32-bits on 32 bit machines,
42 * 64-bit on 64-bit AMD machines) to use to hold the set...
43 * the default is 4, allowing 128 or 256 different members
44 * of the set.
45 *
46 * This should never need to be changed for correctness reasons,
47 * though increasing it will increase performance for larger
48 * set sizes at the cost of a (much) larger memory footprint
49 *
50 */
51const int NUMBER_WORDS_PER_SET = 1;
52
53class Set
54{
55  private:
56    int m_nSize;              // the number of bits in this set
57    int m_nArrayLen;          // the number of 32-bit words that are
58                              // held in the array
59
60    // Changed 5/24/05 for static allocation of array
61    // note that "long" corresponds to 32 bits on a 32-bit machine,
62    // 64 bits if the -m64 parameter is passed to g++, which it is
63    // for an AMD opteron under our configuration
64
65    long *m_p_nArray;      // an word array to hold the bits in the set
66    long m_p_nArray_Static[NUMBER_WORDS_PER_SET];
67
68    static const int LONG_BITS = std::numeric_limits<long>::digits + 1;
69    static const int INDEX_SHIFT = LONG_BITS == 64 ? 6 : 5;
70    static const int INDEX_MASK = (1 << INDEX_SHIFT) - 1;
71
72    void clearExcess();
73
74  public:
75    Set();
76    Set(int size);
77    Set(const Set& obj);
78    ~Set();
79
80    Set& operator=(const Set& obj);
81
82    void
83    add(NodeID index)
84    {
85        m_p_nArray[index >> INDEX_SHIFT] |=
86            (((unsigned long) 1) << (index & INDEX_MASK));
87    }
88
89    void addSet(const Set& set);
90
91    void
92    remove(NodeID index)
93    {
94        m_p_nArray[index >> INDEX_SHIFT] &=
95            ~(((unsigned long)1) << (index & INDEX_MASK));
96    }
97
98    void removeSet(const Set& set);
99
100    void
101    clear()
102    {
103        for (int i = 0; i < m_nArrayLen; i++)
104            m_p_nArray[i] = 0;
105    }
106
107    void broadcast();
108    int count() const;
109    bool isEqual(const Set& set) const;
110
111    // return the logical OR of this set and orSet
112    Set OR(const Set& orSet) const;
113
114    // return the logical AND of this set and andSet
115    Set AND(const Set& andSet) const;
116
117    // Returns true if the intersection of the two sets is empty
118    bool
119    intersectionIsEmpty(const Set& other_set) const
120    {
121        for (int i = 0; i < m_nArrayLen; i++)
122            if (m_p_nArray[i] & other_set.m_p_nArray[i])
123                return false;
124        return true;
125    }
126
127    bool isSuperset(const Set& test) const;
128    bool isSubset(const Set& test) const { return test.isSuperset(*this); }
129
130    bool
131    isElement(NodeID element) const
132    {
133        return (m_p_nArray[element>>INDEX_SHIFT] &
134            (((unsigned long)1) << (element & INDEX_MASK))) != 0;
135    }
136
137    bool isBroadcast() const;
138    bool isEmpty() const;
139
140    NodeID smallestElement() const;
141
142    void setSize(int size);
143
144    NodeID
145    elementAt(int index) const
146    {
147        if (isElement(index))
148            return (NodeID)true;
149        else
150            return 0;
151    }
152
153    int getSize() const { return m_nSize; }
154
155    void print(std::ostream& out) const;
156};
157
158inline std::ostream&
159operator<<(std::ostream& out, const Set& obj)
160{
161    obj.print(out);
162    out << std::flush;
163    return out;
164}
165
166#endif // __MEM_RUBY_COMMON_SET_HH__
167