SparseMatSuperLU.hpp

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (C) 2017-2025 Theodore Chang
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
// ReSharper disable CppCStyleCast
#ifndef SPARSEMATSUPERLU_HPP
#define SPARSEMATSUPERLU_HPP
 
#include "../SparseMat.hpp"
#include "../csc_form.hpp"
 
#include <superlu-mt/superlu-mt.h>
 
template<sp_d T> class SparseMatSuperLU final : public SparseMat<T> {
    SuperMatrix A{}, L{}, U{}, B{};
 
#ifndef SUANPAN_SUPERLUMT
    superlu_options_t options{};
 
    SuperLUStat_t stat{};
#else
    const int ordering_num = 1;
 
    Gstat_t stat{};
#endif
 
    std::vector<T> t_val;
    std::vector<int> t_row, t_col, perm_r, perm_c;
 
    bool allocated = false;
 
    auto init_config();
 
    template<sp_d ET> void alloc(csc_form<ET, int>&&);
    void dealloc();
 
    template<sp_d ET> void wrap_b(const Mat<ET>&);
 
    int solve_trs(Mat<T>&, Mat<T>&&);
 
protected:
    int direct_solve(Mat<T>& out_mat, const Mat<T>& in_mat) override { return this->direct_solve(out_mat, Mat<T>(in_mat)); }
 
    int direct_solve(Mat<T>&, Mat<T>&&) override;
 
public:
    SparseMatSuperLU(uword, uword, uword = 0);
    SparseMatSuperLU(const SparseMatSuperLU&);
    SparseMatSuperLU(SparseMatSuperLU&&) = delete;
    SparseMatSuperLU& operator=(const SparseMatSuperLU&) = delete;
    SparseMatSuperLU& operator=(SparseMatSuperLU&&) = delete;
    ~SparseMatSuperLU() override;
 
    unique_ptr<MetaMat<T>> make_copy() override;
};
 
template<sp_d T> auto SparseMatSuperLU<T>::init_config() {
#ifndef SUANPAN_SUPERLUMT
    set_default_options(&options);
    options.IterRefine = std::is_same_v<T, float> ? superlu::IterRefine_t::SLU_SINGLE : superlu::IterRefine_t::SLU_DOUBLE;
    options.Equil = superlu::yes_no_t::NO;
 
    StatInit(&stat);
#else
    StatAlloc(static_cast<int>(this->n_cols), SUANPAN_NUM_THREADS, sp_ienv(1), sp_ienv(2), &stat);
    StatInit(static_cast<int>(this->n_cols), SUANPAN_NUM_THREADS, &stat);
#endif
 
    this->factored = false;
}
 
template<sp_d T> template<sp_d ET> void SparseMatSuperLU<T>::alloc(csc_form<ET, int>&& in) {
    dealloc();
 
    t_row = std::vector<int>(in.row_mem(), in.row_mem() + in.n_elem);
    t_col = std::vector<int>(in.col_mem(), in.col_mem() + in.n_cols + 1);
    t_val = std::vector<ET>(in.val_mem(), in.val_mem() + in.n_elem);
 
    if constexpr(std::is_same_v<ET, double>) {
        using E = double;
        dCreate_CompCol_Matrix(&A, in.n_rows, in.n_cols, in.n_elem, (E*)t_val.data(), t_row.data(), t_col.data(), Stype_t::SLU_NC, Dtype_t::SLU_D, Mtype_t::SLU_GE);
    }
    else {
        using E = float;
        sCreate_CompCol_Matrix(&A, in.n_rows, in.n_cols, in.n_elem, (E*)t_val.data(), t_row.data(), t_col.data(), Stype_t::SLU_NC, Dtype_t::SLU_S, Mtype_t::SLU_GE);
    }
 
    perm_r.resize(this->n_rows + 1);
    perm_c.resize(this->n_cols + 1);
 
    allocated = true;
}
 
template<sp_d T> void SparseMatSuperLU<T>::dealloc() {
    if(!allocated) return;
 
    Destroy_SuperMatrix_Store(&A);
#ifdef SUANPAN_SUPERLUMT
    Destroy_SuperNode_SCP(&L);
    Destroy_CompCol_NCP(&U);
#else
    Destroy_SuperNode_Matrix(&L);
    Destroy_CompCol_Matrix(&U);
#endif
 
    allocated = false;
}
 
template<sp_d T> template<sp_d ET> void SparseMatSuperLU<T>::wrap_b(const Mat<ET>& in_mat) {
    if constexpr(std::is_same_v<ET, float>) {
        using E = float;
        sCreate_Dense_Matrix(&B, (int)in_mat.n_rows, (int)in_mat.n_cols, (E*)in_mat.memptr(), (int)in_mat.n_rows, Stype_t::SLU_DN, Dtype_t::SLU_S, Mtype_t::SLU_GE);
    }
    else {
        using E = double;
        dCreate_Dense_Matrix(&B, (int)in_mat.n_rows, (int)in_mat.n_cols, (E*)in_mat.memptr(), (int)in_mat.n_rows, Stype_t::SLU_DN, Dtype_t::SLU_D, Mtype_t::SLU_GE);
    }
}
 
template<sp_d T> SparseMatSuperLU<T>::SparseMatSuperLU(const uword in_row, const uword in_col, const uword in_elem)
    : SparseMat<T>(in_row, in_col, in_elem) { init_config(); }
 
template<sp_d T> SparseMatSuperLU<T>::SparseMatSuperLU(const SparseMatSuperLU& other)
    : SparseMat<T>(other) { init_config(); }
 
template<sp_d T> SparseMatSuperLU<T>::~SparseMatSuperLU() {
    dealloc();
    StatFree(&stat);
}
 
template<sp_d T> unique_ptr<MetaMat<T>> SparseMatSuperLU<T>::make_copy() { return std::make_unique<SparseMatSuperLU>(*this); }
 
template<sp_d T> int SparseMatSuperLU<T>::direct_solve(Mat<T>& out_mat, Mat<T>&& in_mat) {
    if(this->factored) return solve_trs(out_mat, std::move(in_mat));
 
    this->factored = true;
 
    alloc(csc_form<T, int>(this->triplet_mat));
 
    wrap_b(in_mat);
 
    int flag{0};
 
#ifdef SUANPAN_SUPERLUMT
    get_perm_c(ordering_num, &A, perm_c.data());
    if(std::is_same_v<T, float>) psgssv(SUANPAN_NUM_THREADS, &A, perm_c.data(), perm_r.data(), &L, &U, &B, &flag);
    else pdgssv(SUANPAN_NUM_THREADS, &A, perm_c.data(), perm_r.data(), &L, &U, &B, &flag);
#else
    superlu::gssv<T>(&options, &A, perm_c.data(), perm_r.data(), &L, &U, &B, &stat, &flag);
#endif
 
    Destroy_SuperMatrix_Store(&B);
 
    out_mat = std::move(in_mat);
 
    return flag;
}
 
template<sp_d T> int SparseMatSuperLU<T>::solve_trs(Mat<T>& out_mat, Mat<T>&& in_mat) {
    wrap_b(in_mat);
 
    int flag{0};
 
#ifdef SUANPAN_SUPERLUMT
    if(std::is_same_v<T, float>) sgstrs(NOTRANS, &L, &U, perm_c.data(), perm_r.data(), &B, &stat, &flag);
    else dgstrs(NOTRANS, &L, &U, perm_c.data(), perm_r.data(), &B, &stat, &flag);
#else
    superlu::gstrs<T>(options.Trans, &L, &U, perm_c.data(), perm_r.data(), &B, &stat, &flag);
#endif
 
    Destroy_SuperMatrix_Store(&B);
 
    out_mat = std::move(in_mat);
 
    return flag;
}
#endif