/
sortedset.go
536 lines (466 loc) · 13.4 KB
/
sortedset.go
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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
package sortedset
import (
"math/rand"
"golang.org/x/exp/constraints"
)
const SKIPLIST_MAXLEVEL = 32 /* Should be enough for 2^32 elements */
const SKIPLIST_P = 0.25 /* Skiplist P = 1/4 */
type SortedSet[K constraints.Ordered, SCORE constraints.Ordered, V any] struct {
header *SortedSetNode[K, SCORE, V]
tail *SortedSetNode[K, SCORE, V]
length int64
level int
dict map[K]*SortedSetNode[K, SCORE, V]
}
func createNode[K constraints.Ordered, SCORE constraints.Ordered, V any](level int, score SCORE, key K, value V) *SortedSetNode[K, SCORE, V] {
node := SortedSetNode[K, SCORE, V]{
score: score,
key: key,
Value: value,
level: make([]SortedSetLevel[K, SCORE, V], level),
}
return &node
}
// Returns a random level for the new skiplist node we are going to create.
// The return value of this function is between 1 and SKIPLIST_MAXLEVEL
// (both inclusive), with a powerlaw-alike distribution where higher
// levels are less likely to be returned.
func randomLevel() int {
level := 1
for float64(rand.Int31()&0xFFFF) < float64(SKIPLIST_P*0xFFFF) {
level += 1
}
if level < SKIPLIST_MAXLEVEL {
return level
}
return SKIPLIST_MAXLEVEL
}
func (this *SortedSet[K, SCORE, V]) insertNode(score SCORE, key K, value V) *SortedSetNode[K, SCORE, V] {
var update [SKIPLIST_MAXLEVEL]*SortedSetNode[K, SCORE, V]
var rank [SKIPLIST_MAXLEVEL]int64
x := this.header
for i := this.level - 1; i >= 0; i-- {
/* store rank that is crossed to reach the insert position */
if this.level-1 == i {
rank[i] = 0
} else {
rank[i] = rank[i+1]
}
for x.level[i].forward != nil &&
(x.level[i].forward.score < score ||
(x.level[i].forward.score == score && // score is the same but the key is different
x.level[i].forward.key < key)) {
rank[i] += x.level[i].span
x = x.level[i].forward
}
update[i] = x
}
/* we assume the key is not already inside, since we allow duplicated
* scores, and the re-insertion of score and redis object should never
* happen since the caller of Insert() should test in the hash table
* if the element is already inside or not. */
level := randomLevel()
if level > this.level { // add a new level
for i := this.level; i < level; i++ {
rank[i] = 0
update[i] = this.header
update[i].level[i].span = this.length
}
this.level = level
}
x = createNode(level, score, key, value)
for i := 0; i < level; i++ {
x.level[i].forward = update[i].level[i].forward
update[i].level[i].forward = x
/* update span covered by update[i] as x is inserted here */
x.level[i].span = update[i].level[i].span - (rank[0] - rank[i])
update[i].level[i].span = (rank[0] - rank[i]) + 1
}
/* increment span for untouched levels */
for i := level; i < this.level; i++ {
update[i].level[i].span++
}
if update[0] == this.header {
x.backward = nil
} else {
x.backward = update[0]
}
if x.level[0].forward != nil {
x.level[0].forward.backward = x
} else {
this.tail = x
}
this.length++
return x
}
/* Internal function used by delete, DeleteByScore and DeleteByRank */
func (this *SortedSet[K, SCORE, V]) deleteNode(x *SortedSetNode[K, SCORE, V], update [SKIPLIST_MAXLEVEL]*SortedSetNode[K, SCORE, V]) {
for i := 0; i < this.level; i++ {
if update[i].level[i].forward == x {
update[i].level[i].span += x.level[i].span - 1
update[i].level[i].forward = x.level[i].forward
} else {
update[i].level[i].span -= 1
}
}
if x.level[0].forward != nil {
x.level[0].forward.backward = x.backward
} else {
this.tail = x.backward
}
for this.level > 1 && this.header.level[this.level-1].forward == nil {
this.level--
}
this.length--
delete(this.dict, x.key)
}
/* Delete an element with matching score/key from the skiplist. */
func (this *SortedSet[K, SCORE, V]) delete(score SCORE, key K) bool {
var update [SKIPLIST_MAXLEVEL]*SortedSetNode[K, SCORE, V]
x := this.header
for i := this.level - 1; i >= 0; i-- {
for x.level[i].forward != nil &&
(x.level[i].forward.score < score ||
(x.level[i].forward.score == score &&
x.level[i].forward.key < key)) {
x = x.level[i].forward
}
update[i] = x
}
/* We may have multiple elements with the same score, what we need
* is to find the element with both the right score and object. */
x = x.level[0].forward
if x != nil && score == x.score && x.key == key {
this.deleteNode(x, update)
// free x
return true
}
return false /* not found */
}
// Create a new SortedSet
func New[K constraints.Ordered, SCORE constraints.Ordered, V any]() *SortedSet[K, SCORE, V] {
sortedSet := SortedSet[K, SCORE, V]{
level: 1,
dict: make(map[K]*SortedSetNode[K, SCORE, V]),
}
var emptyKey K
var emptyScore SCORE
var emptyValue V
sortedSet.header = createNode(SKIPLIST_MAXLEVEL, emptyScore, emptyKey, emptyValue)
return &sortedSet
}
// Get the number of elements
func (this *SortedSet[K, SCORE, V]) GetCount() int {
return int(this.length)
}
// get the element with minimum score, nil if the set is empty
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) PeekMin() *SortedSetNode[K, SCORE, V] {
return this.header.level[0].forward
}
// get and remove the element with minimal score, nil if the set is empty
//
// // Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) PopMin() *SortedSetNode[K, SCORE, V] {
x := this.header.level[0].forward
if x != nil {
this.Remove(x.key)
}
return x
}
// get the element with maximum score, nil if the set is empty
// Time Complexity : O(1)
func (this *SortedSet[K, SCORE, V]) PeekMax() *SortedSetNode[K, SCORE, V] {
return this.tail
}
// get and remove the element with maximum score, nil if the set is empty
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) PopMax() *SortedSetNode[K, SCORE, V] {
x := this.tail
if x != nil {
this.Remove(x.key)
}
return x
}
// Add an element into the sorted set with specific key / value / score.
// if the element is added, this method returns true; otherwise false means updated
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) AddOrUpdate(key K, score SCORE, value V) bool {
var newNode *SortedSetNode[K, SCORE, V] = nil
found := this.dict[key]
if found != nil {
// score does not change, only update value
if found.score == score {
found.Value = value
} else { // score changes, delete and re-insert
this.delete(found.score, found.key)
newNode = this.insertNode(score, key, value)
}
} else {
newNode = this.insertNode(score, key, value)
}
if newNode != nil {
this.dict[key] = newNode
}
return found == nil
}
// Delete element specified by key
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) Remove(key K) *SortedSetNode[K, SCORE, V] {
found := this.dict[key]
if found != nil {
this.delete(found.score, found.key)
return found
}
return nil
}
type GetRangeByScoreOptions struct {
Limit int // limit the max nodes to return
ExcludeStart bool // exclude start value, so it search in interval (start, end] or (start, end)
ExcludeEnd bool // exclude end value, so it search in interval [start, end) or (start, end)
}
// Get the nodes whose score within the specific range
//
// If options is nil, it searchs in interval [start, end] without any limit by default
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) GetRangeByScore(start SCORE, end SCORE, options *GetRangeByScoreOptions) []*SortedSetNode[K, SCORE, V] {
// prepare parameters
var limit int = int((^uint(0)) >> 1)
if options != nil && options.Limit > 0 {
limit = options.Limit
}
excludeStart := options != nil && options.ExcludeStart
excludeEnd := options != nil && options.ExcludeEnd
reverse := start > end
if reverse {
start, end = end, start
excludeStart, excludeEnd = excludeEnd, excludeStart
}
//////////////////////////
var nodes []*SortedSetNode[K, SCORE, V]
//determine if out of range
if this.length == 0 {
return nodes
}
//////////////////////////
if reverse { // search from end to start
x := this.header
if excludeEnd {
for i := this.level - 1; i >= 0; i-- {
for x.level[i].forward != nil &&
x.level[i].forward.score < end {
x = x.level[i].forward
}
}
} else {
for i := this.level - 1; i >= 0; i-- {
for x.level[i].forward != nil &&
x.level[i].forward.score <= end {
x = x.level[i].forward
}
}
}
for x != nil && limit > 0 {
if excludeStart {
if x.score <= start {
break
}
} else {
if x.score < start {
break
}
}
next := x.backward
nodes = append(nodes, x)
limit--
x = next
}
} else {
// search from start to end
x := this.header
if excludeStart {
for i := this.level - 1; i >= 0; i-- {
for x.level[i].forward != nil &&
x.level[i].forward.score <= start {
x = x.level[i].forward
}
}
} else {
for i := this.level - 1; i >= 0; i-- {
for x.level[i].forward != nil &&
x.level[i].forward.score < start {
x = x.level[i].forward
}
}
}
/* Current node is the last with score < or <= start. */
x = x.level[0].forward
for x != nil && limit > 0 {
if excludeEnd {
if x.score >= end {
break
}
} else {
if x.score > end {
break
}
}
next := x.level[0].forward
nodes = append(nodes, x)
limit--
x = next
}
}
return nodes
}
// sanitizeIndexes return start, end, and reverse flag
func (this *SortedSet[K, SCORE, V]) sanitizeIndexes(start int, end int) (int, int, bool) {
if start < 0 {
start = int(this.length) + start + 1
}
if end < 0 {
end = int(this.length) + end + 1
}
if start <= 0 {
start = 1
}
if end <= 0 {
end = 1
}
reverse := start > end
if reverse { // swap start and end
start, end = end, start
}
return start, end, reverse
}
func (this *SortedSet[K, SCORE, V]) findNodeByRank(start int, remove bool) (traversed int, x *SortedSetNode[K, SCORE, V], update [SKIPLIST_MAXLEVEL]*SortedSetNode[K, SCORE, V]) {
x = this.header
for i := this.level - 1; i >= 0; i-- {
for x.level[i].forward != nil &&
traversed+int(x.level[i].span) < start {
traversed += int(x.level[i].span)
x = x.level[i].forward
}
if remove {
update[i] = x
} else {
if traversed+1 == start {
break
}
}
}
return
}
// Get nodes within specific rank range [start, end]
// Note that the rank is 1-based integer. Rank 1 means the first node; Rank -1 means the last node;
//
// If start is greater than end, the returned array is in reserved order
// If remove is true, the returned nodes are removed
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) GetRangeByRank(start int, end int, remove bool) []*SortedSetNode[K, SCORE, V] {
start, end, reverse := this.sanitizeIndexes(start, end)
var nodes []*SortedSetNode[K, SCORE, V]
traversed, x, update := this.findNodeByRank(start, remove)
traversed++
x = x.level[0].forward
for x != nil && traversed <= end {
next := x.level[0].forward
nodes = append(nodes, x)
if remove {
this.deleteNode(x, update)
}
traversed++
x = next
}
if reverse {
for i, j := 0, len(nodes)-1; i < j; i, j = i+1, j-1 {
nodes[i], nodes[j] = nodes[j], nodes[i]
}
}
return nodes
}
// Get node by rank.
// Note that the rank is 1-based integer. Rank 1 means the first node; Rank -1 means the last node;
//
// If remove is true, the returned nodes are removed
// If node is not found at specific rank, nil is returned
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) GetByRank(rank int, remove bool) *SortedSetNode[K, SCORE, V] {
nodes := this.GetRangeByRank(rank, rank, remove)
if len(nodes) == 1 {
return nodes[0]
}
return nil
}
// Get node by key
//
// If node is not found, nil is returned
// Time complexity : O(1)
func (this *SortedSet[K, SCORE, V]) GetByKey(key K) *SortedSetNode[K, SCORE, V] {
return this.dict[key]
}
// Find the rank of the node specified by key
// Note that the rank is 1-based integer. Rank 1 means the first node
//
// If the node is not found, 0 is returned. Otherwise rank(> 0) is returned
//
// Time complexity of this method is : O(log(N))
func (this *SortedSet[K, SCORE, V]) FindRank(key K) int {
var rank int = 0
node := this.dict[key]
if node != nil {
x := this.header
for i := this.level - 1; i >= 0; i-- {
for x.level[i].forward != nil &&
(x.level[i].forward.score < node.score ||
(x.level[i].forward.score == node.score &&
x.level[i].forward.key <= node.key)) {
rank += int(x.level[i].span)
x = x.level[i].forward
}
if x.key == key {
return rank
}
}
}
return 0
}
// IterFuncRangeByRank apply fn to node within specific rank range [start, end]
// or until fn return false
//
// Note that the rank is 1-based integer. Rank 1 means the first node; Rank -1 means the last node;
// If start is greater than end, apply fn in reserved order
// If fn is nil, this function return without doing anything
func (this *SortedSet[K, SCORE, V]) IterFuncRangeByRank(start int, end int, fn func(key K, value V) bool) {
if fn == nil {
return
}
start, end, reverse := this.sanitizeIndexes(start, end)
traversed, x, _ := this.findNodeByRank(start, false)
var nodes []*SortedSetNode[K, SCORE, V]
x = x.level[0].forward
for x != nil && traversed < end {
next := x.level[0].forward
if reverse {
nodes = append(nodes, x)
} else if !fn(x.key, x.Value) {
return
}
traversed++
x = next
}
if reverse {
for i := len(nodes) - 1; i >= 0; i-- {
if !fn(nodes[i].key, nodes[i].Value) {
return
}
}
}
}