leo_passes/loop_unrolling/
range_iterator.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
// Copyright (C) 2019-2025 Provable Inc.
// This file is part of the Leo library.

// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.

use num_traits::One;
use std::{fmt::Display, ops::Add};

use leo_ast::Value;
use leo_errors::LeoError;

// TODO: Consider the sealing this trait.
// TODO: Better name.
/// A trait for whose implementors are concrete values for loop bounds.
pub(crate) trait LoopBound:
    Add<Output = Self> + Copy + Display + One + PartialOrd + TryFrom<Value, Error = LeoError>
{
}

impl LoopBound for i128 {}
impl LoopBound for u128 {}

/// Whether or not a bound is inclusive or exclusive.
pub(crate) enum Clusivity {
    Inclusive,
    Exclusive,
}

/// An iterator over a range of values.
pub(crate) struct RangeIterator<I: LoopBound> {
    end: I,
    current: Option<I>,
    clusivity: Clusivity,
}

impl<I: LoopBound> RangeIterator<I> {
    pub(crate) fn new(start: I, end: I, clusivity: Clusivity) -> Self {
        Self { end, current: Some(start), clusivity }
    }
}

impl<I: LoopBound> Iterator for RangeIterator<I> {
    type Item = I;

    fn next(&mut self) -> Option<Self::Item> {
        match self.current {
            None => None,
            Some(value) if value < self.end => {
                self.current = Some(value.add(I::one()));
                Some(value)
            }
            Some(value) => {
                self.current = None;
                match self.clusivity {
                    Clusivity::Exclusive => None,
                    Clusivity::Inclusive => Some(value),
                }
            }
        }
    }
}