Home
Getting Started
Current Status
Documentation
- frostc
- Syntax
  - Keywords
  - Statements
    - Assignment
    - Method Calls
    - if
    - for
    - while
    - do
    - loop
    - break
    - continue
    - return
    - assert
    - unreachable
    - match
    - try
  - Expressions
  - Annotations
  - Comments
  - Documentation Comments
  - Error Handling
- Classes
  - Interfaces
  - Choices
  - Values
  - Immutability
  - Packages
    - Uses
  - Generics
  - Bare Code
- Methods
- Fields
- Types
- Variables and Constants
- Memory
  - Weak References
- Threads
API Documentation
- frostcollections Array Collection CollectionView CollectionWriter DefaultHashMap HashKey HashMap HashSet IdentityMap IdentitySet ImmutableArray Iterable Iterator List ListView ListWriter Map MapView MapWriter Stack core Bit Char16 Char32 Char8 Comparable Equatable Error Formattable Immutable Int Int16 Int32 Int64 Int8 Matcher Maybe MutableString Index MutableValue Object Range Real32 Real64 RegularExpression SteppedRange String Index Match System Process UInt UInt16 UInt32 UInt64 UInt8 Value Weak io ByteOrder Console File IndentedOutputStream InputStream LineNumberInputStream MemoryInputStream MemoryOutputStream OutputStream PushbackInputStream math Random XorShift128Plus threads Lock MessageQueue Notifier ScopedLock Thread time Timer unsafe Pointer UnsafeMessageQueue

frost.core

Class UInt64

└ Value

└ Immutable

└ Object

Implemented Interfaces:

HashKey<UInt64>, Comparable<UInt64>, Formattable

A 64-bit unsigned integer.

Source Code:: View Source

Constant Summary

MIN:UInt64: The smallest value this type can hold (0).
MAX:UInt64: The largest value this type can hold (18,446,744,073,709,551,615).

Class Method Summary

-- index operator -- [](range:Range<UInt64>):ListView<UInt64>: Returns a list of all integers in the given range.
-- index operator -- [](range:SteppedRange<UInt64, UInt64>):ListView<UInt64>: Returns a list of all integers in the given stepped range.
parse(str:String, radix:Int):UInt64?: Parses a string as a number in the specified radix.

Field Summary

value:builtin_uint64
bits:ListView<Bit>: A view of this number as a collection of bits, with bits[0] as the least significant bit.
sqrt:Real64: The square root of this number.
bitCount:UInt64: The number of 1 bits in this number's binary representation.
asInt:Int: This number converted to an Int.
toInt:Int: This number converted to an Int.
asInt8:Int8: This number truncated to an 8 bit signed number.
toInt8:Int8: This number truncated to an 8 bit signed number.
asInt16:Int16: This number truncated to a 16 bit signed number.
toInt16:Int16: This number truncated to a 16 bit signed number.
asInt32:Int32: This number truncated to a 32 bit signed number.
toInt32:Int32: This number truncated to a 32 bit signed number.
asInt64:Int64: This number reinterpreted as a 64 bit signed number.
toInt64:Int64: This number reinterpreted as 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 truncated to an 8 bit unsigned number.
toUInt8:UInt8: This number truncated to an 8 bit unsigned number.
asUInt16:UInt16: This number truncated to a 16 bit unsigned number.
toUInt16:UInt16: This number truncated to a 16 bit unsigned number.
asUInt32:UInt32: This number truncated to a 32 bit unsigned number.
toUInt32:UInt32: This number truncated to a 32 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:

toString

Instance Method Summary

-- add operator -- +(other:UInt64):UInt64: Adds another number to this number.
-- unchecked add operator -- +&(other:UInt64):UInt64: Adds another number to this number without checking for overflow.
-- subtract operator -- -(other:UInt64):UInt64: Subtracts another number from this number.
-- unchecked subtract operator -- -&(other:UInt64):UInt64: Subtracts another number from this number without checking for overflow.
-- subtract operator -- -():UInt64: Returns the negation (additive inverse) of this number
-- multiply operator -- *(other:UInt64):UInt64: Multiplies this number by another number.
-- unchecked multiply operator -- *&(other:UInt64):UInt64: Multiplies this number by another number without checking for overflow.
-- integer divide operator -- //(other:UInt64):UInt64: Divides this number by another number, returning the whole number portion.
-- unchecked integer divide operator -- //&(other:UInt64):UInt64: Divides this number by another number, returning the whole number portion, without checking for overflow.
-- remainder operator -- %(other:UInt64):UInt64: Returns the remainder of dividing 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.
-- bitwise not operator -- !!():UInt64: Returns the bitwise NOT of this number.
-- bitwise and operator -- &&(other:Int64):Int64: Returns the bitwise AND of this number with another number.
-- bitwise and operator -- &&(other:UInt64):UInt64: Returns the bitwise AND of this number with another number.
-- bitwise or operator -- ||(other:Int64):Int64: Returns the bitwise OR of this number with another number.
-- bitwise or operator -- ||(other:UInt64):UInt64: Returns the bitwise OR of this number with another number.
-- bitwise exclusive or operator -- ~~(other:Int64):Int64: Returns the bitwise XOR of this number with another number.
-- bitwise exclusive or operator -- ~~(other:UInt64):UInt64: Returns the bitwise XOR of this number with another number.
-- left shift operator -- <<(other:UInt64):UInt64: Returns this number shifted left by the specified number of bits.
-- unchecked left shift operator -- <<&(other:UInt64):UInt64: Returns this number shifted left by the specified number of bits, without checking for overflow.
-- right shift operator -- >>(other:UInt64):UInt64: Returns this number logical shifted right by the specified number of bits.
-- equals operator -- =(other:UInt8):Bit: Returns true if this number is equal to the given number.
-- equals operator -- =(other:UInt16):Bit: Returns true if this number is equal to the given number.
-- equals operator -- =(other:UInt32):Bit: Returns true if this number is equal to the given number.
-- equals operator -- =(other:UInt64):Bit: Returns true if this number is equal to the given number.
-- equals operator -- =(other:UInt):Bit: Returns true if this number is equal to the given number.
-- not equal operator -- !=(other:UInt8):Bit: Returns true if this number is not equal to the given number.
-- not equal operator -- !=(other:UInt16):Bit: Returns true if this number is not equal to the given number.
-- not equal operator -- !=(other:UInt32):Bit: Returns true if this number is not equal to the given number.
-- not equal operator -- !=(other:UInt64):Bit: Returns true if this number is not equal to the given number.
-- not equal operator -- !=(other:UInt):Bit: Returns true if this number is not equal to the given number.
-- less than operator -- <(other:UInt8):Bit: Returns true if this number is less than the given number.
-- less than operator -- <(other:UInt16):Bit: Returns true if this number is less than the given number.
-- less than operator -- <(other:UInt32):Bit: Returns true if this number is less than the given number.
-- less than operator -- <(other:UInt64):Bit: Returns true if this number is less than the given number.
-- less than operator -- <(other:UInt):Bit: Returns true if this number is less than the given number.
-- greater than operator -- >(other:UInt8):Bit: Returns true if this number is greater than the given number.
-- greater than operator -- >(other:UInt16):Bit: Returns true if this number is greater than the given number.
-- greater than operator -- >(other:UInt32):Bit: Returns true if this number is greater than the given number.
-- greater than operator -- >(other:UInt64):Bit: Returns true if this number is greater than the given number.
-- greater than operator -- >(other:UInt):Bit: Returns true if this number is greater than the given number.
-- greater than or equal operator -- >=(other:UInt8):Bit: Returns true if this number is greater than or equal to the given number.
-- greater than or equal operator -- >=(other:UInt16):Bit: Returns true if this number is greater than or equal to the given number.
-- greater than or equal operator -- >=(other:UInt32):Bit: Returns true if this number is greater than or equal to the given number.
-- greater than or equal operator -- >=(other:UInt64):Bit: Returns true if this number is greater than or equal to the given number.
-- greater than or equal operator -- >=(other:UInt):Bit: Returns true if this number is greater than or equal to the given number.
-- less than or equal operator -- <=(other:UInt8):Bit: Returns true if this number is less than or equal to the given number.
-- less than or equal operator -- <=(other:UInt16):Bit: Returns true if this number is less than or equal to the given number.
-- less than or equal operator -- <=(other:UInt32):Bit: Returns true if this number is less than or equal to the given number.
-- less than or equal operator -- <=(other:UInt64):Bit: Returns true if this number is less than or equal to the given number.
-- less than or equal operator -- <=(other:UInt):Bit: Returns true if this number is less than or equal to the given number.
min(other:UInt8):UInt64: Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt16):UInt64: Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt32):UInt64: Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt64):UInt64: Returns the smaller (closest to negative infinity) of this number and another number.
min(other:UInt):UInt64: Returns the smaller (closest to negative infinity) of this number and another number.
max(other:UInt8):UInt64: Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt16):UInt64: Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt32):UInt64: Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt64):UInt64: Returns the larger (closest to positive infinity) of this number and another number.
max(other:UInt):UInt64: 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 MIN:UInt64

The smallest value this type can hold (0).

@class
constant MAX:UInt64

The largest value this type can hold (18,446,744,073,709,551,615).

Fields

@package
def value:builtin_uint64

property bits:ListView<Bit>

A view of this number as a collection of bits, with bits[0] as the least significant bit.

property sqrt:Real64

The square root of this number.

property bitCount:UInt64

The number of 1 bits in this number's binary representation.

property asInt:Int

This number converted to an Int. If this number is not in the range of an Int, a safety violation occurs.

property toInt:Int

This number converted to an Int. This function never fails, even if the number is not in the range of an Int.

property asInt8:Int8

This number truncated to an 8 bit signed number. If this number is not in the range of an 8 bit signed number, a safety violation occurs.

property toInt8:Int8

This number truncated to an 8 bit signed number. This function never fails, even if the number is not in the range of an 8 bit signed number.

property asInt16:Int16

This number truncated to a 16 bit signed number. If this number is not in the range of a 16 bit signed number, a safety violation occurs.

property toInt16:Int16

This number truncated to a 16 bit signed number. This function never fails, even if the number is not in the range of a 16 bit signed number.

property asInt32:Int32

This number truncated to a 32 bit signed number. If this number is not in the range of a 32 bit signed number, a safety violation occurs.

property toInt32:Int32

This number truncated to a 32 bit signed number. This function never fails, even if the number is not in the range of a 32 bit signed number.

property asInt64:Int64

This number reinterpreted as a 64 bit signed number. If this number is not in the range of a 64 bit signed number, a safety violation occurs.

property toInt64:Int64

This number reinterpreted as a 64 bit signed number. This function never fails, even if the number is not in the range of a 64 bit signed number.

property asUInt:UInt

This number converted to a UInt. If this number is not in the range of a UInt, a safety violation occurs.

property toUInt:UInt

This number converted to a UInt. This function never fails, even if the number is not in the range of a UInt.

property asUInt8:UInt8

This number truncated to an 8 bit unsigned number. If this number is not in the range of an 8 bit unsigned number, a safety violation occurs.

property toUInt8:UInt8

This number truncated to an 8 bit unsigned number. This function never fails, even if the number is not in the range of an 8 bit unsigned number.

property asUInt16:UInt16

This number truncated to a 16 bit unsigned number. If this number is not in the range of a 16 bit unsigned number, a safety violation occurs.

property toUInt16:UInt16

This number truncated to a 16 bit unsigned number. This function never fails, even if the number is not in the range of a 16 bit unsigned number.

property asUInt32:UInt32

This number truncated to a 32 bit unsigned number. If this number is not in the range of a 32 bit unsigned number, a safety violation occurs.

property toUInt32:UInt32

This number truncated to a 32 bit unsigned number. This function never fails, even if the number is not in the range of a 32 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

-- index operator --
@class
@pre(range.max - range.min < Int64.MAX.asUInt64)

function []

(range:Range<UInt64>
):ListView<UInt64>

Returns a list of all integers in the given range. The list is 'lazy', meaning that it does not actually allocate memory to hold the entire list.

Parameters:: range - value of type Range<UInt64>

-- index operator --
@class
@pre(org.frostlang.frost.UInt64List.computeCount(range) > 0)

function []

(range:SteppedRange<UInt64, UInt64>
):ListView<UInt64>

Returns a list of all integers in the given stepped range. The list is 'lazy', meaning that it does not actually allocate memory to hold the entire list.

Parameters:: range - value of type SteppedRange<UInt64, UInt64>

@class
@pre(radix >= 2 & radix <= 36)

function parse

(str:String,
 radix:Int
):UInt64?

Parses a string as a number in the specified radix. Returns null if the parse fails.

Parameters:: str - value of type String
radix - value of type Int

Instance Methods

-- add operator --

function +

(other:UInt64
):UInt64

Adds another number to this number.

Parameters:: other - value of type UInt64

-- unchecked add operator --

function +&

(other:UInt64
):UInt64

Adds another number to this number without checking for overflow.

Parameters:: other - value of type UInt64

-- subtract operator --

function -

(other:UInt64
):UInt64

Subtracts another number from this number.

Parameters:: other - value of type UInt64

-- unchecked subtract operator --

function -&

(other:UInt64
):UInt64

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type UInt64

-- subtract operator --

function -

():UInt64

Returns the negation (additive inverse) of this number

-- multiply operator --

function *

(other:UInt64
):UInt64

Multiplies this number by another number.

Parameters:: other - value of type UInt64

-- unchecked multiply operator --

function *&

(other:UInt64
):UInt64

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type UInt64

-- integer divide operator --

function //

(other:UInt64
):UInt64

Divides this number by another number, returning the whole number portion.

Parameters:: other - value of type UInt64

-- unchecked integer divide operator --

function //&

(other:UInt64
):UInt64

Divides this number by another number, returning the whole number portion, without checking for overflow.

Parameters:: other - value of type UInt64

-- remainder operator --

function %

(other:UInt64
):UInt64

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type UInt64

-- divide operator --

function /

(other:Int8
):Real64