TheRock/rocm-libraries/projects/rocalution/clients/tests/test_gmres.cpp

/* ************************************************************************
 * Copyright (C) 2018-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 "testing_gmres.hpp"
#include "utility.hpp"

#include <gtest/gtest.h>
#include <vector>

typedef std::tuple<int, int, std::string, std::string, unsigned int, int> gmres_tuple;

std::vector<int>         gmres_size               = {7, 63};
std::vector<int>         gmres_basis              = {20, 60};
std::vector<std::string> gmres_matrix             = {"laplacian"};
std::vector<std::string> gmres_bad_precond_matrix = {"permuted_identity"};
std::vector<std::string> gmres_precond
    = {"None", "Chebyshev", "GS", "ILU", "ItILU0", "ILUT", "MCGS", "MCILU"};
std::vector<std::string>  gmres_bad_precond = {"MCGS"};
std::vector<unsigned int> gmres_format      = {1, 2, 5, 6};
std::vector<int>          gmres_use_acc     = {1};

// Function to update tests if environment variable is set
void update_gmres()
{
    if(is_any_env_var_set({"ROCALUTION_EMULATION_SMOKE",
                           "ROCALUTION_EMULATION_REGRESSION",
                           "ROCALUTION_EMULATION_EXTENDED",
                           "ROCALUTION_CODE_COVERAGE"}))
    {
        gmres_size.clear();
        gmres_basis.clear();
        gmres_precond.clear();
        gmres_format.clear();
    }
    if(is_env_var_set("ROCALUTION_CODE_COVERAGE"))
    {
        gmres_size.push_back(7);
        gmres_basis.push_back(20);
        gmres_precond.insert(gmres_precond.end(),
                             {"None", "Chebyshev", "GS", "ILU", "ItILU0", "ILUT", "MCGS", "MCILU"});
        gmres_format.insert(gmres_format.end(), {1, 2, 5, 6});
        gmres_use_acc.push_back(0);
    }

    if(is_env_var_set("ROCALUTION_EMULATION_SMOKE"))
    {
        gmres_size.push_back(7);
        gmres_basis.push_back(20);
        gmres_precond.insert(gmres_precond.end(), {"None", "ILU"});
        gmres_format.push_back(6);
    }
    else if(is_env_var_set("ROCALUTION_EMULATION_REGRESSION"))
    {
        gmres_size.push_back(7);
        gmres_basis.push_back(60);
        gmres_precond.insert(gmres_precond.end(), {"Chebyshev", "GS"});
        gmres_format.push_back(1);
    }
    else if(is_env_var_set("ROCALUTION_EMULATION_EXTENDED"))
    {
        gmres_size.push_back(63);
        gmres_basis.push_back(60);
        gmres_precond.insert(gmres_precond.end(), {"ILUT", "MCILU"});
        gmres_format.insert(gmres_format.end(), {2, 5});
    }
}

struct GMRESInitializer
{
    GMRESInitializer()
    {
        update_gmres();
    }
};

// Create a global instance of the initializer, so the environment is checked and updated before tests.
GMRESInitializer gmres_initializer;

class parameterized_gmres : public testing::TestWithParam<gmres_tuple>
{
protected:
    parameterized_gmres() {}
    virtual ~parameterized_gmres() {}
    virtual void SetUp() {}
    virtual void TearDown() {}
};

class parameterized_gmres_bad_precond : public testing::TestWithParam<gmres_tuple>
{
protected:
    parameterized_gmres_bad_precond() {}
    virtual ~parameterized_gmres_bad_precond() {}
    virtual void SetUp() override
    {
        if(is_any_env_var_set({"ROCALUTION_EMULATION_SMOKE",
                               "ROCALUTION_EMULATION_REGRESSION",
                               "ROCALUTION_EMULATION_EXTENDED"})
           && !is_env_var_set("ROCALUTION_CODE_COVERAGE"))
        {
            GTEST_SKIP();
        }
    }

    virtual void TearDown() {}
};

Arguments setup_gmres_arguments(gmres_tuple tup)
{
    Arguments arg;
    arg.size    = std::get<0>(tup);
    arg.index   = std::get<1>(tup);
    arg.matrix  = std::get<2>(tup);
    arg.precond = std::get<3>(tup);
    arg.format  = std::get<4>(tup);
    arg.use_acc = std::get<5>(tup);
    return arg;
}

TEST_P(parameterized_gmres, gmres_float)
{
    Arguments arg = setup_gmres_arguments(GetParam());
    ASSERT_EQ(testing_gmres<float>(arg), true);
}

TEST_P(parameterized_gmres, gmres_double)
{
    Arguments arg = setup_gmres_arguments(GetParam());
    ASSERT_EQ(testing_gmres<double>(arg), true);
}

TEST_P(parameterized_gmres_bad_precond, gmres_float)
{
    Arguments arg = setup_gmres_arguments(GetParam());
    ASSERT_EQ(testing_gmres<float>(arg, false), true);
}

INSTANTIATE_TEST_CASE_P(gmres,
                        parameterized_gmres,
                        testing::Combine(testing::ValuesIn(gmres_size),
                                         testing::ValuesIn(gmres_basis),
                                         testing::ValuesIn(gmres_matrix),
                                         testing::ValuesIn(gmres_precond),
                                         testing::ValuesIn(gmres_format),
                                         testing::ValuesIn(gmres_use_acc)));

INSTANTIATE_TEST_CASE_P(gmres_bad_precond,
                        parameterized_gmres_bad_precond,
                        testing::Combine(testing::ValuesIn(gmres_size),
                                         testing::ValuesIn(gmres_basis),
                                         testing::ValuesIn(gmres_bad_precond_matrix),
                                         testing::ValuesIn(gmres_bad_precond),
                                         testing::ValuesIn(gmres_format),
                                         testing::ValuesIn(gmres_use_acc)));