From 741e715c037a15fdec7c03f3ee7d031ab78e6266 Mon Sep 17 00:00:00 2001 From: Naim Date: Mon, 25 Dec 2023 00:48:01 +0100 Subject: [PATCH] Update doc-strings --- cpp/include/cugraph/algorithms.hpp | 10 +++++++++- cpp/src/community/ecg_impl.cuh | 4 ++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/cpp/include/cugraph/algorithms.hpp b/cpp/include/cugraph/algorithms.hpp index a0c4ad4fe3b..16824ebd749 100644 --- a/cpp/include/cugraph/algorithms.hpp +++ b/cpp/include/cugraph/algorithms.hpp @@ -594,7 +594,10 @@ std::pair louvain( * * @throws cugraph::logic_error when an error occurs. * - * @tparam graph_view_t Type of graph + * @tparam vertex_t Type of vertex identifiers. Needs to be an integral type. + * @tparam edge_t Type of edge identifiers. Needs to be an integral type. + * @tparam weight_t Type of edge weights. Needs to be a floating point type. + * @tparam multi_gpu Flag indicating whether template instantiation should target single-GPU (false) * * @param[in] handle Library handle (RAFT) * @param[in] graph_view Input graph view object @@ -792,6 +795,11 @@ void ecg(raft::handle_t const& handle, * * @throws cugraph::logic_error when an error occurs. * + * @tparam vertex_t Type of vertex identifiers. Needs to be an integral type. + * @tparam edge_t Type of edge identifiers. Needs to be an integral type. + * @tparam weight_t Type of edge weights. Needs to be a floating point type. + * @tparam multi_gpu Flag indicating whether template instantiation should target single-GPU (false) + * * @param[in] handle Library handle (RAFT). If a communicator is set in the handle, * @param[in] rng_state The RngState instance holding pseudo-random number generator state. * @param[in] graph_view Input graph view object diff --git a/cpp/src/community/ecg_impl.cuh b/cpp/src/community/ecg_impl.cuh index 9481083258e..62c28a37062 100644 --- a/cpp/src/community/ecg_impl.cuh +++ b/cpp/src/community/ecg_impl.cuh @@ -54,10 +54,10 @@ std::tuple, size_t, weight_t> ecg( "Invalid input arguments: ensemble_size must be a non-zero integer"); CUGRAPH_EXPECTS( threshold > 0.0 && threshold <= 1.0, - "Invalid input arguments: threshold must be a positive number in range [0.0, 1.0]"); + "Invalid input arguments: threshold must be a positive number in range (0.0, 1.0]"); CUGRAPH_EXPECTS( resolution > 0.0 && resolution <= 1.0, - "Invalid input arguments: resolution must be a positive number in range [0.0, 1.0]"); + "Invalid input arguments: resolution must be a positive number in range (0.0, 1.0]"); edge_src_property_t src_cluster_assignments(handle, graph_view); edge_dst_property_t dst_cluster_assignments(handle, graph_view);