rayon

chore: Release rayon version 1.12.0

• Fixed a bug in parallel Range<char> when the end is 0xE000, just past the surrogate boundary, which was unsafely producing invalid char values.
• The new method ParallelSlice::par_array_windows works like par_windows but with a constant length, producing &[T; N] items.

• The minimum supported rustc is now 1.59.
• Added a fallback when threading is unsupported.
• The new ParallelIterator::take_any and skip_any methods work like unordered IndexedParallelIterator::take and skip, counting items in whatever order they are visited in parallel.
• The new ParallelIterator::take_any_while and skip_any_while methods work like unordered Iterator::take_while and skip_while, which previously had no parallel equivalent. The "while" condition may be satisfied from anywhere in the parallel iterator, affecting all future items regardless of position.
• The new yield_now and yield_local functions will cooperatively yield execution to Rayon, either trying to execute pending work from the entire pool or from just the local deques of the current thread, respectively.

• The new methods ParallelSlice::par_chunk_by and ParallelSliceMut::par_chunk_by_mut work like the slice methods chunk_by and chunk_by_mut added in Rust 1.77.

chore: Release rayon version 1.9.0

• The new methods IndexedParallelIterator::by_exponential_blocks and by_uniform_blocks allow processing items in smaller groups at a time.
• The new iter::walk_tree, walk_tree_prefix, and walk_tree_postfix functions enable custom parallel iteration over tree-like structures.
• The new method ParallelIterator::collect_vec_list returns items as a linked list of vectors, which is an efficient mode of parallel collection used by many of the internal implementations of collect.
• The new methods ParallelSliceMut::par_split_inclusive_mut, ParallelSlice::par_split_inclusive, and ParallelString::par_split_inclusive all work like a normal split but keeping the separator as part of the left slice.
• The new ParallelString::par_split_ascii_whitespace splits only on ASCII whitespace, which is faster than including Unicode multi-byte whitespace.
• OsString now implements FromParallelIterator<_> and ParallelExtend<_> for a few item types similar to the standard FromIterator and Extend.
• The internal Pattern trait for string methods is now implemented for [char; N] and &[char; N], matching any of the given characters.

chore: Release rayon version 1.8.1

• Fixed an overflow panic on high-contention workloads, for a counter that was meant to simply wrap. This panic only occurred with debug assertions enabled, and was much more likely on 32-bit targets.

chore: Release rayon version 1.8.0

• Implemented a new thread scheduler, RFC 5, which uses targeted wakeups for new work and for notifications of completed stolen work, reducing wasteful CPU usage in idle threads.
• Implemented IntoParallelIterator for Range<char> and RangeInclusive<char> with the same iteration semantics as Rust 1.45.
• Relaxed the lifetime requirements of the initial scope closure.

Contributors

Thanks to all of the contributors for this release!

• @CAD97
• @cuviper
• @kmaork
• @nikomatsakis
• @SuperFluffy

chore: Release rayon version 1.7.0

• Tuples up to length 12 now implement IntoParallelIterator, creating a MultiZip iterator that produces items as similarly-shaped tuples.
• The --cfg=rayon_unstable supporting code for rayon-futures is removed.
• The minimum supported rustc is now 1.31.

Contributors

Thanks to all of the contributors for this release!

• @cuviper
• @c410-f3r
• @silwol

• Simplified par_bridge to only pull one item at a time from the iterator, without batching. Threads that are waiting for iterator items will now block appropriately rather than spinning CPU. (Thanks @njaard!)
• Added protection against recursion in par_bridge, so iterators that also invoke rayon will not cause mutex recursion deadlocks.

• The new ParallelIterator::copied() converts an iterator of references into copied values, like Iterator::copied().
• ParallelExtend is now implemented for the unit ().
• Internal updates were made to improve test determinism, reduce closure type sizes, reduce task allocations, and update dependencies.
• The minimum supported rustc is now 1.28.

Contributors

Thanks to all of the contributors for this release!

• @Aaron1011
• @cuviper
• @ralfbiedert

• The new ParallelSliceMut::par_sort_by_cached_key is a stable sort that caches the keys for each item -- a parallel version of slice::sort_by_cached_key.

• FIFO spawns are now supported using the new spawn_fifo() and scope_fifo() global functions, and their corresponding ThreadPool methods.
  • Normally when tasks are queued on a thread, the most recent is processed first (LIFO) while other threads will steal the oldest (FIFO). With FIFO spawns, those tasks are processed locally in FIFO order too.
  • Regular spawns and other tasks like join are not affected.
  • The breadth_first configuration flag, which globally approximated this effect, is now deprecated.
  • For more design details, please see RFC 1.
• ThreadPoolBuilder can now take a custom spawn_handler to control how threads will be created in the pool.
  • ThreadPoolBuilder::build_scoped() uses this to create a scoped thread pool, where the threads are able to use non-static data.
  • This may also be used to support threading in exotic environments, like WebAssembly, which don't support the normal std::thread.
• ParallelIterator has 3 new methods: find_map_any(), find_map_first(), and find_map_last(), like Iterator::find_map() with ordering constraints.
• The new ParallelIterator::panic_fuse() makes a parallel iterator halt as soon as possible if any of its threads panic. Otherwise, the panic state is not usually noticed until the iterator joins its parallel tasks back together.
• IntoParallelIterator is now implemented for integral RangeInclusive.
• Several internal Folders now have optimized consume_iter implementations.
• rayon_core::current_thread_index() is now re-exported in rayon.
• The minimum rustc is now 1.26, following the update policy defined in RFC 3.

Contributors

Thanks to all of the contributors for this release!

• @cuviper
• @didroe
• @GuillaumeGomez
• @huonw
• @janriemer
• @kornelski
• @nikomatsakis
• @seanchen1991
• @yegeun542

• The new flat_map_iter and flatten_iter methods can be used to flatten sequential iterators, which may perform better in cases that don't need the nested parallelism of flat_map and flatten.
• The new par_drain method is a parallel version of the standard drain for collections, removing items while keeping the original capacity. Collections that implement this through ParallelDrainRange support draining items from arbitrary index ranges, while ParallelDrainFull always drains everything.
• The new positions method finds all items that match the given predicate and returns their indices in a new iterator.

• ParallelIterator added the update method which applies a function to mutable references, inspired by itertools.
• IndexedParallelIterator added the chunks method which yields vectors of consecutive items from the base iterator, inspired by itertools.
• String now implements FromParallelIterator<Cow<str>> and ParallelExtend<Cow<str>>, inspired by std.
• () now implements FromParallelIterator<()>, inspired by std.
• The new ThreadPoolBuilder replaces and deprecates Configuration.
  • Errors from initialization now have the concrete ThreadPoolBuildError type, rather than Box<Error>, and this type implements Send and Sync.
  • ThreadPool::new is deprecated in favor of ThreadPoolBuilder::build.
  • initialize is deprecated in favor of ThreadPoolBuilder::build_global.
• Examples have been added to most of the parallel iterator methods.
• A lot of the documentation has been reorganized and extended.

Breaking changes

• Rayon now requires rustc 1.13 or greater.
• IndexedParallelIterator::len and ParallelIterator::opt_len now operate on &self instead of &mut self.
• IndexedParallelIterator::collect_into is now collect_into_vec.
• IndexedParallelIterator::unzip_into is now unzip_into_vecs.
• Rayon no longer exports the deprecated Configuration and initialize from rayon-core.

Contributors

Thanks to all of the contributors for this release!

• @Bilkow
• @cuviper
• @Enet4
• @ignatenkobrain
• @iwillspeak
• @jeehoonkang
• @jwass
• @Kerollmops
• @KodrAus
• @kornelski
• @MaloJaffre
• @nikomatsakis
• @obv-mikhail
• @oddg
• @phimuemue
• @stjepang
• @tmccombs
• bors[bot]

• The following core APIs are being stabilized:
  • rayon::spawn() -- spawns a task into the Rayon thread pool; as it is contained in the global scope (rather than a user-created scope), the task cannot capture anything from the current stack frame.
  • ThreadPool::join(), ThreadPool::spawn(), ThreadPool::scope() -- convenience APIs for launching new work within a thread pool.
• The various iterator adapters are now tagged with #[must_use]
• Parallel iterators now offer a for_each_with adapter, similar to map_with.
• We are adopting a new approach to handling the remaining unstable APIs (which primarily pertain to futures integration). As awlays, unstable APIs are intended for experimentation, but do not come with any promise of compatibility (in other words, we might change them in arbitrary ways in any release). Previously, we designated such APIs using a Cargo feature "unstable". Now, we are using a regular #[cfg] flag. This means that to see the unstable APIs, you must do RUSTFLAGS='--cfg rayon_unstable' cargo build. This is intentionally inconvenient; in particular, if you are a library, then your clients must also modify their environment, signaling their agreement to instability.

Rayon 0.8.0

• Added the map_with and fold_with combinators, which help for passing along state (like channels) that cannot be shared between threads but which can be cloned on each thread split.
• Added the while_some combinator, which helps for writing short-circuiting iterators.
• Added support for "short-circuiting" collection: e.g., collecting from an iterator producing Option<T> or Result<T, E> into a Option<Collection<T>> or Result<Collection<T>, E>.
• Support FromParallelIterator for Cow.
• Removed the deprecated weight APIs.
• Simplified the parallel iterator trait hierarchy by removing the BoundedParallelIterator and ExactParallelIterator traits, which were not serving much purpose.
• Improved documentation.
• Added some missing Send impls.
• Fixed some small bugs.

Rayon-core 1.1.0

• We now have more documentation.
• Renamed the (unstable) methods spawn_async and spawn_future_async -- which spawn tasks that cannot hold references -- to simply spawn and spawn_future, respectively.
• We are now using the coco library for our deque.
• Individual thread pools can now be configured in "breadth-first" mode, which causes them to execute spawned tasks in the reverse order that they used to. In some specific scenarios, this can be a win (though it is not generally the right choice).
• Added top-level functions:
  • current_thread_index, for querying the index of the current worker thread within its thread pool (previously available as thread_pool.current_thread_index());
  • current_thread_has_pending_tasks, for querying whether the current worker that has an empty task deque or not. This can be useful when deciding whether to spawn a task.
• The environment variables for controlling Rayon are now RAYON_NUM_THREADS and RAYON_LOG. The older variables (e.g., RAYON_RS_NUM_CPUS are still supported but deprecated).

Rayon-demo

• Added a new game-of-life benchmark.

Contributors

Thanks to the following contributors:

• @ChristopherDavenport
• @SuperFluffy
• @antoinewdg
• @crazymykl
• @cuviper
• @glandium
• @julian-seward1
• @leodasvacas
• @leshow
• @lilianmoraru
• @mschmo
• @nikomatsakis
• @stjepang

• ParallelExtend is now implemented for tuple pairs, enabling nested unzip() and partition_map() operations. For instance, (A, (B, C)) items can be unzipped into (Vec<A>, (Vec<B>, Vec<C>)).
  • ParallelExtend<(A, B)> works like unzip().
  • ParallelExtend<Either<A, B>> works like partition_map().
• ParallelIterator now has a method map_init() which calls an init function for a value to pair with items, like map_with() but dynamically constructed. That value type has no constraints, not even Send or Sync.
  • The new for_each_init() is a variant of this for simple iteration.
  • The new try_for_each_init() is a variant for fallible iteration.

Contributors

Thanks to all of the contributors for this release!

• @cuviper
• @dan-zheng
• @dholbert
• @ignatenkobrain
• @mdonoughe

This release is a targeted performance fix for #343, an issue where rayon threads could sometimes enter into a spin loop where they would be unable to make progress until they are pre-empted.

• Added more documentation for rayon::iter::split().
• Corrected links and typos in documentation.

Contributors

Thanks to all of the contributors for this release!

• @cuviper
• @HadrienG2
• @matthiasbeyer
• @nikomatsakis

• ParallelSliceMut now has six parallel sorting methods with the same variations as the standard library.
  • par_sort, par_sort_by, and par_sort_by_key perform stable sorts in parallel, using the default order, a custom comparator, or a key extraction function, respectively.
  • par_sort_unstable, par_sort_unstable_by, and par_sort_unstable_by_key perform unstable sorts with the same comparison options.
  • Thanks to @stjepang!

• Parallel iterators now offer an adaptive weight scheme, which means that explicit weights should no longer be necessary in most cases! Thanks @cuviper!
  • We are considering removing weights or changing the weight mechanism before 1.0. Examples of scenarios where you still need weights even with this adaptive mechanism would be great. Join the discussion at https://github.com/rayon-rs/rayon/issues/111.
• New (unstable) scoped threads API, see rayon::scope for details.
  • You will need to supply the cargo feature unstable.
• The various demos and benchmarks have been consolidated into one program, rayon-demo.
• Optimizations in Rayon's inner workings. Thanks @emilio!
• Update num_cpus to 1.0. Thanks @jamwt!
• Various internal cleanup in the implementation and typo fixes. Thanks @cuviper, @Eh2406, and @spacejam!

• Updated crates.io metadata.

• New chain combinator for parallel iterators.
• Option, Result, as well as many more collection types now have parallel iterators.
• New mergesort demo.
• Misc fixes.

Thanks to @cuviper, @edre, @jdanford, @frewsxcv for their contributions!