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
313 lines
18 KiB
C
313 lines
18 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_GPSV_H
|
|
#define ROCSPARSE_GPSV_H
|
|
|
|
#include "../../rocsparse-types.h"
|
|
#include "rocsparse/rocsparse-export.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*! \ingroup precond_module
|
|
* \details
|
|
* \p rocsparse_gpsv_interleaved_batch_buffer_size calculates the required buffer size
|
|
* for \ref rocsparse_sgpsv_interleaved_batch "rocsparse_Xgpsv_interleaved_batch()". It is the user's
|
|
* responsibility to allocate this buffer.
|
|
*
|
|
* \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]
|
|
* alg algorithm to solve the linear system.
|
|
* @param[in]
|
|
* m size of the pentadiagonal linear system.
|
|
* @param[in]
|
|
* ds lower diagonal (distance 2) of pentadiagonal system. The first two entries
|
|
* must be zero.
|
|
* @param[in]
|
|
* dl lower diagonal of pentadiagonal system. The first entry must be zero.
|
|
* @param[in]
|
|
* d main diagonal of pentadiagonal system.
|
|
* @param[in]
|
|
* du upper diagonal of pentadiagonal system. The last entry must be zero.
|
|
* @param[in]
|
|
* dw upper diagonal (distance 2) of pentadiagonal system. The last two entries
|
|
* must be zero.
|
|
* @param[in]
|
|
* x Dense array of right-hand-sides, with dimension \p batch_stride by \p m.
|
|
* @param[in]
|
|
* batch_count The number of systems to solve.
|
|
* @param[in]
|
|
* batch_stride The number of elements that separate consecutive elements in a system.
|
|
* Must satisfy \p batch_stride >= \p batch_count.
|
|
* @param[out]
|
|
* buffer_size Number of bytes of the temporary storage buffer required.
|
|
*
|
|
* \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 alg, \p batch_count, or
|
|
* \p batch_stride is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p ds, \p dl, \p d, \p du, \p dw, \p x,
|
|
* or \p temp_buffer pointer is invalid.
|
|
* \retval rocsparse_status_internal_error an internal error occurred.
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_sgpsv_interleaved_batch_buffer_size(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
const float* ds,
|
|
const float* dl,
|
|
const float* d,
|
|
const float* du,
|
|
const float* dw,
|
|
const float* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dgpsv_interleaved_batch_buffer_size(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
const double* ds,
|
|
const double* dl,
|
|
const double* d,
|
|
const double* du,
|
|
const double* dw,
|
|
const double* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_cgpsv_interleaved_batch_buffer_size(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
const rocsparse_float_complex* ds,
|
|
const rocsparse_float_complex* dl,
|
|
const rocsparse_float_complex* d,
|
|
const rocsparse_float_complex* du,
|
|
const rocsparse_float_complex* dw,
|
|
const rocsparse_float_complex* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
size_t* buffer_size);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zgpsv_interleaved_batch_buffer_size(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
const rocsparse_double_complex* ds,
|
|
const rocsparse_double_complex* dl,
|
|
const rocsparse_double_complex* d,
|
|
const rocsparse_double_complex* du,
|
|
const rocsparse_double_complex* dw,
|
|
const rocsparse_double_complex* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
size_t* buffer_size);
|
|
/**@}*/
|
|
|
|
/*! \ingroup precond_module
|
|
* \brief Batched pentadiagonal solver.
|
|
*
|
|
* \details
|
|
* \p rocsparse_gpsv_interleaved_batch solves a batch of pentadiagonal linear systems
|
|
* \f[
|
|
* P^{i}*x^{i} = x^{i}
|
|
* \f]
|
|
* where for each batch \f$i=0\ldots\f$ \p batch_count, \f$P^{i}\f$ is a sparse pentadiagonal matrix and
|
|
* \f$x^{i}\f$ is a dense right-hand side vector. All of the pentadiagonal matrices, \f$P^{i}\f$, are
|
|
* packed in an interleaved fashion into five vectors: \p ds for the lowest diagonals, \p dl for the lower
|
|
* diagonals, \p d for the main diagonals, \p du for the upper diagonals, and \p dw for the highest diagonals.
|
|
* See below for a description of what this interleaved memory pattern looks like.
|
|
*
|
|
* Solving the batched pentadiagonal system involves two steps. First, call
|
|
* \ref rocsparse_sgpsv_interleaved_batch_buffer_size "rocsparse_Xgpsv_interleaved_batch_buffer_size()"
|
|
* to determine the size of the required temporary storage buffer. After this is determined, allocate
|
|
* the buffer and pass it to \ref rocsparse_sgpsv_interleaved_batch "rocsparse_Xgpsv_interleaved_batch()"
|
|
* to perform the actual solve. The \f$x^{i}\f$ vectors, which initially stores the right-hand side values, are
|
|
* overwritten with the solution after the call to
|
|
* \ref rocsparse_sgpsv_interleaved_batch "rocsparse_Xgpsv_interleaved_batch()".
|
|
*
|
|
* Unlike the strided batch routines, which write each batch matrix one after the other in memory, the interleaved
|
|
* routines write the batch matrices such that each element from each matrix is written consecutively one after
|
|
* the other. For example, consider the following batch matrices:
|
|
*
|
|
* \f[
|
|
* \begin{bmatrix}
|
|
* t^{0}_{00} & t^{0}_{01} & t^{0}_{02} \\
|
|
* t^{0}_{10} & t^{0}_{11} & t^{0}_{12} \\
|
|
* t^{0}_{20} & t^{0}_{21} & t^{0}_{22}
|
|
* \end{bmatrix}
|
|
* \begin{bmatrix}
|
|
* t^{1}_{00} & t^{1}_{01} & t^{1}_{02} \\
|
|
* t^{1}_{10} & t^{1}_{11} & t^{1}_{12} \\
|
|
* t^{1}_{20} & t^{1}_{21} & t^{1}_{22}
|
|
* \end{bmatrix}
|
|
* \begin{bmatrix}
|
|
* t^{2}_{00} & t^{2}_{01} & t^{2}_{02} \\
|
|
* t^{2}_{10} & t^{2}_{11} & t^{2}_{12} \\
|
|
* t^{2}_{20} & t^{2}_{21} & t^{2}_{22}
|
|
* \end{bmatrix}
|
|
* \f]
|
|
*
|
|
* In interleaved format, the highest, higher, lowest, lower, and diagonal arrays would look like:
|
|
* \f[
|
|
* \begin{align}
|
|
* \text{lowest} &= \begin{bmatrix} 0 & 0 & 0 & 0 & 0 & 0 & t^{0}_{20} & t^{1}_{20} & t^{2}_{20} \end{bmatrix} \\
|
|
* \text{lower} &= \begin{bmatrix} 0 & 0 & 0 & t^{0}_{10} & t^{1}_{10} & t^{1}_{10} & t^{0}_{21} & t^{1}_{21} & t^{2}_{21} \end{bmatrix} \\
|
|
* \text{diagonal} &= \begin{bmatrix} t^{0}_{00} & t^{1}_{00} & t^{2}_{00} & t^{0}_{11} & t^{1}_{11} & t^{2}_{11} & t^{0}_{22} & t^{1}_{22} & t^{2}_{22} \end{bmatrix} \\
|
|
* \text{higher} &= \begin{bmatrix} t^{0}_{01} & t^{1}_{01} & t^{2}_{01} & t^{0}_{12} & t^{1}_{12} & t^{2}_{12} & 0 & 0 & 0 \end{bmatrix} \\
|
|
* \text{highest} &= \begin{bmatrix} t^{0}_{02} & t^{1}_{02} & t^{2}_{02} & 0 & 0 & 0 & 0 & 0 & 0 \end{bmatrix} \\
|
|
* \end{align}
|
|
* \f]
|
|
* For the lowest array, the first \p 2*batch_count entries are zero, and for the lower array, the first \p batch_count entries are zero.
|
|
* For the upper array, the last \p batch_count entries are zero, and for the highest array, the last \p 2*batch_count entries are zero.
|
|
*
|
|
* \note
|
|
* This function is non-blocking and executed asynchronously with respect to the host.
|
|
* It can return before the actual computation has finished.
|
|
*
|
|
* \note
|
|
* The routine is numerically stable because it uses QR to solve the linear systems.
|
|
*
|
|
* \note
|
|
* m need to be at least 3 to be a valid pentadiagonal matrix.
|
|
*
|
|
* \note
|
|
* This routine supports execution in a hipGraph context.
|
|
*
|
|
* @param[in]
|
|
* handle handle to the rocSPARSE library context queue.
|
|
* @param[in]
|
|
* alg algorithm to solve the linear system.
|
|
* @param[in]
|
|
* m size of the pentadiagonal linear system.
|
|
* @param[inout]
|
|
* ds lower diagonal (distance 2) of pentadiagonal system. The first two entries
|
|
* must be zero.
|
|
* @param[inout]
|
|
* dl lower diagonal of pentadiagonal system. The first entry must be zero.
|
|
* @param[inout]
|
|
* d main diagonal of pentadiagonal system.
|
|
* @param[inout]
|
|
* du upper diagonal of pentadiagonal system. The last entry must be zero.
|
|
* @param[inout]
|
|
* dw upper diagonal (distance 2) of pentadiagonal system. The last two entries
|
|
* must be zero.
|
|
* @param[inout]
|
|
* x Dense array of right-hand-sides, with dimension \p batch_stride by \p m.
|
|
* @param[in]
|
|
* batch_count The number of systems to solve.
|
|
* @param[in]
|
|
* batch_stride The number of elements that separate consecutive elements in a system.
|
|
* Must satisfy \p batch_stride >= \p batch_count.
|
|
* @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 alg, \p batch_count, or
|
|
* \p batch_stride is invalid.
|
|
* \retval rocsparse_status_invalid_pointer \p ds, \p dl, \p d, \p du, \p dw, \p x,
|
|
* or \p temp_buffer pointer is invalid.
|
|
* \retval rocsparse_status_internal_error an internal error occurred.
|
|
*
|
|
* \par Example
|
|
* \snippet example_rocsparse_gpsv.cpp doc example
|
|
*/
|
|
/**@{*/
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_sgpsv_interleaved_batch(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
float* ds,
|
|
float* dl,
|
|
float* d,
|
|
float* du,
|
|
float* dw,
|
|
float* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_dgpsv_interleaved_batch(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
double* ds,
|
|
double* dl,
|
|
double* d,
|
|
double* du,
|
|
double* dw,
|
|
double* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_cgpsv_interleaved_batch(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
rocsparse_float_complex* ds,
|
|
rocsparse_float_complex* dl,
|
|
rocsparse_float_complex* d,
|
|
rocsparse_float_complex* du,
|
|
rocsparse_float_complex* dw,
|
|
rocsparse_float_complex* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
void* temp_buffer);
|
|
|
|
ROCSPARSE_EXPORT
|
|
rocsparse_status rocsparse_zgpsv_interleaved_batch(rocsparse_handle handle,
|
|
rocsparse_gpsv_interleaved_alg alg,
|
|
rocsparse_int m,
|
|
rocsparse_double_complex* ds,
|
|
rocsparse_double_complex* dl,
|
|
rocsparse_double_complex* d,
|
|
rocsparse_double_complex* du,
|
|
rocsparse_double_complex* dw,
|
|
rocsparse_double_complex* x,
|
|
rocsparse_int batch_count,
|
|
rocsparse_int batch_stride,
|
|
void* temp_buffer);
|
|
/**@}*/
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* ROCSPARSE_GPSV_H */
|