struct BigDecimal

Included Modules

Defined in:

big.cr
big/big_decimal.cr
big/number.cr

Constant Summary

DEFAULT_MAX_DIV_ITERATIONS = 100_u64
TEN = BigInt.new(10)
ZERO = BigInt.new(0)

Constructors

Instance Method Summary

Instance methods inherited from module Comparable(BigDecimal)

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

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(Int)

<(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 : 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) >, >=(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 : 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(value : BigInt, scale : UInt64) #

Creates a new BigDecimal from BigInt value and UInt64 scale, which matches the internal representation.


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

Creates a new BigDecimal from Float.

NOTE Floats are fundamentally less precise than BigDecimals, which makes initialization from them risky.


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

Creates a new BigDecimal from BigRational.

NOTE BigRational are fundamentally more precise than BigDecimals, which makes initialization from them risky.


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

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


[View source]
def self.new(num : Int = 0, scale : Int = 0) #

Creates a new BigDecimal from Int.


[View source]
def self.new(str : String) #

Creates a new BigDecimal from a String.

Allows only valid number strings with an optional negative sign.


[View source]

Instance Method Detail

def *(other : BigDecimal) : BigDecimal #

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

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

Raises the decimal to the otherth power

require "big"

BigDecimal.new(1234, 2) ** 2 # => 152.2756

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

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

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

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

[View source]
def - : BigDecimal #

[View source]
def /(other : UInt16) : BigDecimal #

[View source]
def /(other : Float32) : BigDecimal #

[View source]
def /(other : UInt128) : BigDecimal #

[View source]
def /(other : Int128) : BigDecimal #

[View source]
def /(other : UInt64) : BigDecimal #

[View source]
def /(other : Int64) : BigDecimal #

[View source]
def /(other : UInt32) : BigDecimal #

[View source]
def /(other : Int32) : BigDecimal #

[View source]
def /(other : Int16) : BigDecimal #

[View source]
def /(other : UInt8) : BigDecimal #

[View source]
def /(other : Int8) : BigDecimal #

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

[View source]
def /(other : BigFloat) : BigDecimal #

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

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

[View source]
def /(other : Float64) : BigDecimal #

[View source]
def <=>(other : BigDecimal) : Int32 #
Description copied from module Comparable(BigDecimal)

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]

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

[View source]
def ==(other : BigDecimal) : Bool #
Description copied from module Comparable(BigDecimal)

Compares this object to other based on the receiver’s #<=> method, returning true if it returns 0.

Also returns true if this and other are the same object.


[View source]
def ceil : BigDecimal #

[View source]
def clone #

[View source]
def div(other : BigDecimal, max_div_iterations = DEFAULT_MAX_DIV_ITERATIONS) : BigDecimal #

Divides self with another BigDecimal, with a optionally configurable max_div_iterations, which defines a maximum number of iterations in case the division is not exact.

BigDecimal.new(1).div(BigDecimal.new(2))    # => BigDecimal(@value=5, @scale=2)
BigDecimal.new(1).div(BigDecimal.new(3), 5) # => BigDecimal(@value=33333, @scale=5)

[View source]
def floor : BigDecimal #

[View source]
def hash(hasher) #
Description copied from class Object

Appends this object's value to hasher, and returns the modified hasher.

Usually the macro def_hash can be used to generate this method. Otherwise, invoke #hash(hasher) on each object's instance variables to accumulate the result:

def hash(hasher)
  hasher = @some_ivar.hash(hasher)
  hasher = @some_other_ivar.hash(hasher)
  hasher
end

[View source]
def normalize_quotient(other : BigDecimal, quotient : BigInt) : BigInt #

Returns the quotient as absolutely negative if self and other have different signs, otherwise returns the quotient.


[View source]
def scale : UInt64 #

[View source]
def scale_to(new_scale : BigDecimal) : BigDecimal #

Scales a BigDecimal to another BigDecimal, so they can be computed easier.


[View source]
def to_big_d #

[View source]
def to_big_f #

Converts to BigFloat.


[View source]
def to_big_i #

Converts to BigInt. Truncates anything on the right side of the decimal point.


[View source]
def to_big_r #

[View source]
def to_f #

Converts to Float64. Raises OverflowError in case of overflow.


[View source]
def to_f! #

Converts to Float64. In case of overflow a wrapping is performed.


[View source]
def to_f32 #

Converts to Float32. Raises OverflowError in case of overflow.


[View source]
def to_f32! #

Converts to Float32. In case of overflow a wrapping is performed.


[View source]
def to_f64 #

Converts to Float64. Raises OverflowError in case of overflow.


[View source]
def to_f64! #

Converts to Float64. In case of overflow a wrapping is performed.


[View source]
def to_i #

Converts to Int32. Truncates anything on the right side of the decimal point. Raises OverflowError in case of overflow.


[View source]
def to_i! #

Converts to Int32. Truncates anything on the right side of the decimal point. In case of overflow a wrapping is performed.


[View source]
def to_i16 #

Converts to Int16. Truncates anything on the right side of the decimal point. Raises OverflowError in case of overflow.


[View source]
def to_i16! #

Converts to Int16. Truncates anything on the right side of the decimal point. In case of overflow a wrapping is performed.


[View source]
def to_i32 #

Converts to Int32. Truncates anything on the right side of the decimal point. Raises OverflowError in case of overflow.


[View source]
def to_i32! #

Converts to Int32. Truncates anything on the right side of the decimal point. In case of overflow a wrapping is performed.


[View source]
def to_i64 #

Converts to Int64. Truncates anything on the right side of the decimal point. Raises OverflowError in case of overflow.


[View source]
def to_i64! #

Converts to Int64. Truncates anything on the right side of the decimal point. In case of overflow a wrapping is performed.


[View source]
def to_i8 #

Converts to Int8. Truncates anything on the right side of the decimal point. Raises OverflowError in case of overflow.


[View source]
def to_i8! #

Converts to Int8. Truncates anything on the right side of the decimal point. In case of overflow a wrapping is performed.


[View source]
def to_s(io : IO) : Nil #
Description copied from class Object

Appends a String representation of this object to the given IO object.

An object must never append itself to the io argument, as this will in turn call #to_s(io) on it.


[View source]
def to_u #

Converts to UInt32. Truncates anything on the right side of the decimal point, converting negative to positive. Raises OverflowError in case of overflow.


[View source]
def to_u! #

Converts to UInt32. Truncates anything on the right side of the decimal point, converting negative to positive. In case of overflow a wrapping is performed.


[View source]
def to_u16 #

Converts to UInt16. Truncates anything on the right side of the decimal point, converting negative to positive. Raises OverflowError in case of overflow.


[View source]
def to_u16! #

Converts to UInt16. Truncates anything on the right side of the decimal point, converting negative to positive. In case of overflow a wrapping is performed.


[View source]
def to_u32 #

Converts to UInt32. Truncates anything on the right side of the decimal point, converting negative to positive. Raises OverflowError in case of overflow.


[View source]
def to_u32! #

Converts to UInt32. Truncates anything on the right side of the decimal point, converting negative to positive. In case of overflow a wrapping is performed.


[View source]
def to_u64 #

Converts to UInt64. Truncates anything on the right side of the decimal point, converting negative to positive. Raises OverflowError in case of overflow.


[View source]
def to_u64! #

Converts to UInt64. Truncates anything on the right side of the decimal point, converting negative to positive. In case of overflow a wrapping is performed.


[View source]
def to_u8 #

Converts to UInt8. Truncates anything on the right side of the decimal point, converting negative to positive. Raises OverflowError in case of overflow.


[View source]
def to_u8! #

Converts to UInt8. Truncates anything on the right side of the decimal point, converting negative to positive. In case of overflow a wrapping is performed.


[View source]
def trunc : BigDecimal #

[View source]
def value : BigInt #

[View source]