zset 0.1.17

High-performance, thread-safe sorted set for Rust, inspired by Redis ZSET. / 高性能、线程安全的 Rust 排序集,灵感源自 Redis ZSET。
Documentation
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
use std::{
  sync::{Arc, Barrier},
  thread,
};

use ordered_float::OrderedFloat;
use zset::{Api, Zset};

#[test]
fn test_add_and_len() {
  // Test adding new elements and checking leninality.
  // 测试添加新元素和检查基数。
  let zset = Zset::<&str, &str, i32>::new();
  assert!(!zset.add("one", 1));
  assert_eq!(zset.len(), 1);
  assert!(!zset.add("two", 2));
  assert_eq!(zset.len(), 2);
  // Test updating an existing element.
  // 测试更新现有元素。
  assert!(zset.add("one", 10));
  assert_eq!(zset.len(), 2);
  // After update, "two" has score 2 (rank 0), "one" has score 10 (rank 1)
  // 更新后,"two" 的分数是 2 (排名 0),"one" 的分数是 10 (排名 1)
  assert_eq!(zset.get(0).map(|v| *v), Some("two"));
  assert_eq!(
    zset.get_with_score(0).map(|(m, s)| (*m, s)),
    Some(("two", 2))
  );
  assert_eq!(zset.get(1).map(|v| *v), Some("one"));
  assert_eq!(
    zset.get_with_score(1).map(|(m, s)| (*m, s)),
    Some(("one", 10))
  );
}

#[test]
fn test_rm() {
  // Test removing elements.
  // 测试移除元素。
  let zset: Zset<&str, &str, i32> = Zset::new();
  zset.add("one", 1);
  zset.add("two", 2);
  assert!(zset.rm(&"one"));
  assert_eq!(zset.len(), 1);
  assert_eq!(zset.score(&"one"), None);
  // Test removing a non-existent element.
  // 测试移除不存在的元素。
  assert!(!zset.rm(&"three"));
  assert_eq!(zset.len(), 1);
}

#[test]
fn test_score_and_rank() {
  // Test getting score and rank.
  // 测试获取分数和排名。
  let zset: Zset<&str, &str, i32> = Zset::new();
  zset.add("one", 10);
  zset.add("two", 20);
  zset.add("three", 30);

  assert_eq!(zset.score(&"two"), Some(20));
  assert_eq!(zset.score(&"non-existent"), None);

  // Ranks are 0-based.
  // 排名是 0-based 的。
  assert_eq!(zset.rank(&"one"), Some(0));
  assert_eq!(zset.rank(&"two"), Some(1));
  assert_eq!(zset.rank(&"three"), Some(2));
  assert_eq!(zset.rank(&"non-existent"), None);

  // Test rank after score update.
  // 测试分数更新后的排名。
  zset.add("one", 40);
  assert_eq!(zset.rank(&"two"), Some(0));
  assert_eq!(zset.rank(&"three"), Some(1));
  assert_eq!(zset.rank(&"one"), Some(2));
}

#[test]
fn test_range() {
  // Test getting ranges of elements.
  // 测试获取元素范围。
  let zset: Zset<&str, &str, i32> = Zset::new();
  zset.add("c", 3);
  zset.add("d", 4);
  zset.add("e", 5);
  zset.add("a", 1);
  zset.add("b", 2);

  // Test various ranges.
  // 测试不同范围。
  let r: Vec<&str> = zset.range(0..3).iter().map(|v| **v).collect();
  assert_eq!(r, vec!["a", "b", "c"]);
  let r: Vec<&str> = zset.range(2..5).iter().map(|v| **v).collect();
  assert_eq!(r, vec!["c", "d", "e"]);
  let r: Vec<&str> = zset.range(0..zset.len()).iter().map(|v| **v).collect();
  assert_eq!(r, vec!["a", "b", "c", "d", "e"]);

  // Test RangeBounds
  let r: Vec<&str> = zset.range(..3).iter().map(|v| **v).collect();
  assert_eq!(r, vec!["a", "b", "c"]);
  let r: Vec<&str> = zset.range(2..).iter().map(|v| **v).collect();
  assert_eq!(r, vec!["c", "d", "e"]);
  let r: Vec<&str> = zset.range(..).iter().map(|v| **v).collect();
  assert_eq!(r, vec!["a", "b", "c", "d", "e"]);
  let r: Vec<&str> = zset.range(1..=3).iter().map(|v| **v).collect();
  assert_eq!(r, vec!["b", "c", "d"]);

  // Test out of bounds ranges.
  // 测试超出边界的范围。
  assert!(zset.range(5..10).is_empty());
  assert!(zset.range(10..12).is_empty());
  assert!(zset.range(3..3).is_empty());
}

#[test]
fn test_range_with_scores() {
  // Test getting ranges with scores.
  // 测试获取带分数的范围。
  let zset: Zset<&str, &str, i32> = Zset::new();
  zset.add("a", 1);
  zset.add("b", 2);
  zset.add("c", 3);

  let expected = vec![("a", 1), ("b", 2), ("c", 3)];
  let r: Vec<(&str, i32)> = zset
    .range_with_scores(0..3)
    .iter()
    .map(|(m, s)| (**m, *s))
    .collect();
  assert_eq!(r, expected);
  let r: Vec<(&str, i32)> = zset
    .range_with_scores(0..zset.len())
    .iter()
    .map(|(m, s)| (**m, *s))
    .collect();
  assert_eq!(r, expected);

  let expected_subset = vec![("b", 2), ("c", 3)];
  let r: Vec<(&str, i32)> = zset
    .range_with_scores(1..3)
    .iter()
    .map(|(m, s)| (**m, *s))
    .collect();
  assert_eq!(r, expected_subset);
}

#[test]
fn test_rm_range_by_rank() {
  // Test removing elements by rank range.
  // 按排名范围测试删除元素。
  let zset: Zset<&str, &str, i32> = Zset::new();
  zset.add("a", 1);
  zset.add("b", 2);
  zset.add("c", 3);
  zset.add("d", 4);
  zset.add("e", 5);

  // Remove "c" and "d" (ranks 2 and 3)
  // 删除 "c" 和 "d" (排名 2 和 3)
  assert_eq!(zset.rm_range_by_rank(2..4), 2);
  assert_eq!(zset.len(), 3);
  assert_eq!(zset.score(&"c"), None);
  assert_eq!(zset.score(&"d"), None);
  assert_eq!(zset.rank(&"a"), Some(0));
  assert_eq!(zset.rank(&"b"), Some(1));
  assert_eq!(zset.rank(&"e"), Some(2));

  // Reset zset
  zset.rm_range_by_rank(..);
  assert_eq!(zset.len(), 0);
  zset.add("a", 1);
  zset.add("b", 2);
  zset.add("c", 3);
  zset.add("d", 4);
  zset.add("e", 5);

  // Test with other RangeBounds
  // 使用其他 RangeBounds 进行测试
  // Remove "a", "b" (ranks 0, 1)
  assert_eq!(zset.rm_range_by_rank(..2), 2);
  assert_eq!(zset.len(), 3);
  assert_eq!(zset.score(&"a"), None);
  assert_eq!(zset.score(&"b"), None);

  // Remove "e" (rank 2, originally 4)
  assert_eq!(zset.rm_range_by_rank(2..), 1);
  assert_eq!(zset.len(), 2);
  assert_eq!(zset.score(&"e"), None);

  // Remove "c", "d"
  assert_eq!(zset.rm_range_by_rank(..), 2);
  assert_eq!(zset.len(), 0);

  // Test inclusive range
  zset.add("a", 1);
  zset.add("b", 2);
  zset.add("c", 3);
  assert_eq!(zset.rm_range_by_rank(0..=1), 2);
  assert_eq!(zset.len(), 1);
  assert_eq!(zset.score(&"c"), Some(3));
}

#[test]
fn test_concurrent_add() {
  // Test concurrent additions from multiple threads.
  // 测试多线程并发添加。
  let zset: Arc<Zset<String, String, i32>> = Arc::new(Zset::new());
  let barrier = Arc::new(Barrier::new(10));
  let mut handles = vec![];

  for i in 0..10 {
    let zset_clone = zset.clone();
    let barrier_clone = barrier.clone();
    handles.push(thread::spawn(move || {
      let member = format!("member-{}", i);
      let score = i as i32;
      barrier_clone.wait();
      // Move the String into the zset, making M = String
      // 将 String 移入 zset,使 M = String
      zset_clone.add(member, score);
    }));
  }

  for handle in handles {
    handle.join().unwrap();
  }

  assert_eq!(zset.len(), 10);
  for i in 0..10 {
    let member = format!("member-{}", i);
    // Pass a &String to score and rank
    // 向 score 和 rank 传递 &String
    assert_eq!(zset.score(&member), Some(i as i32));
    assert_eq!(zset.rank(&member), Some(i));
  }
}

#[test]
fn test_concurrent_add_rm() {
  // Test concurrent additions and removals.
  // 测试并发添加和删除。
  let zset: Arc<Zset<String, String, i64>> = Arc::new(Zset::new());
  let barrier = Arc::new(Barrier::new(100));

  // Add 100 elements concurrently.
  // 并发添加 100 个元素。
  let mut handles = vec![];
  for i in 0..100 {
    let zset_clone = zset.clone();
    let barrier_clone = barrier.clone();
    handles.push(thread::spawn(move || {
      barrier_clone.wait();
      zset_clone.add(i.to_string(), i as i64);
    }));
  }
  for handle in handles {
    handle.join().unwrap();
  }
  assert_eq!(zset.len(), 100);

  // Concurrently rm even-numbered elements.
  // 并发删除偶数元素。
  let barrier = Arc::new(Barrier::new(50));
  let mut handles = vec![];
  for i in (0..100).filter(|&x| x % 2 == 0) {
    let zset_clone = zset.clone();
    let barrier_clone = barrier.clone();
    handles.push(thread::spawn(move || {
      barrier_clone.wait();
      zset_clone.rm(&i.to_string());
    }));
  }
  for handle in handles {
    handle.join().unwrap();
  }

  // Only odd-numbered elements should remain.
  // 应该只剩下奇数元素。
  assert_eq!(zset.len(), 50);
  assert_eq!(zset.score(&"49".to_string()), Some(49));
  assert_eq!(zset.score(&"50".to_string()), None);
}

#[test]
fn test_float_scores() {
  // Test Zset with floating-point scores.
  // 测试使用浮点数分数的 Zset。
  let zset = Zset::<&str, &str, OrderedFloat<f64>>::new();
  zset.add("one", OrderedFloat(1.5));
  zset.add("two", OrderedFloat(2.5));
  zset.add("neg_one", OrderedFloat(-1.0));
  zset.add("zero", OrderedFloat(0.0));

  assert_eq!(zset.len(), 4);

  // Check scores.
  // 检查分数。
  assert_eq!(zset.score(&"two"), Some(OrderedFloat(2.5)));

  // Check ranks (low to high).
  // 检查排名(从低到高)。
  assert_eq!(zset.rank(&"neg_one"), Some(0));
  assert_eq!(zset.rank(&"zero"), Some(1));
  assert_eq!(zset.rank(&"one"), Some(2));
  assert_eq!(zset.rank(&"two"), Some(3));

  let expected_range = vec!["neg_one", "zero", "one", "two"];
  let r: Vec<&str> = zset.range(0..zset.len()).iter().map(|v| **v).collect();
  assert_eq!(r, expected_range);

  // Check range with scores.
  // 检查带分数的范围。
  let expected_range_with_scores = vec![
    ("neg_one", OrderedFloat(-1.0)),
    ("zero", OrderedFloat(0.0)),
    ("one", OrderedFloat(1.5)),
    ("two", OrderedFloat(2.5)),
  ];
  let r: Vec<(&str, OrderedFloat<f64>)> = zset
    .range_with_scores(0..zset.len())
    .iter()
    .map(|(m, s)| (**m, *s))
    .collect();
  assert_eq!(r, expected_range_with_scores);
}

#[test]
fn test_operators() {
  // Test union
  // 测试并集
  let zset1: Zset<String, String, i32> = Zset::new();
  zset1.add("a".to_string(), 1);
  zset1.add("b".to_string(), 2);

  let zset2: Zset<String, String, i32> = Zset::new();
  zset2.add("b".to_string(), 3);
  zset2.add("c".to_string(), 4);

  let zset_union = &zset1 | &zset2;
  assert_eq!(zset_union.len(), 3);
  assert_eq!(zset_union.score(&"a".to_string()), Some(1));
  assert_eq!(zset_union.score(&"b".to_string()), Some(5)); // 2 + 3
  assert_eq!(zset_union.score(&"c".to_string()), Some(4));

  // Test union-assign
  // 测试并集赋值
  let mut zset1_for_assign: Zset<String, String, i32> = Zset::new();
  zset1_for_assign.add("a".to_string(), 1);
  zset1_for_assign.add("b".to_string(), 2);
  zset1_for_assign |= &zset2;
  assert_eq!(zset1_for_assign.len(), 3);
  assert_eq!(zset1_for_assign.score(&"a".to_string()), Some(1));
  assert_eq!(zset1_for_assign.score(&"b".to_string()), Some(5));
  assert_eq!(zset1_for_assign.score(&"c".to_string()), Some(4));

  // Test intersection
  // 测试交集
  let zset_intersection = &zset1 & &zset2;
  assert_eq!(zset_intersection.len(), 1);
  assert_eq!(zset_intersection.score(&"b".to_string()), Some(5)); // 2 + 3

  // Test intersection-assign
  // 测试交集赋值
  let mut zset1_for_assign2: Zset<String, String, i32> = Zset::new();
  zset1_for_assign2.add("a".to_string(), 1);
  zset1_for_assign2.add("b".to_string(), 2);
  zset1_for_assign2 &= &zset2;
  assert_eq!(zset1_for_assign2.len(), 1);
  assert_eq!(zset1_for_assign2.score(&"b".to_string()), Some(5));
  assert_eq!(zset1_for_assign2.score(&"a".to_string()), None);
}

#[test]
fn test_is_empty_and_len() {
  let zset = Zset::<&str, &str, i32>::new();
  assert!(zset.is_empty());
  assert_eq!(zset.len(), 0);

  zset.add("one", 1);
  assert!(!zset.is_empty());
  assert_eq!(zset.len(), 1);

  zset.rm(&"one");
  assert!(zset.is_empty());
  assert_eq!(zset.len(), 0);
}

#[test]
#[cfg(feature = "card")]
fn test_card() {
  // Test the card alias for len.
  // 测试 len 的别名 card。
  let zset = Zset::<&str, &str, i32>::new();
  zset.add("one", 1);
  zset.add("two", 2);
  assert_eq!(zset.card(), 2);
  assert_eq!(zset.card(), zset.len());
  zset.rm(&"one");
  assert_eq!(zset.card(), 1);
}

#[test]
#[ignore] // This test is slow and is meant for stress testing.
fn test_concurrent_stress() {
  use rand::Rng;

  let zset: Arc<Zset<String, String, i32>> = Arc::new(Zset::new());
  let num_threads = 50;
  let num_ops_per_thread = 1000;
  let member_space = 1000;

  let mut handles = vec![];

  for _ in 0..num_threads {
    let zset_clone = zset.clone();
    handles.push(thread::spawn(move || {
      let mut rng = rand::rng();
      for _ in 0..num_ops_per_thread {
        let op = rng.random_range(0..5);
        let member = rng.random_range(0..member_space).to_string();

        match op {
          0 => {
            let score = rng.random_range(0..10000);
            zset_clone.add(member, score);
          }
          1 => {
            zset_clone.rm(&member);
          }
          2 => {
            zset_clone.rank(&member);
          }
          3 => {
            zset_clone.score(&member);
          }
          4 => {
            let len = zset_clone.len();
            if len > 0 {
              let start = rng.random_range(0..len);
              let end = rng.random_range(start..=len);
              zset_clone.range(start..end);
            }
          }
          _ => unreachable!(),
        }
      }
    }));
  }
  for handle in handles {
    handle.join().unwrap();
  }
}