From 1705b76203cb21b4fa1822bf9dd9e037107117ce Mon Sep 17 00:00:00 2001 From: "Bae, Seung-Hee" Date: Thu, 3 Aug 2023 15:45:09 -0700 Subject: [PATCH] rename 'handle' as 'p_handle' for init_matrix_handle and release_matrix_handle routines. --- .../source/domains/spblas/matrixinit.rst | 23 +++++++++++++++++-- .../domains/spblas/releasematrixhandle.rst | 14 +++++------ 2 files changed, 28 insertions(+), 9 deletions(-) diff --git a/source/elements/oneMKL/source/domains/spblas/matrixinit.rst b/source/elements/oneMKL/source/domains/spblas/matrixinit.rst index ca6493d216..70126e9d8a 100644 --- a/source/elements/oneMKL/source/domains/spblas/matrixinit.rst +++ b/source/elements/oneMKL/source/domains/spblas/matrixinit.rst @@ -24,10 +24,29 @@ The oneapi::mkl::sparse::init_matrix_handle function initializes the namespace oneapi::mkl::sparse { - void init_matrix_handle (oneapi::mkl::sparse::matrix_handle_t *handle); + void init_matrix_handle (oneapi::mkl::sparse::matrix_handle_t *p_handle); } + +.. container:: section + + .. rubric:: Input parameter + + p_handle + The address of the sparse::matrix_handle_t ``p_handle`` object to be initialized. + This initialization routine must only be called on an uninitialized matrix_handle_t object. + + +.. container:: section + + .. rubric:: Output parameters + + p_handle + On return, the address is updated to point to a newly allocated and initialized matrix_handle_t object + that can be filled and used to perform sparse BLAS operations. + + .. container:: section .. rubric:: Throws @@ -50,4 +69,4 @@ The oneapi::mkl::sparse::init_matrix_handle function initializes the .. container:: parentlink - **Parent topic:** :ref:`onemkl_spblas` \ No newline at end of file + **Parent topic:** :ref:`onemkl_spblas` diff --git a/source/elements/oneMKL/source/domains/spblas/releasematrixhandle.rst b/source/elements/oneMKL/source/domains/spblas/releasematrixhandle.rst index b2dff8bdfe..cdad196b55 100644 --- a/source/elements/oneMKL/source/domains/spblas/releasematrixhandle.rst +++ b/source/elements/oneMKL/source/domains/spblas/releasematrixhandle.rst @@ -27,7 +27,7 @@ before releasing any data in case of USM. namespace oneapi::mkl::sparse { sycl::event release_matrix_handle (sycl::queue &queue, - oneapi::mkl::sparse::matrix_handle_t *handle, + oneapi::mkl::sparse::matrix_handle_t *p_handle, const std::vector &dependencies = {}); } @@ -40,21 +40,21 @@ before releasing any data in case of USM. queue The SYCL command queue which will be used for SYCL kernels execution. - handle - The address of the sparse::matrix_handle_t ``handle`` object to be released, containing sparse matrix and other internal + p_handle + The address of the sparse::matrix_handle_t ``p_handle`` object to be released, containing sparse matrix and other internal data. Initialized with oneapi::mkl::sparse::init_matrix_handle routine, and filled with user data using one of the oneapi::mkl::sparse::set__structure routines. dependencies - List of events that ``handle`` depends on. - The call waits on the events(if any) before resetting the ``handle`` to default values. + List of events that ``p_handle`` depends on. + The call waits on the events(if any) before resetting the ``p_handle`` to default values. .. container:: section .. rubric:: Output parameters - handle - The address of the sparse::matrix_handle_t ``handle`` that will be scheduled to be updated to point to a null object + p_handle + The address of the sparse::matrix_handle_t ``p_handle`` that will be scheduled to be updated to point to a null object and the passed in handle will be scheduled for deallocation and cleanup. .. container:: section