find_first_of: Add docs

StreamHPC · Sep 9, 2024 · 1cce46b · 1cce46b
1 parent fd07e9e
commit 1cce46b
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,8 @@ Documentation for rocPRIM is available at
 
 ### Additions
 
+* Added the parallel `find_first_of` device function with autotuned configurations, this function is similar to `std::find_first_of`, it searches for the first occurrence of any of the provided elements.
+
 ### Changes
 
 ### Fixes

diff --git a/docs/device_ops/find_first_of.rst b/docs/device_ops/find_first_of.rst
@@ -0,0 +1,19 @@
+.. meta::
+  :description: rocPRIM documentation and API reference library
+  :keywords: rocPRIM, ROCm, API, documentation
+
+.. _dev-find_first_of:
+
+
+Find first of
+-------------
+
+Configuring the kernel
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. doxygenstruct::  rocprim::find_first_of_config
+
+find_first_of
+~~~~~~~~~~~~~
+
+.. doxygenfunction:: rocprim::find_first_of(void* temporary_storage, size_t& storage_size, InputIterator1 input, InputIterator2 keys, OutputIterator output, size_t size, size_t keys_size, BinaryFunction compare_function = BinaryFunction(), hipStream_t stream = 0, bool debug_synchronous = false)
diff --git a/docs/device_ops/index.rst b/docs/device_ops/index.rst
@@ -25,3 +25,4 @@
    * :ref:`dev-memcpy`
    * :ref:`dev-nth_element`
    * :ref:`dev-partial_sort`
+   * :ref:`dev-find_first_of`
diff --git a/docs/reference/ops_summary.rst b/docs/reference/ops_summary.rst
@@ -50,6 +50,11 @@ Data Movement
 * ``load`` the complementary operations of the above ones.
 * ``memcpy`` copies bytes between device sources and destinations
 
+Sequence Search
+===============
+
+* ``find_first_of`` searches for the first occurrence of any of the provided elements.
+
 Other operations
 ======================
 

diff --git a/docs/sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in
@@ -36,6 +36,7 @@ subtrees:
           - file: device_ops/histogram.rst
           - file: device_ops/device_copy.rst
           - file: device_ops/memcpy.rst
+          - file: device_ops/find_first_of.rst
       - file: block_ops/index.rst
         subtrees:
         - entries: