par_array_init/
lib.rs

1#![deny(
2    missing_docs,
3    missing_debug_implementations,
4    missing_copy_implementations,
5    trivial_casts,
6    trivial_numeric_casts,
7    unstable_features,
8    unused_import_braces,
9    unused_qualifications
10)]
11
12//! The `par_array_init` crate allows you to initialize arrays with an initializer closure that will be called in parallel to fill the array.
13//!
14//! This crate mirrors the api of crate (array-init)[https://crates.io/crates/array-init] with the caveat that initialization is performed in parallel.
15//! An important departure from `array-init`, initialization order is not deterministic and should not be relied on.
16//!
17//! Parallelization is achieved using (rayon)[https://https://crates.io/crates/rayon] and it's `ParallelIterator` api.
18//!
19//! # Examples:
20//! ```rust
21//! # extern crate par_array_init;
22//! # extern crate rayon;
23//! // Initialize an array of length 10 containing successive squares
24//! let arr: [usize; 50] = par_array_init::par_array_init(|i| i * i);
25//!
26//! // Initialize an array from an iterator producing an array filled with 34's
27//! let mut iter = rayon::iter::repeat(34u32).take(50);
28//! let arr: Option<[u32; 50]> = par_array_init::from_par_iter(iter);
29//! ```
30//!
31extern crate array_init;
32extern crate rayon;
33
34use array_init::IsArray;
35use rayon::prelude::{IndexedParallelIterator, IntoParallelIterator, ParallelIterator};
36
37/// Initialize an array given a function from index to element
38pub fn par_array_init<Array, F>(initializer: F) -> Array
39where
40    Array: Send + Sync + IsParArray,
41    F: Send + Sync + Fn(usize) -> Array::Item,
42    Array::Item: Send + Sync + Copy,
43{
44    let elems = (0..Array::len()).into_par_iter().map(|i| initializer(i));
45    // Since our iterator is 0..len here we're safe to unwrap
46    from_par_iter(elems).unwrap()
47}
48
49/// Initialize an array given a parallel iterator.
50///
51/// IndexedParallelIterator is required (as opposed to just ParallelIterator) so we know we have atleast as many elements as array length.
52///
53/// Takes elements from the iterator until the Array is full, returns full array on completion. Returns None if there are not enough elements.
54pub fn from_par_iter<Array, I>(into_iter: I) -> Option<Array>
55where
56    I: IntoParallelIterator<Item = Array::Item>,
57    I::Iter: IndexedParallelIterator<Item = Array::Item>,
58    Array: IsParArray,
59    Array::Item: Copy + Send + Sync,
60{
61    let iter = into_iter.into_par_iter();
62    if Array::len() > iter.len() {
63        return None;
64    }
65    let mut ret: Array = unsafe { std::mem::uninitialized() };
66    ret.mut_slice()
67        .into_par_iter()
68        .zip(iter)
69        .for_each(|(dst, src)| {
70            *dst = src;
71        });
72    Some(ret)
73}
74
75/// Extension of `array_init::IsArray` that includes method to convert the array to a mutable slice.
76/// `&mut [T]` implements parallel iterator so this allows us to write our elements in parallel without having to explicitly pass a `*mut T` across threads.
77pub trait IsParArray: IsArray {
78    /// Convert array to a mutable slice.
79    fn mut_slice(&mut self) -> &mut [Self::Item];
80}
81
82macro_rules! impl_is_par_array {
83    ($($size:expr)+) => ($(
84        impl<T> IsParArray for [T; $size] {
85            fn mut_slice(&mut self) -> &mut [Self::Item] {
86                self.as_mut()
87            }
88        }
89    )+);
90}
91
92// This is like straight up copied from (array-init's impl)[https://github.com/Manishearth/array-init/blob/master/src/lib.rs#L270]
93// let the legacy live on
94impl_is_par_array! {
95     0  1  2  3  4  5  6  7  8  9 10 11 12 13 14 15
96    16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
97    32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
98    48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
99    64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
100    80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95
101    96 97 98 99 100 101 102 103 104 105 106 107 108
102    109 110 111 112 113 114 115 116 117 118 119 120
103    121 122 123 124 125 126 127 128 129 130 131 132
104    133 134 135 136 137 138 139 140 141 142 143 144
105    145 146 147 148 149 150 151 152 153 154 155 156
106    157 158 159 160 161 162 163 164 165 166 167 168
107    169 170 171 172 173 174 175 176 177 178 179 180
108    181 182 183 184 185 186 187 188 189 190 191 192
109    193 194 195 196 197 198 199 200 201 202 203 204
110    205 206 207 208 209 210 211 212 213 214 215 216
111    217 218 219 220 221 222 223 224 225 226 227 228
112    229 230 231 232 233 234 235 236 237 238 239 240
113    241 242 243 244 245 246 247 248 249 250 251 252
114    253 254 255 256 257 258 259 260 261 262 263 264
115    265 266 267 268 269 270 271 272 273 274 275 276
116    277 278 279 280 281 282 283 284 285 286 287 288
117    289 290 291 292 293 294 295 296 297 298 299 300
118    301 302 303 304 305 306 307 308 309 310 311 312
119    313 314 315 316 317 318 319 320 321 322 323 324
120    325 326 327 328 329 330 331 332 333 334 335 336
121    337 338 339 340 341 342 343 344 345 346 347 348
122    349 350 351 352 353 354 355 356 357 358 359 360
123    361 362 363 364 365 366 367 368 369 370 371 372
124    373 374 375 376 377 378 379 380 381 382 383 384
125    385 386 387 388 389 390 391 392 393 394 395 396
126    397 398 399 400 401 402 403 404 405 406 407 408
127    409 410 411 412 413 414 415 416 417 418 419 420
128    421 422 423 424 425 426 427 428 429 430 431 432
129    433 434 435 436 437 438 439 440 441 442 443 444
130    445 446 447 448 449 450 451 452 453 454 455 456
131    457 458 459 460 461 462 463 464 465 466 467 468
132    469 470 471 472 473 474 475 476 477 478 479 480
133    481 482 483 484 485 486 487 488 489 490 491 492
134    493 494 495 496 497 498 499 500 501 502 503 504
135    505 506 507 508 509 510 511 512
136}
137
138#[cfg(test)]
139mod test {
140    use super::*;
141
142    #[test]
143    fn test_array_init_in_parallel_works() {
144        let array: [usize; 10] = par_array_init(|i| i);
145        for (indx, i) in array.iter().enumerate() {
146            assert_eq!(*i, indx)
147        }
148    }
149
150    #[test]
151    fn test_array_init_with_capturing_lambda_works() {
152        let vec = vec![40; 10];
153        let array: [usize; 10] = par_array_init(|i| vec[i]);
154        for i in array.iter() {
155            assert_eq!(*i, 40);
156        }
157    }
158
159    #[test]
160    fn test_from_iter_works() {
161        let vec = vec![1, 2, 3, 4];
162        let array: Option<[usize; 4]> = from_par_iter(vec.into_par_iter());
163        assert_eq!(array, Some([1, 2, 3, 4]));
164    }
165
166    #[test]
167    fn test_from_iter_fails_when_len_is_different() {
168        let vec = vec![1, 2, 3, 4];
169        let array: Option<[usize; 10]> = from_par_iter(vec.into_par_iter());
170        assert_eq!(array, None);
171    }
172
173    #[test]
174    fn test_initialization_works_with_larger_types() {
175        let vec = vec![
176            "A neat string",
177            "A lame string",
178            "A longish string abcdefghijklmnopqrstuvwxyz",
179        ];
180        let array: Option<[&str; 3]> = from_par_iter(vec.into_par_iter());
181        assert_eq!(
182            array,
183            Some([
184                "A neat string",
185                "A lame string",
186                "A longish string abcdefghijklmnopqrstuvwxyz"
187            ])
188        )
189    }
190}
par_array_init/lib.rs

par_array_init/
lib.rs
