com.wallstop-studios.unity-helpers 2.0.0-rc25 → 2.0.0-rc26

package/README.md

@@ -10,3 +10,91 @@ Various Unity Helpers. Includes many deterministic, seedable random number gener
     - URL: `https://registry.npmjs.org`
     - Scope(s): `com.wallstop-studios.unity-helpers`
 5. Resolve the latest `com.wallstop-studios.unity-helpers`
+
+# Package Contents
+- Random Number Generators
+- Spatial Trees
+- Protobuf, Binary, and JSON formatting
+- A resizable CyclicBuffer
+- Simple single-threaded thread pool
+- A LayeredImage for use with Unity's UI Toolkit
+- Geometry Helpers
+- Child/Parent/Sibling Attributes to automatically get components
+- ReadOnly attribute to disable editing of serialized properties in the inspector
+- An extensive collection of helpers
+- Simple math functions including a generic Range
+- Common buffers to reduce allocations
+- A RuntimeSingleton implementation for automatic creation/accessing of singletons
+- String helpers, like converting to PascalCase, like Unity does for variable names in the inspector
+- A randomizable PerlinNoise implementation
+- And more!
+
+# Random Number Generators
+This package implements several high quality, seedable, and serializable random number generators. The best one (currently) is the PCG Random. This has been hidden behind the `PRNG.Instance` class, which is thread-safe. As the package evolves, the exact implementation of this may change.
+
+All of these implement a custom [IRandom](./Runtime/Core/Random/IRandom.cs) interface with a significantly richer suite of methods than the standard .Net and Unity randoms offer.
+
+To use:
+
+```csharp
+IRandom random = PRNG.Instance;
+
+random.NextFloat(); // Something between 0.0f and 1.0f
+random.NextDouble(); // Something between 0.0d and 1.0d
+random.Next(); // Something between 0 and int.MaxValue
+random.NextUint(); // Something between 0 and uint.MaxValue
+
+int [] values = {1, 2, 3};
+random.NextOf(values); // 1, 2, or 3
+random.NextOf(Enumerable.Range(0, 3)); // 1, 2, or 3
+HashSet<int> setValues = new() {1, 2, 3};
+random.NextOf(setValues); // 1, 2, or 3
+
+random.NextGuid(); // A valid UUIDv4
+random.NextGaussian(); // A value sampled from a gaussian curve around mean=0, stdDev=1 (configurable via parameters)
+random.NextEnum<T>(); // A randomly selected enum of type T
+
+int width = 100;
+int height = 100;
+random.NextNoiseMap(width, height); // A configurable noise map generated using random octave offsets
+```
+
+## Implemented Random Number Generators
+- PCG
+- DotNet (uses the currently implemented .Net Random)
+- RomoDuo
+- SplitMix64
+- Squirrel
+- System (uses a port of the Windows .Net Random)
+- Unity (uses Unity's random under the hood)
+- Wy
+- XorShift
+- XorShiro
+
+# Spatial Trees
+There are three implemented 2D immutable spatial trees that can store generic objects, as long as there is some resolution function that can convert them into Vector2 spatial positions.
+
+- QuadTree (easiest to use)
+- KDTree
+- RTree
+
+Spatial trees, after construction, allow for O(log(n)) spatial query time instead of O(n). They are extremely useful if you need repeated spatial queries, or if you have relatively static spatial data.
+
+## Usage
+
+```csharp
+GameObject [] spatialStorage = { myCoolGameObject };
+QuadTree<GameObject> quadTree = new(spatialStorage, go => go.transform.position);
+
+// Might return your object, might not
+GameObject [] inBounds = quadTree.GetElementsInBounds(new Bounds(0, 0, 100, 100));
+
+// Uses a "good-enough" nearest-neighbor approximately for cheap neighbors
+List<GameObject> nearestNeighbors = new();
+quadTree.GetApproximateNearestNeighbors(myCoolGameObject.transform.position, 1, nearestNeighbors);
+Assert.AreEqual(1, nearestNeighbors.Count);
+Assert.AreEqual(myCoolGameObject, nearestNeighbors[0]);
+```
+
+## Note
+All spatial trees expect the positional data to be *immutable*. It is very important that the positions do not change. If they do, you will need to reconstruct the tree.

package/Runtime/Core/DataStructure/CyclicBuffer.cs

@@ -95,19 +95,26 @@
 
         public void Resize(int newCapacity)
         {
+            if (newCapacity == Capacity)
+            {
+                return;
+            }
+
             if (newCapacity < 0)
             {
                 throw new ArgumentException(nameof(newCapacity));
             }
 
+            int oldCapacity = Capacity;
             Capacity = newCapacity;
             _buffer.Shift(-_position);
             if (newCapacity < _buffer.Count)
             {
                 _buffer.RemoveRange(newCapacity, _buffer.Count - newCapacity);
-                _position = 0;
             }
 
+            _position =
+                newCapacity < oldCapacity && newCapacity <= _buffer.Count ? 0 : _buffer.Count;
             Count = Math.Min(newCapacity, Count);
         }
 

package/Runtime/Core/Extension/IListExtensions.cs

@@ -1,5 +1,6 @@
 namespace UnityHelpers.Core.Extension
 {
+    using System;
     using System.Collections.Generic;
     using Helper;
     using Random;
@@ -48,6 +49,15 @@
 
         public static void Reverse<T>(this IList<T> list, int start, int end)
         {
+            if (start < 0 || list.Count <= start)
+            {
+                throw new ArgumentException(nameof(start));
+            }
+            if (end < 0 || list.Count <= end)
+            {
+                throw new ArgumentException(nameof(end));
+            }
+
             while (start < end)
             {
                 (list[start], list[end]) = (list[end], list[start]);

package/Tests/Runtime/DataStructures/CyclicBufferTests.cs

@@ -244,6 +244,11 @@
                 Assert.AreEqual(newCapacity, newValues.Length);
                 Assert.That(values.Take(newCapacity), Is.EqualTo(newValues));
 
+                buffer.Add(1);
+                buffer.Add(2);
+                int[] afterAddition = buffer.ToArray();
+                Assert.That(afterAddition, Is.EqualTo(newValues.Skip(2).Concat(new[] { 1, 2 })));
+
                 newCapacity = 0;
                 buffer.Resize(newCapacity);
                 newValues = buffer.ToArray();
@@ -277,6 +282,37 @@
                 Assert.AreEqual(Math.Min(filled, newCapacity), newValues.Length);
                 Assert.That(values.Take(newCapacity), Is.EqualTo(newValues));
 
+                buffer.Add(1);
+                buffer.Add(2);
+                int[] afterAddition = buffer.ToArray();
+                if (newCapacity <= filled)
+                {
+                    Assert.That(
+                        afterAddition,
+                        Is.EqualTo(newValues.Skip(2).Concat(new[] { 1, 2 })),
+                        $"Resize failed for iteration {i}, fillPercent {fillPercent:0.00}, capacityPercent: {capacityPercent:0.00}. "
+                            + $"Capacity: {capacity}, newCapacity: {newCapacity}, filled: {filled}."
+                    );
+                }
+                else if (newCapacity == filled + 1)
+                {
+                    Assert.That(
+                        afterAddition,
+                        Is.EqualTo(newValues.Skip(1).Concat(new[] { 1, 2 })),
+                        $"Resize failed for iteration {i}, fillPercent {fillPercent:0.00}, capacityPercent: {capacityPercent:0.00}. "
+                            + $"Capacity: {capacity}, newCapacity: {newCapacity}, filled: {filled}."
+                    );
+                }
+                else
+                {
+                    Assert.That(
+                        afterAddition,
+                        Is.EqualTo(newValues.Concat(new[] { 1, 2 })),
+                        $"Resize failed for iteration {i}, fillPercent {fillPercent:0.00}, capacityPercent: {capacityPercent:0.00}. "
+                            + $"Capacity: {capacity}, newCapacity: {newCapacity}, filled: {filled}."
+                    );
+                }
+
                 newCapacity = 0;
                 buffer.Resize(newCapacity);
                 newValues = buffer.ToArray();

package/Tests/Runtime/Extensions/IListExtensionTests.cs

@@ -0,0 +1,76 @@
+namespace UnityHelpers.Tests.Extensions
+{
+    using System;
+    using System.Linq;
+    using Core.Extension;
+    using NUnit.Framework;
+
+    public sealed class IListExtensionTests
+    {
+        [Test]
+        public void ShiftLeft()
+        {
+            int[] input = Enumerable.Range(0, 10).ToArray();
+            for (int i = 0; i < input.Length * 2; ++i)
+            {
+                int[] shifted = input.ToArray();
+                shifted.Shift(-1 * i);
+                Assert.That(
+                    input.Skip(i % input.Length).Concat(input.Take(i % input.Length)),
+                    Is.EqualTo(shifted)
+                );
+            }
+        }
+
+        [Test]
+        public void ShiftRight()
+        {
+            int[] input = Enumerable.Range(0, 10).ToArray();
+            for (int i = 0; i < input.Length * 2; ++i)
+            {
+                int[] shifted = input.ToArray();
+                shifted.Shift(i);
+                Assert.That(
+                    input
+                        .Skip((input.Length * 3 - i) % input.Length)
+                        .Concat(input.Take((input.Length * 3 - i) % input.Length)),
+                    Is.EqualTo(shifted),
+                    $"Shift failed for amount {i}."
+                );
+            }
+        }
+
+        [Test]
+        public void Reverse()
+        {
+            int[] input = Enumerable.Range(0, 10).ToArray();
+            for (int i = 0; i < input.Length; ++i)
+            {
+                int[] shifted = input.ToArray();
+                shifted.Reverse(0, i);
+                Assert.That(
+                    input.Take(i + 1).Reverse().Concat(input.Skip(i + 1)),
+                    Is.EqualTo(shifted),
+                    $"Reverse failed for reversal from [0, {i}]."
+                );
+            }
+
+            // TODO
+        }
+
+        [Test]
+        public void ReverseInvalidArguments()
+        {
+            int[] input = Enumerable.Range(0, 10).ToArray();
+            Assert.Throws<ArgumentException>(() => input.Reverse(-1, 1));
+            Assert.Throws<ArgumentException>(() => input.Reverse(input.Length, 1));
+            Assert.Throws<ArgumentException>(() => input.Reverse(int.MaxValue, 1));
+            Assert.Throws<ArgumentException>(() => input.Reverse(int.MinValue, 1));
+
+            Assert.Throws<ArgumentException>(() => input.Reverse(1, -1));
+            Assert.Throws<ArgumentException>(() => input.Reverse(1, input.Length));
+            Assert.Throws<ArgumentException>(() => input.Reverse(1, int.MaxValue));
+            Assert.Throws<ArgumentException>(() => input.Reverse(1, int.MinValue));
+        }
+    }
+}

package/Tests/Runtime/Extensions/IListExtensionTests.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 53f10c10d1a14859a9a8616477fd318a
+timeCreated: 1741982863

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.wallstop-studios.unity-helpers",
-  "version": "2.0.0-rc25",
+  "version": "2.0.0-rc26",
   "displayName": "Unity Helpers",
   "description": "Various Unity Helper Library",
   "dependencies": {},