rotate.rs.html -- source
Description: Source to the Rust file `libcore/slice/rotate.rs`.
Keywords: rust, rustlang, rust-lang

      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105

    // Copyright 2012-2017 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.

    use cmp;
    use mem;
    use ptr;

    /// Rotation is much faster if it has access to a little bit of memory. This
    /// union provides a RawVec-like interface, but to a fixed-size stack buffer.
    #[allow(unions_with_drop_fields)]
    union RawArray<T> {
        /// Ensure this is appropriately aligned for T, and is big
        /// enough for two elements even if T is enormous.
        typed: [T; 2],
        /// For normally-sized types, especially things like u8, having more
        /// than 2 in the buffer is necessary for usefulness, so pad it out
        /// enough to be helpful, but not so big as to risk overflow.
        _extra: [usize; 32],
    }

    impl<T> RawArray<T> {
        fn new() -> Self {
            unsafe { mem::uninitialized() }
        }
        fn ptr(&self) -> *mut T {
            unsafe { &self.typed as *const T as *mut T }
        }
        fn cap() -> usize {
            if mem::size_of::<T>() == 0 {
                usize::max_value()
            } else {
                mem::size_of::<Self>() / mem::size_of::<T>()
            }
        }
    }

    /// Rotates the range `[mid-left, mid+right)` such that the element at `mid`
    /// becomes the first element.  Equivalently, rotates the range `left`
    /// elements to the left or `right` elements to the right.
    ///
    /// # Safety
    ///
    /// The specified range must be valid for reading and writing.
    ///
    /// # Algorithm
    ///
    /// For longer rotations, swap the left-most `delta = min(left, right)`
    /// elements with the right-most `delta` elements.  LLVM vectorizes this,
    /// which is profitable as we only reach this step for a "large enough"
    /// rotation.  Doing this puts `delta` elements on the larger side into the
    /// correct position, leaving a smaller rotate problem.  Demonstration:
    ///
    /// ```text
    /// [ 6 7 8 9 10 11 12 13 . 1 2 3 4 5 ]
    /// 1 2 3 4 5 [ 11 12 13 . 6 7 8 9 10 ]
    /// 1 2 3 4 5 [ 8 9 10 . 6 7 ] 11 12 13
    /// 1 2 3 4 5 6 7 [ 10 . 8 9 ] 11 12 13
    /// 1 2 3 4 5 6 7 [ 9 . 8 ] 10 11 12 13
    /// 1 2 3 4 5 6 7 8 [ . ] 9 10 11 12 13
    /// ```
    ///
    /// Once the rotation is small enough, copy some elements into a stack
    /// buffer, `memmove` the others, and move the ones back from the buffer.
    pub unsafe fn ptr_rotate<T>(mut left: usize, mid: *mut T, mut right: usize) {
        loop {
            let delta = cmp::min(left, right);
            if delta <= RawArray::<T>::cap() {
                // We will always hit this immediately for ZST.
                break;
            }

            ptr::swap_nonoverlapping(
                mid.sub(left),
                mid.add(right - delta),
                delta);

            if left <= right {
                right -= delta;
            } else {
                left -= delta;
            }
        }

        let rawarray = RawArray::new();
        let buf = rawarray.ptr();

        let dim = mid.sub(left).add(right);
        if left <= right {
            ptr::copy_nonoverlapping(mid.sub(left), buf, left);
            ptr::copy(mid, mid.sub(left), right);
            ptr::copy_nonoverlapping(buf, dim, left);
        }
        else {
            ptr::copy_nonoverlapping(mid, buf, right);
            ptr::copy(mid.sub(left), dim, left);
            ptr::copy_nonoverlapping(buf, mid.sub(left), right);
        }
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)