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 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565
//! Definitions of safe integers and uints.
use crate::math::traits::*;
#[cfg(feature = "radix_engine_fuzzing")]
use arbitrary::Arbitrary;
use bnum::{BInt, BUint};
use num_bigint::BigInt;
use num_integer::Roots;
use num_traits::{FromPrimitive, One, Pow, ToPrimitive, Zero};
use paste::paste;
use sbor::rust::cmp::{Ord, Ordering, PartialEq, PartialOrd};
use sbor::rust::convert::{From, TryFrom};
use sbor::rust::fmt;
use sbor::rust::ops::{Add, AddAssign, BitAnd, BitAndAssign, BitOr, BitOrAssign};
use sbor::rust::ops::{BitXor, BitXorAssign, Div, DivAssign};
use sbor::rust::ops::{Mul, MulAssign, Neg, Not, Rem, RemAssign};
use sbor::rust::ops::{Shl, ShlAssign, Shr, ShrAssign, Sub, SubAssign};
use sbor::rust::str::FromStr;
use sbor::rust::string::*;
use sbor::rust::vec::Vec;
#[cfg(feature = "radix_engine_fuzzing")]
use serde::{Deserialize, Serialize};
pub mod bits;
pub mod convert;
pub mod test;
pub mod test_macros;
macro_rules! types {
($($t:ident, $wrap:ty),*) => {
paste!{
$(
/// Provides safe integer arithmetic.
///
/// Operations like `+`, '-', '*', or '/' sometimes produce overflow
/// which is detected and results in a panic, in of silently
/// wrapping around.
///
/// The bit length of output type will be the greater one in the math operation,
/// and if any of the types was signed, then the resulting type will be signed too,
/// otherwise the output type is unsigned.
///
/// The underlying value can be retrieved through the `.0` index of the
#[doc = "`" $t "` tuple."]
///
/// # Layout
///
#[doc = "`" $t "` will have the same methods and traits as"]
/// the built-in counterpart.
#[cfg_attr(feature = "radix_engine_fuzzing", derive(Arbitrary, Serialize, Deserialize))]
#[derive(Clone , Copy)]
#[repr(transparent)]
pub struct $t(pub $wrap);
impl $t {
pub const MIN: Self = Self($wrap::MIN);
pub const MAX: Self = Self($wrap::MAX);
pub const ZERO: Self = Self($wrap::ZERO);
pub const ONE: Self = Self($wrap::ONE);
pub const TEN: Self = Self($wrap::TEN);
pub const BITS: u32 = $wrap::BITS as u32;
pub const BYTES: u32 = $wrap::BYTES as u32;
pub const N: usize = ($wrap::BYTES / 8) as usize;
}
impl Default for $t {
fn default() -> Self {
Self::ZERO
}
}
impl fmt::Debug for $t {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.0.fmt(f)
}
}
impl fmt::Display for $t {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.0.fmt(f)
}
}
impl Zero for $t {
fn zero() -> Self {
Self::ZERO
}
fn is_zero(&self) -> bool {
$wrap::ZERO == self.0
}
fn set_zero(&mut self) {
self.0 = $wrap::ZERO;
}
}
impl One for $t {
fn one() -> Self {
Self::ONE
}
}
impl Ord for $t {
fn cmp(&self, other: &Self) -> Ordering {
self.0.cmp(&other.0)
}
}
impl PartialOrd for $t {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
// The following three trait implementations must be aligned.
impl PartialEq for $t {
fn eq(&self, other: &Self) -> bool {
self.0.eq(&other.0)
}
}
impl Eq for $t {
}
impl sbor::rust::hash::Hash for $t {
fn hash<H>(&self, state: &mut H) where H: sbor::rust::hash::Hasher {
self.0.hash(state)
}
}
)*
}
};
}
types! {
I192, BInt::<3>,
I256, BInt::<4>,
I320, BInt::<5>,
I384, BInt::<6>,
I448, BInt::<7>,
I512, BInt::<8>,
I768, BInt::<12>,
U192, BUint::<3>,
U256, BUint::<4>,
U320, BUint::<5>,
U384, BUint::<6>,
U448, BUint::<7>,
U512, BUint::<8>,
U768, BUint::<12>
}
pub trait Sqrt {
fn sqrt(self) -> Self;
}
pub trait Cbrt {
fn cbrt(self) -> Self;
}
pub trait NthRoot {
fn nth_root(self, n: u32) -> Self;
}
macro_rules! forward_ref_unop {
(impl $imp:ident, $method:ident for $t:ty) => {
impl $imp for &$t {
type Output = <$t as $imp>::Output;
#[inline]
fn $method(self) -> <$t as $imp>::Output {
$imp::$method(*self)
}
}
};
}
macro_rules! forward_ref_binop {
(impl $imp:ident, $method:ident for $t:ty, $u:ty) => {
impl<'a> $imp<$u> for &'a $t {
type Output = <$t as $imp<$u>>::Output;
#[inline]
fn $method(self, other: $u) -> <$t as $imp<$u>>::Output {
$imp::$method(*self, other)
}
}
impl $imp<&$u> for $t {
type Output = <$t as $imp<$u>>::Output;
#[inline]
fn $method(self, other: &$u) -> <$t as $imp<$u>>::Output {
$imp::$method(self, *other)
}
}
impl $imp<&$u> for &$t {
type Output = <$t as $imp<$u>>::Output;
#[inline]
fn $method(self, other: &$u) -> <$t as $imp<$u>>::Output {
$imp::$method(*self, *other)
}
}
};
}
macro_rules! forward_ref_op_assign {
(impl $imp:ident, $method:ident for $t:ty, $u:ty) => {
impl $imp<&$u> for $t {
#[inline]
fn $method(&mut self, other: &$u) {
$imp::$method(self, *other);
}
}
};
}
macro_rules! op_impl {
($($t:ty),*) => {
paste! {
$(
impl Add for $t {
type Output = $t;
#[inline]
fn add(self, other: $t) -> Self {
Self(self.0.checked_add(other.0).expect("Overflow"))
}
}
forward_ref_binop! { impl Add, add for $t, $t }
impl AddAssign for $t {
#[inline]
fn add_assign(&mut self, other: $t) {
self.0 = self.0.checked_add(other.0).expect("Overflow");
}
}
forward_ref_op_assign! { impl AddAssign, add_assign for $t, $t }
impl Sub for $t {
type Output = $t;
#[inline]
fn sub(self, other: $t) -> Self {
Self(self.0.checked_sub(other.0).expect("Overflow"))
}
}
forward_ref_binop! { impl Sub, sub for $t, $t }
impl SubAssign for $t {
#[inline]
fn sub_assign(&mut self, other: $t) {
self.0 = self.0.checked_sub(other.0).expect("Overflow");
}
}
forward_ref_op_assign! { impl SubAssign, sub_assign for $t, $t }
impl Mul for $t {
type Output = $t;
#[inline]
fn mul(self, other: $t) -> Self {
Self(self.0.checked_mul(other.0).expect("Overflow"))
}
}
forward_ref_binop! { impl Mul, mul for $t, $t }
impl MulAssign for $t {
#[inline]
fn mul_assign(&mut self, other: $t) {
self.0 = self.0.checked_mul(other.0).expect("Overflow");
}
}
forward_ref_op_assign! { impl MulAssign, mul_assign for $t, $t }
impl Div for $t {
type Output = $t;
#[inline]
fn div(self, other: $t) -> Self {
Self(self.0.checked_div(other.0).expect("Overflow"))
}
}
forward_ref_binop! { impl Div, div for $t, $t }
impl DivAssign for $t {
#[inline]
fn div_assign(&mut self, other: $t) {
self.0 = self.0.checked_div(other.0).expect("Overflow");
}
}
forward_ref_op_assign! { impl DivAssign, div_assign for $t, $t }
impl Rem for $t {
type Output = $t;
#[inline]
fn rem(self, other: $t) -> Self {
Self(self.0 % other.0)
}
}
forward_ref_binop! { impl Rem, rem for $t, $t }
impl RemAssign for $t {
#[inline]
fn rem_assign(&mut self, other: $t) {
self.0 = self.0 % other.0;
}
}
forward_ref_op_assign! { impl RemAssign, rem_assign for $t, $t }
impl Not for $t {
type Output = $t;
#[inline]
fn not(self) -> Self {
Self(!self.0)
}
}
forward_ref_unop! { impl Not, not for $t }
impl Pow<u32> for $t
{
type Output = $t;
/// Raises self to the power of `exp`, using exponentiation by squaring.
///
#[inline]
#[must_use = "this returns the result of the operation, \
without modifying the original"]
fn pow(self, exp: u32) -> Self {
Self(self.0.checked_pow(exp).expect("Overflow"))
}
}
impl Sqrt for $t
{
fn sqrt(self) -> Self {
Self(self.0.sqrt())
}
}
impl Cbrt for $t
{
fn cbrt(self) -> Self {
Self(self.0.cbrt())
}
}
impl NthRoot for $t
{
fn nth_root(self, n: u32) -> Self {
Self(self.0.nth_root(n))
}
}
impl CheckedAdd for $t
{
type Output = $t;
fn checked_add(self, other: Self) -> Option<Self::Output> {
let opt = self.0.checked_add(other.0);
opt.map(|v| Self(v))
}
}
impl CheckedSub for $t
{
type Output = $t;
fn checked_sub(self, other: Self) -> Option<Self::Output> {
let opt = self.0.checked_sub(other.0);
opt.map(|v| Self(v))
}
}
impl CheckedMul for $t
{
type Output = $t;
fn checked_mul(self, other: Self) -> Option<Self::Output> {
let opt = self.0.checked_mul(other.0);
opt.map(|v| Self(v))
}
}
impl CheckedDiv for $t
{
type Output = $t;
fn checked_div(self, other: Self) -> Option<Self::Output> {
let opt = self.0.checked_div(other.0);
opt.map(|v| Self(v))
}
}
)*
}
};
}
op_impl! { I192 }
op_impl! { I256 }
op_impl! { I320 }
op_impl! { I384 }
op_impl! { I448 }
op_impl! { I512 }
op_impl! { I768 }
op_impl! { U192 }
op_impl! { U256 }
op_impl! { U320 }
op_impl! { U384 }
op_impl! { U448 }
op_impl! { U512 }
op_impl! { U768 }
macro_rules! op_impl_unsigned {
($($t:ty),*) => {
paste! {
$(
impl $t {
pub fn is_power_of_two(self) -> bool {
self.0.is_power_of_two()
}
pub fn next_power_of_two(self) -> Self {
Self(self.0.checked_next_power_of_two().expect("Overflow"))
}
}
)*
}
};
}
op_impl_unsigned! { U192 }
op_impl_unsigned! { U256 }
op_impl_unsigned! { U320 }
op_impl_unsigned! { U384 }
op_impl_unsigned! { U448 }
op_impl_unsigned! { U512 }
op_impl_unsigned! { U768 }
macro_rules! op_impl_signed {
($($t:ty),*) => {
paste! {
$(
impl Neg for $t {
type Output = Self;
#[inline]
fn neg(self) -> Self {
Self(self.0.neg())
}
}
impl CheckedNeg for $t {
type Output = Self;
#[inline]
fn checked_neg(self) -> Option<Self::Output> {
let c = self.0.checked_neg();
c.map(Self)
}
}
impl $t {
/// Computes the absolute value of `self`, with overflow causing panic.
///
/// The only case where such overflow can occur is when one takes the absolute value of the negative
/// minimal value for the type this is a positive value that is too large to represent in the type. In
/// such a case, this function panics.
///
#[inline]
#[must_use = "this returns the result of the operation, \
without modifying the original"]
pub fn abs(self) -> Self {
Self(self.0.abs())
}
/// Returns a number representing sign of `self`.
///
/// - `0` if the number is zero
/// - `1` if the number is positive
/// - `-1` if the number is negative
///
#[inline]
#[must_use = "this returns the result of the operation, \
without modifying the original"]
pub fn signum(self) -> Self {
Self(self.0.signum())
}
/// Returns `true` if `self` is positive and `false` if the number is zero or
/// negative.
///
#[must_use]
#[inline]
pub fn is_positive(self) -> bool {
self.0.is_positive()
}
/// Returns `true` if `self` is negative and `false` if the number is zero or
/// positive.
///
#[must_use]
#[inline]
pub fn is_negative(self) -> bool {
self.0.is_negative()
}
}
)*
}
}
}
op_impl_signed! { I192 }
op_impl_signed! { I256 }
op_impl_signed! { I320 }
op_impl_signed! { I384 }
op_impl_signed! { I448 }
op_impl_signed! { I512 }
op_impl_signed! { I768 }
macro_rules! error {
($($t:ident),*) => {
paste! {
$(
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum [<Parse $t Error>] {
NegativeToUnsigned,
InvalidLength,
InvalidDigit,
Empty,
Overflow,
}
#[cfg(not(feature = "alloc"))]
impl std::error::Error for [<Parse $t Error>] {}
#[cfg(not(feature = "alloc"))]
impl fmt::Display for [<Parse $t Error>] {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "{:?}", self)
}
}
)*
}
};
}
error! {
I192,
I256,
I320,
I384,
I448,
I512,
I768,
U192,
U256,
U320,
U384,
U448,
U512,
U768
}