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.crtime/span.cr
time/span.cr
big/big_int.cr
big/big_rational.cr
json/to_json.cr
Class Method Summary
- 
        .from_io(io : IO, format : IO::ByteFormat)
        
          
Reads an integer from the given io in the given format.
 
Instance Method Summary
- #%(other : Int)
 - #%(other : BigInt) : BigInt
 - #*(other : BigInt) : BigInt
 - #*(other : BigRational)
 - 
        #**(exponent : Float) : Float64
        
          
Returns the value of raising self to the power of exponent.
 - 
        #**(exponent : Int) : self
        
          
Returns the value of raising self to the power of exponent.
 - #+(other : BigInt) : BigInt
 - #+(other : BigRational)
 - #-(other : BigRational)
 - #-(other : BigInt) : BigInt
 - #/(other : BigRational)
 - #/(x : Int)
 - #/(other : BigInt) : BigInt
 - 
        #<<(count : Int)
        
          
Returns the result of shifting this number's bits count positions to the left.
 - #<=>(other : BigRational)
 - #<=>(other : BigInt)
 - #===(char : Char)
 - 
        #>>(count : Int)
        
          
Returns the result of shifting this number's bits count positions to the right.
 - #abs
 - 
        #bit(bit)
        
          
Returns this number's bitth bit, starting with the least-significant.
 - #ceil
 - 
        #chr
        
          
Returns a
Charthat has the unicode codepoint of self. - #day
 - #days
 - #divisible_by?(num)
 - #downto(n, &block : self -> )
 - #downto(n)
 - #even?
 - #fdiv(other)
 - #floor
 - #gcd(other : Int)
 - #hash
 - #hour
 - #hours
 - #lcm(other : Int)
 - #millisecond
 - #milliseconds
 - #minute
 - #minutes
 - #modulo(other)
 - #month
 - #months
 - #odd?
 - 
        #popcount
        
          
Counts
1-bits in the binary representation of this integer. - #pred
 - #remainder(other : Int)
 - #round
 - #second
 - #seconds
 - #succ
 - #times(&block : self -> )
 - #times
 - #to(n)
 - #to(n, &block : self -> )
 - 
        #to_big_i : BigInt
        
          
Returns a BigInt representing this integer.
 - 
        #to_big_r
        
          
Returns a BigRational representing this integer.
 - 
        #to_io(io : IO, format : IO::ByteFormat)
        
          
Writes this integer to the given io in the given format.
 - #to_json(io)
 - #to_s(base : Int, io : IO, upcase : Bool = false)
 - #to_s(io : IO)
 - #to_s
 - #to_s(base : Int, upcase : Bool = false)
 - #trunc
 - #upto(n, &block : self -> )
 - #upto(n)
 - #week
 - #weeks
 - #year
 - #years
 - #~
 
Instance methods inherited from module Comparable(T)
  
  
    
      <(other : T)
    <, 
    
  
    
      <=(other : T)
    <=, 
    
  
    
      <=>(other : T)
    <=>, 
    
  
    
      ==(other : T)
    ==, 
    
  
    
      >(other : T)
    >, 
    
  
    
      >=(other : T)
    >=
    
  
    
  
    
  Instance methods inherited from module Comparable(T)
  
  
    
      <(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(range : Range)
clamp(min, max) 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_big_f to_big_f, to_c to_c, to_yaml(yaml : YAML::Generator) to_yaml
Class methods inherited from struct Number
  
  
    
      zero : self
    zero
    
  
  
    
  Instance methods inherited from module Comparable(T)
  
  
    
      <(other : T)
    <, 
    
  
    
      <=(other : T)
    <=, 
    
  
    
      <=>(other : T)
    <=>, 
    
  
    
      ==(other : T)
    ==, 
    
  
    
      >(other : T)
    >, 
    
  
    
      >=(other : T)
    >=
    
  
    
  
    
  Instance methods inherited from module Comparable(T)
  
  
    
      <(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)===(other : YAML::Any)
===(other : JSON::Any) ===, =~(other) =~, class class, crystal_type_id crystal_type_id, dup dup, hash hash, inspect(io : IO)
inspect 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
to_yaml(io : IO) to_yaml, try(&block) try
Class methods inherited from class Object
  
  
    
      ==(other : Class)
    ==, 
    
  
    
      ===(other)
    ===, 
    
  
    
      cast(other) : self
    cast, 
    
  
    
      clone
    clone, 
    
  
    
      dup
    dup, 
    
  
    
      from_json(string_or_io, root : String) : selffrom_json(string_or_io) : self from_json, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, to_s(io) to_s, |(other : U.class) |
Class Method Detail
Reads an integer from the given io in the given format.
See IO#read_bytes.
Instance Method Detail
Returns the value of raising self to the power of exponent.
2 ** 3.0  # => 8.0
2 ** 0.0  # => 1.0
2 ** -1.0 # => 0.5Returns 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.
2 ** 3  # => 8
2 ** 0  # => 1
2 ** -1 # ArgumentErrorReturns 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 # => 16000Returns 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 # => -4000Returns 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) # => 0Returns a Char that has the unicode codepoint of self.
Raises ArgumentError if this integer's value doesn't fit a char's range (0..0x10ffff).
97.chr # => 'a'Counts 1-bits in the binary representation of this integer.
5.popcount   # => 2
-15.popcount # => 5Writes this integer to the given io in the given format.
See IO#write_bytes.