Struct NativeMultiHashMap<TKey, TValue>
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 |
| Int32 |
capacity |
|
| Allocator |
allocator |
|
Properties
Capacity
The number of items that can fit in the container.
Declaration
public int Capacity { get; set; }
Property Value
| Type |
Description |
| Int32 |
The number of items that the container can hold before it resizes its internal storage.
|
IsCreated
Reports whether memory for the container is allocated.
Declaration
public bool IsCreated { get; }
Property Value
| Type |
Description |
| Boolean |
True if this container object's internal storage has been allocated.
|
Length
Declaration
public int Length { get; }
Property Value
Methods
Add(TKey, TValue)
Add an element with the specified key and value into the container. If the key already exist an ArgumentException will be thrown.
Declaration
public void Add(TKey key, TValue item)
Parameters
| Type |
Name |
Description |
| TKey |
key |
The key of the element to add.
|
| TValue |
item |
|
AsParallelWriter()
Returns parallel writer instance.
Declaration
public NativeMultiHashMap<TKey, TValue>.ParallelWriter AsParallelWriter()
Returns
Clear()
Declaration
ContainsKey(TKey)
Declaration
public bool ContainsKey(TKey key)
Parameters
| Type |
Name |
Description |
| TKey |
key |
|
Returns
CountValuesForKey(TKey)
Declaration
public int CountValuesForKey(TKey key)
Parameters
| Type |
Name |
Description |
| TKey |
key |
|
Returns
Dispose()
Disposes of this multi-hashmap and deallocates its memory immediately.
Declaration
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
GetKeyArray(Allocator)
Declaration
public NativeArray<TKey> GetKeyArray(Allocator allocator)
Parameters
| Type |
Name |
Description |
| Allocator |
allocator |
|
Returns
| Type |
Description |
| NativeArray<TKey> |
|
GetKeyValueArrays(Allocator)
Declaration
public NativeKeyValueArrays<TKey, TValue> GetKeyValueArrays(Allocator allocator)
Parameters
| Type |
Name |
Description |
| Allocator |
allocator |
|
Returns
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
Remove(TKey)
Removes all elements with the specified key from the container.
Declaration
public int Remove(TKey key)
Parameters
| Type |
Name |
Description |
| TKey |
key |
The key of the element to remove.
|
Returns
| Type |
Description |
| Int32 |
Returns number of removed items.
|
Remove(NativeMultiHashMapIterator<TKey>)
Declaration
public void Remove(NativeMultiHashMapIterator<TKey> it)
Parameters
Remove<TValueEQ>(TKey, TValueEQ)
Removes all elements with the specified key from the container.
Declaration
public void Remove<TValueEQ>(TKey key, TValueEQ value)
where TValueEQ : struct, IEquatable<TValueEQ>
Parameters
| Type |
Name |
Description |
| TKey |
key |
The key of the element to remove.
|
| TValueEQ |
value |
|
Type Parameters
| Name |
Description |
| TValueEQ |
|
SetValue(TValue, NativeMultiHashMapIterator<TKey>)
Declaration
public bool SetValue(TValue item, NativeMultiHashMapIterator<TKey> it)
Parameters
Returns
TryGetFirstValue(TKey, out TValue, out NativeMultiHashMapIterator<TKey>)
Declaration
public bool TryGetFirstValue(TKey key, out TValue item, out NativeMultiHashMapIterator<TKey> it)
Parameters
Returns
TryGetNextValue(out TValue, ref NativeMultiHashMapIterator<TKey>)
Declaration
public bool TryGetNextValue(out TValue item, ref NativeMultiHashMapIterator<TKey> it)
Parameters
Returns
Extension Methods
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.