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
914 lines
45 KiB
C
914 lines
45 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_CSRITSV_H
|
|
#define ROCSPARSE_CSRITSV_H
|
|
|
|
#include "../../rocsparse-types.h"
|
|
#include "rocsparse/rocsparse-export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \ingroup level2_module
|
|
* \details
|
|
* \p rocsparse_csritsv_zero_pivot returns \ref rocsparse_status_zero_pivot if either a
|
|
* structural or numerical zero has been found during
|
|
* \ref rocsparse_scsritsv_solve "rocsparse_Xcsritsv_solve()" and/or
|
|
* \ref rocsparse_scsritsv_analysis "rocsparse_Xcsritsv_analysis()" execution. 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_csritsv_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]
|
|
* descr descriptor of the sparse CSR matrix.
|
|
* @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_csritsv_zero_pivot(rocsparse_handle handle,
|
|
const rocsparse_mat_descr descr,
|
|
rocsparse_mat_info info,
|
|
rocsparse_int* position);
|
|
|
|
/*! \ingroup level2_module
|
|
* \details
|
|
* \p rocsparse_csritsv_buffer_size returns the size of the temporary storage buffer that
|
|
* is required by \ref rocsparse_scsritsv_analysis "rocsparse_Xcsritsv_analysis()" and
|
|
* \ref rocsparse_scsritsv_solve "rocsparse_Xcsritsv_solve()". The temporary storage buffer
|
|
* must be allocated by the user.
|
|
*
|
|
* \note
|
|
* This routine does not support execution in a hipGraph context.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the rocSPARSE library context queue.
|
|
* @param[in]
|
|
* trans matrix operation type.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix.
|
|
* @param[in]
|
|
* nnz number of non-zero entries of the sparse CSR matrix.
|
|
* @param[in]
|
|
* descr descriptor of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_val array of \p nnz elements of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_row_ptr array of \p m+1 elements that point to the start of every row of the
|
|
* sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
|
|
* CSR 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
|
|
* \ref rocsparse_scsritsv_analysis "rocsparse_Xcsritsv_analysis()" and
|
|
* \ref rocsparse_scsritsv_solve "rocsparse_Xcsritsv_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 or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p descr, \p csr_val, \p csr_row_ptr,
|
|
* \p csr_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
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general and \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_triangular.
|
|
*/
|
|
/**@{*/
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_scsritsv_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const float* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dcsritsv_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const double* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_ccsritsv_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_float_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zcsritsv_buffer_size(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_double_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
size_t* buffer_size);
|
|
|
|
/**@}*/
|
|
|
|
/*! \ingroup level2_module
|
|
* \details
|
|
* \p rocsparse_csritsv_analysis performs the analysis step for \ref rocsparse_scsritsv_solve "rocsparse_Xcsritsv_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_csritsv_clear().
|
|
*
|
|
* Selecting
|
|
* \ref rocsparse_analysis_policy_reuse policy can greatly improve the computation
|
|
* performance of 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 matrix operation type.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix.
|
|
* @param[in]
|
|
* nnz number of non-zero entries of the sparse CSR matrix.
|
|
* @param[in]
|
|
* descr descriptor of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_val array of \p nnz elements of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_row_ptr array of \p m+1 elements that point to the start of every row of the
|
|
* sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
|
|
* CSR 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 m or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p descr, \p csr_row_ptr,
|
|
* \p csr_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
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general and \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_triangular.
|
|
*/
|
|
/**@{*/
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_scsritsv_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const float* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dcsritsv_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const double* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_ccsritsv_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_float_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zcsritsv_analysis(rocsparse_handle handle,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
rocsparse_int nnz,
|
|
const rocsparse_mat_descr descr,
|
|
const rocsparse_double_complex* csr_val,
|
|
const rocsparse_int* csr_row_ptr,
|
|
const rocsparse_int* csr_col_ind,
|
|
rocsparse_mat_info info,
|
|
rocsparse_analysis_policy analysis,
|
|
rocsparse_solve_policy solve,
|
|
void* temp_buffer);
|
|
|
|
/**@}*/
|
|
/*! \ingroup level2_module
|
|
* \details
|
|
* \p rocsparse_csritsv_clear deallocates all memory that was allocated by
|
|
* \ref rocsparse_scsritsv_analysis "rocsparse_Xcsritsv_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_csritsv_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[in]
|
|
* descr descriptor of the sparse CSR matrix.
|
|
* @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_csritsv_clear(rocsparse_handle handle,
|
|
const rocsparse_mat_descr descr,
|
|
rocsparse_mat_info info);
|
|
|
|
/*! \ingroup level2_module
|
|
* \brief Sparse iterative triangular solve using the CSR storage format.
|
|
*
|
|
* \details
|
|
* \p rocsparse_csritsv_solve solves iteratively, with the use of the Jacobi method, a sparse triangular linear system of a sparse
|
|
* \f$m \times m\f$ matrix, defined in CSR 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) y = \alpha 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} \\
|
|
* A^H, & \text{if trans == rocsparse_operation_conjugate_transpose}
|
|
* \end{array}
|
|
* \right.
|
|
* \f]
|
|
*
|
|
* The Jacobi method applied to the sparse triangular linear system above gives
|
|
* \f[
|
|
* y_{k+1} = y_{k} + D^{-1} ( \alpha x - (D + T) y_{k} )
|
|
* \f]
|
|
* with \f$A = D + T\f$, \f$D\f$ the diagonal of \f$A\f$ and \f$T\f$ the strict triangular part of \f$A\f$.
|
|
*
|
|
* The above equation can be also written as
|
|
* \f[
|
|
* y_{k+1} = y_{k} + D^{-1} r_k
|
|
* \f]
|
|
* where
|
|
* \f[
|
|
* r_k = \alpha x - (D + T) y_k.
|
|
* \f]
|
|
* Starting with \f$y_0 = \f$ \p y, the method iterates if \f$ 0 \le k \lt \f$ \p host_nmaxiter and if
|
|
* \f[
|
|
* \Vert r_k \Vert_{\infty} \gt \epsilon,
|
|
* \f]
|
|
* with \f$\epsilon\f$ = \p host_tol.
|
|
*
|
|
* \p rocsparse_csritsv_solve requires a user allocated temporary buffer. Its size is
|
|
* returned by \ref rocsparse_scsritsv_buffer_size "rocsparse_Xcsritsv_buffer_size()".
|
|
* In addition, analysis metadata is required. It can be obtained by
|
|
* \ref rocsparse_scsritsv_analysis "rocsparse_Xcsritsv_analysis()". \p rocsparse_csritsv_solve
|
|
* reports the first zero pivot (either numerical or structural zero).
|
|
* The zero pivot status can be checked by calling \ref rocsparse_csritsv_zero_pivot(). 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$.
|
|
*
|
|
* \note
|
|
* The sparse CSR matrix has to be sorted. This can be achieved by calling
|
|
* rocsparse_csrsort().
|
|
*
|
|
* \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[inout]
|
|
* host_nmaxiter maximum number of iterations on input and number of iterations on output. If the output number of iterations is strictly less than the input maximum number of iterations, then the algorithm converged.
|
|
* @param[in]
|
|
* host_tol if the pointer is null then loop will execute \p nmaxiter[0] iterations.
|
|
* @param[out]
|
|
* host_history optional array to record the norm of the residual before each iteration.
|
|
* @param[in]
|
|
* trans matrix operation type.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix.
|
|
* @param[in]
|
|
* nnz number of non-zero entries of the sparse CSR matrix.
|
|
* @param[in]
|
|
* alpha scalar \f$\alpha\f$.
|
|
* @param[in]
|
|
* descr descriptor of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_val array of \p nnz elements of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_row_ptr array of \p m+1 elements that point to the start
|
|
* of every row of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
|
|
* CSR 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[inout]
|
|
* 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 m or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p descr, \p alpha, \p csr_val,
|
|
* \p csr_row_ptr, \p csr_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
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general and \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_triangular.
|
|
*
|
|
* \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 y = x\f$.
|
|
* \code{.c}
|
|
* // Create rocSPARSE handle
|
|
* rocsparse_handle handle;
|
|
* rocsparse_create_handle(&handle);
|
|
*
|
|
* // Create matrix descriptor
|
|
* rocsparse_mat_descr descr;
|
|
* rocsparse_create_mat_descr(&descr);
|
|
* rocsparse_set_mat_fill_mode(descr, rocsparse_fill_mode_lower);
|
|
* rocsparse_set_mat_diag_type(descr, rocsparse_diag_type_unit);
|
|
*
|
|
* // Create matrix info structure
|
|
* rocsparse_mat_info info;
|
|
* rocsparse_create_mat_info(&info);
|
|
*
|
|
* // Obtain required buffer size
|
|
* size_t buffer_size;
|
|
* rocsparse_dcsritsv_buffer_size(handle,
|
|
* rocsparse_operation_none,
|
|
* m,
|
|
* nnz,
|
|
* descr,
|
|
* csr_val,
|
|
* csr_row_ptr,
|
|
* csr_col_ind,
|
|
* info,
|
|
* &buffer_size);
|
|
*
|
|
* // Allocate temporary buffer
|
|
* void* temp_buffer;
|
|
* hipMalloc(&temp_buffer, buffer_size);
|
|
*
|
|
* // Perform analysis step
|
|
* rocsparse_dcsritsv_analysis(handle,
|
|
* rocsparse_operation_none,
|
|
* m,
|
|
* nnz,
|
|
* descr,
|
|
* csr_val,
|
|
* csr_row_ptr,
|
|
* csr_col_ind,
|
|
* info,
|
|
* rocsparse_analysis_policy_reuse,
|
|
* rocsparse_solve_policy_auto,
|
|
* temp_buffer);
|
|
*
|
|
* // Solve Ly = x
|
|
* rocsparse_int nmaxiter = 200;
|
|
* rocsparse_int host_maxiter = nmaxiter;
|
|
* double host_tol = 1.0e-4;
|
|
* double host_history[200];
|
|
*
|
|
* // Initialization of y
|
|
* hipMemset(y, 0, sizeof(double) * m);
|
|
*
|
|
* rocsparse_dcsritsv_solve(handle,
|
|
* &host_maxiter,
|
|
* &host_tol,
|
|
* host_history,
|
|
* rocsparse_operation_none,
|
|
* m,
|
|
* nnz,
|
|
* &alpha,
|
|
* descr,
|
|
* csr_val,
|
|
* csr_row_ptr,
|
|
* csr_col_ind,
|
|
* info,
|
|
* x,
|
|
* y,
|
|
* rocsparse_solve_policy_auto,
|
|
* temp_buffer);
|
|
*
|
|
* if (host_maxiter < nmaxiter)
|
|
* {
|
|
* printf("convergence\n");
|
|
* }
|
|
* else
|
|
* {
|
|
* printf("no convergence\n");
|
|
* }
|
|
* for (int i=0;i<=host_maxiter;++i)
|
|
* {
|
|
* printf("iter = %d, nrm inf residual=%e\n", i, host_history[i]);
|
|
* }
|
|
|
|
* // No zero pivot should be found, with L having unit diagonal
|
|
*
|
|
* // Clean up
|
|
* hipFree(temp_buffer);
|
|
* rocsparse_destroy_mat_info(info);
|
|
* rocsparse_destroy_mat_descr(descr);
|
|
* rocsparse_destroy_handle(handle);
|
|
* \endcode
|
|
*/
|
|
/**@{*/
|
|
|
|
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
|
|
"Use rocsparse_scsritsv_solve_ex instead.")))
|
|
ROCSPARSE_EXPORT rocsparse_status
|
|
rocsparse_scsritsv_solve(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
const float* host_tol,
|
|
float* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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,
|
|
rocsparse_mat_info info,
|
|
const float* x,
|
|
float* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
|
|
"Use rocsparse_dcsritsv_solve_ex instead.")))
|
|
ROCSPARSE_EXPORT rocsparse_status
|
|
rocsparse_dcsritsv_solve(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
const double* host_tol,
|
|
double* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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,
|
|
rocsparse_mat_info info,
|
|
const double* x,
|
|
double* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
|
|
"Use rocsparse_ccsritsv_solve_ex instead.")))
|
|
ROCSPARSE_EXPORT rocsparse_status
|
|
rocsparse_ccsritsv_solve(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
const float* host_tol,
|
|
float* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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_mat_info info,
|
|
const rocsparse_float_complex* x,
|
|
rocsparse_float_complex* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
__attribute__((deprecated("This function is deprecated and will be removed in a future release. "
|
|
"Use rocsparse_zcsritsv_solve_ex instead.")))
|
|
ROCSPARSE_EXPORT rocsparse_status
|
|
rocsparse_zcsritsv_solve(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
const double* host_tol,
|
|
double* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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_mat_info info,
|
|
const rocsparse_double_complex* x,
|
|
rocsparse_double_complex* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
/**@}*/
|
|
|
|
/*! \ingroup level2_module
|
|
* \brief Sparse iterative triangular solve using the CSR storage format.
|
|
*
|
|
* \details
|
|
* \p rocsparse_csritsv_solve_ex solves iteratively, with the use of the Jacobi method, a sparse triangular linear system of a sparse
|
|
* \f$m \times m\f$ matrix, defined in CSR 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) y = \alpha 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} \\
|
|
* A^H, & \text{if trans == rocsparse_operation_conjugate_transpose}
|
|
* \end{array}
|
|
* \right.
|
|
* \f]
|
|
*
|
|
* The Jacobi method applied to the sparse triangular linear system above gives
|
|
* \f[
|
|
* y_{k+1} = y_{k} + D^{-1} ( \alpha x - (D + T) y_{k} )
|
|
* \f]
|
|
* with \f$A = D + T\f$, \f$D\f$ the diagonal of \f$A\f$ and \f$T\f$ the strict triangular part of \f$A\f$.
|
|
*
|
|
* The above equation can be also written as
|
|
* \f[
|
|
* y_{k+1} = y_{k} + D^{-1} r_k
|
|
* \f]
|
|
* where
|
|
* \f[
|
|
* r_k = \alpha x - (D + T) y_k.
|
|
* \f]
|
|
* Starting with \f$y_0 = \f$ \p y, the method iterates if \f$ 0 \le k \lt \f$ \p host_nmaxiter and if
|
|
* \f[
|
|
* \Vert r_k \Vert_{\infty} \gt \epsilon,
|
|
* \f]
|
|
* with \f$\epsilon\f$ = \p host_tol.
|
|
*
|
|
* The parameter \p host_nfreeiter is used to control the frequence of the stopping criteria evaluation, potentially improving the performance of the algorithm with less norm calculation. Between each iteration of index \f$ k \f$, \p host_nfreeiter are performed without stopping criteria evaluation. Therefore, if the convergence is obtained at index \f$ k \f$, that means \f$ (k + 1) \f$ \p host_nfreeiter \f$ + k \f$ iterations have been performed.
|
|
*
|
|
* \p rocsparse_csritsv_solve_ex requires a user allocated temporary buffer. Its size is
|
|
* returned by \ref rocsparse_scsritsv_buffer_size "rocsparse_Xcsritsv_buffer_size()".
|
|
* Furthermore, analysis meta data is required. It can be obtained by
|
|
* \ref rocsparse_scsritsv_analysis "rocsparse_Xcsritsv_analysis()". \p rocsparse_csritsv_solve_ex
|
|
* reports the first zero pivot (either numerical or structural zero). The zero pivot status
|
|
* can be checked by calling rocsparse_csritsv_zero_pivot(). 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$.
|
|
*
|
|
* \note
|
|
* The sparse CSR matrix has to be sorted. This can be achieved by calling
|
|
* rocsparse_csrsort().
|
|
*
|
|
* \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[inout]
|
|
* host_nmaxiter maximum number of iterations on input and number of iterations on output. If the output number of iterations is strictly less than the input maximum number of iterations, then the algorithm converged.
|
|
* @param[in]
|
|
* host_nfreeiter number of free iterations, that is, the number of iterations performed without stopping criteria evaluation between two iterations with stopping criteria evaluation.
|
|
* @param[in]
|
|
* host_tol if the pointer is null, then loop will execute \p nmaxiter[0] iterations.
|
|
* @param[out]
|
|
* host_history optional array to record the norm of the residual before each iteration.
|
|
* @param[in]
|
|
* trans matrix operation type.
|
|
* @param[in]
|
|
* m number of rows of the sparse CSR matrix.
|
|
* @param[in]
|
|
* nnz number of non-zero entries of the sparse CSR matrix.
|
|
* @param[in]
|
|
* alpha scalar \f$\alpha\f$.
|
|
* @param[in]
|
|
* descr descriptor of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_val array of \p nnz elements of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_row_ptr array of \p m+1 elements that point to the start
|
|
* of every row of the sparse CSR matrix.
|
|
* @param[in]
|
|
* csr_col_ind array of \p nnz elements containing the column indices of the sparse
|
|
* CSR 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[inout]
|
|
* 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 m or \p nnz is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p descr, \p alpha, \p csr_val,
|
|
* \p csr_row_ptr, \p csr_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
|
|
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general and \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_triangular.
|
|
*
|
|
* \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 y = x\f$.
|
|
* \code{.c}
|
|
* // Create rocSPARSE handle
|
|
* rocsparse_handle handle;
|
|
* rocsparse_create_handle(&handle);
|
|
*
|
|
* // Create matrix descriptor
|
|
* rocsparse_mat_descr descr;
|
|
* rocsparse_create_mat_descr(&descr);
|
|
* rocsparse_set_mat_fill_mode(descr, rocsparse_fill_mode_lower);
|
|
* rocsparse_set_mat_diag_type(descr, rocsparse_diag_type_unit);
|
|
*
|
|
* // Create matrix info structure
|
|
* rocsparse_mat_info info;
|
|
* rocsparse_create_mat_info(&info);
|
|
*
|
|
* // Obtain required buffer size
|
|
* size_t buffer_size;
|
|
* rocsparse_dcsritsv_buffer_size(handle,
|
|
* rocsparse_operation_none,
|
|
* m,
|
|
* nnz,
|
|
* descr,
|
|
* csr_val,
|
|
* csr_row_ptr,
|
|
* csr_col_ind,
|
|
* info,
|
|
* &buffer_size);
|
|
*
|
|
* // Allocate temporary buffer
|
|
* void* temp_buffer;
|
|
* hipMalloc(&temp_buffer, buffer_size);
|
|
*
|
|
* // Perform analysis step
|
|
* rocsparse_dcsritsv_analysis(handle,
|
|
* rocsparse_operation_none,
|
|
* m,
|
|
* nnz,
|
|
* descr,
|
|
* csr_val,
|
|
* csr_row_ptr,
|
|
* csr_col_ind,
|
|
* info,
|
|
* rocsparse_analysis_policy_reuse,
|
|
* rocsparse_solve_policy_auto,
|
|
* temp_buffer);
|
|
*
|
|
* // Solve Ly = x
|
|
* rocsparse_int nmaxiter = 200;
|
|
* rocsparse_int host_maxiter = nmaxiter;
|
|
*
|
|
* rocsparse_int host_nfreeiter = 20;
|
|
* double host_tol = 1.0e-4;
|
|
* double host_history[200];
|
|
*
|
|
* // Initialization of y
|
|
* hipMemset(y, 0, sizeof(double) * m);
|
|
*
|
|
* rocsparse_dcsritsv_solve_ex(handle,
|
|
* &host_maxiter,
|
|
* host_nfreeiter,
|
|
* &host_tol,
|
|
* host_history,
|
|
* rocsparse_operation_none,
|
|
* m,
|
|
* nnz,
|
|
* &alpha,
|
|
* descr,
|
|
* csr_val,
|
|
* csr_row_ptr,
|
|
* csr_col_ind,
|
|
* info,
|
|
* x,
|
|
* y,
|
|
* rocsparse_solve_policy_auto,
|
|
* temp_buffer);
|
|
*
|
|
* if (host_maxiter < nmaxiter)
|
|
* {
|
|
* printf("convergence\n");
|
|
* }
|
|
* else
|
|
* {
|
|
* printf("no convergence\n");
|
|
* }
|
|
* for (int i=0;i<=host_maxiter;++i)
|
|
* {
|
|
* printf("iter = %d, nrm inf residual=%e\n", i, host_history[i]);
|
|
* }
|
|
* // No zero pivot should be found, with L having unit diagonal
|
|
*
|
|
* // Clean up
|
|
* hipFree(temp_buffer);
|
|
* rocsparse_destroy_mat_info(info);
|
|
* rocsparse_destroy_mat_descr(descr);
|
|
* rocsparse_destroy_handle(handle);
|
|
* \endcode
|
|
*/
|
|
/**@{*/
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_scsritsv_solve_ex(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
rocsparse_int host_nfreeiter,
|
|
const float* host_tol,
|
|
float* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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,
|
|
rocsparse_mat_info info,
|
|
const float* x,
|
|
float* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dcsritsv_solve_ex(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
rocsparse_int host_nfreeiter,
|
|
const double* host_tol,
|
|
double* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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,
|
|
rocsparse_mat_info info,
|
|
const double* x,
|
|
double* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_ccsritsv_solve_ex(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
rocsparse_int host_nfreeiter,
|
|
const float* host_tol,
|
|
float* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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_mat_info info,
|
|
const rocsparse_float_complex* x,
|
|
rocsparse_float_complex* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zcsritsv_solve_ex(rocsparse_handle handle,
|
|
rocsparse_int* host_nmaxiter,
|
|
rocsparse_int host_nfreeiter,
|
|
const double* host_tol,
|
|
double* host_history,
|
|
rocsparse_operation trans,
|
|
rocsparse_int m,
|
|
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_mat_info info,
|
|
const rocsparse_double_complex* x,
|
|
rocsparse_double_complex* y,
|
|
rocsparse_solve_policy policy,
|
|
void* temp_buffer);
|
|
|
|
/**@}*/
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ROCSPARSE_CSRITSV_H */
|