|
|
|
|
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `ParallelSliceMut` trait in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, ParallelSliceMut"><title>rayon::slice::ParallelSliceMut - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../rayon/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ParallelSliceMut</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.as_parallel_slice_mut">as_parallel_slice_mut</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.par_chunks_mut">par_chunks_mut</a><a href="#method.par_sort">par_sort</a><a href="#method.par_sort_by">par_sort_by</a><a href="#method.par_sort_by_key">par_sort_by_key</a><a href="#method.par_sort_unstable">par_sort_unstable</a><a href="#method.par_sort_unstable_by">par_sort_unstable_by</a><a href="#method.par_sort_unstable_by_key">par_sort_unstable_by_key</a><a href="#method.par_split_mut">par_split_mut</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-ParallelSliceMut%3CT%3E-for-%5BT%5D">[T]</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>rayon</a>::<wbr><a href='index.html'>slice</a></p><script>window.sidebarCurrent = {name: 'ParallelSliceMut', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/rayon/slice/mod.rs.html#101-399' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>rayon</a>::<wbr><a href='index.html'>slice</a>::<wbr><a class="trait" href=''>ParallelSliceMut</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait ParallelSliceMut<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> {
|
|
|
|
|
|
fn <a href='#tymethod.as_parallel_slice_mut' class='fnname'>as_parallel_slice_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.par_split_mut' class='fnname'>par_split_mut</a><P>(&mut self, separator: P) -> <a class="struct" href="../../rayon/slice/struct.SplitMut.html" title="struct rayon::slice::SplitMut">SplitMut</a><T, P><br> <span class="where">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.par_chunks_mut' class='fnname'>par_chunks_mut</a>(&mut self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../rayon/slice/struct.ChunksMut.html" title="struct rayon::slice::ChunksMut">ChunksMut</a><T> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.par_sort' class='fnname'>par_sort</a>(&mut self)<br> <span class="where">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.par_sort_by' class='fnname'>par_sort_by</a><F>(&mut self, compare: F)<br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.par_sort_by_key' class='fnname'>par_sort_by_key</a><B, F>(&mut self, f: F)<br> <span class="where">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.par_sort_unstable' class='fnname'>par_sort_unstable</a>(&mut self)<br> <span class="where">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.par_sort_unstable_by' class='fnname'>par_sort_unstable_by</a><F>(&mut self, compare: F)<br> <span class="where">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.par_sort_unstable_by_key' class='fnname'>par_sort_unstable_by_key</a><B, F>(&mut self, f: F)<br> <span class="where">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>Parallel extensions for mutable slices.</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.as_parallel_slice_mut' class='method'><code id='as_parallel_slice_mut.v'>fn <a href='#tymethod.as_parallel_slice_mut' class='fnname'>as_parallel_slice_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a></code></h3><div class='docblock'><p>Returns a plain mutable slice, which is used to implement the rest of
|
|
|
|
|
|
the parallel methods.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.par_split_mut' class='method'><code id='par_split_mut.v'>fn <a href='#method.par_split_mut' class='fnname'>par_split_mut</a><P>(&mut self, separator: P) -> <a class="struct" href="../../rayon/slice/struct.SplitMut.html" title="struct rayon::slice::SplitMut">SplitMut</a><T, P> <span class="where fmt-newline">where<br> P: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code></h3><div class='docblock'><p>Returns a parallel iterator over mutable subslices separated by
|
|
|
|
|
|
elements that match the separator.</p>
|
|
|
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">array</span> <span class="op">=</span> [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">8</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">6</span>, <span class="number">9</span>];
|
|
|
|
|
|
<span class="ident">array</span>.<span class="ident">par_split_mut</span>(<span class="op">|</span><span class="ident">i</span><span class="op">|</span> <span class="kw-2">*</span><span class="ident">i</span> <span class="op">=</span><span class="op">=</span> <span class="number">0</span>)
|
|
|
|
|
|
.<span class="ident">for_each</span>(<span class="op">|</span><span class="ident">slice</span><span class="op">|</span> <span class="ident">slice</span>.<span class="ident">reverse</span>());
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">array</span>, [<span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">0</span>, <span class="number">8</span>, <span class="number">4</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">9</span>, <span class="number">6</span>, <span class="number">3</span>]);</pre></div>
|
|
|
|
|
|
</div><h3 id='method.par_chunks_mut' class='method'><code id='par_chunks_mut.v'>fn <a href='#method.par_chunks_mut' class='fnname'>par_chunks_mut</a>(&mut self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../../rayon/slice/struct.ChunksMut.html" title="struct rayon::slice::ChunksMut">ChunksMut</a><T></code></h3><div class='docblock'><p>Returns a parallel iterator over at most <code>chunk_size</code> elements of
|
|
|
|
|
|
<code>self</code> at a time. The chunks are mutable and do not overlap.</p>
|
|
|
|
|
|
<p>If the number of elements in the iterator is not divisible by
|
|
|
|
|
|
<code>chunk_size</code>, the last chunk may be shorter than <code>chunk_size</code>. All
|
|
|
|
|
|
other chunks will have that exact length.</p>
|
|
|
|
|
|
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">array</span> <span class="op">=</span> [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
|
|
|
|
|
|
<span class="ident">array</span>.<span class="ident">par_chunks_mut</span>(<span class="number">2</span>)
|
|
|
|
|
|
.<span class="ident">for_each</span>(<span class="op">|</span><span class="ident">slice</span><span class="op">|</span> <span class="ident">slice</span>.<span class="ident">reverse</span>());
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">array</span>, [<span class="number">2</span>, <span class="number">1</span>, <span class="number">4</span>, <span class="number">3</span>, <span class="number">5</span>]);</pre></div>
|
|
|
|
|
|
</div><h3 id='method.par_sort' class='method'><code id='par_sort.v'>fn <a href='#method.par_sort' class='fnname'>par_sort</a>(&mut self) <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>, </span></code></h3><div class='docblock'><p>Sorts the slice in parallel.</p>
|
|
|
|
|
|
<p>This sort is stable (i.e. does not reorder equal elements) and <code>O(n log n)</code> worst-case.</p>
|
|
|
|
|
|
<p>When applicable, unstable sorting is preferred because it is generally faster than stable
|
|
|
|
|
|
sorting and it doesn't allocate auxiliary memory.
|
|
|
|
|
|
See <a href="#method.par_sort_unstable"><code>par_sort_unstable</code></a>.</p>
|
|
|
|
|
|
<h1 id="current-implementation" class="section-header"><a href="#current-implementation">Current implementation</a></h1>
|
|
|
|
|
|
<p>The current algorithm is an adaptive merge sort inspired by
|
|
|
|
|
|
<a href="https://en.wikipedia.org/wiki/Timsort">timsort</a>.
|
|
|
|
|
|
It is designed to be very fast in cases where the slice is nearly sorted, or consists of
|
|
|
|
|
|
two or more sorted sequences concatenated one after another.</p>
|
|
|
|
|
|
<p>Also, it allocates temporary storage the same size as <code>self</code>, but for very short slices a
|
|
|
|
|
|
non-allocating insertion sort is used instead.</p>
|
|
|
|
|
|
<p>In order to sort the slice in parallel, the slice is first divided into smaller chunks and
|
|
|
|
|
|
all chunks are sorted in parallel. Then, adjacent chunks that together form non-descending
|
|
|
|
|
|
or descending runs are concatenated. Finally, the remaining chunks are merged together using
|
|
|
|
|
|
parallel subdivision of chunks and parallel merge operation.</p>
|
|
|
|
|
|
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> [<span class="op">-</span><span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">2</span>];
|
|
|
|
|
|
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort</span>();
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="op">-</span><span class="number">5</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>]);</pre></div>
|
|
|
|
|
|
</div><h3 id='method.par_sort_by' class='method'><code id='par_sort_by.v'>fn <a href='#method.par_sort_by' class='fnname'>par_sort_by</a><F>(&mut self, compare: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code></h3><div class='docblock'><p>Sorts the slice in parallel with a comparator function.</p>
|
|
|
|
|
|
<p>This sort is stable (i.e. does not reorder equal elements) and <code>O(n log n)</code> worst-case.</p>
|
|
|
|
|
|
<p>When applicable, unstable sorting is preferred because it is generally faster than stable
|
|
|
|
|
|
sorting and it doesn't allocate auxiliary memory.
|
|
|
|
|
|
See <a href="#method.par_sort_unstable_by"><code>par_sort_unstable_by</code></a>.</p>
|
|
|
|
|
|
<h1 id="current-implementation-1" class="section-header"><a href="#current-implementation-1">Current implementation</a></h1>
|
|
|
|
|
|
<p>The current algorithm is an adaptive merge sort inspired by
|
|
|
|
|
|
<a href="https://en.wikipedia.org/wiki/Timsort">timsort</a>.
|
|
|
|
|
|
It is designed to be very fast in cases where the slice is nearly sorted, or consists of
|
|
|
|
|
|
two or more sorted sequences concatenated one after another.</p>
|
|
|
|
|
|
<p>Also, it allocates temporary storage the same size as <code>self</code>, but for very short slices a
|
|
|
|
|
|
non-allocating insertion sort is used instead.</p>
|
|
|
|
|
|
<p>In order to sort the slice in parallel, the slice is first divided into smaller chunks and
|
|
|
|
|
|
all chunks are sorted in parallel. Then, adjacent chunks that together form non-descending
|
|
|
|
|
|
or descending runs are concatenated. Finally, the remaining chunks are merged together using
|
|
|
|
|
|
parallel subdivision of chunks and parallel merge operation.</p>
|
|
|
|
|
|
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> [<span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">2</span>];
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort_by</span>(<span class="op">|</span><span class="ident">a</span>, <span class="ident">b</span><span class="op">|</span> <span class="ident">a</span>.<span class="ident">cmp</span>(<span class="ident">b</span>));
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// reverse sorting</span>
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort_by</span>(<span class="op">|</span><span class="ident">a</span>, <span class="ident">b</span><span class="op">|</span> <span class="ident">b</span>.<span class="ident">cmp</span>(<span class="ident">a</span>));
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="number">5</span>, <span class="number">4</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>]);</pre></div>
|
|
|
|
|
|
</div><h3 id='method.par_sort_by_key' class='method'><code id='par_sort_by_key.v'>fn <a href='#method.par_sort_by_key' class='fnname'>par_sort_by_key</a><B, F>(&mut self, f: F) <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code></h3><div class='docblock'><p>Sorts the slice in parallel with a key extraction function.</p>
|
|
|
|
|
|
<p>This sort is stable (i.e. does not reorder equal elements) and <code>O(n log n)</code> worst-case.</p>
|
|
|
|
|
|
<p>When applicable, unstable sorting is preferred because it is generally faster than stable
|
|
|
|
|
|
sorting and it doesn't allocate auxiliary memory.
|
|
|
|
|
|
See <a href="#method.par_sort_unstable_by_key"><code>par_sort_unstable_by_key</code></a>.</p>
|
|
|
|
|
|
<h1 id="current-implementation-2" class="section-header"><a href="#current-implementation-2">Current implementation</a></h1>
|
|
|
|
|
|
<p>The current algorithm is an adaptive merge sort inspired by
|
|
|
|
|
|
<a href="https://en.wikipedia.org/wiki/Timsort">timsort</a>.
|
|
|
|
|
|
It is designed to be very fast in cases where the slice is nearly sorted, or consists of
|
|
|
|
|
|
two or more sorted sequences concatenated one after another.</p>
|
|
|
|
|
|
<p>Also, it allocates temporary storage the same size as <code>self</code>, but for very short slices a
|
|
|
|
|
|
non-allocating insertion sort is used instead.</p>
|
|
|
|
|
|
<p>In order to sort the slice in parallel, the slice is first divided into smaller chunks and
|
|
|
|
|
|
all chunks are sorted in parallel. Then, adjacent chunks that together form non-descending
|
|
|
|
|
|
or descending runs are concatenated. Finally, the remaining chunks are merged together using
|
|
|
|
|
|
parallel subdivision of chunks and parallel merge operation.</p>
|
|
|
|
|
|
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> [<span class="op">-</span><span class="number">5i32</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">2</span>];
|
|
|
|
|
|
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort_by_key</span>(<span class="op">|</span><span class="ident">k</span><span class="op">|</span> <span class="ident">k</span>.<span class="ident">abs</span>());
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="number">1</span>, <span class="number">2</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">4</span>, <span class="op">-</span><span class="number">5</span>]);</pre></div>
|
|
|
|
|
|
</div><h3 id='method.par_sort_unstable' class='method'><code id='par_sort_unstable.v'>fn <a href='#method.par_sort_unstable' class='fnname'>par_sort_unstable</a>(&mut self) <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>, </span></code></h3><div class='docblock'><p>Sorts the slice in parallel, but may not preserve the order of equal elements.</p>
|
|
|
|
|
|
<p>This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate),
|
|
|
|
|
|
and <code>O(n log n)</code> worst-case.</p>
|
|
|
|
|
|
<h1 id="current-implementation-3" class="section-header"><a href="#current-implementation-3">Current implementation</a></h1>
|
|
|
|
|
|
<p>The current algorithm is based on Orson Peters' <a href="https://github.com/orlp/pdqsort">pattern-defeating quicksort</a>,
|
|
|
|
|
|
which is a quicksort variant designed to be very fast on certain kinds of patterns,
|
|
|
|
|
|
sometimes achieving linear time. It is randomized but deterministic, and falls back to
|
|
|
|
|
|
heapsort on degenerate inputs.</p>
|
|
|
|
|
|
<p>It is generally faster than stable sorting, except in a few special cases, e.g. when the
|
|
|
|
|
|
slice consists of several concatenated sorted sequences.</p>
|
|
|
|
|
|
<p>All quicksorts work in two stages: partitioning into two halves followed by recursive
|
|
|
|
|
|
calls. The partitioning phase is sequential, but the two recursive calls are performed in
|
|
|
|
|
|
parallel.</p>
|
|
|
|
|
|
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> [<span class="op">-</span><span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">2</span>];
|
|
|
|
|
|
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort_unstable</span>();
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="op">-</span><span class="number">5</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>]);</pre></div>
|
|
|
|
|
|
</div><h3 id='method.par_sort_unstable_by' class='method'><code id='par_sort_unstable_by.v'>fn <a href='#method.par_sort_unstable_by' class='fnname'>par_sort_unstable_by</a><F>(&mut self, compare: F) <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code></h3><div class='docblock'><p>Sorts the slice in parallel with a comparator function, but may not preserve the order of
|
|
|
|
|
|
equal elements.</p>
|
|
|
|
|
|
<p>This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate),
|
|
|
|
|
|
and <code>O(n log n)</code> worst-case.</p>
|
|
|
|
|
|
<h1 id="current-implementation-4" class="section-header"><a href="#current-implementation-4">Current implementation</a></h1>
|
|
|
|
|
|
<p>The current algorithm is based on Orson Peters' <a href="https://github.com/orlp/pdqsort">pattern-defeating quicksort</a>,
|
|
|
|
|
|
which is a quicksort variant designed to be very fast on certain kinds of patterns,
|
|
|
|
|
|
sometimes achieving linear time. It is randomized but deterministic, and falls back to
|
|
|
|
|
|
heapsort on degenerate inputs.</p>
|
|
|
|
|
|
<p>It is generally faster than stable sorting, except in a few special cases, e.g. when the
|
|
|
|
|
|
slice consists of several concatenated sorted sequences.</p>
|
|
|
|
|
|
<p>All quicksorts work in two stages: partitioning into two halves followed by recursive
|
|
|
|
|
|
calls. The partitioning phase is sequential, but the two recursive calls are performed in
|
|
|
|
|
|
parallel.</p>
|
|
|
|
|
|
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> [<span class="number">5</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="number">3</span>, <span class="number">2</span>];
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort_unstable_by</span>(<span class="op">|</span><span class="ident">a</span>, <span class="ident">b</span><span class="op">|</span> <span class="ident">a</span>.<span class="ident">cmp</span>(<span class="ident">b</span>));
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>]);
|
|
|
|
|
|
|
|
|
|
|
|
<span class="comment">// reverse sorting</span>
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort_unstable_by</span>(<span class="op">|</span><span class="ident">a</span>, <span class="ident">b</span><span class="op">|</span> <span class="ident">b</span>.<span class="ident">cmp</span>(<span class="ident">a</span>));
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="number">5</span>, <span class="number">4</span>, <span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>]);</pre></div>
|
|
|
|
|
|
</div><h3 id='method.par_sort_unstable_by_key' class='method'><code id='par_sort_unstable_by_key.v'>fn <a href='#method.par_sort_unstable_by_key' class='fnname'>par_sort_unstable_by_key</a><B, F>(&mut self, f: F) <span class="where fmt-newline">where<br> B: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code></h3><div class='docblock'><p>Sorts the slice in parallel with a key extraction function, but may not preserve the order
|
|
|
|
|
|
of equal elements.</p>
|
|
|
|
|
|
<p>This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate),
|
|
|
|
|
|
and <code>O(n log n)</code> worst-case.</p>
|
|
|
|
|
|
<h1 id="current-implementation-5" class="section-header"><a href="#current-implementation-5">Current implementation</a></h1>
|
|
|
|
|
|
<p>The current algorithm is based on Orson Peters' <a href="https://github.com/orlp/pdqsort">pattern-defeating quicksort</a>,
|
|
|
|
|
|
which is a quicksort variant designed to be very fast on certain kinds of patterns,
|
|
|
|
|
|
sometimes achieving linear time. It is randomized but deterministic, and falls back to
|
|
|
|
|
|
heapsort on degenerate inputs.</p>
|
|
|
|
|
|
<p>It is generally faster than stable sorting, except in a few special cases, e.g. when the
|
|
|
|
|
|
slice consists of several concatenated sorted sequences.</p>
|
|
|
|
|
|
<p>All quicksorts work in two stages: partitioning into two halves followed by recursive
|
|
|
|
|
|
calls. The partitioning phase is sequential, but the two recursive calls are performed in
|
|
|
|
|
|
parallel.</p>
|
|
|
|
|
|
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
|
|
|
|
|
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">v</span> <span class="op">=</span> [<span class="op">-</span><span class="number">5i32</span>, <span class="number">4</span>, <span class="number">1</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">2</span>];
|
|
|
|
|
|
|
|
|
|
|
|
<span class="ident">v</span>.<span class="ident">par_sort_unstable_by_key</span>(<span class="op">|</span><span class="ident">k</span><span class="op">|</span> <span class="ident">k</span>.<span class="ident">abs</span>());
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [<span class="number">1</span>, <span class="number">2</span>, <span class="op">-</span><span class="number">3</span>, <span class="number">4</span>, <span class="op">-</span><span class="number">5</span>]);</pre></div>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-ParallelSliceMut%3CT%3E-for-%5BT%5D' class='impl'><code class='in-band'>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="../../rayon/slice/trait.ParallelSliceMut.html" title="trait rayon::slice::ParallelSliceMut">ParallelSliceMut</a><T> for <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a></code><a href='#impl-ParallelSliceMut%3CT%3E-for-%5BT%5D' class='anchor'></a><a class='srclink' href='../../src/rayon/slice/mod.rs.html#401-406' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.as_parallel_slice_mut' class="method hidden"><code id='as_parallel_slice_mut.v-1'>fn <a href='#method.as_parallel_slice_mut' class='fnname'>as_parallel_slice_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a></code><a class='srclink' href='../../src/rayon/slice/mod.rs.html#403-405' title='goto source code'>[src]</a></h4></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
|
|
|
src="../../implementors/rayon/slice/trait.ParallelSliceMut.js">
|
|
|
|
|
|
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "rayon";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
|
