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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
// 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::conversion::traits::WrappingFrom;
use crate::num::logic::traits::{BitConvertible, LeadingZeros};
use alloc::vec::Vec;
fn to_bits_asc_unsigned<T: PrimitiveUnsigned>(x: &T) -> Vec<bool> {
let mut bits = Vec::new();
let mut x = *x;
while x != T::ZERO {
bits.push(x.odd());
x >>= 1;
}
bits
}
fn to_bits_desc_unsigned<T: PrimitiveUnsigned>(x: &T) -> Vec<bool> {
let mut bits = Vec::new();
if *x == T::ZERO {
return bits;
}
bits.push(true);
if *x == T::ONE {
return bits;
}
let mut mask = T::power_of_2(T::WIDTH - LeadingZeros::leading_zeros(*x) - 2);
while mask != T::ZERO {
bits.push(*x & mask != T::ZERO);
mask >>= 1;
}
bits
}
fn from_bits_asc_unsigned<T: PrimitiveUnsigned, I: Iterator<Item = bool>>(bits: I) -> T {
let mut n = T::ZERO;
let mut mask = T::ONE;
for bit in bits {
if mask == T::ZERO {
assert!(!bit, "Bits cannot fit in integer of type {}", T::NAME);
} else {
if bit {
n |= mask;
}
mask <<= 1;
}
}
n
}
#[inline]
fn from_bits_desc_unsigned<T: PrimitiveUnsigned, I: Iterator<Item = bool>>(bits: I) -> T {
let mut n = T::ZERO;
let high_mask = T::power_of_2(T::WIDTH - 1);
for bit in bits {
assert!(
n & high_mask == T::ZERO,
"Bits cannot fit in integer of type {}",
T::NAME
);
n <<= 1;
if bit {
n |= T::ONE;
}
}
n
}
macro_rules! impl_bit_convertible_unsigned {
($t:ident) => {
impl BitConvertible for $t {
/// Returns a [`Vec`] containing the bits of a number in ascending order: least- to
/// most-significant.
///
/// If the number is 0, the [`Vec`] is empty; otherwise, it ends with `true`.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(n)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// See [here](super::bit_convertible#to_bits_asc).
#[inline]
fn to_bits_asc(&self) -> Vec<bool> {
to_bits_asc_unsigned(self)
}
/// Returns a [`Vec`] containing the bits of a number in descending order: most- to
/// least-significant.
///
/// If the number is 0, the [`Vec`] is empty; otherwise, it begins with `true`.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(n)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// See [here](super::bit_convertible#to_bits_desc).
#[inline]
fn to_bits_desc(&self) -> Vec<bool> {
to_bits_desc_unsigned(self)
}
/// Converts an iterator of bits into a number. The bits should be in ascending order
/// (least- to most-significant).
///
/// The function panics if the input represents a number that can't fit in the output
/// type.
///
/// $$
/// f((b_i)_ {i=0}^{k-1}) = \sum_{i=0}^{k-1}2^i \[b_i\],
/// $$
/// where braces denote the Iverson bracket, which converts a bit to 0 or 1.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `bits.count()`.
///
/// # Panics
/// Panics if the bits represent a value that isn't representable by the output type.
///
/// # Examples
/// See [here](super::bit_convertible#from_bits_asc).
#[inline]
fn from_bits_asc<I: Iterator<Item = bool>>(bits: I) -> $t {
from_bits_asc_unsigned(bits)
}
/// Converts an iterator of bits into a number. The bits should be in descending order
/// (most- to least-significant).
///
/// The function panics if the input represents a number that can't fit in the output
/// type.
///
/// $$
/// f((b_i)_ {i=0}^{k-1}) = \sum_{i=0}^{k-1}2^{k-i-1} \[b_i\],
/// $$
/// where braces denote the Iverson bracket, which converts a bit to 0 or 1.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `bits.count()`.
///
/// # Panics
/// Panics if the bits represent a value that isn't representable by the output type.
///
/// # Examples
/// See [here](super::bit_convertible#from_bits_desc).
#[inline]
fn from_bits_desc<I: Iterator<Item = bool>>(bits: I) -> $t {
from_bits_desc_unsigned(bits)
}
}
};
}
apply_to_unsigneds!(impl_bit_convertible_unsigned);
fn to_bits_asc_signed<T: PrimitiveSigned>(x: &T) -> Vec<bool> {
let mut bits = Vec::new();
let mut x = *x;
if x >= T::ZERO {
while x != T::ZERO {
bits.push(x.odd());
x >>= 1;
}
if !bits.is_empty() {
bits.push(false);
}
} else {
while x != T::NEGATIVE_ONE {
bits.push(x.odd());
x >>= 1;
}
bits.push(true);
}
bits
}
fn to_bits_desc_signed<T: PrimitiveSigned>(x: &T) -> Vec<bool> {
let mut bits = Vec::new();
if *x >= T::ZERO {
if *x == T::ZERO {
return bits;
}
bits.push(false);
bits.push(true);
if *x == T::ONE {
return bits;
}
let mut mask = T::power_of_2(T::WIDTH - LeadingZeros::leading_zeros(*x) - 2);
while mask != T::ZERO {
bits.push(*x & mask != T::ZERO);
mask >>= 1;
}
} else {
bits.push(true);
if *x == T::NEGATIVE_ONE {
return bits;
}
bits.push(false);
if *x == T::NEGATIVE_ONE << 1 {
return bits;
}
let mut mask = T::power_of_2(T::WIDTH - LeadingZeros::leading_zeros(!*x) - 2);
while mask != T::ZERO {
bits.push(*x & mask != T::ZERO);
mask >>= 1;
}
}
bits
}
fn from_bits_asc_signed<
U: PrimitiveUnsigned,
S: PrimitiveSigned + WrappingFrom<U>,
I: Iterator<Item = bool>,
>(
bits: I,
) -> S {
let mut n = U::ZERO;
let mut mask = U::ONE;
let mut last_bit = false;
for bit in bits {
if mask == U::ZERO {
assert_eq!(
bit,
last_bit,
"Bits cannot fit in integer of type {}",
S::NAME
);
} else {
if bit {
n |= mask;
}
mask <<= 1;
last_bit = bit;
}
}
if last_bit {
S::wrapping_from(n | mask.wrapping_neg())
} else {
S::wrapping_from(n)
}
}
#[inline]
fn from_bits_desc_signed<
U: PrimitiveUnsigned,
S: PrimitiveSigned + WrappingFrom<U>,
I: Iterator<Item = bool>,
>(
bits: I,
) -> S {
let mut n = U::ZERO;
let high_mask = U::power_of_2(U::WIDTH - 2);
let mut first = true;
let mut sign_bit = false;
for bit in bits {
if first {
sign_bit = bit;
first = false;
} else {
assert!(
n & high_mask == U::ZERO,
"Bits cannot fit in integer of type {}",
S::NAME
);
n <<= 1;
if bit != sign_bit {
n |= U::ONE;
}
}
}
if sign_bit {
S::wrapping_from(!n)
} else {
S::wrapping_from(n)
}
}
macro_rules! impl_bit_convertible_signed {
($u:ident, $s:ident) => {
impl BitConvertible for $s {
/// Returns a [`Vec`] containing the bits of a number in ascending order: least- to
/// most-significant.
///
/// If the number is 0, the [`Vec`] is empty; otherwise, the last bit is the sign bit:
/// `false` if the number is non-negative and `true` if it is negative.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(n)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// See [here](super::bit_convertible#to_bits_asc).
#[inline]
fn to_bits_asc(&self) -> Vec<bool> {
to_bits_asc_signed(self)
}
/// Returns a [`Vec`] containing the bits of a number in ascending order: most- to
/// least-significant.
///
/// If the number is 0, the [`Vec`] is empty; otherwise, the first bit is the sign bit:
/// `false` if the number is non-negative and `true` if it is negative.
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(n)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `self.significant_bits()`.
///
/// # Examples
/// See [here](super::bit_convertible#to_bits_desc).
#[inline]
fn to_bits_desc(&self) -> Vec<bool> {
to_bits_desc_signed(self)
}
/// Converts an iterator of bits into a value. The bits should be in ascending order
/// (least- to most-significant).
///
/// The bits are interpreted as in twos-complement, and the last bit is the sign bit; if
/// it is `false`, the number is non-negative, and if it is `true`, the number is
/// negative.
///
/// The function panics if the input represents a number that can't fit in the output
/// type.
///
/// Let $k$ be `bits.count()`. If $k = 0$ or $b_{k-1}$ is `false`, then
/// $$
/// f((b_i)_ {i=0}^{k-1}) = \sum_{i=0}^{k-1}2^i \[b_i\],
/// $$
/// where braces denote the Iverson bracket, which converts a bit to 0 or 1.
///
/// If $b_{k-1}$ is `true`, then
/// $$
/// f((b_i)_ {i=0}^{k-1}) = \left ( \sum_{i=0}^{k-1}2^i \[b_i\] \right ) - 2^k.
/// $$
///
/// # Worst-case complexity
/// $T(n) = O(n)$
///
/// $M(n) = O(1)$
///
/// where $T$ is time, $M$ is additional memory, and $n$ is `bits.count()`.
///
/// # Panics
/// Panics if the bits represent a value that doesn't fit in the output type.
///
/// # Examples
/// See [here](super::bit_convertible#from_bits_asc).
#[inline]
fn from_bits_asc<I: Iterator<Item = bool>>(bits: I) -> $s {
from_bits_asc_signed::<$u, $s, _>(bits)
}
/// Converts an iterator of bits into a value. The bits should be in descending order
/// (most- to least-significant).
///
/// The bits are interpreted as in twos-complement, and the first bit is the sign bit;
/// if it is `false`, the number is non-negative, and if it is `true`, the number is
/// negative.
///
/// The function panics if the input represents a number that can't fit in the output
/// type.
///
/// If `bits` is empty or $b_0$ is `false`, then
/// $$
/// f((b_i)_ {i=0}^{k-1}) = \sum_{i=0}^{k-1}2^{k-i-1} \[b_i\],
/// $$
/// where braces denote the Iverson bracket, which converts a bit to 0 or 1.
///
/// If $b_0$ is `true`, then
/// $$
/// f((b_i)_ {i=0}^{k-1}) = \left ( \sum_{i=0}^{k-1}2^{k-i-1} \[b_i\] \right ) - 2^k.
/// $$
///
/// # Examples
/// See [here](super::bit_convertible#from_bits_desc).
#[inline]
fn from_bits_desc<I: Iterator<Item = bool>>(bits: I) -> $s {
from_bits_desc_signed::<$u, $s, _>(bits)
}
}
};
}
apply_to_unsigned_signed_pairs!(impl_bit_convertible_signed);