Files
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
Flatten subprojects into a single base monorepo
2026-09-02 16:34:47 -07:00

477 lines
26 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_BSRIC0_H
#define ROCSPARSE_BSRIC0_H
#include "../../rocsparse-types.h"
#include "rocsparse/rocsparse-export.h"
#ifdef __cplusplus
extern "C" {
#endif
/*! \ingroup precond_module
* \details
* \p rocsparse_bsric0_zero_pivot returns \ref rocsparse_status_zero_pivot if either a
* structural or numerical zero has been found during \ref rocsparse_sbsric0 "rocsparse_Xbsric0()"
* 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
* If a zero pivot is found, \p position=j means that either the diagonal block \p A(j,j)
* is missing (structural zero) or the diagonal block \p A(j,j) is not positive definite
* (numerical zero).
*
* \note \p rocsparse_bsric0_zero_pivot is a blocking function. It might influence negatively
* 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_bsric0_zero_pivot(rocsparse_handle handle,
rocsparse_mat_info info,
rocsparse_int* position);
/*! \ingroup precond_module
* \details
* \p rocsparse_bsric0_buffer_size returns the size of the temporary storage buffer
* that is required by \ref rocsparse_sbsric0_analysis "rocsparse_Xbsric0_analysis()" and
* \ref rocsparse_sbsric0 "rocsparse_Xbsric0()". The temporary storage buffer must be
* allocated by the user. The size of the temporary storage buffer is identical to the size
* returned by \ref rocsparse_sbsrsv_buffer_size "rocsparse_Xbsrsv_buffer_size()" and
* \ref rocsparse_sbsrilu0_buffer_size "rocsparse_Xbsrilu0_buffer_size()" if the matrix sparsity
* pattern is identical. The user-allocated buffer can therefore be shared between subsequent calls
* to those functions.
*
* \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 direction that specifies whether to count non-zero elements by \ref rocsparse_direction_row or by
* \ref rocsparse_direction_column.
* @param[in]
* mb number of block rows in the sparse BSR matrix.
* @param[in]
* nnzb number of non-zero block entries of the sparse BSR matrix.
* @param[in]
* descr descriptor of the sparse BSR matrix.
* @param[in]
* bsr_val array of length \p nnzb*block_dim*block_dim containing the values 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 nnzb elements containing the block column indices of the sparse BSR matrix.
* @param[in]
* block_dim the block dimension of the BSR matrix. Between 1 and m, where \p m=mb*block_dim.
* @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_sbsric0_analysis "rocsparse_Xbsric0_analysis()" and
* \ref rocsparse_sbsric0 "rocsparse_Xbsric0()".
*
* \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
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sbsric0_buffer_size(rocsparse_handle handle,
rocsparse_direction dir,
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_dbsric0_buffer_size(rocsparse_handle handle,
rocsparse_direction dir,
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_cbsric0_buffer_size(rocsparse_handle handle,
rocsparse_direction dir,
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_zbsric0_buffer_size(rocsparse_handle handle,
rocsparse_direction dir,
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 precond_module
* \details
* \p rocsparse_bsric0_analysis performs the analysis step for
* \ref rocsparse_sbsric0 "rocsparse_Xbsric0()". 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_bsric0_clear().
*
* \p rocsparse_bsric0_analysis can share its meta data with
* \ref rocsparse_sbsrilu0_analysis "rocsparse_Xbsrilu0_analysis()",
* \ref rocsparse_sbsrsv_analysis "rocsparse_Xbsrsv_analysis()", and
* \ref rocsparse_sbsrsm_analysis "rocsparse_Xbsrsm_analysis()". 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 must 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 direction that specified whether to count non-zero elements by \ref rocsparse_direction_row or by
* \ref rocsparse_direction_column.
* @param[in]
* mb number of block rows in the sparse BSR matrix.
* @param[in]
* nnzb number of non-zero block entries of the sparse BSR matrix.
* @param[in]
* descr descriptor of the sparse BSR matrix.
* @param[in]
* bsr_val array of length \p nnzb*block_dim*block_dim containing the values 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 nnzb elements containing the block column indices of the sparse BSR matrix.
* @param[in]
* block_dim the block dimension of the BSR matrix. Between 1 and m, where \p m=mb*block_dim.
* @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_val, \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
* \ref rocsparse_matrix_type != \ref rocsparse_matrix_type_general.
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sbsric0_analysis(rocsparse_handle handle,
rocsparse_direction dir,
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_dbsric0_analysis(rocsparse_handle handle,
rocsparse_direction dir,
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_cbsric0_analysis(rocsparse_handle handle,
rocsparse_direction dir,
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_zbsric0_analysis(rocsparse_handle handle,
rocsparse_direction dir,
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 precond_module
* \details
* \p rocsparse_bsric0_clear deallocates all memory that was allocated by
* \ref rocsparse_sbsric0_analysis "rocsparse_Xbsric0_analysis()". This is especially useful
* if memory is an issue and the analysis data is not required for further computation.
*
* \note
* Calling \p rocsparse_bsric0_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_bsric0_clear(rocsparse_handle handle, rocsparse_mat_info info);
/*! \ingroup precond_module
* \brief Incomplete Cholesky factorization with 0 fill-ins and no pivoting using the BSR
* storage format.
*
* \details
* \p rocsparse_bsric0 computes the incomplete Cholesky factorization with 0 fill-ins
* and no pivoting of a sparse \f$mb \times mb\f$ BSR matrix \f$A\f$, such that
* \f[
* A \approx LL^T
* \f]
*
* Computing the above incomplete Cholesky factorization requires three steps to complete. First,
* determine the size of the required temporary storage buffer by calling \ref rocsparse_sbsric0_buffer_size,
* \ref rocsparse_dbsric0_buffer_size, \ref rocsparse_cbsric0_buffer_size, or \ref rocsparse_zbsric0_buffer_size. After
* this buffer size has been determined, allocate the buffer and pass it to \ref rocsparse_sbsric0_analysis,
* \ref rocsparse_dbsric0_analysis, \ref rocsparse_cbsric0_analysis, or \ref rocsparse_zbsric0_analysis. This will
* perform analysis on the sparsity pattern of the matrix. Finally, call \p rocsparse_sbsric0,
* \p rocsparse_dbsric0, \p rocsparse_cbsric0, or \p rocsparse_zbsric0 to perform the actual factorization. The calculation
* of the buffer size and the analysis of the sparse matrix only need to be performed once for a given sparsity pattern,
* while the factorization can be repeatedly applied to multiple matrices having the same sparsity pattern. After all calls
* to \ref rocsparse_sbsric0 "rocsparse_Xbsric0()" are complete, the temporary buffer can be deallocated.
*
* \p rocsparse_bsric0 reports the first zero pivot (either numerical or structural zero).
* The zero pivot status can be obtained by calling \ref rocsparse_bsric0_zero_pivot().
*
* \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 direction that specified whether to count non-zero elements by \ref rocsparse_direction_row or by
* \ref rocsparse_direction_column.
* @param[in]
* mb number of block rows in the sparse BSR matrix.
* @param[in]
* nnzb number of non-zero block entries of the sparse BSR matrix.
* @param[in]
* descr descriptor of the sparse BSR matrix.
* @param[inout]
* bsr_val array of length \p nnzb*block_dim*block_dim containing the values 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 nnzb elements containing the block column indices of the sparse BSR matrix.
* @param[in]
* block_dim the block dimension of the BSR matrix. Between 1 and m, where \p m=mb*block_dim.
* @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 mb, \p nnzb, or \p block_dim is invalid.
* \retval rocsparse_status_invalid_pointer \p descr, \p bsr_val, \p bsr_row_ptr,
* or \p bsr_col_ind 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.
*
* \par Example
* Consider the sparse \f$m \times m\f$ matrix \f$A\f$, stored in BSR
* storage format. The following example computes the incomplete Cholesky factorization
* \f$M \approx LL^T\f$ and solves the preconditioned system \f$My = x\f$.
* \snippet example_rocsparse_bsric0.cpp doc example
*/
/**@{*/
ROCSPARSE_EXPORT
rocsparse_status rocsparse_sbsric0(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_int mb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
float* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
rocsparse_solve_policy policy,
void* temp_buffer);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_dbsric0(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_int mb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
double* bsr_val,
const rocsparse_int* bsr_row_ptr,
const rocsparse_int* bsr_col_ind,
rocsparse_int block_dim,
rocsparse_mat_info info,
rocsparse_solve_policy policy,
void* temp_buffer);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_cbsric0(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_int mb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
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_solve_policy policy,
void* temp_buffer);
ROCSPARSE_EXPORT
rocsparse_status rocsparse_zbsric0(rocsparse_handle handle,
rocsparse_direction dir,
rocsparse_int mb,
rocsparse_int nnzb,
const rocsparse_mat_descr descr,
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_solve_policy policy,
void* temp_buffer);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif /* ROCSPARSE_BSRIC0_H */