Set.hh revision 8229:78bf55f23338 
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/Global.hh"
39#include "mem/ruby/system/NodeID.hh"
40#include "mem/ruby/system/System.hh"
41
42class Set
43{
44  private:
45    int m_nSize;              // the number of bits in this set
46    int m_nArrayLen;          // the number of 32-bit words that are
47                              // held in the array
48
49    // Changed 5/24/05 for static allocation of array
50    // note that "long" corresponds to 32 bits on a 32-bit machine,
51    // 64 bits if the -m64 parameter is passed to g++, which it is
52    // for an AMD opteron under our configuration
53
54    long *m_p_nArray;      // an word array to hold the bits in the set
55    long m_p_nArray_Static[NUMBER_WORDS_PER_SET];
56
57    static const int LONG_BITS = std::numeric_limits<long>::digits;
58    static const int INDEX_SHIFT = LONG_BITS == 64 ? 6 : 5;
59    static const int INDEX_MASK = (1 << INDEX_SHIFT) - 1;
60
61    void clearExcess();
62
63  public:
64    Set();
65    Set(int size);
66    Set(const Set& obj);
67    ~Set();
68
69    Set& operator=(const Set& obj);
70
71    void
72    add(NodeID index)
73    {
74        m_p_nArray[index >> INDEX_SHIFT] |=
75            (((unsigned long) 1) << (index & INDEX_MASK));
76    }
77
78    void addSet(const Set& set);
79    void addRandom();
80
81    void
82    remove(NodeID index)
83    {
84        m_p_nArray[index >> INDEX_SHIFT] &=
85            ~(((unsigned long)1) << (index & INDEX_MASK));
86    }
87
88    void removeSet(const Set& set);
89
90    void
91    clear()
92    {
93        for (int i = 0; i < m_nArrayLen; i++)
94            m_p_nArray[i] = 0;
95    }
96
97    void broadcast();
98    int count() const;
99    bool isEqual(const Set& set) const;
100
101    // return the logical OR of this set and orSet
102    Set OR(const Set& orSet) const;
103
104    // return the logical AND of this set and andSet
105    Set AND(const Set& andSet) const;
106
107    // Returns true if the intersection of the two sets is empty
108    bool
109    intersectionIsEmpty(const Set& other_set) const
110    {
111        for (int i = 0; i < m_nArrayLen; i++)
112            if (m_p_nArray[i] & other_set.m_p_nArray[i])
113                return false;
114        return true;
115    }
116
117    bool isSuperset(const Set& test) const;
118    bool isSubset(const Set& test) const { return test.isSuperset(*this); }
119
120    bool
121    isElement(NodeID element) const
122    {
123        return (m_p_nArray[element>>INDEX_SHIFT] &
124            (((unsigned long)1) << (element & INDEX_MASK))) != 0;
125    }
126
127    bool isBroadcast() const;
128    bool isEmpty() const;
129
130    NodeID smallestElement() const;
131
132    void setSize(int size);
133
134    NodeID
135    elementAt(int index) const
136    {
137        if (isElement(index))
138            return (NodeID)true;
139        else
140            return 0;
141    }
142
143    int getSize() const { return m_nSize; }
144
145    void print(std::ostream& out) const;
146};
147
148inline std::ostream&
149operator<<(std::ostream& out, const Set& obj)
150{
151    obj.print(out);
152    out << std::flush;
153    return out;
154}
155
156#endif // __MEM_RUBY_COMMON_SET_HH__
157