com.wallstop-studios.unity-helpers 2.0.0-rc43 → 2.0.0-rc44

package/README.md

@@ -129,6 +129,22 @@ random.NextNoiseMap(width, height); // A configurable noise map generated using
 - XorShift
 - XorShiro
 
+## Performance (Number of Operations / Second)
+
+| Random | NextBool | Next | NextUInt | NextFloat | NextDouble | NextUint - Range | NextInt - Range |
+| ------ | -------- | ---- | -------- | --------- | ---------- | ---------------- | --------------- |
+| PcgRandom | 34,260,478 | 34,303,866 | 35,148,246 | 24,818,438 | 30,034,632 |22,436,474 |20,801,797 |
+| SystemRandom | 28,698,806 | 30,040,782 | 20,435,092 | 24,079,399 | 27,284,147 |20,735,769 |19,861,780 |
+| SquirrelRandom | 33,285,784 | 33,439,909 | 34,611,893 | 23,885,731 | 28,958,725 |21,520,279 |20,311,372 |
+| XorShiftRandom | 34,695,989 | 35,147,320 | 35,997,718 | 25,248,238 | 31,582,991 |22,679,928 |21,255,319 |
+| DotNetRandom | 18,097,489 | 18,191,042 | 18,783,063 | 14,061,444 | 15,730,439 |13,284,050 |12,596,913 |
+| WyRandom | 28,490,852 | 29,086,052 | 29,724,907 | 20,252,065 | 24,542,201 |18,474,790 |17,404,641 |
+| SplitMix64 | 34,301,843 | 34,343,404 | 35,512,284 | 24,289,416 | 30,586,231 |22,470,330 |20,850,965 |
+| RomuDuo | 32,969,889 | 33,413,212 | 34,339,227 | 23,755,059 | 29,483,136 |21,671,641 |20,253,479 |
+| XorShiroRandom | 31,529,025 | 31,717,709 | 32,536,277 | 22,421,715 | 27,619,417 |20,843,993 |19,270,063 |
+| UnityRandom | 24,925,268 | 24,830,594 | 26,429,283 | 17,864,528 | 21,206,384 |16,376,626 |15,528,972 |
+| LinearCongruentialGenerator | 35,013,818 | 35,025,182 | 35,843,533 | 25,093,401 | 31,553,487 |22,579,798 |21,211,175 |
+
 # 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.
 

package/Runtime/Core/Helper/FormattingHelpers.cs

@@ -0,0 +1,32 @@
+namespace UnityHelpers.Core.Helper
+{
+    using System;
+
+    public static class FormattingHelpers
+    {
+        public static string FormatBytes(long bytes)
+        {
+            string[] sizes = { "B", "KB", "MB", "GB", "TB", "PB", "EB" };
+            double len = bytes;
+            int order = 0;
+
+            bytes = Math.Max(0, bytes);
+
+            const int byteInChunk = 1024;
+            while (byteInChunk <= len)
+            {
+                len /= byteInChunk;
+                if (order < sizes.Length - 1)
+                {
+                    ++order;
+                }
+                else
+                {
+                    throw new ArgumentException($"Too many bytes! Cannot parse {bytes}");
+                }
+            }
+
+            return $"{len:0.##} {sizes[order]}";
+        }
+    }
+}

package/Runtime/Core/Helper/FormattingHelpers.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: a4bf649a0aef41b48c8afb261c4bd1d1
+timeCreated: 1742614257

package/Runtime/Core/Random/AbstractRandom.cs

@@ -21,6 +21,8 @@
 
         public abstract RandomState InternalState { get; }
 
+        private readonly byte[] _guidBytes = new byte[16];
+
         public virtual int Next()
         {
             // Mask out the MSB to ensure the value is within [0, int.MaxValue]
@@ -410,24 +412,23 @@
             where T : struct, Enum
         {
             Type enumType = typeof(T);
-            T[] enumValues = (T[])EnumTypeCache.GetOrAdd(enumType, Enum.GetValues);
+            T[] enumValues = (T[])EnumTypeCache.GetOrAdd(enumType, type => Enum.GetValues(type));
 
             return RandomOf(enumValues);
         }
 
         public Guid NextGuid()
         {
-            return new Guid(GenerateGuidBytes());
+            return new Guid(GenerateGuidBytes(_guidBytes));
         }
 
         public KGuid NextKGuid()
         {
-            return new KGuid(GenerateGuidBytes());
+            return new KGuid(GenerateGuidBytes(_guidBytes));
         }
 
-        private byte[] GenerateGuidBytes()
+        private byte[] GenerateGuidBytes(byte[] guidBytes)
         {
-            byte[] guidBytes = new byte[16];
             NextBytes(guidBytes);
             SetUuidV4Bits(guidBytes);
             return guidBytes;

package/Runtime/Core/Random/DotNetRandom.cs

@@ -8,6 +8,8 @@
     [DataContract]
     public sealed class DotNetRandom : AbstractRandom
     {
+        public static DotNetRandom Instance => ThreadLocalRandom<DotNetRandom>.Instance;
+
         public override RandomState InternalState =>
             new RandomState(unchecked((ulong)_seed), state2: _numberGenerated);
 

package/Runtime/Core/Random/IRandom.cs

@@ -138,6 +138,7 @@
         double NextGaussian(double mean = 0, double stdDev = 1);
 
         Guid NextGuid();
+
         KGuid NextKGuid();
 
         T NextOf<T>(IEnumerable<T> enumerable);

package/Runtime/Core/Random/LinearCongruentialGenerator.cs

@@ -0,0 +1,49 @@
+namespace UnityHelpers.Core.Random
+{
+    using System;
+    using System.Text.Json.Serialization;
+
+    public sealed class LinearCongruentialGenerator : AbstractRandom
+    {
+        public static LinearCongruentialGenerator Instance =>
+            ThreadLocalRandom<LinearCongruentialGenerator>.Instance;
+
+        public override RandomState InternalState => new(_state, 0, _cachedGaussian);
+
+        private uint _state;
+
+        public LinearCongruentialGenerator()
+            : this(Guid.NewGuid()) { }
+
+        public LinearCongruentialGenerator(int seed)
+        {
+            _state = unchecked((uint)seed);
+        }
+
+        public LinearCongruentialGenerator(Guid seed)
+        {
+            _state = unchecked((uint)seed.GetHashCode());
+        }
+
+        [JsonConstructor]
+        public LinearCongruentialGenerator(RandomState internalState)
+        {
+            _state = unchecked((uint)internalState.State1);
+            _cachedGaussian = internalState.Gaussian;
+        }
+
+        public override uint NextUint()
+        {
+            unchecked
+            {
+                _state = _state * 1664525U + 1013904223U;
+            }
+            return _state;
+        }
+
+        public override IRandom Copy()
+        {
+            return new LinearCongruentialGenerator(InternalState);
+        }
+    }
+}

package/Runtime/Core/Random/LinearCongruentialGenerator.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 23eaec3a914247e59d9bd39e199b718e
+timeCreated: 1742702544

package/Runtime/Core/Random/PcgRandom.cs

@@ -15,7 +15,7 @@
             IComparable,
             IComparable<PcgRandom>
     {
-        public static IRandom Instance => ThreadLocalRandom<PcgRandom>.Instance;
+        public static PcgRandom Instance => ThreadLocalRandom<PcgRandom>.Instance;
 
         public override RandomState InternalState => new(_state, _increment, _cachedGaussian);
 

package/Runtime/Core/Random/RomuDuo.cs

@@ -15,7 +15,7 @@
             IComparable,
             IComparable<RomuDuo>
     {
-        public static IRandom Instance => ThreadLocalRandom<RomuDuo>.Instance;
+        public static RomuDuo Instance => ThreadLocalRandom<RomuDuo>.Instance;
         public override RandomState InternalState => new(_x, _y, _cachedGaussian);
 
         internal ulong _x;

package/Runtime/Core/Random/SplitMix64.cs

@@ -12,7 +12,7 @@
             IComparable,
             IComparable<SplitMix64>
     {
-        public static IRandom Instance => ThreadLocalRandom<SplitMix64>.Instance;
+        public static SplitMix64 Instance => ThreadLocalRandom<SplitMix64>.Instance;
 
         public override RandomState InternalState => new(_state, 0, _cachedGaussian);
 

package/Runtime/Core/Random/SystemRandom.cs

@@ -16,7 +16,7 @@
         private const int SeedArraySize = 56;
         private const int LastSeedIndex = SeedArraySize - 1;
 
-        public static IRandom Instance => ThreadLocalRandom<SystemRandom>.Instance;
+        public static SystemRandom Instance => ThreadLocalRandom<SystemRandom>.Instance;
 
         public override RandomState InternalState =>
             new(

package/Runtime/Core/Random/WyRandom.cs

@@ -14,7 +14,7 @@
         private const ulong Prime0 = 0xa0761d6478bd642f;
         private const ulong Prime1 = 0xe7037ed1a0b428db;
 
-        public static IRandom Instance => ThreadLocalRandom<WyRandom>.Instance;
+        public static WyRandom Instance => ThreadLocalRandom<WyRandom>.Instance;
 
         public override RandomState InternalState => new RandomState(_state);
 

package/Runtime/Core/Random/XorShiftRandom.cs

@@ -8,18 +8,25 @@
     [DataContract]
     public sealed class XorShiftRandom : AbstractRandom
     {
-        public static IRandom Instance => ThreadLocalRandom<XorShiftRandom>.Instance;
+        public static XorShiftRandom Instance => ThreadLocalRandom<XorShiftRandom>.Instance;
 
         public override RandomState InternalState => new(_state, 0, _cachedGaussian);
 
         private uint _state;
 
         public XorShiftRandom()
-            : this(Guid.NewGuid().GetHashCode()) { }
+            : this(Guid.NewGuid()) { }
 
         public XorShiftRandom(int state)
         {
             _state = unchecked((uint)state);
+            _state = _state != 0 ? _state : 2463534242U;
+        }
+
+        public XorShiftRandom(Guid seed)
+        {
+            _state = unchecked((uint)seed.GetHashCode());
+            _state = _state != 0 ? _state : 2463534242U;
         }
 
         [JsonConstructor]
@@ -31,12 +38,10 @@
 
         public override uint NextUint()
         {
-            uint state = _state;
-            state ^= state << 13;
-            state ^= state >> 17;
-            state ^= state << 5;
-            _state = state;
-            return state;
+            _state ^= _state << 13;
+            _state ^= _state >> 17;
+            _state ^= _state << 5;
+            return _state;
         }
 
         public override IRandom Copy()

package/Runtime/Core/Random/XorShiroRandom.cs

@@ -12,6 +12,8 @@
             IComparable,
             IComparable<XorShiroRandom>
     {
+        public static XorShiroRandom Instance => ThreadLocalRandom<XorShiroRandom>.Instance;
+
         public override RandomState InternalState => new(_s0, _s1, _cachedGaussian);
 
         internal ulong _s0;

package/Runtime/UI/LayeredImage.cs

@@ -176,7 +176,7 @@
                 int maxY = int.MinValue;
                 foreach (AnimatedSpriteLayer layer in _layers)
                 {
-                    if (!layer.frames.Any())
+                    if (layer.frames.Length <= 0)
                     {
                         continue;
                     }
@@ -210,7 +210,7 @@
 
                 foreach (AnimatedSpriteLayer layer in _layers)
                 {
-                    if (!layer.frames.Any())
+                    if (layer.frames.Length <= 0)
                     {
                         continue;
                     }

package/Runtime/Utils/SpriteRendererMetadata.cs

@@ -11,6 +11,8 @@
     [DisallowMultipleComponent]
     public sealed class SpriteRendererMetadata : MonoBehaviour
     {
+        private bool Enabled => enabled && gameObject.activeInHierarchy;
+
         private readonly List<(Component component, Color color)> _colorStack = new();
         private readonly List<(Component component, Material material)> _materialStack = new();
 
@@ -25,9 +27,10 @@
 
         public Material CurrentMaterial => _materialStack[^1].material;
 
-        public IEnumerable<Material> Materials => _materialStack.Select(entry => entry.material);
+        public IEnumerable<Material> Materials =>
+            _materialStack.Select(entry => entry.material).Reverse();
 
-        public IEnumerable<Color> Colors => _colorStack.Select(entry => entry.color);
+        public IEnumerable<Color> Colors => _colorStack.Select(entry => entry.color).Reverse();
 
         [SiblingComponent]
         [SerializeField]
@@ -42,7 +45,7 @@
                 return;
             }
 
-            if (!force && !enabled)
+            if (!force && !Enabled)
             {
                 return;
             }
@@ -64,7 +67,7 @@
                 return;
             }
 
-            if (!force && !enabled)
+            if (!force && !Enabled)
             {
                 return;
             }
@@ -82,15 +85,17 @@
 
         public bool TryGetColor(Component component, out Color color)
         {
-            int index = _colorStack.FindIndex(value => value.component == component);
-            if (index < 0)
+            foreach ((Component component, Color color) entry in _colorStack)
             {
-                color = default;
-                return false;
+                if (entry.component == component)
+                {
+                    color = entry.color;
+                    return true;
+                }
             }
 
-            color = _colorStack[index].color;
-            return true;
+            color = default;
+            return false;
         }
 
         /// <summary>
@@ -98,7 +103,7 @@
         /// </summary>
         /// <param name="component">Component that owns the material.</param>
         /// <param name="material">Material to use.</param>
-        /// <param name="force">If true, overrides the enable check.</param>
+        /// <param name="force">If true, overrides the enabled check.</param>
         /// <returns>The instanced material, if possible.</returns>
         public Material PushMaterial(Component component, Material material, bool force = false)
         {
@@ -107,7 +112,7 @@
                 return null;
             }
 
-            if (!force && !enabled)
+            if (!force && !Enabled)
             {
                 return null;
             }
@@ -135,7 +140,7 @@
         /// </summary>
         /// <param name="component">Component that owns the material.</param>
         /// <param name="material">Material to use.</param>
-        /// <param name="force">If true, overrides the enable check.</param>
+        /// <param name="force">If true, overrides the enabled check.</param>
         /// <returns>The instanced material, if possible.</returns>
         public Material PushBackMaterial(Component component, Material material, bool force = false)
         {
@@ -144,7 +149,7 @@
                 return null;
             }
 
-            if (!force && !enabled)
+            if (!force && !Enabled)
             {
                 return null;
             }
@@ -186,14 +191,17 @@
 
         public bool TryGetMaterial(Component component, out Material material)
         {
-            int index = _materialStack.FindIndex(value => value.component == component);
-            if (index < 0)
+            foreach ((Component component, Material material) entry in _materialStack)
             {
-                material = default;
-                return false;
+                if (entry.component == component)
+                {
+                    material = entry.material;
+                    return true;
+                }
             }
-            material = _materialStack[index].material;
-            return true;
+
+            material = default;
+            return false;
         }
 
         private void Awake()
@@ -204,9 +212,15 @@
             }
 
             InternalPushColor(this, _spriteRenderer.color);
-            _colorStackCache.AddRange(_colorStack);
+            foreach ((Component component, Color color) entry in _colorStack)
+            {
+                _colorStackCache.Add(entry);
+            }
             _ = InternalPushMaterial(this, _spriteRenderer.material);
-            _materialStackCache.AddRange(_materialStack);
+            foreach ((Component component, Material material) entry in _materialStack)
+            {
+                _materialStackCache.Add(entry);
+            }
         }
 
         private void OnEnable()
@@ -219,13 +233,20 @@
             }
 
             _colorStack.Clear();
-            _colorStack.Add(_colorStackCache[0]);
+            if (0 < _colorStackCache.Count)
+            {
+                _colorStack.Add(_colorStackCache[0]);
+            }
+
             List<(Component component, Color color)> colorBuffer = Buffers<(
                 Component component,
                 Color color
             )>.List;
             colorBuffer.Clear();
-            colorBuffer.AddRange(_colorStackCache);
+            foreach ((Component component, Color color) entry in _colorStackCache)
+            {
+                colorBuffer.Add(entry);
+            }
             for (int i = 1; i < colorBuffer.Count; ++i)
             {
                 (Component component, Color color) entry = colorBuffer[i];
@@ -233,13 +254,20 @@
             }
 
             _materialStack.Clear();
-            _materialStack.Add(_materialStackCache[0]);
+            if (0 < _materialStackCache.Count)
+            {
+                _materialStack.Add(_materialStackCache[0]);
+            }
+
             List<(Component component, Material material)> materialBuffer = Buffers<(
                 Component component,
                 Material material
             )>.List;
             materialBuffer.Clear();
-            materialBuffer.AddRange(_materialStackCache);
+            foreach ((Component component, Material material) entry in _materialStackCache)
+            {
+                materialBuffer.Add(entry);
+            }
             for (int i = 1; i < materialBuffer.Count; ++i)
             {
                 (Component component, Material material) entry = materialBuffer[i];
@@ -254,21 +282,30 @@
                 Color color
             )>.List;
             colorBuffer.Clear();
-            colorBuffer.AddRange(_colorStack);
+            foreach ((Component component, Color color) entry in _colorStack)
+            {
+                colorBuffer.Add(entry);
+            }
             for (int i = colorBuffer.Count - 1; 1 <= i; --i)
             {
                 PopColor(colorBuffer[i].component);
             }
 
             _colorStackCache.Clear();
-            _colorStackCache.AddRange(colorBuffer);
+            foreach ((Component component, Color color) entry in colorBuffer)
+            {
+                _colorStackCache.Add(entry);
+            }
 
             List<(Component component, Material material)> materialBuffer = Buffers<(
                 Component component,
                 Material material
             )>.List;
             materialBuffer.Clear();
-            materialBuffer.AddRange(_materialStack);
+            foreach ((Component component, Material material) entry in _materialStack)
+            {
+                materialBuffer.Add(entry);
+            }
 
             for (int i = materialBuffer.Count - 1; 1 <= i; --i)
             {
@@ -276,7 +313,10 @@
             }
 
             _materialStackCache.Clear();
-            _materialStackCache.AddRange(materialBuffer);
+            foreach ((Component component, Material material) entry in materialBuffer)
+            {
+                _materialStackCache.Add(entry);
+            }
         }
 
         private void RemoveColor(Component component)
@@ -286,12 +326,23 @@
                 return;
             }
 
-            _ = _colorStack.RemoveAll(existingComponent =>
-                existingComponent.component == component || existingComponent.component == null
-            );
-            _ = _colorStackCache.RemoveAll(existingComponent =>
-                existingComponent.component == component || existingComponent.component == null
-            );
+            for (int i = _colorStack.Count - 1; 0 <= i; --i)
+            {
+                (Component component, Color color) stackEntry = _colorStack[i];
+                if (stackEntry.component == component || stackEntry.component == null)
+                {
+                    _colorStack.RemoveAt(i);
+                }
+            }
+
+            for (int i = _colorStackCache.Count - 1; 0 <= i; --i)
+            {
+                (Component component, Color color) stackEntry = _colorStackCache[i];
+                if (stackEntry.component == component || stackEntry.component == null)
+                {
+                    _colorStackCache.RemoveAt(i);
+                }
+            }
         }
 
         private void RemoveMaterial(Component component)
@@ -301,12 +352,23 @@
                 return;
             }
 
-            _ = _materialStack.RemoveAll(existingComponent =>
-                existingComponent.component == component || existingComponent.component == null
-            );
-            _ = _materialStackCache.RemoveAll(existingComponent =>
-                existingComponent.component == component || existingComponent.component == null
-            );
+            for (int i = _materialStack.Count - 1; 0 <= i; --i)
+            {
+                (Component component, Material material) stackEntry = _materialStack[i];
+                if (stackEntry.component == component || stackEntry.component == null)
+                {
+                    _materialStack.RemoveAt(i);
+                }
+            }
+
+            for (int i = _materialStackCache.Count - 1; 0 <= i; --i)
+            {
+                (Component component, Material material) stackEntry = _materialStackCache[i];
+                if (stackEntry.component == component || stackEntry.component == null)
+                {
+                    _materialStackCache.RemoveAt(i);
+                }
+            }
         }
     }
 }

package/Tests/Runtime/Performance/RandomPerformanceTests.cs

@@ -10,13 +10,13 @@
         [Test]
         public void Benchmark()
         {
-            TimeSpan timeout = TimeSpan.FromSeconds(1.125);
+            TimeSpan timeout = TimeSpan.FromSeconds(1);
 
             UnityEngine.Debug.Log(
-                $"| Random | NextBool | Next | NextUInt | NextFloat | NextDouble | NextUint - Range | "
+                "| Random | NextBool | Next | NextUInt | NextFloat | NextDouble | NextUint - Range | NextInt - Range |"
             );
             UnityEngine.Debug.Log(
-                $"| ------ | -------- | ---- | -------- | --------- | ---------- | ---------------- |"
+                "| ------ | -------- | ---- | -------- | --------- | ---------- | ---------------- | --------------- |"
             );
 
             RunTest(new PcgRandom(), timeout);
@@ -28,6 +28,8 @@
             RunTest(new SplitMix64(), timeout);
             RunTest(new RomuDuo(), timeout);
             RunTest(new XorShiroRandom(), timeout);
+            RunTest(new UnityRandom(), timeout);
+            RunTest(new LinearCongruentialGenerator(), timeout);
         }
 
         private static void RunTest<T>(T random, TimeSpan timeout)
@@ -39,6 +41,7 @@
             int nextFloat = RunNextFloat(timeout, random);
             int nextDouble = RunNextDouble(timeout, random);
             int nextUintRange = RunNextUintRange(timeout, random);
+            int nextIntRange = RunNextIntRange(timeout, random);
 
             UnityEngine.Debug.Log(
                 $"| {random.GetType().Name} | "
@@ -48,6 +51,7 @@
                     + $"{(nextFloat / timeout.TotalSeconds):N0} | "
                     + $"{(nextDouble / timeout.TotalSeconds):N0} |"
                     + $"{(nextUintRange / timeout.TotalSeconds):N0} |"
+                    + $"{(nextIntRange / timeout.TotalSeconds):N0} |"
             );
         }
 
@@ -108,6 +112,20 @@
             return count;
         }
 
+        private static int RunNextIntRange<T>(TimeSpan timeout, T random)
+            where T : IRandom
+        {
+            int count = 0;
+            Stopwatch timer = Stopwatch.StartNew();
+            do
+            {
+                _ = random.Next(1_000);
+                ++count;
+            } while (timer.Elapsed < timeout);
+
+            return count;
+        }
+
         private static int RunNextFloat<T>(TimeSpan timeout, T random)
             where T : IRandom
         {

package/Tests/Runtime/Random/LinearCongruentialGeneratorTests.cs

@@ -0,0 +1,12 @@
+namespace UnityHelpers.Tests.Random
+{
+    using Core.Random;
+
+    public sealed class LinearCongruentialGeneratorTests : RandomTestBase
+    {
+        protected override IRandom NewRandom()
+        {
+            return new LinearCongruentialGenerator();
+        }
+    }
+}

package/Tests/Runtime/Random/LinearCongruentialGeneratorTests.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 7859c541d79a4af7893bd98abfe7fea8
+timeCreated: 1742702856

package/package.json

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