author | Claus Gittinger <cg@exept.de> |
Wed, 29 Jan 1997 22:05:45 +0100 | |
changeset 2314 | 39ba656af0bb |
parent 2272 | 9942d9c853c3 |
child 2323 | a1fb9151a986 |
permissions | -rw-r--r-- |
1 | 1 |
" |
5 | 2 |
COPYRIGHT (c) 1991 by Claus Gittinger |
159 | 3 |
All Rights Reserved |
1 | 4 |
|
5 |
This software is furnished under a license and may be used |
|
6 |
only in accordance with the terms of that license and with the |
|
7 |
inclusion of the above copyright notice. This software may not |
|
8 |
be provided or otherwise made available to, or used by, any |
|
9 |
other person. No title to or ownership of the software is |
|
10 |
hereby transferred. |
|
11 |
" |
|
12 |
||
13 |
Collection subclass:#Set |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
14 |
instanceVariableNames:'tally keyArray' |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
15 |
classVariableNames:'DeletedEntry' |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
16 |
poolDictionaries:'' |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
17 |
category:'Collections-Unordered' |
1 | 18 |
! |
19 |
||
2272 | 20 |
Object subclass:#EmptySlot |
2259 | 21 |
instanceVariableNames:'' |
22 |
classVariableNames:'' |
|
23 |
poolDictionaries:'' |
|
24 |
privateIn:Set |
|
25 |
! |
|
26 |
||
27 |
!Set class methodsFor:'documentation'! |
|
88 | 28 |
|
29 |
copyright |
|
30 |
" |
|
31 |
COPYRIGHT (c) 1991 by Claus Gittinger |
|
159 | 32 |
All Rights Reserved |
1 | 33 |
|
88 | 34 |
This software is furnished under a license and may be used |
35 |
only in accordance with the terms of that license and with the |
|
36 |
inclusion of the above copyright notice. This software may not |
|
37 |
be provided or otherwise made available to, or used by, any |
|
38 |
other person. No title to or ownership of the software is |
|
39 |
hereby transferred. |
|
40 |
" |
|
41 |
! |
|
1 | 42 |
|
88 | 43 |
documentation |
44 |
" |
|
45 |
a Set is a collection where each element occurs at most once. |
|
95 | 46 |
The inclusion test is done using = for comparison; |
47 |
see IdentitySet for sets using identity compare. |
|
48 |
Sets use hashing for fast access, this access is considerably faster, |
|
49 |
if a good hash-number is returned by the elements. |
|
362 | 50 |
|
51 |
Notice that the default hash (Object>>hash) is not perfect; due to |
|
52 |
the implementation of hash-keys in ST/X, increased hash collisions |
|
53 |
are to be expected for large sets (say: > 20000 element). |
|
54 |
If your objects are heavyly used in sets or dictionaries, and you need |
|
55 |
big collections, your instances may provide a better hash values. |
|
95 | 56 |
|
345 | 57 |
Performance hints: |
657 | 58 |
If only symbols or smallIntegers are used as keys, |
362 | 59 |
use an instance of IdentitySet for slightly better performance, |
60 |
since both hashing and comparison is faster. |
|
345 | 61 |
|
62 |
If you have a rough idea how big the set is going to grow, |
|
63 |
create it using #new: instead of #new. Even if the size given is a |
|
64 |
poor guess (say half of the real size), there is some 20-30% performance |
|
65 |
win to expect, since many resizing operations of the set are avoided. |
|
66 |
||
95 | 67 |
Examples: |
68 |
||
1290 | 69 |
|s| |
70 |
s := Set new. |
|
71 |
s add:'hello'. |
|
72 |
s add:'world'. |
|
73 |
s add:#foo. |
|
74 |
s add:1.2345678. |
|
75 |
s add:'hello'. |
|
95 | 76 |
|
1290 | 77 |
s printNL. |
78 |
's size -> ' print. s size printNL. |
|
79 |
'(s includes:''hello'') -> ' print. (s includes:'hello') printNL. |
|
80 |
'(s includes:#foo) -> ' print. (s includes:#foo) printNL. |
|
81 |
'(s includes:''foo'') -> ' print. (s includes:'foo') printNL. |
|
82 |
'(s includes:#bar) -> ' print. (s includes:#bar) printNL. |
|
83 |
||
84 |
[author:] |
|
85 |
Claus Gittinger |
|
88 | 86 |
" |
87 |
! ! |
|
1 | 88 |
|
2259 | 89 |
!Set class methodsFor:'initialization'! |
41 | 90 |
|
91 |
initialize |
|
92 |
"initialize the Set class" |
|
93 |
||
94 |
DeletedEntry isNil ifTrue:[ |
|
2272 | 95 |
DeletedEntry := EmptySlot new |
41 | 96 |
]. |
97 |
||
98 |
"Set initialize" |
|
2259 | 99 |
|
100 |
"Modified: 24.1.1997 / 21:09:00 / cg" |
|
41 | 101 |
! ! |
102 |
||
2259 | 103 |
!Set class methodsFor:'instance creation'! |
1 | 104 |
|
105 |
new |
|
106 |
"return a new empty Set" |
|
107 |
||
108 |
^ self new:7 |
|
109 |
! |
|
110 |
||
111 |
new:anInteger |
|
112 |
"return a new empty Set with space for anInteger elements" |
|
113 |
||
159 | 114 |
" |
115 |
make it somewhat bigger; hashing works better if fill grade is |
|
116 |
below 10% (make it 75% here ..) |
|
117 |
" |
|
118 |
^ self basicNew setTally:(anInteger * 4 // 3) |
|
119 |
! ! |
|
120 |
||
2259 | 121 |
!Set class methodsFor:'queries'! |
252 | 122 |
|
123 |
goodSizeFrom:arg |
|
124 |
"return a good array size for the given argument. |
|
125 |
Returns the next prime after arg, since prime sizes are good for hashing." |
|
126 |
||
302 | 127 |
|n| |
128 |
||
252 | 129 |
arg <= 11 ifTrue:[^ 11]. |
130 |
||
302 | 131 |
n := arg * 3 // 2. |
132 |
||
252 | 133 |
" |
134 |
mhmh - this returns good numbers for collections with up-to about |
|
135 |
500k elements; if you have bigger ones, add some more primes here ... |
|
136 |
" |
|
302 | 137 |
n <= 524288 ifTrue:[ |
252 | 138 |
"2 4 8 16 32 64 128 256 512 1024 2048 4096 8192 16384 32768 65536 131072 262144 524288" |
302 | 139 |
^ #(11 11 11 17 37 67 131 257 521 1031 2053 4099 8209 16411 32771 65537 131101 262147 524309) at:(n highBit) |
252 | 140 |
]. |
141 |
" |
|
142 |
make it odd - at least |
|
143 |
" |
|
302 | 144 |
^ n bitOr:1 |
252 | 145 |
! ! |
146 |
||
609 | 147 |
!Set methodsFor:'accessing'! |
148 |
||
149 |
at:index |
|
150 |
"report an error: at: is not allowed for Sets" |
|
151 |
||
152 |
^ self errorNotKeyed |
|
153 |
! |
|
154 |
||
155 |
at:index put:anObject |
|
156 |
"report an error: at:put: is not allowed for Sets" |
|
157 |
||
158 |
^ self errorNotKeyed |
|
159 |
! ! |
|
160 |
||
161 |
!Set methodsFor:'adding & removing'! |
|
162 |
||
163 |
add:anObject |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
164 |
"add the argument, anObject to the receiver. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
165 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
166 |
WARNING: do not add elements while iterating over the receiver. |
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
167 |
Iterate over a copy to do this." |
609 | 168 |
|
169 |
|index "{ Class: SmallInteger }"| |
|
170 |
||
171 |
anObject notNil ifTrue:[ |
|
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
172 |
index := self findKeyOrNil:anObject. |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
173 |
(keyArray basicAt:index) isNil ifTrue:[ |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
174 |
keyArray basicAt:index put:anObject. |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
175 |
tally := tally + 1. |
609 | 176 |
|
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
177 |
self fullCheck. |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
178 |
] |
609 | 179 |
]. |
180 |
^ anObject |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
181 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
182 |
"Modified: 1.3.1996 / 21:24:26 / cg" |
609 | 183 |
! |
184 |
||
185 |
remove:oldObject ifAbsent:exceptionBlock |
|
186 |
"remove oldObject from the collection and return it. |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
187 |
If it was not in the collection return the value of exceptionBlock. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
188 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
189 |
WARNING: do not remove elements while iterating over the receiver. |
2314 | 190 |
See #saveRemove: to do this." |
609 | 191 |
|
192 |
|index next| |
|
193 |
||
194 |
index := self find:oldObject ifAbsent:0. |
|
195 |
index == 0 ifTrue:[^ exceptionBlock value]. |
|
196 |
||
197 |
keyArray basicAt:index put:nil. |
|
198 |
tally := tally - 1. |
|
199 |
tally == 0 ifTrue:[ |
|
2314 | 200 |
keyArray := self keyContainerOfSize:(self class goodSizeFrom:0). |
609 | 201 |
] ifFalse:[ |
2314 | 202 |
index == keyArray basicSize ifTrue:[ |
203 |
next := 1 |
|
204 |
] ifFalse:[ |
|
205 |
next := index + 1. |
|
206 |
]. |
|
207 |
(keyArray basicAt:next) notNil ifTrue:[ |
|
208 |
keyArray basicAt:index put:DeletedEntry. |
|
209 |
]. |
|
210 |
self emptyCheck |
|
609 | 211 |
]. |
212 |
^ oldObject |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
213 |
|
2314 | 214 |
"Modified: 29.1.1997 / 21:34:33 / cg" |
609 | 215 |
! |
216 |
||
217 |
removeAll |
|
1164 | 218 |
"remove all elements from the receiver. Returns the receiver." |
609 | 219 |
|
220 |
self setTally:7. |
|
1164 | 221 |
|
222 |
"Modified: 12.4.1996 / 13:35:06 / cg" |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
223 |
! |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
224 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
225 |
saveRemove:oldObject |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
226 |
"remove the element, oldObject from the collection. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
227 |
Return the element. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
228 |
If it was not in the collection return nil. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
229 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
230 |
In contrast to #remove:, this does not resize the underlying collection |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
231 |
and therefore does NOT rehash & change the elements order. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
232 |
Therefor this can be used while enumerating the receiver, |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
233 |
which is not possible if #remove: is used. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
234 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
235 |
WARNING: since no resizing is done, the physical amount of memory used |
2314 | 236 |
by the container remains the same, although the logical size shrinks. |
237 |
You may want to manually resize the receiver using #emptyCheck. |
|
238 |
(after the loop)" |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
239 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
240 |
|index "{ Class:SmallInteger }" |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
241 |
next "{ Class:SmallInteger }"| |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
242 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
243 |
oldObject isNil ifTrue:[^ nil]. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
244 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
245 |
index := self find:oldObject ifAbsent:0. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
246 |
index == 0 ifTrue:[^ nil]. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
247 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
248 |
keyArray basicAt:index put:nil. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
249 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
250 |
tally := tally - 1. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
251 |
tally ~~ 0 ifTrue:[ |
2314 | 252 |
index == keyArray basicSize ifTrue:[ |
253 |
next := 1 |
|
254 |
] ifFalse:[ |
|
255 |
next := index + 1. |
|
256 |
]. |
|
257 |
(keyArray basicAt:next) notNil ifTrue:[ |
|
258 |
keyArray basicAt:index put:DeletedEntry |
|
259 |
]. |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
260 |
]. |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
261 |
^ oldObject |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
262 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
263 |
"does NOT work: |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
264 |
|
2314 | 265 |
|s| |
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
266 |
|
2314 | 267 |
s := Set new. |
268 |
s add:1. |
|
269 |
s add:2. |
|
270 |
s add:3. |
|
271 |
s add:4. |
|
272 |
s add:5. |
|
273 |
s add:6. |
|
274 |
s add:7. |
|
275 |
s add:8. |
|
276 |
s add:9. |
|
277 |
s do:[:v | |
|
278 |
v odd ifTrue:[ |
|
279 |
s remove:v |
|
280 |
] |
|
281 |
]. |
|
282 |
s inspect |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
283 |
" |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
284 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
285 |
"DOES work: |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
286 |
|
2314 | 287 |
|s| |
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
288 |
|
2314 | 289 |
s := Set new. |
290 |
s add:1. |
|
291 |
s add:2. |
|
292 |
s add:3. |
|
293 |
s add:4. |
|
294 |
s add:5. |
|
295 |
s add:6. |
|
296 |
s add:7. |
|
297 |
s add:8. |
|
298 |
s add:9. |
|
299 |
s do:[:v | |
|
300 |
v odd ifTrue:[ |
|
301 |
s saveRemove:v |
|
302 |
] |
|
303 |
]. |
|
304 |
s inspect |
|
1052
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
305 |
" |
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
306 |
|
7d43187f7e11
added saveRemove: & commentaries
Claus Gittinger <cg@exept.de>
parents:
969
diff
changeset
|
307 |
"Created: 1.3.1996 / 21:14:26 / cg" |
2314 | 308 |
"Modified: 29.1.1997 / 21:35:55 / cg" |
609 | 309 |
! ! |
310 |
||
311 |
!Set methodsFor:'binary storage'! |
|
312 |
||
313 |
readBinaryContentsFrom: stream manager: manager |
|
314 |
"must rehash after reload" |
|
315 |
||
316 |
super readBinaryContentsFrom: stream manager: manager. |
|
317 |
self rehash |
|
318 |
! ! |
|
319 |
||
159 | 320 |
!Set methodsFor:'copying'! |
321 |
||
322 |
postCopy |
|
323 |
"have to copy the keyArray too" |
|
324 |
||
325 |
keyArray := keyArray shallowCopy |
|
1 | 326 |
! ! |
327 |
||
609 | 328 |
!Set methodsFor:'enumerating'! |
1 | 329 |
|
609 | 330 |
do:aBlock |
1056 | 331 |
"perform the block for all members in the collection. |
332 |
||
333 |
WARNING: do not add/remove elements while iterating over the receiver. |
|
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
334 |
Iterate over a copy to do this." |
13 | 335 |
|
609 | 336 |
|sz "{ Class: SmallInteger }" |
337 |
element| |
|
13 | 338 |
|
609 | 339 |
sz := keyArray size. |
340 |
1 to:sz do:[:index | |
|
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
341 |
element := keyArray at:index. |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
342 |
(element notNil and:[element ~~ DeletedEntry]) ifTrue:[ |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
343 |
aBlock value:element |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
344 |
] |
609 | 345 |
] |
1056 | 346 |
|
347 |
"Modified: 1.3.1996 / 21:41:13 / cg" |
|
609 | 348 |
! ! |
61 | 349 |
|
969 | 350 |
!Set methodsFor:'inspecting'! |
351 |
||
352 |
inspectorClass |
|
353 |
"redefined to use SetInspector |
|
354 |
(instead of the default Inspector)." |
|
355 |
||
356 |
^ SetInspectorView |
|
357 |
! ! |
|
358 |
||
609 | 359 |
!Set methodsFor:'private'! |
2 | 360 |
|
41 | 361 |
emptyCheck |
252 | 362 |
"check if the receiver has become too empty (after a remove) |
324 | 363 |
and shrink if it makes sense. |
364 |
Definition of 'too empty' is 'filled less than 12.5% (i.e. 1/8th)'" |
|
41 | 365 |
|
61 | 366 |
|sz "{Class: SmallInteger}" |
367 |
newSize "{Class: SmallInteger}" | |
|
41 | 368 |
|
61 | 369 |
sz := keyArray basicSize. |
1643
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
370 |
sz > 56 ifTrue:[ |
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
371 |
" |
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
372 |
shrink if too empty |
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
373 |
" |
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
374 |
tally < (sz // 8) ifTrue:[ |
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
375 |
newSize := sz // 7. |
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
376 |
self grow:newSize |
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
377 |
] |
41 | 378 |
] |
1643
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
379 |
|
577e35f5a046
oops - shrinking of Set could create a fully populated Set,
Claus Gittinger <cg@exept.de>
parents:
1450
diff
changeset
|
380 |
"Modified: 4.9.1996 / 14:39:53 / cg" |
41 | 381 |
! |
382 |
||
1 | 383 |
find:key ifAbsent:aBlock |
384 |
"Look for the key in the receiver. If it is found, return |
|
385 |
the index of the slot containing the key, otherwise |
|
386 |
return the value of evaluating aBlock." |
|
387 |
||
61 | 388 |
|index "{ Class:SmallInteger }" |
389 |
length "{ Class:SmallInteger }" |
|
390 |
startIndex probe| |
|
1 | 391 |
|
13 | 392 |
length := keyArray basicSize. |
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
393 |
|
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
394 |
"/ |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
395 |
"/ length < 10 ifTrue:[ |
362 | 396 |
"/ "assuming, that for small collections the overhead of hashing |
397 |
"/ is larger ... maybe that proves wrong |
|
398 |
"/ (if overhead of comparing is higher)" |
|
399 |
"/ ^ keyArray indexOf:key ifAbsent:aBlock |
|
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
400 |
"/ ]. |
13 | 401 |
|
362 | 402 |
index := key hash. |
1975 | 403 |
index < 16r1FFFFFFF ifTrue:[ |
404 |
index := index * 2 |
|
405 |
]. |
|
406 |
index := index \\ length + 1. |
|
362 | 407 |
startIndex := index. |
1 | 408 |
|
409 |
[true] whileTrue:[ |
|
159 | 410 |
probe := (keyArray basicAt:index). |
362 | 411 |
probe isNil ifTrue:[^ aBlock value]. |
159 | 412 |
key = probe ifTrue:[^ index]. |
1 | 413 |
|
159 | 414 |
index == length ifTrue:[ |
415 |
index := 1 |
|
416 |
] ifFalse:[ |
|
417 |
index := index + 1 |
|
418 |
]. |
|
362 | 419 |
index == startIndex ifTrue:[^ aBlock value]. |
1 | 420 |
] |
421 |
! |
|
422 |
||
13 | 423 |
findKeyOrNil:key |
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
424 |
"Look for the key in the receiver. |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
425 |
If it is found, return return the index of the first unused slot. |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
426 |
Grow the receiver, if key was not found, and no unused slots were present" |
1 | 427 |
|
61 | 428 |
|index "{ Class:SmallInteger }" |
429 |
length "{ Class:SmallInteger }" |
|
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
430 |
startIndex probe |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
431 |
delIndex "{ Class:SmallInteger }" | |
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
432 |
|
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
433 |
delIndex := 0. |
1 | 434 |
|
13 | 435 |
length := keyArray basicSize. |
362 | 436 |
index := key hash. |
1975 | 437 |
index < 16r1FFFFFFF ifTrue:[ |
438 |
index := index * 2 |
|
439 |
]. |
|
440 |
index := index \\ length + 1. |
|
362 | 441 |
startIndex := index. |
1 | 442 |
|
443 |
[true] whileTrue:[ |
|
1450
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
444 |
probe := keyArray basicAt:index. |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
445 |
probe isNil ifTrue:[ |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
446 |
delIndex == 0 ifTrue:[^ index]. |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
447 |
keyArray basicAt:delIndex put:nil. |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
448 |
^ delIndex |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
449 |
]. |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
450 |
key = probe ifTrue:[^ index]. |
1126
497de696dff0
OOPS - could add elements twice after a remove (shame on me: how could that go unnoticed for so long ...)
Claus Gittinger <cg@exept.de>
parents:
1056
diff
changeset
|
451 |
|
1450
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
452 |
probe == DeletedEntry ifTrue:[ |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
453 |
delIndex == 0 ifTrue:[ |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
454 |
delIndex := index |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
455 |
] |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
456 |
]. |
1 | 457 |
|
1450
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
458 |
index == length ifTrue:[ |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
459 |
index := 1 |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
460 |
] ifFalse:[ |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
461 |
index := index + 1 |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
462 |
]. |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
463 |
index == startIndex ifTrue:[ |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
464 |
delIndex ~~ 0 ifTrue:[ |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
465 |
keyArray basicAt:delIndex put:nil. |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
466 |
^ delIndex |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
467 |
]. |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
468 |
^ self grow findKeyOrNil:key |
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
469 |
]. |
1 | 470 |
] |
1450
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
471 |
|
18c2a1da8be2
first look for nil-entry in findKeyOrNil: - saves a compare in the good case, when adding new elements
Claus Gittinger <cg@exept.de>
parents:
1319
diff
changeset
|
472 |
"Modified: 4.6.1996 / 11:15:16 / cg" |
1 | 473 |
! |
474 |
||
475 |
findNil:key |
|
476 |
"Look for the next slot usable for key. This method assumes that |
|
1055 | 477 |
key is not already in the receiver and that keyArray does not have |
478 |
previously removed entries. |
|
479 |
To be used only while growing/rehashing to enter elements into a fresh |
|
480 |
collection." |
|
1 | 481 |
|
1319 | 482 |
|startIndex |
483 |
index "{ Class:SmallInteger }" |
|
61 | 484 |
length "{ Class:SmallInteger }"| |
1 | 485 |
|
13 | 486 |
length := keyArray basicSize. |
362 | 487 |
index := key hash. |
1975 | 488 |
index < 16r1FFFFFFF ifTrue:[ |
489 |
index := index * 2 |
|
490 |
]. |
|
491 |
index := index \\ length + 1. |
|
1319 | 492 |
startIndex := index. |
1 | 493 |
|
13 | 494 |
[(keyArray basicAt:index) notNil] whileTrue:[ |
1319 | 495 |
index == length ifTrue:[ |
496 |
index := 1 |
|
497 |
] ifFalse:[ |
|
498 |
index := index + 1 |
|
499 |
]. |
|
500 |
index == startIndex ifTrue:[ |
|
501 |
"notice: should not be reached |
|
502 |
- we must find one since this is only to be |
|
503 |
called after growing" |
|
504 |
^ 0 |
|
505 |
]. |
|
1 | 506 |
]. |
507 |
^ index |
|
1055 | 508 |
|
1319 | 509 |
"Modified: 30.4.1996 / 14:15:20 / cg" |
1 | 510 |
! |
511 |
||
609 | 512 |
fullCheck |
513 |
"check if collection is full (after an add); grow if so. |
|
514 |
Definition of 'full' is currently: 'filled more than 75% (i.e. 3/4th)'" |
|
515 |
||
516 |
|sz "{Class: SmallInteger}" | |
|
517 |
||
518 |
" |
|
519 |
grow if filled more than 75% |
|
520 |
" |
|
521 |
sz := keyArray basicSize. |
|
522 |
tally > (sz * 3 // 4) ifTrue:[ |
|
523 |
self grow |
|
524 |
] |
|
525 |
! |
|
526 |
||
1 | 527 |
grow |
528 |
"change the number of element slots of the collection to a useful |
|
529 |
new size" |
|
530 |
||
13 | 531 |
self grow:(keyArray basicSize * 2) |
1 | 532 |
! |
533 |
||
534 |
grow:newSize |
|
535 |
"change the number of element slots of the collection - to do this, |
|
536 |
we have to rehash (which is done by re-adding all elements to a new |
|
537 |
empty set)." |
|
538 |
||
95 | 539 |
|elem oldKeyArray newKeyArray deletedEntry |
252 | 540 |
containerSize oldSize "{ Class:SmallInteger }"| |
1 | 541 |
|
13 | 542 |
oldKeyArray := keyArray. |
252 | 543 |
oldSize := oldKeyArray size. |
544 |
containerSize := (self class goodSizeFrom:newSize). |
|
545 |
containerSize == oldSize ifTrue:[^ self]. |
|
1 | 546 |
|
252 | 547 |
keyArray := newKeyArray := self keyContainerOfSize:containerSize. |
548 |
||
95 | 549 |
deletedEntry := DeletedEntry. |
13 | 550 |
1 to:oldSize do:[:srcIndex | |
159 | 551 |
elem := oldKeyArray basicAt:srcIndex. |
552 |
(elem notNil and:[elem ~~ deletedEntry]) ifTrue:[ |
|
553 |
"cannot be already there" |
|
554 |
newKeyArray basicAt:(self findNil:elem) put:elem |
|
555 |
]. |
|
95 | 556 |
]. |
1 | 557 |
! |
558 |
||
609 | 559 |
initialIndexFor:hashKey boundedBy:length |
560 |
"for ST-80 compatibility only; it is (currently) not used in this |
|
561 |
implementation of sets. Therefore, in ST/X it does not make sense |
|
562 |
to redefine it. (which may be a bad design decision, but slightly |
|
563 |
improves performance, by avoiding an extra message send ...)" |
|
564 |
||
1972 | 565 |
^ (hashKey * 2 \\ length) + 1. |
609 | 566 |
! |
567 |
||
568 |
keyContainerOfSize:n |
|
569 |
"return a container for keys of size n. |
|
570 |
Extracted to make life of weak subclasses easier ..." |
|
571 |
||
572 |
^ Array basicNew:n |
|
573 |
! |
|
574 |
||
1 | 575 |
rehash |
61 | 576 |
"rehash is done by re-adding all elements to a new empty set. |
577 |
Rehash is needed after a binaryRead, for example." |
|
1 | 578 |
|
95 | 579 |
|element oldKeyArray newKeyArray |
580 |
n "{ Class:SmallInteger }"| |
|
1 | 581 |
|
95 | 582 |
oldKeyArray := keyArray. |
583 |
n := oldKeyArray size. |
|
584 |
keyArray := newKeyArray := self keyContainerOfSize:n. |
|
585 |
||
2 | 586 |
1 to:n do:[:index | |
159 | 587 |
element := oldKeyArray at:index. |
588 |
(element notNil and:[element ~~ DeletedEntry]) ifTrue:[ |
|
589 |
"cannot be already there" |
|
590 |
newKeyArray basicAt:(self findNil:element) put:element |
|
591 |
]. |
|
1 | 592 |
] |
593 |
! |
|
594 |
||
595 |
rehashFrom:startIndex |
|
61 | 596 |
"rehash elements starting at index - after a remove. |
597 |
Notice: due to the new implementation of remove, |
|
159 | 598 |
this is no longer needed" |
1 | 599 |
|
3 | 600 |
|element i "{ Class:SmallInteger }" |
601 |
length |
|
1 | 602 |
index "{ Class:SmallInteger }" | |
603 |
||
13 | 604 |
length := keyArray basicSize. |
1 | 605 |
index := startIndex. |
13 | 606 |
element := keyArray basicAt:index. |
1 | 607 |
[element notNil] whileTrue:[ |
159 | 608 |
i := self findNil:element. |
609 |
i == index ifTrue:[ |
|
610 |
^ self |
|
611 |
]. |
|
612 |
keyArray basicAt:i put:element. |
|
613 |
keyArray basicAt:index put:nil. |
|
1 | 614 |
|
159 | 615 |
index == length ifTrue:[ |
616 |
index := 1 |
|
617 |
] ifFalse:[ |
|
618 |
index := index + 1. |
|
619 |
]. |
|
620 |
element := keyArray basicAt:index. |
|
1 | 621 |
] |
622 |
! |
|
623 |
||
609 | 624 |
setTally:count |
625 |
"initialize the contents array (for at least count slots) |
|
626 |
and set tally to zero. |
|
627 |
The size is increased to the next prime for better hashing behavior." |
|
1 | 628 |
|
609 | 629 |
keyArray := self keyContainerOfSize:(self class goodSizeFrom:count). |
630 |
tally := 0 |
|
1 | 631 |
! ! |
632 |
||
633 |
!Set methodsFor:'testing'! |
|
634 |
||
362 | 635 |
capacity |
636 |
"return the number of elements, that the receiver is |
|
637 |
prepared to take. |
|
638 |
Not used by the system; added for ST-80 compatibility." |
|
639 |
||
640 |
^ keyArray size |
|
641 |
! |
|
642 |
||
1 | 643 |
includes:anObject |
644 |
"return true if the argument anObject is in the receiver" |
|
645 |
||
362 | 646 |
^ (self find:anObject ifAbsent:0) ~~ 0 |
1 | 647 |
! |
648 |
||
649 |
isEmpty |
|
650 |
"return true if the receiver is empty" |
|
651 |
||
652 |
^ tally == 0 |
|
653 |
! |
|
654 |
||
609 | 655 |
isFixedSize |
656 |
"return true if the receiver cannot grow - this will vanish once |
|
657 |
Arrays and Strings learn how to grow ..." |
|
658 |
||
659 |
^ false |
|
660 |
! |
|
661 |
||
1 | 662 |
occurrencesOf:anObject |
663 |
"return the number of occurrences of anObject in the receiver" |
|
664 |
||
362 | 665 |
(self find:anObject ifAbsent:0) == 0 ifTrue:[^ 0]. |
1 | 666 |
^ 1 |
667 |
! |
|
668 |
||
609 | 669 |
size |
670 |
"return the number of set elements" |
|
1 | 671 |
|
609 | 672 |
^ tally |
1 | 673 |
! ! |
674 |
||
2259 | 675 |
!Set class methodsFor:'documentation'! |
635 | 676 |
|
677 |
version |
|
2314 | 678 |
^ '$Header: /cvs/stx/stx/libbasic/Set.st,v 1.44 1997-01-29 21:05:45 cg Exp $' |
635 | 679 |
! ! |
609 | 680 |
Set initialize! |