class Double

namespace sys.core.lang
class Double

A class representing a 64 bit floating point number.

It maps exactly to a 64 bit CPU resource and has no overhead. Because of this strict mapping it can't have extra non-static member variables, can't be inherited from and can't have virtual methods.

Constructors

Saturated

this Saturated{value: Double};

Brief

Constructs a saturated Double based on the input value.

Parameters

value	the input value. Can be numeric or a string.

Methods

Clamp

def Clamp(min: Double, max: Double);

Brief

Clamps the current mutable instance between `min` and `max`.

Parameters

min	the minimum value
max	the maximum value

Clamped

func Clamped(min: Double, max: Double): Double;

Brief

Returns the current instance clamped between `min` and `max`.

Parameters

min	the minimum value
max	the maximum value

Returns

the clamped value

Pow

func Pow(exp: Double): Double;

Brief

Raises the instance to an exponent.

Parameters

exp	the exponent

Returns

the exponential

ToString

func ToString(): String;

Brief

Converts the value to a Utf8 string.

Returns

the resulting string

@write

func @write(ref stream: Stream);
func @write(ref stream: Stream, format: OutputFormat);

Brief

Writes the value to an Utf8 text stream.

Can use an optional output format specifier.

Parameters

stream	the output stream
format	formatting information

@put

func @put(ref stream: Stream);

Brief

Writes the value to a binary stream as a 64 bit floating point.

Parameters

stream	the output stream

@get

def @get(ref stream: Stream);

Brief

Reads a 64 bit floating point from a binary stream.

Parameters

stream	the input stream

Properties

IsNan

property IsNan: Bool; get;

Brief

Return true if the instance is not a number.

IsInfinite

property IsInfinite: Bool; get;

Brief

Return true if the infinite.

Abs

property Abs: Double; get;

Brief

Returns the absolute value.

Sqr

property Sqr: Double; get;

Brief

Returns the square of the value value.

Sqrt

property Sqrt: Double get = Math.Sqrt;

Brief

Returns the square root of the value.

Floor

property Floor: Double get = Math.Floor;

Brief

Returns the floor of a floating point value.

Ceil

property Ceil: Double get = Math.Ceil;

Brief

Returns the ceiling of a floating point value.

Round

property Round: Double get = Math.Round;

Brief

Returns the rounded value of a floating point.

Trunc

property Trunc: Double get = Math.Trunc;

Brief

Returns the value truncated to the nearest integer value.

Sin

property Sin: Double get = Math.Sin;

Brief

Returns the sine of the value.

Cos

property Cos: Double get = Math.Cos;

Brief

Returns the cosine of the value.

Tan

property Tan: Double get = Math.Tan;

Brief

Returns the tangent of the value.

Sinh

property Sinh: Double get = Math.Sinh;

Brief

Returns the hyperbolic sine of the value.

Cosh

property Cosh: Double get = Math.Cosh;

Brief

Returns the hyperbolic cosine of the value.

Tanh

property Tanh: Double get = Math.Tanh;

Brief

Returns the hyperbolic tangent of the value.

Asin

property Asin: Double get = Math.Asin;

Brief

Returns the arcsine of the value.

Acos

property Acos: Double get = Math.Acos;

Brief

Returns the arccosine of the value.

Atan

property Atan: Double get = Math.Atan;

Brief

Returns the arctangent of the value.

Asinh

property Asinh: Double get = Math.Asinh;

Brief

Returns the hyperbolic arcsine of the value.

Acosh

property Acosh: Double get = Math.Acosh;

Brief

Returns the hyperbolic arcsine of the value.

Atanh

property Atanh: Double get = Math.Atanh;

Brief

Returns the hyperbolic arctangent of the value.

Log

property Log: Double get = Math.Log;

Brief

Returns the natural logarithm of a value.

Log2

property Log2: Double get = Math.Log2;

Brief

Returns the base 2 logarithm of a value.

Log10

property Log10: Double get = Math.Log10;

Brief

Returns the base 10 logarithm of a value.

Constants

Zero

const Zero: Double;

Brief

A Double instance representing a logical "0" value.

One

const One: Double;

Brief

A Double instance representing a logical "1" value.

Min

const Min: Double;

Brief

The minimum value for a Double (64 bit floating point) instance.

Max

const Max: Double;

Brief

The maximum value for a Double (64 bit floating point) instance.

IsSigned

const IsSigned;

Brief

Returns true if the floating point representation is signed.

IsInteger

const IsInteger;

Brief

Returns false.

MaxDigitsLow

const MaxDigitsLow;

Brief

The lower limit for the number of base 10 digits that are needed to represent a maximal value in textual form.

In base 10, you can have MaxDigitsLow digits that go though values 0-9.

Should not be used for buffer sizes.

MaxDigitsHigh

const MaxDigitsHigh;

Brief

The upper limit for the number of base 10 digits that are needed to represent a maximal value in textual form.

In base 10, the `MaxDigitsHigh - MaxDigitsLow` most significant digits can't go though values 0-9 because they do not fit the binary representation.

Should not be used for buffer sizes.

MinExpBase10

const MinExpBase10;

Brief

The minimum base 10 exponent.

MaxExpBase10

const MaxExpBase10;

Brief

The maximum base 10 exponent.

Nan

const Nan;

Brief

The not a number value.

Infinite

const Infinite;

Brief

Positive infinite.