module BSON::Float

Injects behaviour for encoding and decoding floating point values to and from raw bytes as specified by the BSON spec.

@see bsonspec.org/#/specification

@since 2.0.0

Constants

BSON_TYPE

A floating point is type 0x01 in the BSON spec.

@since 2.0.0

PACK

The pack directive is for 8 byte floating points.

@since 2.0.0

Public Instance Methods

as_extended_json(**options) click to toggle source

Converts this object to a representation directly serializable to Extended JSON (github.com/mongodb/specifications/blob/master/source/extended-json.rst).

This method returns the float itself if relaxed representation is requested and the value is finite, otherwise a $numberDouble hash.

@option opts [ nil | :relaxed | :legacy ] :mode Serialization mode

(default is canonical extended JSON)

@return [ Hash | Float ] The extended json representation.

# File lib/bson/float.rb, line 60
def as_extended_json(**options)
  if infinite? == 1
    { '$numberDouble' => 'Infinity' }
  elsif infinite? == -1
    { '$numberDouble' => '-Infinity' }
  elsif nan?
    { '$numberDouble' => 'NaN' }
  elsif options[:mode] == :relaxed || options[:mode] == :legacy
    self
  elsif BSON::Environment.jruby? && abs > 1e15
    # Hack to make bson corpus spec tests pass.
    # JRuby serializes -1.2345678901234568e+18 as
    # -1234567890123456770.0, which is valid but differs from MRI
    # serialization. Extended JSON spec does not define precise
    # stringification of floats.
    # https://jira.mongodb.org/browse/SPEC-1536
    { '$numberDouble' => ('%.17g' % to_s).upcase }
  else
    { '$numberDouble' => to_s.upcase }
  end
end
to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?) click to toggle source

Get the floating point as encoded BSON.

@example Get the floating point as encoded BSON.

1.221311.to_bson

@return [ BSON::ByteBuffer ] The buffer with the encoded object.

@see bsonspec.org/#/specification

@since 2.0.0

# File lib/bson/float.rb, line 46
def to_bson(buffer = ByteBuffer.new, validating_keys = Config.validating_keys?)
  buffer.put_double(self)
end