diskann-quantization 0.51.0

DiskANN is a fast approximate nearest neighbor search library for high dimensional data
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

/*
 * Copyright (c) Microsoft Corporation.
 * Licensed under the MIT license.
 */

//! Utilities to support cancelation of long-running operations.

use std::sync::atomic::{AtomicBool, Ordering};

/// Provides a means for cancelling long-running operations.
///
/// Reasonable implementation of this trait should ensure that once `should_cancel` returns
/// `true`, all future calls to `should_cancel` should **also** return `true`.
pub trait Cancelation {
    fn should_cancel(&self) -> bool;
}

/// A light-weight cancelation token based on an `AtomicBool`.
pub struct AtomicCancelation<'a>(&'a AtomicBool);

impl<'a> AtomicCancelation<'a> {
    pub fn new(val: &'a AtomicBool) -> Self {
        Self(val)
    }
}

impl Cancelation for AtomicCancelation<'_> {
    fn should_cancel(&self) -> bool {
        self.0.load(Ordering::Relaxed)
    }
}

/// A no-op cancelation token.
pub struct DontCancel;

impl Cancelation for DontCancel {
    fn should_cancel(&self) -> bool {
        false
    }
}

///////////
// Tests //
///////////

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_atomic_cancelation() {
        let x = AtomicBool::new(false);
        let y = AtomicCancelation::new(&x);
        assert!(!y.should_cancel());
        x.store(true, Ordering::Relaxed);
        assert!(y.should_cancel());
    }

    #[test]
    fn test_no_cancelation() {
        let x = DontCancel;
        assert!(!x.should_cancel());
    }
}