MathKit/com.sztorm.mathkit/Flags32

Flags32

@JvmInline

value class Flags32(val intValue: Int) : Collection<Boolean>

Represents a collection of thirty-two bit flags.

On the JVM, non-nullable values of this type are represented as values of the primitive type int.

Constructors

Flags32

constructor(intValue: Int)

Types

Companion

object Companion

Properties

intValue

val intValue: Int

Returns 32-bit signed integer representation of this type.

lastIndex

val lastIndex: Int

Returns the last valid index for this collection.

size

open override val size: Int

Returns the number of flags, which is always 32.

uIntValue

val uIntValue: UInt

Returns 32-bit unsigned integer representation of this type.

Functions

adding

infix inline fun adding(flags: Flags32): Flags32

Returns a copy of this flags instance with the specified flags added.

contains

inline operator override fun contains(element: Boolean): Boolean

Returns a value indicating whether the element is contained in this collection.

containsAll

open override fun containsAll(elements: Collection<Boolean>): Boolean

Returns a value indicating whether all specified elements are contained in this collection.

get

inline operator fun get(index: Int): Boolean

Returns a value indicating whether the bit at index is set to 1.

hasAll

inline fun hasAll(flags: Flags32): Boolean

Returns a value indicating whether this flags instance has all the specified flags.

hasAny

inline fun hasAny(flags: Flags32): Boolean

Returns a value indicating whether this flags instance has any of the specified flags.

isEmpty

inline override fun isEmpty(): Boolean

Returns a value indicating whether this collection is empty, which is always false.

iterator

open operator override fun iterator(): BooleanIterator

Returns an iterator of this collection.

removing

infix inline fun removing(flags: Flags32): Flags32

Returns a copy of this flags instance with the specified flags removed.

setting

inline fun setting(flags: Flags32, to: Boolean): Flags32

Returns a copy of this flags instance with the specified flags set to the particular value.

sum

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

sumOf

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

toggling

infix inline fun toggling(flags: Flags32): Flags32

Returns a copy of this flags instance with the specified flags toggled.

toString

open override fun toString(): String

Returns a String representation of this flags collection in "Flags32(00000000 00000000 00000000 00000000)" format.