kitecore/io.github.yuroyami.kitecore.math

Package-level declarations

Properties

val Int.GB: Long

This value in gigabytes (multiples of 1000^3) expressed as bytes.

GiB

val Int.GiB: Long

This value in gibibytes (multiples of 1024^3) expressed as bytes.

val Int.KB: Long

This value in kilobytes (multiples of 1000) expressed as bytes.

KiB

val Int.KiB: Long

This value in kibibytes (multiples of 1024) expressed as bytes.

val Int.MB: Long

This value in megabytes (multiples of 1000^2) expressed as bytes.

MiB

val Int.MiB: Long

This value in mebibytes (multiples of 1024^2) expressed as bytes.

Functions

ceilTo

fun Double.ceilTo(decimals: Int): Double

Returns this value rounded up (toward positive infinity) at decimals fractional digits.

clamp01

fun Double.clamp01(): Double

Clamps this value into 0.0..1.0. NaN stays NaN.

fun Float.clamp01(): Float

Clamps this value into 0f..1f. NaN stays NaN.

digitCount

fun Int.digitCount(): Int

fun Long.digitCount(): Int

Returns the number of decimal digits in the absolute value of this number.

digits

fun Int.digits(): List<Int>

Returns the decimal digits of the absolute value of this number, most significant first.

factorial

fun factorial(n: Int): Long

Returns the factorial of n.

floorTo

fun Double.floorTo(decimals: Int): Double

Returns this value rounded down (toward negative infinity) at decimals fractional digits.

formatBytes

fun Long.formatBytes(decimals: Int = 1, si: Boolean = false): String

Formats this byte count as a human-readable size string such as "1.5 KiB".

formatDecimals

fun Double.formatDecimals(decimals: Int): String

fun Float.formatDecimals(decimals: Int): String

Formats this value with exactly decimals fractional digits, locale-independent.

formatGrouped

fun Int.formatGrouped(separator: Char = ','): String

fun Long.formatGrouped(separator: Char = ','): String

Formats this value in decimal with separator between each group of three digits.

formatPercent

fun Double.formatPercent(decimals: Int = 0): String

Formats this fraction as a percentage string, so 0.42.formatPercent() is "42%".

gcd

fun gcd(a: Int, b: Int): Int

fun gcd(a: Long, b: Long): Long

Returns the greatest common divisor of a and b.

hasFlag

fun Int.hasFlag(flag: Int): Boolean

Returns true when every bit of flag is set in this mask.

inverseLerp

fun inverseLerp(start: Double, stop: Double, value: Double): Double

Returns the fraction at which value lies between start and stop.

isApproximately

fun Double.isApproximately(other: Double, epsilon: Double = 1.0E-9): Boolean

fun Float.isApproximately(other: Float, epsilon: Float = 1.0E-6f): Boolean

Returns true when this value is within epsilon of other.

isEven

fun Int.isEven(): Boolean

fun Long.isEven(): Boolean

Returns true when this value is evenly divisible by two.

isOdd

fun Int.isOdd(): Boolean

fun Long.isOdd(): Boolean

Returns true when this value is not evenly divisible by two.

isPowerOfTwo

fun Int.isPowerOfTwo(): Boolean

fun Long.isPowerOfTwo(): Boolean

Returns true when this value is a positive power of two.

isPrime

fun isPrime(n: Long): Boolean

Returns true when n is a prime number.

lcm

fun lcm(a: Int, b: Int): Long

Returns the least common multiple of a and b as a Long.

fun lcm(a: Long, b: Long): Long

Returns the least common multiple of a and b.

lerp

fun lerp(start: Double, stop: Double, fraction: Double): Double

fun lerp(start: Float, stop: Float, fraction: Float): Float

Linearly interpolates between start and stop by fraction.

midpoint

fun Int.midpoint(other: Int): Int

fun Long.midpoint(other: Long): Long

Returns the midpoint of this value and other without intermediate overflow.

nextPowerOfTwo

fun Int.nextPowerOfTwo(): Int

Returns the smallest power of two that is greater than or equal to this value.

ordinalSuffix

fun Int.ordinalSuffix(): String

Returns the English ordinal suffix for this number: "st", "nd", "rd", or "th".

percentOf

fun Int.percentOf(total: Int): Double

Returns the percentage that this value represents of total.

pow

fun Int.pow(exponent: Int): Long

Raises this value to the given non-negative exponent and returns the result as a Long.

remap

fun Double.remap(fromStart: Double, fromEnd: Double, toStart: Double, toEnd: Double): Double

Remaps this value from the range fromStart..fromEnd to the range toStart..toEnd.

roundTo

fun Double.roundTo(decimals: Int): Double

fun Float.roundTo(decimals: Int): Float

Returns this value rounded to decimals fractional digits.

roundToNearest

fun Double.roundToNearest(step: Double): Double

fun Int.roundToNearest(step: Int): Int

Returns the multiple of step closest to this value.

toDegrees

fun Double.toDegrees(): Double

Converts this angle in radians to degrees.

toggleFlag

fun Int.toggleFlag(flag: Int): Int

Returns this mask with every bit of flag inverted.

toRadians

fun Double.toRadians(): Double

Converts this angle in degrees to radians.

withFlag

fun Int.withFlag(flag: Int): Int

Returns this mask with every bit of flag set.

withOrdinalSuffix

fun Int.withOrdinalSuffix(): String

Returns this number followed by its English ordinal suffix, such as "21st".

withoutFlag

fun Int.withoutFlag(flag: Int): Int

Returns this mask with every bit of flag cleared.