perldoc > BSON::Double

man perldoc info pydoc3 ri search

📛 NAME

BSON::Double - BSON type wrapper for Double

🚀 Quick Reference

Use Case	Command	Description
Create a double	bson_double(42.5)	Wraps a number as a BSON double
Positive infinity	bson_double(BSON::Double::pInf())	Double representing +∞
Negative infinity	bson_double(BSON::Double::nInf())	Double representing −∞
NaN	bson_double(BSON::Double::NaN())	Double representing not‑a‑number
Convert to JSON	$double->TO_JSON	Returns numeric or extended JSON document

🏷️ VERSION

version v1.12.2

📜 SYNOPSIS

use BSON::Types ':all';

my $bytes = bson_double( $number );

📖 DESCRIPTION

This module provides a BSON type wrapper for a numeric value that would be represented in BSON as a double.

🔧 ATTRIBUTES

📊 value

A numeric scalar (or the special strings "Inf", "-Inf" or "NaN"). This will be coerced to Perl's numeric type. The default is 0.0.

🛠️ METHODS

🔄 TO_JSON

Returns a double.

If the BSON_EXTJSON environment variable is true and the BSON_EXTJSON_RELAXED environment variable is false, returns a hashref compatible with MongoDB's extended JSON (spec) format, which represents it as a document as follows:

{"$numberDouble" : "42.0"}

If BSON_EXTJSON is false and the value is 'Inf', '-Inf' or 'NaN' (which are illegal in regular JSON), then an exception is thrown.

∞ INFINITY AND NAN

Some Perls may not support converting "Inf" or "NaN" strings to their double equivalent. They are available as functions from the POSIX module, but as a lighter alternative to POSIX, the following functions are available:

• BSON::Double::pInf() – positive infinity
• BSON::Double::nInf() – negative infinity
• BSON::Double::NaN() – not-a-number

⚡ OVERLOADING

The numification operator, 0+ is overloaded to return the value, the full "minimal set" of overloaded operations is provided (per overload documentation) and fallback overloading is enabled.

👤 AUTHORS

• David Golden <david AT mongodb.com>
• Stefan G. <minimalist AT lavabit.com>

⚖️ COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Stefan G. and MongoDB, Inc.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004

📛 NAME 🚀 Quick Reference 🏷️ VERSION 📜 SYNOPSIS 📖 DESCRIPTION 🔧 ATTRIBUTES 🛠️ METHODS ∞ INFINITY AND NAN ⚡ OVERLOADING 👤 AUTHORS ⚖️ COPYRIGHT AND LICENSE