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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
use crate::internal::mr::reduce::*; use crate::internal::mr::rvec::RVec; use crate::traits::record::Record; use crate::traits::valid_key::{BorrowedKey, ValidKey}; use crate::types::storage::Storage; use std::collections::HashMap; /// Summarize a `Storage` using a cached multi-layered reduction strategy. /// Repeated evaluations will only re-compute the parts of the reduction that have changed. /// If you've used map-reduce in something like CouchDB, this is a lot like that. /// /// # Type Parameters /// /// * `ChunkKey`: matches the `ChunkKey` of the `Storage`. /// * `Element`: matches the `Element` of the `Storage`. /// * `Summary`: this is the type of the result of summarizing all of the `Elements` in `Storage`. pub struct Reduction<ChunkKey, Element, Summary> where ChunkKey: BorrowedKey + ?Sized, ChunkKey::Owned: ValidKey, { parent_id: u64, group_size: usize, gc_chunk_list: RVec<Option<ChunkKey::Owned>>, rules: ReduceRules<Element, Summary>, chunkwise_reductions: HashMap<ChunkKey::Owned, Reduce<Element, Summary>, crate::internal::hasher::HasherImpl>, chunkwise_summaries: RVec<Summary>, reduction: Reduce<Summary, Summary>, } impl<ChunkKey, Element, Summary> Reduction<ChunkKey, Element, Summary> where ChunkKey: BorrowedKey + ?Sized, ChunkKey::Owned: ValidKey, Summary: Default + Clone, { /// Create a new `Reduction` on a `Storage`. /// /// A `Reduction` is constructed from two rules: `Map` and `Fold` (or reduce). The only /// difference between these rules is that the `Map` rule examines a single element while /// the `Fold` rule examines a list of `Summaries`. Both rules receive a reference to the old /// `Summary`. If the `Summary` has never been evaluated before, then the old `Summary` will be /// Summary::default(). /// /// Each rule constructs a new `Summary`, and if the new `Summary` is different from the old /// `Summary`, returns `Some(new_summary)`. If the `Summary` is unchanged, indicate this by /// returning `None`. /// /// Try to re-use `Reductions` as much as possible. If you drop a `Reduction` and re-create it, /// then the `Reduction`'s internal index has to be rebuilt, which might take a lot of time. /// /// # Type Parameters /// /// * `ItemKey`: this is the `ItemKey` matching the `Storage`. /// * `Map`: this operation produces a `Summary` of a single `Element`. If the result `Summary` /// has not changed since the last `Summary`, return `None`. /// * `Fold`: this operations folds several `Summaries` into one `Summary`. If the result /// `Summary` has not changed since the last `Summary`, return `None`. pub fn new<ItemKey, Map, Fold>( storage: &Storage<ChunkKey, ItemKey, Element>, group_size: usize, map: Map, fold: Fold, ) -> Self where ItemKey: BorrowedKey + ?Sized, ItemKey::Owned: ValidKey, Element: Record<ChunkKey, ItemKey>, Map: Fn(&Element, &Summary) -> Option<Summary> + Clone + Send + Sync + 'static, Fold: Fn(&[Summary], &Summary) -> Option<Summary> + Clone + Send + Sync + 'static, { let chunkwise_summaries = RVec::default(); let reduction = Reduce::new( &chunkwise_summaries, group_size, Self::reduction_rules(map.clone(), fold.clone()), ); Reduction { parent_id: storage.id(), group_size, gc_chunk_list: RVec::default(), rules: Self::chunkwise_rules(map.clone(), fold.clone()), chunkwise_reductions: HashMap::with_hasher( crate::internal::hasher::HasherImpl::default(), ), chunkwise_summaries, reduction, } } fn reduction_rules<Map, Reduce>(_map: Map, reduce: Reduce) -> ReduceRules<Summary, Summary> where Map: Fn(&Element, &Summary) -> Option<Summary> + Clone + Send + Sync + 'static, Reduce: Fn(&[Summary], &Summary) -> Option<Summary> + Clone + Send + Sync + 'static, { let map = reduce.clone(); ReduceRules::new(move |ss, s, _| map(std::slice::from_ref(ss), s), reduce) } fn chunkwise_rules<Map, Reduce>(map: Map, reduce: Reduce) -> ReduceRules<Element, Summary> where Map: Fn(&Element, &Summary) -> Option<Summary> + Clone + Send + Sync + 'static, Reduce: Fn(&[Summary], &Summary) -> Option<Summary> + Clone + Send + Sync + 'static, { ReduceRules::new(move |e, s, _| map(e, s), reduce) } fn gc<ItemKey>(&mut self, parent: &Storage<ChunkKey, ItemKey, Element>) where ItemKey: BorrowedKey + ?Sized, ItemKey::Owned: ValidKey, Element: Record<ChunkKey, ItemKey>, { parent.gc(&mut self.gc_chunk_list, &mut self.chunkwise_reductions); } /// Reduce all of the elements of the given `Storage` down to a single value. /// /// # Example /// /// ``` /// use retriever::prelude::*; /// use std::borrow::Cow; /// use std::collections::HashSet; /// /// #[derive(Clone, Eq, PartialEq)] /// struct Notification { /// user_id: usize, /// id: usize, /// priority: usize, /// msg: String, /// service: &'static str, /// } /// /// #[derive(Clone,Default,Eq,PartialEq)] /// struct NotificationSummary { /// count: usize, /// priority: usize, /// services: HashSet<&'static str>, /// } /// /// impl Record<usize, usize> for Notification { /// fn chunk_key(&self) -> Cow<usize> { /// Cow::Owned(self.user_id) /// } /// /// fn item_key(&self) -> Cow<usize> { /// Cow::Owned(self.id) /// } /// } /// /// impl NotificationSummary { /// fn add_one(&mut self, n: &Notification) { /// self.count += 1; /// self.priority = self.priority.max(n.priority); /// self.services.insert(n.service); /// } /// /// fn add_summary(&mut self, s: &NotificationSummary) { /// self.count += s.count; /// self.priority = self.priority.max(s.priority); /// /// for i in s.services.iter() { /// self.services.insert(*i); /// } /// } /// } /// /// let mut storage : Storage<usize, usize, Notification> = Storage::new(); /// let mut reduction : Reduction<usize, Notification, NotificationSummary> = /// Reduction::new( /// &storage, /// 2, /// |element: &Notification, was: &NotificationSummary| { /// let mut summary = NotificationSummary::default(); /// summary.add_one(element); /// if &summary != was { /// Some(summary) /// } else { /// None /// } /// }, /// |notifications: &[NotificationSummary], was: &NotificationSummary| { /// let mut summary = NotificationSummary::default(); /// /// for n in notifications { /// summary.add_summary(n); /// } /// /// if &summary != was { /// Some(summary) /// } else { /// None /// } /// } /// ); /// /// storage.add(Notification { /// user_id: 1000, /// id: 1, /// priority: 2, /// msg: String::from("You have mail!"), /// service: "mail", /// }); /// /// storage.add(Notification { /// user_id: 1000, /// id: 2, /// priority: 2, /// msg: String::from("New email from Susan."), /// service: "mail", /// }); /// /// storage.add(Notification { /// user_id: 0, /// id: 3, /// priority: 8, /// msg: String::from("Battery low"), /// service: "power", /// }); /// /// storage.add(Notification { /// user_id: 1000, /// id: 4, /// priority: 0, /// msg: String::from("You have won 13 gold coins!!"), /// service: "games", /// }); /// /// let summary = reduction.reduce(&storage).unwrap(); /// /// assert_eq!(summary.count, 4); /// assert_eq!(summary.priority, 8); /// assert!(summary.services.contains("power")); /// assert!(summary.services.contains("mail")); /// assert!(summary.services.contains("games")); ///``` pub fn reduce<ItemKey>( &mut self, storage: &Storage<ChunkKey, ItemKey, Element>, ) -> Option<&Summary> where Element: Record<ChunkKey, ItemKey>, ItemKey: BorrowedKey + ?Sized, ItemKey::Owned: ValidKey, { assert_eq!( self.parent_id, storage.id(), "Id mismatch: a Reduction may only be used with it's parent Storage, never any other Storage" ); self.gc(storage); let chunkwise_reductions = &mut self.chunkwise_reductions; let chunkwise_summaries = &mut self.chunkwise_summaries; let group_size = self.group_size; let rules = &self.rules; chunkwise_summaries.reduce(&self.gc_chunk_list, 1, |chunk_key, _old_summary, idx| { assert!(chunk_key.len() <= 1); if chunk_key.is_empty() { return None; } let chunk_key = chunk_key[0] .as_ref() .cloned() .expect("retriever bug: chunk keys should be defined for all indices after gc"); let internal_storage = storage.internal_rvec()[idx].internal_rvec(); chunkwise_reductions .entry(chunk_key) .or_insert_with(|| Reduce::new(internal_storage, group_size, rules.clone())) .update(&internal_storage) .cloned() }); self.reduction.update(&self.chunkwise_summaries) } /// Reduce all of the elements of a single chunk down to a single value. pub fn reduce_chunk<ItemKey>( &mut self, storage: &Storage<ChunkKey, ItemKey, Element>, chunk_key: &ChunkKey, ) -> Option<&Summary> where Element: Record<ChunkKey, ItemKey>, ItemKey: BorrowedKey + ?Sized, ItemKey::Owned: ValidKey, { assert_eq!( self.parent_id, storage.id(), "Id mismatch: a Reduction may only be used with it's parent Storage, never any other Storage" ); self.gc(storage); let chunkwise_reductions = &mut self.chunkwise_reductions; let group_size = self.group_size; let rules = &self.rules; let idx = storage.internal_idx_of(chunk_key)?; let internal_storage = storage.internal_rvec()[idx].internal_rvec(); chunkwise_reductions .entry(chunk_key.to_owned()) .or_insert_with(|| Reduce::new(internal_storage, group_size, rules.clone())) .update(&internal_storage) } }