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 UInt8

└ Value

└ Immutable

└ Object

Implemented Interfaces:

HashKey<UInt8>, Comparable<UInt8>, Formattable

An 8-bit unsigned integer.

Source Code:: View Source

Constant Summary

MIN:UInt8: The smallest value this type can hold (0).
MAX:UInt8: The largest value this type can hold (255).

Class Method Summary

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

Field Summary

value:builtin_uint8
bits:ListView<Bit>: A view of this number as a collection of bits, with bits[0] as the least significant bit.
sqrt:Real32: The square root of this number.
bitCount:UInt8: 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 reinterpreted as an 8 bit signed number.
toInt8:Int8: This number reinterpreted as an 8 bit signed number.
asInt16:Int16: This number zero extended to a 16 bit signed number.
toInt16:Int16: This number zero extended to a 16 bit signed number.
asInt32:Int32: This number zero extended to a 32 bit signed number.
toInt32:Int32: This number zero extended to a 32 bit signed number.
asInt64:Int64: This number zero extended to a 64 bit signed number.
toInt64:Int64: This number zero extended to a 64 bit signed number.
asUInt:UInt: This number converted to a UInt.
toUInt:UInt: This number converted to a UInt.
asUInt16:UInt16: This number zero extended to a 16 bit unsigned number.
toUInt16:UInt16: This number zero extended to a 16 bit unsigned number.
asUInt32:UInt32: This number zero extended to a 32 bit unsigned number.
toUInt32:UInt32: This number zero extended to a 32 bit unsigned number.
asUInt64:UInt64: This number zero extended to a 64 bit unsigned number.
toUInt64:UInt64: This number zero extended 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:

toString

Instance Method Summary

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

The smallest value this type can hold (0).

@class
constant MAX:UInt8

The largest value this type can hold (255).

Fields

@package
def value:builtin_uint8

property bits:ListView<Bit>

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

property sqrt:Real32

The square root of this number.

property bitCount:UInt8

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

property asInt:Int

This number converted to an Int.

property toInt:Int

This number converted to an Int.

property asInt8:Int8

This number reinterpreted as 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 reinterpreted as 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 zero extended to a 16 bit signed number.

property toInt16:Int16

This number zero extended to a 16 bit signed number.

property asInt32:Int32

This number zero extended to a 32 bit signed number.

property toInt32:Int32

This number zero extended to a 32 bit signed number.

property asInt64:Int64

This number zero extended to a 64 bit signed number.

property toInt64:Int64

This number zero extended to a 64 bit signed number.

property asUInt:UInt

This number converted to a UInt.

property toUInt:UInt

This number converted to a UInt.

property asUInt16:UInt16

This number zero extended to a 16 bit unsigned number.

property toUInt16:UInt16

This number zero extended to a 16 bit unsigned number.

property asUInt32:UInt32

This number zero extended to a 32 bit unsigned number.

property toUInt32:UInt32

This number zero extended to a 32 bit unsigned number.

property asUInt64:UInt64

This number zero extended to a 64 bit unsigned number.

property toUInt64:UInt64

This number zero extended 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

-- index operator --
@class

function []

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

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<UInt8>

-- index operator --
@class

function []

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

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<UInt8, UInt8>

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

function parse

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

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:Int8
):Int32

Adds another number to this number.

Parameters:: other - value of type Int8

-- add operator --

function +

(other:Int16
):Int32

Adds another number to this number.

Parameters:: other - value of type Int16

-- add operator --

function +

(other:Int32
):Int64

Adds another number to this number.

Parameters:: other - value of type Int32

-- add operator --

function +

(other:Int
):Int64

Adds another number to this number.

Parameters:: other - value of type Int

-- add operator --

function +

(other:UInt8
):UInt32

Adds another number to this number.

Parameters:: other - value of type UInt8

-- add operator --

function +

(other:UInt8
):UInt8

Adds another number to this number.

Parameters:: other - value of type UInt8

-- add operator --

function +

(other:UInt16
):UInt32

Adds another number to this number.

Parameters:: other - value of type UInt16

-- add operator --

function +

(other:UInt32
):UInt32

Adds another number to this number.

Parameters:: other - value of type UInt32

-- add operator --

function +

(other:UInt64
):UInt64

Adds another number to this number.

Parameters:: other - value of type UInt64

-- add operator --

function +

(other:UInt
):UInt

Adds another number to this number.

Parameters:: other - value of type UInt

-- unchecked add operator --

function +&

(other:Int8
):Int32

Adds another number to this number without checking for overflow.

Parameters:: other - value of type Int8

-- unchecked add operator --

function +&

(other:Int16
):Int32

Adds another number to this number without checking for overflow.

Parameters:: other - value of type Int16

-- unchecked add operator --

function +&

(other:Int32
):Int64

Adds another number to this number without checking for overflow.

Parameters:: other - value of type Int32

-- unchecked add operator --

function +&

(other:Int
):Int64

Adds another number to this number without checking for overflow.

Parameters:: other - value of type Int

-- unchecked add operator --

function +&

(other:UInt8
):UInt32

Adds another number to this number without checking for overflow.

Parameters:: other - value of type UInt8

-- unchecked add operator --

function +&

(other:UInt8
):UInt8

Adds another number to this number without checking for overflow.

Parameters:: other - value of type UInt8

-- unchecked add operator --

function +&

(other:UInt16
):UInt32

Adds another number to this number without checking for overflow.

Parameters:: other - value of type UInt16

-- unchecked add operator --

function +&

(other:UInt32
):UInt32

Adds another number to this number without checking for overflow.

Parameters:: other - value of type UInt32

-- unchecked add operator --

function +&

(other:UInt64
):UInt64

Adds another number to this number without checking for overflow.

Parameters:: other - value of type UInt64

-- unchecked add operator --

function +&

(other:UInt
):UInt

Adds another number to this number without checking for overflow.

Parameters:: other - value of type UInt

-- subtract operator --

function -

(other:Int8
):Int32

Subtracts another number from this number.

Parameters:: other - value of type Int8

-- subtract operator --

function -

(other:Int16
):Int32

Subtracts another number from this number.

Parameters:: other - value of type Int16

-- subtract operator --

function -

(other:Int32
):Int64

Subtracts another number from this number.

Parameters:: other - value of type Int32

-- subtract operator --

function -

(other:Int
):Int64

Subtracts another number from this number.

Parameters:: other - value of type Int

-- subtract operator --

function -

(other:UInt8
):UInt32

Subtracts another number from this number.

Parameters:: other - value of type UInt8

-- subtract operator --

function -

(other:UInt8
):UInt8

Subtracts another number from this number.

Parameters:: other - value of type UInt8

-- subtract operator --

function -

(other:UInt16
):UInt32

Subtracts another number from this number.

Parameters:: other - value of type UInt16

-- subtract operator --

function -

(other:UInt32
):UInt32

Subtracts another number from this number.

Parameters:: other - value of type UInt32

-- subtract operator --

function -

(other:UInt64
):UInt64

Subtracts another number from this number.

Parameters:: other - value of type UInt64

-- subtract operator --

function -

(other:UInt
):UInt

Subtracts another number from this number.

Parameters:: other - value of type UInt

-- unchecked subtract operator --

function -&

(other:Int8
):Int32

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type Int8

-- unchecked subtract operator --

function -&

(other:Int16
):Int32

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type Int16

-- unchecked subtract operator --

function -&

(other:Int32
):Int64

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type Int32

-- unchecked subtract operator --

function -&

(other:Int
):Int64

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type Int

-- unchecked subtract operator --

function -&

(other:UInt8
):UInt32

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type UInt8

-- unchecked subtract operator --

function -&

(other:UInt8
):UInt8

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type UInt8

-- unchecked subtract operator --

function -&

(other:UInt16
):UInt32

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type UInt16

-- unchecked subtract operator --

function -&

(other:UInt32
):UInt32

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type UInt32

-- unchecked subtract operator --

function -&

(other:UInt64
):UInt64

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type UInt64

-- unchecked subtract operator --

function -&

(other:UInt
):UInt

Subtracts another number from this number without checking for overflow.

Parameters:: other - value of type UInt

-- subtract operator --

function -

():UInt8

Returns the negation (additive inverse) of this number

-- multiply operator --

function *

(other:Int8
):Int32

Multiplies this number by another number.

Parameters:: other - value of type Int8

-- multiply operator --

function *

(other:Int16
):Int32

Multiplies this number by another number.

Parameters:: other - value of type Int16

-- multiply operator --

function *

(other:Int32
):Int64

Multiplies this number by another number.

Parameters:: other - value of type Int32

-- multiply operator --

function *

(other:Int
):Int64

Multiplies this number by another number.

Parameters:: other - value of type Int

-- multiply operator --

function *

(other:UInt8
):UInt32

Multiplies this number by another number.

Parameters:: other - value of type UInt8

-- multiply operator --

function *

(other:UInt8
):UInt8

Multiplies this number by another number.

Parameters:: other - value of type UInt8

-- multiply operator --

function *

(other:UInt16
):UInt32

Multiplies this number by another number.

Parameters:: other - value of type UInt16

-- multiply operator --

function *

(other:UInt32
):UInt32

Multiplies this number by another number.

Parameters:: other - value of type UInt32

-- multiply operator --

function *

(other:UInt64
):UInt64

Multiplies this number by another number.

Parameters:: other - value of type UInt64

-- multiply operator --

function *

(other:UInt
):UInt

Multiplies this number by another number.

Parameters:: other - value of type UInt

-- unchecked multiply operator --

function *&

(other:Int8
):Int32

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type Int8

-- unchecked multiply operator --

function *&

(other:Int16
):Int32

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type Int16

-- unchecked multiply operator --

function *&

(other:Int32
):Int64

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type Int32

-- unchecked multiply operator --

function *&

(other:Int
):Int64

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type Int

-- unchecked multiply operator --

function *&

(other:UInt8
):UInt32

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type UInt8

-- unchecked multiply operator --

function *&

(other:UInt8
):UInt8

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type UInt8

-- unchecked multiply operator --

function *&

(other:UInt16
):UInt32

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type UInt16

-- unchecked multiply operator --

function *&

(other:UInt32
):UInt32

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type UInt32

-- unchecked multiply operator --

function *&

(other:UInt64
):UInt64

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type UInt64

-- unchecked multiply operator --

function *&

(other:UInt
):UInt

Multiplies this number by another number without checking for overflow.

Parameters:: other - value of type UInt

-- integer divide operator --

function //

(other:Int8
):Int32

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

Parameters:: other - value of type Int8

-- integer divide operator --

function //

(other:Int16
):Int32

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

Parameters:: other - value of type Int16

-- integer divide operator --

function //

(other:Int32
):Int64

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

Parameters:: other - value of type Int32

-- integer divide operator --

function //

(other:Int
):Int64

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

Parameters:: other - value of type Int

-- integer divide operator --

function //

(other:UInt8
):UInt32

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

Parameters:: other - value of type UInt8

-- integer divide operator --

function //

(other:UInt8
):UInt8

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

Parameters:: other - value of type UInt8

-- integer divide operator --

function //

(other:UInt16
):UInt32

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

Parameters:: other - value of type UInt16

-- integer divide operator --

function //

(other:UInt32
):UInt32

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

Parameters:: other - value of type UInt32

-- integer divide operator --

function //

(other:UInt64
):UInt64

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

Parameters:: other - value of type UInt64

-- integer divide operator --

function //

(other:UInt
):UInt

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

Parameters:: other - value of type UInt

-- unchecked integer divide operator --

function //&

(other:Int8
):Int32

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

Parameters:: other - value of type Int8

-- unchecked integer divide operator --

function //&

(other:Int16
):Int32

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

Parameters:: other - value of type Int16

-- unchecked integer divide operator --

function //&

(other:Int32
):Int64

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

Parameters:: other - value of type Int32

-- unchecked integer divide operator --

function //&

(other:Int
):Int64

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

Parameters:: other - value of type Int

-- unchecked integer divide operator --

function //&

(other:UInt8
):UInt32

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

Parameters:: other - value of type UInt8

-- unchecked integer divide operator --

function //&

(other:UInt8
):UInt8

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

Parameters:: other - value of type UInt8

-- unchecked integer divide operator --

function //&

(other:UInt16
):UInt32

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

Parameters:: other - value of type UInt16

-- unchecked integer divide operator --

function //&

(other:UInt32
):UInt32

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

Parameters:: other - value of type UInt32

-- 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

-- unchecked integer divide operator --

function //&

(other:UInt
):UInt

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

Parameters:: other - value of type UInt

-- remainder operator --

function %

(other:Int8
):Int32

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type Int8

-- remainder operator --

function %

(other:Int16
):Int32

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type Int16

-- remainder operator --

function %

(other:Int32
):Int64

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type Int32

-- remainder operator --

function %

(other:Int
):Int64

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type Int

-- remainder operator --

function %

(other:UInt8
):UInt32

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type UInt8

-- remainder operator --

function %

(other:UInt8
):UInt8

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type UInt8

-- remainder operator --

function %

(other:UInt16
):UInt32

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type UInt16

-- remainder operator --

function %

(other:UInt32
):UInt32

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type UInt32

-- remainder operator --

function %

(other:UInt64
):UInt64

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type UInt64

-- remainder operator --

function %

(other:UInt
):UInt

Returns the remainder of dividing this number by another number.

Parameters:: other - value of type UInt

-- divide operator --

function /

(other:Int8
):Real32

Divides this number by another number.

Parameters:: other - value of type Int8

-- divide operator --

function /

(other:Int16
):Real32

Divides this number by another number.

Parameters:: other - value of type Int16

-- divide operator --

function /

(other:Int32
):Real32

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
):Real32

Divides this number by another number.

Parameters:: other - value of type UInt8

-- divide operator --

function /

(other:UInt16
):Real32

Divides this number by another number.

Parameters:: other - value of type UInt16

-- divide operator --

function /

(other:UInt32
):Real32

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
):Real32

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

-- bitwise not operator --

function !!

():UInt8

Returns the bitwise NOT of this number.

-- bitwise and operator --

function &&

(other:Int8
):Int32

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type Int8

-- bitwise and operator --

function &&

(other:Int16
):Int32

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type Int16

-- bitwise and operator --

function &&

(other:Int32
):Int32

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type Int32

-- bitwise and operator --

function &&

(other:Int64
):Int64

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type Int64

-- bitwise and operator --

function &&

(other:Int
):Int

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type Int

-- bitwise and operator --

function &&

(other:UInt8
):UInt32

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type UInt8

-- bitwise and operator --

function &&

(other:UInt8
):UInt8

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type UInt8

-- bitwise and operator --

function &&

(other:UInt16
):UInt32

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type UInt16

-- bitwise and operator --

function &&

(other:UInt32
):UInt32

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type UInt32

-- bitwise and operator --

function &&

(other:UInt64
):UInt64

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type UInt64

-- bitwise and operator --

function &&

(other:UInt
):UInt

Returns the bitwise AND of this number with another number.

Parameters:: other - value of type UInt

-- bitwise or operator --

function ||

(other:Int8
):Int32

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type Int8

-- bitwise or operator --

function ||

(other:Int16
):Int32

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type Int16

-- bitwise or operator --

function ||

(other:Int32
):Int32

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type Int32

-- bitwise or operator --

function ||

(other:Int64
):Int64

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type Int64

-- bitwise or operator --

function ||

(other:Int
):Int

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type Int

-- bitwise or operator --

function ||

(other:UInt8
):UInt32

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type UInt8

-- bitwise or operator --

function ||

(other:UInt8
):UInt8

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type UInt8

-- bitwise or operator --

function ||

(other:UInt16
):UInt32

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type UInt16

-- bitwise or operator --

function ||

(other:UInt32
):UInt32

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type UInt32

-- bitwise or operator --

function ||

(other:UInt64
):UInt64

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type UInt64

-- bitwise or operator --

function ||

(other:UInt
):UInt

Returns the bitwise OR of this number with another number.

Parameters:: other - value of type UInt

-- bitwise exclusive or operator --

function ~~

(other:Int8
):Int32