update for C++

rapidsai · Sep 13, 2023 · 8109f7f · 8109f7f
1 parent 5f54928
commit 8109f7f
Show file tree

Hide file tree

Showing 18 changed files with 252 additions and 73 deletions.
diff --git a/cpp/include/cugraph/algorithms.hpp b/cpp/include/cugraph/algorithms.hpp
@@ -37,7 +37,6 @@
 #include <tuple>
 
 /** @ingroup cpp_api
- *  @{
  */
 
 namespace cugraph {
@@ -2078,7 +2077,7 @@ rmm::device_uvector<weight_t> sorensen_coefficients(
   raft::handle_t const& handle,
   graph_view_t<vertex_t, edge_t, false, multi_gpu> const& graph_view,
   std::optional<edge_property_view_t<edge_t, weight_t const*>> edge_weight_view,
-  std::tuple<raft::device_span<vertex_t const>, raft::device_span<vertex_t const>> vertex_pairs,
+  std::tuple<raft::device_span<vertex_t const>,raft::device_span<vertex_t const>> vertex_pairs,
   bool do_expensive_check = false);
 
 /**
@@ -2162,7 +2161,3 @@ rmm::device_uvector<vertex_t> maximal_independent_set(
   raft::random::RngState& rng_state);
 
 }  // namespace cugraph
-
-/**
- * @}
- */
diff --git a/cpp/include/cugraph_c/sampling_algorithms.h b/cpp/include/cugraph_c/sampling_algorithms.h
@@ -21,12 +21,7 @@
 #include <cugraph_c/random.h>
 #include <cugraph_c/resource_handle.h>
 
-/** @defgroup sampling Sampling algorithms
- */
-
-/**
- *  @defgroup sampling_test
- *  @ingroup c_api
+/** @defgroup samplingC Sampling algorithms
  */
 
 #ifdef __cplusplus
@@ -138,7 +133,7 @@ cugraph_error_code_t cugraph_node2vec(const cugraph_resource_handle_t* handle,
                                       cugraph_error_t** error);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the max path length from random walk result
  *
  * @param [in]   result   The result from random walks
@@ -150,7 +145,7 @@ size_t cugraph_random_walk_result_get_max_path_length(cugraph_random_walk_result
 //         difference at the moment is that RW results contain weights
 //         and extract_paths results don't.  But that's probably wrong.
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the matrix (row major order) of vertices in the paths
  *
  * @param [in]   result   The result from a random walk algorithm
@@ -160,7 +155,7 @@ cugraph_type_erased_device_array_view_t* cugraph_random_walk_result_get_paths(
   cugraph_random_walk_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the matrix (row major order) of edge weights in the paths
  *
  * @param [in]   result   The result from a random walk algorithm
@@ -170,7 +165,7 @@ cugraph_type_erased_device_array_view_t* cugraph_random_walk_result_get_weights(
   cugraph_random_walk_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     If the random walk result is compressed, get the path sizes
  * @deprecated This call will no longer be relevant once the new node2vec are called
  *
@@ -181,7 +176,7 @@ cugraph_type_erased_device_array_view_t* cugraph_random_walk_result_get_path_siz
   cugraph_random_walk_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Free random walks result
  *
  * @param [in]   result   The result from random walks
@@ -203,7 +198,7 @@ typedef struct {
 } cugraph_sampling_options_t;
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Enumeration for prior sources behavior
  */
 typedef enum cugraph_prior_sources_behavior_t {
@@ -215,7 +210,7 @@ typedef enum cugraph_prior_sources_behavior_t {
 } cugraph_prior_sources_behavior_t;
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief   Create sampling options object
  *
  * All sampling options set to FALSE
@@ -228,7 +223,7 @@ cugraph_error_code_t cugraph_sampling_options_create(cugraph_sampling_options_t*
                                                      cugraph_error_t** error);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief   Set flag to renumber results
  *
  * @param options - opaque pointer to the sampling options
@@ -237,7 +232,7 @@ cugraph_error_code_t cugraph_sampling_options_create(cugraph_sampling_options_t*
 void cugraph_sampling_set_renumber_results(cugraph_sampling_options_t* options, bool_t value);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief   Set flag to sample with_replacement
  *
  * @param options - opaque pointer to the sampling options
@@ -246,7 +241,7 @@ void cugraph_sampling_set_renumber_results(cugraph_sampling_options_t* options,
 void cugraph_sampling_set_with_replacement(cugraph_sampling_options_t* options, bool_t value);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief   Set flag to sample return_hops
  *
  * @param options - opaque pointer to the sampling options
@@ -255,7 +250,7 @@ void cugraph_sampling_set_with_replacement(cugraph_sampling_options_t* options,
 void cugraph_sampling_set_return_hops(cugraph_sampling_options_t* options, bool_t value);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief   Set prior sources behavior
  *
  * @param options - opaque pointer to the sampling options
@@ -274,7 +269,7 @@ void cugraph_sampling_set_prior_sources_behavior(cugraph_sampling_options_t* opt
 void cugraph_sampling_set_dedupe_sources(cugraph_sampling_options_t* options, bool_t value);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Free sampling options object
  *
  * @param [in]   options   Opaque pointer to sampling object
@@ -390,7 +385,7 @@ cugraph_error_code_t cugraph_uniform_neighbor_sample(
   cugraph_error_t** error);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the source vertices from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -400,7 +395,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_sources(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the destination vertices from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -410,7 +405,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_destinations(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the start labels from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -420,7 +415,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_start_labels(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the edge_id from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -430,7 +425,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_edge_id(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the edge_type from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -440,7 +435,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_edge_type(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the edge_weight from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -450,7 +445,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_edge_weight(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the hop from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -460,7 +455,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_hop(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the index from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -470,7 +465,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_index(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the result offsets from the sampling algorithm result
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -480,7 +475,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_offsets(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the renumber map
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -490,7 +485,7 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_renumber_map(
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Get the renumber map offsets
  *
  * @param [in]   result   The result from a sampling algorithm
@@ -500,15 +495,15 @@ cugraph_type_erased_device_array_view_t* cugraph_sample_result_get_renumber_map_
   const cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling
+ * @ingroup samplingC
  * @brief     Free a sampling result
  *
  * @param [in]   result   The result from a sampling algorithm
  */
 void cugraph_sample_result_free(cugraph_sample_result_t* result);
 
 /**
- * @ingroup sampling_test
+ * @ingroup samplingC
  * @brief     Create a sampling result (testing API)
  *
  * @param [in]   handle         Handle for accessing resources
@@ -539,7 +534,7 @@ cugraph_error_code_t cugraph_test_sample_result_create(
   cugraph_error_t** error);
 
 /**
- * @ingroup sampling_test
+ * @ingroup samplingC
  * @brief     Create a sampling result (testing API)
  *
  * @param [in]   handle         Handle for accessing resources
@@ -570,7 +565,7 @@ cugraph_error_code_t cugraph_test_uniform_neighborhood_sample_result_create(
   cugraph_error_t** error);
 
 /**
- * @ingroup sampling_test
+ * @ingroup samplingC
  * @brief Select random vertices from the graph
  *
  * @param [in]      handle        Handle for accessing resources

diff --git a/docs/cugraph/source/api_docs/cugraph/index.rst b/docs/cugraph/source/api_docs/cugraph/index.rst
@@ -1,6 +1,6 @@
-~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 cugraph Python API Reference
-~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/cugraph/source/api_docs/cugraph_c/labeling.rst b/docs/cugraph/source/api_docs/cugraph_c/labeling.rst
@@ -8,7 +8,7 @@ Weakly Connected Components
     :project: libcugraph
 
 Strongly Connected Components
---------
+-----------------------------
 .. doxygenfunction:: cugraph_strongly_connected_components
     :project: libcugraph
 

diff --git a/docs/cugraph/source/api_docs/cugraph_c/sampling.rst b/docs/cugraph/source/api_docs/cugraph_c/sampling.rst
@@ -29,13 +29,9 @@ Uniform Neighborhood Sampling
 .. doxygenfunction:: cugraph_uniform_neighbor_sample
     :project: libcugraph
 
-Sampling Testing
-----------------
-.. doxygenfunction:: sampling_test
-    :project: libcugraph
-
 Support
 -------
-.. doxygenfunction:: sampling
-    :project: libcugraph
-
+.. doxygengroup:: samplingC
+     :project: libcugraph
+     :members:
+     :content-only:
diff --git a/docs/cugraph/source/api_docs/cugraph_c/similarity.rst b/docs/cugraph/source/api_docs/cugraph_c/similarity.rst
@@ -9,7 +9,7 @@ Jaccard
 
 Sorensen
 --------
-.. jaccard:: cugraph_sorensen_coefficients
+.. doxygenfunction:: cugraph_sorensen_coefficients
     :project: libcugraph
 
 Overlap
@@ -19,5 +19,7 @@ Overlap
 
 Support
 -------
-.. doxygenfunction:: similarity
-    :project: libcugraph
+.. doxygengroup:: similarity
+     :project: libcugraph
+     :members:
+     :content-only:
diff --git a/docs/cugraph/source/api_docs/cugraph_c/traversal.rst b/docs/cugraph/source/api_docs/cugraph_c/traversal.rst
@@ -9,7 +9,7 @@ Breadth First Search (BFS)
 
 Single-Source Shortest-Path (SSSP)
 ----------------------------------
-.. jaccard:: cugraph_sssp
+.. doxygenfunction:: cugraph_sssp
     :project: libcugraph
 
 Path Extraction
@@ -24,5 +24,7 @@ Extract Max Path Length
 
 Support
 -------
-.. doxygenfunction:: traversal
-    :project: libcugraph
+.. doxygengroup:: traversal
+     :project: libcugraph
+     :members:
+     :content-only: