struct Float64

Defined in:

big/number.cr
float.cr
primitives.cr

Constant Summary

DIGITS = 15

The number of decimal digits that can be represented without losing precision

EPSILON = 2.2204460492503131e-16

The machine epsilon (difference between 1.0 and the next representable value)

INFINITY = (1_f64 / 0_f64).as(Float64)
MANT_DIGITS = 53

The number of digits that can be represented without losing precision (in base RADIX)

MAX = 1.7976931348623157e+308

Largest finite value

MAX_10_EXP = 308

The maximum possible power of 10 exponent (such that 10**MAX_10_EXP is representable)

MAX_EXP = 1024

The maximum possible normal power of 2 exponent

MIN = -1.7976931348623157e+308

Smallest finite value

MIN_10_EXP = -307

The minimum possible power of 10 exponent (such that 10**MIN_10_EXP is representable)

MIN_EXP = -1021

The minimum possible normal power of 2 exponent

MIN_POSITIVE = 2.2250738585072014e-308

Smallest representable positive value

NAN = (0_f64 / 0_f64).as(Float64)
RADIX = 2

The radix or integer base used by the internal representation

Constructors

Class Method Summary

Instance Method Summary

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 | Nil 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) : Bool <, <=(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) : Bool <, <=(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) : Bool <, <=(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 | Nil <=>, ==(other : Complex) ==, abs : self abs, abs2 abs2, cis : Complex cis, divmod(number) divmod, format(io : IO, separator = '.', delimiter = ',', decimal_places : Int | Nil = nil, *, group : Int = 3, only_significant : Bool = false) : Nil
format(separator = '.', delimiter = ',', decimal_places : Int | Nil = 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 | Nil si_prefix

Instance methods inherited from module Comparable(BigFloat)

<(other : T) : Bool <, <=(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) : Bool <, <=(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!(message)
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(value : String, whitespace : Bool = true, strict : Bool = true) : self #

Returns a Float64 by invoking String#to_f64 on value.

Float64.new "20"                        # => 20.0
Float64.new "  20  ", whitespace: false # raises ArgumentError: Invalid Float64: "  20  "

[View source]
def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]
def self.new(pull : JSON::PullParser) #

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

Returns a Float64 by invoking #to_f64 on value.


[View source]
def self.new!(value) : Float64 #

Returns a Float64 by invoking #to_f64! on value.


[View source]

Class Method Detail

def self.from_json_object_key?(key : String) : Float64 | Nil #

[View source]

Instance Method Detail

def !=(other : Int8) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : Int16) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : Int32) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : Int64) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : Int128) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : UInt8) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : UInt16) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : UInt32) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : UInt64) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : UInt128) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : Float32) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def !=(other : Float64) : Bool #

Returns true if self is not equal to other or if self and other are unordered.


[View source]
def *(other : Int8) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : Int16) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : Int32) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : Int64) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : Int128) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : UInt8) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : UInt16) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : UInt32) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : UInt64) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : UInt128) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : Float32) : self #

Returns the result of multiplying self and other.


[View source]
def *(other : Float64) : self #

Returns the result of multiplying self and other.


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

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

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

[View source]
def +(other : Int8) : self #

Returns the result of adding self and other.


[View source]
def +(other : Int16) : self #

Returns the result of adding self and other.


[View source]
def +(other : Int32) : self #

Returns the result of adding self and other.


[View source]
def +(other : Int64) : self #

Returns the result of adding self and other.


[View source]
def +(other : Int128) : self #

Returns the result of adding self and other.


[View source]
def +(other : UInt8) : self #

Returns the result of adding self and other.


[View source]
def +(other : UInt16) : self #

Returns the result of adding self and other.


[View source]
def +(other : UInt32) : self #

Returns the result of adding self and other.


[View source]
def +(other : UInt64) : self #

Returns the result of adding self and other.


[View source]
def +(other : UInt128) : self #

Returns the result of adding self and other.


[View source]
def +(other : Float32) : self #

Returns the result of adding self and other.


[View source]
def +(other : Float64) : self #

Returns the result of adding self and other.


[View source]
def -(other : Int8) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : Int16) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : Int32) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : Int64) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : Int128) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : UInt8) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : UInt16) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : UInt32) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : UInt64) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : UInt128) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : Float32) : self #

Returns the result of subtracting self and other.


[View source]
def -(other : Float64) : self #

Returns the result of subtracting self and other.


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

Returns the result of division self and other.


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[View source]
def <(other : Int8) : Bool #

Returns true if self is less than other.


[View source]
def <(other : Int16) : Bool #

Returns true if self is less than other.


[View source]
def <(other : Int32) : Bool #

Returns true if self is less than other.


[View source]
def <(other : Int64) : Bool #

Returns true if self is less than other.


[View source]
def <(other : Int128) : Bool #

Returns true if self is less than other.


[View source]
def <(other : UInt8) : Bool #

Returns true if self is less than other.


[View source]
def <(other : UInt16) : Bool #

Returns true if self is less than other.


[View source]
def <(other : UInt32) : Bool #

Returns true if self is less than other.


[View source]
def <(other : UInt64) : Bool #

Returns true if self is less than other.


[View source]
def <(other : UInt128) : Bool #

Returns true if self is less than other.


[View source]
def <(other : Float32) : Bool #

Returns true if self is less than other.


[View source]
def <(other : Float64) : Bool #

Returns true if self is less than other.


[View source]
def <=(other : Int8) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : Int16) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : Int32) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : Int64) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : Int128) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : UInt8) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : UInt16) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : UInt32) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : UInt64) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : UInt128) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : Float32) : Bool #

Returns true if self is less than or equal to other.


[View source]
def <=(other : Float64) : Bool #

Returns true if self is less than or equal to other.


[View source]
def ==(other : Int8) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : Int16) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : Int32) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : Int64) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : Int128) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : UInt8) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : UInt16) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : UInt32) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : UInt64) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : UInt128) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : Float32) : Bool #

Returns true if self is equal to other.


[View source]
def ==(other : Float64) : Bool #

Returns true if self is equal to other.


[View source]
def >(other : Int8) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : Int16) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : Int32) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : Int64) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : Int128) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : UInt8) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : UInt16) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : UInt32) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : UInt64) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : UInt128) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : Float32) : Bool #

Returns true if self is greater than other.


[View source]
def >(other : Float64) : Bool #

Returns true if self is greater than other.


[View source]
def >=(other : Int8) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : Int16) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : Int32) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : Int64) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : Int128) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : UInt8) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : UInt16) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : UInt32) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : UInt64) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : UInt128) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : Float32) : Bool #

Returns true if self is greater than or equal to other.


[View source]
def >=(other : Float64) : Bool #

Returns true if self is greater than or equal to other.


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

[View source]
def clone #

[View source]
def fdiv(other : Int8) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : Int16) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : Int32) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : Int64) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : Int128) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : UInt8) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : UInt16) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : UInt32) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : UInt64) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : UInt128) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : Float32) : self #

Returns the float division of self and other.


[View source]
def fdiv(other : Float64) : self #

Returns the float division of self and other.


[View source]
def floor : Float64 #

[View source]
def next_float : Float64 #

Returns the least Float64 that is greater than self.


[View source]
def prev_float : Float64 #

Returns the greatest Float64 that is less than self.


[View source]
def round_away : Float64 #

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


[View source]
def round_even : Float64 #

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


[View source]
def to_f : Float64 #

Returns self converted to Float64. Raises OverflowError in case of overflow.


[View source]
def to_f! : Float64 #

Returns self converted to Float64. In case of overflow infinity is returned.


[View source]
def to_f32 : Float32 #

Returns self converted to Float32. Raises OverflowError in case of overflow.


[View source]
def to_f32! : Float32 #

Returns self converted to Float32. In case of overflow infinity is returned.


[View source]
def to_f64 : Float64 #

Returns self converted to Float64. Raises OverflowError in case of overflow.


[View source]
def to_f64! : Float64 #

Returns self converted to Float64. In case of overflow infinity is returned.


[View source]
def to_i : Int32 #

Returns self converted to Int32. Raises OverflowError in case of overflow.


[View source]
def to_i! : Int32 #

Returns self converted to Int32. In case of overflow the result is undefined.


[View source]
def to_i128 : Int128 #

Returns self converted to Int128. Raises OverflowError in case of overflow.


[View source]
def to_i128! : Int128 #

Returns self converted to Int128. In case of overflow the result is undefined.


[View source]
def to_i16 : Int16 #

Returns self converted to Int16. Raises OverflowError in case of overflow.


[View source]
def to_i16! : Int16 #

Returns self converted to Int16. In case of overflow the result is undefined.


[View source]
def to_i32 : Int32 #

Returns self converted to Int32. Raises OverflowError in case of overflow.


[View source]
def to_i32! : Int32 #

Returns self converted to Int32. In case of overflow the result is undefined.


[View source]
def to_i64 : Int64 #

Returns self converted to Int64. Raises OverflowError in case of overflow.


[View source]
def to_i64! : Int64 #

Returns self converted to Int64. In case of overflow the result is undefined.


[View source]
def to_i8 : Int8 #

Returns self converted to Int8. Raises OverflowError in case of overflow.


[View source]
def to_i8! : Int8 #

Returns self converted to Int8. In case of overflow the result is undefined.


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

Prints a nicely readable and concise string representation of this object, typically intended for users, to io.

This method is called when an object is interpolated in a string literal:

"foo #{bar} baz" # calls bar.to_io with the builder for this string

IO#<< calls this method to append an object to itself:

io << bar # calls bar.to_s(io)

Thus implementations must not interpolate self in a string literal or call io << self which both would lead to an endless loop.

Also see #inspect(IO).


[View source]
def to_s : String #
Description copied from class Object

Returns a nicely readable and concise string representation of this object, typically intended for users.

This method should usually not be overridden. It delegates to #to_s(IO) which can be overridden for custom implementations.

Also see #inspect.


[View source]
def to_u : UInt32 #

Returns self converted to UInt32. Raises OverflowError in case of overflow.


[View source]
def to_u! : UInt32 #

Returns self converted to UInt32. In case of overflow the result is undefined.


[View source]
def to_u128 : UInt128 #

Returns self converted to UInt128. Raises OverflowError in case of overflow.


[View source]
def to_u128! : UInt128 #

Returns self converted to UInt128. In case of overflow the result is undefined.


[View source]
def to_u16 : UInt16 #

Returns self converted to UInt16. Raises OverflowError in case of overflow.


[View source]
def to_u16! : UInt16 #

Returns self converted to UInt16. In case of overflow the result is undefined.


[View source]
def to_u32 : UInt32 #

Returns self converted to UInt32. Raises OverflowError in case of overflow.


[View source]
def to_u32! : UInt32 #

Returns self converted to UInt32. In case of overflow the result is undefined.


[View source]
def to_u64 : UInt64 #

Returns self converted to UInt64. Raises OverflowError in case of overflow.


[View source]
def to_u64! : UInt64 #

Returns self converted to UInt64. In case of overflow the result is undefined.


[View source]
def to_u8 : UInt8 #

Returns self converted to UInt8. Raises OverflowError in case of overflow.


[View source]
def to_u8! : UInt8 #

Returns self converted to UInt8. In case of overflow the result is undefined.


[View source]
def trunc : Float64 #

[View source]