malachite_nz/integer_vector/conversion/
into_iterator.rs

1// Copyright © 2026 Mikhail Hogrefe
2//
3// This file is part of Malachite.
4//
5// Malachite is free software: you can redistribute it and/or modify it under the terms of the GNU
6// Lesser General Public License (LGPL) as published by the Free Software Foundation; either version
7// 3 of the License, or (at your option) any later version. See <https://www.gnu.org/licenses/>.
8
9use crate::integer::Integer;
10use crate::integer_vector::IntegerVector;
11use alloc::vec;
12use core::slice;
13
14impl IntoIterator for IntegerVector {
15    type Item = Integer;
16    type IntoIter = vec::IntoIter<Integer>;
17
18    /// Converts an [`IntegerVector`] into an iterator over its elements, taking the vector by
19    /// value.
20    ///
21    /// The elements are produced in order, starting with the element at index 0.
22    ///
23    /// # Worst-case complexity
24    /// Constant time and additional memory.
25    ///
26    /// # Examples
27    /// ```
28    /// use core::str::FromStr;
29    /// use malachite_nz::integer_vector::IntegerVector;
30    ///
31    /// let v = IntegerVector::from_str("(1, -2, 3)").unwrap();
32    /// assert_eq!(
33    ///     v.into_iter().map(|x| x.to_string()).collect::<Vec<_>>(),
34    ///     ["1", "-2", "3"]
35    /// );
36    /// ```
37    #[inline]
38    fn into_iter(self) -> vec::IntoIter<Integer> {
39        self.elements.into_iter()
40    }
41}
42
43impl<'a> IntoIterator for &'a IntegerVector {
44    type Item = &'a Integer;
45    type IntoIter = slice::Iter<'a, Integer>;
46
47    /// Converts a reference to an [`IntegerVector`] into an iterator over references to its
48    /// elements.
49    ///
50    /// The elements are produced in order, starting with the element at index 0. This is what `for
51    /// x in &v` uses.
52    ///
53    /// # Worst-case complexity
54    /// Constant time and additional memory.
55    ///
56    /// # Examples
57    /// ```
58    /// use core::str::FromStr;
59    /// use malachite_nz::integer_vector::IntegerVector;
60    ///
61    /// let v = IntegerVector::from_str("(1, -2, 3)").unwrap();
62    /// let mut strings = Vec::new();
63    /// for x in &v {
64    ///     strings.push(x.to_string());
65    /// }
66    /// assert_eq!(strings, ["1", "-2", "3"]);
67    /// ```
68    #[inline]
69    fn into_iter(self) -> slice::Iter<'a, Integer> {
70        self.elements.iter()
71    }
72}
73
74impl<'a> IntoIterator for &'a mut IntegerVector {
75    type Item = &'a mut Integer;
76    type IntoIter = slice::IterMut<'a, Integer>;
77
78    /// Converts a mutable reference to an [`IntegerVector`] into an iterator over mutable
79    /// references to its elements.
80    ///
81    /// The elements are produced in order, starting with the element at index 0. This is what `for
82    /// x in &mut v` uses; since every list of elements is a valid vector, any element may be
83    /// changed.
84    ///
85    /// # Worst-case complexity
86    /// Constant time and additional memory.
87    ///
88    /// # Examples
89    /// ```
90    /// use core::str::FromStr;
91    /// use malachite_base::num::basic::traits::One;
92    /// use malachite_nz::integer::Integer;
93    /// use malachite_nz::integer_vector::IntegerVector;
94    ///
95    /// let mut v = IntegerVector::from_str("(1, -2, 3)").unwrap();
96    /// for x in &mut v {
97    ///     *x += Integer::ONE;
98    /// }
99    /// assert_eq!(v.to_string(), "(2, -1, 4)");
100    /// ```
101    #[inline]
102    fn into_iter(self) -> slice::IterMut<'a, Integer> {
103        self.elements.iter_mut()
104    }
105}
malachite_nz/integer_vector/conversion/into_iterator.rs

malachite_nz/integer_vector/conversion/
into_iterator.rs
