struct BigInt

• BigInt
• Int
• Number
• Value
• Object

Overview

A BigInt can represent arbitrarily large integers.

It is implemented under the hood with GMP.

Included Modules

• Comparable(Float)
• Comparable(BigInt)
• Comparable(UInt128 | UInt16 | UInt32 | UInt64 | UInt8)
• Comparable(Int128 | Int16 | Int32 | Int64 | Int8)

Defined in:

Constructors

• .new(str : String, base = 10)

  Creates a BigInt with the value denoted by str in the given base.

• .new(num : Int::Signed)

  Creates a BigInt from the given num.

• .new(num : Int::Unsigned)

  Creates a BigInt from the given num.

• .new(num : Float::Primitive)

  Creates a BigInt from the given num.

• .new(num : BigFloat)

  Creates a BigInt from the given num.

• .new(num : BigDecimal)

  Creates a BigInt from the given num.

• .new(num : BigRational)

  Creates a BigInt from the given num.

• .new(num : BigInt)

  Returns num.

• .new

  Creates a BigInt with the value zero.

Instance Method Summary

• #%(other : Int) : BigInt

  Returns self modulo other.

• #&(other : Int) : BigInt
• #&*(other) : BigInt
• #&+(other) : BigInt
• #&-(other) : BigInt
• #*(other : Int) : BigInt
• #*(other : LibGMP::IntPrimitiveUnsigned) : BigInt
• #*(other : LibGMP::IntPrimitiveSigned) : BigInt
• #*(other : BigInt) : BigInt
• #**(other : Int) : BigInt

  Returns the value of raising self to the power of exponent.

• #+(other : Int) : BigInt
• #+(other : BigInt) : BigInt
• #- : BigInt
• #-(other : Int) : BigInt
• #-(other : BigInt) : BigInt
• #/(other : Float64) : BigFloat
• #/(other : Float32) : BigFloat
• #/(other : UInt128) : BigFloat
• #/(other : Int128) : BigFloat
• #/(other : UInt64) : BigFloat
• #/(other : Int64) : BigFloat
• #/(other : UInt32) : BigFloat
• #/(other : Int32) : BigFloat
• #/(other : UInt16) : BigFloat
• #/(other : Int16) : BigFloat
• #/(other : Int8) : BigFloat
• #/(other : BigRational) : BigRational
• #/(other : BigDecimal) : BigDecimal
• #/(other : BigInt) : BigFloat
• #/(other : UInt8) : BigFloat
• #//(other : Int) : BigInt
• #//(other : Int::Unsigned) : BigInt
• #<<(other : Int) : BigInt

  Returns the result of shifting this number's bits count positions to the left.

• #<=>(other : BigInt)
• #<=>(other : Float)

  The comparison operator.

• #<=>(other : Int::Unsigned)
• #<=>(other : Int::Signed)
• #>>(other : Int) : BigInt

  Returns the result of shifting this number's bits count positions to the right.

• #^(other : Int) : BigInt
• #abs : BigInt

  Returns the absolute value of this number.

• #clone
• #digits : Array(Int32)
• #divmod(number : Int::Unsigned)
• #divmod(number : Int::Signed)
• #divmod(number : LibGMP::ULong)
• #divmod(number : BigInt)
• #gcd(other : Int) : Int
• #gcd(other : BigInt) : BigInt
• #hash(hasher)

  TODO improve this

• #lcm(other : Int) : BigInt
• #lcm(other : BigInt) : BigInt
• #popcount

  Counts 1-bits in the binary representation of this integer.

• #remainder(other : Int) : BigInt

  Returns self remainder other.

• #tdiv(other : Int) : BigInt

  Divides self by other using truncated division.

• #to_big_d

  Converts self to BigDecimal.

• #to_big_f
• #to_big_i

  Returns a BigInt representing this integer.

• #to_big_r

  Returns a BigRational representing this integer.

• #to_f
• #to_f!
• #to_f32
• #to_f32!
• #to_f64
• #to_f64!
• #to_i
• #to_i!
• #to_i16
• #to_i16!
• #to_i32
• #to_i32!
• #to_i64
• #to_i64!
• #to_i8
• #to_i8!
• #to_s : String

  Returns a string representation of self.

• #to_s(base : Int) : String

  Returns a string containing the representation of big radix base (2 through 36).

• #to_s(io : IO) : Nil

  Returns a string representation of self.

• #to_u
• #to_u!
• #to_u16
• #to_u16!
• #to_u32
• #to_u32!
• #to_u64
• #to_u64!
• #to_u8
• #to_u8!
• #to_unsafe
• #trailing_zeros_count

  Returns the number of trailing 0-bits.

• #unsafe_floored_div(other : BigInt) : BigInt
• #unsafe_floored_div(other : Int) : BigInt
• #unsafe_floored_divmod(number : LibGMP::ULong)
• #unsafe_floored_divmod(number : BigInt)
• #unsafe_floored_mod(other : BigInt) : BigInt
• #unsafe_floored_mod(other : Int) : BigInt
• #unsafe_truncated_div(other : BigInt) : BigInt
• #unsafe_truncated_div(other : Int) : BigInt
• #unsafe_truncated_divmod(number : BigInt)
• #unsafe_truncated_divmod(number : LibGMP::ULong)
• #unsafe_truncated_mod(other : BigInt) : BigInt
• #unsafe_truncated_mod(other : Int) : BigInt
• #unsafe_truncated_mod(other : LibGMP::IntPrimitive) : BigInt
• #|(other : Int) : BigInt
• #~ : BigInt

Constructor Detail

require "big"

BigInt.new("123456789123456789123456789123456789") # => 123456789123456789123456789123456789
BigInt.new("123_456_789_123_456_789_123_456_789")  # => 123456789123456789123456789
BigInt.new("1234567890ABCDEF", base: 16)           # => 1311768467294899695

require "big"

BigInt.new # => 0

Instance Method Detail

2 ** 3  # => 8
2 ** 0  # => 1
2 ** -1 # ArgumentError

8000 << 1  # => 16000
8000 << 2  # => 32000
8000 << 32 # => 0
8000 << -1 # => 4000

# Sort in a descending way:
[3, 1, 2].sort { |x, y| y <=> x } # => [3, 2, 1]

# Sort in an ascending way:
[3, 1, 2].sort { |x, y| x <=> y } # => [1, 2, 3]

8000 >> 1  # => 4000
8000 >> 2  # => 2000
8000 >> 32 # => 0
8000 >> -1 # => 16000

-8000 >> 1 # => -4000

123.abs  # => 123
-123.abs # => 123

5.popcount   # => 2
-15.popcount # => 29

 x     y     x / y     x % y
 5     3       1         2
-5     3      -1        -2
 5    -3      -1         2
-5    -3       1        -2

require "big"
12123415151254124124.to_big_d

require "big"

123.to_big_i

require "big"

123.to_big_r

require "big"

BigInt.new("123456789101101987654321").to_s # => 123456789101101987654321

require "big"

BigInt.new("123456789101101987654321").to_s(8)  # => "32111154373025463465765261"
BigInt.new("123456789101101987654321").to_s(16) # => "1a249b1f61599cd7eab1"
BigInt.new("123456789101101987654321").to_s(36) # => "k3qmt029k48nmpd"

require "big"

BigInt.new("123456789101101987654321").to_s # => 123456789101101987654321