datasketches 0.3.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
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

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

//! Naturally extended integer hash value wrappers.
//!
//! [`NaturalExtend`] first widens signed values to `i64` and unsigned values to `u64`, and then
//! hashes the resulting integers.
//!
//! This strategy is the same as how datasketches-cpp hashes short integers for `BloomFilter`.

use std::hash::Hash;
use std::hash::Hasher;

use super::value::HashStrategy;
use super::value::Value;

/// An integer value wrapper that uses Rust's natural integer widening before hashing.
///
/// See the [module level documentation](super) for more.
pub type NaturalExtend<T> = Value<T, NaturalExtendStrategy>;

/// Hashing strategy for [`NaturalExtend`].
#[doc(hidden)]
pub struct NaturalExtendStrategy;

/// Create a naturally extended hashable value from an `i8` value.
///
/// # Examples
///
/// ```
/// # use datasketches::hash_value::calculate_hash;
/// # use datasketches::hash_value::natural_extend::from_i8;
/// assert_eq!(calculate_hash(from_i8(-1)), calculate_hash(-1i64));
/// assert_eq!(calculate_hash(from_i8(42)), calculate_hash(42i64));
/// ```
pub fn from_i8(v: i8) -> NaturalExtend<i8> {
    NaturalExtend::new(v)
}

/// Create a naturally extended hashable value from a `u8` value.
///
/// # Examples
///
/// ```
/// # use datasketches::hash_value::calculate_hash;
/// # use datasketches::hash_value::natural_extend::from_u8;
/// assert_eq!(calculate_hash(from_u8(255)), calculate_hash(255u64));
/// assert_eq!(calculate_hash(from_u8(42)), calculate_hash(42u64));
/// ```
pub fn from_u8(v: u8) -> NaturalExtend<u8> {
    NaturalExtend::new(v)
}

/// Create a naturally extended hashable value from an `i16` value.
///
/// # Examples
///
/// ```
/// # use datasketches::hash_value::calculate_hash;
/// # use datasketches::hash_value::natural_extend::from_i16;
/// assert_eq!(calculate_hash(from_i16(-1)), calculate_hash(-1i64));
/// assert_eq!(calculate_hash(from_i16(42)), calculate_hash(42i64));
/// ```
pub fn from_i16(v: i16) -> NaturalExtend<i16> {
    NaturalExtend::new(v)
}

/// Create a naturally extended hashable value from a `u16` value.
///
/// # Examples
///
/// ```
/// # use datasketches::hash_value::calculate_hash;
/// # use datasketches::hash_value::natural_extend::from_u16;
/// assert_eq!(calculate_hash(from_u16(65535)), calculate_hash(65535u64));
/// assert_eq!(calculate_hash(from_u16(42)), calculate_hash(42u64));
/// ```
pub fn from_u16(v: u16) -> NaturalExtend<u16> {
    NaturalExtend::new(v)
}

/// Create a naturally extended hashable value from an `i32` value.
///
/// # Examples
///
/// ```
/// # use datasketches::hash_value::calculate_hash;
/// # use datasketches::hash_value::natural_extend::from_i32;
/// assert_eq!(calculate_hash(from_i32(-1)), calculate_hash(-1i64));
/// assert_eq!(calculate_hash(from_i32(42)), calculate_hash(42i64));
/// ```
pub fn from_i32(v: i32) -> NaturalExtend<i32> {
    NaturalExtend::new(v)
}

/// Create a naturally extended hashable value from a `u32` value.
///
/// # Examples
///
/// ```
/// # use datasketches::hash_value::calculate_hash;
/// # use datasketches::hash_value::natural_extend::from_u32;
/// assert_eq!(
///     calculate_hash(from_u32(4294967295)),
///     calculate_hash(4294967295u64)
/// );
/// assert_eq!(calculate_hash(from_u32(42)), calculate_hash(42u64));
/// ```
pub fn from_u32(v: u32) -> NaturalExtend<u32> {
    NaturalExtend::new(v)
}

macro_rules! impl_natural_extend {
    ($t:ty, |$v:ident| $extended:expr) => {
        impl HashStrategy<$t> for NaturalExtendStrategy {
            fn hash<H: Hasher>(value: &$t, state: &mut H) {
                let $v = *value;
                let extended = $extended;
                extended.hash(state);
            }
        }
    };
}

impl_natural_extend!(i8, |v| v as i64);
impl_natural_extend!(u8, |v| v as u64);
impl_natural_extend!(i16, |v| v as i64);
impl_natural_extend!(u16, |v| v as u64);
impl_natural_extend!(i32, |v| v as i64);
impl_natural_extend!(u32, |v| v as u64);