libdatasketches_sys 0.1.3

Low-level bindings for Apache DataSketches C++ library
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

//! Low-level FFI bindings for Apache DataSketches C++ library

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]

extern crate libc;

pub use libc::size_t;
use std::os::raw::c_void;

// Include the generated bindings (if available)
// include!(env!("BINDING_PATH"));

// FFI-safe opaque types
#[repr(C)]
pub struct KllFloatSketch(c_void);

#[repr(C)]
pub struct KllDoubleSketch(c_void);

// Re-export the generated functions with proper types
unsafe extern "C" {
    // KLL Float Sketch functions
    pub fn kll_float_sketch_new() -> *mut c_void;
    pub fn kll_float_sketch_new_with_k(k: u16) -> *mut c_void;
    pub fn kll_float_sketch_copy(sketch: *mut c_void) -> *mut c_void;
    pub fn kll_float_sketch_delete(sketch: *mut c_void);

    pub fn kll_float_sketch_update(sketch: *mut c_void, value: f32);
    pub fn kll_float_sketch_merge(sketch: *mut c_void, other: *mut c_void);

    pub fn kll_float_sketch_is_empty(sketch: *mut c_void) -> bool;
    pub fn kll_float_sketch_get_k(sketch: *mut c_void) -> u16;
    pub fn kll_float_sketch_get_n(sketch: *mut c_void) -> u64;
    pub fn kll_float_sketch_get_num_retained(sketch: *mut c_void) -> u32;
    pub fn kll_float_sketch_is_estimation_mode(sketch: *mut c_void) -> bool;

    pub fn kll_float_sketch_get_min_value(sketch: *mut c_void) -> f32;
    pub fn kll_float_sketch_get_max_value(sketch: *mut c_void) -> f32;
    pub fn kll_float_sketch_get_quantile(sketch: *mut c_void, fraction: f64) -> f32;
    pub fn kll_float_sketch_get_rank(sketch: *mut c_void, value: f32) -> f64;

    pub fn kll_float_sketch_serialize(sketch: *mut c_void, size: *mut size_t) -> *mut u8;
    pub fn kll_float_sketch_deserialize(data: *const u8, size: size_t) -> *mut c_void;

    pub fn kll_float_sketch_get_quantiles(
        sketch: *mut c_void,
        fractions: *const f64,
        num_fractions: size_t,
        results: *mut f32,
    );
    pub fn kll_float_sketch_get_quantiles_evenly_spaced(
        sketch: *mut c_void,
        num: u32,
        results: *mut f32,
    );

    // KLL Double Sketch functions
    pub fn kll_double_sketch_new() -> *mut c_void;
    pub fn kll_double_sketch_new_with_k(k: u16) -> *mut c_void;
    pub fn kll_double_sketch_copy(sketch: *mut c_void) -> *mut c_void;
    pub fn kll_double_sketch_delete(sketch: *mut c_void);

    pub fn kll_double_sketch_update(sketch: *mut c_void, value: f64);
    pub fn kll_double_sketch_merge(sketch: *mut c_void, other: *mut c_void);

    pub fn kll_double_sketch_is_empty(sketch: *mut c_void) -> bool;
    pub fn kll_double_sketch_get_k(sketch: *mut c_void) -> u16;
    pub fn kll_double_sketch_get_n(sketch: *mut c_void) -> u64;
    pub fn kll_double_sketch_get_num_retained(sketch: *mut c_void) -> u32;
    pub fn kll_double_sketch_is_estimation_mode(sketch: *mut c_void) -> bool;

    pub fn kll_double_sketch_get_min_value(sketch: *mut c_void) -> f64;
    pub fn kll_double_sketch_get_max_value(sketch: *mut c_void) -> f64;
    pub fn kll_double_sketch_get_quantile(sketch: *mut c_void, fraction: f64) -> f64;
    pub fn kll_double_sketch_get_rank(sketch: *mut c_void, value: f64) -> f64;

    pub fn kll_double_sketch_serialize(sketch: *mut c_void, size: *mut size_t) -> *mut u8;
    pub fn kll_double_sketch_deserialize(data: *const u8, size: size_t) -> *mut c_void;

    pub fn kll_double_sketch_get_quantiles(
        sketch: *mut c_void,
        fractions: *const f64,
        num_fractions: size_t,
        results: *mut f64,
    );
    pub fn kll_double_sketch_get_quantiles_evenly_spaced(
        sketch: *mut c_void,
        num: u32,
        results: *mut f64,
    );
}

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

    #[test]
    fn test_float_sketch_creation() {
        unsafe {
            let sketch = kll_float_sketch_new();
            assert!(!sketch.is_null());
            assert!(kll_float_sketch_is_empty(sketch));
            kll_float_sketch_delete(sketch);
        }
    }

    #[test]
    fn test_double_sketch_creation() {
        unsafe {
            let sketch = kll_double_sketch_new();
            assert!(!sketch.is_null());
            assert!(kll_double_sketch_is_empty(sketch));
            kll_double_sketch_delete(sketch);
        }
    }
}