Class "BitSet128"

Info

This class can be accessed by using its constructor or usind the TearFlags enum:

Example Code

local myBitSet = TearFlags.TEAR_WIGGLE

Constructors

BitSet128 ()

BitSet128 BitSet128 ( int Low = 0, int High = 0 )

Constructor for the "BitSet128" class.

BitSet128 is used as a storage system for flags and other bit-wise evaluated values that exceed the numeric limits of the default 64-bit integers which only allow for up to 64 flags to be defined. BitSet128 allows for up to 128 Flags by spliting the bitset into a "lower" and "higher" part. Those parts are represented by a simple 64bit integer number.

---

Operators

__bnot ()

BitSet128 __bnot ( )

Defines the negation of a BitSet128 object using the ~ operator.

---

__bor ()

BitSet128 __bor ( BitSet128 Right )

Defines the binary OR operation of two BitSet128 objects using the | operator.

---

__band ()

BitSet128 __band ( BitSet128 Right )

Defines the binary AND operation of two BitSet128 objects using the & operator.

---

__bxor ()

BitSet128 __bxor ( BitSet128 Right )

Defines the binary XOR operation of two BitSet128 objects using the ~ operator.

---

__shl ()

BitSet128 __shl ( int Shift )

Defines the left bit-shift operator of a BitSet128 object using the << operator.

---

__shr ()

BitSet128 __shr ( int Shift )

Defines the right bit-shift operator of a BitSet128 object using the >> operator.

---

__eq ()

boolean __eq ( BitSet128 right )

Defines the equality operation of two BitSet128 objects using the == operator.

---

__lt ()

boolean __lt ( BitSet128 right )

Defines the "smaller than"-Operation of two BitSet128 objects using the < operator.

The > operator is implicitly defined with this as well.

---

__le ()

boolean __le ( BitSet128 right )

Defines the "smaller of equal" operation of two BitSet128 objects using the <= operator.

The >= operator is implicitly defined with this as well.

---

Functions

Get ()

boolean Get ( int BitPosition )

Gets the flags' value at the provided position.

---

Set ()

void Set ( int BitPosition, boolean State )

Sets the bit at the given position to the given value.

---

__tostring ()

void __tostring ( )

BitSet128 objects can be cast to a string object, which returns information about this object in the following format:

BitSet128: [[High+Low values converted into Hexadecimal]]

---

Variables

h

int h

Returns the number representing the "High" or "upper" 64-bit number of the 128bit BitSet128 object.

---

l

int l

Returns the number representing the "Low" or "lower" 64-bit number of the 128bit BitSet128 object.

---

---

Last update: April 26, 2024