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
|
/*
* Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program 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 3 of the License, or
* (at your option) any later version.
*
* This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**
* @template [K=unknown]
* @template [V=unknown]
* Class which caches a map of values, keeping the most recently accessed values.
*/
export class CacheMap {
/**
* Creates a new CacheMap.
* @param {number} maxSize The maximum number of entries able to be stored in the cache.
*/
constructor(maxSize) {
if (!(
Number.isFinite(maxSize) &&
maxSize >= 0 &&
Math.floor(maxSize) === maxSize
)) {
throw new Error('Invalid maxCount');
}
/** @type {number} */
this._maxSize = maxSize;
/** @type {Map<K, import('cache-map').Node<K, V>>} */
this._map = new Map();
/** @type {import('cache-map').Node<K, V>} */
this._listFirst = this._createNode(null, null);
/** @type {import('cache-map').Node<K, V>} */
this._listLast = this._createNode(null, null);
this._resetEndNodes();
}
/**
* Returns the number of items in the cache.
* @type {number}
*/
get size() {
return this._map.size;
}
/**
* Returns the maximum number of items that can be added to the cache.
* @type {number}
*/
get maxSize() {
return this._maxSize;
}
/**
* Returns whether or not an element exists at the given key.
* @param {K} key The key of the element.
* @returns {boolean} `true` if an element with the specified key exists, `false` otherwise.
*/
has(key) {
return this._map.has(key);
}
/**
* Gets an element at the given key, if it exists. Otherwise, returns undefined.
* @param {K} key The key of the element.
* @returns {V|undefined} The existing value at the key, if any; `undefined` otherwise.
*/
get(key) {
const node = this._map.get(key);
if (typeof node === 'undefined') { return void 0; }
this._updateRecency(node);
return /** @type {V} */ (node.value);
}
/**
* Sets a value at a given key.
* @param {K} key The key of the element.
* @param {V} value The value to store in the cache.
*/
set(key, value) {
let node = this._map.get(key);
if (typeof node !== 'undefined') {
this._updateRecency(node);
node.value = value;
} else {
if (this._maxSize <= 0) { return; }
node = this._createNode(key, value);
this._addNode(node, this._listFirst);
this._map.set(key, node);
// Remove
for (let removeCount = this._map.size - this._maxSize; removeCount > 0; --removeCount) {
node = /** @type {import('cache-map').Node<K, V>} */ (this._listLast.previous);
this._removeNode(node);
this._map.delete(/** @type {K} */ (node.key));
}
}
}
/**
* Clears the cache.
*/
clear() {
this._map.clear();
this._resetEndNodes();
}
// Private
/**
* @param {import('cache-map').Node<K, V>} node
*/
_updateRecency(node) {
this._removeNode(node);
this._addNode(node, this._listFirst);
}
/**
* @param {?K} key
* @param {?V} value
* @returns {import('cache-map').Node<K, V>}
*/
_createNode(key, value) {
return {key, value, previous: null, next: null};
}
/**
* @param {import('cache-map').Node<K, V>} node
* @param {import('cache-map').Node<K, V>} previous
*/
_addNode(node, previous) {
const next = previous.next;
node.next = next;
node.previous = previous;
previous.next = node;
/** @type {import('cache-map').Node<K, V>} */ (next).previous = node;
}
/**
* @param {import('cache-map').Node<K, V>} node
*/
_removeNode(node) {
/** @type {import('cache-map').Node<K, V>} */ (node.next).previous = node.previous;
/** @type {import('cache-map').Node<K, V>} */ (node.previous).next = node.next;
}
/**
* @returns {void}
*/
_resetEndNodes() {
this._listFirst.next = this._listLast;
this._listLast.previous = this._listFirst;
}
}
|