cleanup a bit

Author: LoneWandererProductions

MemoryManager.Core/CompactionStyle.cs

@@ -10,8 +10,8 @@ namespace MemoryManager.Core
 {
     public enum CompactionStyle
     {
-        Full,        // The current "Nuclear Reset" (Default for SlowLane)
-        GoodEnough,  // Stops the moment a target gap is opened
-        None         // Defragments strictly via free-list coalescing
+        Full, // The current "Nuclear Reset" (Default for SlowLane)
+        GoodEnough, // Stops the moment a target gap is opened
+        None // Defragments strictly via free-list coalescing
     }
-}
+}

MemoryManager.Core/IMemoryAllocator.cs

@@ -7,7 +7,7 @@
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
 
-using System.Diagnostics;
+// ReSharper disable UnusedMemberInSuper.Global
 
 namespace MemoryManager.Core
 {

MemoryManager.Lanes/SlabLane.cs

@@ -6,6 +6,8 @@
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
 
+// ReSharper disable MemberCanBePrivate.Global
+
 using ExtendedSystemObjects;
 using MemoryManager.Core;
 using System.Runtime.CompilerServices;
@@ -127,6 +129,9 @@ public unsafe SlabLane(int size, SlowLane slowLane, int maxEntries = 1024, Memor
         /// <summary>
         /// Gets the native raw heap memory handle.
         /// </summary>
+        /// <value>
+        /// The buffer.
+        /// </value>
         public nint Buffer { get; private set; }
 
         /// <inheritdoc />

MemoryManager.Tests/MemoryArenaInlineTests.cs

@@ -60,6 +60,9 @@ public void MemoryArena_GenerationalRedirection_WorksCorrectly()
             Assert.AreEqual(3.14f, result.Y, 0.001f);
         }
 
+        /// <summary>
+        /// Memories the arena zombie handle throws exception.
+        /// </summary>
         [TestMethod]
         public void MemoryArena_ZombieHandle_ThrowsException()
         {

MemoryManager.Types/ArenaList.cs

@@ -7,6 +7,8 @@
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
 
+// ReSharper disable UnusedMember.Global
+
 using MemoryManager.Core;
 using System.Runtime.CompilerServices;
 
@@ -57,16 +59,12 @@ public sealed class ArenaList<T> : IDisposable where T : unmanaged
         /// <summary>
         /// Initializes a new instance of the <see cref="ArenaList{T}" /> class.
         /// </summary>
-<<<<<<< HEAD
         /// <param name="arena">The arena.</param>
         /// <param name="initialCapacity">The initial capacity.</param>
         /// <param name="priority">The priority.</param>
         /// <param name="hints">The hints.</param>
-        public ArenaList(IMemoryAllocator arena, int initialCapacity = 8, AllocationPriority priority = AllocationPriority.Normal, AllocationHints hints = AllocationHints.None)
-=======
         public ArenaList(MemoryArena arena, int initialCapacity = 8,
             AllocationPriority priority = AllocationPriority.Normal, AllocationHints hints = AllocationHints.None)
->>>>>>> f41cf23e1c66b3d2e4e393356f32f92443e0ab03
         {
             if (initialCapacity <= 0) initialCapacity = 8;
 
@@ -109,12 +107,9 @@ public void Add(T item)
         public ref T Get(int index)
         {
             if (index < 0 || index >= Count)
-<<<<<<< HEAD
-                throw new IndexOutOfRangeException($"Index {index} is outside active boundaries.");
-=======
                 throw new IndexOutOfRangeException(
                     $"Index {index} is outside the active boundaries of the ArenaList (Count: {Count}).");
->>>>>>> f41cf23e1c66b3d2e4e393356f32f92443e0ab03
+
 
             var span = _arena.GetSpan<T>(_handle, _capacity);
             return ref span[index];
@@ -126,14 +121,13 @@ public ref T Get(int index)
         public void Clear() => Count = 0;
 
         /// <summary>
-        /// Ases the span.
+        /// Converts the active portion of the internal buffer to a <see cref="Span{T}"/> for zero-allocation access.
         /// </summary>
         /// <returns></returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public Span<T> AsSpan()
         {
-            if (Count == 0) return Span<T>.Empty;
-            return _arena.GetSpan<T>(_handle, _capacity).Slice(0, Count);
+            return Count == 0 ? Span<T>.Empty : _arena.GetSpan<T>(_handle, _capacity).Slice(0, Count);
         }
 
         /// <summary>
@@ -162,16 +156,16 @@ private void Grow()
             _capacity = newCapacity;
         }
 
+        /// <inheritdoc />
         /// <summary>
         /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
         /// </summary>
         public void Dispose()
         {
-            if (!_handle.IsInvalid)
-            {
-                _arena.Free(_handle);
-                _handle = default;
-            }
+            if (_handle.IsInvalid) return;
+
+            _arena.Free(_handle);
+            _handle = default;
         }
     }
 }

MemoryManager.Types/ArenaQueue.cs

@@ -7,11 +7,16 @@
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
 
+// ReSharper disable ConvertToAutoPropertyWithPrivateSetter
+// ReSharper disable UnusedType.Global
+
 using MemoryManager.Core;
 using System.Runtime.CompilerServices;
 
+
 namespace MemoryManager.Types
 {
+    /// <inheritdoc />
     /// <summary>
     /// A high-performance, zero-allocation circular queue (Ring Buffer) for unmanaged types,
     /// backed by an <see cref="IMemoryAllocator"/>.
@@ -76,7 +81,8 @@ public sealed class ArenaQueue<T> : IDisposable where T : unmanaged
         /// <param name="initialCapacity">The initial capacity.</param>
         /// <param name="priority">The priority.</param>
         /// <param name="hints">The hints.</param>
-        public ArenaQueue(IMemoryAllocator arena, int initialCapacity = 8, AllocationPriority priority = AllocationPriority.Normal, AllocationHints hints = AllocationHints.None)
+        public ArenaQueue(IMemoryAllocator arena, int initialCapacity = 8,
+            AllocationPriority priority = AllocationPriority.Normal, AllocationHints hints = AllocationHints.None)
         {
             if (initialCapacity <= 0) initialCapacity = 8;
 
@@ -191,16 +197,16 @@ private void Grow()
             _capacity = newCapacity;
         }
 
+        /// <inheritdoc />
         /// <summary>
         /// Cleans up unmanaged boundaries back to native runtime engines safely.
         /// </summary>
         public void Dispose()
         {
-            if (!_handle.IsInvalid)
-            {
-                _arena.Free(_handle);
-                _handle = default;
-            }
+            if (_handle.IsInvalid) return;
+
+            _arena.Free(_handle);
+            _handle = default;
         }
     }
 }

MemoryManager/MemoryArenaExtensions.cs

@@ -141,7 +141,8 @@ public static void BulkSet<T>(this IMemoryAllocator arena, MemoryHandle handle,
         /// <param name="count">The number of elements of type T to include in the span view.</param>
         /// <returns>A span tracking the underlying raw native block coordinates.</returns>
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
-        public static unsafe Span<T> GetSpan<T>(this IMemoryAllocator allocator, MemoryHandle handle, int count) where T : unmanaged
+        public static unsafe Span<T> GetSpan<T>(this IMemoryAllocator allocator, MemoryHandle handle, int count)
+            where T : unmanaged
         {
             if (handle.IsInvalid || count <= 0) return Span<T>.Empty;