rust-lodash 0.1.0

A high-performance, type-safe Rust implementation of Lodash collection methods with zero-cost abstractions
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
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
/*!

Parallel processing extensions for Lodash-RS.

This module provides parallel versions of collection methods using the rayon crate
for automatic parallelization of operations on large datasets.
*/

#[cfg(feature = "parallel")]
use rayon::prelude::*;
#[cfg(feature = "parallel")]
use crate::collection::Collection;
#[cfg(feature = "parallel")]
use crate::utils::{LodashError, Result};

#[cfg(feature = "parallel")]
/// Parallel version of `map`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::extensions::parallel::map_parallel;
/// 
/// let numbers = vec![1, 2, 3, 4, 5];
/// let doubled = map_parallel(&numbers, |x| x * 2);
/// assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
/// ```
pub fn map_parallel<T, U, F>(collection: &[T], iteratee: F) -> Vec<U>
where
    T: Send + Sync,
    U: Send,
    F: Fn(&T) -> U + Sync,
{
    collection.par_iter().map(iteratee).collect()
}

#[cfg(feature = "parallel")]
/// Parallel version of `filter`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::extensions::parallel::filter_parallel;
/// 
/// let numbers = vec![1, 2, 3, 4, 5];
/// let evens = filter_parallel(&numbers, |x| x % 2 == 0);
/// assert_eq!(evens, vec![2, 4]);
/// ```
pub fn filter_parallel<T, F>(collection: &[T], predicate: F) -> Vec<T>
where
    T: Clone + Send + Sync,
    F: Fn(&T) -> bool + Sync,
{
    collection.par_iter()
        .filter(|item| predicate(item))
        .cloned()
        .collect()
}

#[cfg(feature = "parallel")]
/// Parallel version of `reduce`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::extensions::parallel::reduce_parallel;
/// 
/// let numbers = vec![1, 2, 3, 4, 5];
/// let sum = reduce_parallel(&numbers, |acc, x| acc + x, 0);
/// assert_eq!(sum, 15);
/// ```
pub fn reduce_parallel<T, U, F>(collection: &[T], iteratee: F, initial: U) -> U
where
    T: Send + Sync,
    U: Send + Sync,
    F: Fn(U, &T) -> U + Sync,
{
    collection.par_iter().fold(|| initial, |acc, item| iteratee(acc, item)).reduce(|| initial, |a, b| a)
}

#[cfg(feature = "parallel")]
/// Parallel version of `for_each`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::extensions::parallel::for_each_parallel;
/// 
/// let numbers = vec![1, 2, 3, 4, 5];
/// let mut sum = 0;
/// for_each_parallel(&numbers, |x| sum += x);
/// assert_eq!(sum, 15);
/// ```
pub fn for_each_parallel<T, F>(collection: &[T], iteratee: F)
where
    T: Send + Sync,
    F: Fn(&T) + Sync,
{
    collection.par_iter().for_each(iteratee);
}

#[cfg(feature = "parallel")]
/// Parallel version of `find`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::extensions::parallel::find_parallel;
/// 
/// let numbers = vec![1, 2, 3, 4, 5];
/// let first_even = find_parallel(&numbers, |x| x % 2 == 0);
/// assert_eq!(first_even, Some(&2));
/// ```
pub fn find_parallel<T, F>(collection: &[T], predicate: F) -> Option<&T>
where
    T: Send + Sync,
    F: Fn(&T) -> bool + Sync,
{
    collection.par_iter().find_any(|item| predicate(item))
}

#[cfg(feature = "parallel")]
/// Parallel version of `every`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::extensions::parallel::every_parallel;
/// 
/// let numbers = vec![2, 4, 6, 8];
/// let all_even = every_parallel(&numbers, |x| x % 2 == 0);
/// assert!(all_even);
/// ```
pub fn every_parallel<T, F>(collection: &[T], predicate: F) -> bool
where
    T: Send + Sync,
    F: Fn(&T) -> bool + Sync,
{
    collection.par_iter().all(predicate)
}

#[cfg(feature = "parallel")]
/// Parallel version of `some`.
/// 
/// # Examples
/// 
/// ```
/// use rust_lodash::extensions::parallel::some_parallel;
/// 
/// let numbers = vec![1, 3, 5, 7];
/// let has_even = some_parallel(&numbers, |x| x % 2 == 0);
/// assert!(!has_even);
/// ```
pub fn some_parallel<T, F>(collection: &[T], predicate: F) -> bool
where
    T: Send + Sync,
    F: Fn(&T) -> bool + Sync,
{
    collection.par_iter().any(predicate)
}

#[cfg(feature = "parallel")]
/// Collection methods that work on the `Collection` type.
impl<T> Collection<T> {
    /// Parallel version of `map`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let doubled = collection.map_parallel(|x| x * 2);
    /// assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
    /// ```
    pub fn map_parallel<U, F>(&self, iteratee: F) -> Vec<U>
    where
        T: Send + Sync,
        U: Send,
        F: Fn(&T) -> U + Sync,
    {
        map_parallel(&self.data, iteratee)
    }

    /// Parallel version of `filter`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let evens = collection.filter_parallel(|x| x % 2 == 0);
    /// assert_eq!(evens, vec![2, 4]);
    /// ```
    pub fn filter_parallel<F>(&self, predicate: F) -> Vec<T>
    where
        T: Clone + Send + Sync,
        F: Fn(&T) -> bool + Sync,
    {
        filter_parallel(&self.data, predicate)
    }

    /// Parallel version of `reduce`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let sum = collection.reduce_parallel(|acc, x| acc + x, 0);
    /// assert_eq!(sum, 15);
    /// ```
    pub fn reduce_parallel<U, F>(&self, iteratee: F, initial: U) -> U
    where
        T: Send + Sync,
        U: Send + Sync,
        F: Fn(U, &T) -> U + Sync,
    {
        reduce_parallel(&self.data, iteratee, initial)
    }

    /// Parallel version of `for_each`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let mut sum = 0;
    /// collection.for_each_parallel(|x| sum += x);
    /// assert_eq!(sum, 15);
    /// ```
    pub fn for_each_parallel<F>(&self, iteratee: F)
    where
        T: Send + Sync,
        F: Fn(&T) + Sync,
    {
        for_each_parallel(&self.data, iteratee)
    }

    /// Parallel version of `find`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// let collection = Collection::new(vec![1, 2, 3, 4, 5]);
    /// let first_even = collection.find_parallel(|x| x % 2 == 0);
    /// assert_eq!(first_even, Some(&2));
    /// ```
    pub fn find_parallel<F>(&self, predicate: F) -> Option<&T>
    where
        T: Send + Sync,
        F: Fn(&T) -> bool + Sync,
    {
        find_parallel(&self.data, predicate)
    }

    /// Parallel version of `every`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// let collection = Collection::new(vec![2, 4, 6, 8]);
    /// let all_even = collection.every_parallel(|x| x % 2 == 0);
    /// assert!(all_even);
    /// ```
    pub fn every_parallel<F>(&self, predicate: F) -> bool
    where
        T: Send + Sync,
        F: Fn(&T) -> bool + Sync,
    {
        every_parallel(&self.data, predicate)
    }

    /// Parallel version of `some`.
    /// 
    /// # Examples
    /// 
    /// ```
    /// use rust_lodash::collection::Collection;
    /// 
    /// let collection = Collection::new(vec![1, 3, 5, 7]);
    /// let has_even = collection.some_parallel(|x| x % 2 == 0);
    /// assert!(!has_even);
    /// ```
    pub fn some_parallel<F>(&self, predicate: F) -> bool
    where
        T: Send + Sync,
        F: Fn(&T) -> bool + Sync,
    {
        some_parallel(&self.data, predicate)
    }
}

#[cfg(test)]
#[cfg(feature = "parallel")]
mod tests {
    use super::*;

    #[test]
    fn test_map_parallel() {
        let numbers = vec![1, 2, 3, 4, 5];
        let doubled = map_parallel(&numbers, |x| x * 2);
        assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
    }

    #[test]
    fn test_filter_parallel() {
        let numbers = vec![1, 2, 3, 4, 5];
        let evens = filter_parallel(&numbers, |x| x % 2 == 0);
        assert_eq!(evens, vec![2, 4]);
    }

    #[test]
    fn test_reduce_parallel() {
        let numbers = vec![1, 2, 3, 4, 5];
        let sum = reduce_parallel(&numbers, |acc, x| acc + x, 0);
        assert_eq!(sum, 15);
    }

    #[test]
    fn test_for_each_parallel() {
        let numbers = vec![1, 2, 3, 4, 5];
        let mut sum = 0;
        for_each_parallel(&numbers, |x| sum += x);
        assert_eq!(sum, 15);
    }

    #[test]
    fn test_find_parallel() {
        let numbers = vec![1, 2, 3, 4, 5];
        let first_even = find_parallel(&numbers, |x| x % 2 == 0);
        assert_eq!(first_even, Some(&2));
    }

    #[test]
    fn test_every_parallel() {
        let numbers = vec![2, 4, 6, 8];
        let all_even = every_parallel(&numbers, |x| x % 2 == 0);
        assert!(all_even);
    }

    #[test]
    fn test_some_parallel() {
        let numbers = vec![1, 3, 5, 7];
        let has_even = some_parallel(&numbers, |x| x % 2 == 0);
        assert!(!has_even);
    }

    #[test]
    fn test_collection_map_parallel() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let doubled = collection.map_parallel(|x| x * 2);
        assert_eq!(doubled, vec![2, 4, 6, 8, 10]);
    }

    #[test]
    fn test_collection_filter_parallel() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let evens = collection.filter_parallel(|x| x % 2 == 0);
        assert_eq!(evens, vec![2, 4]);
    }

    #[test]
    fn test_collection_reduce_parallel() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let sum = collection.reduce_parallel(|acc, x| acc + x, 0);
        assert_eq!(sum, 15);
    }

    #[test]
    fn test_collection_for_each_parallel() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let mut sum = 0;
        collection.for_each_parallel(|x| sum += x);
        assert_eq!(sum, 15);
    }

    #[test]
    fn test_collection_find_parallel() {
        let collection = Collection::new(vec![1, 2, 3, 4, 5]);
        let first_even = collection.find_parallel(|x| x % 2 == 0);
        assert_eq!(first_even, Some(&2));
    }

    #[test]
    fn test_collection_every_parallel() {
        let collection = Collection::new(vec![2, 4, 6, 8]);
        let all_even = collection.every_parallel(|x| x % 2 == 0);
        assert!(all_even);
    }

    #[test]
    fn test_collection_some_parallel() {
        let collection = Collection::new(vec![1, 3, 5, 7]);
        let has_even = collection.some_parallel(|x| x % 2 == 0);
        assert!(!has_even);
    }

    #[test]
    fn test_empty_collection_parallel() {
        let empty: Vec<i32> = vec![];
        let doubled = map_parallel(&empty, |x| x * 2);
        assert!(doubled.is_empty());

        let evens = filter_parallel(&empty, |x| x % 2 == 0);
        assert!(evens.is_empty());

        let sum = reduce_parallel(&empty, |acc, x| acc + x, 0);
        assert_eq!(sum, 0);

        let first_even = find_parallel(&empty, |x| x % 2 == 0);
        assert_eq!(first_even, None);

        let all_even = every_parallel(&empty, |x| x % 2 == 0);
        assert!(all_even); // vacuous truth

        let has_even = some_parallel(&empty, |x| x % 2 == 0);
        assert!(!has_even); // vacuous false
    }
}