Struct UnsafeSparseSet<T>

Namespace

Misaki.HighPerformance.LowLevel.Collections

Assembly

Misaki.HighPerformance.LowLevel.dll

A sparse set data structure that provides O(1) insertion, deletion, and lookup operations. The sparse set uses three arrays: a dense array for storing values, a sparse array for mapping indices, and a reverse array for mapping dense indices back to sparse indices. Sparse indices work like entity IDs and are automatically generated.

public struct UnsafeSparseSet<T> : IUnsafeCollection<T>, IUnsafeCollection, IDisposable where T : unmanaged

Type Parameters

T

Represents a type that can be stored in the sparse set, constrained to unmanaged types for performance and safety.

Implements

IUnsafeCollection<T>

IUnsafeCollection

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

UnsafeSparseSet()

Constructs an UnsafeSparseSet with a default size of 1 and uses the Persistent allocator.

public UnsafeSparseSet()

UnsafeSparseSet(int, AllocationHandle, AllocationOption)

Initializes a new instance of UnsafeSparseSet with a specified capacity and an allocation handle.

public UnsafeSparseSet(int capacity, AllocationHandle handle, AllocationOption allocationOption = AllocationOption.None)

Parameters

capacity int

Specifies the initial capacity of the sparse set, which must be greater than zero.

handle AllocationHandle

A reference to an AllocationHandle that manages the memory allocation for the sparse set.

allocationOption AllocationOption

Specifies how the memory should be allocated.

Exceptions

ArgumentOutOfRangeException

Thrown when the specified capacity is less than or equal to zero.

Properties

Capacity

public readonly int Capacity { get; }

Property Value

int

Count

Gets the number of elements in a collection.

public readonly int Count { get; }

Property Value

int

IsCreated

Indicates whether the object has been created. Returns true if the object is created, otherwise false.

public readonly bool IsCreated { get; }

Property Value

bool

Remarks

If MHP_ENABLE_STACKTRACE is not defined, this property will only check if the underlying pointer is not null, which may not be sufficient to determine if the collection is fully initialized and ready for use.

Methods

Add(scoped in T, out int)

Adds a value to the sparse set and returns a unique sparse index for the value.

public int Add(scoped in T value, out int generation)

Parameters

value T

The value to add to the sparse set.

generation int

Outputs the generation number associated with the added value.

Returns

int

A unique sparse index that can be used to reference this value.

AsUnsafeArray()

Converts the current sparse set to an UnsafeArray representation using its dense array.

public readonly UnsafeArray<T> AsUnsafeArray()

Returns

UnsafeArray<T>

Returns a new UnsafeArray instance initialized with the dense array's pointer and count.

Clear()

Removes all elements from the collection. The collection will be empty after this operation.

public void Clear()

Contains(int, int)

Checks if the sparse set contains a value at the specified sparse index.

public readonly bool Contains(int sparseIndex, int generation)

Parameters

sparseIndex int

The sparse index to check.

generation int

The generation number to validate against the stored generation.

Returns

bool

True if the sparse index is valid and contains a value, false otherwise.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

GetEnumerator()

[UnscopedRef]
public UnsafeSparseSet<T>.Enumerator GetEnumerator()

Returns

UnsafeSparseSet<T>.Enumerator

GetUnsafePtr()

Returns a pointer to an unmanaged memory location. This pointer can be used for low-level memory operations.

public readonly void* GetUnsafePtr()

Returns

void*

The method returns a void pointer to the unsafe memory location.

GetValue(int, int)

Gets the value at the specified sparse index and generation.

public readonly T GetValue(int sparseIndex, int generation)

Parameters

sparseIndex int

The sparse index to retrieve the value from.

generation int

The generation number to validate against the stored generation.

Returns

T

The value at the specified sparse index.

Exceptions

ArgumentOutOfRangeException

Thrown when the sparse index is not found.

GetValueReference(int, int, out bool)

Gets reference of the value at the specified sparse index and generation.

public readonly ref T GetValueReference(int sparseIndex, int generation, out bool exist)

Parameters

sparseIndex int

The sparse index to retrieve the value from.

generation int

The generation number to validate against the stored generation.

exist bool

Outputs whether the sparse index exists in the set.

Returns

T

Reference of the value at the specified sparse index.

Exceptions

ArgumentOutOfRangeException

Thrown when the sparse index is not found.

Remove(int, int)

Removes the value at the specified sparse index.

public bool Remove(int sparseIndex, int generation)

Parameters

sparseIndex int

The sparse index of the value to remove.

generation int

The generation number associated with the sparse index to validate.

Returns

bool

True if the value was removed, false if the sparse index was not found.

Remove(int, int, out T)

Removes the value at the specified sparse index.

public bool Remove(int sparseIndex, int generation, out T item)

Parameters

sparseIndex int

The sparse index of the value to remove.

generation int

The generation number associated with the sparse index to validate.

item T

When this method returns, contains the item that was removed if the removal was successful; otherwise, the default value for type T.

Returns

bool

True if the value was removed, false if the sparse index was not found.

Resize(int, AllocationOption)

Changes the size of a collection to the specified value.

public void Resize(int newSize, AllocationOption option = AllocationOption.None)

Parameters

newSize int

Specifies the new size to which the collection should be adjusted.

option AllocationOption

Specifies allocation options that may affect how memory is managed during the resize operation.

SetValue(int, int, T)

Updates the value at the specified sparse index.

public readonly bool SetValue(int sparseIndex, int generation, T value)

Parameters

sparseIndex int

The sparse index of the value to update.

generation int

The generation number to validate against the stored generation.

value T

The new value.

Returns

bool

True if the value was updated, false if the sparse index was not found.

TryGetValue(int, int, out T)

Gets the value at the specified sparse index and generation.

public readonly bool TryGetValue(int sparseIndex, int generation, out T value)

Parameters

sparseIndex int

The sparse index to retrieve the value from.

generation int

The generation number to validate against the stored generation.

value T

When this method returns, contains the value at the specified sparse index, if found.

Returns

bool

True if the sparse index contains a value, false otherwise.