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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
use serde::{Deserialize, Serialize};
use crate::ones::One;
use crate::prelude::MaxMin;
use core::ops::{Add, Div, Sub};
#[derive(Clone, Copy, Debug, PartialEq, Default, Deserialize, Serialize)]
/// A struct for more readable code.
pub struct EstimatedUnionCardinalities<F> {
/// The estimated cardinality of the left set.
left_cardinality: F,
/// The estimated cardinality of the right set.
right_cardinality: F,
/// The estimated cardinality of the union of the two sets.
union_cardinality: F,
}
impl<F> From<(F, F, F)> for EstimatedUnionCardinalities<F> {
fn from(value: (F, F, F)) -> Self {
Self {
left_cardinality: value.0,
right_cardinality: value.1,
union_cardinality: value.2,
}
}
}
impl<F: MaxMin + One + Add<F, Output = F> + Sub<F, Output = F> + Div<F, Output = F> + Copy>
EstimatedUnionCardinalities<F>
{
#[inline(always)]
/// Returns the estimated cardinality of the left set.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let left_cardinality = estimated_union_cardinalities.get_left_cardinality();
///
/// assert_eq!(left_cardinality, 2.0);
///
/// ```
pub fn get_left_cardinality(&self) -> F {
self.left_cardinality
}
#[inline(always)]
/// Returns the estimated cardinality of the right set.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let right_cardinality = estimated_union_cardinalities.get_right_cardinality();
///
/// assert_eq!(right_cardinality, 3.0);
///
/// ```
pub fn get_right_cardinality(&self) -> F {
self.right_cardinality
}
#[inline(always)]
/// Returns the estimated cardinality of the union of the two sets.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let union_cardinality = estimated_union_cardinalities.get_union_cardinality();
///
/// assert_eq!(union_cardinality, 4.0);
///
/// ```
pub fn get_union_cardinality(&self) -> F {
self.union_cardinality
}
#[inline(always)]
/// Returns the estimated cardinality of the intersection of the two sets.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let intersection_cardinality = estimated_union_cardinalities.get_intersection_cardinality();
///
/// assert_eq!(intersection_cardinality, 1.0);
///
/// ```
pub fn get_intersection_cardinality(&self) -> F {
self.left_cardinality + self.right_cardinality - self.union_cardinality
}
#[inline(always)]
/// Returns the estimated cardinality of the left set minus the right set.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let left_minus_right_cardinality = estimated_union_cardinalities.get_left_difference_cardinality();
///
/// assert_eq!(left_minus_right_cardinality, 1.0);
///
/// ```
pub fn get_left_difference_cardinality(&self) -> F {
self.union_cardinality - self.right_cardinality
}
#[inline(always)]
/// Returns the estimated cardinality of the right set minus the left set.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let right_minus_left_cardinality = estimated_union_cardinalities.get_right_difference_cardinality();
///
/// assert_eq!(right_minus_left_cardinality, 2.0);
///
/// ```
pub fn get_right_difference_cardinality(&self) -> F {
self.union_cardinality - self.left_cardinality
}
#[inline(always)]
/// Returns the estimated cardinality of the symmetric difference of the two sets.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let symmetric_difference_cardinality = estimated_union_cardinalities.get_symmetric_difference_cardinality();
///
/// assert_eq!(symmetric_difference_cardinality, 3.0);
///
/// ```
pub fn get_symmetric_difference_cardinality(&self) -> F {
self.union_cardinality + self.union_cardinality
- self.left_cardinality
- self.right_cardinality
}
#[inline(always)]
/// Returns the estimated Jaccard index of the two sets.
///
/// # Examples
///
/// ```
/// use hyperloglog_rs::EstimatedUnionCardinalities;
///
/// let estimated_union_cardinalities = EstimatedUnionCardinalities::from((2.0, 3.0, 4.0));
///
/// let jaccard_index = estimated_union_cardinalities.get_jaccard_index();
///
/// assert_eq!(jaccard_index, 1.0 / 4.0, "Example 1: Expected 1.0 / 4.0, got {}", jaccard_index);
///
/// ```
///
pub fn get_jaccard_index(&self) -> F {
(self.get_intersection_cardinality() / self.union_cardinality).get_min(F::ONE)
}
}