/*! \file */ /* ************************************************************************ * Copyright (C) 2023 Advanced Micro Devices, Inc. All rights Reserved. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the Software), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * ************************************************************************ */ #ifndef ROCSPARSE_BSRSV_H #define ROCSPARSE_BSRSV_H #include "../../rocsparse-types.h" #include "rocsparse/rocsparse-export.h" #ifdef __cplusplus extern "C" { #endif /*! \ingroup level2_module * \details * \p rocsparse_bsrsv_zero_pivot returns \ref rocsparse_status_zero_pivot if either a * structural or numerical zero has been found during \ref rocsparse_sbsrsv_solve "rocsparse_sbsrsv_solve()" * computation. The first zero pivot \f$j\f$ at \f$A_{j,j}\f$ is stored in \p position, * using the same index base as the BSR matrix. * * \p position can be in host or device memory. If no zero pivot has been found, * \p position is set to -1 and \ref rocsparse_status_success is returned instead. * * \note \p rocsparse_bsrsv_zero_pivot is a blocking function. It might negatively influence * performance. * * \note * This routine does not support execution in a hipGraph context. * * @param[in] * handle handle to the rocSPARSE library context queue. * @param[in] * info structure that holds the information collected during the analysis step. * @param[inout] * position pointer to zero pivot \f$j\f$, which can be in host or device memory. * * \retval rocsparse_status_success the operation completed successfully. * \retval rocsparse_status_invalid_handle the library context was not initialized. * \retval rocsparse_status_invalid_pointer \p info or \p position pointer is * invalid. * \retval rocsparse_status_internal_error an internal error occurred. * \retval rocsparse_status_zero_pivot zero pivot has been found. */ ROCSPARSE_EXPORT rocsparse_status rocsparse_bsrsv_zero_pivot(rocsparse_handle handle, rocsparse_mat_info info, rocsparse_int* position); /*! \ingroup level2_module * \details * \p rocsparse_bsrsv_buffer_size returns the size of the temporary storage buffer that * is required by \ref rocsparse_sbsrsv_analysis "rocsparse_Xbsrsv_analysis()" and * \ref rocsparse_sbsrsv_solve "rocsparse_Xbsrsv_solve()". The temporary storage buffer * must be allocated by the user. * * \note * This function is non-blocking and executed asynchronously with respect to the host. * It can return before the actual computation has finished. * * \note * This routine supports execution in a hipGraph context. * * @param[in] * handle handle to the rocSPARSE library context queue. * @param[in] * dir matrix storage of BSR blocks. * @param[in] * trans matrix operation type. * @param[in] * mb number of block rows of the sparse BSR matrix. * @param[in] * nnzb number of non-zero blocks of the sparse BSR matrix. * @param[in] * descr descriptor of the sparse BSR matrix. * @param[in] * bsr_val array of \p nnzb blocks of the sparse BSR matrix. * @param[in] * bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of * the sparse BSR matrix. * @param[in] * bsr_col_ind array of \p nnz containing the block column indices of the sparse * BSR matrix. * @param[in] * block_dim block dimension of the sparse BSR matrix. * @param[out] * info structure that holds the information collected during the analysis step. * @param[out] * buffer_size number of bytes of the temporary storage buffer required by * rocsparse_sbsrsv_analysis(), rocsparse_dbsrsv_analysis(), * rocsparse_cbsrsv_analysis(), rocsparse_zbsrsv_analysis(), * rocsparse_sbsrsv_solve(), rocsparse_dbsrsv_solve(), * rocsparse_cbsrsv_solve(), and rocsparse_zbsrsv_solve(). * * \retval rocsparse_status_success the operation completed successfully. * \retval rocsparse_status_invalid_handle the library context was not initialized. * \retval rocsparse_status_invalid_size \p mb, \p nnzb, or \p block_dim is invalid. * \retval rocsparse_status_invalid_pointer \p descr, \p bsr_val, \p bsr_row_ptr, * \p bsr_col_ind, \p info, or \p buffer_size pointer is invalid. * \retval rocsparse_status_internal_error an internal error occurred. * \retval rocsparse_status_not_implemented * \p trans == \ref rocsparse_operation_conjugate_transpose or * \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general. */ /**@{*/ ROCSPARSE_EXPORT rocsparse_status rocsparse_sbsrsv_buffer_size(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const float* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, size_t* buffer_size); ROCSPARSE_EXPORT rocsparse_status rocsparse_dbsrsv_buffer_size(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const double* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, size_t* buffer_size); ROCSPARSE_EXPORT rocsparse_status rocsparse_cbsrsv_buffer_size(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const rocsparse_float_complex* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, size_t* buffer_size); ROCSPARSE_EXPORT rocsparse_status rocsparse_zbsrsv_buffer_size(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const rocsparse_double_complex* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, size_t* buffer_size); /**@}*/ /*! \ingroup level2_module * \details * \p rocsparse_bsrsv_analysis performs the analysis step for \ref rocsparse_sbsrsv_solve "rocsparse_sbsrsv_solve()". * It is expected that this function will be executed only once for a given matrix and particular operation type. * The analysis meta data can be cleared by \ref rocsparse_bsrsv_clear(). * * \p rocsparse_bsrsv_analysis can share its meta data with \ref rocsparse_sbsrsm_analysis "rocsparse_Xbsrsm_analysis()", * \ref rocsparse_sbsrilu0_analysis "rocsparse_Xbsrilu0_analysis()", and * \ref rocsparse_sbsric0_analysis "rocsparse_Xbsric0_analysis()". Selecting \ref rocsparse_analysis_policy_reuse policy * can greatly improve computation performance of metadata. However, the user needs to ensure that the sparsity * pattern remains unchanged. Otherwise, \ref rocsparse_analysis_policy_force has to be used. * * \note * If the matrix sparsity pattern changes, the gathered information will become invalid. * * \note * This function is blocking with respect to the host. * * \note * This routine does not support execution in a hipGraph context. * * @param[in] * handle handle to the rocSPARSE library context queue. * @param[in] * dir matrix storage of BSR blocks. * @param[in] * trans matrix operation type. * @param[in] * mb number of block rows of the sparse BSR matrix. * @param[in] * nnzb number of non-zero blocks of the sparse BSR matrix. * @param[in] * descr descriptor of the sparse BSR matrix. * @param[in] * bsr_val array of \p nnzb blocks of the sparse BSR matrix. * @param[in] * bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of * the sparse BSR matrix. * @param[in] * bsr_col_ind array of \p nnz containing the block column indices of the sparse * BSR matrix. * @param[in] * block_dim block dimension of the sparse BSR matrix. * @param[out] * info structure that holds the information collected during * the analysis step. * @param[in] * analysis \ref rocsparse_analysis_policy_reuse or * \ref rocsparse_analysis_policy_force. * @param[in] * solve \ref rocsparse_solve_policy_auto. * @param[in] * temp_buffer temporary storage buffer allocated by the user. * * \retval rocsparse_status_success the operation completed successfully. * \retval rocsparse_status_invalid_handle the library context was not initialized. * \retval rocsparse_status_invalid_size \p mb, \p nnzb, or \p block_dim is invalid. * \retval rocsparse_status_invalid_pointer \p descr, \p bsr_row_ptr, * \p bsr_col_ind, \p info, or \p temp_buffer pointer is invalid. * \retval rocsparse_status_internal_error an internal error occurred. * \retval rocsparse_status_not_implemented * \p trans == \ref rocsparse_operation_conjugate_transpose or * \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general. */ /**@{*/ ROCSPARSE_EXPORT rocsparse_status rocsparse_sbsrsv_analysis(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const float* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, rocsparse_analysis_policy analysis, rocsparse_solve_policy solve, void* temp_buffer); ROCSPARSE_EXPORT rocsparse_status rocsparse_dbsrsv_analysis(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const double* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, rocsparse_analysis_policy analysis, rocsparse_solve_policy solve, void* temp_buffer); ROCSPARSE_EXPORT rocsparse_status rocsparse_cbsrsv_analysis(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const rocsparse_float_complex* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, rocsparse_analysis_policy analysis, rocsparse_solve_policy solve, void* temp_buffer); ROCSPARSE_EXPORT rocsparse_status rocsparse_zbsrsv_analysis(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_mat_descr descr, const rocsparse_double_complex* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, rocsparse_analysis_policy analysis, rocsparse_solve_policy solve, void* temp_buffer); /**@}*/ /*! \ingroup level2_module * \details * \p rocsparse_bsrsv_clear deallocates all memory that was allocated by * \ref rocsparse_sbsrsv_analysis "rocsparse_sbsrsv_analysis()". This is especially useful * if memory is an issue and the analysis data is not required for further computation, for example, * when switching to another sparse matrix format. Calling \p rocsparse_bsrsv_clear is optional. * All allocated resources will be cleared when the opaque \ref rocsparse_mat_info struct is * destroyed using \ref rocsparse_destroy_mat_info(). * * \note * This routine does not support execution in a hipGraph context. * * @param[in] * handle handle to the rocSPARSE library context queue. * @param[inout] * info structure that holds the information collected during the analysis step. * * \retval rocsparse_status_success the operation completed successfully. * \retval rocsparse_status_invalid_handle the library context was not initialized. * \retval rocsparse_status_invalid_pointer \p info pointer is invalid. * \retval rocsparse_status_memory_error the buffer holding the meta data could not * be deallocated. * \retval rocsparse_status_internal_error an internal error occurred. */ ROCSPARSE_EXPORT rocsparse_status rocsparse_bsrsv_clear(rocsparse_handle handle, rocsparse_mat_info info); /*! \ingroup level2_module * \brief Sparse triangular solve using the BSR storage format. * * \details * \p rocsparse_bsrsv_solve solves a sparse triangular linear system of a sparse * \f$m \times m\f$ matrix, defined in BSR storage format, a dense solution vector * \f$y\f$, and the right-hand side \f$x\f$ that is multiplied by \f$\alpha\f$, such that * \f[ * op(A) \cdot y = \alpha \cdot x, * \f] * with * \f[ * op(A) = \left\{ * \begin{array}{ll} * A, & \text{if trans == rocsparse_operation_none} \\ * A^T, & \text{if trans == rocsparse_operation_transpose} * \end{array} * \right. * \f] * * Performing the above operation requires three steps. First, call * \ref rocsparse_sbsrsv_buffer_size "rocsparse_Xbsrsv_buffer_size()", which will determine the size of the required * temporary storage buffer. Then allocate this buffer and call * \ref rocsparse_sbsrsv_analysis "rocsparse_Xbsrsv_analysis()", which will perform analysis on the sparse matrix * \f$op(A)\f$. Finally, complete the computation by calling \p rocsparse_bsrsv_solve. The buffer size, * buffer allocation, and analysis only need to be called once for a given sparse matrix \f$op(A)\f$, while the * computation stage can be repeatedly used with different \f$x\f$ and \f$y\f$ vectors. After all calls to * \p rocsparse_bsrsv_solve are complete, the temporary buffer can be deallocated. * * Solving a triangular system involves inverting the diagonal blocks. This means that if the sparse matrix is * missing the diagonal block (referred to as a structural zero) or the diagonal block is not invertible (referred * to as a numerical zero), then a solution is not possible. \p rocsparse_bsrsv_solve tracks the location of the first * zero pivot (either numerical or structural zero). The zero pivot status can be checked by calling \ref rocsparse_bsrsv_zero_pivot(). * If \ref rocsparse_bsrsv_zero_pivot() returns \ref rocsparse_status_success, then no zero pivot was found and therefore * the matrix does not have a structural or numerical zero. * * The user can specify that the sparse matrix should be interpreted as having identity blocks on the diagonal by setting the diagonal * type on the descriptor \p descr to \ref rocsparse_diag_type_unit using \ref rocsparse_set_mat_diag_type. If * \ref rocsparse_diag_type == \ref rocsparse_diag_type_unit, no zero pivot will be reported, even if the diagonal block \f$A_{j,j}\f$ * for some \f$j\f$ is not invertible. * * The sparse CSR matrix passed to \p rocsparse_bsrsv_solve does not actually have to be a triangular matrix. Instead, the * triangular upper or lower part of the sparse matrix is solved based on \ref rocsparse_fill_mode set on the descriptor * \p descr. If the fill mode is set to \ref rocsparse_fill_mode_lower, then the lower triangular matrix is solved. If the * fill mode is set to \ref rocsparse_fill_mode_upper, then the upper triangular matrix is solved. * * \note * The sparse BSR matrix has to be sorted. * * \note * This function is non-blocking and executed asynchronously with respect to the host. * It can return before the actual computation has finished. * * \note * Currently, only \p trans == \ref rocsparse_operation_none and * \p trans == \ref rocsparse_operation_transpose are supported. * * \note * This routine supports execution in a hipGraph context. * * @param[in] * handle handle to the rocSPARSE library context queue. * @param[in] * dir matrix storage of BSR blocks. * @param[in] * trans matrix operation type. * @param[in] * mb number of block rows of the sparse BSR matrix. * @param[in] * nnzb number of non-zero blocks of the sparse BSR matrix. * @param[in] * alpha scalar \f$\alpha\f$. * @param[in] * descr descriptor of the sparse BSR matrix. * @param[in] * bsr_val array of \p nnzb blocks of the sparse BSR matrix. * @param[in] * bsr_row_ptr array of \p mb+1 elements that point to the start of every block row of * the sparse BSR matrix. * @param[in] * bsr_col_ind array of \p nnz containing the block column indices of the sparse * BSR matrix. * @param[in] * block_dim block dimension of the sparse BSR matrix. * @param[in] * info structure that holds the information collected during the analysis step. * @param[in] * x array of \p m elements, holding the right-hand side. * @param[out] * y array of \p m elements, holding the solution. * @param[in] * policy \ref rocsparse_solve_policy_auto. * @param[in] * temp_buffer temporary storage buffer allocated by the user. * * \retval rocsparse_status_success the operation completed successfully. * \retval rocsparse_status_invalid_handle the library context was not initialized. * \retval rocsparse_status_invalid_size \p mb, \p nnzb, or \p block_dim is invalid. * \retval rocsparse_status_invalid_pointer \p descr, \p alpha, \p bsr_val, * \p bsr_row_ptr, \p bsr_col_ind, \p x, or \p y pointer is invalid. * \retval rocsparse_status_arch_mismatch the device is not supported. * \retval rocsparse_status_internal_error an internal error occurred. * \retval rocsparse_status_not_implemented * \p trans == \ref rocsparse_operation_conjugate_transpose or * \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general. * * \par Example * Consider the lower triangular \f$m \times m\f$ matrix \f$L\f$, stored in BSR * storage format with unit diagonal. The following example solves \f$L \cdot y = x\f$. * \snippet example_rocsparse_bsrsv.cpp doc example */ /**@{*/ ROCSPARSE_EXPORT rocsparse_status rocsparse_sbsrsv_solve(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const float* alpha, const rocsparse_mat_descr descr, const float* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, const float* x, float* y, rocsparse_solve_policy policy, void* temp_buffer); ROCSPARSE_EXPORT rocsparse_status rocsparse_dbsrsv_solve(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const double* alpha, const rocsparse_mat_descr descr, const double* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, const double* x, double* y, rocsparse_solve_policy policy, void* temp_buffer); ROCSPARSE_EXPORT rocsparse_status rocsparse_cbsrsv_solve(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_float_complex* alpha, const rocsparse_mat_descr descr, const rocsparse_float_complex* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, const rocsparse_float_complex* x, rocsparse_float_complex* y, rocsparse_solve_policy policy, void* temp_buffer); ROCSPARSE_EXPORT rocsparse_status rocsparse_zbsrsv_solve(rocsparse_handle handle, rocsparse_direction dir, rocsparse_operation trans, rocsparse_int mb, rocsparse_int nnzb, const rocsparse_double_complex* alpha, const rocsparse_mat_descr descr, const rocsparse_double_complex* bsr_val, const rocsparse_int* bsr_row_ptr, const rocsparse_int* bsr_col_ind, rocsparse_int block_dim, rocsparse_mat_info info, const rocsparse_double_complex* x, rocsparse_double_complex* y, rocsparse_solve_policy policy, void* temp_buffer); /**@}*/ #ifdef __cplusplus } #endif #endif /* ROCSPARSE_BSRSV_H */