shadow:standard

Class int

Parent class

shadow:standard@Object

Interfaces

shadow:standard@Integer<int>, shadow:standard@Integer<long>, shadow:standard@Number<float>, shadow:standard@Number<double>, shadow:standard@CanNegate<int>, shadow:standard@CanHash

immutable locked class int

Class int contains the methods that can be called on int values.

Constant Summary

Modifiers Type Name and Description
public immutable constant int MAX

Largest value an int can have, 2147483647.

public immutable constant int MIN

Smallest value an int can have, -2147483648.

Create Summary

Modifiers Return Types Method and Description
public () create()

Destroy Summary

Modifiers Return Types Method and Description
public () destroy()

Method Summary

Modifiers Return Types Method and Description
public readonly locked (uint) abs()

Returns a non-negative version of the current value.

public readonly locked (double) add(double other)

Adds a double to the current value and returns the resulting value.

public readonly locked (float) add(float other)

Adds a float to the current value and returns the resulting value.

public readonly locked (int) add(int other)
public readonly locked (long) add(long other)

Adds a long to the current value and returns the resulting value.

public readonly locked (int, boolean) addWithOverflow(int other)
public readonly locked (int) bitAnd(int other)
public readonly locked (long) bitAnd(long other)

Computes the bitwise AND of the value and a long value.

public readonly locked (int) bitComplement()
public readonly locked (int) bitOr(int other)
public readonly locked (long) bitOr(long other)

Computes the bitwise OR of the value and a long value.

public readonly locked (int) bitRotateLeft(int amount)

Finds the result of left-rotating the bits of the int value by a signed amount which may be positive, negative, or zero.

public readonly locked (int) bitRotateLeft(uint amount)
public readonly locked (int) bitRotateRight(int amount)

Finds the result of right-rotating the bits of the int value by a signed amount which may be positive, negative, or zero.

public readonly locked (int) bitRotateRight(uint amount)
public readonly locked (int) bitShiftLeft(int amount)

Finds the result of left-shifting the bits of the int value by a signed amount which may be positive, negative, or zero.

public readonly locked (int) bitShiftLeft(uint amount)
public readonly locked (int) bitShiftRight(int amount)

Finds the result of right-shifting the bits of the int value by a signed amount which may be positive, negative, or zero.

public readonly locked (int) bitShiftRight(uint amount)
public readonly locked (int) bitXor(int other)
public readonly locked (long) bitXor(long other)

Computes the bitwise XOR of the value and a long value.

public readonly locked (int) compare(double other)

Compares the current value to a double, returning -1, 0, or 1, if the current value is smaller than, equal to, or larger than the other value, respectively.

public readonly locked (int) compare(float other)

Compares the current value to a float, returning -1, 0, or 1, if the current value is smaller than, equal to, or larger than the other value, respectively.

public readonly locked (int) compare(int other)
public readonly locked (int) compare(long other)

Compares the current value to a long, returning -1, 0, or 1, if the current value is smaller than, equal to, or larger than the other value, respectively.

public readonly (int) copy(AddressMap addresses)
public readonly locked (double) cos()

Finds the cosine of the current value.

public readonly locked (double) divide(double other)

Divides the current value by a double and returns the quotient.

public readonly locked (float) divide(float other)

Divides the current value by a float and returns the quotient.

public readonly locked (int) divide(int other)
public readonly locked (long) divide(long other)

Divides the current value by a long and returns the quotient.

public readonly locked (boolean) equal(double other)

Compares the current value to a double, returning true if they represent the same number.

public readonly locked (boolean) equal(float other)

Compares the current value to a float, returning true if they represent the same number.

public readonly locked (boolean) equal(int other)
public readonly locked (boolean) equal(long other)

Compares the current value to a long, returning true if they represent the same number.

public readonly locked (int) flipEndian()
public readonly locked (int) leadingZeroes()
public readonly locked (double) logBase10()

Finds the logarithm base 10 of the current value.

public readonly locked (double) logBase2()

Finds the logarithm base 2 of the current value.

public readonly locked (double) logBaseE()

Finds the natural logarithm of the current value.

public readonly locked (int) max(int other)

Finds the maximum of the current value and another int.

public readonly locked (int) min(int other)

Finds the minimum of the current value and another int.

public readonly locked (double) modulus(double other)

Divides the current value by a double and returns the remainder.

public readonly locked (float) modulus(float other)

Divides the current value by a float and returns the remainder.

public readonly locked (int) modulus(int other)
public readonly locked (long) modulus(long other)

Divides the current value by a long and returns the remainder.

public readonly locked (double) multiply(double other)

Multiplies the current value by a double and returns the resulting value.

public readonly locked (float) multiply(float other)

Multiplies the current value by a float and returns the resulting value.

public readonly locked (int) multiply(int other)
public readonly locked (long) multiply(long other)

Multiplies the current value by a long and returns the resulting value.

public readonly locked (int, boolean) multiplyWithOverflow(int other)
public readonly locked (int) negate()
public readonly locked (int) ones()
public readonly locked (double) power(double value)

Raises the current value to the power of a double.

public readonly locked (double) power(int value)

Raises the current value to the power of an int.

public readonly locked (double) sin()

Finds the sine of the current value.

public readonly locked (double) squareRoot()

Finds the square root of the value.

public readonly locked (double) subtract(double other)

Subtracts a double from the current value and returns the resulting value.

public readonly locked (float) subtract(float other)

Subtracts a float from the current value and returns the resulting value.

public readonly locked (int) subtract(int other)
public readonly locked (long) subtract(long other)

Subtracts a long from the current value and returns the resulting value.

public readonly locked (int, boolean) subtractWithOverflow(int other)
public readonly locked (double) tan()

Finds the tangent of the current value.

public readonly locked (byte) toByte()
public readonly locked (code) toCode()
public readonly locked (double) toDouble()
public readonly locked (float) toFloat()
public readonly locked (int) toInt()
public readonly locked (long) toLong()
public readonly locked (short) toShort()
public readonly locked (String) toString()

Returns a String representation of the value, in base 10.

public readonly locked (String) toString(uint base)

Returns a String representation of the value, in the specified base.

public readonly locked (ubyte) toUByte()
public readonly locked (uint) toUInt()
public readonly locked (ulong) toULong()
public readonly locked (ushort) toUShort()
public readonly locked (uint) toUnsigned()

Returns an unsigned version of the current value, underflowing if negative.

public readonly locked (int) trailingZeroes()

Property Summary

Modifiers Return Types Method and Description
public readonly get locked (ulong) hash()

Finds a hash value for the current value.

Constant Detail

MAX

public immutable constant int MAX

Largest value an int can have, 2147483647.

MIN

public immutable constant int MIN

Smallest value an int can have, -2147483648.

Create Detail

create

public create() => ()

Destroy Detail

destroy

public destroy() => ()

Method Detail

abs

public readonly locked abs() => (uint)

Returns a non-negative version of the current value.

Returns

non-negative value

add

public readonly locked add(double other) => (double)

Adds a double to the current value and returns the resulting value.

Parameters

other - value to add

Returns

sum of the two values

add

public readonly locked add(float other) => (float)

Adds a float to the current value and returns the resulting value.

Parameters

other - value to add

Returns

sum of the two values

add

public readonly locked add(int other) => (int)

add

public readonly locked add(long other) => (long)

Adds a long to the current value and returns the resulting value.

Parameters

other - value to add

Returns

sum of the two values

addWithOverflow

public readonly locked addWithOverflow(int other) => (int, boolean)

bitAnd

public readonly locked bitAnd(int other) => (int)

bitAnd

public readonly locked bitAnd(long other) => (long)

Computes the bitwise AND of the value and a long value.

Parameters

other - value to bitwise AND with

Returns

result of bitwise AND

bitComplement

public readonly locked bitComplement() => (int)

bitOr

public readonly locked bitOr(int other) => (int)

bitOr

public readonly locked bitOr(long other) => (long)

Computes the bitwise OR of the value and a long value.

Parameters

other - value to bitwise OR with

Returns

result of bitwise OR

bitRotateLeft

public readonly locked bitRotateLeft(int amount) => (int)

Finds the result of left-rotating the bits of the int value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to rotate

Returns

rotated value

bitRotateLeft

public readonly locked bitRotateLeft(uint amount) => (int)

bitRotateRight

public readonly locked bitRotateRight(int amount) => (int)

Finds the result of right-rotating the bits of the int value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to rotate

Returns

rotated value

bitRotateRight

public readonly locked bitRotateRight(uint amount) => (int)

bitShiftLeft

public readonly locked bitShiftLeft(int amount) => (int)

Finds the result of left-shifting the bits of the int value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to shift

Returns

shifted value

bitShiftLeft

public readonly locked bitShiftLeft(uint amount) => (int)

bitShiftRight

public readonly locked bitShiftRight(int amount) => (int)

Finds the result of right-shifting the bits of the int value by a signed amount which may be positive, negative, or zero.

Parameters

amount - bits to shift

Returns

shifted value

bitShiftRight

public readonly locked bitShiftRight(uint amount) => (int)

bitXor

public readonly locked bitXor(int other) => (int)

bitXor

public readonly locked bitXor(long other) => (long)

Computes the bitwise XOR of the value and a long value.

Parameters

other - value to bitwise XOR with

Returns

result of bitwise XOR

compare

public readonly locked compare(double other) => (int)

Compares the current value to a double, returning -1, 0, or 1, if the current value is smaller than, equal to, or larger than the other value, respectively.

Parameters

other - value to compare to

Returns

whether smaller, equal, or larger

compare

public readonly locked compare(float other) => (int)

Compares the current value to a float, returning -1, 0, or 1, if the current value is smaller than, equal to, or larger than the other value, respectively.

Parameters

other - value to compare to

Returns

whether smaller, equal, or larger

compare

public readonly locked compare(int other) => (int)

compare

public readonly locked compare(long other) => (int)

Compares the current value to a long, returning -1, 0, or 1, if the current value is smaller than, equal to, or larger than the other value, respectively.

Parameters

other - value to compare to

Returns

whether smaller, equal, or larger

copy

public readonly copy(AddressMap addresses) => (int)

cos

public readonly locked cos() => (double)

Finds the cosine of the current value.

Returns

cosine of the value

divide

public readonly locked divide(double other) => (double)

Divides the current value by a double and returns the quotient.

Parameters

other - value to divide by

Returns

quotient of the division

divide

public readonly locked divide(float other) => (float)

Divides the current value by a float and returns the quotient.

Parameters

other - value to divide by

Returns

quotient of the division

divide

public readonly locked divide(int other) => (int)

divide

public readonly locked divide(long other) => (long)

Divides the current value by a long and returns the quotient.

Parameters

other - value to divide by

Returns

quotient of the division

equal

public readonly locked equal(double other) => (boolean)

Compares the current value to a double, returning true if they represent the same number.

Parameters

other - value to compare to

Returns

true if identical

equal

public readonly locked equal(float other) => (boolean)

Compares the current value to a float, returning true if they represent the same number.

Parameters

other - value to compare to

Returns

true if identical

equal

public readonly locked equal(int other) => (boolean)

equal

public readonly locked equal(long other) => (boolean)

Compares the current value to a long, returning true if they represent the same number.

Parameters

other - value to compare to

Returns

true if identical

flipEndian

public readonly locked flipEndian() => (int)

leadingZeroes

public readonly locked leadingZeroes() => (int)

logBase10

public readonly locked logBase10() => (double)

Finds the logarithm base 10 of the current value.

Returns

logarithm base 10 of the value

logBase2

public readonly locked logBase2() => (double)

Finds the logarithm base 2 of the current value.

Returns

logarithm base 2 of the value

logBaseE

public readonly locked logBaseE() => (double)

Finds the natural logarithm of the current value.

Returns

natural logarithm of the value

max

public readonly locked max(int other) => (int)

Finds the maximum of the current value and another int.

Parameters

other - value

Returns

maximum value

min

public readonly locked min(int other) => (int)

Finds the minimum of the current value and another int.

Parameters

other - value

Returns

minimum value

modulus

public readonly locked modulus(double other) => (double)

Divides the current value by a double and returns the remainder.

Parameters

other - value to divide by

Returns

remainder of the division

modulus

public readonly locked modulus(float other) => (float)

Divides the current value by a float and returns the remainder.

Parameters

other - value to divide by

Returns

remainder of the division

modulus

public readonly locked modulus(int other) => (int)

modulus

public readonly locked modulus(long other) => (long)

Divides the current value by a long and returns the remainder.

Parameters

other - value to divide by

Returns

remainder of the division

multiply

public readonly locked multiply(double other) => (double)

Multiplies the current value by a double and returns the resulting value.

Parameters

other - value to multiply by

Returns

product of the two values

multiply

public readonly locked multiply(float other) => (float)

Multiplies the current value by a float and returns the resulting value.

Parameters

other - value to multiply by

Returns

product of the two values

multiply

public readonly locked multiply(int other) => (int)

multiply

public readonly locked multiply(long other) => (long)

Multiplies the current value by a long and returns the resulting value.

Parameters

other - value to multiply by

Returns

product of the two values

multiplyWithOverflow

public readonly locked multiplyWithOverflow(int other) => (int, boolean)

negate

public readonly locked negate() => (int)

ones

public readonly locked ones() => (int)

power

public readonly locked power(double value) => (double)

Raises the current value to the power of a double.

Parameters

exponent - power to raise by

Returns

number after exponentiation

power

public readonly locked power(int value) => (double)

Raises the current value to the power of an int.

Parameters

exponent - power to raise by

Returns

number after exponentiation

sin

public readonly locked sin() => (double)

Finds the sine of the current value.

Returns

sine of the value

squareRoot

public readonly locked squareRoot() => (double)

Finds the square root of the value.

Returns

square root

subtract

public readonly locked subtract(double other) => (double)

Subtracts a double from the current value and returns the resulting value.

Parameters

other - value to subtract

Returns

difference of the two values

subtract

public readonly locked subtract(float other) => (float)

Subtracts a float from the current value and returns the resulting value.

Parameters

other - value to subtract

Returns

difference of the two values

subtract

public readonly locked subtract(int other) => (int)

subtract

public readonly locked subtract(long other) => (long)

Subtracts a long from the current value and returns the resulting value.

Parameters

other - value to subtract

Returns

difference of the two values

subtractWithOverflow

public readonly locked subtractWithOverflow(int other) => (int, boolean)

tan

public readonly locked tan() => (double)

Finds the tangent of the current value.

Returns

tangent of the value

toByte

public readonly locked toByte() => (byte)

toCode

public readonly locked toCode() => (code)

toDouble

public readonly locked toDouble() => (double)

toFloat

public readonly locked toFloat() => (float)

toInt

public readonly locked toInt() => (int)

toLong

public readonly locked toLong() => (long)

toShort

public readonly locked toShort() => (short)

toString

public readonly locked toString() => (String)

Returns a String representation of the value, in base 10.

Returns

String representation

toString

public readonly locked toString(uint base) => (String)

Returns a String representation of the value, in the specified base.

Parameters

base - base of output representation

Returns

String representation

toUByte

public readonly locked toUByte() => (ubyte)

toUInt

public readonly locked toUInt() => (uint)

toULong

public readonly locked toULong() => (ulong)

toUShort

public readonly locked toUShort() => (ushort)

toUnsigned

public readonly locked toUnsigned() => (uint)

Returns an unsigned version of the current value, underflowing if negative.

Returns

unsigned value

trailingZeroes

public readonly locked trailingZeroes() => (int)

Property Detail

hash

public readonly get locked hash() => (ulong)

Finds a hash value for the current value.

Returns

hash value