TheRock/rocm-libraries/projects/hipblas/clients/include/syrkx_reference.hpp

/* ************************************************************************
 * Copyright (C) 2016-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.
 *
 * ************************************************************************ */

#pragma once

#include <fstream>
#include <iostream>
#include <stdlib.h>
#include <vector>

#include "testing_common.hpp"

// reference implementation of syrkx. This function is not part of legacy BLAS.
template <typename T>
void syrkx_reference(hipblasFillMode_t  uplo,
                     hipblasOperation_t trans,
                     int                n,
                     int                k,
                     T                  alpha,
                     T*                 a,
                     int                lda,
                     T*                 b,
                     int                ldb,
                     T                  beta,
                     T*                 c,
                     int                ldc)
{
    int a_s1 = HIPBLAS_OP_N == trans ? 1 : lda;
    int a_s2 = HIPBLAS_OP_N == trans ? lda : 1;
    int b_s1 = HIPBLAS_OP_N == trans ? 1 : ldb;
    int b_s2 = HIPBLAS_OP_N == trans ? ldb : 1;
    int c_s1 = 1;
    int c_s2 = ldc;

    // argument error
    int nrow = trans == HIPBLAS_OP_N ? n : k;
    if(n < 0)
    {
        std::cout << "ERROR: syrkx_reference n < 0" << std::endl;
        return;
    }
    if(k < 0)
    {
        std::cout << "ERROR: syrk_reference k < 0" << std::endl;
        return;
    }
    if(n > ldc)
    {
        std::cout << "ERROR: syrk_reference n > ldc" << std::endl;
        return;
    }
    if(nrow > lda)
    {
        std::cout << "ERROR: syrk_reference nrow > lda" << std::endl;
        return;
    }
    if(nrow > ldb)
    {
        std::cout << "ERROR: syrk_reference nrow > ldb" << std::endl;
        return;
    }

    // quick return
    if((n == 0) || (((alpha == T(0)) || (k == 0)) && (beta == T(1))))
        return;

    // rank kx update with special cases for alpha == 0, beta == 0
    for(int i1 = 0; i1 < n; i1++)
    {
        int i2_start = HIPBLAS_FILL_MODE_LOWER == uplo ? 0 : i1;
        int i2_end   = HIPBLAS_FILL_MODE_LOWER == uplo ? i1 + 1 : n;
        for(int i2 = i2_start; i2 < i2_end; i2++)
        {
            if(alpha == T(0) && beta == T(0))
            {
                c[i1 * c_s1 + i2 * c_s2] = 0.0;
            }
            else if(alpha == T(0))
            {
                c[i1 * c_s1 + i2 * c_s2] *= beta;
            }
            else
            {
                T t = 0;
                for(int i3 = 0; i3 < k; i3++)
                {
                    t += a[i1 * a_s1 + i3 * a_s2] * b[i2 * b_s1 + i3 * b_s2];
                }
                c[i1 * c_s1 + i2 * c_s2] = beta * c[i1 * c_s1 + i2 * c_s2] + alpha * t;
            }
        }
    }
    return;
}