update docstrings and remove unused function declaration

rapidsai · Sep 26, 2024 · 0470299 · 0470299
1 parent e5c94f7
commit 0470299
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 34 deletions.
diff --git a/cpp/include/cugraph_c/graph.h b/cpp/include/cugraph_c/graph.h
@@ -103,9 +103,8 @@ cugraph_error_code_t cugraph_sg_graph_create(
  *    Note that setting this flag will arbitrarily select one instance of a multi edge to be the
  *    edge that survives.  If the edges have properties that should be honored (e.g. sum the
  weights,
- * @param [in] symmetrize      If true, symmetrize the edgelist.
- *    or take the maximum weight), the caller should remove specific edges themselves and not rely
- *    on this flag.
+ * @param [in] symmetrize      If true, symmetrize the edgelist. The symmetrization of edges
+ * with edge_ids and/or edge_type_ids is currently not supported.
  * @param [in]  do_expensive_check    If true, do expensive checks to validate the input data
  *    is consistent with software assumptions.  If false bypass these checks.
  * @param [out] graph          A pointer to the graph object
@@ -152,9 +151,8 @@ cugraph_error_code_t cugraph_graph_create_sg(
  *    If false, do not renumber.  Renumbering enables some significant optimizations within
  *    the graph primitives library, so it is strongly encouraged.  Renumbering is required if
  *    the vertices are not sequential integer values from 0 to num_vertices.
- * @param [in]  symmetrize     If true, symmetrize the edgelist.
- *    or take the maximum weight), the caller should remove specific edges themselves and not rely
- *    on this flag.
+ * @param [in]  symmetrize     If true, symmetrize the edgelist. The symmetrization of edges
+ * with edge_ids and/or edge_type_ids is currently not supported.
  * @param [in]  do_expensive_check    If true, do expensive checks to validate the input data
  *    is consistent with software assumptions.  If false bypass these checks.
  * @param [out] graph          A pointer to the graph object
@@ -196,9 +194,8 @@ cugraph_error_code_t cugraph_sg_graph_create_from_csr(
  *    If false, do not renumber.  Renumbering enables some significant optimizations within
  *    the graph primitives library, so it is strongly encouraged.  Renumbering is required if
  *    the vertices are not sequential integer values from 0 to num_vertices.
- * @param [in]  symmetrize     If true, symmetrize the edgelist.
- *    or take the maximum weight), the caller should remove specific edges themselves and not rely
- *    on this flag.
+ * @param [in]  symmetrize     If true, symmetrize the edgelist. The symmetrization of edges
+ * with edge_ids and/or edge_type_ids is currently not supported.
  * @param [in]  do_expensive_check    If true, do expensive checks to validate the input data
  *    is consistent with software assumptions.  If false bypass these checks.
  * @param [out] graph          A pointer to the graph object
@@ -299,7 +296,8 @@ cugraph_error_code_t cugraph_mg_graph_create(
  *    Note that setting this flag will arbitrarily select one instance of a multi edge to be the
  *    edge that survives.  If the edges have properties that should be honored (e.g. sum the
  * weights, or take the maximum weight), the caller should do that on not rely on this flag.
- * @param [in]  symmetrize      If true, symmetrize the edgelist.
+ * @param [in]  symmetrize      If true, symmetrize the edgelist. The symmetrization of edges
+ * with edge_ids and/or edge_type_ids is currently not supported.
  * @param [in]  do_expensive_check  If true, do expensive checks to validate the input data
  *    is consistent with software assumptions.  If false bypass these checks.
  * @param [out] graph           A pointer to the graph object

diff --git a/cpp/include/cugraph_c/graph_functions.h b/cpp/include/cugraph_c/graph_functions.h
@@ -361,30 +361,6 @@ cugraph_type_erased_device_array_view_t* cugraph_degrees_result_get_out_degrees(
  */
 void cugraph_degrees_result_free(cugraph_degrees_result_t* degrees_result);
 
-/**
- * @brief      Symmetrize edgelist
- *
- * This function symmetrizes the edgelist.
- *
- * @param [in]  handle            Handle for accessing resources.
- * @param [in]  src               Device array containing the source vertex ids.
- * @param [in]  dst               Device array containing the destination vertex ids
- * @param [in]  weights           Optional device array containing the edge weights
- * @param [in]  reciprocal        Flag indicating whether to keep (if set to `false`) or discard
- *                                 (if set to `true`) edges that appear only in one direction.
- * @param [out] result            Opaque pointer to gathered edgelist result
- * @param [out] error             Pointer to an error object storing details of any error.  Will
- *                                be populated if error code is not CUGRAPH_SUCCESS
- * @return error code
- */
-cugraph_error_code_t symmetrize_edgelist(const cugraph_resource_handle_t* handle,
-                                         const cugraph_type_erased_device_array_view_t* src,
-                                         const cugraph_type_erased_device_array_view_t* dst,
-                                         const cugraph_type_erased_device_array_view_t* weights,
-                                         bool_t reciprocal,
-                                         cugraph_induced_subgraph_result_t** result,
-                                         cugraph_error_t** error);
-
 #ifdef __cplusplus
 }
 #endif