frost.core

Class Real64

    └ Value
         └ Immutable
             └ Object

Implemented Interfaces:

A 64-bit floating point number.

Source Code:
View Source

Constant Summary

PI:Real64
E:Real64

Class Method Summary

atan2(y:Real64, x:Real64):Real64
Returns the counterclockwise angle in radians between the X axis and the point (x, y).

Field Summary

value:builtin_float64
abs:Real64
The absolute value of this number.
floor:Real64
This number rounded down (that is, in the direction of negative infinity) to the nearest integer.
ceiling:Real64
This number rounded up (that is, in the direction of positive infinity) to the nearest integer.
sqrt:Real64
The square root of this number.
sin:Real64
The trigonometric sine of this number.
cos:Real64
The trigonometric cosine of this number.
tan:Real64
The trigonometric tangent of this number.
asin:Real64
The trigonometric arcsine of this number.
acos:Real64
The trigonometric arccosine of this number.
atan:Real64
The trigonometric arctangent of this number.
asInt:Int
This number converted to an Int.
toInt:Int
This number converted to an Int.
asInt8:Int8
This number converted to an 8 bit signed number.
toInt8:Int8
This number converted to an 8 bit signed number.
asInt16:Int16
This number converted to a 16 bit signed number.
toInt16:Int16
This number converted to a 16 bit signed number.
asInt32:Int32
This number converted to a 32 bit signed number.
toInt32:Int32
This number converted to a 32 bit signed number.
asInt64:Int64
This number converted to a 64 bit signed number.
toInt64:Int64
This number converted to a 64 bit signed number.
asUInt:UInt
This number converted to a UInt.
toUInt:UInt
This number converted to a UInt.
asUInt8:UInt8
This number converted to an 8 bit unsigned number.
toUInt8:UInt8
This number converted to an 8 bit unsigned number.
asUInt16:UInt16
This number converted to a 16 bit unsigned number.
toUInt16:UInt16
This number converted to a 16 bit unsigned number.
asUInt32:UInt32
This number converted to a 32 bit unsigned number.
toUInt32:UInt32
This number converted to a 32 bit unsigned number.
asUInt64:UInt64
This number converted to a 64 bit unsigned number.
toUInt64:UInt64
This number converted to a 64 bit unsigned number.
asReal32:Real32
This number converted to a 32 bit floating point number.
toReal32:Real32
This number converted to a 32 bit floating point number.
asReal64:Real64
This number converted to a 64 bit floating point number.
toReal64:Real64
This number converted to a 64 bit floating point number.
Inherited Fields:

Instance Method Summary

-- add operator --
+(other:Real64):Real64
Adds another number to this number.
-- subtract operator --
-(other:Real64):Real64
Subtracts another number from this number.
-- subtract operator --
-():Real64
Returns the negation (additive inverse) of this number
-- multiply operator --
*(other:Real64):Real64
Multiplies this number by another number.
-- divide operator --
/(other:Int8):Real64
Divides this number by another number.
-- divide operator --
/(other:Int16):Real64
Divides this number by another number.
-- divide operator --
/(other:Int32):Real64
Divides this number by another number.
-- divide operator --
/(other:Int64):Real64
Divides this number by another number.
-- divide operator --
/(other:UInt8):Real64
Divides this number by another number.
-- divide operator --
/(other:UInt16):Real64
Divides this number by another number.
-- divide operator --
/(other:UInt32):Real64
Divides this number by another number.
-- divide operator --
/(other:UInt64):Real64
Divides this number by another number.
-- divide operator --
/(other:Real32):Real64
Divides this number by another number.
-- divide operator --
/(other:Real64):Real64
Divides this number by another number.
-- equals operator --
=(other:Real32):Bit
Returns true if this number is equal to the given number.
-- equals operator --
=(other:Real64):Bit
Returns true if this number is equal to the given number.
-- not equal operator --
!=(other:Real32):Bit
Returns true if this number is not equal to the given number.
-- not equal operator --
!=(other:Real64):Bit
Returns true if this number is not equal to the given number.
-- less than operator --
<(other:Real32):Bit
Returns true if this number is less than the given number.
-- less than operator --
<(other:Real64):Bit
Returns true if this number is less than the given number.
-- greater than operator --
>(other:Real32):Bit
Returns true if this number is greater than the given number.
-- greater than operator --
>(other:Real64):Bit
Returns true if this number is greater than the given number.
-- greater than or equal operator --
>=(other:Real32):Bit
Returns true if this number is greater than or equal to the given number.
-- greater than or equal operator --
>=(other:Real64):Bit
Returns true if this number is greater than or equal to the given number.
-- less than or equal operator --
<=(other:Real32):Bit
Returns true if this number is less than or equal to the given number.
-- less than or equal operator --
<=(other:Real64):Bit
Returns true if this number is less than or equal to the given number.
min(other:Int8):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:Int16):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:Int32):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:Int64):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:Int):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt8):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt16):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt32):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt64):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt):Real64
Returns the smaller (closest to negative infinity) of this number and another number.
max(other:Int8):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:Int16):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:Int32):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:Int64):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:Int):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt8):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt16):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt32):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt64):Real64
Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt):Real64
Returns the larger (closest to positive infinity) of this number and another number.
format(fmt:String):String
Returns a formatted representation of this number.

Constants

@class
constant PI:Real64
@class
constant E:Real64

Fields

@package
def value:builtin_float64
property abs:Real64

The absolute value of this number.

property floor:Real64

This number rounded down (that is, in the direction of negative infinity) to the nearest integer.

property ceiling:Real64

This number rounded up (that is, in the direction of positive infinity) to the nearest integer.

property sqrt:Real64

The square root of this number.

property sin:Real64

The trigonometric sine of this number.

property cos:Real64

The trigonometric cosine of this number.

property tan:Real64

The trigonometric tangent of this number.

property asin:Real64

The trigonometric arcsine of this number.

property acos:Real64

The trigonometric arccosine of this number.

property atan:Real64

The trigonometric arctangent of this number.

property asInt:Int

This number converted to an Int. If this number cannot be exactly represented as an Int, a safety violation occurs.

property toInt:Int

This number converted to an Int.

property asInt8:Int8

This number converted to an 8 bit signed number. If this number cannot be exactly represented as an 8 bit signed number, a safety violation occurs.

property toInt8:Int8

This number converted to an 8 bit signed number.

property asInt16:Int16

This number converted to a 16 bit signed number. If this number cannot be exactly represented as a 16 bit signed number, a safety violation occurs.

property toInt16:Int16

This number converted to a 16 bit signed number.

property asInt32:Int32

This number converted to a 32 bit signed number. If this number cannot be exactly represented as a 32 bit signed number, a safety violation occurs.

property toInt32:Int32

This number converted to a 32 bit signed number.

property asInt64:Int64

This number converted to a 64 bit signed number. If this number cannot be exactly represented as a 64 bit signed number, a safety violation occurs.

property toInt64:Int64

This number converted to a 64 bit signed number.

property asUInt:UInt

This number converted to a UInt. If this number cannot be exactly represented as a UInt, a safety violation occurs.

property toUInt:UInt

This number converted to a UInt.

property asUInt8:UInt8

This number converted to an 8 bit unsigned number. If this number cannot be exactly represented as an 8 bit unsigned number, a safety violation occurs.

property toUInt8:UInt8

This number converted to an 8 bit unsigned number.

property asUInt16:UInt16

This number converted to a 16 bit unsigned number. If this number cannot be exactly represented as a 16 bit unsigned number, a safety violation occurs.

property toUInt16:UInt16

This number converted to a 16 bit unsigned number.

property asUInt32:UInt32

This number converted to a 32 bit unsigned number. If this number cannot be exactly represented as a 32 bit unsigned number, a safety violation occurs.

property toUInt32:UInt32

This number converted to a 32 bit unsigned number.

property asUInt64:UInt64

This number converted to a 64 bit unsigned number. If this number cannot be exactly represented as a 64 bit unsigned number, a safety violation occurs.

property toUInt64:UInt64

This number converted to a 64 bit unsigned number.

property asReal32:Real32

This number converted to a 32 bit floating point number.

property toReal32:Real32

This number converted to a 32 bit floating point number.

property asReal64:Real64

This number converted to a 64 bit floating point number.

property toReal64:Real64

This number converted to a 64 bit floating point number.

Class Methods

@class
function atan2 (y:Real64,
 x:Real64
):Real64

Returns the counterclockwise angle in radians between the X axis and the point (x, y).

Parameters:
y - value of type Real64
x - value of type Real64

Instance Methods

-- add operator --
function + (other:Real64
):Real64

Adds another number to this number.

Parameters:
other - value of type Real64
-- subtract operator --
function - (other:Real64
):Real64

Subtracts another number from this number.

Parameters:
other - value of type Real64
-- subtract operator --
function - ():Real64

Returns the negation (additive inverse) of this number

-- multiply operator --
function * (other:Real64
):Real64

Multiplies this number by another number.

Parameters:
other - value of type Real64
-- divide operator --
function / (other:Int8
):Real64

Divides this number by another number.

Parameters:
other - value of type Int8
-- divide operator --
function / (other:Int16
):Real64

Divides this number by another number.

Parameters:
other - value of type Int16
-- divide operator --
function / (other:Int32
):Real64

Divides this number by another number.

Parameters:
other - value of type Int32
-- divide operator --
function / (other:Int64
):Real64

Divides this number by another number.

Parameters:
other - value of type Int64
-- divide operator --
function / (other:UInt8
):Real64

Divides this number by another number.

Parameters:
other - value of type UInt8
-- divide operator --
function / (other:UInt16
):Real64

Divides this number by another number.

Parameters:
other - value of type UInt16
-- divide operator --
function / (other:UInt32
):Real64

Divides this number by another number.

Parameters:
other - value of type UInt32
-- divide operator --
function / (other:UInt64
):Real64

Divides this number by another number.

Parameters:
other - value of type UInt64
-- divide operator --
function / (other:Real32
):Real64

Divides this number by another number.

Parameters:
other - value of type Real32
-- divide operator --
function / (other:Real64
):Real64

Divides this number by another number.

Parameters:
other - value of type Real64
-- equals operator --
function = (other:Real32
):Bit

Returns true if this number is equal to the given number.

Parameters:
other - value of type Real32
-- equals operator --
@override
function = (other:Real64
):Bit

Returns true if this number is equal to the given number.

Parameters:
other - value of type Real64
Overrides:
frost.core.Equatable.=
-- not equal operator --
function != (other:Real32
):Bit

Returns true if this number is not equal to the given number.

Parameters:
other - value of type Real32
-- not equal operator --
@override
function != (other:Real64
):Bit

Returns true if this number is not equal to the given number.

Parameters:
other - value of type Real64
Overrides:
frost.core.Equatable.!=
-- less than operator --
function < (other:Real32
):Bit

Returns true if this number is less than the given number.

Parameters:
other - value of type Real32
-- less than operator --
@override
function < (other:Real64
):Bit

Returns true if this number is less than the given number.

Parameters:
other - value of type Real64
Overrides:
frost.core.Comparable.<
-- greater than operator --
function > (other:Real32
):Bit

Returns true if this number is greater than the given number.

Parameters:
other - value of type Real32
-- greater than operator --
@override
function > (other:Real64
):Bit

Returns true if this number is greater than the given number.

Parameters:
other - value of type Real64
Overrides:
frost.core.Comparable.>
-- greater than or equal operator --
function >= (other:Real32
):Bit

Returns true if this number is greater than or equal to the given number.

Parameters:
other - value of type Real32
-- greater than or equal operator --
@override
function >= (other:Real64
):Bit

Returns true if this number is greater than or equal to the given number.

Parameters:
other - value of type Real64
Overrides:
frost.core.Comparable.>=
-- less than or equal operator --
function <= (other:Real32
):Bit

Returns true if this number is less than or equal to the given number.

Parameters:
other - value of type Real32
-- less than or equal operator --
@override
function <= (other:Real64
):Bit

Returns true if this number is less than or equal to the given number.

Parameters:
other - value of type Real64
Overrides:
frost.core.Comparable.<=
function min (other:Int8
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type Int8
function min (other:Int16
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type Int16
function min (other:Int32
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type Int32
function min (other:Int64
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type Int64
function min (other:Int
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type Int
function min (other:UInt8
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type UInt8
function min (other:UInt16
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type UInt16
function min (other:UInt32
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type UInt32
function min (other:UInt64
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type UInt64
function min (other:UInt
):Real64

Returns the smaller (closest to negative infinity) of this number and another number.

Parameters:
other - value of type UInt
function max (other:Int8
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type Int8
function max (other:Int16
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type Int16
function max (other:Int32
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type Int32
function max (other:Int64
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type Int64
function max (other:Int
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type Int
function max (other:UInt8
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type UInt8
function max (other:UInt16
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type UInt16
function max (other:UInt32
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type UInt32
function max (other:UInt64
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type UInt64
function max (other:UInt
):Real64

Returns the larger (closest to positive infinity) of this number and another number.

Parameters:
other - value of type UInt
@override
function format (fmt:String
):String

Returns a formatted representation of this number. Supported format strings are "", "d", or "D" for decimal, "b" or "B" for binary, "o" or "O" for octal, "x" for lowercase hexadecimal, and "X" for uppercase hexadecimal.

Parameters:
fmt - value of type String
Overrides:
frost.core.Formattable.format