/*! \file */
/* ************************************************************************
 * Copyright (C) 2021-2026 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_matrix_factory.hpp"
#include "rocsparse_clients_envariables.hpp"
#include "rocsparse_clients_matrices_dir.hpp"
#include "rocsparse_importer_format_t.hpp"
#include "rocsparse_init.hpp"

#include "rocsparse_clients_routine_trace.hpp"

static void get_matrix_full_filename(const Arguments& arg_,
                                     const char*      extension_,
                                     std::string&     full_filename_)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    if(arg_.timing)
    {
        static constexpr bool use_default = false;
        full_filename_                    = rocsparse_clients_matrices_dir_get(use_default);
        full_filename_ += arg_.filename;
    }
    else
    {
        static constexpr bool use_default = true;
        full_filename_                    = rocsparse_clients_matrices_dir_get(use_default);
        full_filename_ += arg_.filename;
        full_filename_ += extension_;
    }
}

//
// Destructor.
//
template <typename T, typename I, typename J>
rocsparse_matrix_factory<T, I, J>::~rocsparse_matrix_factory()
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    if(this->m_instance)
    {
        delete this->m_instance;
        this->m_instance = nullptr;
    }
}

//
// Constructor.
//
template <typename T, typename I, typename J>
rocsparse_matrix_factory<T, I, J>::rocsparse_matrix_factory(const Arguments&      arg,
                                                            rocsparse_matrix_init matrix,
                                                            bool                  to_int, // = false
                                                            bool full_rank, // = false
                                                            bool noseed // = false
                                                            )
    : m_arg(arg)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    //
    // FORCE REINIT.
    //
    if(false == noseed)
    {
        rocsparse_seedrand();
    }

    switch(matrix)
    {
    case rocsparse_matrix_random:
    {
        rocsparse_matrix_init_kind matrix_init_kind = arg.matrix_init_kind;
        this->m_instance
            = new rocsparse_matrix_factory_random<T, I, J>(full_rank, to_int, matrix_init_kind);
        break;
    }

    case rocsparse_matrix_laplace_2d:
    {
        this->m_instance = new rocsparse_matrix_factory_laplace2d<T, I, J>(arg.dimx, arg.dimy);
        break;
    }

    case rocsparse_matrix_laplace_3d:
    {
        this->m_instance
            = new rocsparse_matrix_factory_laplace3d<T, I, J>(arg.dimx, arg.dimy, arg.dimz);
        break;
    }

    case rocsparse_matrix_tridiagonal:
    {
        this->m_instance = new rocsparse_matrix_factory_tridiagonal<T, I, J>(arg.l, arg.u);
        break;
    }

    case rocsparse_matrix_pentadiagonal:
    {
        this->m_instance
            = new rocsparse_matrix_factory_pentadiagonal<T, I, J>(arg.ll, arg.l, arg.u, arg.uu);
        break;
    }

    case rocsparse_matrix_file_rocalution:
    {
        std::string full_filename;
        get_matrix_full_filename(
            arg,
            rocsparse_importer_format_t::extension(rocsparse_importer_format_t::rocalution),
            full_filename);

        this->m_instance
            = new rocsparse_matrix_factory_rocalution<T, I, J>(full_filename.c_str(), to_int);
        break;
    }

    case rocsparse_matrix_file_rocsparseio:
    {
        std::string full_filename;
        get_matrix_full_filename(
            arg,
            rocsparse_importer_format_t::extension(rocsparse_importer_format_t::rocsparseio),
            full_filename);
        this->m_instance
            = new rocsparse_matrix_factory_rocsparseio<T, I, J>(full_filename.c_str(), to_int);
        break;
    }

    case rocsparse_matrix_file_mtx:
    {
        std::string full_filename;
        get_matrix_full_filename(
            arg,
            rocsparse_importer_format_t::extension(rocsparse_importer_format_t::matrixmarket),
            full_filename);
        this->m_instance = new rocsparse_matrix_factory_mtx<T, I, J>(full_filename.c_str());
        break;
    }

    case rocsparse_matrix_file_smtx:
    {
        std::string full_filename;
        get_matrix_full_filename(
            arg,
            rocsparse_importer_format_t::extension(rocsparse_importer_format_t::mlcsr),
            full_filename);
        this->m_instance = new rocsparse_matrix_factory_smtx<T, I, J>(full_filename.c_str());
        break;
    }

    case rocsparse_matrix_file_bsmtx:
    {
        std::string full_filename;
        get_matrix_full_filename(
            arg,
            rocsparse_importer_format_t::extension(rocsparse_importer_format_t::mlbsr),
            full_filename);
        this->m_instance = new rocsparse_matrix_factory_bsmtx<T, I, J>(full_filename.c_str());
        break;
    }

    case rocsparse_matrix_zero:
    {
        this->m_instance = new rocsparse_matrix_factory_zero<T, I, J>();
        break;
    }
    }

    if(this->m_instance == nullptr)
    {
        std::cerr << "rocsparse_matrix_factory constructor failed, at line " << __LINE__
                  << std::endl;
        throw(1);
    }
}

//
// Constructor.
//
template <typename T, typename I, typename J>
rocsparse_matrix_factory<T, I, J>::rocsparse_matrix_factory(const Arguments& arg,
                                                            bool             to_int, //  = false,
                                                            bool             full_rank, // = false,
                                                            bool             noseed) //  = false)
    : rocsparse_matrix_factory(arg, arg.matrix, to_int, full_rank, noseed)
{
}

//
// COO
//
template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_coo(std::vector<I>&      coo_row_ind,
                                                 std::vector<I>&      coo_col_ind,
                                                 std::vector<T>&      coo_val,
                                                 I&                   M,
                                                 I&                   N,
                                                 int64_t&             nnz,
                                                 rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->m_instance->init_coo(coo_row_ind,
                               coo_col_ind,
                               coo_val,
                               M,
                               N,
                               nnz,
                               base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_coo(host_coo_matrix<T, I>& that)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.base = this->m_arg.baseA;
    that.m    = this->m_arg.M;
    that.n    = this->m_arg.N;
    this->m_instance->init_coo(that.row_ind,
                               that.col_ind,
                               that.val,
                               that.m,
                               that.n,
                               that.nnz,
                               that.base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_coo(host_coo_matrix<T, I>& that,
                                                 I&                     M,
                                                 I&                     N,
                                                 rocsparse_index_base   base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.base = base;
    that.m    = M;
    that.n    = N;
    this->m_instance->init_coo(that.row_ind,
                               that.col_ind,
                               that.val,
                               that.m,
                               that.n,
                               that.nnz,
                               that.base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
    M = that.m;
    N = that.n;
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_coo(host_coo_matrix<T, I>& that, I& M, I& N)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->init_coo(that, M, N, this->m_arg.baseA);
}

//
// CSR
//
template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_csr(std::vector<I>&      csr_row_ptr,
                                                 std::vector<J>&      csr_col_ind,
                                                 std::vector<T>&      csr_val,
                                                 J&                   m,
                                                 J&                   n,
                                                 I&                   nnz,
                                                 rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->m_instance->init_csr(csr_row_ptr,
                               csr_col_ind,
                               csr_val,
                               m,
                               n,
                               nnz,
                               base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_csr(host_csr_matrix<T, I, J>& that)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.base = this->m_arg.baseA;
    that.m    = this->m_arg.M;
    that.n    = this->m_arg.N;
    this->m_instance->init_csr(that.ptr,
                               that.ind,
                               that.val,
                               that.m,
                               that.n,
                               that.nnz,
                               that.base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_csr(host_csr_matrix<T, I, J>& that,
                                                 J&                        m,
                                                 J&                        n,
                                                 rocsparse_index_base      base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.base = base;
    that.m    = m;
    that.n    = n;
    this->m_instance->init_csr(that.ptr,
                               that.ind,
                               that.val,
                               that.m,
                               that.n,
                               that.nnz,
                               that.base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
    m = that.m;
    n = that.n;
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_csr(host_csr_matrix<T, I, J>& that, J& m, J& n)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->init_csr(that, m, n, this->m_arg.baseA);
}

//
// CSC
//
template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_csc(std::vector<I>&      csc_col_ptr,
                                                 std::vector<J>&      csc_row_ind,
                                                 std::vector<T>&      csc_val,
                                                 J&                   M,
                                                 J&                   N,
                                                 I&                   nnz,
                                                 rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->m_instance->init_csr(csc_col_ptr,
                               csc_row_ind,
                               csc_val,
                               N,
                               M,
                               nnz,
                               base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_csc(host_csc_matrix<T, I, J>& that,
                                                 J&                        m,
                                                 J&                        n,
                                                 rocsparse_index_base      base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.base = base;
    this->m_instance->init_csr(that.ptr,
                               that.ind,
                               that.val,
                               n,
                               m,
                               that.nnz,
                               that.base,
                               this->m_arg.matrix_type,
                               this->m_arg.uplo,
                               this->m_arg.storage);
    that.m = m;
    that.n = n;
}

//
// GEBSR
//
template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_gebsr(std::vector<I>&      bsr_row_ptr,
                                                   std::vector<J>&      bsr_col_ind,
                                                   std::vector<T>&      bsr_val,
                                                   rocsparse_direction  dirb,
                                                   J&                   Mb,
                                                   J&                   Nb,
                                                   I&                   nnzb,
                                                   J&                   row_block_dim,
                                                   J&                   col_block_dim,
                                                   rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->m_instance->init_gebsr(bsr_row_ptr,
                                 bsr_col_ind,
                                 bsr_val,
                                 dirb,
                                 Mb,
                                 Nb,
                                 nnzb,
                                 row_block_dim,
                                 col_block_dim,
                                 base,
                                 this->m_arg.matrix_type,
                                 this->m_arg.uplo,
                                 this->m_arg.storage);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_gebsr(host_gebsr_matrix<T, I, J>& that,
                                                   rocsparse_direction         block_dir_,
                                                   J&                          mb_,
                                                   J&                          nb_,
                                                   I&                          nnzb_,
                                                   J&                          row_block_dim_,
                                                   J&                          col_block_dim_,
                                                   rocsparse_index_base        base_)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.block_direction = block_dir_;
    that.mb              = mb_;
    that.nb              = nb_;
    that.row_block_dim   = row_block_dim_;
    that.col_block_dim   = col_block_dim_;
    that.base            = base_;
    that.nnzb            = nnzb_;
    this->m_instance->init_gebsr(that.ptr,
                                 that.ind,
                                 that.val,
                                 that.block_direction,
                                 that.mb,
                                 that.nb,
                                 that.nnzb,
                                 that.row_block_dim,
                                 that.col_block_dim,
                                 that.base,
                                 this->m_arg.matrix_type,
                                 this->m_arg.uplo,
                                 this->m_arg.storage);

    mb_            = that.mb;
    nb_            = that.nb;
    nnzb_          = that.nnzb;
    row_block_dim_ = that.row_block_dim;
    col_block_dim_ = that.col_block_dim;
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_gebsr(host_gebsr_matrix<T, I, J>& that)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.block_direction = this->m_arg.direction;
    that.mb              = this->m_arg.M;
    that.nb              = this->m_arg.N;
    that.nnzb            = this->m_arg.nnz;
    that.row_block_dim   = this->m_arg.row_block_dimA;
    that.col_block_dim   = this->m_arg.col_block_dimA;
    that.base            = this->m_arg.baseA;
    this->m_instance->init_gebsr(that.ptr,
                                 that.ind,
                                 that.val,
                                 that.block_direction,
                                 that.mb,
                                 that.nb,
                                 that.nnzb,
                                 that.row_block_dim,
                                 that.col_block_dim,
                                 that.base,
                                 this->m_arg.matrix_type,
                                 this->m_arg.uplo,
                                 this->m_arg.storage);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_gebsr(host_gebsr_matrix<T, I, J>& that,
                                                   J&                          mb,
                                                   J&                          nb,
                                                   J&                          row_block_dim,
                                                   J&                          col_block_dim,
                                                   rocsparse_index_base        base_)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    that.base = base_;
    that.mb   = mb;
    that.nb   = nb;
    that.nnzb = this->m_arg.nnz;

    that.row_block_dim = row_block_dim;
    that.col_block_dim = col_block_dim;

    this->m_instance->init_gebsr(that.ptr,
                                 that.ind,
                                 that.val,
                                 that.block_direction,
                                 that.mb,
                                 that.nb,
                                 that.nnzb,
                                 that.row_block_dim,
                                 that.col_block_dim,
                                 that.base,
                                 this->m_arg.matrix_type,
                                 this->m_arg.uplo,
                                 this->m_arg.storage);

    mb            = that.mb;
    nb            = that.nb;
    row_block_dim = that.row_block_dim;
    col_block_dim = that.col_block_dim;
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_gebsr_spezial(host_gebsr_matrix<T, I, J>& that,
                                                           J&                          Mb,
                                                           J&                          Nb)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    I idx = 0;

    host_csr_matrix<T, I, J> hA;
    rocsparse_direction      direction     = this->m_arg.direction;
    rocsparse_index_base     base          = this->m_arg.baseA;
    J                        row_block_dim = this->m_arg.row_block_dimA;
    J                        col_block_dim = this->m_arg.col_block_dimA;
    this->init_csr(hA, Mb, Nb, base);

    that.define(direction, Mb, Nb, hA.nnz, row_block_dim, col_block_dim, base);

    switch(direction)
    {
    case rocsparse_direction_column:
    {
        T*       val    = that.val;
        const I* hA_ptr = hA.ptr.data();
        for(J i = 0; i < Mb; ++i)
        {
            for(J r = 0; r < row_block_dim; ++r)
            {
                for(I k = hA_ptr[i] - base; k < hA_ptr[i + 1] - base; ++k)
                {
                    for(J c = 0; c < col_block_dim; ++c)
                    {
                        val[k * row_block_dim * col_block_dim + c * row_block_dim + r]
                            = static_cast<T>(++idx);
                    }
                }
            }
        }
        break;
    }

    case rocsparse_direction_row:
    {
        T*       val    = that.val;
        const I* hA_ptr = hA.ptr.data();
        for(J i = 0; i < Mb; ++i)
        {
            for(J r = 0; r < row_block_dim; ++r)
            {
                for(I k = hA_ptr[i] - base; k < hA_ptr[i + 1] - base; ++k)
                {
                    for(J c = 0; c < col_block_dim; ++c)
                    {
                        val[k * row_block_dim * col_block_dim + r * col_block_dim + c]
                            = static_cast<T>(++idx);
                    }
                }
            }
        }
        break;
    }
    }

    that.ptr.transfer_from(hA.ptr);
    that.ind.transfer_from(hA.ind);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_gebsc(std::vector<I>&      bsc_col_ptr,
                                                   std::vector<J>&      bsc_row_ind,
                                                   std::vector<T>&      bsc_val,
                                                   rocsparse_direction  dirb,
                                                   J&                   Mb,
                                                   J&                   Nb,
                                                   I&                   nnzb,
                                                   J&                   row_block_dim,
                                                   J&                   col_block_dim,
                                                   rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->m_instance->init_gebsr(bsc_col_ptr,
                                 bsc_row_ind,
                                 bsc_val,
                                 dirb,
                                 Nb,
                                 Mb,
                                 nnzb,
                                 row_block_dim,
                                 col_block_dim,
                                 base,
                                 this->m_arg.matrix_type,
                                 this->m_arg.uplo,
                                 this->m_arg.storage);
}

//
// BSR
//

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_bsr(std::vector<I>&      bsr_row_ptr,
                                                 std::vector<J>&      bsr_col_ind,
                                                 std::vector<T>&      bsr_val,
                                                 rocsparse_direction  dirb,
                                                 J&                   Mb,
                                                 J&                   Nb,
                                                 I&                   nnzb,
                                                 J&                   block_dim,
                                                 rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    this->m_instance->init_gebsr(bsr_row_ptr,
                                 bsr_col_ind,
                                 bsr_val,
                                 dirb,
                                 Mb,
                                 Nb,
                                 nnzb,
                                 block_dim,
                                 block_dim,
                                 base,
                                 this->m_arg.matrix_type,
                                 this->m_arg.uplo,
                                 this->m_arg.storage);
}

template <typename T, typename I, typename J, class FILTER = void>
struct traits_init_bsr
{
    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_gebsr_matrix<T, I, J>&        that,
                     device_gebsr_matrix<T, I, J>&      that_on_device,
                     J&                                 mb_,
                     J&                                 nb_,
                     rocsparse_index_base               base_)
    {
        std::cout << "default traits_init_bsr not implemented (file: " << __FILE__ << ")"
                  << std::endl;
        throw rocsparse_status_internal_error;
    }
};

template <typename T, typename I, typename J>
struct traits_init_bsr<
    T,
    I,
    J,
    std::enable_if_t<std::is_same<rocsparse_int, J>{} && std::is_same<rocsparse_int, I>{}>>
{

    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_gebsr_matrix<T, I, J>&        that,
                     device_gebsr_matrix<T, I, J>&      that_on_device,
                     J&                                 mb_,
                     J&                                 nb_,
                     rocsparse_index_base               base_)
    {
        ROCSPARSE_CLIENTS_ROUTINE_TRACE;

        //
        // Initialize in case init_csr requires it as input.
        //
        rocsparse_int            block_dim = factory.m_arg.block_dim;
        rocsparse_int            M         = mb_ * block_dim;
        rocsparse_int            N         = nb_ * block_dim;
        host_csr_matrix<T, I, J> hA_uncompressed;

        // Always generate sorted CSR matrix as convert routine requires CSR matrix to be sorted
        hA_uncompressed.define(M, N, 0, base_);
        factory.init_csr(hA_uncompressed.ptr,
                         hA_uncompressed.ind,
                         hA_uncompressed.val,
                         hA_uncompressed.m,
                         hA_uncompressed.n,
                         hA_uncompressed.nnz,
                         hA_uncompressed.base,
                         rocsparse_matrix_type_general,
                         rocsparse_fill_mode_lower,
                         rocsparse_storage_mode_sorted);

        {
            device_csr_matrix<T, I, J> dA_uncompressed(hA_uncompressed);
            device_csr_matrix<T, I, J> dA_compressed;
            rocsparse_matrix_utils::compress(dA_compressed, dA_uncompressed, base_);
            rocsparse_matrix_utils::convert(dA_compressed,
                                            factory.m_arg.direction,
                                            block_dim,
                                            base_,
                                            rocsparse_storage_mode_sorted,
                                            that_on_device);
        }

        that(that_on_device);

        mb_ = that.mb;
        nb_ = that.nb;

        switch(factory.m_arg.storage)
        {
        case rocsparse_storage_mode_unsorted:
        {
            rocsparse_matrix_utils::host_gebsrunsort<T>(
                that.ptr.data(), that.ind.data(), that.mb, that.base);
            that_on_device(that);
            break;
        }
        case rocsparse_storage_mode_sorted:
        {
            break;
        }
        }
    };
};

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_bsr(host_gebsr_matrix<T, I, J>& that_,
                                                 J&                          mb_,
                                                 J&                          nb_,
                                                 rocsparse_index_base        base_)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    device_gebsr_matrix<T, I, J> dB;
    this->init_bsr(that_, dB, mb_, nb_, base_);
}

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_bsr(host_gebsr_matrix<T, I, J>&   that_,
                                                 device_gebsr_matrix<T, I, J>& that_on_device_,
                                                 J&                            mb_,
                                                 J&                            nb_,
                                                 rocsparse_index_base          base_)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    traits_init_bsr<T, I, J>::init(*this, that_, that_on_device_, mb_, nb_, base_);
}

//
// COO AOS
//
template <typename T, typename I, typename J, class FILTER = void>
struct traits_init_coo_aos
{

    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_coo_aos_matrix<T, I>&         that,
                     I&                                 M,
                     I&                                 N,
                     rocsparse_index_base               base)
    {
        std::cerr << "non reachable " << __LINE__ << std::endl;
        exit(1);
    };
};

template <typename T, typename I, typename J>
struct traits_init_coo_aos<T, I, J, std::enable_if_t<std::is_same<I, J>{}>>
{

    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_coo_aos_matrix<T, I>&         that,
                     I&                                 M,
                     I&                                 N,
                     rocsparse_index_base               base)
    {
        ROCSPARSE_CLIENTS_ROUTINE_TRACE;

        host_csr_matrix<T, I, I> hA;
        factory.init_csr(hA, M, N, base);
        that.define(hA.m, hA.n, hA.nnz, hA.base);
        host_csr_to_coo_aos(hA.m, hA.nnz, hA.ptr, hA.ind, that.ind, hA.base);
        that.val.transfer_from(hA.val);
    };
};

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_coo_aos(host_coo_aos_matrix<T, I>& that,
                                                     I&                         M,
                                                     I&                         N,
                                                     rocsparse_index_base       base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    traits_init_coo_aos<T, I, J>::init(*this, that, M, N, base);
}

//
// ELL
//
template <typename T, typename I, typename J, class FILTER = void>
struct traits_init_ell
{
    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_ell_matrix<T, I>&             that,
                     I&                                 M,
                     I&                                 N,
                     rocsparse_index_base               base)
    {
        std::cerr << "non reachable " << __LINE__ << std::endl;
        exit(1);
    };
};

template <typename T, typename I, typename J>
struct traits_init_ell<T, I, J, std::enable_if_t<std::is_same<I, J>{}>>
{
    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_ell_matrix<T, I>&             that,
                     I&                                 M,
                     I&                                 N,
                     rocsparse_index_base               base)
    {
        ROCSPARSE_CLIENTS_ROUTINE_TRACE;

        host_csr_matrix<T, I, I> hA;
        factory.init_csr(hA, M, N, base);
        that.define(hA.m, hA.n, 0, hA.base);
        host_csr_to_ell(
            hA.m, hA.ptr, hA.ind, hA.val, that.ind, that.val, that.width, hA.base, that.base);
        that.nnz = (int64_t)that.width * that.m;
    };
};

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_ell(host_ell_matrix<T, I>& that,
                                                 I&                     M,
                                                 I&                     N,
                                                 rocsparse_index_base   base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    traits_init_ell<T, I, J>::init(*this, that, M, N, base);
}

//
// SLICED ELL
//
template <typename T, typename I, typename J, class FILTER = void>
struct traits_init_sell
{
    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_sell_matrix<T, I, J>&         that,
                     J&                                 M,
                     J&                                 N,
                     J                                  sell_slice_size,
                     rocsparse_index_base               base)
    {
        std::cerr << "non reachable " << __LINE__ << std::endl;
        exit(1);
    };
};

template <typename T, typename I, typename J>
struct traits_init_sell<T, I, J, std::enable_if_t<std::is_same<I, J>{}>>
{
    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     host_sell_matrix<T, I, J>&         that,
                     J&                                 M,
                     J&                                 N,
                     J                                  sell_slice_size,
                     rocsparse_index_base               base)
    {
        ROCSPARSE_CLIENTS_ROUTINE_TRACE;

        host_csr_matrix<T, I, J> hA;
        factory.init_csr(hA, M, N, base);
        that.define(hA.m, hA.n, hA.nnz, sell_slice_size, 0, hA.base);
        host_csr_to_sell(hA.m,
                         sell_slice_size,
                         hA.ptr,
                         hA.ind,
                         hA.val,
                         that.ptr,
                         that.ind,
                         that.val,
                         that.sell_colval_size,
                         hA.base,
                         that.base);
    };
};

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_sell(
    host_sell_matrix<T, I, J>& that, J& M, J& N, J sell_slice_size, rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    traits_init_sell<T, I, J>::init(*this, that, M, N, sell_slice_size, base);
}

//
// HYB
//
template <typename T, typename I, typename J, class FILTER = void>
struct traits_init_hyb
{
    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     rocsparse_hyb_mat                  that,
                     I&                                 M,
                     I&                                 N,
                     I&                                 nnz,
                     rocsparse_index_base               base,
                     bool&                              conform)
    {
        std::cerr << "non reachable " << __LINE__ << std::endl;
        exit(1);
    };
};

template <typename T, typename I, typename J>
struct traits_init_hyb<T,
                       I,
                       J,
                       std::enable_if_t<std::is_same<I, J>{} && std::is_same<rocsparse_int, J>{}>>
{
    static void init(rocsparse_matrix_factory<T, I, J>& factory,
                     rocsparse_hyb_mat                  that,
                     I&                                 M,
                     I&                                 N,
                     I&                                 nnz,
                     rocsparse_index_base               base,
                     bool&                              conform)
    {
        ROCSPARSE_CLIENTS_ROUTINE_TRACE;

        conform                                = true;
        rocsparse_hyb_partition part           = factory.m_arg.part;
        rocsparse_int           user_ell_width = factory.m_arg.algo;

        host_csr_matrix<T, I, I> hA;
        factory.init_csr(hA, M, N, base);
        nnz = hA.nnz;

        // ELL width limit
        rocsparse_int width_limit = (M != 0) ? (2 * (hA.nnz - 1) / M + 1) : 0;

        // Limit ELL user width
        if(part == rocsparse_hyb_partition_user)
        {
            user_ell_width *= (M != 0) ? (hA.nnz / M) : 0;
            user_ell_width = std::min(width_limit, user_ell_width);
        }

        if(part == rocsparse_hyb_partition_max)
        {
            // Compute max ELL width
            rocsparse_int ell_max_width = 0;
            for(rocsparse_int i = 0; i < M; ++i)
            {
                ell_max_width = std::max(hA.ptr[i + 1] - hA.ptr[i], ell_max_width);
            }

            if(ell_max_width > width_limit)
            {
                conform = false;
                return;
            }
        }

        device_csr_matrix<T, I, I> dA(hA);

        rocsparse_handle handle;
        CHECK_ROCSPARSE_THROW_ERROR(rocsparse_create_handle(&handle));
        rocsparse_mat_descr descr;
        CHECK_ROCSPARSE_THROW_ERROR(rocsparse_create_mat_descr(&descr));
        // Set matrix index base
        CHECK_ROCSPARSE_THROW_ERROR(rocsparse_set_mat_index_base(descr, base));

        // Convert CSR matrix to HYB
        CHECK_ROCSPARSE_THROW_ERROR(rocsparse_csr2hyb<T>(
            handle, M, N, descr, dA.val, dA.ptr, dA.ind, that, user_ell_width, part));

        CHECK_ROCSPARSE_THROW_ERROR(rocsparse_destroy_mat_descr(descr));
        CHECK_ROCSPARSE_THROW_ERROR(rocsparse_destroy_handle(handle));
    };
};

template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_hyb(
    rocsparse_hyb_mat that, I& M, I& N, I& nnz, rocsparse_index_base base, bool& conform)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    traits_init_hyb<T, I, J>::init(*this, that, M, N, nnz, base, conform);
}

//
// BLOCKED ELL
//
template <typename T, typename I, typename J>
void rocsparse_matrix_factory<T, I, J>::init_bell(std::vector<I>&      bell_col_ind,
                                                  std::vector<T>&      bell_val,
                                                  I&                   mb,
                                                  I&                   nb,
                                                  I&                   ell_cols,
                                                  I&                   ell_block_size,
                                                  rocsparse_index_base base)
{
    ROCSPARSE_CLIENTS_ROUTINE_TRACE;

    // Generate or load a block level CSR matrix first (using whichever underlying matrix
    // initialization was selected), then convert it to Blocked ELL. The CSR matrix describes
    // the block sparsity pattern (mb block rows by nb block columns).
    J              Mb = static_cast<J>(mb);
    J              Nb = static_cast<J>(nb);
    I              nnzb;
    std::vector<I> csr_row_ptr;
    std::vector<J> csr_col_ind;
    std::vector<T> csr_val;

    this->m_instance->init_csr(csr_row_ptr,
                               csr_col_ind,
                               csr_val,
                               Mb,
                               Nb,
                               nnzb,
                               base,
                               rocsparse_matrix_type_general,
                               rocsparse_fill_mode_lower,
                               rocsparse_storage_mode_sorted);

    mb = static_cast<I>(Mb);
    nb = static_cast<I>(Nb);

    host_csr_to_bell(
        mb, ell_block_size, csr_row_ptr, csr_col_ind, bell_col_ind, bell_val, ell_cols, base);
}

//
// INSTANTIATE.
//
template struct rocsparse_matrix_factory<int8_t, int32_t, int32_t>;
template struct rocsparse_matrix_factory<int8_t, int64_t, int32_t>;
template struct rocsparse_matrix_factory<int8_t, int64_t, int64_t>;

template struct rocsparse_matrix_factory<_Float16, int32_t, int32_t>;
template struct rocsparse_matrix_factory<_Float16, int64_t, int32_t>;
template struct rocsparse_matrix_factory<_Float16, int64_t, int64_t>;

template struct rocsparse_matrix_factory<rocsparse_bfloat16, int32_t, int32_t>;
template struct rocsparse_matrix_factory<rocsparse_bfloat16, int64_t, int32_t>;
template struct rocsparse_matrix_factory<rocsparse_bfloat16, int64_t, int64_t>;

template struct rocsparse_matrix_factory<float, int32_t, int32_t>;
template struct rocsparse_matrix_factory<float, int64_t, int32_t>;
template struct rocsparse_matrix_factory<float, int64_t, int64_t>;

template struct rocsparse_matrix_factory<double, int32_t, int32_t>;
template struct rocsparse_matrix_factory<double, int64_t, int32_t>;
template struct rocsparse_matrix_factory<double, int64_t, int64_t>;

template struct rocsparse_matrix_factory<rocsparse_float_complex, int32_t, int32_t>;
template struct rocsparse_matrix_factory<rocsparse_float_complex, int64_t, int32_t>;
template struct rocsparse_matrix_factory<rocsparse_float_complex, int64_t, int64_t>;

template struct rocsparse_matrix_factory<rocsparse_double_complex, int32_t, int32_t>;
template struct rocsparse_matrix_factory<rocsparse_double_complex, int64_t, int32_t>;
template struct rocsparse_matrix_factory<rocsparse_double_complex, int64_t, int64_t>;