datasketches 0.5.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
56
57
58
59
60
61
62
63
64
65
66
67

// 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.

//! Tuple sketch implementation.
//!
//! A Tuple sketch is an extension of the Theta sketch: in addition to the retained hash values it
//! keeps a user-defined summary associated with every retained key. The hash table mechanics
//! (theta screening, resize, rebuild to the capacity configured by `lg_k`) mirror the Theta sketch,
//! with the added requirement that colliding keys merge their summaries.
//!
//! Custom summary behavior is supplied externally through policy objects: [`SummaryPolicy`]
//! creates summaries, while [`SummaryUpdatePolicy`] folds update values into them. Summaries that
//! implement `Default` and `AddAssign` can use [`DefaultUpdatePolicy`]. Set operations combine the
//! summaries of shared keys through [`SummaryCombinePolicy`]; the union defaults to
//! [`DefaultUnionPolicy`].
//!
//! # Usage
//!
//! ```
//! use datasketches::tuple::DefaultUpdatePolicy;
//! use datasketches::tuple::TupleSketchBuilder;
//!
//! let policy = DefaultUpdatePolicy::<u64>::default();
//! let mut sketch = TupleSketchBuilder::new(policy).build().unwrap();
//! sketch.update("apple", 1_u64);
//! assert!(sketch.estimate() >= 1.0);
//! ```

mod a_not_b;
mod hash_table;
mod intersection;
mod jaccard_similarity;
mod policy;
mod serialization;
mod sketch;
mod union;

pub use self::a_not_b::TupleANotB;
pub use self::hash_table::TupleEntry;
pub use self::intersection::TupleIntersection;
pub use self::jaccard_similarity::TupleJaccardSimilarity;
pub use self::policy::DefaultUnionPolicy;
pub use self::policy::DefaultUpdatePolicy;
pub use self::policy::SummaryCombinePolicy;
pub use self::policy::SummaryPolicy;
pub use self::policy::SummaryUpdatePolicy;
pub use self::serialization::TupleSummaryValue;
pub use self::sketch::CompactTupleSketch;
pub use self::sketch::TupleSketch;
pub use self::sketch::TupleSketchBuilder;
pub use self::sketch::TupleSketchView;
pub use self::union::TupleUnion;
pub use self::union::TupleUnionBuilder;