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
// 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::Float;
use crate::malachite_base::num::arithmetic::traits::{ShrRound, ShrRoundAssign};
use core::ops::{Shr, ShrAssign};
use malachite_base::rounding_modes::RoundingMode::*;
macro_rules! impl_shr {
($t:ident) => {
impl Shr<$t> for Float {
type Output = Float;
/// Left-shifts a [`Float`] (multiplies it by a power of 2), taking it by value.
///
/// `NaN`, infinities, and zeros are unchanged. If the [`Float`] has a precision, the
/// output has the same precision.
///
/// $$
/// f(x, k) = x/2^k.
/// $$
///
/// - If $f(x,k)\geq 2^{2^{30}-1}$, $\infty$ is returned instead.
/// - If $f(x,k)\leq -2^{2^{30}-1}$, $-\infty$ is returned instead.
/// - If $0<f(x,k)\leq2^{-2^{30}-1}$, $0.0$ is returned instead.
/// - If $2^{-2^{30}-1}<f(x,k)<2^{-2^{30}}$, $2^{-2^{30}}$ is returned instead.
/// - If $-2^{-2^{30}-1}\leq f(x,k)<0$, $-0.0$ is returned instead.
/// - If $-2^{-2^{30}}<f(x,k)<-2^{-2^{30}-1}$, $-2^{-2^{30}}$ is returned instead.
///
/// Constant time and additional memory.
///
/// # Examples
/// See [here](super::shr#shr).
#[inline]
fn shr(self, bits: $t) -> Float {
self.shr_round(bits, Nearest).0
}
}
impl Shr<$t> for &Float {
type Output = Float;
/// Left-shifts a [`Float`] (multiplies it by a power of 2), taking it by value.
///
/// `NaN`, infinities, and zeros are unchanged. If the [`Float`] has a precision, the
/// output has the same precision.
///
/// $$
/// f(x, k) = x/2^k.
/// $$
///
/// - If $f(x,k)\geq 2^{2^{30}-1}$, $\infty$ is returned instead.
/// - If $f(x,k)\leq -2^{2^{30}-1}$, $-\infty$ is returned instead.
/// - If $0<f(x,k)\leq2^{-2^{30}-1}$, $0.0$ is returned instead.
/// - If $2^{-2^{30}-1}<f(x,k)<2^{-2^{30}}$, $2^{-2^{30}}$ is returned instead.
/// - If $-2^{-2^{30}-1}\leq f(x,k)<0$, $-0.0$ is returned instead.
/// - If $-2^{-2^{30}}<f(x,k)<-2^{-2^{30}-1}$, $-2^{-2^{30}}$ is returned instead.
///
/// Constant time and additional memory.
///
/// # Examples
/// See [here](super::shr#shr).
#[inline]
fn shr(self, bits: $t) -> Float {
self.shr_round(bits, Nearest).0
}
}
impl ShrAssign<$t> for Float {
/// Left-shifts a [`Float`] (multiplies it by a power of 2), in place.
///
/// `NaN`, infinities, and zeros are unchanged. If the [`Float`] has a precision, the
/// precision is unchanged.
///
/// $$
/// x \gets x/2^k.
/// $$
///
/// - If $f(x,k)\geq 2^{2^{30}-1}$, $\infty$ is assigned instead.
/// - If $f(x,k)\leq -2^{2^{30}-1}$, $-\infty$ is assigned instead.
/// - If $0<f(x,k)\leq2^{-2^{30}-1}$, $0.0$ is assigned instead.
/// - If $2^{-2^{30}-1}<f(x,k)<2^{-2^{30}}$, $2^{-2^{30}}$ is assigned instead.
/// - If $-2^{-2^{30}-1}\leq f(x,k)<0$, $-0.0$ is assigned instead.
/// - If $-2^{-2^{30}}<f(x,k)<-2^{-2^{30}-1}$, $-2^{-2^{30}}$ is assigned instead.
///
/// Constant time and additional memory.
///
/// # Examples
/// See [here](super::shr#shr_assign).
#[inline]
fn shr_assign(&mut self, bits: $t) {
self.shr_round_assign(bits, Nearest);
}
}
};
}
apply_to_primitive_ints!(impl_shr);