Struct NativeMultiHashMap<TKey, TValue>

Namespace: Unity.Collections
Syntax
public struct NativeMultiHashMap<TKey, TValue> : IDisposable where TKey : struct, IEquatable<TKey> where TValue : struct
Type Parameters
Name Description
TKey
TValue

Constructors

NativeMultiHashMap(Int32, Allocator)

Declaration
public NativeMultiHashMap(int capacity, Allocator allocator)
Parameters
Type Name Description
System.Int32 capacity
Allocator allocator

Properties

Capacity

Declaration
public int Capacity { get; set; }
Property Value
Type Description
System.Int32

IsCreated

Declaration
public bool IsCreated { get; }
Property Value
Type Description
System.Boolean

Length

Declaration
public int Length { get; }
Property Value
Type Description
System.Int32

Methods

Add(TKey, TValue)

Declaration
public void Add(TKey key, TValue item)
Parameters
Type Name Description
TKey key
TValue item

AsParallelWriter()

Returns parallel writer instance.

Declaration
public NativeMultiHashMap<TKey, TValue>.ParallelWriter AsParallelWriter()
Returns
Type Description
NativeMultiHashMap.ParallelWriter<>

Clear()

Declaration
public void Clear()

ContainsKey(TKey)

Declaration
public bool ContainsKey(TKey key)
Parameters
Type Name Description
TKey key
Returns
Type Description
System.Boolean

CountValuesForKey(TKey)

Declaration
public int CountValuesForKey(TKey key)
Parameters
Type Name Description
TKey key
Returns
Type Description
System.Int32

Dispose()

Disposes of this multi-hashmap and deallocates its memory immediately.

Declaration
public void Dispose()

Dispose(JobHandle)

Safely disposes of this container and deallocates its memory when the jobs that use it have completed.

Declaration
public JobHandle Dispose(JobHandle inputDeps)
Parameters
Type Name Description
JobHandle inputDeps
Returns
Type Description
JobHandle

A new job handle containing the prior handles as well as the handle for the job that deletes the container.
Remarks

You can call this function dispose of the container immediately after scheduling the job. Pass the JobHandle returned by the Job.Schedule method using the jobHandle parameter so the job scheduler can dispose the container after all jobs using it have run.

GetKeyArray(Allocator)

Declaration
public NativeArray<TKey> GetKeyArray(Allocator allocator)
Parameters
Type Name Description
Allocator allocator
Returns
Type Description
NativeArray<TKey>

GetValueArray(Allocator)

Declaration
public NativeArray<TValue> GetValueArray(Allocator allocator)
Parameters
Type Name Description
Allocator allocator
Returns
Type Description
NativeArray<TValue>

GetValuesForKey(TKey)

Declaration
public NativeMultiHashMap<TKey, TValue>.Enumerator GetValuesForKey(TKey key)
Parameters
Type Name Description
TKey key
Returns
Type Description
NativeMultiHashMap.Enumerator<>

Remove(TKey)

Declaration
public void Remove(TKey key)
Parameters
Type Name Description
TKey key

Remove(NativeMultiHashMapIterator<TKey>)

Declaration
public void Remove(NativeMultiHashMapIterator<TKey> it)
Parameters
Type Name Description
NativeMultiHashMapIterator<TKey> it

Remove<TValueEQ>(TKey, TValueEQ)

Declaration
public void Remove<TValueEQ>(TKey key, TValueEQ value)
    where TValueEQ : struct, IEquatable<TValueEQ>
Parameters
Type Name Description
TKey key
TValueEQ value
Type Parameters
Name Description
TValueEQ

SetValue(TValue, NativeMultiHashMapIterator<TKey>)

Declaration
public bool SetValue(TValue item, NativeMultiHashMapIterator<TKey> it)
Parameters
Type Name Description
TValue item
NativeMultiHashMapIterator<TKey> it
Returns
Type Description
System.Boolean

TryGetFirstValue(TKey, out TValue, out NativeMultiHashMapIterator<TKey>)

Declaration
public bool TryGetFirstValue(TKey key, out TValue item, out NativeMultiHashMapIterator<TKey> it)
Parameters
Type Name Description
TKey key
TValue item
NativeMultiHashMapIterator<TKey> it
Returns
Type Description
System.Boolean

TryGetNextValue(out TValue, ref NativeMultiHashMapIterator<TKey>)

Declaration
public bool TryGetNextValue(out TValue item, ref NativeMultiHashMapIterator<TKey> it)
Parameters
Type Name Description
TValue item
NativeMultiHashMapIterator<TKey> it
Returns
Type Description
System.Boolean

Extension Methods

Did you find this page useful? Please give it a rating: