TheRock/rocm-libraries/projects/rocsparse/clients/testings/testing_gebsr2csr.cpp

/*! \file */
/* ************************************************************************
 * Copyright (C) 2020-2025 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.
 *
 * ************************************************************************ */

#include "rocsparse_enum.hpp"
#include "testing.hpp"

template <typename T>
void testing_gebsr2csr_bad_arg(const Arguments& arg)
{
    static const size_t safe_size = 1;

    // Create rocsparse handle
    rocsparse_local_handle local_handle;

    // Create descriptors
    rocsparse_local_mat_descr local_bsr_descr;
    rocsparse_local_mat_descr local_csr_descr;

    rocsparse_handle          handle    = local_handle;
    rocsparse_direction       dir       = rocsparse_direction_row;
    rocsparse_int             mb        = safe_size;
    rocsparse_int             nb        = safe_size;
    const rocsparse_mat_descr bsr_descr = local_bsr_descr;

    const T* bsr_val = (const T*)0x4;

    host_dense_vector<rocsparse_int> hptr(safe_size + 1);
    hptr[0] = 0;
    hptr[1] = 1;
    device_dense_vector<rocsparse_int> dbsr_row_ptr(hptr);

    const rocsparse_int*      bsr_row_ptr   = (const rocsparse_int*)dbsr_row_ptr;
    const rocsparse_int*      bsr_col_ind   = (const rocsparse_int*)0x4;
    rocsparse_int             row_block_dim = safe_size;
    rocsparse_int             col_block_dim = safe_size;
    const rocsparse_mat_descr csr_descr     = local_csr_descr;
    T*                        csr_val       = (T*)0x4;
    rocsparse_int*            csr_row_ptr   = (rocsparse_int*)0x4;
    rocsparse_int*            csr_col_ind   = (rocsparse_int*)0x4;

#define PARAMS                                                                        \
    handle, dir, mb, nb, bsr_descr, bsr_val, bsr_row_ptr, bsr_col_ind, row_block_dim, \
        col_block_dim, csr_descr, csr_val, csr_row_ptr, csr_col_ind
    bad_arg_analysis(rocsparse_gebsr2csr<T>, PARAMS);

    CHECK_ROCSPARSE_ERROR(
        rocsparse_set_mat_storage_mode(bsr_descr, rocsparse_storage_mode_unsorted));
    CHECK_ROCSPARSE_ERROR(
        rocsparse_set_mat_storage_mode(csr_descr, rocsparse_storage_mode_unsorted));
    EXPECT_ROCSPARSE_STATUS(rocsparse_gebsr2csr<T>(PARAMS),
                            rocsparse_status_requires_sorted_storage);

    CHECK_ROCSPARSE_ERROR(rocsparse_set_mat_storage_mode(bsr_descr, rocsparse_storage_mode_sorted));
    CHECK_ROCSPARSE_ERROR(rocsparse_set_mat_storage_mode(csr_descr, rocsparse_storage_mode_sorted));

    // Check row_block_dim == 0
    row_block_dim = 0;
    col_block_dim = safe_size;
    EXPECT_ROCSPARSE_STATUS(rocsparse_gebsr2csr<T>(PARAMS), rocsparse_status_invalid_size);

    // Check col_block_dim == 0
    row_block_dim = safe_size;
    col_block_dim = 0;
    EXPECT_ROCSPARSE_STATUS(rocsparse_gebsr2csr<T>(PARAMS), rocsparse_status_invalid_size);
#undef PARAMS
}

template <typename T>
void testing_gebsr2csr(const Arguments& arg)
{
    rocsparse_matrix_factory<T> matrix_factory(arg);
    rocsparse_int               M             = arg.M;
    rocsparse_int               N             = arg.N;
    rocsparse_direction         direction     = arg.direction;
    rocsparse_index_base        bsr_base      = arg.baseA;
    rocsparse_index_base        csr_base      = arg.baseB;
    rocsparse_int               row_block_dim = arg.row_block_dimA;
    rocsparse_int               col_block_dim = arg.col_block_dimA;

    rocsparse_int Mb = -1;
    rocsparse_int Nb = -1;
    if(row_block_dim > 0)
    {
        Mb = (M + row_block_dim - 1) / row_block_dim;
    }
    if(col_block_dim > 0)
    {
        Nb = (N + col_block_dim - 1) / col_block_dim;
    }

    // Create rocsparse handle
    rocsparse_local_handle handle(arg);

    rocsparse_local_mat_descr bsr_descr;
    rocsparse_local_mat_descr csr_descr;

    CHECK_ROCSPARSE_ERROR(rocsparse_set_mat_index_base(bsr_descr, bsr_base));
    CHECK_ROCSPARSE_ERROR(rocsparse_set_mat_index_base(csr_descr, csr_base));

    // Declare and initialize matrices.
    host_gebsr_matrix<T> hA;
    matrix_factory.init_gebsr(hA);

    device_gebsr_matrix<T> dA(hA);

    M = dA.mb * dA.row_block_dim;
    N = dA.nb * dA.col_block_dim;

    rocsparse_int nnzb = hA.ind.size();

    // Allocate device memory for output CSR matrix
    device_csr_matrix<T> dC(M, N, size_t(nnzb) * row_block_dim * col_block_dim, csr_base);
    if(arg.unit_check)
    {
        CHECK_ROCSPARSE_ERROR(testing::rocsparse_gebsr2csr<T>(handle,
                                                              direction,
                                                              dA.mb,
                                                              dA.nb,
                                                              bsr_descr,
                                                              dA.val,
                                                              dA.ptr,
                                                              dA.ind,
                                                              row_block_dim,
                                                              col_block_dim,
                                                              csr_descr,
                                                              dC.val,
                                                              dC.ptr,
                                                              dC.ind));

        host_csr_matrix<T> hC_gold(M, N, size_t(nnzb) * row_block_dim * col_block_dim, csr_base);
        host_gebsr_to_csr(direction,
                          hA.mb,
                          hA.nb,
                          hA.nnzb,
                          hA.val,
                          hA.ptr,
                          hA.ind,
                          row_block_dim,
                          col_block_dim,
                          bsr_base,
                          hC_gold.val,
                          hC_gold.ptr,
                          hC_gold.ind,
                          csr_base);

        hC_gold.near_check(dC);
    }

    if(arg.timing)
    {

        const double gpu_time_used = rocsparse_clients::run_benchmark(arg,
                                                                      rocsparse_gebsr2csr<T>,
                                                                      handle,
                                                                      direction,
                                                                      dA.mb,
                                                                      dA.nb,
                                                                      bsr_descr,
                                                                      dA.val,
                                                                      dA.ptr,
                                                                      dA.ind,
                                                                      row_block_dim,
                                                                      col_block_dim,
                                                                      csr_descr,
                                                                      dC.val,
                                                                      dC.ptr,
                                                                      dC.ind);

        double gbyte_count = gebsr2csr_gbyte_count<T>(Mb, row_block_dim, col_block_dim, nnzb);
        double gpu_gbyte   = get_gpu_gbyte(gpu_time_used, gbyte_count);

        display_timing_info(display_key_t::M,
                            M,
                            display_key_t::N,
                            N,
                            display_key_t::Mb,
                            Mb,
                            display_key_t::Nb,
                            Nb,
                            display_key_t::rbdim,
                            row_block_dim,
                            display_key_t::cbdim,
                            col_block_dim,
                            display_key_t::nnzb,
                            nnzb,
                            display_key_t::bandwidth,
                            gpu_gbyte,
                            display_key_t::time_ms,
                            get_gpu_time_msec(gpu_time_used));
    }
}

#define INSTANTIATE(TYPE)                                                \
    template void testing_gebsr2csr_bad_arg<TYPE>(const Arguments& arg); \
    template void testing_gebsr2csr<TYPE>(const Arguments& arg)
INSTANTIATE(float);
INSTANTIATE(double);
INSTANTIATE(rocsparse_float_complex);
INSTANTIATE(rocsparse_double_complex);
void testing_gebsr2csr_extra(const Arguments& arg) {}