OpenBLAS/utest/test_extensions/test_cgemm.c

/*****************************************************************************
Copyright (c) 2023, The OpenBLAS Project
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

   1. Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.

   2. Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
   3. Neither the name of the OpenBLAS project nor the names of
      its contributors may be used to endorse or promote products
      derived from this software without specific prior written
      permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

**********************************************************************************/

#include "utest/openblas_utest.h"
#include <cblas.h>
#include "common.h"

#define DATASIZE 100
#define INCREMENT 2

struct DATA_CGEMM {
	float a_test[DATASIZE * DATASIZE * 2];
    float a_verify[DATASIZE * DATASIZE * 2];
	float b_test[DATASIZE * DATASIZE * 2];
    float b_verify[DATASIZE * DATASIZE * 2];
    float c_test[DATASIZE * DATASIZE * 2];
	float c_verify[DATASIZE * DATASIZE * 2];
};

#ifdef BUILD_COMPLEX
static struct DATA_CGEMM data_cgemm;

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices
 * and comparing it with the non-conjugate cgemm.
 *
 * param transa specifies op(A), the transposition (conjugation) operation applied to A
 * param transb specifies op(B), the transposition (conjugation) operation applied to B
 * param m specifies the number of rows of the matrix op(A) and of the matrix C
 * param n specifies the number of columns of the matrix op(B) and the number of columns of the matrix C
 * param k specifies the number of columns of the matrix op(A) and the number of rows of the matrix op(B)
 * param alpha - scaling factor for the matrix-matrix product
 * param lda - leading dimension of matrix A
 * param ldb - leading dimension of matrix B
 * param beta - scaling factor for matrix C
 * param ldc - leading dimension of matrix C
 * return norm of difference
 */
static float check_cgemm(char transa, char transb, blasint m, blasint n, blasint k, 
                         float *alpha, blasint lda, blasint ldb, float *beta, blasint ldc)
{
	blasint i;
	float alpha_conj[] = {1.0f, 0.0f}; 
	char transa_verify = transa;
    char transb_verify = transb;

    int arows = k, acols = m;
    int brows = n, bcols = k;

    if (transa == 'T' || transa == 'C'){
        arows = m; acols = k;
    }

    if (transb == 'T' || transb == 'C'){
        brows = k; bcols = n;
    }

	srand_generate(data_cgemm.a_test, arows * lda * 2);
	srand_generate(data_cgemm.b_test, brows * ldb * 2);
    srand_generate(data_cgemm.c_test, n * ldc * 2);

	for (i = 0; i < arows * lda * 2; i++)
		data_cgemm.a_verify[i] = data_cgemm.a_test[i];

	for (i = 0; i < brows * ldb * 2; i++)
		data_cgemm.b_verify[i] = data_cgemm.b_test[i];

    for (i = 0; i < n * ldc * 2; i++)
		data_cgemm.c_verify[i] = data_cgemm.c_test[i];

	if (transa == 'R'){
		cblas_cimatcopy(CblasColMajor, CblasConjNoTrans, arows, acols, alpha_conj, data_cgemm.a_verify, lda, lda);
		transa_verify = 'N';
	}

    if (transb == 'R'){
		cblas_cimatcopy(CblasColMajor, CblasConjNoTrans, brows, bcols, alpha_conj, data_cgemm.b_verify, ldb, ldb);
		transb_verify = 'N';
	}

	BLASFUNC(cgemm)(&transa_verify, &transb_verify, &m, &n, &k, alpha, data_cgemm.a_verify, &lda,
	 				data_cgemm.b_verify, &ldb, beta, data_cgemm.c_verify, &ldc);

	BLASFUNC(cgemm)(&transa, &transb, &m, &n, &k, alpha, data_cgemm.a_test, &lda,
	 				data_cgemm.b_test, &ldb, beta, data_cgemm.c_test, &ldc);

	return smatrix_difference(data_cgemm.c_test, data_cgemm.c_verify, m, n, ldc*2);
}

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices 
 * and comparing it with the non-conjugate cgemm.
 * Test with the following options:
 *
 * matrix A is conjugate and transposed
 * matrix B is conjugate and not transposed
 */
CTEST(cgemm, conjtransa_conjnotransb)
{
	blasint n = DATASIZE, m = DATASIZE, k = DATASIZE;
    blasint lda = DATASIZE, ldb = DATASIZE, ldc = DATASIZE;
	char transa = 'C';
	char transb = 'R';
	float alpha[] = {-2.0, 1.0f};
    float beta[] = {1.0f, -1.0f};

	float norm = check_cgemm(transa, transb, m, n, k, alpha, lda, ldb, beta, ldc);

	ASSERT_DBL_NEAR_TOL(0.0f, norm, SINGLE_EPS);
}

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices 
 * and comparing it with the non-conjugate cgemm.
 * Test with the following options:
 *
 * matrix A is not conjugate and not transposed
 * matrix B is conjugate and not transposed
 */
CTEST(cgemm, notransa_conjnotransb)
{
	blasint n = DATASIZE, m = DATASIZE, k = DATASIZE;
    blasint lda = DATASIZE, ldb = DATASIZE, ldc = DATASIZE;
	char transa = 'N';
	char transb = 'R';
	float alpha[] = {-2.0, 1.0f};
    float beta[] = {1.0f, -1.0f};

	float norm = check_cgemm(transa, transb, m, n, k, alpha, lda, ldb, beta, ldc);

	ASSERT_DBL_NEAR_TOL(0.0f, norm, SINGLE_EPS);
}

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices 
 * and comparing it with the non-conjugate cgemm.
 * Test with the following options:
 *
 * matrix A is conjugate and not transposed
 * matrix B is conjugate and transposed
 */
CTEST(cgemm, conjnotransa_conjtransb)
{
	blasint n = DATASIZE, m = DATASIZE, k = DATASIZE;
    blasint lda = DATASIZE, ldb = DATASIZE, ldc = DATASIZE;
	char transa = 'R';
	char transb = 'C';
	float alpha[] = {-2.0, 1.0f};
    float beta[] = {1.0f, -1.0f};

	float norm = check_cgemm(transa, transb, m, n, k, alpha, lda, ldb, beta, ldc);

	ASSERT_DBL_NEAR_TOL(0.0f, norm, SINGLE_EPS);
}

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices 
 * and comparing it with the non-conjugate cgemm.
 * Test with the following options:
 *
 * matrix A is conjugate and not transposed
 * matrix B is not conjugate and not transposed
 */
CTEST(cgemm, conjnotransa_notransb)
{
	blasint n = DATASIZE, m = DATASIZE, k = DATASIZE;
    blasint lda = DATASIZE, ldb = DATASIZE, ldc = DATASIZE;
	char transa = 'R';
	char transb = 'N';
	float alpha[] = {-2.0, 1.0f};
    float beta[] = {1.0f, -1.0f};

	float norm = check_cgemm(transa, transb, m, n, k, alpha, lda, ldb, beta, ldc);

	ASSERT_DBL_NEAR_TOL(0.0f, norm, SINGLE_EPS);
}

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices 
 * and comparing it with the non-conjugate cgemm.
 * Test with the following options:
 *
 * matrix A is conjugate and not transposed
 * matrix B is conjugate and not transposed
 */
CTEST(cgemm, conjnotransa_conjnotransb)
{
	blasint n = DATASIZE, m = DATASIZE, k = DATASIZE;
    blasint lda = DATASIZE, ldb = DATASIZE, ldc = DATASIZE;
	char transa = 'R';
	char transb = 'R';
	float alpha[] = {-2.0, 1.0f};
    float beta[] = {1.0f, -1.0f};

	float norm = check_cgemm(transa, transb, m, n, k, alpha, lda, ldb, beta, ldc);

	ASSERT_DBL_NEAR_TOL(0.0f, norm, SINGLE_EPS);
}

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices 
 * and comparing it with the non-conjugate cgemm.
 * Test with the following options:
 *
 * matrix A is conjugate and not transposed
 * matrix B is transposed
 */
CTEST(cgemm, conjnotransa_transb)
{
	blasint n = DATASIZE, m = DATASIZE, k = DATASIZE;
    blasint lda = DATASIZE, ldb = DATASIZE, ldc = DATASIZE;
	char transa = 'R';
	char transb = 'T';
	float alpha[] = {-2.0, 1.0f};
    float beta[] = {1.0f, -1.0f};

	float norm = check_cgemm(transa, transb, m, n, k, alpha, lda, ldb, beta, ldc);

	ASSERT_DBL_NEAR_TOL(0.0f, norm, SINGLE_EPS);
}

/**
 * Test cgemm with the conjugate matrices by conjugating and not transposed matrices 
 * and comparing it with the non-conjugate cgemm.
 * Test with the following options:
 *
 * matrix A is transposed
 * matrix B is conjugate and not transposed
 */
CTEST(cgemm, transa_conjnotransb)
{
	blasint n = DATASIZE, m = DATASIZE, k = DATASIZE;
    blasint lda = DATASIZE, ldb = DATASIZE, ldc = DATASIZE;
	char transa = 'T';
	char transb = 'R';
	float alpha[] = {-2.0, 1.0f};
    float beta[] = {1.0f, -1.0f};

	float norm = check_cgemm(transa, transb, m, n, k, alpha, lda, ldb, beta, ldc);

	ASSERT_DBL_NEAR_TOL(0.0f, norm, SINGLE_EPS);
}
#endif