TheRock/rocm-libraries/projects/hipblas/clients/gtest/solver/geqrf_gtest.cpp

/* ************************************************************************
 * Copyright (C) 2023-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 cop-
 * ies 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 IM-
 * PLIED, 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 CONNE-
 * CTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 * ************************************************************************ */

#include "hipblas_data.hpp"
#include "hipblas_test.hpp"
#include "solver/testing_geqrf.hpp"
#include "solver/testing_geqrf_batched.hpp"
#include "solver/testing_geqrf_strided_batched.hpp"
#include "type_dispatch.hpp"

namespace
{
    // possible geqrf test cases
    enum geqrf_test_type
    {
        GEQRF,
        GEQRF_BATCHED,
        GEQRF_STRIDED_BATCHED,
    };

    //geqrf test template
    template <template <typename...> class FILTER, geqrf_test_type GEQRF_TYPE>
    struct geqrf_template : HipBLAS_Test<geqrf_template<FILTER, GEQRF_TYPE>, FILTER>
    {
        template <typename... T>
        struct type_filter_functor
        {
            bool operator()(const Arguments& args)
            {
                // additional global filters applied first
                if(!hipblas_client_global_filters(args))
                    return false;

                // type filters
                return static_cast<bool>(FILTER<T...>{});
            }
        };

        // Filter for which types apply to this suite
        static bool type_filter(const Arguments& arg)
        {
            return hipblas_simple_dispatch<geqrf_template::template type_filter_functor>(arg);
        }

        // Filter for which functions apply to this suite
        static bool function_filter(const Arguments& arg)
        {
            switch(GEQRF_TYPE)
            {
            case GEQRF:
                return !strcmp(arg.function, "geqrf") || !strcmp(arg.function, "geqrf_bad_arg");
            case GEQRF_BATCHED:
                return !strcmp(arg.function, "geqrf_batched")
                       || !strcmp(arg.function, "geqrf_batched_bad_arg");
            case GEQRF_STRIDED_BATCHED:
                return !strcmp(arg.function, "geqrf_strided_batched")
                       || !strcmp(arg.function, "geqrf_strided_batched_bad_arg");
            }
            return false;
        }

        // Google Test name suffix based on parameters
        static std::string name_suffix(const Arguments& arg)
        {
            std::string name;
            if constexpr(GEQRF_TYPE == GEQRF)
                testname_geqrf(arg, name);
            else if constexpr(GEQRF_TYPE == GEQRF_BATCHED)
                testname_geqrf_batched(arg, name);
            else if constexpr(GEQRF_TYPE == GEQRF_STRIDED_BATCHED)
                testname_geqrf_strided_batched(arg, name);
            return std::move(name);
        }
    };

    // By default, arbitrary type combinations are invalid.
    // The unnamed second parameter is used for enable_if_t below.
    template <typename, typename = void>
    struct geqrf_testing : hipblas_test_invalid
    {
    };

    // When the condition in the second argument is satisfied, the type combination
    // is valid. When the condition is false, this specialization does not apply.
    template <typename T>
    struct geqrf_testing<
        T,
        std::enable_if_t<
            std::is_same_v<
                T,
                float> || std::is_same_v<T, double> || std::is_same_v<T, std::complex<float>> || std::is_same_v<T, std::complex<double>>>>
        : hipblas_test_valid
    {
        void operator()(const Arguments& arg)
        {
            if(!strcmp(arg.function, "geqrf"))
                testing_geqrf<T>(arg);
            else if(!strcmp(arg.function, "geqrf_bad_arg"))
                testing_geqrf_bad_arg<T>(arg);
            else if(!strcmp(arg.function, "geqrf_batched"))
                testing_geqrf_batched<T>(arg);
            else if(!strcmp(arg.function, "geqrf_batched_bad_arg"))
                testing_geqrf_batched_bad_arg<T>(arg);
            else if(!strcmp(arg.function, "geqrf_strided_batched"))
                testing_geqrf_strided_batched<T>(arg);
            else if(!strcmp(arg.function, "geqrf_strided_batched_bad_arg"))
                testing_geqrf_strided_batched_bad_arg<T>(arg);
            else
                FAIL() << "Internal error: Test called with unknown function: " << arg.function;
        }
    };

    using geqrf = geqrf_template<geqrf_testing, GEQRF>;
    TEST_P(geqrf, solver)
    {
        CATCH_SIGNALS_AND_EXCEPTIONS_AS_FAILURES(
            hipblas_simple_dispatch<geqrf_testing>(GetParam()));
    }
    INSTANTIATE_TEST_CATEGORIES(geqrf);

    using geqrf_batched = geqrf_template<geqrf_testing, GEQRF_BATCHED>;
    TEST_P(geqrf_batched, solver)
    {
        CATCH_SIGNALS_AND_EXCEPTIONS_AS_FAILURES(
            hipblas_simple_dispatch<geqrf_testing>(GetParam()));
    }
    INSTANTIATE_TEST_CATEGORIES(geqrf_batched);

    using geqrf_strided_batched = geqrf_template<geqrf_testing, GEQRF_STRIDED_BATCHED>;
    TEST_P(geqrf_strided_batched, solver)
    {
        CATCH_SIGNALS_AND_EXCEPTIONS_AS_FAILURES(
            hipblas_simple_dispatch<geqrf_testing>(GetParam()));
    }
    INSTANTIATE_TEST_CATEGORIES(geqrf_strided_batched);

} // namespace