malachite-base 0.14.0

A collection of utilities, including new arithmetic traits and iterators that generate all values of a type.
Documentation
// Copyright © 2026 Mikhail Hogrefe
//
// This file is part of Malachite.
//
// Malachite is free software: you can redistribute it and/or modify it under the terms of the GNU
// Lesser General Public License (LGPL) as published by the Free Software Foundation; either version
// 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/>.

use crate::num::arithmetic::traits::ModElementSum;
use crate::num::basic::unsigneds::PrimitiveUnsigned;
use crate::unsigned_vector::UnsignedVector;

impl<T: PrimitiveUnsigned> ModElementSum<T> for UnsignedVector<T> {
    type Output = T;

    /// Returns the sum of the elements of an [`UnsignedVector`] modulo another number $m$, taking
    /// the vector by reference. The elements must already be reduced.
    ///
    /// The 0-dimensional vector has no elements, and their sum is 0.
    ///
    /// $$
    /// f(v, m) = \sum_i v_i \bmod m.
    /// $$
    ///
    /// # Worst-case complexity
    /// $T(n) = O(n)$
    ///
    /// $M(n) = O(1)$
    ///
    /// where $T$ is time, $M$ is additional memory, $n$ is the total number of bits of the
    /// elements.
    ///
    /// # Panics
    /// Panics if `m` is zero, or if any element is greater than or equal to `m`.
    ///
    /// # Examples
    /// ```
    /// use core::str::FromStr;
    /// use malachite_base::num::arithmetic::traits::ModElementSum;
    /// use malachite_base::unsigned_vector::UnsignedVector;
    ///
    /// let v = UnsignedVector::<u8>::from_str("(5, 6, 7)").unwrap();
    /// assert_eq!(v.to_mod_element_sum(10), 8);
    /// let v = UnsignedVector::<u8>::from_str("()").unwrap();
    /// assert_eq!(v.to_mod_element_sum(10), 0);
    /// ```
    #[inline]
    fn to_mod_element_sum(&self, m: T) -> T {
        T::mod_sum(self.elements.iter(), m)
    }

    /// Returns the sum of the elements of an [`UnsignedVector`] modulo another number $m$, taking
    /// the vector by value. The elements must already be reduced.
    ///
    /// The 0-dimensional vector has no elements, and their sum is 0.
    ///
    /// $$
    /// f(v, m) = \sum_i v_i \bmod m.
    /// $$
    ///
    /// # Worst-case complexity
    /// $T(n) = O(n)$
    ///
    /// $M(n) = O(1)$
    ///
    /// where $T$ is time, $M$ is additional memory, $n$ is the total number of bits of the
    /// elements.
    ///
    /// # Panics
    /// Panics if `m` is zero, or if any element is greater than or equal to `m`.
    ///
    /// # Examples
    /// ```
    /// use core::str::FromStr;
    /// use malachite_base::num::arithmetic::traits::ModElementSum;
    /// use malachite_base::unsigned_vector::UnsignedVector;
    ///
    /// let v = UnsignedVector::<u8>::from_str("(5, 6, 7)").unwrap();
    /// assert_eq!(v.into_mod_element_sum(10), 8);
    /// let v = UnsignedVector::<u8>::from_str("()").unwrap();
    /// assert_eq!(v.into_mod_element_sum(10), 0);
    /// ```
    #[inline]
    fn into_mod_element_sum(self, m: T) -> T {
        T::mod_sum(self.elements.into_iter(), m)
    }
}