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

// 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::arithmetic::traits::{NextPowerOf2, NextPowerOf2Assign, PowerOf2, Sign};
use crate::num::basic::floats::PrimitiveFloat;
use crate::num::conversion::traits::SciMantissaAndExponent;
use core::cmp::Ordering::*;

macro_rules! impl_next_power_of_2_unsigned {
    ($t:ident) => {
        impl NextPowerOf2 for $t {
            type Output = $t;

            /// This is a wrapper over the `next_power_of_two` functions in the standard library,
            /// for example [this one](u32::next_power_of_two).
            #[inline]
            fn next_power_of_2(self) -> $t {
                $t::next_power_of_two(self)
            }
        }

        impl NextPowerOf2Assign for $t {
            /// Replaces a number with the smallest power of 2 greater than or equal to it.
            ///
            /// $x \gets 2^{\lceil \log_2 x \rceil}$.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Panics
            /// Panics if the next power of 2 is greater than the type's maximum value.
            ///
            /// # Examples
            /// See [here](super::next_power_of_2#next_power_of_2_assign).
            #[inline]
            fn next_power_of_2_assign(&mut self) {
                *self = $t::next_power_of_2(*self);
            }
        }
    };
}
apply_to_unsigneds!(impl_next_power_of_2_unsigned);

macro_rules! impl_next_power_of_2_primitive_float {
    ($t:ident) => {
        impl NextPowerOf2 for $t {
            type Output = $t;

            /// Finds the smallest power of 2 greater than or equal to a number.
            ///
            /// $x \gets 2^{\lceil \log_2 x \rceil}$.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Panics
            /// Panics if `self` has a negative sign (positive zero is allowed, but negative zero is
            /// not), or if the next power of 2 is greater than the type's maximum value.
            ///
            /// # Examples
            /// See [here](super::next_power_of_2#next_power_of_2).
            #[inline]
            fn next_power_of_2(self) -> $t {
                assert_eq!(self.sign(), Greater);
                assert!(self.is_finite());
                if self == 0.0 {
                    return $t::MIN_POSITIVE_SUBNORMAL;
                }
                let (mantissa, exponent) = self.sci_mantissa_and_exponent();
                if mantissa == 1.0 {
                    self
                } else if exponent == $t::MAX_EXPONENT {
                    panic!("Next power of 2 is too large to represent");
                } else {
                    $t::power_of_2(exponent + 1)
                }
            }
        }

        impl NextPowerOf2Assign for $t {
            /// Replaces a number with the smallest power of 2 greater than or equal to it.
            ///
            /// $x \gets 2^{\lceil \log_2 x \rceil}$.
            ///
            /// # Worst-case complexity
            /// Constant time and additional memory.
            ///
            /// # Panics
            /// Panics if the next power of 2 is greater than the type's maximum value.
            ///
            /// # Examples
            /// See [here](super::next_power_of_2#next_power_of_2_assign).
            #[inline]
            fn next_power_of_2_assign(&mut self) {
                *self = $t::next_power_of_2(*self);
            }
        }
    };
}
apply_to_primitive_floats!(impl_next_power_of_2_primitive_float);