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

Constructors

Instance Method Summary

Instance methods inherited from module Comparable(Float)

<(other : T) <, <=(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) >, >=(other : T) >=

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

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

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

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

Instance methods inherited from struct Int

%(other : BigInt) : BigInt
%(other : Int)
%
, *(other : BigInt) : BigInt
*(other : BigRational)
*
, **(exponent : Float) : Float64
**(exponent : Int) : self
**
, +(other : BigInt) : BigInt
+(other : BigRational)
+
, -(other : BigRational)
-(other : BigInt) : BigInt
-
, /(other : BigInt) : BigInt
/(other : Int)
/(other : BigRational)
/
, <<(count : Int) <<, <=>(other : BigInt)
<=>(other : BigRational)
<=>
, ===(char : Char) ===, >>(count : Int) >>, abs abs, bit(bit) bit, ceil ceil, chr chr, day day, days days, divisible_by?(num) divisible_by?, downto(to)
downto(to, &block : self -> ) : Nil
downto
, even? even?, fdiv(other) fdiv, floor floor, gcd(other : Int) gcd, gcm(other : BigInt) : Int gcm, hash(hasher) hash, hour hour, hours hours, inspect(io) inspect, lcm(other : Int)
lcm(other : BigInt) : BigInt
lcm
, millisecond millisecond, milliseconds milliseconds, minute minute, minutes minutes, modulo(other) modulo, month month, months months, odd? odd?, popcount popcount, pred pred, remainder(other : Int) remainder, round round, second second, seconds seconds, succ succ, tdiv(other : Int) tdiv, times
times(&block : self -> ) : Nil
times
, to(to)
to(to, &block : self -> ) : Nil
to
, 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_s(base : Int, upcase : Bool = false)
to_s(io : IO)
to_s(base : Int, io : IO, upcase : Bool = false)
to_s
to_s
, trunc trunc, upto(to)
upto(to, &block : self -> ) : Nil
upto
, week week, weeks weeks, year year, years years, ~ ~

Constructor methods inherited from struct Int

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

Instance methods inherited from module Comparable(BigRational)

<(other : T) <, <=(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) >, >=(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 : Complex) ==, abs abs, abs2 abs2, cis cis, clamp(min, max)
clamp(range : Range)
clamp
, divmod(number) divmod, i i, round(digits, 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::Builder) to_yaml, zero? : Bool zero?

Constructor methods inherited from struct Number

zero : self zero

Instance methods inherited from module Comparable(BigFloat)

<(other : T) <, <=(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) >, >=(other : T) >=

Instance methods inherited from struct Value

==(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)
inspect
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
to_s(io : IO)
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) : self from_yaml

Constructor Detail

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

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

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

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

[View source]
def self.new(num : Int::Signed) #

Creates a BigInt from the given num.


[View source]
def self.new(num : Int::Unsigned) #

Creates a BigInt from the given num.


[View source]
def self.new(num : Float) #

Creates a BigInt from the given num.


[View source]
def self.new(num : BigInt) #

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


[View source]
def self.new #

Creates a BigInt with the value zero.

require "big"
BigInt.new # => 0

[View source]

Instance Method Detail

def %(other : Int) : BigInt #

[View source]
def &(other : Int) : BigInt #

[View source]
def *(other : BigInt) : BigInt #

[View source]

[View source]

[View source]
def *(other : Int) : BigInt #

[View source]
def **(other : Int) : BigInt #

[View source]
def +(other : BigInt) : BigInt #

[View source]
def +(other : Int) : BigInt #

[View source]
def -(other : BigInt) : BigInt #

[View source]
def -(other : Int) : BigInt #

[View source]
def - : BigInt #

[View source]
def /(other : Int) : BigInt #

[View source]
def <<(other : Int) : BigInt #

[View source]
def <=>(other : Int::Unsigned) #

[View source]
def <=>(other : Int::Signed) #

[View source]
def <=>(other : Float) #

[View source]
def <=>(other : BigInt) #

[View source]
def >>(other : Int) : BigInt #

[View source]
def ^(other : Int) : BigInt #

[View source]
def abs : BigInt #

[View source]
def clone #

[View source]
def digits : Array(Int32) #

[View source]
def divmod(number : BigInt) #

[View source]
def divmod(number : Int::Unsigned) #

[View source]
def divmod(number : Int::Signed) #

[View source]
def gcd(other : Int) : Int #

[View source]
def gcd(other : BigInt) : BigInt #

[View source]
def hash(hasher) #

TODO improve this


[View source]
def inspect(io) #

[View source]
def lcm(other : Int) : BigInt #

[View source]
def lcm(other : BigInt) : BigInt #

[View source]
def popcount #

[View source]
def remainder(other : Int) : BigInt #

[View source]
def tdiv(other : Int) : BigInt #

[View source]
def to_big_f #

[View source]
def to_big_i #

[View source]
def to_f #

[View source]
def to_f32 #

[View source]
def to_f64 #

[View source]
def to_i #

[View source]
def to_i16 #

[View source]
def to_i32 #

[View source]
def to_i64 #

[View source]
def to_i8 #

[View source]
def to_s(base : Int) #

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

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

[View source]
def to_s(io) #

Returns a string representation of self.

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

[View source]
def to_s #

Returns a string representation of self.

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

[View source]
def to_u #

[View source]
def to_u16 #

[View source]
def to_u32 #

[View source]
def to_u64 #

[View source]
def to_u8 #

[View source]
def to_unsafe #

[View source]
def unsafe_floored_div(other : Int) : BigInt #

[View source]
def unsafe_floored_div(other : BigInt) : BigInt #

[View source]
def unsafe_floored_divmod(number : LibGMP::ULong) #

[View source]
def unsafe_floored_divmod(number : BigInt) #

[View source]
def unsafe_floored_mod(other : Int) : BigInt #

[View source]
def unsafe_floored_mod(other : BigInt) : BigInt #

[View source]
def unsafe_truncated_div(other : Int) : BigInt #

[View source]
def unsafe_truncated_div(other : BigInt) : BigInt #

[View source]
def unsafe_truncated_divmod(number : LibGMP::ULong) #

[View source]
def unsafe_truncated_divmod(number : BigInt) #

[View source]
def unsafe_truncated_mod(other : Int) : BigInt #

[View source]
def unsafe_truncated_mod(other : LibGMP::IntPrimitive) : BigInt #

[View source]
def unsafe_truncated_mod(other : BigInt) : BigInt #

[View source]
def |(other : Int) : BigInt #

[View source]
def ~ : BigInt #

[View source]