Unverified Commit 619d735d authored by Hongzhi (Steve), Chen's avatar Hongzhi (Steve), Chen Committed by GitHub
Browse files

[Misc] Replace \xxx with @XXX in structured comment. (#4822)



* param

* brief

* note

* return

* tparam

* brief2

* file

* return2

* return

* blabla

* all
Co-authored-by: default avatarSteve <ubuntu@ip-172-31-34-29.ap-northeast-1.compute.internal>
parent 96297fb8
/*!
* Copyright (c) 2021-2022 by Contributors
* \file array/cuda/array_index_select.cuh
* \brief Array index select GPU kernel implementation
* @file array/cuda/array_index_select.cuh
* @brief Array index select GPU kernel implementation
*/
#ifndef DGL_ARRAY_CUDA_ARRAY_INDEX_SELECT_CUH_
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/array_nonzero.cc
* \brief Array nonzero CPU implementation
* @file array/cpu/array_nonzero.cc
* @brief Array nonzero CPU implementation
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020-2021 by Contributors
* \file array/cuda/array_op_impl.cu
* \brief Array operator GPU implementation
* @file array/cuda/array_op_impl.cu
* @brief Array operator GPU implementation
*/
#include <dgl/array.h>
#include "../../runtime/cuda/cuda_common.h"
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cuda/array_scatter.cu
* \brief Array scatter GPU implementation
* @file array/cuda/array_scatter.cu
* @brief Array scatter GPU implementation
*/
#include <dgl/array.h>
#include "../../runtime/cuda/cuda_common.h"
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cpu/array_sort.cu
* \brief Array sort GPU implementation
* @file array/cpu/array_sort.cu
* @brief Array sort GPU implementation
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2019 by Contributors
* \file array/cuda/atomic.cuh
* \brief Atomic functions
* @file array/cuda/atomic.cuh
* @brief Atomic functions
*/
#ifndef DGL_ARRAY_CUDA_ATOMIC_CUH_
#define DGL_ARRAY_CUDA_ATOMIC_CUH_
......@@ -171,16 +171,16 @@ DEFINE_ATOMIC(Add)
/**
* \brief Performs an atomic compare-and-swap on 64 bit integers. That is,
* @brief Performs an atomic compare-and-swap on 64 bit integers. That is,
* it the word `old` at the memory location `address`, computes
* `(old == compare ? val : old)` , and stores the result back to memory at
* the same address.
*
* \param address The address to perform the atomic operation on.
* \param compare The value to compare to.
* \param val The new value to conditionally store.
* @param address The address to perform the atomic operation on.
* @param compare The value to compare to.
* @param val The new value to conditionally store.
*
* \return The old value at the address.
* @return The old value at the address.
*/
inline __device__ int64_t AtomicCAS(
int64_t * const address,
......@@ -197,16 +197,16 @@ inline __device__ int64_t AtomicCAS(
}
/**
* \brief Performs an atomic compare-and-swap on 32 bit integers. That is,
* @brief Performs an atomic compare-and-swap on 32 bit integers. That is,
* it the word `old` at the memory location `address`, computes
* `(old == compare ? val : old)` , and stores the result back to memory at
* the same address.
*
* \param address The address to perform the atomic operation on.
* \param compare The value to compare to.
* \param val The new value to conditionally store.
* @param address The address to perform the atomic operation on.
* @param compare The value to compare to.
* @param val The new value to conditionally store.
*
* \return The old value at the address.
* @return The old value at the address.
*/
inline __device__ int32_t AtomicCAS(
int32_t * const address,
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/coo2csr.cc
* \brief COO2CSR
* @file array/cuda/coo2csr.cc
* @brief COO2CSR
*/
#include <dgl/array.h>
......@@ -59,7 +59,7 @@ CSRMatrix COOToCSR<kDGLCUDA, int32_t>(COOMatrix coo) {
}
/*!
* \brief Search for the insertion positions for needle in the hay.
* @brief Search for the insertion positions for needle in the hay.
*
* The hay is a list of sorted elements and the result is the insertion position
* of each needle so that the insertion still gives sorted order.
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/coo_sort.cc
* \brief Sort COO index
* @file array/cuda/coo_sort.cc
* @brief Sort COO index
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/csr2coo.cc
* \brief CSR2COO
* @file array/cuda/csr2coo.cc
* @brief CSR2COO
*/
#include <dgl/array.h>
......@@ -46,12 +46,12 @@ COOMatrix CSRToCOO<kDGLCUDA, int32_t>(CSRMatrix csr) {
}
/*!
* \brief Repeat elements
* \param val Value to repeat
* \param repeats Number of repeats for each value
* \param pos The position of the output buffer to write the value.
* \param out Output buffer.
* \param length Number of values
* @brief Repeat elements
* @param val Value to repeat
* @param repeats Number of repeats for each value
* @param pos The position of the output buffer to write the value.
* @param out Output buffer.
* @param length Number of values
*
* For example:
* val = [3, 0, 1]
......
/*!
* Copyright (c) 2021 by Contributors
* \file array/cuda/csr_get_data.cu
* \brief Retrieve entries of a CSR matrix
* @file array/cuda/csr_get_data.cu
* @brief Retrieve entries of a CSR matrix
*/
#include <dgl/array.h>
#include <vector>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/csr_mm.cu
* \brief SpSpMM/SpGEMM C APIs and definitions.
* @file array/cuda/csr_mm.cu
* @brief SpSpMM/SpGEMM C APIs and definitions.
*/
#include <dgl/array.h>
#include <dgl/runtime/device_api.h>
......@@ -18,7 +18,7 @@ namespace cusparse {
#if 0 // disabling CUDA 11.0+ implementation for now because of problems on bigger graphs
/*! \brief Cusparse implementation of SpGEMM on Csr format for CUDA 11.0+ */
/*! @brief Cusparse implementation of SpGEMM on Csr format for CUDA 11.0+ */
template <typename DType, typename IdType>
std::pair<CSRMatrix, NDArray> CusparseSpgemm(
const CSRMatrix& A,
......@@ -127,7 +127,7 @@ std::pair<CSRMatrix, NDArray> CusparseSpgemm(
#else // __CUDACC_VER_MAJOR__ != 11
/*! \brief Cusparse implementation of SpGEMM on Csr format for older CUDA versions */
/*! @brief Cusparse implementation of SpGEMM on Csr format for older CUDA versions */
template <typename DType, typename IdType>
std::pair<CSRMatrix, NDArray> CusparseSpgemm(
const CSRMatrix& A,
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/csr_sort.cc
* \brief Sort CSR index
* @file array/cuda/csr_sort.cc
* @brief Sort CSR index
*/
#include <dgl/array.h>
......@@ -17,7 +17,7 @@ namespace aten {
namespace impl {
/*!
* \brief Check whether each row is sorted.
* @brief Check whether each row is sorted.
*/
template <typename IdType>
__global__ void _SegmentIsSorted(
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/spmm.cu
* \brief SpGEAM C APIs and definitions.
* @file array/cuda/spmm.cu
* @brief SpGEAM C APIs and definitions.
*/
#include <dgl/array.h>
#include <dgl/runtime/device_api.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/csr_transpose.cc
* \brief CSR transpose (convert to CSC)
* @file array/cuda/csr_transpose.cc
* @brief CSR transpose (convert to CSC)
*/
#include <dgl/array.h>
......
/*!
* Copyright (c) 2021 by Contributors
* \file array/cuda/cuda_filter.cc
* \brief Object for selecting items in a set, or selecting items not in a set.
* @file array/cuda/cuda_filter.cc
* @brief Object for selecting items in a set, or selecting items not in a set.
*/
#include <dgl/runtime/device_api.h>
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/dispatcher.cuh
* \brief Templates to dispatch into different cuSPARSE routines based on the type
* @file array/cuda/dispatcher.cuh
* @brief Templates to dispatch into different cuSPARSE routines based on the type
* argument.
*/
#ifndef DGL_ARRAY_CUDA_CUSPARSE_DISPATCHER_CUH_
......@@ -15,7 +15,7 @@
namespace dgl {
namespace aten {
/*! \brief cusparseXcsrgemm dispatcher */
/*! @brief cusparseXcsrgemm dispatcher */
template <typename DType>
struct CSRGEMM {
template <typename... Args>
......@@ -122,7 +122,7 @@ struct CSRGEMM<double> {
}
};
/*! \brief cusparseXcsrgeam dispatcher */
/*! @brief cusparseXcsrgeam dispatcher */
template <typename DType>
struct CSRGEAM {
template <typename... Args>
......
/*!
* Copyright (c) 2021 by Contributors
* \file cuda_common.h
* \brief Wrapper to place cub in dgl namespace.
* @file cuda_common.h
* @brief Wrapper to place cub in dgl namespace.
*/
#ifndef DGL_ARRAY_CUDA_DGL_CUB_CUH_
......
......@@ -13,8 +13,8 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
* \file array/gpu/disjoint_union.cu
* \brief Disjoint union GPU implementation.
* @file array/gpu/disjoint_union.cu
* @brief Disjoint union GPU implementation.
*/
#include <dgl/array.h>
......
......@@ -13,9 +13,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
* \file array/cuda/fp16.cuh
* \brief float16 related functions.
* \note this file is modified from TVM project:
* @file array/cuda/fp16.cuh
* @brief float16 related functions.
* @note this file is modified from TVM project:
* https://github.com/apache/tvm/blob/e561007f0c330e3d14c2bc8a3ef40fb741db9004/src/target/source/literal/cuda_half_t.h.
*/
#ifndef DGL_ARRAY_CUDA_FP16_CUH_
......
/*!
* Copyright (c) 2020 by Contributors
* \file array/cuda/functor.cuh
* \brief Functors for template on CUDA
* @file array/cuda/functor.cuh
* @brief Functors for template on CUDA
*/
#ifndef DGL_ARRAY_CUDA_FUNCTOR_CUH_
#define DGL_ARRAY_CUDA_FUNCTOR_CUH_
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment