Skip to content

Commit

Permalink
Reword and format mkl_handles comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Rbiessy committed Jul 2, 2024
1 parent 002d788 commit 5c37ee3
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions src/sparse_blas/backends/mkl_common/mkl_handles.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,16 @@
#define _ONEMKL_SRC_SPARSE_BLAS_BACKENDS_MKL_COMMON_MKL_HANDLES_HPP_

// MKLCPU and MKLGPU backends include
// This include defines its own oneapi::mkl::sparse namespace with some of the types that are used here: matrix_handle_t, index_base, transpose, uplo, diag.
// This include defines its own oneapi::mkl::sparse namespace with some of the
// types that are used here: matrix_handle_t, index_base, transpose, uplo, diag.
#include <oneapi/mkl/spblas.hpp>

#include "sparse_blas/generic_container.hpp"

namespace oneapi::mkl::sparse {

// Complete the definition of incomplete types dense_vector_handle and dense_matrix_handle as there is no conflict with the oneMKL backends.
// Complete the definition of incomplete types dense_vector_handle and
// dense_matrix_handle as they don't exist in oneMKL backends yet.

struct dense_vector_handle : public detail::generic_dense_vector_handle<void*> {
template <typename T>
Expand Down Expand Up @@ -62,7 +64,9 @@ namespace oneapi::mkl::sparse::detail {
* Internal sparse_matrix_handle type for MKL backends.
* Here \p matrix_handle_t is the type of the backend's handle.
* The user-facing incomplete type matrix_handle_t must be kept incomplete.
* Internally matrix_handle_t is reinterpret_cast as oneapi::mkl::sparse::detail::sparse_matrix_handle which holds another matrix_handle_t for the backend handle.
* Internally matrix_handle_t is reinterpret_cast as
* oneapi::mkl::sparse::detail::sparse_matrix_handle which holds another
* matrix_handle_t for the backend handle.
*/
using sparse_matrix_handle = detail::generic_sparse_handle<matrix_handle_t>;

Expand Down

0 comments on commit 5c37ee3

Please sign in to comment.