low-alloc-math/com.sztorm.lowallocmath

Package-level declarations

Types

Link copied to clipboard
@JvmInline
value class AngleF(val radians: Float) : Comparable<AngleF>

Represents an angle stored in single-precision 32-bit IEEE 754 floating point number.

Link copied to clipboard
@JvmInline
value class Color32

Represents a 32-bit representation of RGBA color.

Link copied to clipboard
@JvmInline
value class ComplexF

Represents a complex number composed of two single-precision 32-bit IEEE 754 floating point numbers for real and imaginary parts.

Link copied to clipboard
@JvmInline
value class Flags16(val shortValue: Short) : Collection<Boolean>

Represents a collection of sixteen bit flags.

Link copied to clipboard
@JvmInline
value class Flags32(val intValue: Int) : Collection<Boolean>

Represents a collection of thirty-two bit flags.

Link copied to clipboard
@JvmInline
value class Flags64(val longValue: Long) : Collection<Boolean>

Represents a collection of sixty-four bit flags.

Link copied to clipboard
@JvmInline
value class Flags8(val byteValue: Byte) : Collection<Boolean>

Represents a collection of eight bit flags.

Link copied to clipboard
@JvmInline
value class Vector2F

Represents a vector of two single-precision 32-bit IEEE 754 floating point numbers.

Link copied to clipboard
@JvmInline
value class Vector2FArray : Collection<Vector2F>

An array of Vector2F values.

Link copied to clipboard
abstract class Vector2FIterator : Iterator<Vector2F>

An iterator over a sequence of values of type Vector2F

Link copied to clipboard
@JvmInline
value class Vector2I

Represents a vector of two 32-bit signed integers.

Link copied to clipboard
@JvmInline
value class Vector2IArray : Collection<Vector2I>

An array of Vector2I values.

Link copied to clipboard
abstract class Vector2IIterator : Iterator<Vector2I>

An iterator over a sequence of values of type Vector2I

Functions

Link copied to clipboard
operator fun Float.div(other: ComplexF): ComplexF

Divides this real number by the other complex number.

Link copied to clipboard
inline fun Double.Companion.inverseLerp(a: Double, b: Double, t: Double): Double
inline fun Float.Companion.inverseLerp(a: Float, b: Float, t: Float): Float

Returns an interpolator value of the linearly interpolated value t between a and b.

Link copied to clipboard
inline fun Double.isApproximately(other: Double, epsilon: Double = 1.0E-10): Boolean
inline fun Float.isApproximately(other: Float, epsilon: Float = 1.0E-5f): Boolean

Returns a value indicating whether this value is approximately the other value given the specified epsilon tolerance.

Link copied to clipboard
inline fun Double.Companion.lerp(a: Double, b: Double, t: Double): Double
inline fun Float.Companion.lerp(a: Float, b: Float, t: Float): Float

Returns a linearly interpolated value between a and b.

Link copied to clipboard
inline operator fun Float.minus(other: ComplexF): ComplexF

Subtracts the other complex number from this real number.

Link copied to clipboard
inline operator fun Float.plus(other: ComplexF): ComplexF

Adds the other complex number to this real number.

Link copied to clipboard
@JvmName(name = "sumOfVector2F")
fun Array<out Vector2F>.sum(): Vector2F
@JvmName(name = "sumOfVector2I")
fun Array<out Vector2I>.sum(): Vector2I

Returns the sum of all elements in the array.

@JvmName(name = "sumOfVector2F")
fun Iterable<Vector2F>.sum(): Vector2F
@JvmName(name = "sumOfVector2I")
fun Iterable<Vector2I>.sum(): Vector2I

Returns the sum of all elements in the collection.

Link copied to clipboard
@JvmName(name = "sumOfVector2F")
inline fun <T> Array<out T>.sumOf(selector: (T) -> Vector2F): Vector2F
@JvmName(name = "sumOfVector2I")
inline fun <T> Array<out T>.sumOf(selector: (T) -> Vector2I): Vector2I

Returns the sum of all values produced by selector function applied to each element in the array.

@JvmName(name = "sumOfVector2F")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Vector2F): Vector2F
@JvmName(name = "sumOfVector2I")
inline fun <T> Iterable<T>.sumOf(selector: (T) -> Vector2I): Vector2I

Returns the sum of all values produced by selector function applied to each element in the collection.

Link copied to clipboard
inline operator fun Float.times(other: AngleF): AngleF

Multiplies this value by the other value.

inline operator fun Float.times(other: ComplexF): ComplexF

Multiplies this real number by the other complex number.

inline operator fun Float.times(other: Vector2F): Vector2F
inline operator fun Int.times(other: Vector2I): Vector2I

Multiplies this vector by the other scalar.

Link copied to clipboard
inline fun Float.toComplexF(): ComplexF

Converts this Float value to ComplexF.

Link copied to clipboard
fun Array<out Vector2F>.toVector2FArray(): Vector2FArray

Returns an array of Vector2F containing all the elements of this generic array.

Link copied to clipboard
fun Array<out Vector2I>.toVector2IArray(): Vector2IArray

Returns an array of Vector2I containing all the elements of this generic array.

Properties

Link copied to clipboard
val Float.i: ComplexF

Returns a complex number with the specified imaginary value.