Fixed several JaggedArray related bugs and released new LowLevels-Ver…

…sion.
genaray · Jun 12, 2024 · 1fa6450 · 1fa6450
1 parent cb44ec9
commit 1fa6450
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 51 deletions.
diff --git a/Arch.LowLevel.Tests/Jagged/JaggedArrayTest.cs b/Arch.LowLevel.Tests/Jagged/JaggedArrayTest.cs
@@ -36,6 +36,58 @@ public void Add([Values(256,512,1024)] int capacity)
         That(jaggedArray.Capacity, Is.GreaterThan(capacity));
     }
 
+    [Test]
+    public void TryGetValue([Values(256,512,1024)] int capacity)
+    {
+        // Initialize the JaggedArray
+        var jaggedArray = new JaggedArray<int>(16000/Unsafe.SizeOf<int>(), -1, capacity);
+
+        // Add elements to the array
+        for (var index = 0; index < jaggedArray.Capacity; index++)
+        {
+            jaggedArray.Add(index, index);
+        }
+
+        // Check values using TryGetValue
+        for (var index = 0; index < jaggedArray.Capacity; index++)
+        {
+            var found = jaggedArray.TryGetValue(index, out int value);
+            That(found, Is.True);
+            That(value, Is.EqualTo(index));
+        }
+
+        // Check for values out of bounds
+        var outOfBoundsFound = jaggedArray.TryGetValue(jaggedArray.Capacity, out int _);
+        That(outOfBoundsFound, Is.False);
+    }
+
+    [Test]
+    public void TryGetValueRef([Values(256,512,1024)] int capacity)
+    {
+        // Initialize the JaggedArray
+        var jaggedArray = new JaggedArray<int>(16000/Unsafe.SizeOf<int>(), -1, capacity);
+
+        // Add elements to the array
+        for (var index = 0; index < jaggedArray.Capacity; index++)
+        {
+            jaggedArray.Add(index, index);
+        }
+
+        // Check values using TryGetValue
+        for (var index = 0; index < jaggedArray.Capacity; index++)
+        {
+            bool found;
+            ref var value = ref jaggedArray.TryGetValue(index, out found);
+            That(found, Is.True);
+            That(value, Is.EqualTo(index));
+        }
+
+        // Check for values out of bounds
+        ref var outOfBoundsValue = ref jaggedArray.TryGetValue(jaggedArray.Capacity, out bool outOfBoundsFound);
+        That(outOfBoundsFound, Is.False);
+    }
+
+
     /// <summary>
     ///     Checks if <see cref="JaggedArray{T}"/> is capable of adding items correctly.
     /// </summary>

diff --git a/Arch.LowLevel/Arch.LowLevel.csproj b/Arch.LowLevel/Arch.LowLevel.csproj
@@ -13,11 +13,11 @@
 
         <PackageId>Arch.LowLevel</PackageId>
         <Title>Arch.LowLevel</Title>
-        <Version>1.1.0</Version>
+        <Version>1.1.1</Version>
         <Authors>genaray</Authors>
         <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
         <Description>LowLevel tools for arch.</Description>
-        <PackageReleaseNotes>Additional fixes. </PackageReleaseNotes>
+        <PackageReleaseNotes>Fixed several JaggedArray related bugs. </PackageReleaseNotes>
         <PackageTags>c#;.net;.net6;.net7;ecs;game;entity;gamedev; game-development; game-engine; entity-component-system; arch;</PackageTags>
 
         <PackageProjectUrl>https://github.com/genaray/Arch.Extended</PackageProjectUrl>

diff --git a/Arch.LowLevel/Jagged/JaggedArray.cs b/Arch.LowLevel/Jagged/JaggedArray.cs
@@ -221,13 +221,6 @@ public bool TryGetValue(int index, out T value)
 
         IndexToSlot(index, out var bucketIndex, out var itemIndex);
 
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
-        {
-            value = _filler;
-            return false;
-        }
-
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
         // If the item is the default then the nobody set its value.
@@ -257,14 +250,13 @@ public ref T TryGetValue(int index, out bool @bool)
             return ref Unsafe.NullRef<T>(); 
         }
 
-        IndexToSlot(index, out var bucketIndex, out var itemIndex);
-
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
+        if (index >= Capacity)
         {
             @bool = false;
             return ref Unsafe.NullRef<T>(); 
         }
+
+        IndexToSlot(index, out var bucketIndex, out var itemIndex);
 
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
@@ -276,7 +268,7 @@ public ref T TryGetValue(int index, out bool @bool)
         }
 
         @bool = true;
-        return ref Unsafe.NullRef<T>(); 
+        return ref item; 
     }
 
     /// <summary>

diff --git a/Arch.LowLevel/Jagged/SparseJaggedArray.cs b/Arch.LowLevel/Jagged/SparseJaggedArray.cs
@@ -202,11 +202,6 @@ public void Add(int index, in T item)
     {
         IndexToSlot(index, out var bucketIndex, out var itemIndex);
 
-        if (bucketIndex >= _bucketArray.Length)
-        {
-            EnsureCapacity(index);
-        }
-
         ref var bucket = ref _bucketArray[bucketIndex];
         bucket.EnsureCapacity();
         bucket[itemIndex] = item;
@@ -244,16 +239,16 @@ public bool TryGetValue(int index, out T value)
             value = _filler;
             return false;
         }
-
-        IndexToSlot(index, out var bucketIndex, out var itemIndex);
-
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
+
+        // Index greater than capacity? 
+        if (index >= Capacity)
         {
             value = _filler;
             return false;
         }
 
+        IndexToSlot(index, out var bucketIndex, out var itemIndex);
+
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
         // If the item is the default then the nobody set its value.
@@ -282,16 +277,15 @@ public ref T TryGetValue(int index, out bool @bool)
             @bool = false;
             return ref Unsafe.NullRef<T>(); 
         }
-
-        IndexToSlot(index, out var bucketIndex, out var itemIndex);
-
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
+
+        if (index >= Capacity)
         {
             @bool = false;
             return ref Unsafe.NullRef<T>(); 
         }
 
+        IndexToSlot(index, out var bucketIndex, out var itemIndex);
+
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
         // If the item is the default then the nobody set its value.
@@ -302,7 +296,7 @@ public ref T TryGetValue(int index, out bool @bool)
         }
 
         @bool = true;
-        return ref Unsafe.NullRef<T>(); 
+        return ref item; 
     }
 
     /// <summary>

diff --git a/Arch.LowLevel/Jagged/UnsafeJaggedArray.cs b/Arch.LowLevel/Jagged/UnsafeJaggedArray.cs
@@ -192,14 +192,13 @@ public bool TryGetValue(int index, out T value)
             return false;
         }
 
-        IndexToSlot(index, out var bucketIndex, out var itemIndex);
-
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
+        if (index >= Capacity)
         {
             value = _filler;
             return false;
         }
+
+        IndexToSlot(index, out var bucketIndex, out var itemIndex);
 
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
@@ -229,16 +228,14 @@ public ref T TryGetValue(int index, out bool @bool)
             @bool = false;
             return ref Unsafe.NullRef<T>(); 
         }
-
-        IndexToSlot(index, out var bucketIndex, out var itemIndex);
-
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
+
+        if (index >= Capacity)
         {
             @bool = false;
             return ref Unsafe.NullRef<T>(); 
         }
 
+        IndexToSlot(index, out var bucketIndex, out var itemIndex);
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
         // If the item is the default then the nobody set its value.
@@ -249,7 +246,7 @@ public ref T TryGetValue(int index, out bool @bool)
         }
 
         @bool = true;
-        return ref Unsafe.NullRef<T>(); 
+        return ref item; 
     }
 
     /// <summary>

diff --git a/Arch.LowLevel/Jagged/UnsafeSparseJaggedArray.cs b/Arch.LowLevel/Jagged/UnsafeSparseJaggedArray.cs
@@ -250,15 +250,14 @@ public bool TryGetValue(int index, out T value)
             return false;
         }
 
-        IndexToSlot(index, out var bucketIndex, out var itemIndex);
-
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
+        if (index >= Capacity)
         {
             value = _filler;
             return false;
         }
-
+
+        IndexToSlot(index, out var bucketIndex, out var itemIndex);
+
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
         // If the item is the default then the nobody set its value.
@@ -288,14 +287,13 @@ public ref T TryGetValue(int index, out bool @bool)
             return ref Unsafe.NullRef<T>(); 
         }
 
-        IndexToSlot(index, out var bucketIndex, out var itemIndex);
-
-        // If the item is outside the array. Then it definetly doesn't exist
-        if (bucketIndex > _bucketArray.Length)
+        if (index >= Capacity)
         {
             @bool = false;
             return ref Unsafe.NullRef<T>(); 
         }
+
+        IndexToSlot(index, out var bucketIndex, out var itemIndex);
 
         ref var item = ref _bucketArray[bucketIndex][itemIndex];
 
@@ -307,7 +305,7 @@ public ref T TryGetValue(int index, out bool @bool)
         }
 
         @bool = true;
-        return ref Unsafe.NullRef<T>(); 
+        return ref item; 
     }
 
     /// <summary>

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ Download the packages and get started today!
 dotnet add package Arch.System --version 1.0.5
 dotnet add package Arch.System.SourceGenerator --version 1.2.1
 dotnet add package Arch.EventBus --version 1.0.2
-dotnet add package Arch.LowLevel --version 1.0.9
+dotnet add package Arch.LowLevel --version 1.1.1
 dotnet add package Arch.Relationships --version 1.0.0
 dotnet add package Arch.Persistence --version 1.0.4
 dotnet add package Arch.AOT.SourceGenerator --version 1.0.1