Files
blis/gtestsuite/testsuite/level2/hpmv/IIT_ERS/hpmv_IIT_ERS.cpp
Smyth, Edward c32247678c GTestSuite: Packed APIs (hpmv, spmv, tpmv, tpsv)
Create gtestsuite programs for subset of packed matrix APIs. Priority is to
create framework with a basic set of tests - refinement of problem sizes
can be investigated later.

AMD-Internal: [CPUPL-7386]
2026-01-16 12:08:36 +00:00

597 lines
22 KiB
C++

/*
BLIS
An object-based framework for developing high-performance BLAS-like
libraries.
Copyright (C) 2026, Advanced Micro Devices, Inc. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
- Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
- 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.
- Neither the name(s) of the copyright holder(s) 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
HOLDER 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 <gtest/gtest.h>
#include "level2/hpmv/test_hpmv.h"
#include "common/wrong_inputs_helpers.h"
#include "common/testing_helpers.h"
#include "inc/check_error.h"
template <typename T>
class hpmv_IIT_ERS : public ::testing::Test {};
typedef ::testing::Types<scomplex, dcomplex> TypeParam;
TYPED_TEST_SUITE(hpmv_IIT_ERS, TypeParam);
using namespace testinghelpers::IIT;
#if defined(TEST_CBLAS)
#define INFO_OFFSET 1
#else
#define INFO_OFFSET 0
#endif
#if defined(TEST_CBLAS)
TYPED_TEST(hpmv_IIT_ERS, invalid_storage)
{
using T = TypeParam;
gtint_t incx = 3;
gtint_t incy = 3;
T alpha, beta;
testinghelpers::initone<T>( alpha );
testinghelpers::initone<T>( beta );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
hpmv<T>( 'x', UPLO, N, &alpha, nullptr,
nullptr, incx, &beta, nullptr, incy );
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 1 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of c so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( 'x', UPLO, N, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 1 );
#endif
}
#endif
#if defined(TEST_BLAS_LIKE) || defined(TEST_CBLAS)
/*
Incorrect Input Testing(IIT)
BLAS exceptions get triggered in the following cases(for HPMV):
1. When UPLO != 'N' || UPLO != 'T' || UPLO != 'C' (info = 1)
3. When n < 0 (info = 2)
4. When incx = 0 (info = 6)
5. When incy = 0 (info = 9)
*/
TYPED_TEST(hpmv_IIT_ERS, invalid_UPLO)
{
using T = TypeParam;
gtint_t incx = 3;
gtint_t incy = 3;
T alpha, beta;
testinghelpers::initone<T>( alpha );
testinghelpers::initone<T>( beta );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
#if defined(TEST_BLAS_LIKE)
hpmv<T>( STORAGE, 'p', N, nullptr, nullptr,
nullptr, incx, nullptr, nullptr, incy );
#else
hpmv<T>( STORAGE, 'p', N, &alpha, nullptr,
nullptr, incx, &beta, nullptr, incy );
#endif
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, INFO_OFFSET+1 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of c so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, 'p', N, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, INFO_OFFSET+1 );
#endif
}
TYPED_TEST(hpmv_IIT_ERS, n_lt_zero)
{
using T = TypeParam;
gtint_t invalid_n = -1;
gtint_t incx = 3;
gtint_t incy = 3;
T alpha, beta;
testinghelpers::initone<T>( alpha );
testinghelpers::initone<T>( beta );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
#if defined(TEST_BLAS_LIKE)
hpmv<T>( STORAGE, UPLO, invalid_n, nullptr, nullptr,
nullptr, incx, nullptr, nullptr, incy );
#else
hpmv<T>( STORAGE, UPLO, invalid_n, &alpha, nullptr,
nullptr, incx, &beta, nullptr, incy );
#endif
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 2 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of y so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, invalid_n, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 2 );
#endif
}
TYPED_TEST(hpmv_IIT_ERS, incx_eq_zero)
{
using T = TypeParam;
gtint_t incx = 3;
gtint_t incy = 3;
T alpha, beta;
testinghelpers::initone<T>( alpha );
testinghelpers::initone<T>( beta );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
#if defined(TEST_BLAS_LIKE)
hpmv<T>( STORAGE, UPLO, N, nullptr, nullptr,
nullptr, 0, nullptr, nullptr, incy );
#else
hpmv<T>( STORAGE, UPLO, N, &alpha, nullptr,
nullptr, 0, &beta, nullptr, incy );
#endif
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 6 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of y so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, N, &alpha, a.data(),
x.data(), 0, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 6 );
#endif
}
TYPED_TEST(hpmv_IIT_ERS, incy_eq_zero)
{
using T = TypeParam;
gtint_t incx = 3;
gtint_t incy = 3;
T alpha, beta;
testinghelpers::initone<T>( alpha );
testinghelpers::initone<T>( beta );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
#if defined(TEST_BLAS_LIKE)
hpmv<T>( STORAGE, UPLO, N, nullptr, nullptr,
nullptr, incx, nullptr, nullptr, 0 );
#else
hpmv<T>( STORAGE, UPLO, N, &alpha, nullptr,
nullptr, incx, &beta, nullptr, 0 );
#endif
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 9 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of y so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, N, &alpha, a.data(),
x.data(), incx, &beta, y.data(), 0 );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 9 );
#endif
}
/*
BLAS Early Return Scenarios(ERS):
hpmv is expected to return early in the following cases:
1. m || n = 0
2. alpha = 0 && beta = 1
*/
// n = 0
TYPED_TEST(hpmv_IIT_ERS, n_eq_zero)
{
using T = TypeParam;
gtint_t invalid_n = 0;
gtint_t incx = 1;
gtint_t incy = 1;
T alpha = T{1.3};
T beta = T{0.7};
// Test with nullptr for all suitable arguments that shouldn't be accessed.
#if defined(TEST_BLAS_LIKE)
hpmv<T>( STORAGE, UPLO, invalid_n, nullptr, nullptr,
nullptr, incx, nullptr, nullptr, incy );
#else
hpmv<T>( STORAGE, UPLO, invalid_n, &alpha, nullptr,
nullptr, incx, &beta, nullptr, incy );
#endif
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of c so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, invalid_n, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
}
// n = 0, with unit alpha and beta
TYPED_TEST(hpmv_IIT_ERS, n_eq_zero_UnitAlphaBeta)
{
using T = TypeParam;
gtint_t invalid_n = 0;
gtint_t incx = 1;
gtint_t incy = 1;
T alpha, beta;
testinghelpers::initone<T>( alpha );
testinghelpers::initone<T>( beta );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
hpmv<T>( STORAGE, UPLO, invalid_n, &alpha, nullptr,
nullptr, incx, &beta, nullptr, incy );
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of c so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, invalid_n, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
}
// zero alpha and unit beta
TYPED_TEST(hpmv_IIT_ERS, ZeroAlpha_UnitBeta)
{
using T = TypeParam;
gtint_t incx = 1;
gtint_t incy = 1;
T alpha, beta;
testinghelpers::initzero<T>( alpha );
testinghelpers::initone<T>( beta );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
hpmv<T>( STORAGE, UPLO, N, &alpha, nullptr,
nullptr, incx, &beta, nullptr, incy );
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 1, 3, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 1, 3, N, incy );
// Create a copy of c so that we can check reference results.
std::vector<T> y_ref(y);
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, N, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
}
// zero alpha and zero beta - set y to zero
TYPED_TEST(hpmv_IIT_ERS, ZeroAlpha_ZeroBeta)
{
using T = TypeParam;
gtint_t incx = 3;
gtint_t incy = 3;
T alpha, beta;
testinghelpers::initzero<T>( alpha );
testinghelpers::initzero<T>( beta );
// Vector y should not be read, only set.
std::vector<T> y( testinghelpers::buff_dim(N, incy) );
testinghelpers::set_vector( N, incy, y.data(), testinghelpers::aocl_extreme<T>() );
std::vector<T> y2(y);
// Create a zero vector, since the output for alpha = beta = 0 should be a
// zero vector.
std::vector<T> zero_vec = testinghelpers::get_random_vector<T>( 0, 0, N, incy );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
hpmv<T>( STORAGE, UPLO, N, &alpha, nullptr,
nullptr, incx, &beta, y2.data(), incy );
computediff<T>( "y", N, y2.data(), zero_vec.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 0, 1, N, incx );
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, N, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), zero_vec.data(), incy);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
}
// zero alpha and non-zero/non-unit beta - scale y only
TYPED_TEST(hpmv_IIT_ERS, ZeroAlpha_OtherBeta)
{
using T = TypeParam;
gtint_t incx = 3;
gtint_t incy = 3;
T alpha, beta;
testinghelpers::initzero<T>( alpha );
beta = T{2.0};
double thresh = testinghelpers::getEpsilon<T>();
//----------------------------------------------------------
// Initialize matrices with random integer numbers.
//----------------------------------------------------------
dim_t len_a = ( N * ( N + 1 ) ) / 2;
std::vector<T> a = testinghelpers::get_random_vector<T>( 1, 5, len_a, 1 );
std::vector<T> x = testinghelpers::get_random_vector<T>( 0, 1, N, incx );
std::vector<T> y = testinghelpers::get_random_vector<T>( 0, 1, N, incy );
std::vector<T> y_ref(y);
std::vector<T> y2(y);
testinghelpers::ref_hpmv<T>( STORAGE, UPLO, N, &alpha, a.data(),
x.data(), incx, &beta, y_ref.data(), incy );
// Test with nullptr for all suitable arguments that shouldn't be accessed.
hpmv<T>( STORAGE, UPLO, N, &alpha, nullptr,
nullptr, incx, &beta, y2.data(), incy );
computediff<T>( "y", N, y2.data(), y_ref.data(), incy, thresh);
#ifdef CAN_TEST_INFO_VALUE
gtint_t info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
// Test with all arguments correct except for the value we are choosing to test.
//----------------------------------------------------------
// Call BLIS function
//----------------------------------------------------------
hpmv<T>( STORAGE, UPLO, N, &alpha, a.data(),
x.data(), incx, &beta, y.data(), incy );
//----------------------------------------------------------
// check component-wise error.
//----------------------------------------------------------
computediff<T>( "y", N, y.data(), y_ref.data(), incy, thresh);
#ifdef CAN_TEST_INFO_VALUE
info = bli_info_get_info_value();
computediff<gtint_t>( "info", info, 0 );
#endif
}
#endif