W3cubDocs

/Crystal 0.31

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) >=

Instance methods inherited from module Comparable(BigFloat)

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

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) >=

Instance methods inherited from module Comparable(BigRational)

<, <=(other : T) <=, <=>(other : T) <=>, ==(other : T) ==, >(other : T) >, >=(other : T) >=

Instance methods inherited from module Comparable(BigInt)

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

Instance methods inherited from module Comparable(Number)

<, <=(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(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(&block)Source

Class Method Detail

def self.default_precisionSource

def self.default_precision=(prec : Int)Source

Instance Method Detail

def *(other : Number)Source

def **(other : Int)Source

def +(other : Number)Source

def -(other : Number)Source

def -Source

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

def /(other : Float64) : BigFloatSource

def /(other : Float32) : BigFloatSource

def /(other : UInt128) : BigFloatSource

def /(other : Int128) : BigFloatSource

def /(other : Int64) : BigFloatSource

def /(other : Int32) : BigFloatSource

def /(other : Int16) : BigFloatSource

def /(other : Int8) : BigFloatSource

def /(other : BigRational) : BigRationalSource

def /(other : BigDecimal) : BigDecimalSource

def /(other : BigInt) : BigFloatSource

def /(other : BigFloat)Source

def <=>(other : Number)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 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]

def <=>(other : BigInt)Source

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

def absSource

Description copied from struct Number

Returns the absolute value of this number.

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

def ceilSource

def cloneSource

def floorSource

def hash(hasher)Source

TODO improve this

def to_big_fSource

def to_big_iSource

Description copied from struct Float

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

require "big"

1212341515125412412412421.0.to_big_i

def to_fSource

def to_f!Source

def to_f32Source

def to_f32!Source

def to_f64Source

def to_f64!Source

def to_iSource

def to_i!Source

def to_i16Source

def to_i16!Source

def to_i32Source

def to_i32!Source

def to_i64Source

def to_i64!Source

def to_i8Source

def to_i8!Source

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_uSource

def to_u!Source

def to_u16Source

def to_u16!Source

def to_u32Source

def to_u32!Source

def to_u64Source

def to_u64!Source

def to_u8Source

def to_u8!Source

def to_unsafeSource

def truncSource

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