Skip to content

Add rotate, partition, and friends to vectors #11320

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 5 commits into from
Closed
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 165 additions & 0 deletions src/libstd/vec.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1017,6 +1017,17 @@ pub trait ImmutableVector<'a, T> {
* Fails if slice is empty.
*/
fn pop_ref(&mut self) -> &'a T;

/**
* Returns true if all the elements in vector
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence seems to be line-wrapped weirdly.

(Also, we are (slowly) moving to just using /// for doc comments, i.e.

/// Returns true if all the elements in vector
/// for which pred returns true precede those for which it returns false.
///
/// ...
fn is_partititioned(...)

* for which pred returns true precede those for which it returns false.
*
* # Example
* ```rust
* let even = |x: &int| *x % 2 == 0;
* assert!([2, 4, 6, 1, 3, 5].is_partitioned(|x| even(x)));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are missing the closing

```

*/
fn is_partitioned(self, f: |&T| -> bool) -> bool;
}

impl<'a,T> ImmutableVector<'a, T> for &'a [T] {
Expand Down Expand Up @@ -1200,6 +1211,18 @@ impl<'a,T> ImmutableVector<'a, T> for &'a [T] {
&*raw::pop_ptr(s)
}
}

fn is_partitioned(self, f: |&T| -> bool) -> bool {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this can be done by something like

let seen_false = false;
for elem in self.iter() {
    if f(elem) {
        if seen_false { return false; }
    } else { 
        seen_false = true;
    }
}
true

(Although I'm not totally sure we need this method specifically?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I included it for completeness. We will need it to test partition() anyway. It can be demoted to a private function though.

let mut i = 0;
let len = self.len();
while i < len && f(&self[i]) {
i += 1;
}
while i < len && !f(&self[i]) {
i += 1;
}
i == len
}
}

/// Extension methods for vectors contain `Eq` elements.
Expand Down Expand Up @@ -2302,6 +2325,45 @@ pub trait MutableVector<'a, T> {
/// ignores move semantics. `self` and `src` must not
/// overlap. Fails if `self` is shorter than `src`.
unsafe fn copy_memory(self, src: &[T]);

/// Rotates elements of the vector around pivot `mid` in place.
/// This method behaves similarly to STL rotate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is "STL"?

(I personally know what it is, but there will be people reading these docs who know nothing about C++.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, what is the return value? And saying "rotate around the pivot mid" isn't 100% clear, maybe something like "Rotates the vector n places to the right by placing the first n elements at the end of the vector, and moving the rest left to fill the gap. Operates in place.".

///
/// # Example
///
/// ```rust
/// let mut v = [1, 2, 3, 4, 5, 6];
/// let i = v.rotate(2);
/// assert_eq!(v, [3, 4, 5, 6, 1, 2]);
/// assert_eq!(i, 4);
/// ```
fn rotate(self, mid: uint) -> uint;

/// Partitions the vector so that all elements satisfying `pred`
/// precede those that do not. The partitioning is unstable.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume the reason for having two is this is faster than the stable variant? It would be good to mention performance in both doc-strings.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added performance characteristics.

///
/// # Example
///
/// ```rust
/// let mut v = [1, 2, 3, 4, 5, 6];
/// let is_even = |x: &int| *x % 2 == 0;
/// assert_eq!(v.partition(|x| is_even(x)), 3);
/// assert!(v.is_partitioned(is_even))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be much clearer to give the actual expected vector here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The algorithm is unstable and does not guarantee any ordering within each partition. I didn't want to give a specific expected vector, since we'll need to remember to change it if the implementation of the algorithm changes. Should I give an expected vector anyway?

/// ```
fn partition(self, pred: |&T| -> bool) -> uint;

/// Partitions the vector so that all elements satisfying `pred`
/// precede those that do not. The partitioning in stable.
///
/// # Example
///
/// ```rust
/// let mut v = [1, 2, 3, 4, 5, 6];
/// let is_even = |x: &int| *x % 2 == 0;
/// assert_eq!(v.partition(|x| is_even(x)), 3);
/// assert_eq!(v, [2, 4, 6, 1, 3, 5]);
/// ```
fn partition_stable(self, f: |&T| -> bool) -> uint;
}

impl<'a,T> MutableVector<'a, T> for &'a mut [T] {
Expand Down Expand Up @@ -2443,6 +2505,64 @@ impl<'a,T> MutableVector<'a, T> for &'a mut [T] {
assert!(self.len() >= len_src);
ptr::copy_nonoverlapping_memory(self.as_mut_ptr(), src.as_ptr(), len_src)
}

fn rotate(self, mid: uint) -> uint {
let end = self.len();
if mid == 0 {
return end;
}
if mid == end {
return 0;
}
if mid > end {
fail!("index out of bounds: len is {} but rotating around {}", end, mid);
}
let (mut a, mut b) = (0, mid);

let mut piv = mid;
while a != b {
self.swap(a, b);
a += 1;
b += 1;

if b == end {
b = piv;
} else if a == piv {
piv = b;
}
}
end - mid
}

fn partition(self, f: |&T| -> bool) -> uint {
let (mut a, mut b) = (0, self.len());
while a != b {
if f(&self[a]) {
a += 1;
} else {
b -= 1;
self.swap(a, b);
}
}
a
}

fn partition_stable(self, f: |&T| -> bool) -> uint {
let len = self.len();
if len == 0 {
return 0;
}
if len == 1 {
if f(&self[0]) {
return 1;
}
return 0;
}
let mid = len / 2;
let a = self.mut_slice_to(mid).partition_stable(|x| f(x));
let b = self.mut_slice_from(mid).partition_stable(f) + mid;
self.mut_slice(a, b).rotate(mid-a) + a
}
}

/// Trait for &[T] where T is Cloneable
Expand Down Expand Up @@ -4447,6 +4567,51 @@ mod tests {
let mut x: &mut [int] = [];
x.mut_pop_ref();
}

#[test]
fn test_rotate() {
let mut v = [1, 2, 3, 4, 5, 6];
assert_eq!(v.rotate(0), 6);
assert_eq!(v.rotate(6), 0);
assert_eq!(v.rotate(3), 3);
assert_eq!(v, [4, 5, 6, 1, 2, 3]);
let mut v = [1, 2, 3, 4, 5, 6];
assert_eq!(v.rotate(2), 4);
assert_eq!(v, [3, 4, 5, 6, 1, 2]);
let mut v = [1, 2, 3, 4, 5, 6];
assert_eq!(v.rotate(4), 2);
assert_eq!(v, [5, 6, 1, 2, 3, 4]);
}

#[test]
#[should_fail]
fn test_rotate_fail() {
let mut v = [1, 2, 3, 4, 5, 6];
v.rotate(10);
}

#[test]
fn test_is_partitioned() {
let even = |x: &int| *x % 2 == 0;
assert!([2, 4, 6, 1, 3, 5].is_partitioned(|x| even(x)));
assert!(![1, 2, 4, 6, 3, 5].is_partitioned(|x| even(x)));
}

#[test]
fn test_partion() {
let mut v = [1, 2, 3, 4, 5, 6];
let is_even = |x: &int| *x % 2 == 0;
assert_eq!(v.partition(|x| is_even(x)), 3);
assert!(v.is_partitioned(is_even))
}

#[test]
fn test_partion_stable() {
let mut v = [1, 2, 3, 4, 5, 6];
let is_even = |x: &int| *x % 2 == 0;
assert_eq!(v.partition_stable(|x| is_even(x)), 3);
assert_eq!(v, [2, 4, 6, 1, 3, 5]);
}
}

#[cfg(test)]
Expand Down