abstract struct Number

• Number
• Value
• Object

Overview

The top-level number type.

Included Modules

• Comparable(BigFloat)
• Comparable(Number)

Direct Known Subclasses

• BigDecimal
• BigRational
• Float
• Int

Defined in:

Constructors

• .zero : self

Instance Method Summary

• #*(other : Complex)
• #*(other : BigFloat)
• #+(other : BigFloat)
• #+(other : Complex)
• #+

  Returns self.

• #-(other : Complex)
• #-(other : BigFloat)
• #/(other : Complex)
• #/(other : BigFloat)
• #<=>(other : BigFloat)
• #<=>(other)

  Implements the comparison operator.

• #==(other : Complex)
• #abs

  Returns the absolute value of this number.

• #abs2

  Returns the square of self (self * self).

• #cis
• #clamp(min, max)

  Clamps a value between min and max.

• #clamp(range : Range)

  Clamps a value within range.

• #divmod(number)

  Returns a Tuple of two elements containing the quotient and modulus obtained by dividing self by number.

• #i
• #round(digits = 0, base = 10)

  Rounds this number to a given precision in decimal digits.

• #sign

  Returns the sign of this number as an Int32.

• #significant(digits, base = 10)

  Keeps digits significants digits of this number in the given base.

• #step(*, to = nil, by = 1)
• #step(*, to = nil, by = 1, &block)

  Invokes the given block with the sequence of numbers starting at self, incremented by by on each call, and with an optional to.

• #to_big_f
• #to_c
• #to_yaml(yaml : YAML::Nodes::Builder)
• #zero? : Bool

  Returns true if value is equal to zero.

Macro Summary

• [](*nums)

  Creates an Array of self with the given values, which will be casted to this type with the new method (defined in each Number type).

• slice(*nums, read_only = false)

  Creates a Slice of self with the given values, which will be casted to this type with the new method (defined in each Number type).

• static_array(*nums)

  Creates a StaticArray of self with the given values, which will be casted to this type with the new method (defined in each Number type).

Constructor Detail

Instance Method Detail

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

4.abs2   # => 16
1.5.abs2 # => 2.25

5.clamp(10, 100)   # => 10
50.clamp(10, 100)  # => 50
500.clamp(10, 100) # => 100

5.clamp(10..100)   # => 10
50.clamp(10..100)  # => 50
500.clamp(10..100) # => 100

11.divmod(3)  # => {3, 2}
11.divmod(-3) # => {-4, -1}

-1763.116.round(2) # => -1763.12

123.sign # => 1
0.sign   # => 0
-42.sign # => -1

1234.567.significant(1) # => 1000
1234.567.significant(2) # => 1200
1234.567.significant(3) # => 1230
1234.567.significant(4) # => 1235
1234.567.significant(5) # => 1234.6
1234.567.significant(6) # => 1234.57
1234.567.significant(7) # => 1234.567
1234.567.significant(8) # => 1234.567

15.159.significant(1, base = 2) # => 16

3.step(to: 10, by: 2) do |n|
  puts n
end

3
5
7
9

0.zero? # => true
5.zero? # => false

Macro Detail

floats = Float64[1, 2, 3, 4]
floats.class # => Array(Float64)

ints = Int64[1, 2, 3]
ints.class # => Array(Int64)

floats = Float64.slice(1, 2, 3, 4)
floats.class # => Slice(Float64)

ints = Int64.slice(1, 2, 3)
ints.class # => Slice(Int64)

floats = Float64.static_array(1, 2, 3, 4)
floats.class # => StaticArray(Float64, 4)

ints = Int64.static_array(1, 2, 3)
ints.class # => StaticArray(Int64, 3)