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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

// Copyright © 2024 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::basic::signeds::PrimitiveSigned;
use crate::num::basic::unsigneds::PrimitiveUnsigned;
use crate::num::logic::traits::{BitScan, TrailingZeros};

fn index_of_next_false_bit_unsigned<T: PrimitiveUnsigned>(x: T, start: u64) -> u64 {
    if start >= T::WIDTH {
        start
    } else {
        TrailingZeros::trailing_zeros(!(x | T::low_mask(start)))
    }
}

fn index_of_next_true_bit_unsigned<T: PrimitiveUnsigned>(x: T, start: u64) -> Option<u64> {
    if start >= T::WIDTH {
        None
    } else {
        let index = TrailingZeros::trailing_zeros(x & !T::low_mask(start));
        if index == T::WIDTH {
            None
        } else {
            Some(index)
        }
    }
}

macro_rules! impl_bit_scan_unsigned {
    ($t:ident) => {
        impl BitScan for $t {
            /// Given a number and a starting index, searches the number for the smallest index of a
            /// `false` bit that is greater than or equal to the starting index.
            ///
            /// Since the number is unsigned and therefore has an implicit prefix of infinitely-many
            /// zeros, this function always returns a value.
            ///
            /// Starting beyond the type's width is allowed; the result is the starting index.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Examples
            /// See [here](super::bit_scan#index_of_next_false_bit).
            #[inline]
            fn index_of_next_false_bit(self, start: u64) -> Option<u64> {
                Some(index_of_next_false_bit_unsigned(self, start))
            }

            /// Given a number and a starting index, searches the number for the smallest index of a
            /// `true` bit that is greater than or equal to the starting index.
            ///
            /// If the starting index is greater than or equal to the type's width, the result is
            /// `None` since there are no `true` bits past that point.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Examples
            /// See [here](super::bit_scan#index_of_next_true_bit).
            #[inline]
            fn index_of_next_true_bit(self, start: u64) -> Option<u64> {
                index_of_next_true_bit_unsigned(self, start)
            }
        }
    };
}
apply_to_unsigneds!(impl_bit_scan_unsigned);

fn index_of_next_false_bit_signed<T: PrimitiveSigned>(x: T, start: u64) -> Option<u64> {
    if start >= T::WIDTH - 1 {
        if x >= T::ZERO {
            Some(start)
        } else {
            None
        }
    } else {
        let index = TrailingZeros::trailing_zeros(!(x | T::low_mask(start)));
        if index == T::WIDTH {
            None
        } else {
            Some(index)
        }
    }
}

fn index_of_next_true_bit_signed<T: PrimitiveSigned>(x: T, start: u64) -> Option<u64> {
    if start >= T::WIDTH - 1 {
        if x >= T::ZERO {
            None
        } else {
            Some(start)
        }
    } else {
        let index = TrailingZeros::trailing_zeros(x & !T::low_mask(start));
        if index == T::WIDTH {
            None
        } else {
            Some(index)
        }
    }
}

macro_rules! impl_bit_scan_signed {
    ($t:ident) => {
        impl BitScan for $t {
            /// Given a number and a starting index, searches the number for the smallest index of a
            /// `false` bit that is greater than or equal to the starting index.
            ///
            /// If the starting index is greater than or equal to the type's width, then the result
            /// depends on whether the number is negative. If it is, then the result is `None` since
            /// there are no `false` bits past that point. If the number is non-negative, then the
            /// result is the starting index.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Examples
            /// See [here](super::bit_scan#index_of_next_false_bit).
            #[inline]
            fn index_of_next_false_bit(self, start: u64) -> Option<u64> {
                index_of_next_false_bit_signed(self, start)
            }

            /// Given a number and a starting index, searches the number for the smallest index of a
            /// `true` bit that is greater than or equal to the starting index.
            ///
            /// If the starting index is greater than or equal to the type's width, then the result
            /// depends on whether the number is non-negative. If it is, then the result is `None`
            /// since there are no `true` bits past that point. If the number is negative, then the
            /// result is the starting index.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Examples
            /// See [here](super::bit_scan#index_of_next_true_bit).
            #[inline]
            fn index_of_next_true_bit(self, start: u64) -> Option<u64> {
                index_of_next_true_bit_signed(self, start)
            }
        }
    };
}
apply_to_signeds!(impl_bit_scan_signed);