derek.holloway
7502bf64a4
CodeQL / Analyze (actions) (push) Canceled after 0s
CodeQL / Analyze (python) (push) Canceled after 0s
pre-commit / pre-commit (push) Canceled after 0s
Multi-Arch CI / setup (push) Canceled after 0s
Publish build_manylinux_x86_64 images / publish_build_manylinux_x86_64 (push) Canceled after 0s
Setup (Multi-Arch) / setup (push) Canceled after 0s
Multi-Arch CI / Linux::${{ fromJSON(needs.setup.outputs.linux_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubi10 image / publish_no_rocm_image_ubi10 (push) Canceled after 0s
Multi-Arch CI / Windows::${{ fromJSON(needs.setup.outputs.windows_build_config || '{}').build_variant_label || 'skip' }} (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Multi-Arch CI / Manifest Diff (push) Canceled after 0s
TheRock Manifest Diff Report / Generate Manifest Diff Report (push) Canceled after 0s
Multi-Arch CI / CI Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_ocl_rt images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04_rocgdb images / publish_no_rocm_image_ubuntu24_04_rocgdb (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_ocl_rt (push) Canceled after 0s
Publish TheRock Docker image / build-and-push-image (push) Canceled after 0s
Unit Tests / Unit Tests :: ubuntu-24.04 (push) Canceled after 0s
Unit Tests / Unit Tests :: windows-2022 (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_media (push) Canceled after 0s
Unit Tests / Unit Tests Summary (push) Canceled after 0s
Publish no_rocm_image_ubuntu24_04 images / publish_no_rocm_image_ubuntu24_04_openmpi (push) Canceled after 0s
659 lines
34 KiB
C
659 lines
34 KiB
C
/*! \file */
|
|
/* ************************************************************************
|
|
* Copyright (C) 2023-2024 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_CSRSM_H
|
|
#define ROCSPARSE_CSRSM_H
|
|
|
|
#include "../../rocsparse-types.h"
|
|
#include "rocsparse/rocsparse-export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \ingroup level3_module
|
|
* \details
|
|
* \p rocsparse_csrsm_zero_pivot returns \ref rocsparse_status_zero_pivot if either a
|
|
* structural or numerical zero has been found during
|
|
* \ref rocsparse_scsrsm_solve "rocsparse_Xcsrsm_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 CSR 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_csrsm_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_csrsm_zero_pivot(rocsparse_handle handle,
|
|
rocsparse_mat_info info,
|
|
rocsparse_int* position);
|
|
|
|
/*! \ingroup level3_module
|
|
* \details
|
|
* \p rocsparse_csrsm_buffer_size returns the size of the temporary storage buffer that
|
|
* is required by \ref rocsparse_scsrsm_analysis "rocsparse_Xcsrsm_analysis()" and
|
|
* \ref rocsparse_scsrsm_solve "rocsparse_Xcsrsm_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]
|
|
* trans_A matrix A operation type.
|
|
* @param[in]
|
|
* trans_B matrix B operation type.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* nrhs number of columns of the column-oriented dense matrix op(B).
|
|
* @param[in]
|
|
* nnz number of non-zero entries of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* alpha scalar \f$\alpha\f$.
|
|
* @param[in]
|
|
* descr descriptor of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_val array of \p nnz elements of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_row_ptr array of \p m+1 elements that point to the start of every row of the
|
|
* sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
|
|
* CSR matrix A.
|
|
* @param[in]
|
|
* B column-oriented dense matrix of dimension \p m \f$\times\f$ \p nrhs elements of the rhs matrix B.
|
|
* @param[in]
|
|
* ldb leading dimension of rhs matrix B.
|
|
* @param[in]
|
|
* info structure that holds the information collected during the analysis step.
|
|
* @param[in]
|
|
* policy \ref rocsparse_solve_policy_auto.
|
|
* @param[out]
|
|
* buffer_size number of bytes of the temporary storage buffer required by
|
|
* rocsparse_scsrsm_analysis(), rocsparse_dcsrsm_analysis(),
|
|
* rocsparse_ccsrsm_analysis(), rocsparse_zcsrsm_analysis(),
|
|
* rocsparse_scsrsm_solve(), rocsparse_dcsrsm_solve(),
|
|
* rocsparse_ccsrsm_solve(), and rocsparse_zcsrsm_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 m, \p nrhs, or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p alpha, \p descr, \p csr_val,
|
|
* \p csr_row_ptr, \p csr_col_ind, \p B, \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_A == \ref rocsparse_operation_conjugate_transpose,
|
|
* \p trans_B == \ref rocsparse_operation_conjugate_transpose, or
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_scsrsm_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const float* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const float* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const float* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dcsrsm_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const double* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const double* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const double* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_ccsrsm_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const rocsparse_float_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_float_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const rocsparse_float_complex* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zcsrsm_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const rocsparse_double_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_double_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const rocsparse_double_complex* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
size_t* buffer_size);
|
|
/**@}*/
|
|
|
|
/*! \ingroup level3_module
|
|
* \details
|
|
* \p rocsparse_csrsm_analysis performs the analysis step for
|
|
* \ref rocsparse_scsrsm_solve "rocsparse_Xcsrsm_solve()". It is expected that this
|
|
* function will be executed only once for a given matrix and particular operation
|
|
* type. The analysis metadata can be cleared by \ref rocsparse_csrsm_clear().
|
|
*
|
|
* \p rocsparse_csrsm_analysis can share its meta data with
|
|
* \ref rocsparse_scsrilu0_analysis "rocsparse_Xcsrilu0_analysis()",
|
|
* \ref rocsparse_scsric0_analysis "rocsparse_Xcsric0_analysis()", and
|
|
* \ref rocsparse_scsrsv_analysis "rocsparse_Xcsrsv_analysis()". Selecting
|
|
* \ref rocsparse_analysis_policy_reuse policy can greatly improve computation
|
|
* performance of the metadata. However, the user needs to ensure that the sparsity
|
|
* pattern remains unchanged. If this cannot be assured,
|
|
* \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]
|
|
* trans_A matrix A operation type.
|
|
* @param[in]
|
|
* trans_B matrix B operation type.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* nrhs number of columns of the column-oriented dense matrix op(B).
|
|
* @param[in]
|
|
* nnz number of non-zero entries of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* alpha scalar \f$\alpha\f$.
|
|
* @param[in]
|
|
* descr descriptor of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_val array of \p nnz elements of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_row_ptr array of \p m+1 elements that point to the start of every row of the
|
|
* sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
|
|
* CSR matrix A.
|
|
* @param[in]
|
|
* B column-oriented dense matrix of dimension \p m \f$\times\f$ \p nrhs elements of the rhs matrix B.
|
|
* @param[in]
|
|
* ldb leading dimension of rhs matrix B.
|
|
* @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 m, \p nrhs, or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p alpha, \p descr, \p csr_val,
|
|
* \p csr_row_ptr, \p csr_col_ind, \p B, \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_A == \ref rocsparse_operation_conjugate_transpose,
|
|
* \p trans_B == \ref rocsparse_operation_conjugate_transpose, or
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_scsrsm_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const float* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const float* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const float* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dcsrsm_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const double* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const double* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const double* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_ccsrsm_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const rocsparse_float_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_float_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const rocsparse_float_complex* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zcsrsm_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const rocsparse_double_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_double_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
const rocsparse_double_complex* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
/**@}*/
|
|
|
|
/*! \ingroup level3_module
|
|
* \details
|
|
* \p rocsparse_csrsm_clear deallocates all memory that was allocated by
|
|
* \ref rocsparse_scsrsm_analysis "rocsparse_Xcsrsm_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_csrsm_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 metadata could not
|
|
* be deallocated.
|
|
* \retval rocsparse_status_internal_error an internal error occurred.
|
|
*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_csrsm_clear(rocsparse_handle handle, rocsparse_mat_info info);
|
|
|
|
/*! \ingroup level3_module
|
|
* \brief Sparse triangular system solve using the CSR storage format.
|
|
*
|
|
* \details
|
|
* \p rocsparse_csrsm_solve solves a sparse triangular linear system of a sparse
|
|
* \f$m \times m\f$ matrix, defined in CSR storage format, a column-oriented dense solution matrix
|
|
* \f$X\f$ and the column-oriented dense right-hand side matrix \f$B\f$ that is multiplied by \f$\alpha\f$, such that
|
|
* \f[
|
|
* op(A) \cdot op(X) = \alpha \cdot op(B),
|
|
* \f]
|
|
* with
|
|
* \f[
|
|
* op(A) = \left\{
|
|
* \begin{array}{ll}
|
|
* A, & \text{if trans_A == rocsparse_operation_none} \\
|
|
* A^T, & \text{if trans_A == rocsparse_operation_transpose} \\
|
|
* A^H, & \text{if trans_A == rocsparse_operation_conjugate_transpose}
|
|
* \end{array}
|
|
* \right.
|
|
* \f]
|
|
* ,
|
|
* \f[
|
|
* op(B) = \left\{
|
|
* \begin{array}{ll}
|
|
* B, & \text{if trans_B == rocsparse_operation_none} \\
|
|
* B^T, & \text{if trans_B == rocsparse_operation_transpose} \\
|
|
* B^H, & \text{if trans_B == rocsparse_operation_conjugate_transpose}
|
|
* \end{array}
|
|
* \right.
|
|
* \f]
|
|
* and
|
|
* \f[
|
|
* op(X) = \left\{
|
|
* \begin{array}{ll}
|
|
* X, & \text{if trans_B == rocsparse_operation_none} \\
|
|
* X^T, & \text{if trans_B == rocsparse_operation_transpose} \\
|
|
* X^H, & \text{if trans_B == rocsparse_operation_conjugate_transpose}
|
|
* \end{array}
|
|
* \right.
|
|
* \f]
|
|
*
|
|
* The solution is performed inplace, meaning that the matrix B is overwritten with the solution
|
|
* X after calling \p rocsparse_csrsm_solve. Given that the sparse matrix A is a square matrix, its
|
|
* size is \f$m \times m\f$, regardless of whether A is transposed or not. The size of the column-oriented dense
|
|
* matrices B and X depends on the value of \p trans_B:
|
|
*
|
|
* \f[
|
|
* op(B)/op(X) = \left\{
|
|
* \begin{array}{ll}
|
|
* ldb \times nrhs, \text{ } ldb \ge m, & \text{if trans_B == rocsparse_operation_none} \\
|
|
* ldb \times m, \text{ } ldb \ge nrhs, & \text{if trans_B == rocsparse_operation_transpose} \\
|
|
* ldb \times m, \text{ } ldb \ge nrhs, & \text{if trans_B == rocsparse_operation_conjugate_transpose}
|
|
* \end{array}
|
|
* \right.
|
|
* \f]
|
|
*
|
|
* \p rocsparse_csrsm_solve requires a user-allocated temporary buffer. Its size is returned by
|
|
* \ref rocsparse_scsrsm_buffer_size "rocsparse_Xcsrsm_buffer_size()". The size of the required buffer is
|
|
* larger when \p trans_A equals \ref rocsparse_operation_transpose or \ref rocsparse_operation_conjugate_transpose
|
|
* and when \p trans_B is \ref rocsparse_operation_none. The subsequent solve will also be faster when \f$A\f$
|
|
* is non-transposed and \f$B\f$ is transposed (or conjugate transposed). For example, instead of solving:
|
|
*
|
|
* \f[
|
|
* \begin{bmatrix}
|
|
* a_{00} & 0 & 0 \\
|
|
* a_{10} & a_{11} & 0 \\
|
|
* a_{20} & a_{21} & a_{22} \\
|
|
* \end{bmatrix}
|
|
* \cdot
|
|
* \begin{bmatrix}
|
|
* x_{00} & x_{01} \\
|
|
* x_{10} & x_{11} \\
|
|
* x_{20} & x_{21} \\
|
|
* \end{bmatrix}
|
|
* =
|
|
* \begin{bmatrix}
|
|
* b_{00} & b_{01} \\
|
|
* b_{10} & b_{11} \\
|
|
* b_{20} & b_{21} \\
|
|
* \end{bmatrix}
|
|
* \f]
|
|
*
|
|
* Consider solving:
|
|
*
|
|
* \f[
|
|
* \begin{bmatrix}
|
|
* a_{00} & 0 & 0 \\
|
|
* a_{10} & a_{11} & 0 \\
|
|
* a_{20} & a_{21} & a_{22}
|
|
* \end{bmatrix}
|
|
* \cdot
|
|
* \begin{bmatrix}
|
|
* x_{00} & x_{10} & x_{20} \\
|
|
* x_{01} & x_{11} & x_{21}
|
|
* \end{bmatrix}^{T}
|
|
* =
|
|
* \begin{bmatrix}
|
|
* b_{00} & b_{10} & b_{20} \\
|
|
* b_{01} & b_{11} & b_{21}
|
|
* \end{bmatrix}^{T}
|
|
* \f]
|
|
*
|
|
* After the temporary storage buffer has been allocated, analysis of the metadata is required.
|
|
* It can be obtained by \ref rocsparse_scsrsm_analysis "rocsparse_Xcsrsm_analysis()".
|
|
*
|
|
* Solving a triangular system involves division by the diagonal elements. This means that if the sparse matrix is
|
|
* missing the diagonal entry (referred to as a structural zero) or the diagonal entry is zero (referred to as a numerical zero),
|
|
* then a division by zero would occur. \p rocsparse_csrsm_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_csrsm_zero_pivot(). If
|
|
* \ref rocsparse_csrsm_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 ones 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 \f$A_{j,j} = 0\f$ for
|
|
* some \f$j\f$.
|
|
*
|
|
* The sparse CSR matrix passed to \p rocsparse_csrsm_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 the \ref rocsparse_fill_mode setting 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 CSR matrix has to be sorted. This can be achieved by calling
|
|
* rocsparse_csrsort().
|
|
*
|
|
* \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_A != \ref rocsparse_operation_conjugate_transpose and
|
|
* \p trans_B != \ref rocsparse_operation_conjugate_transpose is supported.
|
|
*
|
|
* \note
|
|
* This routine supports execution in a hipGraph context.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the rocSPARSE library context queue.
|
|
* @param[in]
|
|
* trans_A matrix A operation type.
|
|
* @param[in]
|
|
* trans_B matrix B operation type.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* nrhs number of columns of the column-oriented dense matrix op(B).
|
|
* @param[in]
|
|
* nnz number of non-zero entries of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* alpha scalar \f$\alpha\f$.
|
|
* @param[in]
|
|
* descr descriptor of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_val array of \p nnz elements of the sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_row_ptr array of \p m+1 elements that point to the start of every row of the
|
|
* sparse CSR matrix A.
|
|
* @param[in]
|
|
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
|
|
* CSR matrix A.
|
|
* @param[inout]
|
|
* B column-oriented dense matrix of dimension \p m \f$\times\f$ \p nrhs elements of the rhs matrix B.
|
|
* @param[in]
|
|
* ldb leading dimension of rhs matrix B.
|
|
* @param[in]
|
|
* info structure that holds the information collected during the analysis step.
|
|
* @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 m, \p nrhs, or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p alpha, \p descr, \p csr_val,
|
|
* \p csr_row_ptr, \p csr_col_ind, \p B, \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_A == \ref rocsparse_operation_conjugate_transpose,
|
|
* \p trans_B == \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 CSR
|
|
* storage format with unit diagonal. The following example solves \f$L \cdot X = B\f$.
|
|
* \snippet example_rocsparse_csrmm.cpp doc example
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_scsrsm_solve(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const float* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const float* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
float* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dcsrsm_solve(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const double* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const double* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
double* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_ccsrsm_solve(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const rocsparse_float_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_float_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_float_complex* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zcsrsm_solve(rocsparse_handle handle,
|
|
rocsparse_operation trans_A,
|
|
rocsparse_operation trans_B,
|
|
rocsparse_int m,
|
|
rocsparse_int nrhs,
|
|
rocsparse_int nnz,
|
|
const rocsparse_double_complex* alpha,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_double_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_double_complex* B,
|
|
rocsparse_int ldb,
|
|
rocsparse_mat_info info,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
/**@}*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ROCSPARSE_CSRSM_H */
|