datasketches 0.4.0

A software library of stochastic streaming algorithms (a.k.a. sketches)
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

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

//! Data structures and functions that may be used across all the Theta sketch family.

pub(super) mod a_not_b;
pub(super) mod binomial_bounds;
pub(super) mod constants;
pub(super) mod hash_table;
pub(super) mod intersection;
pub(super) mod jaccard_similarity;
pub(super) mod union;

pub use self::jaccard_similarity::JaccardSimilarity;

/// Minimal entry behavior required by the shared hash table and set operations.
pub(super) trait SketchEntry {
    fn hash(&self) -> u64;
}

pub(super) trait KeySketch: Copy {
    fn scalars(self) -> SketchScalars;

    fn hashes(self) -> impl Iterator<Item = u64>;
}

pub(super) trait EntrySketch: KeySketch {
    type Entry: SketchEntry;

    fn entries(self) -> impl Iterator<Item = Self::Entry>;
}

/// Scalar sketch values inspected by Theta-family set operations.
#[derive(Clone, Copy, Debug)]
pub(super) struct SketchScalars {
    pub seed_hash: u16,
    pub theta: u64,
    pub empty: bool,
    pub ordered: bool,
    pub num_retained: usize,
}