Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Commit f280e76

Browse files
committed
Auto merge of #150595 - antonilol:deque_extend_front_prepend_drain_spec, r=jhpratt
Add specialization for `deque1.prepend(deque2.drain(range))` (VecDeque::prepend and extend_front) Tracking issue: #146975 This specialization makes sure `deque1.prepend(deque2.drain(..))` gets similar speed to `deque1.append(&mut deque2)`. `deque1.prepend(deque2.drain(..))` is the equivalent of `deque1.append(&mut deque2)` but appending to the front (see the [second example of prepend](https://doc.rust-lang.org/nightly/std/collections/struct.VecDeque.html#method.prepend), prepend is from the same tracking issue).
2 parents e25ee6b + 7e425b8 commit f280e76

3 files changed

Lines changed: 180 additions & 14 deletions

File tree

‎library/alloc/src/collections/vec_deque/drain.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ pub struct Drain<
2525
// drain_start is stored in deque.len
2626
pub(super)drain_len:usize,
2727
// index into the logical array, not the physical one (always lies in [0..deque.len))
28-
idx:usize,
28+
pub(super)idx:usize,
2929
// number of elements after the drained range
3030
pub(super)tail_len:usize,
31-
remaining:usize,
31+
pub(super)remaining:usize,
3232
// Needed to make Drain covariant over T
3333
_marker:PhantomData<&'aT>,
3434
}
@@ -53,7 +53,7 @@ impl<'a, T, A: Allocator> Drain<'a, T, A> {
5353

5454
// Only returns pointers to the slices, as that's all we need
5555
// to drop them. May only be called if `self.remaining != 0`.
56-
unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
56+
pub(super)unsafefnas_slices(&self) -> (*mut[T],*mut[T]){
5757
unsafe{
5858
let deque = self.deque.as_ref();
5959

‎library/alloc/src/collections/vec_deque/spec_extend.rs‎

Lines changed: 67 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use core::iter::{Copied,Rev,TrustedLen};
22
use core::slice;
33

4-
usesuper::VecDeque;
4+
usesuper::{Drain,VecDeque};
55
usecrate::alloc::Allocator;
66
#[cfg(not(test))]
77
usecrate::vec;
@@ -157,7 +157,8 @@ impl<T, A: Allocator> SpecExtendFront<T, vec::IntoIter<T>> for VecDeque<T, A> {
157157
#[track_caller]
158158
fnspec_extend_front(&mutself,mutiterator: vec::IntoIter<T>){
159159
let slice = iterator.as_slice();
160-
// SAFETY: elements in the slice are forgotten after this call
160+
self.reserve(slice.len());
161+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
161162
unsafe{prepend_reversed(self, slice)};
162163
iterator.forget_remaining_elements();
163164
}
@@ -169,7 +170,8 @@ impl<T, A: Allocator> SpecExtendFront<T, Rev<vec::IntoIter<T>>> for VecDeque<T,
169170
fnspec_extend_front(&mutself,iterator:Rev<vec::IntoIter<T>>){
170171
letmut iterator = iterator.into_inner();
171172
let slice = iterator.as_slice();
172-
// SAFETY: elements in the slice are forgotten after this call
173+
self.reserve(slice.len());
174+
// SAFETY: `slice.len()` space was just reserved and elements in the slice are forgotten after this call
173175
unsafe{prepend(self, slice)};
174176
iterator.forget_remaining_elements();
175177
}
@@ -182,7 +184,8 @@ where
182184
#[track_caller]
183185
fnspec_extend_front(&mutself,iter:Copied<slice::Iter<'a,T>>){
184186
let slice = iter.into_inner().as_slice();
185-
// SAFETY: T is Copy because Copied<slice::Iter<'a, T>> is Iterator
187+
self.reserve(slice.len());
188+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Copied<slice::Iter<'a, T>> is Iterator
186189
unsafe{prepend_reversed(self, slice)};
187190
}
188191
}
@@ -194,30 +197,83 @@ where
194197
#[track_caller]
195198
fnspec_extend_front(&mutself,iter:Rev<Copied<slice::Iter<'a,T>>>){
196199
let slice = iter.into_inner().into_inner().as_slice();
197-
// SAFETY: T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
200+
self.reserve(slice.len());
201+
// SAFETY: `slice.len()` space was just reserved and T is Copy because Rev<Copied<slice::Iter<'a, T>>> is Iterator
198202
unsafe{prepend(self, slice)};
199203
}
200204
}
201205

206+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Drain<'a,T,A2>>forVecDeque<T,A1>{
207+
#[track_caller]
208+
fnspec_extend_front(&mutself,mutiter:Drain<'a,T,A2>){
209+
if iter.remaining == 0{
210+
return;
211+
}
212+
213+
self.reserve(iter.remaining);
214+
unsafe{
215+
// SAFETY: iter.remaining != 0.
216+
let(left, right) = iter.as_slices();
217+
// SAFETY:
218+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
219+
// - The elements in `left` and `right` are forgotten after these calls.
220+
prepend_reversed(self,&*left);
221+
prepend_reversed(self,&*right);
222+
}
223+
224+
iter.idx += iter.remaining;
225+
iter.remaining = 0;
226+
}
227+
}
228+
229+
impl<'a,T,A1:Allocator,A2:Allocator>SpecExtendFront<T,Rev<Drain<'a,T,A2>>>
230+
forVecDeque<T,A1>
231+
{
232+
#[track_caller]
233+
fnspec_extend_front(&mutself,iter:Rev<Drain<'a,T,A2>>){
234+
letmut iter = iter.into_inner();
235+
236+
if iter.remaining == 0{
237+
return;
238+
}
239+
240+
self.reserve(iter.remaining);
241+
unsafe{
242+
// SAFETY: iter.remaining != 0.
243+
let(left, right) = iter.as_slices();
244+
// SAFETY:
245+
// - `iter.remaining` space was reserved, `iter.remaining == left.len() + right.len()`.
246+
// - The elements in `left` and `right` are forgotten after these calls.
247+
prepend(self,&*right);
248+
prepend(self,&*left);
249+
}
250+
251+
iter.idx += iter.remaining;
252+
iter.remaining = 0;
253+
}
254+
}
255+
256+
/// Prepends elements of `slice` to `deque` using a copy.
257+
///
202258
/// # Safety
203259
///
204-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
260+
/// - `deque` must have space for `slice.len()` new elements.
261+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
205262
unsafefnprepend<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
206-
deque.reserve(slice.len());
207-
208263
unsafe{
209264
deque.head = deque.wrap_sub(deque.head, slice.len());
210265
deque.copy_slice(deque.head, slice);
211266
deque.len += slice.len();
212267
}
213268
}
214269

270+
/// Prepends elements of `slice` to `deque` in reverse order using a copy.
271+
///
215272
/// # Safety
216273
///
217-
/// Elements of `slice` will be copied into the deque, make sure to forget the items if `T` is not `Copy`.
274+
/// - `deque` must have space for `slice.len()` new elements.
275+
/// - Elements of `slice` will be copied into the deque, make sure to forget the elements if `T` is not `Copy`.
218276
unsafefnprepend_reversed<T,A:Allocator>(deque:&mutVecDeque<T,A>,slice:&[T]){
219-
deque.reserve(slice.len());
220-
221277
unsafe{
222278
deque.head = deque.wrap_sub(deque.head, slice.len());
223279
deque.copy_slice_reversed(deque.head, slice);

‎library/alloctests/tests/vec_deque.rs‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,116 @@ fn test_extend_front_specialization_copy_slice() {
21562156
assert_eq!(v.as_slices(),([5].as_slice(),[4,3,2].as_slice()));
21572157
}
21582158

2159+
#[test]
2160+
fntest_extend_front_specialization_deque_drain(){
2161+
// trigger 8 code paths: all combinations of prepend and extend_front, wrap and no wrap (src deque), wrap and no wrap (dst deque)
2162+
2163+
/// Get deque containing `[1, 2, 3, 4]`, possibly wrapping in the middle (between the 2 and 3).
2164+
fntest_deque(wrap:bool) -> VecDeque<i32>{
2165+
if wrap {
2166+
letmut v = VecDeque::with_capacity(4);
2167+
v.extend([3,4]);
2168+
v.prepend([1,2]);
2169+
assert_eq!(v.as_slices(),([1,2].as_slice(),[3,4].as_slice()));
2170+
v
2171+
}else{
2172+
VecDeque::from([1,2,3,4])
2173+
}
2174+
}
2175+
2176+
// prepend, v2.head == 0
2177+
2178+
letmut v1 = VecDeque::with_capacity(7);
2179+
2180+
letmut v2 = test_deque(false);
2181+
v1.prepend(v2.drain(..));
2182+
// drain removes all elements but keeps the buffer
2183+
assert_eq!(v2,[]);
2184+
assert!(v2.capacity() >= 4);
2185+
2186+
assert_eq!(v1,[1,2,3,4]);
2187+
v1.pop_back();
2188+
2189+
letmut v2 = test_deque(false);
2190+
// this should wrap around the physical buffer
2191+
v1.prepend(v2.drain(..));
2192+
// drain removes all elements but keeps the buffer
2193+
assert_eq!(v2,[]);
2194+
assert!(v2.capacity() >= 4);
2195+
2196+
// check it really wrapped
2197+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2198+
2199+
// extend_front, v2.head == 0
2200+
2201+
letmut v1 = VecDeque::with_capacity(7);
2202+
2203+
letmut v2 = test_deque(false);
2204+
v1.extend_front(v2.drain(..));
2205+
// drain removes all elements but keeps the buffer
2206+
assert_eq!(v2,[]);
2207+
assert!(v2.capacity() >= 4);
2208+
2209+
assert_eq!(v1,[4,3,2,1]);
2210+
v1.pop_back();
2211+
2212+
letmut v2 = test_deque(false);
2213+
// this should wrap around the physical buffer
2214+
v1.extend_front(v2.drain(..));
2215+
// drain removes all elements but keeps the buffer
2216+
assert_eq!(v2,[]);
2217+
assert!(v2.capacity() >= 4);
2218+
2219+
// check it really wrapped
2220+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2221+
2222+
// prepend, v2.head != 0
2223+
2224+
letmut v1 = VecDeque::with_capacity(7);
2225+
2226+
letmut v2 = test_deque(true);
2227+
v1.prepend(v2.drain(..));
2228+
// drain removes all elements but keeps the buffer
2229+
assert_eq!(v2,[]);
2230+
assert!(v2.capacity() >= 4);
2231+
2232+
assert_eq!(v1,[1,2,3,4]);
2233+
v1.pop_back();
2234+
2235+
letmut v2 = test_deque(true);
2236+
// this should wrap around the physical buffer
2237+
v1.prepend(v2.drain(..));
2238+
// drain removes all elements but keeps the buffer
2239+
assert_eq!(v2,[]);
2240+
assert!(v2.capacity() >= 4);
2241+
2242+
// check it really wrapped
2243+
assert_eq!(v1.as_slices(),([1].as_slice(),[2,3,4,1,2,3].as_slice()));
2244+
2245+
// extend_front, v2.head != 0
2246+
2247+
letmut v1 = VecDeque::with_capacity(7);
2248+
2249+
letmut v2 = test_deque(true);
2250+
v1.extend_front(v2.drain(..));
2251+
// drain removes all elements but keeps the buffer
2252+
assert_eq!(v2,[]);
2253+
assert!(v2.capacity() >= 4);
2254+
2255+
assert_eq!(v1,[4,3,2,1]);
2256+
v1.pop_back();
2257+
2258+
letmut v2 = test_deque(true);
2259+
// this should wrap around the physical buffer
2260+
v1.extend_front(v2.drain(..));
2261+
// drain removes all elements but keeps the buffer
2262+
assert_eq!(v2,[]);
2263+
assert!(v2.capacity() >= 4);
2264+
2265+
// check it really wrapped
2266+
assert_eq!(v1.as_slices(),([4].as_slice(),[3,2,1,4,3,2].as_slice()));
2267+
}
2268+
21592269
#[test]
21602270
fntest_splice(){
21612271
letmut v = VecDeque::from(vec![1,2,3,4,5]);

0 commit comments

Comments
 (0)