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) : Bool >, >=(other : T) >=, clamp(min, max)
clamp(range : Range) clamp

Instance methods inherited from module Comparable(BigFloat)

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

Instance methods inherited from module Comparable(Int)

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

Instance methods inherited from struct Float

%(other) %, - -, //(other) //, <=>(other : BigInt)
<=>(other : BigRational)
<=>(other : BigDecimal) <=>
, days : Time::Span days, fdiv(other : BigInt | BigFloat | BigDecimal | BigRational) : self fdiv, finite? : Bool finite?, hash(hasher) hash, hours : Time::Span hours, infinite? : Int32? infinite?, microseconds : Time::Span microseconds, milliseconds : Time::Span milliseconds, minutes : Time::Span minutes, modulo(other) modulo, nan? : Bool nan?, nanoseconds : Time::Span nanoseconds, remainder(other) remainder, seconds : Time::Span seconds, to_big_d : BigDecimal to_big_d, to_big_i : BigInt to_big_i, to_big_r : BigRational to_big_r, to_io(io : IO, format : IO::ByteFormat) : Nil to_io, to_json(json : JSON::Builder) : Nil to_json, to_json_object_key : String to_json_object_key, to_yaml(yaml : YAML::Nodes::Builder) : Nil to_yaml, 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) : Bool >, >=(other : T) >=, clamp(min, max)
clamp(range : Range) clamp

Instance methods inherited from module Comparable(BigRational)

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

Instance methods inherited from module Comparable(BigInt)

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

Instance methods inherited from struct Number

*(other : BigFloat) : BigFloat
*(other : Complex) : Complex *
, +(other : BigFloat)
+(other : Complex) : Complex
+ +
, -(other : BigFloat)
-(other : Complex) : Complex -
, /(other : BigFloat) : BigFloat
/(other : Complex) : Complex /
, //(other) //, <=>(other : BigFloat)
<=>(other) : Int32? <=>
, ==(other : Complex) ==, abs : self abs, abs2 abs2, cis : Complex cis, divmod(number) divmod, format(io : IO, separator = '.', delimiter = ',', decimal_places : Int? = nil, *, group : Int = 3, only_significant : Bool = false) : Nil
format(separator = '.', delimiter = ',', decimal_places : Int? = nil, *, group : Int = 3, only_significant : Bool = false) : String 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, _) | Tuple(Int32, _, Bool)) : Nil
humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, &) : String
humanize(precision = 3, separator = '.', delimiter = ',', *, base = 10 ** 3, significant = true, prefixes : Proc) : String humanize
, i : Complex i, negative? : Bool negative?, positive? : Bool positive?, round(mode : RoundingMode = :ties_even) : self
round(digits : Number, base = 10, *, mode : RoundingMode = :ties_even) round
, sign : Int32 sign, significant(digits, base = 10) significant, step(*, to limit = nil, exclusive : Bool = false, &) : Nil
step(*, to limit = nil, exclusive : Bool = false) step
, to_big_f : BigFloat to_big_f, to_c : Complex to_c, to_yaml(yaml : YAML::Nodes::Builder) : Nil to_yaml, zero? : Bool zero?

Constructor methods inherited from struct Number

additive_identity : self additive_identity, multiplicative_identity : self multiplicative_identity, 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) : Bool >, >=(other : T) >=, clamp(min, max)
clamp(range : Range) clamp

Instance methods inherited from module Steppable

step(*, to limit = nil, by step, exclusive : Bool = false, &) : Nil
step(*, to limit = nil, by step, exclusive : Bool = false) step

Instance methods inherited from module Comparable(Number)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) : Bool >, >=(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(hasher)
hash hash
, in?(collection : Object) : Bool
in?(*values : Object) : Bool in?
, 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) : Nil
to_json : String to_json
, to_pretty_json(indent : String = " ") : String
to_pretty_json(io : IO, indent : String = " ") : Nil to_pretty_json
, to_s(io : IO) : Nil
to_s : String to_s
, to_yaml(io : IO) : Nil
to_yaml : String 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)Source

def self.new(str : String)Source

def self.new(num : BigInt)Source

def self.new(num : BigRational)Source

def self.new(num : BigFloat)Source

def self.new(num : Int8 | Int16 | Int32)Source

def self.new(num : UInt8 | UInt16 | UInt32)Source

def self.new(num : Int64)Source

def self.new(num : UInt64)Source

def self.new(num : Number)Source

def self.new(mpf : LibGMP::MPF)Source

def self.newSource

def self.new(&)Source

Class Method Detail

def self.default_precisionSource

def self.default_precision=(prec : Int)Source

Instance Method Detail

def *(other : Number) : BigFloatSource

def **(other : Int) : BigFloatSource

def +(other : Number) : BigFloatSource

def -(other : Number) : BigFloatSource

def - : BigFloatSource

def /(other : BigFloat) : BigFloatSource

def /(other : BigInt) : BigFloatSource

def /(other : BigDecimal) : BigDecimalSource

def /(other : BigRational) : BigRationalSource

def /(other : UInt8 | UInt16 | UInt32 | UInt64) : BigFloatSource

def /(other : Int8) : BigFloatSource

def /(other : Int16) : BigFloatSource

def /(other : Int32) : BigFloatSource

def /(other : Int64) : BigFloatSource

def /(other : Int128) : BigFloatSource

def /(other : UInt128) : BigFloatSource

def /(other : Float32) : BigFloatSource

def /(other : Float64) : BigFloatSource

def <=>(other : BigFloat)Source

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 greater 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]

def <=>(other : BigInt)Source

def <=>(other : Float32 | Float64)Source

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 greater 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]

def <=>(other : Number)Source

def abs : BigFloatSource

Description copied from struct Number

Returns the absolute value of this number.

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

def ceil : BigFloatSource

def cloneSource

def fdiv(other : Number::Primitive) : selfSource

def floor : BigFloatSource

def hash(hasher)Source

TODO improve this

def round_away : selfSource

Rounds towards the nearest integer. If both neighboring integers are equidistant, rounds away from zero.

def round_even : selfSource

Rounds towards the nearest integer. If both neighboring integers are equidistant, rounds towards the even neighbor (Banker's rounding).

def to_big_f : BigFloatSource

def to_big_i : BigIntSource

Description copied from struct Float

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

require "big"

1212341515125412412412421.0.to_big_i

def to_f : Float64Source

def to_f! : Float64Source

def to_f32 : Float32Source

def to_f32! : Float32Source

def to_f64 : Float64Source

def to_f64! : Float64Source

def to_i : Int32Source

def to_i! : Int32Source

def to_i16 : Int16Source

def to_i16! : Int16Source

def to_i32 : Int32Source

def to_i32! : Int32Source

def to_i64 : Int64Source

def to_i64! : Int64Source

def to_i8 : Int8Source

def to_i8! : Int8Source

def to_s(io : IO) : NilSource

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.

def to_u : UInt32Source

def to_u! : UInt32Source

def to_u16 : UInt16Source

def to_u16! : UInt16Source

def to_u32 : UInt32Source

def to_u32! : UInt32Source

def to_u64 : UInt64Source

def to_u64! : UInt64Source

def to_u8 : UInt8Source

def to_u8! : UInt8Source

def to_unsafeSource

def trunc : BigFloatSource

© 2012–2021 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/1.2.1/BigFloat.html