Trait enso_prelude::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 the sum() method on iterators. Types which implement the trait can be generated by the sum() method. Like FromIterator this trait should rarely be called directly and instead interacted with through Iterator::sum().

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 Sum<Wrapping<i32>> for Wrapping<i32>

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

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

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

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

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

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

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

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

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

impl Sum<i8> for i8

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

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 Sum<u16> for u16

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

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

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

impl Sum<usize> for usize

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

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

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

impl Sum<Duration> for Duration

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

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

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

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

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

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

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

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

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

impl Sum<i64> for i64

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

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

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

impl Sum<f64> for f64

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

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

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

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

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

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

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

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

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

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

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

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

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

impl Sum<i16> for i16

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl Sum<f32> for f32

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Examples

This sums up every integer in a vector, rejecting the sum if a negative element is encountered:

let v = vec![1, 2];
let res: Result<i32, &'static str> = v.iter().map(|&x: &i32|
    if x < 0 { Err("Negative element found") }
    else { Ok(x) }
).sum();
assert_eq!(res, Ok(3));

impl Sum<isize> for isize

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

impl Sum<u128> for u128

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

impl Sum<i128> for i128

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

impl Sum<u8> for u8

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

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

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

impl Sum<u32> for u32

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

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

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

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

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

impl Sum<i32> for i32

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

impl Sum<u64> for u64

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

impl<T> Sum<T> for BigInt where
    BigInt: Add<T>,
    <BigInt as Add<T>>::Output == BigInt, 

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

impl<T> Sum<T> for BigUint where
    BigUint: Add<T>,
    <BigUint as Add<T>>::Output == BigUint, 

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

impl<T> Sum<Complex<T>> for Complex<T> where
    T: Num + Clone, 

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

impl<'a, T> Sum<&'a Complex<T>> for Complex<T> where
    T: 'a + Num + Clone, 

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

impl<T> Sum<Ratio<T>> for Ratio<T> where
    T: Integer + Clone, 

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

impl<'a, T> Sum<&'a Ratio<T>> for Ratio<T> where
    T: Integer + Clone, 

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

impl<T, C> Sum<Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer>> for Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer> where
    C: Dim,
    T: Scalar + ClosedAdd<T> + Zero,
    DefaultAllocator: Allocator<T, Dynamic, C>, 

pub fn sum<I>(
    iter: I
) -> Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer> where
    I: Iterator<Item = Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer>>, 

Example

assert_eq!(vec![DVector::repeat(3, 1.0f64),
                DVector::repeat(3, 1.0f64),
                DVector::repeat(3, 1.0f64)].into_iter().sum::<DVector<f64>>(),
           DVector::repeat(3, 1.0f64) + DVector::repeat(3, 1.0f64) + DVector::repeat(3, 1.0f64));

Panics

Panics if the iterator is empty:

iter::empty::<DMatrix<f64>>().sum::<DMatrix<f64>>(); // panics!

impl<'a, T, C> Sum<&'a Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer>> for Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer> where
    C: Dim,
    T: Scalar + ClosedAdd<T> + Zero,
    DefaultAllocator: Allocator<T, Dynamic, C>, 

pub fn sum<I>(
    iter: I
) -> Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer> where
    I: Iterator<Item = &'a Matrix<T, Dynamic, C, <DefaultAllocator as Allocator<T, Dynamic, C>>::Buffer>>, 

Example

let v = &DVector::repeat(3, 1.0f64);

assert_eq!(vec![v, v, v].into_iter().sum::<DVector<f64>>(),
           v + v + v);

Panics

Panics if the iterator is empty:

iter::empty::<&DMatrix<f64>>().sum::<DMatrix<f64>>(); // panics!

impl<T, R, C> Sum<Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>> for Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer> where
    C: DimName,
    T: Scalar + ClosedAdd<T> + Zero,
    R: DimName,
    DefaultAllocator: Allocator<T, R, C>, 

pub fn sum<I>(
    iter: I
) -> Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer> where
    I: Iterator<Item = Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>>, 

impl<'a, T, R, C> Sum<&'a Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>> for Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer> where
    C: DimName,
    T: Scalar + ClosedAdd<T> + Zero,
    R: DimName,
    DefaultAllocator: Allocator<T, R, C>, 

pub fn sum<I>(
    iter: I
) -> Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer> where
    I: Iterator<Item = &'a Matrix<T, R, C, <DefaultAllocator as Allocator<T, R, C>>::Buffer>>, 

impl<'a, T> Sum<&'a Complex<T>> for Complex<T> where
    T: 'a + Num + Clone, 

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

impl<T> Sum<Complex<T>> for Complex<T> where
    T: Num + Clone, 

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

impl<T> Sum<Ratio<T>> for Ratio<T> where
    T: Integer + Clone, 

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

impl<'a, T> Sum<&'a Ratio<T>> for Ratio<T> where
    T: Integer + Clone, 

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

Implementors