Struct GroupingMap
pub struct GroupingMap<I> { /* private fields */ }
dep_itertools
only.Expand description
GroupingMap
is an intermediate struct for efficient group-and-fold operations.
It groups elements by their key and at the same time fold each group
using some aggregating operation.
No method on this struct performs temporary allocations.
Implementations§
§impl<I, K, V> GroupingMap<I>
impl<I, K, V> GroupingMap<I>
pub fn aggregate<FO, R>(self, operation: FO) -> HashMap<K, R>
pub fn aggregate<FO, R>(self, operation: FO) -> HashMap<K, R>
This is the generic way to perform any operation on a GroupingMap
.
It’s suggested to use this method only to implement custom operations
when the already provided ones are not enough.
Groups elements from the GroupingMap
source by key and applies operation
to the elements
of each group sequentially, passing the previously accumulated value, a reference to the key
and the current element as arguments, and stores the results in an HashMap
.
The operation
function is invoked on each element with the following parameters:
- the current value of the accumulator of the group if there is currently one;
- a reference to the key of the group this element belongs to;
- the element from the source being aggregated;
If operation
returns Some(element)
then the accumulator is updated with element
,
otherwise the previous accumulation is discarded.
Return a HashMap
associating the key of each group with the result of aggregation of
that group’s elements. If the aggregation of the last element of a group discards the
accumulator then there won’t be an entry associated to that group’s key.
use itertools::Itertools;
let data = vec![2, 8, 5, 7, 9, 0, 4, 10];
let lookup = data.into_iter()
.into_grouping_map_by(|&n| n % 4)
.aggregate(|acc, _key, val| {
if val == 0 || val == 10 {
None
} else {
Some(acc.unwrap_or(0) + val)
}
});
assert_eq!(lookup[&0], 4); // 0 resets the accumulator so only 4 is summed
assert_eq!(lookup[&1], 5 + 9);
assert_eq!(lookup.get(&2), None); // 10 resets the accumulator and nothing is summed afterward
assert_eq!(lookup[&3], 7);
assert_eq!(lookup.len(), 3); // The final keys are only 0, 1 and 2
pub fn fold_with<FI, FO, R>(self, init: FI, operation: FO) -> HashMap<K, R>
pub fn fold_with<FI, FO, R>(self, init: FI, operation: FO) -> HashMap<K, R>
Groups elements from the GroupingMap
source by key and applies operation
to the elements
of each group sequentially, passing the previously accumulated value, a reference to the key
and the current element as arguments, and stores the results in a new map.
init
is called to obtain the initial value of each accumulator.
operation
is a function that is invoked on each element with the following parameters:
- the current value of the accumulator of the group;
- a reference to the key of the group this element belongs to;
- the element from the source being accumulated.
Return a HashMap
associating the key of each group with the result of folding that group’s elements.
use itertools::Itertools;
#[derive(Debug, Default)]
struct Accumulator {
acc: usize,
}
let lookup = (1..=7)
.into_grouping_map_by(|&n| n % 3)
.fold_with(|_key, _val| Default::default(), |Accumulator { acc }, _key, val| {
let acc = acc + val;
Accumulator { acc }
});
assert_eq!(lookup[&0].acc, 3 + 6);
assert_eq!(lookup[&1].acc, 1 + 4 + 7);
assert_eq!(lookup[&2].acc, 2 + 5);
assert_eq!(lookup.len(), 3);
pub fn fold<FO, R>(self, init: R, operation: FO) -> HashMap<K, R>
pub fn fold<FO, R>(self, init: R, operation: FO) -> HashMap<K, R>
Groups elements from the GroupingMap
source by key and applies operation
to the elements
of each group sequentially, passing the previously accumulated value, a reference to the key
and the current element as arguments, and stores the results in a new map.
init
is the value from which will be cloned the initial value of each accumulator.
operation
is a function that is invoked on each element with the following parameters:
- the current value of the accumulator of the group;
- a reference to the key of the group this element belongs to;
- the element from the source being accumulated.
Return a HashMap
associating the key of each group with the result of folding that group’s elements.
use itertools::Itertools;
let lookup = (1..=7)
.into_grouping_map_by(|&n| n % 3)
.fold(0, |acc, _key, val| acc + val);
assert_eq!(lookup[&0], 3 + 6);
assert_eq!(lookup[&1], 1 + 4 + 7);
assert_eq!(lookup[&2], 2 + 5);
assert_eq!(lookup.len(), 3);
pub fn reduce<FO>(self, operation: FO) -> HashMap<K, V>
pub fn reduce<FO>(self, operation: FO) -> HashMap<K, V>
Groups elements from the GroupingMap
source by key and applies operation
to the elements
of each group sequentially, passing the previously accumulated value, a reference to the key
and the current element as arguments, and stores the results in a new map.
This is similar to fold
but the initial value of the accumulator is the first element of the group.
operation
is a function that is invoked on each element with the following parameters:
- the current value of the accumulator of the group;
- a reference to the key of the group this element belongs to;
- the element from the source being accumulated.
Return a HashMap
associating the key of each group with the result of folding that group’s elements.
use itertools::Itertools;
let lookup = (1..=7)
.into_grouping_map_by(|&n| n % 3)
.reduce(|acc, _key, val| acc + val);
assert_eq!(lookup[&0], 3 + 6);
assert_eq!(lookup[&1], 1 + 4 + 7);
assert_eq!(lookup[&2], 2 + 5);
assert_eq!(lookup.len(), 3);
pub fn fold_first<FO>(self, operation: FO) -> HashMap<K, V>
👎Deprecated since 0.13.0: Use .reduce() instead
pub fn fold_first<FO>(self, operation: FO) -> HashMap<K, V>
See .reduce()
.
pub fn collect<C>(self) -> HashMap<K, C>
pub fn collect<C>(self) -> HashMap<K, C>
Groups elements from the GroupingMap
source by key and collects the elements of each group in
an instance of C
. The iteration order is preserved when inserting elements.
Return a HashMap
associating the key of each group with the collection containing that group’s elements.
use itertools::Itertools;
use std::collections::HashSet;
let lookup = vec![0, 1, 2, 3, 4, 5, 6, 2, 3, 6].into_iter()
.into_grouping_map_by(|&n| n % 3)
.collect::<HashSet<_>>();
assert_eq!(lookup[&0], vec![0, 3, 6].into_iter().collect::<HashSet<_>>());
assert_eq!(lookup[&1], vec![1, 4].into_iter().collect::<HashSet<_>>());
assert_eq!(lookup[&2], vec![2, 5].into_iter().collect::<HashSet<_>>());
assert_eq!(lookup.len(), 3);
pub fn max(self) -> HashMap<K, V>where
V: Ord,
pub fn max(self) -> HashMap<K, V>where
V: Ord,
Groups elements from the GroupingMap
source by key and finds the maximum of each group.
If several elements are equally maximum, the last element is picked.
Returns a HashMap
associating the key of each group with the maximum of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.max();
assert_eq!(lookup[&0], 12);
assert_eq!(lookup[&1], 7);
assert_eq!(lookup[&2], 8);
assert_eq!(lookup.len(), 3);
pub fn max_by<F>(self, compare: F) -> HashMap<K, V>
pub fn max_by<F>(self, compare: F) -> HashMap<K, V>
Groups elements from the GroupingMap
source by key and finds the maximum of each group
with respect to the specified comparison function.
If several elements are equally maximum, the last element is picked.
Returns a HashMap
associating the key of each group with the maximum of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.max_by(|_key, x, y| y.cmp(x));
assert_eq!(lookup[&0], 3);
assert_eq!(lookup[&1], 1);
assert_eq!(lookup[&2], 5);
assert_eq!(lookup.len(), 3);
pub fn max_by_key<F, CK>(self, f: F) -> HashMap<K, V>
pub fn max_by_key<F, CK>(self, f: F) -> HashMap<K, V>
Groups elements from the GroupingMap
source by key and finds the element of each group
that gives the maximum from the specified function.
If several elements are equally maximum, the last element is picked.
Returns a HashMap
associating the key of each group with the maximum of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.max_by_key(|_key, &val| val % 4);
assert_eq!(lookup[&0], 3);
assert_eq!(lookup[&1], 7);
assert_eq!(lookup[&2], 5);
assert_eq!(lookup.len(), 3);
pub fn min(self) -> HashMap<K, V>where
V: Ord,
pub fn min(self) -> HashMap<K, V>where
V: Ord,
Groups elements from the GroupingMap
source by key and finds the minimum of each group.
If several elements are equally minimum, the first element is picked.
Returns a HashMap
associating the key of each group with the minimum of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.min();
assert_eq!(lookup[&0], 3);
assert_eq!(lookup[&1], 1);
assert_eq!(lookup[&2], 5);
assert_eq!(lookup.len(), 3);
pub fn min_by<F>(self, compare: F) -> HashMap<K, V>
pub fn min_by<F>(self, compare: F) -> HashMap<K, V>
Groups elements from the GroupingMap
source by key and finds the minimum of each group
with respect to the specified comparison function.
If several elements are equally minimum, the first element is picked.
Returns a HashMap
associating the key of each group with the minimum of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.min_by(|_key, x, y| y.cmp(x));
assert_eq!(lookup[&0], 12);
assert_eq!(lookup[&1], 7);
assert_eq!(lookup[&2], 8);
assert_eq!(lookup.len(), 3);
pub fn min_by_key<F, CK>(self, f: F) -> HashMap<K, V>
pub fn min_by_key<F, CK>(self, f: F) -> HashMap<K, V>
Groups elements from the GroupingMap
source by key and finds the element of each group
that gives the minimum from the specified function.
If several elements are equally minimum, the first element is picked.
Returns a HashMap
associating the key of each group with the minimum of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.min_by_key(|_key, &val| val % 4);
assert_eq!(lookup[&0], 12);
assert_eq!(lookup[&1], 4);
assert_eq!(lookup[&2], 8);
assert_eq!(lookup.len(), 3);
pub fn minmax(self) -> HashMap<K, MinMaxResult<V>>where
V: Ord,
pub fn minmax(self) -> HashMap<K, MinMaxResult<V>>where
V: Ord,
Groups elements from the GroupingMap
source by key and find the maximum and minimum of
each group.
If several elements are equally maximum, the last element is picked. If several elements are equally minimum, the first element is picked.
See Itertools::minmax
for the non-grouping version.
Differences from the non grouping version:
- It never produces a
MinMaxResult::NoElements
- It doesn’t have any speedup
Returns a HashMap
associating the key of each group with the minimum and maximum of that group’s elements.
use itertools::Itertools;
use itertools::MinMaxResult::{OneElement, MinMax};
let lookup = vec![1, 3, 4, 5, 7, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.minmax();
assert_eq!(lookup[&0], MinMax(3, 12));
assert_eq!(lookup[&1], MinMax(1, 7));
assert_eq!(lookup[&2], OneElement(5));
assert_eq!(lookup.len(), 3);
pub fn minmax_by<F>(self, compare: F) -> HashMap<K, MinMaxResult<V>>
pub fn minmax_by<F>(self, compare: F) -> HashMap<K, MinMaxResult<V>>
Groups elements from the GroupingMap
source by key and find the maximum and minimum of
each group with respect to the specified comparison function.
If several elements are equally maximum, the last element is picked. If several elements are equally minimum, the first element is picked.
It has the same differences from the non-grouping version as minmax
.
Returns a HashMap
associating the key of each group with the minimum and maximum of that group’s elements.
use itertools::Itertools;
use itertools::MinMaxResult::{OneElement, MinMax};
let lookup = vec![1, 3, 4, 5, 7, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.minmax_by(|_key, x, y| y.cmp(x));
assert_eq!(lookup[&0], MinMax(12, 3));
assert_eq!(lookup[&1], MinMax(7, 1));
assert_eq!(lookup[&2], OneElement(5));
assert_eq!(lookup.len(), 3);
pub fn minmax_by_key<F, CK>(self, f: F) -> HashMap<K, MinMaxResult<V>>
pub fn minmax_by_key<F, CK>(self, f: F) -> HashMap<K, MinMaxResult<V>>
Groups elements from the GroupingMap
source by key and find the elements of each group
that gives the minimum and maximum from the specified function.
If several elements are equally maximum, the last element is picked. If several elements are equally minimum, the first element is picked.
It has the same differences from the non-grouping version as minmax
.
Returns a HashMap
associating the key of each group with the minimum and maximum of that group’s elements.
use itertools::Itertools;
use itertools::MinMaxResult::{OneElement, MinMax};
let lookup = vec![1, 3, 4, 5, 7, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.minmax_by_key(|_key, &val| val % 4);
assert_eq!(lookup[&0], MinMax(12, 3));
assert_eq!(lookup[&1], MinMax(4, 7));
assert_eq!(lookup[&2], OneElement(5));
assert_eq!(lookup.len(), 3);
pub fn sum(self) -> HashMap<K, V>where
V: Add<Output = V>,
pub fn sum(self) -> HashMap<K, V>where
V: Add<Output = V>,
Groups elements from the GroupingMap
source by key and sums them.
This is just a shorthand for self.reduce(|acc, _, val| acc + val)
.
It is more limited than Iterator::sum
since it doesn’t use the Sum
trait.
Returns a HashMap
associating the key of each group with the sum of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.sum();
assert_eq!(lookup[&0], 3 + 9 + 12);
assert_eq!(lookup[&1], 1 + 4 + 7);
assert_eq!(lookup[&2], 5 + 8);
assert_eq!(lookup.len(), 3);
pub fn product(self) -> HashMap<K, V>where
V: Mul<Output = V>,
pub fn product(self) -> HashMap<K, V>where
V: Mul<Output = V>,
Groups elements from the GroupingMap
source by key and multiply them.
This is just a shorthand for self.reduce(|acc, _, val| acc * val)
.
It is more limited than Iterator::product
since it doesn’t use the Product
trait.
Returns a HashMap
associating the key of each group with the product of that group’s elements.
use itertools::Itertools;
let lookup = vec![1, 3, 4, 5, 7, 8, 9, 12].into_iter()
.into_grouping_map_by(|&n| n % 3)
.product();
assert_eq!(lookup[&0], 3 * 9 * 12);
assert_eq!(lookup[&1], 1 * 4 * 7);
assert_eq!(lookup[&2], 5 * 8);
assert_eq!(lookup.len(), 3);
Trait Implementations§
§impl<I> Clone for GroupingMap<I>where
I: Clone,
impl<I> Clone for GroupingMap<I>where
I: Clone,
§fn clone(&self) -> GroupingMap<I>
fn clone(&self) -> GroupingMap<I>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl<I> Freeze for GroupingMap<I>where
I: Freeze,
impl<I> RefUnwindSafe for GroupingMap<I>where
I: RefUnwindSafe,
impl<I> Send for GroupingMap<I>where
I: Send,
impl<I> Sync for GroupingMap<I>where
I: Sync,
impl<I> Unpin for GroupingMap<I>where
I: Unpin,
impl<I> UnwindSafe for GroupingMap<I>where
I: UnwindSafe,
Blanket Implementations§
§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
§type ArchivedMetadata = ()
type ArchivedMetadata = ()
§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> ByteSized for T
impl<T> ByteSized for T
Source§const BYTE_ALIGN: usize = _
const BYTE_ALIGN: usize = _
Source§fn byte_align(&self) -> usize
fn byte_align(&self) -> usize
Source§fn ptr_size_ratio(&self) -> [usize; 2]
fn ptr_size_ratio(&self) -> [usize; 2]
Source§impl<T, R> Chain<R> for Twhere
T: ?Sized,
impl<T, R> Chain<R> for Twhere
T: ?Sized,
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> ExtAny for T
impl<T> ExtAny for T
Source§fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
Source§impl<T> ExtMem for Twhere
T: ?Sized,
impl<T> ExtMem for Twhere
T: ?Sized,
Source§const NEEDS_DROP: bool = _
const NEEDS_DROP: bool = _
Source§fn mem_align_of<T>() -> usize
fn mem_align_of<T>() -> usize
Source§fn mem_align_of_val(&self) -> usize
fn mem_align_of_val(&self) -> usize
Source§fn mem_size_of<T>() -> usize
fn mem_size_of<T>() -> usize
Source§fn mem_size_of_val(&self) -> usize
fn mem_size_of_val(&self) -> usize
Source§fn mem_needs_drop(&self) -> bool
fn mem_needs_drop(&self) -> bool
true
if dropping values of this type matters. Read moreSource§fn mem_forget(self)where
Self: Sized,
fn mem_forget(self)where
Self: Sized,
self
without running its destructor. Read moreSource§fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
Source§unsafe fn mem_zeroed<T>() -> T
unsafe fn mem_zeroed<T>() -> T
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§fn mem_as_bytes(&self) -> &[u8] ⓘ
fn mem_as_bytes(&self) -> &[u8] ⓘ
unsafe_slice
only.§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> Hook for T
impl<T> Hook for T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError> ⓘ
§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out
indicating that a T
is niched.