Trait ord_subset::OrdSubsetSliceExt
[−]
[src]
pub trait OrdSubsetSliceExt<T> { fn ord_subset_sort(&mut self)
where
T: OrdSubset; fn ord_subset_sort_rev(&mut self)
where
T: OrdSubset; fn ord_subset_sort_by<F>(&mut self, compare: F)
where
T: OrdSubset,
F: FnMut(&T, &T) -> Ordering; fn ord_subset_sort_by_key<B, F>(&mut self, f: F)
where
B: OrdSubset,
F: FnMut(&T) -> B; fn ord_subset_binary_search(&self, x: &T) -> Result<usize, usize>
where
T: OrdSubset; fn ord_subset_binary_search_by<F>(&self, f: F) -> Result<usize, usize>
where
T: OrdSubset,
F: FnMut(&T) -> Ordering; fn ord_subset_binary_search_by_key<B, F>(
&self,
b: &B,
f: F
) -> Result<usize, usize>
where
B: OrdSubset,
F: FnMut(&T) -> B; fn ord_subset_binary_search_rev(&self, x: &T) -> Result<usize, usize>
where
T: OrdSubset; }
Required Methods
fn ord_subset_sort(&mut self) where
T: OrdSubset,
T: OrdSubset,
Sort the slice, in place. Values outside the ordered subset are put at the end in their original order.
This is equivalent to self.ord_subset_sort_by(|a,b| a.partial_cmp(b).unwrap())
Panics
Panics when a.partial_cmp(b)
returns None
for two values a
,b
inside the total order (Violated OrdSubset contract).
fn ord_subset_sort_rev(&mut self) where
T: OrdSubset,
T: OrdSubset,
UNSTABLE Will likely remove these. Easily recreated by .sort_by()
Sort the slice in reverse order, in place. Values outside the ordered subset are put at the end in their original order (i.e. not reversed).
Panics
Panics when a.partial_cmp(b)
returns None
for two values a
,b
inside the total order (Violated OrdSubset contract).
fn ord_subset_sort_by<F>(&mut self, compare: F) where
T: OrdSubset,
F: FnMut(&T, &T) -> Ordering,
T: OrdSubset,
F: FnMut(&T, &T) -> Ordering,
Sorts the slice, in place, using compare
to order elements. Values outside the total order are put at the end in their original order.
compare
will not be called on them. If you wish to handle these yourself, use the regular .sort_by()
.
Warning: The function interface is identical to the .sort_by()
interface. Be careful not to miss ord_subset_
in front.
It would work until you have unordered values in your slice, then crash unexpectedly.
This delegates to .sort_by()
in the std library. See official docs for
time and space complexity of the current implementation.
Panics
Panics when a.partial_cmp(b)
returns None
for two values a
,b
inside the total order (Violated OrdSubset contract).
fn ord_subset_sort_by_key<B, F>(&mut self, f: F) where
B: OrdSubset,
F: FnMut(&T) -> B,
B: OrdSubset,
F: FnMut(&T) -> B,
Sorts the slice, in place, using key
to extract a key by which to order the sort by.
This delegates to .sort_by()
in the std library. See official docs for
time and space complexity of the current implementation.
fn ord_subset_binary_search(&self, x: &T) -> Result<usize, usize> where
T: OrdSubset,
T: OrdSubset,
Binary search a sorted slice for a given element. Values outside the ordered subset need to be at the end of the slice.
If the value is found then Ok is returned, containing the index of the matching element; if the value is not found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.
Example
Looks up a series of five elements. The first is found, with a uniquely determined position; the second and third are not found; the fourth could match any position in [1,4]
.
use ord_subset::OrdSubsetSliceExt; use std::f64; let s = [0., 1., 1., 1., 1., 2., 3., 5., 8., 13., 21., 34., 55., f64::NAN, f64::NAN]; assert_eq!(s.ord_subset_binary_search(&13.), Ok(9)); assert_eq!(s.ord_subset_binary_search(&4.), Err(7)); assert_eq!(s.ord_subset_binary_search(&100.), Err(13)); let r = s.ord_subset_binary_search(&1.); assert!(match r { Ok(1...4) => true, _ => false, }); assert_eq!(s.ord_subset_binary_search(&f64::INFINITY), Err(13));
Panics
Panics if the argument is outside of the total order. Also panics when a.partial_cmp(b)
returns None
for two values a
,b
inside the total order (Violated OrdSubset contract).
fn ord_subset_binary_search_by<F>(&self, f: F) -> Result<usize, usize> where
T: OrdSubset,
F: FnMut(&T) -> Ordering,
T: OrdSubset,
F: FnMut(&T) -> Ordering,
Binary search a sorted slice with a comparator function.
The comparator function should implement an order consistent with the sort order of the underlying slice, returning an order code that indicates whether its argument is Less, Equal or Greater the desired target. The comparator will only be called for values inside the total order.
It's imperative, that the comparator function doesn't compare its arguments with values outside the total order. This will result in bogus output which cannot be caught by this function.
If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.
fn ord_subset_binary_search_by_key<B, F>(
&self,
b: &B,
f: F
) -> Result<usize, usize> where
B: OrdSubset,
F: FnMut(&T) -> B,
&self,
b: &B,
f: F
) -> Result<usize, usize> where
B: OrdSubset,
F: FnMut(&T) -> B,
Binary search a sorted slice with a key extraction function.
Assumes that the slice is sorted by the key, for instance with ord_subset_sort_by_key
using the same key extraction function.
If a matching value is found then returns Ok
, containing the index for the matched element; if no match is found then Err
is returned, containing the index where a matching element could be inserted while maintaining sorted order.
fn ord_subset_binary_search_rev(&self, x: &T) -> Result<usize, usize> where
T: OrdSubset,
T: OrdSubset,
UNSTABLE Will likely remove these. Easily recreated by .binary_search_by()
Binary search a slice sorted in reverse order for a given element. Values outside the ordered subset need to be at the end of the slice.
If a matching value is found then returns Ok, containing the index for the matched element; if no match is found then Err is returned, containing the index where a matching element could be inserted while maintaining sorted order.
Panics
Panics if the argument is outside of the total order. Also panics when a.partial_cmp(b)
returns None
for two values a
,b
inside the total order (Violated OrdSubset contract).
Implementations on Foreign Types
impl<T> OrdSubsetSliceExt<T> for [T]
[src]
fn ord_subset_sort(&mut self) where
T: OrdSubset,
[src]
T: OrdSubset,
fn ord_subset_sort_by<F>(&mut self, compare: F) where
T: OrdSubset,
F: FnMut(&T, &T) -> Ordering,
[src]
T: OrdSubset,
F: FnMut(&T, &T) -> Ordering,
fn ord_subset_sort_rev(&mut self) where
T: OrdSubset,
[src]
T: OrdSubset,
fn ord_subset_sort_by_key<B, F>(&mut self, f: F) where
B: OrdSubset,
F: FnMut(&T) -> B,
[src]
B: OrdSubset,
F: FnMut(&T) -> B,
fn ord_subset_binary_search(&self, x: &T) -> Result<usize, usize> where
T: OrdSubset,
[src]
T: OrdSubset,
fn ord_subset_binary_search_by<F>(&self, f: F) -> Result<usize, usize> where
T: OrdSubset,
F: FnMut(&T) -> Ordering,
[src]
T: OrdSubset,
F: FnMut(&T) -> Ordering,
fn ord_subset_binary_search_by_key<B, F>(
&self,
b: &B,
f: F
) -> Result<usize, usize> where
B: OrdSubset,
F: FnMut(&T) -> B,
[src]
&self,
b: &B,
f: F
) -> Result<usize, usize> where
B: OrdSubset,
F: FnMut(&T) -> B,
fn ord_subset_binary_search_rev(&self, x: &T) -> Result<usize, usize> where
T: OrdSubset,
[src]
T: OrdSubset,