123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295 |
- using System;
- using System.Collections;
- using System.Collections.Generic;
- using System.Diagnostics;
- using System.Runtime.InteropServices;
- using Unity.Collections.LowLevel.Unsafe;
- using Unity.Jobs;
- using UnityEngine.Internal;
- using Unity.Burst;
-
- namespace Unity.Collections
- {
- /// <summary>
- /// An unordered, expandable set of unique values.
- /// </summary>
- /// <typeparam name="T">The type of the values.</typeparam>
- [StructLayout(LayoutKind.Sequential)]
- [DebuggerTypeProxy(typeof(NativeHashSetDebuggerTypeProxy<>))]
- [BurstCompatible(GenericTypeArguments = new [] { typeof(int) })]
- public unsafe struct NativeHashSet<T>
- : INativeDisposable
- , IEnumerable<T> // Used by collection initializers.
- where T : unmanaged, IEquatable<T>
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- internal static readonly SharedStatic<int> s_staticSafetyId = SharedStatic<int>.GetOrCreate<NativeHashSet<T>>();
- #endif
-
- internal NativeHashMap<T, bool> m_Data;
-
- /// <summary>
- /// Initializes and returns an instance of NativeHashSet.
- /// </summary>
- /// <param name="capacity">The number of values that should fit in the initial allocation.</param>
- /// <param name="allocator">The allocator to use.</param>
- public NativeHashSet(int capacity, AllocatorManager.AllocatorHandle allocator)
- {
- m_Data = new NativeHashMap<T, bool>(capacity, allocator);
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- CollectionHelper.SetStaticSafetyId<NativeHashSet<T>>(ref m_Data.m_Safety, ref s_staticSafetyId.Data);
- #endif
- }
-
- /// <summary>
- /// Whether this set is empty.
- /// </summary>
- /// <value>True if this set is empty or if the set has not been constructed.</value>
- public bool IsEmpty => m_Data.IsEmpty;
-
- /// <summary>
- /// Returns the current number of values in this set.
- /// </summary>
- /// <returns>The current number of values in this set.</returns>
- public int Count() => m_Data.Count();
-
- /// <summary>
- /// The number of values that fit in the current allocation.
- /// </summary>
- /// <value>The number of values that fit in the current allocation.</value>
- /// <param name="value">A new capacity. Must be larger than current capacity.</param>
- /// <exception cref="Exception">Thrown if `value` is less than the current capacity.</exception>
- public int Capacity { get => m_Data.Capacity; set => m_Data.Capacity = value; }
-
- /// <summary>
- /// Whether this set has been allocated (and not yet deallocated).
- /// </summary>
- /// <value>True if this set has been allocated (and not yet deallocated).</value>
- public bool IsCreated => m_Data.IsCreated;
-
- /// <summary>
- /// Releases all resources (memory and safety handles).
- /// </summary>
- public void Dispose() => m_Data.Dispose();
-
- /// <summary>
- /// Creates and schedules a job that will dispose this set.
- /// </summary>
- /// <param name="inputDeps">A job handle. The newly scheduled job will depend upon this handle.</param>
- /// <returns>The handle of a new job that will dispose this set.</returns>
- [NotBurstCompatible /* This is not burst compatible because of IJob's use of a static IntPtr. Should switch to IJobBurstSchedulable in the future */]
- public JobHandle Dispose(JobHandle inputDeps) => m_Data.Dispose(inputDeps);
-
- /// <summary>
- /// Removes all values.
- /// </summary>
- /// <remarks>Does not change the capacity.</remarks>
- public void Clear() => m_Data.Clear();
-
- /// <summary>
- /// Adds a new value (unless it is already present).
- /// </summary>
- /// <param name="item">The value to add.</param>
- /// <returns>True if the value was not already present.</returns>
- public bool Add(T item) => m_Data.TryAdd(item, false);
-
- /// <summary>
- /// Removes a particular value.
- /// </summary>
- /// <param name="item">The value to remove.</param>
- /// <returns>True if the value was present.</returns>
- public bool Remove(T item) => m_Data.Remove(item);
-
- /// <summary>
- /// Returns true if a particular value is present.
- /// </summary>
- /// <param name="item">The value to check for.</param>
- /// <returns>True if the value was present.</returns>
- public bool Contains(T item) => m_Data.ContainsKey(item);
-
- /// <summary>
- /// Returns an array with a copy of this set's values (in no particular order).
- /// </summary>
- /// <param name="allocator">The allocator to use.</param>
- /// <returns>An array with a copy of the set's values.</returns>
- public NativeArray<T> ToNativeArray(AllocatorManager.AllocatorHandle allocator) => m_Data.GetKeyArray(allocator);
-
- /// <summary>
- /// Returns a parallel writer.
- /// </summary>
- /// <returns>A parallel writer.</returns>
- public ParallelWriter AsParallelWriter()
- {
- ParallelWriter writer;
- writer.m_Data = m_Data.AsParallelWriter();
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- CollectionHelper.SetStaticSafetyId<ParallelWriter>(ref writer.m_Data.m_Safety, ref ParallelWriter.s_staticSafetyId.Data);
- #endif
- return writer;
- }
-
- /// <summary>
- /// A parallel writer for a NativeHashSet.
- /// </summary>
- /// <remarks>
- /// Use <see cref="AsParallelWriter"/> to create a parallel writer for a set.
- /// </remarks>
- [NativeContainerIsAtomicWriteOnly]
- [BurstCompatible(GenericTypeArguments = new [] { typeof(int) })]
- public struct ParallelWriter
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- internal static readonly SharedStatic<int> s_staticSafetyId = SharedStatic<int>.GetOrCreate<ParallelWriter>();
- #endif
- internal NativeHashMap<T, bool>.ParallelWriter m_Data;
-
- /// <summary>
- /// The number of values that fit in the current allocation.
- /// </summary>
- /// <value>The number of values that fit in the current allocation.</value>
- public int Capacity => m_Data.Capacity;
-
- /// <summary>
- /// Adds a new value (unless it is already present).
- /// </summary>
- /// <param name="item">The value to add.</param>
- /// <returns>True if the value is not already present.</returns>
- public bool Add(T item) => m_Data.TryAdd(item, false);
- }
-
- /// <summary>
- /// Returns an enumerator over the values of this set.
- /// </summary>
- /// <returns>An enumerator over the values of this set.</returns>
- public Enumerator GetEnumerator()
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- AtomicSafetyHandle.CheckGetSecondaryDataPointerAndThrow(m_Data.m_Safety);
- var ash = m_Data.m_Safety;
- AtomicSafetyHandle.UseSecondaryVersion(ref ash);
- #endif
- return new Enumerator
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- m_Safety = ash,
- #endif
- m_Enumerator = new UnsafeHashMapDataEnumerator(m_Data.m_HashMapData.m_Buffer),
- };
- }
-
- /// <summary>
- /// This method is not implemented. Use <see cref="GetEnumerator"/> instead.
- /// </summary>
- /// <returns>Throws NotImplementedException.</returns>
- /// <exception cref="NotImplementedException">Method is not implemented.</exception>
- IEnumerator<T> IEnumerable<T>.GetEnumerator()
- {
- throw new NotImplementedException();
- }
-
- /// <summary>
- /// This method is not implemented. Use <see cref="GetEnumerator"/> instead.
- /// </summary>
- /// <returns>Throws NotImplementedException.</returns>
- /// <exception cref="NotImplementedException">Method is not implemented.</exception>
- IEnumerator IEnumerable.GetEnumerator()
- {
- throw new NotImplementedException();
- }
-
- /// <summary>
- /// An enumerator over the values of a set.
- /// </summary>
- /// <remarks>
- /// In an enumerator's initial state, <see cref="Current"/> is invalid.
- /// The first <see cref="MoveNext"/> call advances the enumerator to the first value.
- /// </remarks>
- [NativeContainer]
- [NativeContainerIsReadOnly]
- public struct Enumerator : IEnumerator<T>
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- internal AtomicSafetyHandle m_Safety;
- #endif
- internal UnsafeHashMapDataEnumerator m_Enumerator;
-
- /// <summary>
- /// Does nothing.
- /// </summary>
- public void Dispose() { }
-
- /// <summary>
- /// Advances the enumerator to the next value.
- /// </summary>
- /// <returns>True if `Current` is valid to read after the call.</returns>
- public bool MoveNext()
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- AtomicSafetyHandle.CheckReadAndThrow(m_Safety);
- #endif
- return m_Enumerator.MoveNext();
- }
-
- /// <summary>
- /// Resets the enumerator to its initial state.
- /// </summary>
- public void Reset()
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- AtomicSafetyHandle.CheckReadAndThrow(m_Safety);
- #endif
- m_Enumerator.Reset();
- }
-
- /// <summary>
- /// The current value.
- /// </summary>
- /// <value>The current value.</value>
- public T Current
- {
- get
- {
- #if ENABLE_UNITY_COLLECTIONS_CHECKS
- AtomicSafetyHandle.CheckReadAndThrow(m_Safety);
- #endif
- return m_Enumerator.GetCurrentKey<T>();
- }
- }
-
- /// <summary>
- /// Gets the element at the current position of the enumerator in the container.
- /// </summary>
- object IEnumerator.Current => Current;
- }
- }
-
- sealed internal class NativeHashSetDebuggerTypeProxy<T>
- where T : unmanaged, IEquatable<T>
- {
- #if !NET_DOTS
- NativeHashSet<T> Data;
-
- public NativeHashSetDebuggerTypeProxy(NativeHashSet<T> data)
- {
- Data = data;
- }
-
- public List<T> Items
- {
- get
- {
- var result = new List<T>();
- using (var keys = Data.ToNativeArray(Allocator.Temp))
- {
- for (var k = 0; k < keys.Length; ++k)
- {
- result.Add(keys[k]);
- }
- }
-
- return result;
- }
- }
- #endif
- }
- }
|