Skip to content

Fix RMAT docs #3071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
divyegala wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix RMAT docs #3071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a766ad3
fix docs
divyegala Jul 2, 2026
7cb31b4
style check
divyegala Jul 2, 2026
629ec1b
fix docs
divyegala Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cpp/.clang-format
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ BreakConstructorInitializers: BeforeColon
BreakInheritanceList: BeforeColon
BreakStringLiterals: true
ColumnLimit: 100
CommentPragmas: '^ IWYU pragma:'
CommentPragmas: '(IWYU pragma:|SPDX-)'

@aamijar aamijar Jul 2, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same change as this one #3067

CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: true
# Kept the below 2 to be the same as `IndentWidth` to keep everything uniform
Expand Down
6 changes: 3 additions & 3 deletions cpp/include/raft/random/detail/rmat_rectangular_generator.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION.
* SPDX-License-Identifier: Apache-2.0
* SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* reserved. reserved. reserved. reserved. SPDX-License-Identifier: Apache-2.0
*/

#pragma once
Expand Down Expand Up @@ -247,7 +247,7 @@ void rmat_rectangular_gen_impl(raft::resources const& handle,
* @brief Overload of `rmat_rectangular_gen` that assumes the same
* a, b, c, d probability distributions across all the scales.
*
* `a`, `b, and `c` effectively replace the above overload's
* `a`, `b`, and `c` effectively replace the above overload's
* `theta` parameter.
*/
template <typename IdxT, typename ProbT>
Expand Down
12 changes: 6 additions & 6 deletions cpp/include/raft/random/detail/rmat_rectangular_generator_types.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION.
* SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: Apache-2.0
*/

Expand Down Expand Up @@ -39,8 +39,8 @@ namespace detail {
* This class prevents users from doing anything other than that,
* and makes it easier for the three cases to share a common implementation.
* It also prevents duplication of run-time vector length checking
* (`out` must have twice the number of elements as `out_src` and `out_dst`,
* and `out_src` and `out_dst` must have the same length).
* (`out.extent(0)` must equal `out_src.extent(0)` and `out_dst.extent(0)`,
* and `out_src.extent(0)` and `out_dst.extent(0)` must have the same length).
*
* @tparam IdxT Type of each node index; must be integral.
*
Expand Down Expand Up @@ -92,11 +92,11 @@ class rmat_rectangular_gen_output {
const out_dst_view_type& dst)
: out_(out), pair_(src, dst)
{
RAFT_EXPECTS(out.extent(0) == IdxT(2) * dst.extent(0),
RAFT_EXPECTS(out.extent(0) == dst.extent(0),
"rmat_rectangular_gen: "
"out.extent(0) = %zu != 2 * out_dst.extent(0) = %zu",
"out.extent(0) = %zu != out_dst.extent(0) = %zu",
static_cast<std::size_t>(out.extent(0)),
static_cast<std::size_t>(IdxT(2) * dst.extent(0)));
static_cast<std::size_t>(dst.extent(0)));
}

out_view_type out_view() const { return out_; }
Expand Down
14 changes: 7 additions & 7 deletions cpp/include/raft/random/rmat_rectangular_generator.cuh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/*
* SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION.
* SPDX-License-Identifier: Apache-2.0
* SPDX-FileCopyrightText: Copyright (c) 2022-2026, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* reserved. reserved. reserved. reserved. SPDX-License-Identifier: Apache-2.0
*/

#pragma once
Expand Down Expand Up @@ -61,7 +61,7 @@ namespace random {
* @param[in] r_scale 2^r_scale represents the number of source nodes
* @param[in] c_scale 2^c_scale represents the number of destination nodes
*
* @pre `out.extent(0) == 2 * `out_src.extent(0)` is `true`
* @pre `out.extent(0) == out_src.extent(0)` is `true`
* @pre `out_src.extent(0) == out_dst.extent(0)` is `true`
*
* We call the `r_scale != c_scale` case the "rectangular adjacency matrix" case
Expand Down Expand Up @@ -150,10 +150,10 @@ void rmat_rectangular_gen(
* and `out_src` and `out_dst` with the struct-of-arrays
* output representation).
*
* `a`, `b, and `c` effectively replace the above overloads'
* `a`, `b`, and `c` effectively replace the above overloads'
* `theta` parameter.
*
* @pre `out.extent(0) == 2 * `out_src.extent(0)` is `true`
* @pre `out.extent(0) == out_src.extent(0)` is `true`
* @pre `out_src.extent(0) == out_dst.extent(0)` is `true`
*/
template <typename IdxT, typename ProbT>
Expand All @@ -179,7 +179,7 @@ void rmat_rectangular_gen(
* and takes only two output vectors
* (the struct-of-arrays output representation).
*
* `a`, `b, and `c` effectively replace the above overloads'
* `a`, `b`, and `c` effectively replace the above overloads'
* `theta` parameter.
*
* @pre `out_src.extent(0) == out_dst.extent(0)` is `true`
Expand All @@ -205,7 +205,7 @@ void rmat_rectangular_gen(raft::resources const& handle,
* and takes only one output vector
* (the array-of-structs output representation).
*
* `a`, `b, and `c` effectively replace the above overloads'
* `a`, `b`, and `c` effectively replace the above overloads'
* `theta` parameter.
*/
template <typename IdxT, typename ProbT>
Expand Down
Loading