summaryrefslogtreecommitdiff
path: root/libjava/classpath/gnu/java/io/ObjectIdentityMap2Int.java
blob: ed62e83812082aaaec8aee9fbf3db86da0289b78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/* ObjectIdentityMapToInt.java -- Helper class for faster serialization
   Copyright (C) 2006 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package gnu.java.io;

/**
 * This class provides a map from Object to non-negative int values.
 * Objects are considered equal only if their references are equal.
 *
 * This can be used to equip objects with an integer id.  This class
 * is implemented to use as little memory as possible, particularly
 * not to create hashtable buckets and Integer instances for each
 * mapping.
 *
 * @author Fridtjof Siebert (siebert@aicas.com)
 */
public class ObjectIdentityMap2Int
{


  /**
   * Prime numbers used as size of array. We need the size to be a
   * prime number since the delta used for conflict resulution must
   * not have any common divisors with the length.
   */
  private static final int[] PRIMES = {
    0x1f,
    0x3d,
    0x7f,
    0xfb,
    0x1fd,
    0x3fd,
    0x7f7,
    0xffd,
    0x1fff,
    0x3ffd,
    0x7fed,
    0xfff1,
    0x1ffff,
    0x3fffb,
    0x7ffff,
    0xffffd,
    0x1ffff7,
    0x3ffffd,
    0x7ffff1,
    0xfffffd,
    0x1ffffd9,
    0x3fffffb,
    0x7ffffd9,
    0xfffffc7,
    0x1ffffffd,
    0x3fffffdd,
    0x7fffffff};


  /**
   * Object to be used instead of "null"
   */
  private static final Object NIL = new Object();


  /**
   * The objects in this map:
   *
   * invariant
   *   objectTable.size == PRIMES[cap]
   */
  private Object[] objectTable;


  /**
   * The corresponding integer ids.
   *
   * invariant
   *   intTable.size == PRIMES[cap]
   */
  private int[] intTable;


  /**
   * The number of entries in this map.
   *
   * invariant
   *   size < limit
   */
  private int size = 0;


  /**
   * The index in primes of the size of the tables.
   */
  private int cap = 0;


  /**
   * The limit for size at which the table size is increased.
   *
   * invariant
   *   limit = PRIMES[cap] / 4 * 3;
   */
  private int limit = 0;


  /**
   * Constructs an empty <code>ObjectIdentityMap2Int</code>.
   */
  public ObjectIdentityMap2Int()
  {
    alloc(0);
  }


  /**
   * Helper function to alloc the object and int array for the given
   * capacity.  Set limit, reset size to 0.
   *
   * No elements will be stored in the newly allocated arrays.
   *
   * @param c the capacity: this is an index in PRIMES, PRIMES[c]
   * gives the size of the arrays.
   *
   * @throws InternalError if c >= PRIMES.length (in this case, a
   * normal Hashtable would throw an OutOfMemoryError or a
   * NegativeArraySizeException since the array size exceeds the range
   * of positive integers).
   */
  private void alloc(int c)
  {
    if (c >= PRIMES.length)
      throw new InternalError("Hash table size overflow");

    cap = c;
    int len = PRIMES[c];
    objectTable = new Object[len];
    intTable    = new int[len];
    limit = len / 4 * 3;

    size = 0;
  }


  /**
   * Add a mapping to this Map.
   *
   * ensures
   *   (get(o) == i);
   *
   * @param o object reference or null that is to be mapped.
   *
   * @param i the integer id to be associated with o
   *
   * @throws IllegalArgumentException if i<0
   *
   * @throws InternalError if hash tables has grown to more then
   * 0x7fffffff entries (ie., size >= 0x7fffffff*3/4).
   */
  public void put(Object o, int i)
  {
    if (i < 0)
      throw new IllegalArgumentException("int argument must be postive: "+i);

    o = (o == null) ? NIL : o;
    int s = slot(o);
    Object[] ot = objectTable;
    intTable[s] = i;
    if (objectTable[s] == null)
      {
        objectTable[s] = o;
        size++;
        if (size >= limit)
          {
            rehash();
          }
      }
  }


  /**
   * Helper function to find the index of a free or existing slot for
   * object o
   *
   * ensure
   *   ((objectTable[result] != null) IMPLIES (objectTable[result] == o));
   *
   * @param o an object, must not be null.
   *
   * @return an index of o
   */
  private int slot(Object o)
  {
    Object[] ot = objectTable;
    int hc     = System.identityHashCode(o);
    int len    = ot.length;
    int result = hc % len;
    result = result < 0 ? -result : result;
    int delta  = 16 - (hc & 15);
    Object existing = ot[result];
    while ((existing != null) && (existing != o))
      {
        result += delta;
        if (result >= len)
          result -= len;
        existing = ot[result];
      }
    return result;
  }


  /**
   * Helper function for put() to increaes the capacity of this table
   * to the next size (approx. double the size).  Keep the mapping and
   * the size unchanged.
   *
   * ensure
   *   (cap == \old cap+1);
   */
  private void rehash()
  {
    Object[] ot = objectTable;
    int   [] it = intTable;
    alloc(cap + 1);

    for (int i = 0; i < ot.length; i++)
      put(ot[i], it[i]);
  }


  /**
   * Obtain an element from this map
   *
   * @param o an object or null
   *
   * @return the corresponding integer id for o or -1 if o has not
   * been put into this map.
   */
  public int get(Object o)
  {
    o = (o == null) ? NIL : o;
    int s = slot(o);
    return objectTable[s] == null ? -1 : intTable[s];
  }

  /**
   * Clear this map
   *
   * ensures
   *   ((size == 0) && \forall Object o: get(o) == -1)
   */
  public void clear()
  {
    Object[] ot = objectTable;
    size = 0;
    for (int i = 0; i < ot.length; i++)
      ot[i] = null;
  }

}