Trait sp_std::iter::Sum

pub trait Sum<A = Self> {
    fn sum<I>(iter: I) -> Self
    where
        I: Iterator<Item = A>;
}

Trait to represent types that can be created by summing up an iterator.

This trait is used to implement Iterator::sum(). Types which implement this trait can be generated by using the sum() method on an iterator. Like FromIterator, this trait should rarely be called directly.

Required methods

fn sum<I>(iter: I) -> Self where
    I: Iterator<Item = A>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

Implementations on Foreign Types

impl<'a> Sum<&'a f64> for f64

pub fn sum<I>(iter: I) -> f64 where
    I: Iterator<Item = &'a f64>, 

impl<const LANES: usize> Sum<Simd<u32, LANES>> for Simd<u32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u32, LANES> where
    I: Iterator<Item = Simd<u32, LANES>>, 

impl<const LANES: usize> Sum<Simd<u8, LANES>> for Simd<u8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u8, LANES> where
    I: Iterator<Item = Simd<u8, LANES>>, 

impl Sum<usize> for usize

pub fn sum<I>(iter: I) -> usize where
    I: Iterator<Item = usize>, 

impl<'a, const LANES: usize> Sum<&'a Simd<i16, LANES>> for Simd<i16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i16, LANES> where
    I: Iterator<Item = &'a Simd<i16, LANES>>, 

impl<const LANES: usize> Sum<Simd<i32, LANES>> for Simd<i32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i32, LANES> where
    I: Iterator<Item = Simd<i32, LANES>>, 

impl Sum<u16> for u16

pub fn sum<I>(iter: I) -> u16 where
    I: Iterator<Item = u16>, 

impl<'a, const LANES: usize> Sum<&'a Simd<f32, LANES>> for Simd<f32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<f32, LANES> where
    I: Iterator<Item = &'a Simd<f32, LANES>>, 

impl Sum<i16> for i16

pub fn sum<I>(iter: I) -> i16 where
    I: Iterator<Item = i16>, 

impl<'a, const LANES: usize> Sum<&'a Simd<i32, LANES>> for Simd<i32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i32, LANES> where
    I: Iterator<Item = &'a Simd<i32, LANES>>, 

impl<'a, const LANES: usize> Sum<&'a Simd<usize, LANES>> for Simd<usize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<usize, LANES> where
    I: Iterator<Item = &'a Simd<usize, LANES>>, 

impl<'a> Sum<&'a i8> for i8

pub fn sum<I>(iter: I) -> i8 where
    I: Iterator<Item = &'a i8>, 

impl<'a> Sum<&'a u8> for u8

pub fn sum<I>(iter: I) -> u8 where
    I: Iterator<Item = &'a u8>, 

impl<const LANES: usize> Sum<Simd<i64, LANES>> for Simd<i64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i64, LANES> where
    I: Iterator<Item = Simd<i64, LANES>>, 

impl<const LANES: usize> Sum<Simd<isize, LANES>> for Simd<isize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<isize, LANES> where
    I: Iterator<Item = Simd<isize, LANES>>, 

impl<'a, const LANES: usize> Sum<&'a Simd<i8, LANES>> for Simd<i8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i8, LANES> where
    I: Iterator<Item = &'a Simd<i8, LANES>>, 

impl<'a> Sum<&'a i64> for i64

pub fn sum<I>(iter: I) -> i64 where
    I: Iterator<Item = &'a i64>, 

impl<'a> Sum<&'a i128> for i128

pub fn sum<I>(iter: I) -> i128 where
    I: Iterator<Item = &'a i128>, 

impl Sum<i128> for i128

pub fn sum<I>(iter: I) -> i128 where
    I: Iterator<Item = i128>, 

impl<'a> Sum<&'a usize> for usize

pub fn sum<I>(iter: I) -> usize where
    I: Iterator<Item = &'a usize>, 

impl<'a, const LANES: usize> Sum<&'a Simd<i64, LANES>> for Simd<i64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i64, LANES> where
    I: Iterator<Item = &'a Simd<i64, LANES>>, 

impl Sum<i32> for i32

pub fn sum<I>(iter: I) -> i32 where
    I: Iterator<Item = i32>, 

impl<'a, const LANES: usize> Sum<&'a Simd<isize, LANES>> for Simd<isize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<isize, LANES> where
    I: Iterator<Item = &'a Simd<isize, LANES>>, 

impl<const LANES: usize> Sum<Simd<f32, LANES>> for Simd<f32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<f32, LANES> where
    I: Iterator<Item = Simd<f32, LANES>>, 

impl Sum<f64> for f64

pub fn sum<I>(iter: I) -> f64 where
    I: Iterator<Item = f64>, 

impl Sum<i64> for i64

pub fn sum<I>(iter: I) -> i64 where
    I: Iterator<Item = i64>, 

impl<'a> Sum<&'a Duration> for Duration

pub fn sum<I>(iter: I) -> Duration where
    I: Iterator<Item = &'a Duration>, 

impl<'a> Sum<&'a f32> for f32

pub fn sum<I>(iter: I) -> f32 where
    I: Iterator<Item = &'a f32>, 

impl<'a, const LANES: usize> Sum<&'a Simd<u32, LANES>> for Simd<u32, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u32, LANES> where
    I: Iterator<Item = &'a Simd<u32, LANES>>, 

impl Sum<f32> for f32

pub fn sum<I>(iter: I) -> f32 where
    I: Iterator<Item = f32>, 

impl<'a, const LANES: usize> Sum<&'a Simd<u64, LANES>> for Simd<u64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u64, LANES> where
    I: Iterator<Item = &'a Simd<u64, LANES>>, 

impl<T, U> Sum<Option<U>> for Option<T> where
    T: Sum<U>, 

pub fn sum<I>(iter: I) -> Option<T> where
    I: Iterator<Item = Option<U>>, 

Takes each element in the Iterator: if it is a None, no further elements are taken, and the None is returned. Should no None occur, the sum of all elements is returned.

Examples

This sums up the position of the character ‘a’ in a vector of strings, if a word did not have the character ‘a’ the operation returns None:

let words = vec!["have", "a", "great", "day"];
let total: Option<usize> = words.iter().map(|w| w.find('a')).sum();
assert_eq!(total, Some(5));

impl<'a> Sum<&'a u128> for u128

pub fn sum<I>(iter: I) -> u128 where
    I: Iterator<Item = &'a u128>, 

impl Sum<u128> for u128

pub fn sum<I>(iter: I) -> u128 where
    I: Iterator<Item = u128>, 

impl<const LANES: usize> Sum<Simd<u64, LANES>> for Simd<u64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u64, LANES> where
    I: Iterator<Item = Simd<u64, LANES>>, 

impl<'a, const LANES: usize> Sum<&'a Simd<u16, LANES>> for Simd<u16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u16, LANES> where
    I: Iterator<Item = &'a Simd<u16, LANES>>, 

impl<'a> Sum<&'a isize> for isize

pub fn sum<I>(iter: I) -> isize where
    I: Iterator<Item = &'a isize>, 

impl Sum<i8> for i8

pub fn sum<I>(iter: I) -> i8 where
    I: Iterator<Item = i8>, 

impl<const LANES: usize> Sum<Simd<f64, LANES>> for Simd<f64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<f64, LANES> where
    I: Iterator<Item = Simd<f64, LANES>>, 

impl<'a> Sum<&'a i32> for i32

pub fn sum<I>(iter: I) -> i32 where
    I: Iterator<Item = &'a i32>, 

impl Sum<u32> for u32

pub fn sum<I>(iter: I) -> u32 where
    I: Iterator<Item = u32>, 

impl<'a> Sum<&'a i16> for i16

pub fn sum<I>(iter: I) -> i16 where
    I: Iterator<Item = &'a i16>, 

impl<const LANES: usize> Sum<Simd<usize, LANES>> for Simd<usize, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<usize, LANES> where
    I: Iterator<Item = Simd<usize, LANES>>, 

impl Sum<u8> for u8

pub fn sum<I>(iter: I) -> u8 where
    I: Iterator<Item = u8>, 

impl Sum<Duration> for Duration

pub fn sum<I>(iter: I) -> Duration where
    I: Iterator<Item = Duration>, 

impl<'a> Sum<&'a u32> for u32

pub fn sum<I>(iter: I) -> u32 where
    I: Iterator<Item = &'a u32>, 

impl<const LANES: usize> Sum<Simd<u16, LANES>> for Simd<u16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u16, LANES> where
    I: Iterator<Item = Simd<u16, LANES>>, 

impl<'a, const LANES: usize> Sum<&'a Simd<u8, LANES>> for Simd<u8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<u8, LANES> where
    I: Iterator<Item = &'a Simd<u8, LANES>>, 

impl Sum<u64> for u64

pub fn sum<I>(iter: I) -> u64 where
    I: Iterator<Item = u64>, 

impl<const LANES: usize> Sum<Simd<i8, LANES>> for Simd<i8, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i8, LANES> where
    I: Iterator<Item = Simd<i8, LANES>>, 

impl<const LANES: usize> Sum<Simd<i16, LANES>> for Simd<i16, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<i16, LANES> where
    I: Iterator<Item = Simd<i16, LANES>>, 

impl<'a> Sum<&'a u16> for u16

pub fn sum<I>(iter: I) -> u16 where
    I: Iterator<Item = &'a u16>, 

impl<'a, const LANES: usize> Sum<&'a Simd<f64, LANES>> for Simd<f64, LANES> where
    LaneCount<LANES>: SupportedLaneCount, 

pub fn sum<I>(iter: I) -> Simd<f64, LANES> where
    I: Iterator<Item = &'a Simd<f64, LANES>>, 

impl<'a> Sum<&'a u64> for u64

pub fn sum<I>(iter: I) -> u64 where
    I: Iterator<Item = &'a u64>, 

impl Sum<isize> for isize

pub fn sum<I>(iter: I) -> isize where
    I: Iterator<Item = isize>, 

Implementors

impl Sum<Wrapping<i8>> for Wrapping<i8>

impl Sum<Wrapping<i16>> for Wrapping<i16>

impl Sum<Wrapping<i32>> for Wrapping<i32>

impl Sum<Wrapping<i64>> for Wrapping<i64>

impl Sum<Wrapping<i128>> for Wrapping<i128>

impl Sum<Wrapping<isize>> for Wrapping<isize>

impl Sum<Wrapping<u8>> for Wrapping<u8>

impl Sum<Wrapping<u16>> for Wrapping<u16>

impl Sum<Wrapping<u32>> for Wrapping<u32>

impl Sum<Wrapping<u64>> for Wrapping<u64>

impl Sum<Wrapping<u128>> for Wrapping<u128>

impl Sum<Wrapping<usize>> for Wrapping<usize>

impl<'a> Sum<&'a Wrapping<i8>> for Wrapping<i8>

impl<'a> Sum<&'a Wrapping<i16>> for Wrapping<i16>

impl<'a> Sum<&'a Wrapping<i32>> for Wrapping<i32>

impl<'a> Sum<&'a Wrapping<i64>> for Wrapping<i64>

impl<'a> Sum<&'a Wrapping<i128>> for Wrapping<i128>

impl<'a> Sum<&'a Wrapping<isize>> for Wrapping<isize>

impl<'a> Sum<&'a Wrapping<u8>> for Wrapping<u8>

impl<'a> Sum<&'a Wrapping<u16>> for Wrapping<u16>

impl<'a> Sum<&'a Wrapping<u32>> for Wrapping<u32>

impl<'a> Sum<&'a Wrapping<u64>> for Wrapping<u64>

impl<'a> Sum<&'a Wrapping<u128>> for Wrapping<u128>

impl<'a> Sum<&'a Wrapping<usize>> for Wrapping<usize>

impl<T, U, E> Sum<Result<U, E>> for Result<T, E> where
    T: Sum<U>,