| | | 1 | | //======================================================================= |
| | | 2 | | // SwiftArray3D.cs |
| | | 3 | | //======================================================================= |
| | | 4 | | // MIT License, Copyright (c) 2024-present David Oravsky (mrdav30) |
| | | 5 | | // See LICENSE file in the project root for full license information. |
| | | 6 | | //======================================================================= |
| | | 7 | | |
| | | 8 | | using System; |
| | | 9 | | using System.Collections; |
| | | 10 | | using System.Collections.Generic; |
| | | 11 | | using System.Text.Json.Serialization; |
| | | 12 | | using Chronicler; |
| | | 13 | | using Chronicler.Diagnostics; |
| | | 14 | | using Chronicler.Serialization; |
| | | 15 | | using MemoryPack; |
| | | 16 | | |
| | | 17 | | namespace SwiftCollections.Dimensions; |
| | | 18 | | |
| | | 19 | | /// <summary> |
| | | 20 | | /// Represents a generic, flattened 3D array with efficient indexing and resizing capabilities. |
| | | 21 | | /// Optimized for use in performance-critical applications like game grids. |
| | | 22 | | /// </summary> |
| | | 23 | | /// <typeparam name="T">The type of elements in the 3D array.</typeparam> |
| | | 24 | | [Serializable] |
| | | 25 | | [JsonConverter(typeof(StateJsonConverterFactory))] |
| | | 26 | | [MemoryPackable] |
| | | 27 | | public partial class SwiftArray3D<T> : IStateBacked<Array3DState<T>>, IEnumerable<T>, IEnumerable |
| | | 28 | | { |
| | | 29 | | #region Fields |
| | | 30 | | |
| | | 31 | | private T[] _innerArray; |
| | | 32 | | |
| | | 33 | | private int _width; |
| | | 34 | | |
| | | 35 | | private int _height; |
| | | 36 | | |
| | | 37 | | private int _depth; |
| | | 38 | | |
| | | 39 | | #endregion |
| | | 40 | | |
| | | 41 | | #region Constructors |
| | | 42 | | |
| | | 43 | | /// <summary> |
| | | 44 | | /// Initializes a new instance of the SwiftArray3D class with zero dimensions. |
| | | 45 | | /// </summary> |
| | | 46 | | /// <remarks> |
| | | 47 | | /// This constructor creates an empty three-dimensional array. |
| | | 48 | | /// Use this overload when you intend to set the dimensions later or create an empty array. |
| | | 49 | | /// </remarks> |
| | 4 | 50 | | public SwiftArray3D() : this(0, 0, 0) { } |
| | | 51 | | |
| | | 52 | | /// <summary> |
| | | 53 | | /// Initializes a new instance of the SwiftArray3D class with the specified dimensions. |
| | | 54 | | /// </summary> |
| | | 55 | | /// <param name="width">The number of elements in the first dimension. Must be greater than zero.</param> |
| | | 56 | | /// <param name="height">The number of elements in the second dimension. Must be greater than zero.</param> |
| | | 57 | | /// <param name="depth">The number of elements in the third dimension. Must be greater than zero.</param> |
| | 26 | 58 | | public SwiftArray3D(int width, int height, int depth) |
| | | 59 | | { |
| | 26 | 60 | | _width = width; |
| | 26 | 61 | | _height = height; |
| | 26 | 62 | | _depth = depth; |
| | 26 | 63 | | _innerArray = new T[width * height * depth]; |
| | 26 | 64 | | } |
| | | 65 | | |
| | | 66 | | /// <summary> |
| | | 67 | | /// Initializes a new instance of the SwiftArray3D class with the specified dimensions and fills all elements with |
| | | 68 | | /// the provided default value. |
| | | 69 | | /// </summary> |
| | | 70 | | /// <param name="width">The number of elements in the first dimension. Must be greater than zero.</param> |
| | | 71 | | /// <param name="height">The number of elements in the second dimension. Must be greater than zero.</param> |
| | | 72 | | /// <param name="depth">The number of elements in the third dimension. Must be greater than zero.</param> |
| | | 73 | | /// <param name="defaultValue">The value to assign to each element in the array upon initialization.</param> |
| | 1 | 74 | | public SwiftArray3D(int width, int height, int depth, T defaultValue) : this(width, height, depth) |
| | | 75 | | { |
| | 1 | 76 | | Fill(defaultValue); |
| | 1 | 77 | | } |
| | | 78 | | |
| | | 79 | | /// <summary> |
| | | 80 | | /// Initializes a new instance of the SwiftArray3D class with the specified array state. |
| | | 81 | | /// </summary> |
| | | 82 | | /// <param name="state"> |
| | | 83 | | /// The state object that encapsulates the underlying data and configuration for the three-dimensional array. |
| | | 84 | | /// Cannot be null. |
| | | 85 | | /// </param> |
| | | 86 | | [MemoryPackConstructor] |
| | 2 | 87 | | public SwiftArray3D(Array3DState<T> state) |
| | | 88 | | { |
| | 2 | 89 | | State = state; |
| | 2 | 90 | | ChronicleGuard.ThrowIfNull(_innerArray, nameof(_innerArray)); |
| | 2 | 91 | | } |
| | | 92 | | |
| | | 93 | | #endregion |
| | | 94 | | |
| | | 95 | | #region Properties |
| | | 96 | | |
| | | 97 | | /// <summary> |
| | | 98 | | /// Gets the width of the object. |
| | | 99 | | /// </summary> |
| | | 100 | | [JsonIgnore] |
| | | 101 | | [MemoryPackIgnore] |
| | 2252251 | 102 | | public int Width => _width; |
| | | 103 | | |
| | | 104 | | /// <summary> |
| | | 105 | | /// Gets the height value associated with the current instance. |
| | | 106 | | /// </summary> |
| | | 107 | | [JsonIgnore] |
| | | 108 | | [MemoryPackIgnore] |
| | 4505307 | 109 | | public int Height => _height; |
| | | 110 | | |
| | | 111 | | /// <summary> |
| | | 112 | | /// Gets the current depth value for this instance. |
| | | 113 | | /// </summary> |
| | | 114 | | [JsonIgnore] |
| | | 115 | | [MemoryPackIgnore] |
| | 6758861 | 116 | | public int Depth => _depth; |
| | | 117 | | |
| | | 118 | | /// <summary> |
| | | 119 | | /// Total size of the array. |
| | | 120 | | /// </summary> |
| | | 121 | | [JsonIgnore] |
| | | 122 | | [MemoryPackIgnore] |
| | 2 | 123 | | public int Size => _width * _height * _depth; |
| | | 124 | | |
| | | 125 | | /// <inheritdoc cref="Array.Length" /> |
| | | 126 | | [JsonIgnore] |
| | | 127 | | [MemoryPackIgnore] |
| | 3 | 128 | | public int Length => _innerArray.Length; |
| | | 129 | | |
| | | 130 | | /// <summary> |
| | | 131 | | /// Gets or sets the element at the specified three-dimensional indices. |
| | | 132 | | /// </summary> |
| | | 133 | | /// <remarks>An exception is thrown if any index is outside the valid range for its dimension.</remarks> |
| | | 134 | | /// <param name="x">The zero-based index along the first dimension.</param> |
| | | 135 | | /// <param name="y">The zero-based index along the second dimension.</param> |
| | | 136 | | /// <param name="z">The zero-based index along the third dimension.</param> |
| | | 137 | | /// <returns>The element located at the specified indices.</returns> |
| | | 138 | | [JsonIgnore] |
| | | 139 | | [MemoryPackIgnore] |
| | | 140 | | public T this[int x, int y, int z] |
| | | 141 | | { |
| | | 142 | | get |
| | | 143 | | { |
| | 1126131 | 144 | | ValidateIndex(x, y, z); |
| | 1126127 | 145 | | return _innerArray[GetIndex(x, y, z)]; |
| | | 146 | | } |
| | | 147 | | set |
| | | 148 | | { |
| | 1126021 | 149 | | ValidateIndex(x, y, z); |
| | 1126021 | 150 | | _innerArray[GetIndex(x, y, z)] = value; |
| | 1126021 | 151 | | } |
| | | 152 | | } |
| | | 153 | | |
| | | 154 | | /// <summary> |
| | | 155 | | /// Gets or sets the complete state of the 3D array, including its dimensions and data contents. |
| | | 156 | | /// </summary> |
| | | 157 | | /// <remarks> |
| | | 158 | | /// Setting this property replaces the current array's dimensions and data with those from the specified state. |
| | | 159 | | /// Getting this property returns a snapshot of the current array state. |
| | | 160 | | /// This property is intended for serialization and deserialization scenarios. |
| | | 161 | | /// </remarks> |
| | | 162 | | [JsonInclude] |
| | | 163 | | [MemoryPackInclude] |
| | | 164 | | public Array3DState<T> State |
| | | 165 | | { |
| | | 166 | | get |
| | | 167 | | { |
| | 2 | 168 | | var data = new T[_innerArray.Length]; |
| | 2 | 169 | | Array.Copy(_innerArray, data, data.Length); |
| | | 170 | | |
| | 2 | 171 | | return new Array3DState<T>( |
| | 2 | 172 | | _width, |
| | 2 | 173 | | _height, |
| | 2 | 174 | | _depth, |
| | 2 | 175 | | data |
| | 2 | 176 | | ); |
| | | 177 | | } |
| | | 178 | | |
| | | 179 | | internal set |
| | | 180 | | { |
| | 2 | 181 | | _width = value.Width; |
| | 2 | 182 | | _height = value.Height; |
| | 2 | 183 | | _depth = value.Depth; |
| | | 184 | | |
| | 2 | 185 | | _innerArray = new T[value.Data.Length]; |
| | 2 | 186 | | Array.Copy(value.Data, _innerArray, value.Data.Length); |
| | 2 | 187 | | } |
| | | 188 | | } |
| | | 189 | | |
| | | 190 | | #endregion |
| | | 191 | | |
| | | 192 | | #region Methods |
| | | 193 | | |
| | | 194 | | /// <summary> |
| | | 195 | | /// Resizes the 3D array to the specified dimensions. |
| | | 196 | | /// Retains existing data where possible. |
| | | 197 | | /// </summary> |
| | | 198 | | public void Resize(int newWidth, int newHeight, int newDepth) |
| | | 199 | | { |
| | 5 | 200 | | var newArray = new T[newWidth * newHeight * newDepth]; |
| | | 201 | | |
| | 5 | 202 | | int minWidth = Math.Min(Width, newWidth); |
| | 5 | 203 | | int minHeight = Math.Min(Height, newHeight); |
| | 5 | 204 | | int minDepth = Math.Min(Depth, newDepth); |
| | | 205 | | |
| | 32 | 206 | | for (int x = 0; x < minWidth; x++) |
| | | 207 | | { |
| | 88 | 208 | | for (int y = 0; y < minHeight; y++) |
| | | 209 | | { |
| | 280 | 210 | | for (int z = 0; z < minDepth; z++) |
| | | 211 | | { |
| | 107 | 212 | | int srcIndex = GetIndex(x, y, z); |
| | 107 | 213 | | int dstIndex = x * (newHeight * newDepth) + y * newDepth + z; |
| | 107 | 214 | | newArray[dstIndex] = _innerArray[srcIndex]; |
| | | 215 | | } |
| | | 216 | | } |
| | | 217 | | } |
| | | 218 | | |
| | 5 | 219 | | _innerArray = newArray; |
| | 5 | 220 | | _width = newWidth; |
| | 5 | 221 | | _height = newHeight; |
| | 5 | 222 | | _depth = newDepth; |
| | 5 | 223 | | } |
| | | 224 | | |
| | | 225 | | /// <summary> |
| | | 226 | | /// Shifts the elements in the array by the specified offsets along each axis. |
| | | 227 | | /// </summary> |
| | | 228 | | /// <param name="xOffset">The offset to apply along the X-axis.</param> |
| | | 229 | | /// <param name="yOffset">The offset to apply along the Y-axis.</param> |
| | | 230 | | /// <param name="zOffset">The offset to apply along the Z-axis.</param> |
| | | 231 | | /// <param name="wrap"> |
| | | 232 | | /// Specifies whether to wrap elements that exceed the array's boundaries. |
| | | 233 | | /// If <c>true</c>, values wrap around to the other side of the array. |
| | | 234 | | /// If <c>false</c>, values that exceed boundaries are discarded. |
| | | 235 | | /// </param> |
| | | 236 | | /// <remarks> |
| | | 237 | | /// - Wrapping behavior ensures that no data is lost during shifts. |
| | | 238 | | /// - Non-wrapping behavior discards elements that move out of bounds. |
| | | 239 | | /// </remarks> |
| | | 240 | | public void Shift(int xOffset, int yOffset, int zOffset, bool wrap = true) |
| | | 241 | | { |
| | 7 | 242 | | var newArray = new T[Width * Height * Depth]; |
| | | 243 | | |
| | 7 | 244 | | if (wrap) |
| | 6 | 245 | | ShiftWrapped(newArray, xOffset, yOffset, zOffset); |
| | | 246 | | else |
| | 1 | 247 | | ShiftClamped(newArray, xOffset, yOffset, zOffset); |
| | | 248 | | |
| | 7 | 249 | | _innerArray = newArray; |
| | 7 | 250 | | } |
| | | 251 | | |
| | | 252 | | private void ShiftWrapped(T[] newArray, int xOffset, int yOffset, int zOffset) |
| | | 253 | | { |
| | 6 | 254 | | int normalizedXOffset = NormalizeShift(xOffset, Width); |
| | 6 | 255 | | int normalizedYOffset = NormalizeShift(yOffset, Height); |
| | 6 | 256 | | int normalizedZOffset = NormalizeShift(zOffset, Depth); |
| | | 257 | | |
| | 48 | 258 | | for (int x = 0; x < Width; x++) |
| | | 259 | | { |
| | 18 | 260 | | int newX = WrapForwardIndex(x, normalizedXOffset, Width); |
| | 180 | 261 | | for (int y = 0; y < Height; y++) |
| | | 262 | | { |
| | 72 | 263 | | int newY = WrapForwardIndex(y, normalizedYOffset, Height); |
| | 792 | 264 | | for (int z = 0; z < Depth; z++) |
| | | 265 | | { |
| | 324 | 266 | | int newZ = WrapForwardIndex(z, normalizedZOffset, Depth); |
| | 324 | 267 | | newArray[GetIndex(newX, newY, newZ)] = _innerArray[GetIndex(x, y, z)]; |
| | | 268 | | } |
| | | 269 | | } |
| | | 270 | | } |
| | 6 | 271 | | } |
| | | 272 | | |
| | | 273 | | private void ShiftClamped(T[] newArray, int xOffset, int yOffset, int zOffset) |
| | | 274 | | { |
| | 1 | 275 | | GetShiftRange(Width, xOffset, out int xStart, out int xEnd); |
| | 1 | 276 | | GetShiftRange(Height, yOffset, out int yStart, out int yEnd); |
| | 1 | 277 | | GetShiftRange(Depth, zOffset, out int zStart, out int zEnd); |
| | | 278 | | |
| | 6 | 279 | | for (int x = xStart; x < xEnd; x++) |
| | | 280 | | { |
| | 2 | 281 | | int newX = x + xOffset; |
| | 12 | 282 | | for (int y = yStart; y < yEnd; y++) |
| | | 283 | | { |
| | 4 | 284 | | int newY = y + yOffset; |
| | 16 | 285 | | for (int z = zStart; z < zEnd; z++) |
| | | 286 | | { |
| | 4 | 287 | | int newZ = z + zOffset; |
| | 4 | 288 | | newArray[GetIndex(newX, newY, newZ)] = _innerArray[GetIndex(x, y, z)]; |
| | | 289 | | } |
| | | 290 | | } |
| | | 291 | | } |
| | 1 | 292 | | } |
| | | 293 | | |
| | | 294 | | /// <summary> |
| | | 295 | | /// Clears all elements in the array. |
| | | 296 | | /// </summary> |
| | 1 | 297 | | public void Clear() => Array.Clear(_innerArray, 0, _innerArray.Length); |
| | | 298 | | |
| | | 299 | | /// <summary> |
| | | 300 | | /// Fills the entire array with the specified value. |
| | | 301 | | /// </summary> |
| | | 302 | | public void Fill(T value) |
| | | 303 | | { |
| | 224 | 304 | | for (int i = 0; i < _innerArray.Length; i++) |
| | 108 | 305 | | _innerArray[i] = value; |
| | 4 | 306 | | } |
| | | 307 | | |
| | | 308 | | /// <summary> |
| | | 309 | | /// Calculates the one-dimensional array index corresponding to the specified three-dimensional coordinates. |
| | | 310 | | /// </summary> |
| | | 311 | | /// <remarks> |
| | | 312 | | /// Use this method to map three-dimensional coordinates to a linear array index when working with flattened 3D data |
| | | 313 | | /// The valid ranges for x, y, and z depend on the dimensions of the underlying data structure. |
| | | 314 | | /// </remarks> |
| | | 315 | | /// <param name="x">The zero-based X coordinate to convert.</param> |
| | | 316 | | /// <param name="y">The zero-based Y coordinate to convert.</param> |
| | | 317 | | /// <param name="z">The zero-based Z coordinate to convert.</param> |
| | | 318 | | /// <returns>The zero-based index in the underlying one-dimensional array that corresponds to the specified (x, y, z |
| | | 319 | | public virtual int GetIndex(int x, int y, int z) |
| | | 320 | | { |
| | 2252911 | 321 | | return x * (Height * Depth) + y * Depth + z; |
| | | 322 | | } |
| | | 323 | | |
| | | 324 | | /// <summary> |
| | | 325 | | /// Validates the specified indices. |
| | | 326 | | /// Throws an exception if the indices are out of bounds. |
| | | 327 | | /// </summary> |
| | | 328 | | public virtual void ValidateIndex(int x, int y, int z) |
| | | 329 | | { |
| | 2252152 | 330 | | if (!IsValidIndex(x, y, z)) |
| | 4 | 331 | | throw new IndexOutOfRangeException($"Invalid index ({x}, {y}, {z}) for dimensions ({Width}, {Height}, {Depth |
| | 2252148 | 332 | | } |
| | | 333 | | |
| | | 334 | | private static int NormalizeShift(int shift, int length) |
| | | 335 | | { |
| | 18 | 336 | | if (length == 0) |
| | 3 | 337 | | return 0; |
| | | 338 | | |
| | 15 | 339 | | int normalized = shift % length; |
| | 15 | 340 | | return normalized < 0 ? normalized + length : normalized; |
| | | 341 | | } |
| | | 342 | | |
| | | 343 | | private static int WrapForwardIndex(int index, int normalizedShift, int length) |
| | | 344 | | { |
| | 414 | 345 | | int shifted = index + normalizedShift; |
| | 414 | 346 | | return shifted >= length ? shifted - length : shifted; |
| | | 347 | | } |
| | | 348 | | |
| | | 349 | | private static void GetShiftRange(int length, int shift, out int start, out int end) |
| | | 350 | | { |
| | 3 | 351 | | long startValue = shift < 0 ? -(long)shift : 0L; |
| | 3 | 352 | | long endValue = shift > 0 ? (long)length - shift : length; |
| | | 353 | | |
| | 3 | 354 | | start = (int)Math.Min(startValue, length); |
| | 3 | 355 | | end = (int)Math.Max(0L, Math.Min(endValue, length)); |
| | 3 | 356 | | } |
| | | 357 | | |
| | | 358 | | /// <summary> |
| | | 359 | | /// Checks if the specified indices are within bounds. |
| | | 360 | | /// </summary> |
| | | 361 | | public virtual bool IsValidIndex(int x, int y, int z) => |
| | 2252155 | 362 | | x >= 0 && x < Width && y >= 0 && y < Height && z >= 0 && z < Depth; |
| | | 363 | | |
| | | 364 | | #endregion |
| | | 365 | | |
| | | 366 | | #region IEnumerator Implementation |
| | | 367 | | |
| | | 368 | | /// <summary> |
| | | 369 | | /// Returns an enumerator that iterates through all elements in the 3D array. |
| | | 370 | | /// </summary> |
| | | 371 | | /// <returns>An enumerator for the 3D array.</returns> |
| | | 372 | | public IEnumerator<T> GetEnumerator() |
| | | 373 | | { |
| | 58 | 374 | | for (int x = 0; x < Width; x++) |
| | | 375 | | { |
| | 116 | 376 | | for (int y = 0; y < Height; y++) |
| | | 377 | | { |
| | 286 | 378 | | for (int z = 0; z < Depth; z++) |
| | 103 | 379 | | yield return this[x, y, z]; |
| | | 380 | | } |
| | | 381 | | } |
| | 11 | 382 | | } |
| | | 383 | | |
| | | 384 | | /// <summary> |
| | | 385 | | /// Returns an enumerator that iterates through all elements in the 3D array (non-generic). |
| | | 386 | | /// </summary> |
| | | 387 | | /// <returns>An enumerator for the 3D array.</returns> |
| | 4 | 388 | | IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); |
| | | 389 | | |
| | | 390 | | |
| | | 391 | | #endregion |
| | | 392 | | } |