Skip to content

Commit b899439

Browse files
authored
Adding CAGRA merge to the documentation (#1942)
Closes #1787. Authors: - Victor Lafargue (https://github.com/viclafargue) - Corey J. Nolet (https://github.com/cjnolet) - Anupam (https://github.com/aamijar) Approvers: - Corey J. Nolet (https://github.com/cjnolet) URL: #1942
1 parent 9c97b07 commit b899439

3 files changed

Lines changed: 25 additions & 0 deletions

File tree

c/include/cuvs/neighbors/cagra.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -827,6 +827,15 @@ cuvsError_t cuvsCagraIndexFromArgs(cuvsResources_t res,
827827
DLManagedTensor* dataset,
828828
cuvsCagraIndex_t index);
829829

830+
/**
831+
* @}
832+
*/
833+
834+
/**
835+
* @defgroup cagra_c_index_merge CAGRA C-API merge functions
836+
* @{
837+
*/
838+
830839
/**
831840
* @brief Merge multiple CAGRA indices into a single CAGRA index.
832841
*

docs/source/c_api/neighbors_cagra_c.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,14 @@ Index search
5050
:members:
5151
:content-only:
5252

53+
Index merge
54+
-----------
55+
56+
.. doxygengroup:: cagra_c_index_merge
57+
:project: cuvs
58+
:members:
59+
:content-only:
60+
5361
Index serialize
5462
---------------
5563

docs/source/cpp_api/neighbors_cagra.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,14 @@ Index extend
6767
:members:
6868
:content-only:
6969

70+
Index merge
71+
-----------
72+
73+
.. doxygengroup:: cagra_cpp_index_merge
74+
:project: cuvs
75+
:members:
76+
:content-only:
77+
7078
Index serialize
7179
---------------
7280

0 commit comments

Comments
 (0)