using Misaki.HighPerformance.LowLevel.Buffer;
using Misaki.HighPerformance.LowLevel.Collections.Contracts;
using Misaki.HighPerformance.LowLevel.Utilities;
using System.Collections;
using System.Runtime.CompilerServices;
namespace Misaki.HighPerformance.LowLevel.Collections;
///
/// A structure that implements a queue using unmanaged types for efficient memory management.
///
/// Represents the type of elements stored in the queue, which must be an unmanaged type for performance and safety.
public unsafe struct UnsafeQueue : IUnsafeCollection
where T : unmanaged
{
public struct Enumerator : IEnumerator
{
private readonly UnsafeQueue* _collection;
private int _currentIndex;
// We assume _currentIndex will always be in range when accessed.
public readonly ref T Current => ref _collection->_array[(_collection->_offset + _currentIndex) % _collection->Capacity];
readonly T IEnumerator.Current => Current;
readonly object IEnumerator.Current => Current;
public Enumerator(UnsafeQueue* collection)
{
_collection = collection;
_currentIndex = -1;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public bool MoveNext()
{
_currentIndex++;
return _currentIndex < _collection->_count;
}
public void Reset()
{
_currentIndex = -1;
}
public readonly void Dispose()
{
}
}
private UnsafeArray _array;
private int _count;
private int _offset;
public readonly int Count => _count;
public readonly int Capacity => _array.Count;
public readonly bool IsCreated => _array.IsCreated;
public readonly T this[int index]
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _array[index];
[MethodImpl(MethodImplOptions.AggressiveInlining)]
set => _array[index] = value;
}
public Enumerator GetEnumerator() => new((UnsafeQueue*)UnsafeUtility.AddressOf(ref this));
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
///
/// Invalid constructor. Use or instead."/>
///
public UnsafeQueue()
: this(0, Allocator.Invalid)
{
}
public UnsafeQueue(int capacity, AllocationHandle handle, AllocationOption allocationOption = AllocationOption.None)
{
_array = new UnsafeArray(capacity, handle, allocationOption);
_count = 0;
_offset = 0;
}
public UnsafeQueue(int capacity, Allocator allocator, AllocationOption allocationType = AllocationOption.None)
: this(capacity, AllocationManager.GetAllocationHandle(allocator), allocationType)
{
}
///
/// Returns a reference to the item at the front of the queue without removing it.
///
/// A reference to the item at the front of the queue.
/// Thrown if the queue is empty.
public readonly ref T Peek()
{
if (_count == 0)
{
throw new InvalidOperationException("Queue is empty.");
}
return ref UnsafeUtility.ReadArrayElementRef(_array.GetUnsafePtr(), _offset);
}
///
/// Adds an element to the end of a collection, resizing if the current capacity is reached. The new element is
/// stored in a circular buffer.
///
/// The item to be added to the collection.
public void Enqueue(T value)
{
if (_count >= Capacity)
{
Resize(Math.Max(1, Capacity * 2));
}
UnsafeUtility.WriteArrayElement(_array.GetUnsafePtr(), (_offset + _count) % Capacity, value);
_count++;
}
///
/// Removes and returns the element at the front of the queue. If the queue is empty, an exception is thrown.
///
/// The element that was removed from the front of the queue.
/// Thrown when attempting to dequeue from an empty queue.
public T Dequeue()
{
if (_count == 0)
{
throw new InvalidOperationException("Queue is empty.");
}
var value = UnsafeUtility.ReadArrayElement(_array.GetUnsafePtr(), _offset);
_offset = (_offset + 1) % Capacity;
_count--;
return value;
}
///
/// Attempts to remove and return an item from a collection. Returns a boolean indicating success or failure.
///
/// The output variable that will hold the dequeued item if the operation is successful.
/// True if an item was successfully dequeued, otherwise false.
public bool TryDequeue(out T value)
{
if (_count == 0)
{
value = default;
return false;
}
value = Dequeue();
return true;
}
public void Resize(int newSize, AllocationOption option = AllocationOption.None)
{
_array.Resize(newSize, option);
if (_count > newSize)
{
_count = newSize;
}
}
public void Clear()
{
_array.Clear();
_count = 0;
_offset = 0;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public readonly void* GetUnsafePtr()
{
return _array.GetUnsafePtr();
}
public void Dispose()
{
_array.Dispose();
_count = 0;
_offset = 0;
}
}