Skip to content

Commit

Permalink
Add missing documentation for UnorderedMap (#567)
Browse files Browse the repository at this point in the history
  • Loading branch information
tcclevenger authored Sep 3, 2024
1 parent 474237e commit 0ed3a27
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/source/API/containers/Unordered-Map.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,29 @@ Description
Return true if the internal views (keys, values, hashmap) are allocated

.. cppkokkos:function:: create_copy_view(UnorderedMap<SKey, SValue, SDevice, Hasher, EqualTo> const &src);
For the calling ``UnorderedMap``, allocate views to have the same capacity as ``src``, and copy data from ``src``.

.. cppkokkos:function:: allocate_view(UnorderedMap<SKey, SValue, SDevice, Hasher, EqualTo> const &src);
Allocate views of the calling ``UnorderedMap`` to have the same capacity as ``src``.

.. cppkokkos:function:: deep_copy_view(UnorderedMap<SKey, SValue, SDevice, Hasher, EqualTo> const &src);
Copy data from ``src`` to the calling ``UnorderedMap``.

.. rubric:: Non-Member Functions

.. cppkokkos:function:: inline void deep_copy(UnorderedMap<DKey, DT, DDevice, Hasher, EqualTo> &dst, const UnorderedMap<SKey, ST, SDevice, Hasher, EqualTo> &src);
Copy an ``UnorderedMap`` from ``src`` to ``dst``.

.. warning:: From Kokkos 4.4, ``src.capacity() == dst.capacity()`` is required

.. cppkokkos:function:: UnorderedMap<Key, ValueType, Device, Hasher, EqualTo>::HostMirror create_mirror(const UnorderedMap<Key, ValueType, Device, Hasher, EqualTo> &src);
Create a ``HostMirror`` for an ``UnorderedMap``.

.. cppkokkos:class:: UnorderedMapInsertResult
Expand Down

0 comments on commit 0ed3a27

Please sign in to comment.