| | | 1 | | //======================================================================= |
| | | 2 | | // SwiftSparseSet.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.Runtime.CompilerServices; |
| | | 12 | | using System.Text.Json.Serialization; |
| | | 13 | | using Chronicler; |
| | | 14 | | using MemoryPack; |
| | | 15 | | using SwiftCollections.Diagnostics; |
| | | 16 | | using SwiftCollections.Utility; |
| | | 17 | | |
| | | 18 | | namespace SwiftCollections; |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// Represents a high-performance sparse set for externally supplied non-negative integer IDs. |
| | | 22 | | /// Provides O(1) Add, Remove, Contains, and densely packed iteration. |
| | | 23 | | /// </summary> |
| | | 24 | | /// <remarks> |
| | | 25 | | /// <para> |
| | | 26 | | /// <see cref="SwiftSparseSet"/> is intended for membership workloads where the caller already owns |
| | | 27 | | /// compact integer IDs, such as entity handles, body IDs, or slot indices. |
| | | 28 | | /// </para> |
| | | 29 | | /// <para> |
| | | 30 | | /// Internally, IDs are stored in a dense array for cache-friendly iteration while a sparse lookup |
| | | 31 | | /// table maps each ID directly to its dense position. Removal uses swap-back, so iteration order is |
| | | 32 | | /// not stable. |
| | | 33 | | /// </para> |
| | | 34 | | /// <para> |
| | | 35 | | /// Memory usage scales with the highest stored ID rather than only the number of IDs. For arbitrary, |
| | | 36 | | /// huge, or widely spaced keys, prefer <see cref="SwiftHashSet{T}"/> with <c>int</c> keys. |
| | | 37 | | /// </para> |
| | | 38 | | /// </remarks> |
| | | 39 | | [Serializable] |
| | | 40 | | [JsonConverter(typeof(StateJsonConverterFactory))] |
| | | 41 | | [MemoryPackable] |
| | | 42 | | public sealed partial class SwiftSparseSet : IStateBacked<SwiftArrayState<int>>, ISwiftCloneable<int>, ISet<int>, IReadO |
| | | 43 | | { |
| | | 44 | | #region Constants |
| | | 45 | | |
| | | 46 | | /// <summary> |
| | | 47 | | /// Represents the default initial capacity for dense ID storage. |
| | | 48 | | /// </summary> |
| | | 49 | | public const int DefaultDenseCapacity = 8; |
| | | 50 | | |
| | | 51 | | /// <summary> |
| | | 52 | | /// Represents the default initial capacity for sparse ID lookup. |
| | | 53 | | /// </summary> |
| | | 54 | | public const int DefaultSparseCapacity = 8; |
| | | 55 | | |
| | | 56 | | private const int NotPresent = 0; |
| | | 57 | | |
| | | 58 | | #endregion |
| | | 59 | | |
| | | 60 | | #region Fields |
| | | 61 | | |
| | | 62 | | private int[] _sparse; // id -> denseIndex+1 |
| | | 63 | | private int[] _denseKeys; // denseIndex -> id |
| | | 64 | | private int _count; |
| | | 65 | | |
| | | 66 | | [NonSerialized] |
| | | 67 | | private uint _version; |
| | | 68 | | |
| | | 69 | | [NonSerialized] |
| | | 70 | | private object? _syncRoot; |
| | | 71 | | |
| | | 72 | | #endregion |
| | | 73 | | |
| | | 74 | | #region Constructors |
| | | 75 | | |
| | | 76 | | /// <summary> |
| | | 77 | | /// Initializes a new instance of the <see cref="SwiftSparseSet"/> class with default sparse and dense capacities. |
| | | 78 | | /// </summary> |
| | 80 | 79 | | public SwiftSparseSet() : this(DefaultSparseCapacity, DefaultDenseCapacity) { } |
| | | 80 | | |
| | | 81 | | /// <summary> |
| | | 82 | | /// Initializes a new instance of the <see cref="SwiftSparseSet"/> class with matching sparse and dense capacities. |
| | | 83 | | /// </summary> |
| | | 84 | | /// <param name="capacity">The initial sparse and dense capacity.</param> |
| | 2 | 85 | | public SwiftSparseSet(int capacity) : this(capacity, capacity) { } |
| | | 86 | | |
| | | 87 | | /// <summary> |
| | | 88 | | /// Initializes a new instance of the <see cref="SwiftSparseSet"/> class with explicit sparse and dense capacities. |
| | | 89 | | /// </summary> |
| | | 90 | | /// <param name="sparseCapacity"> |
| | | 91 | | /// Initial sparse lookup capacity. This should track the highest expected ID plus one, |
| | | 92 | | /// not just the number of stored IDs. |
| | | 93 | | /// </param> |
| | | 94 | | /// <param name="denseCapacity">Initial dense storage capacity for IDs.</param> |
| | 45 | 95 | | public SwiftSparseSet(int sparseCapacity, int denseCapacity) |
| | | 96 | | { |
| | 45 | 97 | | SwiftThrowHelper.ThrowIfNegative(sparseCapacity, nameof(sparseCapacity)); |
| | 45 | 98 | | SwiftThrowHelper.ThrowIfNegative(denseCapacity, nameof(denseCapacity)); |
| | | 99 | | |
| | 45 | 100 | | int sparseSize = sparseCapacity == 0 ? 0 : SwiftHashTools.NextPowerOfTwo(sparseCapacity); |
| | 45 | 101 | | _sparse = sparseCapacity == 0 |
| | 45 | 102 | | ? Array.Empty<int>() |
| | 45 | 103 | | : new int[sparseSize]; |
| | | 104 | | |
| | 45 | 105 | | int denseSize = denseCapacity < DefaultDenseCapacity |
| | 45 | 106 | | ? DefaultDenseCapacity |
| | 45 | 107 | | : SwiftHashTools.NextPowerOfTwo(denseCapacity); |
| | 45 | 108 | | _denseKeys = denseCapacity == 0 |
| | 45 | 109 | | ? Array.Empty<int>() |
| | 45 | 110 | | : new int[denseSize]; |
| | 45 | 111 | | } |
| | | 112 | | |
| | | 113 | | /// <summary> |
| | | 114 | | /// Initializes a new instance of the <see cref="SwiftSparseSet"/> class using the specified state. |
| | | 115 | | /// </summary> |
| | | 116 | | /// <param name="state">The state object that provides the initial IDs. Cannot be null.</param> |
| | | 117 | | [MemoryPackConstructor] |
| | 5 | 118 | | public SwiftSparseSet(SwiftArrayState<int> state) |
| | | 119 | | { |
| | 5 | 120 | | _sparse = Array.Empty<int>(); |
| | 5 | 121 | | _denseKeys = Array.Empty<int>(); |
| | | 122 | | |
| | 5 | 123 | | State = state; |
| | 3 | 124 | | } |
| | | 125 | | |
| | | 126 | | #endregion |
| | | 127 | | |
| | | 128 | | #region Properties |
| | | 129 | | |
| | | 130 | | /// <summary> |
| | | 131 | | /// Gets the number of IDs contained in the set. |
| | | 132 | | /// </summary> |
| | | 133 | | [JsonIgnore] |
| | | 134 | | [MemoryPackIgnore] |
| | 4 | 135 | | public int Count => _count; |
| | | 136 | | |
| | | 137 | | /// <summary> |
| | | 138 | | /// Capacity of the dense ID storage. |
| | | 139 | | /// </summary> |
| | | 140 | | [JsonIgnore] |
| | | 141 | | [MemoryPackIgnore] |
| | 9 | 142 | | public int DenseCapacity => _denseKeys.Length; |
| | | 143 | | |
| | | 144 | | /// <summary> |
| | | 145 | | /// Capacity of the sparse lookup table. |
| | | 146 | | /// </summary> |
| | | 147 | | [JsonIgnore] |
| | | 148 | | [MemoryPackIgnore] |
| | 9 | 149 | | public int SparseCapacity => _sparse.Length; |
| | | 150 | | |
| | | 151 | | /// <inheritdoc/> |
| | | 152 | | [JsonIgnore] |
| | | 153 | | [MemoryPackIgnore] |
| | 1 | 154 | | public bool IsReadOnly => false; |
| | | 155 | | |
| | | 156 | | /// <summary> |
| | | 157 | | /// Gets a value indicating whether access to the collection is synchronized. |
| | | 158 | | /// </summary> |
| | | 159 | | [JsonIgnore] |
| | | 160 | | [MemoryPackIgnore] |
| | 1 | 161 | | public bool IsSynchronized => false; |
| | | 162 | | |
| | | 163 | | /// <summary> |
| | | 164 | | /// Gets an object that can be used to synchronize access to the collection. |
| | | 165 | | /// </summary> |
| | | 166 | | [JsonIgnore] |
| | | 167 | | [MemoryPackIgnore] |
| | 3 | 168 | | public object SyncRoot => _syncRoot ??= new object(); |
| | | 169 | | |
| | | 170 | | /// <summary> |
| | | 171 | | /// Returns the dense ID array. Only the range [0..Count) is populated. |
| | | 172 | | /// </summary> |
| | | 173 | | /// <remarks> |
| | | 174 | | /// Prefer collection APIs. Direct key mutation must preserve the dense/sparse lookup invariants; invalid edits may |
| | | 175 | | /// </remarks> |
| | | 176 | | [JsonIgnore] |
| | | 177 | | [MemoryPackIgnore] |
| | 4 | 178 | | public int[] DenseKeys => _denseKeys; |
| | | 179 | | |
| | | 180 | | /// <summary> |
| | | 181 | | /// Gets a span containing the current IDs in dense iteration order. |
| | | 182 | | /// </summary> |
| | | 183 | | /// <remarks> |
| | | 184 | | /// Prefer collection APIs. Direct key mutation must preserve the dense/sparse lookup invariants; invalid edits may |
| | | 185 | | /// </remarks> |
| | | 186 | | [JsonIgnore] |
| | | 187 | | [MemoryPackIgnore] |
| | 3 | 188 | | public Span<int> Keys => _denseKeys.AsSpan(0, _count); |
| | | 189 | | |
| | | 190 | | /// <summary> |
| | | 191 | | /// Gets or sets the current state of the sparse set. |
| | | 192 | | /// </summary> |
| | | 193 | | [JsonInclude] |
| | | 194 | | [MemoryPackInclude] |
| | | 195 | | public SwiftArrayState<int> State |
| | | 196 | | { |
| | | 197 | | get |
| | | 198 | | { |
| | 2 | 199 | | var items = new int[_count]; |
| | 2 | 200 | | Array.Copy(_denseKeys, items, _count); |
| | 2 | 201 | | return new SwiftArrayState<int>(items); |
| | | 202 | | } |
| | | 203 | | internal set |
| | | 204 | | { |
| | 5 | 205 | | SwiftThrowHelper.ThrowIfNull(value.Items, nameof(value.Items)); |
| | | 206 | | |
| | 5 | 207 | | RestoreDenseKeys(value.Items); |
| | 5 | 208 | | int maxKey = ValidateDenseKeys(nameof(value.Items)); |
| | 4 | 209 | | RestoreSparseLookup(maxKey, nameof(value)); |
| | | 210 | | |
| | 3 | 211 | | _version++; |
| | 3 | 212 | | } |
| | | 213 | | } |
| | | 214 | | |
| | | 215 | | private void RestoreDenseKeys(int[] items) |
| | | 216 | | { |
| | 5 | 217 | | int count = items.Length; |
| | 5 | 218 | | _denseKeys = count == 0 |
| | 5 | 219 | | ? Array.Empty<int>() |
| | 5 | 220 | | : new int[Math.Max(DefaultDenseCapacity, SwiftHashTools.NextPowerOfTwo(count))]; |
| | | 221 | | |
| | 5 | 222 | | if (count > 0) |
| | 4 | 223 | | Array.Copy(items, _denseKeys, count); |
| | | 224 | | |
| | 5 | 225 | | _count = count; |
| | 5 | 226 | | } |
| | | 227 | | |
| | | 228 | | private int ValidateDenseKeys(string paramName) |
| | | 229 | | { |
| | 5 | 230 | | int maxKey = -1; |
| | 20 | 231 | | for (int i = 0; i < _count; i++) |
| | | 232 | | { |
| | 6 | 233 | | int key = _denseKeys[i]; |
| | 6 | 234 | | SwiftThrowHelper.ThrowIfNegative(key, paramName); |
| | 5 | 235 | | SwiftThrowHelper.ThrowIfArgumentOutOfRange(key == int.MaxValue, key, paramName, "ID is too large for direct |
| | | 236 | | |
| | 5 | 237 | | if (key > maxKey) |
| | 4 | 238 | | maxKey = key; |
| | | 239 | | } |
| | | 240 | | |
| | 4 | 241 | | return maxKey; |
| | | 242 | | } |
| | | 243 | | |
| | | 244 | | private void RestoreSparseLookup(int maxKey, string paramName) |
| | | 245 | | { |
| | 4 | 246 | | int sparseSize = maxKey < 0 |
| | 4 | 247 | | ? DefaultSparseCapacity |
| | 4 | 248 | | : Math.Max(DefaultSparseCapacity, GetRequiredSparseCapacity(maxKey)); |
| | 4 | 249 | | _sparse = new int[sparseSize]; |
| | | 250 | | |
| | 16 | 251 | | for (int i = 0; i < _count; i++) |
| | | 252 | | { |
| | 5 | 253 | | int key = _denseKeys[i]; |
| | 5 | 254 | | SwiftThrowHelper.ThrowIfArgument(_sparse[key] != NotPresent, paramName, "Duplicate ID in sparse set state.") |
| | 4 | 255 | | _sparse[key] = i + 1; |
| | | 256 | | } |
| | 3 | 257 | | } |
| | | 258 | | |
| | | 259 | | #endregion |
| | | 260 | | |
| | | 261 | | #region Core Operations |
| | | 262 | | |
| | | 263 | | /// <summary> |
| | | 264 | | /// Determines whether the set contains the specified ID. |
| | | 265 | | /// </summary> |
| | | 266 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 267 | | public bool Contains(int item) |
| | | 268 | | { |
| | 52 | 269 | | if ((uint)item >= (uint)_sparse.Length) return false; |
| | 42 | 270 | | return _sparse[item] != NotPresent; |
| | | 271 | | } |
| | | 272 | | |
| | | 273 | | /// <summary> |
| | | 274 | | /// Determines whether the set contains the specified key. Alias for <see cref="Contains(int)"/>. |
| | | 275 | | /// </summary> |
| | | 276 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | 5 | 277 | | public bool ContainsKey(int key) => Contains(key); |
| | | 278 | | |
| | | 279 | | /// <summary> |
| | | 280 | | /// Adds the specified ID if it is not already present. |
| | | 281 | | /// </summary> |
| | | 282 | | /// <returns>true if the ID was added; false if it was already present.</returns> |
| | | 283 | | public bool Add(int item) |
| | | 284 | | { |
| | 92 | 285 | | EnsureSparseCapacity(GetRequiredSparseCapacity(item)); |
| | 90 | 286 | | if (_sparse[item] != NotPresent) |
| | 1 | 287 | | return false; |
| | | 288 | | |
| | 89 | 289 | | EnsureDenseCapacity(_count + 1); |
| | | 290 | | |
| | 89 | 291 | | int newIndex = _count++; |
| | 89 | 292 | | _denseKeys[newIndex] = item; |
| | 89 | 293 | | _sparse[item] = newIndex + 1; |
| | | 294 | | |
| | 89 | 295 | | _version++; |
| | 89 | 296 | | return true; |
| | | 297 | | } |
| | | 298 | | |
| | | 299 | | /// <summary> |
| | | 300 | | /// Adds the specified ID if it is not already present. |
| | | 301 | | /// </summary> |
| | 1 | 302 | | public bool TryAdd(int item) => Add(item); |
| | | 303 | | |
| | 1 | 304 | | void ICollection<int>.Add(int item) => Add(item); |
| | | 305 | | |
| | | 306 | | /// <summary> |
| | | 307 | | /// Removes the specified ID from the set. |
| | | 308 | | /// </summary> |
| | | 309 | | /// <returns>true if the ID was found and removed; otherwise, false.</returns> |
| | | 310 | | public bool Remove(int item) |
| | | 311 | | { |
| | 24 | 312 | | if ((uint)item >= (uint)_sparse.Length) return false; |
| | | 313 | | |
| | 18 | 314 | | int slot = _sparse[item]; |
| | 22 | 315 | | if (slot == NotPresent) return false; |
| | | 316 | | |
| | 14 | 317 | | int index = slot - 1; |
| | 14 | 318 | | int last = --_count; |
| | | 319 | | |
| | 14 | 320 | | _sparse[item] = NotPresent; |
| | | 321 | | |
| | 14 | 322 | | if (index != last) |
| | | 323 | | { |
| | 12 | 324 | | int movedKey = _denseKeys[last]; |
| | 12 | 325 | | _denseKeys[index] = movedKey; |
| | 12 | 326 | | _sparse[movedKey] = index + 1; |
| | | 327 | | } |
| | | 328 | | |
| | 14 | 329 | | _denseKeys[last] = default; |
| | 14 | 330 | | _version++; |
| | 14 | 331 | | return true; |
| | | 332 | | } |
| | | 333 | | |
| | | 334 | | /// <summary> |
| | | 335 | | /// Removes all IDs from the set without reducing capacity. |
| | | 336 | | /// </summary> |
| | | 337 | | public void Clear() |
| | | 338 | | { |
| | 5 | 339 | | if (_count == 0) return; |
| | | 340 | | |
| | 18 | 341 | | for (int i = 0; i < _count; i++) |
| | | 342 | | { |
| | 6 | 343 | | int key = _denseKeys[i]; |
| | 6 | 344 | | _sparse[key] = NotPresent; |
| | 6 | 345 | | _denseKeys[i] = default; |
| | | 346 | | } |
| | | 347 | | |
| | 3 | 348 | | _count = 0; |
| | 3 | 349 | | _version++; |
| | 3 | 350 | | } |
| | | 351 | | |
| | | 352 | | #endregion |
| | | 353 | | |
| | | 354 | | #region Set Operations |
| | | 355 | | |
| | | 356 | | /// <inheritdoc/> |
| | | 357 | | public void ExceptWith(IEnumerable<int> other) |
| | | 358 | | { |
| | 3 | 359 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 360 | | |
| | 4 | 361 | | if (_count == 0) return; |
| | 2 | 362 | | if (ReferenceEquals(other, this)) |
| | | 363 | | { |
| | 1 | 364 | | Clear(); |
| | 1 | 365 | | return; |
| | | 366 | | } |
| | | 367 | | |
| | 6 | 368 | | foreach (int item in other) |
| | 2 | 369 | | Remove(item); |
| | 1 | 370 | | } |
| | | 371 | | |
| | | 372 | | /// <inheritdoc/> |
| | | 373 | | public void IntersectWith(IEnumerable<int> other) |
| | | 374 | | { |
| | 5 | 375 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 376 | | |
| | 7 | 377 | | if (_count == 0 || ReferenceEquals(other, this)) return; |
| | | 378 | | |
| | 3 | 379 | | if (other is SwiftSparseSet sparseSet) |
| | | 380 | | { |
| | 1 | 381 | | RemoveWhereMissingFrom(sparseSet); |
| | 1 | 382 | | return; |
| | | 383 | | } |
| | | 384 | | |
| | 2 | 385 | | if (other is ISet<int> set) |
| | | 386 | | { |
| | 1 | 387 | | RemoveWhereMissingFrom(set); |
| | 1 | 388 | | return; |
| | | 389 | | } |
| | | 390 | | |
| | 1 | 391 | | RemoveWhereMissingFrom(new HashSet<int>(other)); |
| | 1 | 392 | | } |
| | | 393 | | |
| | | 394 | | /// <inheritdoc/> |
| | | 395 | | public bool IsProperSubsetOf(IEnumerable<int> other) |
| | | 396 | | { |
| | 6 | 397 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 398 | | |
| | 6 | 399 | | if (other is SwiftSparseSet sparseSet) |
| | 2 | 400 | | return _count < sparseSet._count && IsSubsetOf(sparseSet); |
| | | 401 | | |
| | 4 | 402 | | if (other is ISet<int> set) |
| | 2 | 403 | | return _count < set.Count && IsSubsetOf(set); |
| | | 404 | | |
| | 2 | 405 | | var lookup = new HashSet<int>(other); |
| | 2 | 406 | | return _count < lookup.Count && IsSubsetOf(lookup); |
| | | 407 | | } |
| | | 408 | | |
| | | 409 | | /// <inheritdoc/> |
| | | 410 | | public bool IsProperSupersetOf(IEnumerable<int> other) |
| | | 411 | | { |
| | 6 | 412 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 413 | | |
| | 6 | 414 | | if (other is SwiftSparseSet sparseSet) |
| | 2 | 415 | | return _count > sparseSet._count && IsSupersetOf(sparseSet); |
| | | 416 | | |
| | 4 | 417 | | if (other is ISet<int> set) |
| | 2 | 418 | | return _count > set.Count && IsSupersetOf(set); |
| | | 419 | | |
| | 2 | 420 | | var lookup = new HashSet<int>(other); |
| | 2 | 421 | | return _count > lookup.Count && IsSupersetOf(lookup); |
| | | 422 | | } |
| | | 423 | | |
| | | 424 | | /// <inheritdoc/> |
| | | 425 | | public bool IsSubsetOf(IEnumerable<int> other) |
| | | 426 | | { |
| | 10 | 427 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 428 | | |
| | 12 | 429 | | if (_count == 0 || ReferenceEquals(other, this)) return true; |
| | | 430 | | |
| | 8 | 431 | | if (other is SwiftSparseSet sparseSet) |
| | 3 | 432 | | return IsSubsetOfSparseSet(sparseSet); |
| | | 433 | | |
| | 5 | 434 | | if (other is ISet<int> set) |
| | 4 | 435 | | return IsSubsetOfSet(set); |
| | | 436 | | |
| | 1 | 437 | | return IsSubsetOfSet(new HashSet<int>(other)); |
| | | 438 | | } |
| | | 439 | | |
| | | 440 | | /// <inheritdoc/> |
| | | 441 | | public bool IsSupersetOf(IEnumerable<int> other) |
| | | 442 | | { |
| | 6 | 443 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 444 | | |
| | 7 | 445 | | if (ReferenceEquals(other, this)) return true; |
| | | 446 | | |
| | 29 | 447 | | foreach (int item in other) |
| | | 448 | | { |
| | 10 | 449 | | if (!Contains(item)) |
| | 1 | 450 | | return false; |
| | | 451 | | } |
| | | 452 | | |
| | 4 | 453 | | return true; |
| | 1 | 454 | | } |
| | | 455 | | |
| | | 456 | | /// <inheritdoc/> |
| | | 457 | | public bool Overlaps(IEnumerable<int> other) |
| | | 458 | | { |
| | 2 | 459 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 460 | | |
| | 9 | 461 | | foreach (int item in other) |
| | | 462 | | { |
| | 3 | 463 | | if (Contains(item)) |
| | 1 | 464 | | return true; |
| | | 465 | | } |
| | | 466 | | |
| | 1 | 467 | | return false; |
| | 1 | 468 | | } |
| | | 469 | | |
| | | 470 | | /// <inheritdoc/> |
| | | 471 | | public bool SetEquals(IEnumerable<int> other) |
| | | 472 | | { |
| | 16 | 473 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 474 | | |
| | 17 | 475 | | if (ReferenceEquals(other, this)) return true; |
| | | 476 | | |
| | 15 | 477 | | if (other is SwiftSparseSet sparseSet) |
| | 4 | 478 | | return SetEqualsSparseSet(sparseSet); |
| | | 479 | | |
| | 11 | 480 | | if (other is ISet<int> set) |
| | 4 | 481 | | return SetEqualsSet(set); |
| | | 482 | | |
| | 7 | 483 | | return SetEqualsSet(new HashSet<int>(other)); |
| | | 484 | | } |
| | | 485 | | |
| | | 486 | | /// <inheritdoc/> |
| | | 487 | | public void SymmetricExceptWith(IEnumerable<int> other) |
| | | 488 | | { |
| | 5 | 489 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 490 | | |
| | 5 | 491 | | if (ReferenceEquals(other, this)) |
| | | 492 | | { |
| | 1 | 493 | | Clear(); |
| | 1 | 494 | | return; |
| | | 495 | | } |
| | | 496 | | |
| | 4 | 497 | | if (other is SwiftSparseSet sparseSet) |
| | | 498 | | { |
| | 1 | 499 | | SymmetricExceptWithSet(sparseSet); |
| | 1 | 500 | | return; |
| | | 501 | | } |
| | | 502 | | |
| | 3 | 503 | | if (other is ISet<int> set) |
| | | 504 | | { |
| | 1 | 505 | | SymmetricExceptWithSet(set); |
| | 1 | 506 | | return; |
| | | 507 | | } |
| | | 508 | | |
| | 2 | 509 | | SymmetricExceptWithSet(new HashSet<int>(other)); |
| | 2 | 510 | | } |
| | | 511 | | |
| | | 512 | | /// <inheritdoc/> |
| | | 513 | | public void UnionWith(IEnumerable<int> other) |
| | | 514 | | { |
| | 1 | 515 | | SwiftThrowHelper.ThrowIfNull(other, nameof(other)); |
| | | 516 | | |
| | 6 | 517 | | foreach (int item in other) |
| | 2 | 518 | | Add(item); |
| | 1 | 519 | | } |
| | | 520 | | |
| | | 521 | | private void RemoveWhereMissingFrom(SwiftSparseSet other) |
| | | 522 | | { |
| | 1 | 523 | | int index = 0; |
| | 4 | 524 | | while (index < _count) |
| | | 525 | | { |
| | 3 | 526 | | int key = _denseKeys[index]; |
| | 3 | 527 | | if (other.Contains(key)) |
| | 2 | 528 | | index++; |
| | | 529 | | else |
| | 1 | 530 | | Remove(key); |
| | | 531 | | } |
| | 1 | 532 | | } |
| | | 533 | | |
| | | 534 | | private void RemoveWhereMissingFrom(ISet<int> other) |
| | | 535 | | { |
| | 2 | 536 | | int index = 0; |
| | 9 | 537 | | while (index < _count) |
| | | 538 | | { |
| | 7 | 539 | | int key = _denseKeys[index]; |
| | 7 | 540 | | if (other.Contains(key)) |
| | 4 | 541 | | index++; |
| | | 542 | | else |
| | 3 | 543 | | Remove(key); |
| | | 544 | | } |
| | 2 | 545 | | } |
| | | 546 | | |
| | | 547 | | private bool AllKeysIn(SwiftSparseSet other) |
| | | 548 | | { |
| | 28 | 549 | | for (int i = 0; i < _count; i++) |
| | | 550 | | { |
| | 10 | 551 | | if (!other.Contains(_denseKeys[i])) |
| | 1 | 552 | | return false; |
| | | 553 | | } |
| | | 554 | | |
| | 4 | 555 | | return true; |
| | | 556 | | } |
| | | 557 | | |
| | | 558 | | private bool AllKeysIn(ISet<int> other) |
| | | 559 | | { |
| | 82 | 560 | | for (int i = 0; i < _count; i++) |
| | | 561 | | { |
| | 30 | 562 | | if (!other.Contains(_denseKeys[i])) |
| | 3 | 563 | | return false; |
| | | 564 | | } |
| | | 565 | | |
| | 11 | 566 | | return true; |
| | | 567 | | } |
| | | 568 | | |
| | | 569 | | private bool IsSubsetOfSparseSet(SwiftSparseSet other) => |
| | 3 | 570 | | _count <= other._count && AllKeysIn(other); |
| | | 571 | | |
| | | 572 | | private bool IsSubsetOfSet(ISet<int> other) => |
| | 5 | 573 | | _count <= other.Count && AllKeysIn(other); |
| | | 574 | | |
| | | 575 | | private bool SetEqualsSparseSet(SwiftSparseSet other) => |
| | 4 | 576 | | _count == other._count && AllKeysIn(other); |
| | | 577 | | |
| | | 578 | | private bool SetEqualsSet(ISet<int> other) => |
| | 11 | 579 | | _count == other.Count && AllKeysIn(other); |
| | | 580 | | |
| | | 581 | | private void SymmetricExceptWithSet(IEnumerable<int> other) |
| | | 582 | | { |
| | 26 | 583 | | foreach (int item in other) |
| | | 584 | | { |
| | 9 | 585 | | if (!Remove(item)) |
| | 4 | 586 | | Add(item); |
| | | 587 | | } |
| | 4 | 588 | | } |
| | | 589 | | |
| | | 590 | | #endregion |
| | | 591 | | |
| | | 592 | | #region Capacity Management |
| | | 593 | | |
| | | 594 | | /// <summary> |
| | | 595 | | /// Ensures that dense storage can hold at least the specified number of IDs. |
| | | 596 | | /// </summary> |
| | | 597 | | public void EnsureDenseCapacity(int capacity) |
| | | 598 | | { |
| | 179 | 599 | | if (capacity <= _denseKeys.Length) return; |
| | | 600 | | |
| | 3 | 601 | | int newCap = _denseKeys.Length == 0 ? DefaultDenseCapacity : _denseKeys.Length * 2; |
| | 5 | 602 | | if (newCap < capacity) newCap = capacity; |
| | | 603 | | |
| | 3 | 604 | | newCap = SwiftHashTools.NextPowerOfTwo(newCap); |
| | | 605 | | |
| | 3 | 606 | | var newKeys = new int[newCap]; |
| | 3 | 607 | | if (_count > 0) |
| | 1 | 608 | | Array.Copy(_denseKeys, newKeys, _count); |
| | | 609 | | |
| | 3 | 610 | | _denseKeys = newKeys; |
| | 3 | 611 | | _version++; |
| | 3 | 612 | | } |
| | | 613 | | |
| | | 614 | | /// <summary> |
| | | 615 | | /// Ensures that the sparse lookup table has at least the specified capacity. |
| | | 616 | | /// </summary> |
| | | 617 | | public void EnsureSparseCapacity(int capacity) |
| | | 618 | | { |
| | 174 | 619 | | if (capacity <= _sparse.Length) return; |
| | | 620 | | |
| | 8 | 621 | | int newCap = _sparse.Length == 0 |
| | 8 | 622 | | ? DefaultSparseCapacity |
| | 8 | 623 | | : _sparse.Length * 2; |
| | 10 | 624 | | if (newCap < capacity) newCap = capacity; |
| | | 625 | | |
| | 8 | 626 | | newCap = SwiftHashTools.NextPowerOfTwo(newCap); |
| | | 627 | | |
| | 8 | 628 | | var newSparse = new int[newCap]; |
| | 8 | 629 | | if (_sparse.Length > 0) |
| | 7 | 630 | | Array.Copy(_sparse, newSparse, _sparse.Length); |
| | | 631 | | |
| | 8 | 632 | | _sparse = newSparse; |
| | 8 | 633 | | _version++; |
| | 8 | 634 | | } |
| | | 635 | | |
| | | 636 | | /// <summary> |
| | | 637 | | /// Reduces unused dense and sparse capacity while preserving all IDs. |
| | | 638 | | /// </summary> |
| | | 639 | | public void TrimExcess() |
| | | 640 | | { |
| | 5 | 641 | | TrimDenseStorage(); |
| | 5 | 642 | | TrimSparseLookup(); |
| | 5 | 643 | | _version++; |
| | 5 | 644 | | } |
| | | 645 | | |
| | | 646 | | private void TrimDenseStorage() |
| | | 647 | | { |
| | 5 | 648 | | int newDense = Math.Max(DefaultDenseCapacity, _count); |
| | 7 | 649 | | if (newDense >= _denseKeys.Length) return; |
| | | 650 | | |
| | 3 | 651 | | var newKeys = new int[newDense]; |
| | 3 | 652 | | if (_count > 0) |
| | 2 | 653 | | Array.Copy(_denseKeys, newKeys, _count); |
| | 3 | 654 | | _denseKeys = newKeys; |
| | 3 | 655 | | } |
| | | 656 | | |
| | | 657 | | private void TrimSparseLookup() |
| | | 658 | | { |
| | 5 | 659 | | int maxKey = -1; |
| | 20 | 660 | | for (int i = 0; i < _count; i++) |
| | 8 | 661 | | if (_denseKeys[i] > maxKey) maxKey = _denseKeys[i]; |
| | | 662 | | |
| | 5 | 663 | | int newSparse = maxKey < 0 |
| | 5 | 664 | | ? DefaultSparseCapacity |
| | 5 | 665 | | : Math.Max(DefaultSparseCapacity, GetRequiredSparseCapacity(maxKey)); |
| | 7 | 666 | | if (newSparse >= _sparse.Length) return; |
| | | 667 | | |
| | 3 | 668 | | var newMap = new int[newSparse]; |
| | 12 | 669 | | for (int i = 0; i < _count; i++) |
| | 3 | 670 | | newMap[_denseKeys[i]] = i + 1; |
| | 3 | 671 | | _sparse = newMap; |
| | 3 | 672 | | } |
| | | 673 | | |
| | | 674 | | #endregion |
| | | 675 | | |
| | | 676 | | #region Copy and Enumeration |
| | | 677 | | |
| | | 678 | | /// <summary> |
| | | 679 | | /// Returns a read-only span over the populated dense ID range. |
| | | 680 | | /// </summary> |
| | 1 | 681 | | public ReadOnlySpan<int> AsReadOnlySpan() => _denseKeys.AsSpan(0, _count); |
| | | 682 | | |
| | | 683 | | /// <summary> |
| | | 684 | | /// Retrieves the backing dense ID array and current count. |
| | | 685 | | /// </summary> |
| | | 686 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 687 | | public void GetDense(out int[] keys, out int count) |
| | | 688 | | { |
| | 1 | 689 | | keys = _denseKeys; |
| | 1 | 690 | | count = _count; |
| | 1 | 691 | | } |
| | | 692 | | |
| | | 693 | | /// <summary> |
| | | 694 | | /// Replaces the destination list contents with this set's keys in dense iteration order. |
| | | 695 | | /// </summary> |
| | | 696 | | /// <remarks> |
| | | 697 | | /// The destination list is reused and only grows when its current capacity is smaller than |
| | | 698 | | /// <see cref="Count"/>. Use <see cref="CopySortedKeysTo(SwiftList{int})"/> when stable ascending |
| | | 699 | | /// key order is required. |
| | | 700 | | /// </remarks> |
| | | 701 | | /// <param name="destination">The caller-owned list that receives the keys.</param> |
| | | 702 | | public void CopyKeysTo(SwiftList<int> destination) |
| | | 703 | | { |
| | 4 | 704 | | SwiftThrowHelper.ThrowIfNull(destination, nameof(destination)); |
| | | 705 | | |
| | 4 | 706 | | destination.FastClear(); |
| | 4 | 707 | | destination.AddRange(_denseKeys.AsSpan(0, _count)); |
| | 4 | 708 | | } |
| | | 709 | | |
| | | 710 | | /// <summary> |
| | | 711 | | /// Replaces the destination list contents with this set's keys sorted in ascending order. |
| | | 712 | | /// </summary> |
| | | 713 | | /// <remarks> |
| | | 714 | | /// This method is intended for reusable hot-path scratch buffers that need deterministic key order |
| | | 715 | | /// without constructing a persistent sorted collection. |
| | | 716 | | /// </remarks> |
| | | 717 | | /// <param name="destination">The caller-owned list that receives the sorted keys.</param> |
| | | 718 | | public void CopySortedKeysTo(SwiftList<int> destination) |
| | | 719 | | { |
| | 3 | 720 | | CopyKeysTo(destination); |
| | 3 | 721 | | destination.SortInPlace(default(SwiftIntAscendingComparer)); |
| | 3 | 722 | | } |
| | | 723 | | |
| | | 724 | | /// <inheritdoc/> |
| | | 725 | | public void CopyTo(int[] array, int arrayIndex) |
| | | 726 | | { |
| | 3 | 727 | | SwiftThrowHelper.ThrowIfNull(array, nameof(array)); |
| | 3 | 728 | | SwiftThrowHelper.ThrowIfArrayIndexInvalid(arrayIndex, array.Length); |
| | 3 | 729 | | SwiftThrowHelper.ThrowIfArgument(array.Length - arrayIndex < _count, nameof(array), "The array is not large enou |
| | | 730 | | |
| | 3 | 731 | | Array.Copy(_denseKeys, 0, array, arrayIndex, _count); |
| | 3 | 732 | | } |
| | | 733 | | |
| | | 734 | | /// <inheritdoc/> |
| | | 735 | | void ICollection.CopyTo(Array array, int index) |
| | | 736 | | { |
| | 8 | 737 | | SwiftThrowHelper.ThrowIfNull(array, nameof(array)); |
| | 8 | 738 | | SwiftThrowHelper.ThrowIfArgument(array.Rank != 1, nameof(array), "Only single dimensional arrays are supported." |
| | 7 | 739 | | SwiftThrowHelper.ThrowIfArgument(array.GetLowerBound(0) != 0, nameof(array), "Non-zero lower bound arrays are no |
| | 6 | 740 | | SwiftThrowHelper.ThrowIfArrayIndexInvalid(index, array.Length, nameof(index)); |
| | 5 | 741 | | SwiftThrowHelper.ThrowIfArgument(array.Length - index < _count, nameof(array), "The array is not large enough to |
| | | 742 | | |
| | 4 | 743 | | if (array is int[] intArray) |
| | | 744 | | { |
| | 1 | 745 | | CopyTo(intArray, index); |
| | 1 | 746 | | return; |
| | | 747 | | } |
| | | 748 | | |
| | 3 | 749 | | Type elementType = array.GetType().GetElementType()!; |
| | 3 | 750 | | if (array is object[] objects && elementType.IsAssignableFrom(typeof(int))) |
| | | 751 | | { |
| | 6 | 752 | | for (int i = 0; i < _count; i++) |
| | 2 | 753 | | objects[index + i] = _denseKeys[i]; |
| | 1 | 754 | | return; |
| | | 755 | | } |
| | | 756 | | |
| | 2 | 757 | | throw new ArgumentException("Invalid array type.", nameof(array)); |
| | | 758 | | } |
| | | 759 | | |
| | | 760 | | /// <inheritdoc/> |
| | | 761 | | public void CloneTo(ICollection<int> output) |
| | | 762 | | { |
| | 1 | 763 | | SwiftThrowHelper.ThrowIfNull(output, nameof(output)); |
| | | 764 | | |
| | 1 | 765 | | output.Clear(); |
| | | 766 | | |
| | 6 | 767 | | for (int i = 0; i < _count; i++) |
| | 2 | 768 | | output.Add(_denseKeys[i]); |
| | 1 | 769 | | } |
| | | 770 | | |
| | | 771 | | /// <inheritdoc cref="IEnumerable.GetEnumerator()"/> |
| | 18 | 772 | | public SwiftSparseSetEnumerator GetEnumerator() => new(this); |
| | 15 | 773 | | IEnumerator<int> IEnumerable<int>.GetEnumerator() => GetEnumerator(); |
| | 1 | 774 | | IEnumerator IEnumerable.GetEnumerator() => GetEnumerator(); |
| | | 775 | | |
| | | 776 | | /// <summary> |
| | | 777 | | /// Supports iteration over IDs in a <see cref="SwiftSparseSet"/>. |
| | | 778 | | /// </summary> |
| | | 779 | | public struct SwiftSparseSetEnumerator : IEnumerator<int> |
| | | 780 | | { |
| | | 781 | | private readonly SwiftSparseSet _set; |
| | | 782 | | private readonly int[] _keys; |
| | | 783 | | private readonly int _count; |
| | | 784 | | private readonly uint _version; |
| | | 785 | | private int _index; |
| | | 786 | | |
| | | 787 | | internal SwiftSparseSetEnumerator(SwiftSparseSet set) |
| | | 788 | | { |
| | 18 | 789 | | _set = set; |
| | 18 | 790 | | _keys = set._denseKeys; |
| | 18 | 791 | | _count = set._count; |
| | 18 | 792 | | _version = set._version; |
| | 18 | 793 | | _index = -1; |
| | 18 | 794 | | Current = default; |
| | 18 | 795 | | } |
| | | 796 | | |
| | | 797 | | /// <inheritdoc/> |
| | | 798 | | public int Current { get; private set; } |
| | 1 | 799 | | object IEnumerator.Current => Current; |
| | | 800 | | |
| | | 801 | | /// <inheritdoc/> |
| | | 802 | | public bool MoveNext() |
| | | 803 | | { |
| | 28 | 804 | | SwiftThrowHelper.ThrowIfTrue(_version != _set._version, message: "Collection was modified during enumeration |
| | | 805 | | |
| | 27 | 806 | | int next = _index + 1; |
| | 27 | 807 | | if (next >= _count) |
| | | 808 | | { |
| | 15 | 809 | | Current = default; |
| | 15 | 810 | | return false; |
| | | 811 | | } |
| | | 812 | | |
| | 12 | 813 | | _index = next; |
| | 12 | 814 | | Current = _keys[_index]; |
| | 12 | 815 | | return true; |
| | | 816 | | } |
| | | 817 | | |
| | | 818 | | /// <inheritdoc/> |
| | | 819 | | public void Reset() |
| | | 820 | | { |
| | 1 | 821 | | SwiftThrowHelper.ThrowIfTrue(_version != _set._version, message: "Collection was modified during enumeration |
| | | 822 | | |
| | 1 | 823 | | _index = -1; |
| | 1 | 824 | | Current = default; |
| | 1 | 825 | | } |
| | | 826 | | |
| | | 827 | | /// <inheritdoc/> |
| | 15 | 828 | | public void Dispose() => _index = -1; |
| | | 829 | | } |
| | | 830 | | |
| | | 831 | | #endregion |
| | | 832 | | |
| | | 833 | | #region Helpers |
| | | 834 | | |
| | | 835 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 836 | | private static int GetRequiredSparseCapacity(int key) |
| | | 837 | | { |
| | 98 | 838 | | SwiftThrowHelper.ThrowIfNegative(key, nameof(key)); |
| | 97 | 839 | | SwiftThrowHelper.ThrowIfArgumentOutOfRange(key == int.MaxValue, key, nameof(key), "ID is too large for direct sp |
| | | 840 | | |
| | 96 | 841 | | return key + 1; |
| | | 842 | | } |
| | | 843 | | |
| | | 844 | | #endregion |
| | | 845 | | } |