CacheDictionary.st
author Claus Gittinger <cg@exept.de>
Fri, 29 Nov 2002 12:09:14 +0100
changeset 1126 0ca4b7558465
parent 910 af28d492d1eb
child 2700 b480eda50a6a
permissions -rw-r--r--
refactored to invoke #hash/#identityHash only from one place
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     1
"
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     2
 COPYRIGHT (c) 1993 by Claus Gittinger
84
claus
parents: 80
diff changeset
     3
	      All Rights Reserved
2
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     4
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     5
 This software is furnished under a license and may be used
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     6
 only in accordance with the terms of that license and with the
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     7
 inclusion of the above copyright notice.   This software may not
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     8
 be provided or otherwise made available to, or used by, any
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
     9
 other person.  No title to or ownership of the software is
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
    10
 hereby transferred.
07d9ee98e092 *** empty log message ***
claus
parents: 0
diff changeset
    11
"
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    12
910
af28d492d1eb examples
Claus Gittinger <cg@exept.de>
parents: 538
diff changeset
    13
"{ Package: 'stx:libbasic2' }"
af28d492d1eb examples
Claus Gittinger <cg@exept.de>
parents: 538
diff changeset
    14
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    15
Dictionary subclass:#CacheDictionary
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
    16
	instanceVariableNames:''
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
    17
	classVariableNames:''
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
    18
	poolDictionaries:''
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
    19
	category:'Collections-Unordered'
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    20
!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    21
31
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    22
!CacheDictionary class methodsFor:'documentation'!
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    23
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    24
copyright
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    25
"
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    26
 COPYRIGHT (c) 1993 by Claus Gittinger
84
claus
parents: 80
diff changeset
    27
	      All Rights Reserved
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    28
31
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    29
 This software is furnished under a license and may be used
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    30
 only in accordance with the terms of that license and with the
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    31
 inclusion of the above copyright notice.   This software may not
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    32
 be provided or otherwise made available to, or used by, any
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    33
 other person.  No title to or ownership of the software is
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    34
 hereby transferred.
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    35
"
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    36
!
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    37
31
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    38
documentation
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    39
"
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    40
    a CacheDictionary is a Dictionary which will not grow - i.e. keep
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    41
    only a limited number of elements.
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    42
    It can be used as a cache, for keeping recently used objects alive.
254
cccfa2590e6e documentation
Claus Gittinger <cg@exept.de>
parents: 238
diff changeset
    43
cccfa2590e6e documentation
Claus Gittinger <cg@exept.de>
parents: 238
diff changeset
    44
    [author:]
cccfa2590e6e documentation
Claus Gittinger <cg@exept.de>
parents: 238
diff changeset
    45
        Claus Gittinger
31
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    46
"
538
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    47
!
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    48
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    49
examples
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    50
"
910
af28d492d1eb examples
Claus Gittinger <cg@exept.de>
parents: 538
diff changeset
    51
                                                                        [exBegin]
538
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    52
    |d|
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    53
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    54
    d := CacheDictionary new:16.
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    55
    1 to:20 do:[:i |
910
af28d492d1eb examples
Claus Gittinger <cg@exept.de>
parents: 538
diff changeset
    56
        d at:i printString put:i.
538
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    57
    ].
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    58
    21 to:40 do:[:i |
910
af28d492d1eb examples
Claus Gittinger <cg@exept.de>
parents: 538
diff changeset
    59
        d at:i printString put:i.
538
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    60
    ].
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    61
    d inspect
910
af28d492d1eb examples
Claus Gittinger <cg@exept.de>
parents: 538
diff changeset
    62
                                                                        [exEnd]
538
9cffa21b8dd4 added example
Claus Gittinger <cg@exept.de>
parents: 499
diff changeset
    63
"
31
e223f3cf2995 *** empty log message ***
claus
parents: 13
diff changeset
    64
! !
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    65
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    66
!CacheDictionary methodsFor:'private'!
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    67
13
f089ff744cd1 *** empty log message ***
claus
parents: 2
diff changeset
    68
emptyCheck
489
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
    69
    "redefined - never shrink"
13
f089ff744cd1 *** empty log message ***
claus
parents: 2
diff changeset
    70
f089ff744cd1 *** empty log message ***
claus
parents: 2
diff changeset
    71
    ^ self
489
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
    72
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
    73
    "Modified: 30.1.1997 / 15:17:12 / cg"
13
f089ff744cd1 *** empty log message ***
claus
parents: 2
diff changeset
    74
!
f089ff744cd1 *** empty log message ***
claus
parents: 2
diff changeset
    75
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    76
findKeyOrNil:key  
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    77
    "Look for the key in the receiver.  If it is found, return
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    78
     the index of the association containing the key, otherwise
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    79
     return the index of the first unused slot. If no empty slot
489
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
    80
     is available, make one empty (but never grow)."
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    81
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    82
    |index  "{ Class:SmallInteger }"
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    83
     length "{ Class:SmallInteger }"
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    84
     startIndex delIndex
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    85
     probe|
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    86
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    87
    length := keyArray basicSize.
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    88
    startIndex := index := self initialIndexForKey:key.
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    89
1cf8d1747859 Initial revision
claus
parents:
diff changeset
    90
    [true] whileTrue:[
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
    91
        probe := keyArray basicAt:index.
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    92
        key = probe ifTrue:[^ index].
489
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
    93
        probe isNil ifTrue:[
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    94
            delIndex isNil ifTrue:[^ index].
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    95
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    96
            keyArray basicAt:delIndex put:nil.
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    97
            valueArray basicAt:delIndex put:nil.
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
    98
            ^ delIndex
489
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
    99
        ].
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   100
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   101
        (delIndex isNil and:[probe == DeletedEntry]) ifTrue:[
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   102
            delIndex := index
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   103
        ].
13
f089ff744cd1 *** empty log message ***
claus
parents: 2
diff changeset
   104
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   105
        index := index + 1.
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   106
        index > length ifTrue:[
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   107
            index := 1.
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   108
        ].
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   109
        index == startIndex ifTrue:[
489
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   110
            "/ mhmh - actually, a kind of round-robin would be better
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   111
            delIndex isNil ifTrue:[
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   112
                delIndex := startIndex
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   113
            ].
13
f089ff744cd1 *** empty log message ***
claus
parents: 2
diff changeset
   114
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   115
            keyArray basicAt:delIndex put:nil.
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   116
            valueArray basicAt:delIndex put:nil.
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   117
            tally := tally - 1.
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   118
            ^ delIndex
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   119
        ].
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   120
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   121
    ]
238
5cd00f81c000 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 134
diff changeset
   122
499
d3814cbd1f90 checkin from browser
Claus Gittinger <cg@exept.de>
parents: 489
diff changeset
   123
    "Modified: 1.3.1997 / 00:59:55 / cg"
489
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   124
!
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   125
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   126
fullCheck
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   127
    "redefined - never grow"
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   128
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   129
    ^ self
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   130
27859443b951 *** empty log message ***
Claus Gittinger <cg@exept.de>
parents: 459
diff changeset
   131
    "Modified: 30.1.1997 / 15:17:18 / cg"
0
1cf8d1747859 Initial revision
claus
parents:
diff changeset
   132
! !
125
8ee6268bd5ed checkin from browser
Claus Gittinger <cg@exept.de>
parents: 112
diff changeset
   133
134
4ef060494a86 version at the end
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   134
!CacheDictionary class methodsFor:'documentation'!
4ef060494a86 version at the end
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   135
4ef060494a86 version at the end
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   136
version
1126
0ca4b7558465 refactored to invoke #hash/#identityHash only from one place
Claus Gittinger <cg@exept.de>
parents: 910
diff changeset
   137
    ^ '$Header: /cvs/stx/stx/libbasic2/CacheDictionary.st,v 1.20 2002-11-29 11:09:14 cg Exp $'
134
4ef060494a86 version at the end
Claus Gittinger <cg@exept.de>
parents: 125
diff changeset
   138
! !