struct BigFloat

Overview

A BigFloat can represent arbitrarily large floats.

It is implemented under the hood with GMP.

Included Modules

Defined in:

big.cr
big/big_float.cr
big/number.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Comparable(Float)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, clamp(min, max)
clamp(range : Range)
clamp

Instance methods inherited from module Comparable(BigFloat)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, clamp(min, max)
clamp(range : Range)
clamp

Instance methods inherited from module Comparable(Int)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, clamp(min, max)
clamp(range : Range)
clamp

Instance methods inherited from struct Float

%(other) %, - -, //(other) //, <=>(other : BigDecimal)
<=>(other : BigRational)
<=>(other : BigInt)
<=>
, days : Time::Span days, fdiv(other) : self fdiv, finite? finite?, hash(hasher) hash, hours : Time::Span hours, infinite? infinite?, microseconds : Time::Span microseconds, milliseconds : Time::Span milliseconds, minutes : Time::Span minutes, modulo(other) modulo, nan? nan?, nanoseconds : Time::Span nanoseconds, remainder(other) remainder, seconds : Time::Span seconds, to_big_d to_big_d, 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_json_object_key to_json_object_key, weeks : Time::Span weeks

Constructor methods inherited from struct Float

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

Instance methods inherited from module Comparable(BigDecimal)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, clamp(min, max)
clamp(range : Range)
clamp

Instance methods inherited from module Comparable(BigRational)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, clamp(min, max)
clamp(range : Range)
clamp

Instance methods inherited from module Comparable(BigInt)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, clamp(min, max)
clamp(range : Range)
clamp

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, 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(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Proc) : Nil
humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, &) : String
humanize(io : IO, precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, &prefixes : Int32, Float64 -> Tuple(Int32, _) | Tuple(Int32, _, Bool)) : 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 : 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, &)
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) >=, clamp(min, max)
clamp(range : Range)
clamp

Instance methods inherited from module Comparable(Number)

<(other : T) <, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=, clamp(min, max)
clamp(range : Range)
clamp

Instance methods inherited from struct Value

==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash
hash(hasher)
hash
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) 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(&) try, unsafe_as(type : T.class) forall T unsafe_as

Class methods inherited from class Object

from_json(string_or_io, root : String)
from_json(string_or_io)
from_json
, from_yaml(string_or_io : String | IO) from_yaml

Constructor Detail

def self.new(num : Float, precision : Int) #

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

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

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

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

[View source]
def self.new(num : Int8 | Int16 | Int32) #

[View source]
def self.new(num : UInt8 | UInt16 | UInt32) #

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

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

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

[View source]
def self.new(mpf : LibGMP::MPF) #

[View source]
def self.new #

[View source]
def self.new(&) #

[View source]

Class Method Detail

def self.default_precision #

[View source]
def self.default_precision=(prec : Int) #

[View source]

Instance Method Detail

def *(other : Number) #

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

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

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

[View source]
def - #

[View source]
def /(other : UInt8 | UInt16 | UInt32 | UInt64) #

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

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

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

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

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

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

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

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

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

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

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

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

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

[View source]
def <=>(other : Float32 | Float64) #
Description copied from module Comparable(Float)

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 : BigInt) #

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

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 abs #
Description copied from struct Number

Returns the absolute value of this number.

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

[View source]
def ceil #

[View source]
def clone #

[View source]
def floor #

[View source]
def hash(hasher) #

TODO improve this


[View source]
def to_big_f #

[View source]
def to_big_i #
Description copied from struct Float

Returns a BigInt representing this float (rounded using #floor).

require "big"

1212341515125412412412421.0.to_big_i

[View source]
def to_f #

[View source]
def to_f! #

[View source]
def to_f32 #

[View source]
def to_f32! #

[View source]
def to_f64 #

[View source]
def to_f64! #

[View source]
def to_i #

[View source]
def to_i! #

[View source]
def to_i16 #

[View source]
def to_i16! #

[View source]
def to_i32 #

[View source]
def to_i32! #

[View source]
def to_i64 #

[View source]
def to_i64! #

[View source]
def to_i8 #

[View source]
def to_i8! #

[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 #

[View source]
def to_u! #

[View source]
def to_u16 #

[View source]
def to_u16! #

[View source]
def to_u32 #

[View source]
def to_u32! #

[View source]
def to_u64 #

[View source]
def to_u64! #

[View source]
def to_u8 #

[View source]
def to_u8! #

[View source]
def to_unsafe #

[View source]
def trunc #

[View source]