W3cubDocs

/Crystal 0.31

struct BigInt

Overview

A BigInt can represent arbitrarily large integers.

It is implemented under the hood with GMP.

Included Modules

Defined in:

big.cr
big/big_int.cr
big/number.cr

Constructors

Instance Method Summary

Instance methods inherited from module Comparable(Float)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from module Comparable(BigInt)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from module Comparable(UInt128 | UInt16 | UInt32 | UInt64 | UInt8)

<, <=(other : T | T | T | T | T) <=, <=>(other : T | T | T | T | T) <=>, ==(other : T | T | T | T | T) ==, >(other : T | T | T | T | T) >, >=(other : T | T | T | T | T) >=

Instance methods inherited from module Comparable(Int128 | Int16 | Int32 | Int64 | Int8)

<, <=(other : T | T | T | T | T) <=, <=>(other : T | T | T | T | T) <=>, ==(other : T | T | T | T | T) ==, >(other : T | T | T | T | T) >, >=(other : T | T | T | T | T) >=

Instance methods inherited from struct Int

%(other : BigInt) : BigInt
%(other : Int) %
, &*(other : BigInt) : BigInt &*, &**(exponent : Int) : self &**, &+(other : BigInt) : BigInt &+, &-(other : BigInt) : BigInt &-, *(other : BigDecimal)
*(other : BigRational)
*(other : BigInt) : BigInt *
, **(exponent : Float) : Float64
**(exponent : Int) : self **
, +(other : BigDecimal)
+(other : BigRational)
+(other : BigInt) : BigInt +
, -(other : BigDecimal)
-(other : BigInt) : BigInt
-(other : BigRational) -
, /(other : BigRational) /, //(other : Int::Primitive) //, < <<, <=>(other : BigDecimal)
<=>(other : BigRational)
<=>(other : Int) : Int32
<=>(other : BigInt) <=>
, ===(char : Char) ===, >>(count : Int) >>, abs abs, bit(bit) bit, bits_set?(mask) bits_set?, ceil ceil, chr chr, day : Time::Span day, days : Time::Span days, divisible_by?(num) divisible_by?, downto(to, &block : self -> ) : Nil
downto(to) downto
, even? even?, fdiv(other) fdiv, floor floor, gcd(other : Int) gcd, gcm(other : BigInt) : Int gcm, hash(hasher) hash, hour : Time::Span hour, hours : Time::Span hours, humanize_bytes(io : IO, precision : Int = 3, separator = '.', *, significant : Bool = true, format : BinaryPrefixFormat = :IEC) : Nil
humanize_bytes(precision : Int = 3, separator = '.', *, significant : Bool = true, format : BinaryPrefixFormat = :IEC) : String humanize_bytes
, lcm(other : Int)
lcm(other : BigInt) : BigInt lcm
, microsecond : Time::Span microsecond, microseconds : Time::Span microseconds, millisecond : Time::Span millisecond, milliseconds : Time::Span milliseconds, minute : Time::Span minute, minutes : Time::Span minutes, modulo(other) modulo, month : Time::MonthSpan month, months : Time::MonthSpan months, nanosecond : Time::Span nanosecond, nanoseconds : Time::Span nanoseconds, odd? odd?, popcount popcount, pred pred, remainder(other : Int) remainder, round round, second : Time::Span second, seconds : Time::Span seconds, succ succ, tdiv(other : Int) tdiv, times
times(&block : self -> ) : Nil times
, to(to, &block : self -> ) : Nil
to(to) to
, to_big_d to_big_d, to_big_i : BigInt to_big_i, to_big_r to_big_r, to_io(io : IO, format : IO::ByteFormat) to_io, to_json(json : JSON::Builder) to_json, to_json_object_key to_json_object_key, to_s : String
to_s(io : IO) : Nil
to_s(base : Int, io : IO, upcase : Bool = false) : Nil
to_s(base : Int, upcase : Bool = false) : String to_s
, trailing_zeros_count trailing_zeros_count, trunc trunc, upto(to)
upto(to, &block : self -> ) : Nil upto
, week : Time::Span week, weeks : Time::Span weeks, year : Time::MonthSpan year, years : Time::MonthSpan years, ~ ~

Constructor methods inherited from struct Int

from_io(io : IO, format : IO::ByteFormat) : self from_io

Instance methods inherited from module Comparable(BigDecimal)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from module Comparable(BigRational)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from module Comparable(BigInt)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from struct Number

*(other : Complex)
*(other : BigFloat) *
, +(other : BigFloat)
+(other : Complex)
+ +
, -(other : Complex)
-(other : BigFloat) -
, /(other : Complex)
/(other : BigFloat) /
, //(other) //, <=>(other : BigFloat)
<=>(other) : Int32? <=>
, ==(other : Complex) ==, abs abs, abs2 abs2, cis cis, clamp(range : Range)
clamp(min, max) clamp
, divmod(number) divmod, format(separator = '.', delimiter = ',', decimal_places : Int? = nil, *, group : Int = 3, only_significant : Bool = false) : String
format(io : IO, separator = '.', delimiter = ',', decimal_places : Int? = nil, *, group : Int = 3, only_significant : Bool = false) : Nil format
, humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Indexable = SI_PREFIXES) : Nil
humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Proc) : Nil
humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes = SI_PREFIXES) : String
humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, &prefixes : Int32, Float64 -> Tuple(Int32, UNDERSCORE) | Tuple(Int32, UNDERSCORE, Bool)) : Nil
humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, &block) : String
humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Proc) : Nil humanize
, i i, round(digits = 0, base = 10) round, sign sign, significant(digits, base = 10) significant, step(*, to = nil, by = 1)
step(*, to = nil, by = 1, &block) step
, to_big_f to_big_f, to_c to_c, to_yaml(yaml : YAML::Nodes::Builder) to_yaml, zero? : Bool zero?

Constructor methods inherited from struct Number

zero : self zero

Class methods inherited from struct Number

si_prefix(magnitude : Int, prefixes = SI_PREFIXES) : Char? si_prefix

Instance methods inherited from module Comparable(BigFloat)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from module Comparable(Number)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from struct Value

==(other : JSON::Any)
==(other : YAML::Any)
==(other) ==
, dup dup

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other) ===
, =~(other) =~, class class, dup dup, hash(hasher)
hash hash
, inspect(io : IO) : Nil
inspect : String inspect
, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) tap, to_json(io : IO)
to_json to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ") to_pretty_json
, to_s : String
to_s(io : IO) : Nil to_s
, to_yaml(io : IO)
to_yaml to_yaml
, try(&block) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self from_json
, from_yaml(string_or_io : String | IO) : self from_yaml

Constructor Detail

def self.new(str : String, base = 10)Source

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

Raises ArgumentError if the string doesn't denote a valid integer.

require "big"

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

def self.new(num : Int::Signed)Source

Creates a BigInt from the given num.

def self.new(num : Int::Unsigned)Source

Creates a BigInt from the given num.

def self.new(num : Float::Primitive)Source

Creates a BigInt from the given num.

def self.new(num : BigFloat)Source

Creates a BigInt from the given num.

def self.new(num : BigDecimal)Source

Creates a BigInt from the given num.

def self.new(num : BigRational)Source

Creates a BigInt from the given num.

def self.new(num : BigInt)Source

Returns num. Useful for generic code that does T.new(...) with T being a Number.

def self.newSource

Creates a BigInt with the value zero.

require "big"

BigInt.new # => 0

Instance Method Detail

def %(other : Int) : BigIntSource

Description copied from struct Int

Returns self modulo other.

This uses floored division.

See Int#/ for more details.

def &(other : Int) : BigIntSource

def &*(other) : BigIntSource

def &+(other) : BigIntSource

def &-(other) : BigIntSource

def *(other : Int) : BigIntSource

def *(other : LibGMP::IntPrimitiveUnsigned) : BigIntSource

def *(other : LibGMP::IntPrimitiveSigned) : BigIntSource

def *(other : BigInt) : BigIntSource

def **(other : Int) : BigIntSource

Description copied from struct Int

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

Raises ArgumentError if exponent is negative: if this is needed, either use a float base or a float exponent.

Raises OverflowError in case of overflow.

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

def +(other : Int) : BigIntSource

def +(other : BigInt) : BigIntSource

def - : BigIntSource

def -(other : Int) : BigIntSource

def -(other : BigInt) : BigIntSource

def /(other : Float64) : BigFloatSource

def /(other : Float32) : BigFloatSource

def /(other : UInt128) : BigFloatSource

def /(other : Int128) : BigFloatSource

def /(other : UInt64) : BigFloatSource

def /(other : Int64) : BigFloatSource

def /(other : UInt32) : BigFloatSource

def /(other : Int32) : BigFloatSource

def /(other : UInt16) : BigFloatSource

def /(other : Int16) : BigFloatSource

def /(other : Int8) : BigFloatSource

def /(other : BigRational) : BigRationalSource

def /(other : BigDecimal) : BigDecimalSource

def /(other : BigInt) : BigFloatSource

def /(other : UInt8) : BigFloatSource

def //(other : Int) : BigIntSource

def //(other : Int::Unsigned) : BigIntSource

Description copied from struct Int

Divides self by other using floored division.

In floored division, given two integers x and y:

  • q = x / y is rounded toward negative infinity
  • r = x % y has the sign of the second argument
  • x == q*y + r

For example:

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

Raises if other is zero, or if other is -1 and self is signed and is the minimum value for that integer type.

def <<(other : Int) : BigIntSource

Description copied from struct Int

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

  • If count is greater than the number of bits of this integer, returns 0
  • If count is negative, a right shift is performed
8000 << 1  # => 16000
8000 << 2  # => 32000
8000 << 32 # => 0
8000 << -1 # => 4000

def <=>(other : BigInt)Source

def <=>(other : Float)Source

Description copied from module Comparable(Float)

The comparison operator. Returns 0 if the two objects are equal, a negative number if this object is considered less than other, a positive number if this object is considered greter than other, or nil if the two objects are not comparable.

Subclasses define this method to provide class-specific ordering.

The comparison operator is usually used to sort values:

# 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]

def <=>(other : Int::Unsigned)Source

def <=>(other : Int::Signed)Source

def >>(other : Int) : BigIntSource

Description copied from struct Int

Returns the result of shifting this number's bits count positions to the right. Also known as arithmetic right shift.

  • If count is greater than the number of bits of this integer, returns 0
  • If count is negative, a left shift is performed
8000 >> 1  # => 4000
8000 >> 2  # => 2000
8000 >> 32 # => 0
8000 >> -1 # => 16000

-8000 >> 1 # => -4000

def ^(other : Int) : BigIntSource

def abs : BigIntSource

Description copied from struct Number

Returns the absolute value of this number.

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

def cloneSource

def digits : Array(Int32)Source

def divmod(number : Int::Signed)Source

def divmod(number : Int::Unsigned)Source

def divmod(number : BigInt)Source

def gcd(other : Int) : IntSource

def gcd(other : BigInt) : BigIntSource

def hash(hasher)Source

TODO improve this

def lcm(other : Int) : BigIntSource

def lcm(other : BigInt) : BigIntSource

def popcountSource

Description copied from struct Int

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

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

def remainder(other : Int) : BigIntSource

Description copied from struct Int

Returns self remainder other.

This uses truncated division.

See Int#div for more details.

def tdiv(other : Int) : BigIntSource

Description copied from struct Int

Divides self by other using truncated division.

In truncated division, given two integers x and y:

  • q = x.tdiv(y) is rounded toward zero
  • r = x.remainder(y) has the sign of the first argument
  • x == q*y + r

For example:

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

Raises if other is 0, or if other is -1 and self is signed and is the minimum value for that integer type.

def to_big_dSource

Description copied from struct Int

Converts self to BigDecimal.

require "big"
12123415151254124124.to_big_d

def to_big_fSource

def to_big_iSource

Description copied from struct Int

Returns a BigInt representing this integer.

require "big"

123.to_big_i

def to_big_rSource

Description copied from struct Int

Returns a BigRational representing this integer.

require "big"

123.to_big_r

def to_fSource

def to_f!Source

def to_f32Source

def to_f32!Source

def to_f64Source

def to_f64!Source

def to_iSource

def to_i!Source

def to_i16Source

def to_i16!Source

def to_i32Source

def to_i32!Source

def to_i64Source

def to_i64!Source

def to_i8Source

def to_i8!Source

def to_s : StringSource

Returns a string representation of self.

require "big"

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

def to_s(base : Int) : StringSource

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

require "big"

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

def to_s(io : IO) : NilSource

Returns a string representation of self.

require "big"

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

def to_uSource

def to_u!Source

def to_u16Source

def to_u16!Source

def to_u32Source

def to_u32!Source

def to_u64Source

def to_u64!Source

def to_u8Source

def to_u8!Source

def to_unsafeSource

def trailing_zeros_countSource

Description copied from struct Int

Returns the number of trailing 0-bits.

def unsafe_floored_div(other : BigInt) : BigIntSource

def unsafe_floored_div(other : Int) : BigIntSource

def unsafe_floored_divmod(number : LibGMP::ULong)Source

def unsafe_floored_divmod(number : BigInt)Source

def unsafe_floored_mod(other : BigInt) : BigIntSource

def unsafe_floored_mod(other : Int) : BigIntSource

def unsafe_truncated_div(other : BigInt) : BigIntSource

def unsafe_truncated_div(other : Int) : BigIntSource

def unsafe_truncated_divmod(number : BigInt)Source

def unsafe_truncated_divmod(number : LibGMP::ULong)Source

def unsafe_truncated_mod(other : BigInt) : BigIntSource

def unsafe_truncated_mod(other : Int) : BigIntSource

def unsafe_truncated_mod(other : LibGMP::IntPrimitive) : BigIntSource

def |(other : Int) : BigIntSource

def ~ : BigIntSource

© 2012–2019 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.31.1/BigInt.html