<!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="Parallel extensions for mutable slices."><meta name="keywords" content="rust, rustlang, rust-lang, ParallelSliceMut"><title>ParallelSliceMut in rayon::slice - 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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../rayon/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Trait ParallelSliceMut</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.as_parallel_slice_mut">as_parallel_slice_mut</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.par_chunks_exact_mut">par_chunks_exact_mut</a><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><h3 class="sidebar-title"><a href="#foreign-impls">Implementations on Foreign Types</a></h3><div class="sidebar-links"><a href="#impl-ParallelSliceMut%3CT%3E-for-%5BT%5D">[T]</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../index.html">rayon</a>::<wbr><a href="index.html">slice</a></h2><div id="sidebar-vars" data-name="ParallelSliceMut" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><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><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></button></span><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#128-455" title="goto source code">[src]</a></span></h1><div class="docblock type-decl"><pre class="rust trait">pub trait ParallelSliceMut<T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/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/1.54.0/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="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/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/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/1.54.0/std/primitive.usize.html">usize</a>) -> <a class="struct" href="struct.ChunksMut.html" title="struct rayon::slice::ChunksMut">ChunksMut</a><'_, T> { ... }
<div class="item-spacer"></div> fn <a href="#method.par_chunks_exact_mut" class="fnname">par_chunks_exact_mut</a>(<br> &mut self, <br> chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.usize.html">usize</a><br> ) -> <a class="struct" href="struct.ChunksExactMut.html" title="struct rayon::slice::ChunksExactMut">ChunksExactMut</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/1.54.0/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/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/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/1.54.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/1.54.0/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/1.54.0/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/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/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/1.54.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a></span>,
{ ... }
}</pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Parallel extensions for mutable slices.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.as_parallel_slice_mut" class="method has-srclink"><h4 class="code-header">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/1.54.0/std/primitive.slice.html">&mut [T]</a></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#131" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns a plain mutable slice, which is used to implement the rest of
the parallel methods.</p>
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.par_split_mut" class="method has-srclink"><h4 class="code-header">fn <a href="#method.par_split_mut" class="fnname">par_split_mut</a><P>(&mut self, separator: P) -> <a class="struct" href="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/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.bool.html">bool</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#145-153" title="goto source code">[src]</a></div></summary><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::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="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></details><details class="rustdoc-toggle" open><summary><div id="method.par_chunks_mut" class="method has-srclink"><h4 class="code-header">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/1.54.0/std/primitive.usize.html">usize</a>) -> <a class="struct" href="struct.ChunksMut.html" title="struct rayon::slice::ChunksMut">ChunksMut</a><'_, T></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#171-177" title="goto source code">[src]</a></div></summary><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::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="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></details><details class="rustdoc-toggle" open><summary><div id="method.par_chunks_exact_mut" class="method has-srclink"><h4 class="code-header">fn <a href="#method.par_chunks_exact_mut" class="fnname">par_chunks_exact_mut</a>(&mut self, chunk_size: <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.usize.html">usize</a>) -> <a class="struct" href="struct.ChunksExactMut.html" title="struct rayon::slice::ChunksExactMut">ChunksExactMut</a><'_, T></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#195-206" title="goto source code">[src]</a></div></summary><div class="docblock"><p>Returns a parallel iterator over <code>chunk_size</code> elements of
<code>self</code> at a time. The chunks are mutable and do not overlap.</p>
<p>If <code>chunk_size</code> does not divide the length of the slice, then the
last up to <code>chunk_size-1</code> elements will be omitted and can be
retrieved from the remainder function of the iterator.</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::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_exact_mut</span>(<span class="number">3</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="ident">array</span>, [<span class="number">3</span>, <span class="number">2</span>, <span class="number">1</span>, <span class="number">4</span>, <span class="number">5</span>]);</pre></div>
</div></details><details class="rustdoc-toggle" open><summary><div id="method.par_sort" class="method has-srclink"><h4 class="code-header">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/1.54.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>, </span></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#241-246" title="goto source code">[src]</a></div></summary><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-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::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="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></details><details class="rustdoc-toggle" open><summary><div id="method.par_sort_by" class="method has-srclink"><h4 class="code-header">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/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#284-291" title="goto source code">[src]</a></div></summary><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-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::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="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="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></details><details class="rustdoc-toggle" open><summary><div id="method.par_sort_by_key" class="method has-srclink"><h4 class="code-header">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/1.54.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#326-332" title="goto source code">[src]</a></div></summary><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-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::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="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></details><details class="rustdoc-toggle" open><summary><div id="method.par_sort_unstable" class="method has-srclink"><h4 class="code-header">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/1.54.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>, </span></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#365-370" title="goto source code">[src]</a></div></summary><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-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::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="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></details><details class="rustdoc-toggle" open><summary><div id="method.par_sort_unstable_by" class="method has-srclink"><h4 class="code-header">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/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T, <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> <a class="enum" href="https://doc.rust-lang.org/1.54.0/core/cmp/enum.Ordering.html" title="enum core::cmp::Ordering">Ordering</a> + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#407-414" title="goto source code">[src]</a></div></summary><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-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::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="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="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></details><details class="rustdoc-toggle" open><summary><div id="method.par_sort_unstable_by_key" class="method has-srclink"><h4 class="code-header">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/1.54.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a>,<br> F: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.reference.html">&</a>T) -> B + <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></h4><a class="srclink" href="../../src/rayon/slice/mod.rs.html#448-454" title="goto source code">[src]</a></div></summary><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-8" class="section-header"><a href="#examples-8">Examples</a></h1>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">rayon::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="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></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor"></a></h2><details class="rustdoc-toggle implementors-toggle"><summary><div id="impl-ParallelSliceMut%3CT%3E-for-%5BT%5D" class="impl has-srclink"><h3 class="code-header in-band">impl<T: <a class="trait" href="https://doc.rust-lang.org/1.54.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="trait.ParallelSliceMut.html" title="trait rayon::slice::ParallelSliceMut">ParallelSliceMut</a><T> for <a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/1.54.0/std/primitive.slice.html">]</a></h3><a href="#impl-ParallelSliceMut%3CT%3E-for-%5BT%5D" class="anchor"></a><a class="srclink" href="../../src/rayon/slice/mod.rs.html#457-462" title="goto source code">[src]</a></div></summary><div class="impl-items"><div id="method.as_parallel_slice_mut" class="method trait-impl has-srclink"><h4 class="code-header">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/1.54.0/std/primitive.slice.html">&mut [T]</a></h4><a href="#method.as_parallel_slice_mut" class="anchor"></a><a class="srclink" href="../../src/rayon/slice/mod.rs.html#459-461" title="goto source code">[src]</a></div></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"></div><script type="text/javascript" src="../../implementors/rayon/slice/trait.ParallelSliceMut.js" async></script></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rayon" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script></body></html>