abstract struct Int

Overview

Int is the base type of all integer types.

There are four signed integer types: Int8, Int16, Int32 and Int64, being able to represent numbers of 8, 16, 32 and 64 bits respectively. There are four unsigned integer types: UInt8, UInt16, UInt32 and UInt64.

An integer literal is an optional #+ or #- sign, followed by a sequence of digits and underscores, optionally followed by a suffix. If no suffix is present, the literal's type is the lowest between Int32, Int64 and UInt64 in which the number fits:

1 # Int32

1_i8  # Int8
1_i16 # Int16
1_i32 # Int32
1_i64 # Int64

1_u8  # UInt8
1_u16 # UInt16
1_u32 # UInt32
1_u64 # UInt64

+10 # Int32
-20 # Int32

2147483648          # Int64
9223372036854775808 # UInt64

The underscore _ before the suffix is optional.

Underscores can be used to make some numbers more readable:

1_000_000 # better than 1000000

Binary numbers start with 0b:

0b1101 # == 13

Octal numbers start with 0o:

0o123 # == 83

Hexadecimal numbers start with 0x:

0xFE012D # == 16646445
0xfe012d # == 16646445

Included Modules

Direct Known Subclasses

Defined in:

int.cr
time/span.cr
time/span.cr
big_int/big_int.cr
json/to_json.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from module Comparable(T)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, between?(min, max) between?

Instance methods inherited from struct Number

*(other : Complex) *, +
+(other : Complex)
+
, -(other : Complex) -, /(other : Complex) /, <=>(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(limit = nil, by = 1)
step(limit = nil, by = 1, &block)
step
, to_c to_c, to_yaml(yaml : YAML::Generator) to_yaml

Class methods inherited from struct Number

[](*nums) [], zero zero

Instance methods inherited from module Comparable(T)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, between?(min, max) between?

Instance methods inherited from struct Value

! !, ==(other) ==, nil? nil?

Instance methods inherited from class Object

! !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other) ===, =~(other) =~, class class, clone clone, crystal_type_id crystal_type_id, dup dup, hash hash, inspect
inspect(io : IO)
inspect
, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(io : IO)
to_pretty_json
to_pretty_json
, to_s
to_s(io : IO)
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, from_json(string_or_io) from_json, from_yaml(string : String) from_yaml, hash hash, inspect(io) inspect, name : String name, to_s(io) to_s

Class Method Detail

def self.from_io(io : IO, format : IO::ByteFormat) #

Reads an integer from the given io in the given format.

See IO#read_bytes.


[View source]

Instance Method Detail

def %(other : Int) #

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

[View source]
def &(other : UInt16) #

def &(other : UInt8) #

def &(other : UInt64) #

def &(other : UInt32) #

def &(other : Int32) #

def &(other : Int64) #

def &(other : Int8) #

def &(other : Int16) #

def *(other : BigInt) #

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

[View source]
def **(other) #

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

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

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

[View source]
def /(x : Int) #

[View source]
def <<(count : 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  # => 4000
8000 << 2  # => 2000
8000 << 32 # => 0
8000 << -1 # => 16000

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

[View source]
def ===(char : Char) #

[View source]
def >>(count : 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

[View source]
def ^(other : UInt32) #

def ^(other : UInt16) #

def ^(other : UInt8) #

def ^(other : Int32) #

def ^(other : Int16) #

def ^(other : Int64) #

def ^(other : Int8) #

def ^(other : UInt64) #

def abs #

[View source]
def bit(bit) #

Returns this number's bitth bit, starting with the least-significant.

11.bit(0) # => 1
11.bit(1) # => 1
11.bit(2) # => 0
11.bit(3) # => 1
11.bit(4) # => 0

[View source]
def ceil #

[View source]
def chr #

def day #

[View source]
def days #

[View source]
def divisible_by?(num) #

[View source]
def downto(n) #

[View source]
def downto(n, &block : self -> ) #

[View source]
def even? #

[View source]
def fdiv(other) #

[View source]
def floor #

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

[View source]
def hash #

[View source]
def hour #

[View source]
def hours #

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

[View source]
def millisecond #

[View source]
def milliseconds #

[View source]
def minute #

[View source]
def minutes #

[View source]
def modulo(other) #

[View source]
def month #

[View source]
def months #

[View source]
def odd? #

[View source]
abstract def popcount #

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

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

[View source]
def pred #

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

[View source]
def round #

[View source]
def second #

[View source]
def seconds #

[View source]
def succ #

[View source]
def times #

[View source]
def times(&block : self -> ) #

[View source]
def to(n) #

[View source]
def to(n, &block : self -> ) #

[View source]
def to_big_i #

[View source]
def to_io(io : IO, format : IO::ByteFormat) #

Writes this integer to the given io in the given format.

See IO#write_bytes.


[View source]
def to_json(io) #

[View source]
def to_s(base : Int, io : IO, upcase = false : Bool) #

[View source]
def to_s(base : Int, upcase = false : Bool) #

[View source]
def to_s #

[View source]
def to_s(io : IO) #

[View source]
def trunc #

[View source]
def unsafe_div(other : Int8) #

def unsafe_div(other : UInt8) #

def unsafe_div(other : UInt16) #

def unsafe_div(other : UInt64) #

def unsafe_div(other : UInt32) #

def unsafe_div(other : Int64) #

def unsafe_div(other : Int16) #

def unsafe_div(other : Int32) #

def unsafe_mod(other : Int32) #

def unsafe_mod(other : UInt16) #

def unsafe_mod(other : UInt32) #

def unsafe_mod(other : UInt8) #

def unsafe_mod(other : Int64) #

def unsafe_mod(other : Int16) #

def unsafe_mod(other : Int8) #

def unsafe_mod(other : UInt64) #

def unsafe_shl(other : UInt8) #

def unsafe_shl(other : Int16) #

def unsafe_shl(other : Int8) #

def unsafe_shl(other : UInt16) #

def unsafe_shl(other : UInt32) #

def unsafe_shl(other : UInt64) #

def unsafe_shl(other : Int32) #

def unsafe_shl(other : Int64) #

def unsafe_shr(other : UInt64) #

def unsafe_shr(other : UInt16) #

def unsafe_shr(other : UInt8) #

def unsafe_shr(other : Int64) #

def unsafe_shr(other : Int32) #

def unsafe_shr(other : Int8) #

def unsafe_shr(other : Int16) #

def unsafe_shr(other : UInt32) #

def upto(n, &block : self -> ) #

[View source]
def upto(n) #

[View source]
def week #

[View source]
def weeks #

[View source]
def year #

[View source]
def years #

[View source]
def |(other : Int8) #

def |(other : UInt32) #

def |(other : Int32) #

def |(other : Int64) #

def |(other : UInt16) #

def |(other : UInt8) #

def |(other : UInt64) #

def |(other : Int16) #

def ~ #

[View source]