/* ************************************************************************ * Copyright (C) 2021-2026 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. * * * ************************************************************************ */ #pragma once #include "clientcommon.hpp" template void syevd_heevd_checkBadArgs(const hipsolverHandle_t handle, const hipsolverDnParams_t params, const hipsolverEigMode_t evect, const hipsolverFillMode_t uplo, const I n, Td dA, const I lda, Sd dD, Td dWork, const SIZE lwork, Td hWork, const SIZE lworkHost, U dinfo, const int bc) { // handle EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, nullptr, params, evect, uplo, n, dA, lda, dD, dWork, lwork, hWork, lworkHost, dinfo, bc), HIPSOLVER_STATUS_NOT_INITIALIZED); // values EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, handle, params, hipsolverEigMode_t(-1), uplo, n, dA, lda, dD, dWork, lwork, hWork, lworkHost, dinfo, bc), HIPSOLVER_STATUS_INVALID_ENUM); EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, handle, params, evect, hipsolverFillMode_t(-1), n, dA, lda, dD, dWork, lwork, hWork, lworkHost, dinfo, bc), HIPSOLVER_STATUS_INVALID_ENUM); #if defined(__HIP_PLATFORM_HCC__) || defined(__HIP_PLATFORM_AMD__) // pointers EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, handle, params, evect, uplo, n, (Td) nullptr, lda, dD, dWork, lwork, hWork, lworkHost, dinfo, bc), HIPSOLVER_STATUS_INVALID_VALUE); EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, handle, params, evect, uplo, n, dA, lda, (Sd) nullptr, dWork, lwork, hWork, lworkHost, dinfo, bc), HIPSOLVER_STATUS_INVALID_VALUE); EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, handle, params, evect, uplo, n, dA, lda, dD, dWork, lwork, hWork, lworkHost, (U) nullptr, bc), HIPSOLVER_STATUS_INVALID_VALUE); #endif // params (only for DnX / int64_t path) if constexpr(!std::is_same_v) EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, handle, (hipsolverDnParams_t) nullptr, evect, uplo, n, dA, lda, dD, dWork, lwork, hWork, lworkHost, dinfo, bc), HIPSOLVER_STATUS_INVALID_VALUE); } template void testing_syevd_heevd_bad_arg() { using S = decltype(std::real(T{})); // safe arguments hipsolver_local_handle handle; hipsolver_local_params params; hipsolverEigMode_t evect = HIPSOLVER_EIG_MODE_NOVECTOR; hipsolverFillMode_t uplo = HIPSOLVER_FILL_MODE_LOWER; I n = 1; I lda = 1; int bc = 1; if(BATCHED) { // // memory allocations // device_batch_vector dA(1, 1, 1); // device_strided_batch_vector dD(1, 1, 1, 1); // device_strided_batch_vector dinfo(1, 1, 1, 1); // CHECK_HIP_ERROR(dA.memcheck()); // CHECK_HIP_ERROR(dD.memcheck()); // CHECK_HIP_ERROR(dinfo.memcheck()); // SIZE size_dW, size_hW; // hipsolver_syevd_heevd_bufferSize( // API, handle, params, evect, uplo, n, dA.data(), lda, dD.data(), &size_dW, &size_hW); // host_strided_batch_vector hWork(size_hW, 1, size_hW, 1); // device_strided_batch_vector dWork(size_dW, 1, size_dW, 1); // if(size_dW) // CHECK_HIP_ERROR(dWork.memcheck()); // // check bad arguments // syevd_heevd_checkBadArgs(handle, // params, // evect, // uplo, // n, // dA.data(), // lda, // dD.data(), // dWork.data(), // size_dW, // hWork.data(), // size_hW, // dinfo.data(), // bc); } else { // memory allocations device_strided_batch_vector dA(1, 1, 1, 1); device_strided_batch_vector dD(1, 1, 1, 1); device_strided_batch_vector dinfo(1, 1, 1, 1); CHECK_HIP_ERROR(dA.memcheck()); CHECK_HIP_ERROR(dD.memcheck()); CHECK_HIP_ERROR(dinfo.memcheck()); SIZE size_dW, size_hW; hipsolver_syevd_heevd_bufferSize( API, handle, params, evect, uplo, n, dA.data(), lda, dD.data(), &size_dW, &size_hW); size_t bytes_dW; if constexpr(std::is_same_v) bytes_dW = std::getenv("HIPSOLVER_BUFFERSIZE_RETURN_BYTES") != nullptr ? size_dW : sizeof(T) * size_dW; else bytes_dW = size_dW; host_strided_batch_vector hWork(size_hW, 1, size_hW, 1); device_strided_batch_vector dWork(bytes_dW, 1, bytes_dW, 1); if(size_dW) CHECK_HIP_ERROR(dWork.memcheck()); // check bad arguments syevd_heevd_checkBadArgs(handle, params, evect, uplo, n, dA.data(), lda, dD.data(), dWork.data(), size_dW, hWork.data(), size_hW, dinfo.data(), bc); } } template void syevd_heevd_initData(const hipsolverHandle_t handle, const hipsolverEigMode_t evect, const I n, Td& dA, const I lda, const int bc, Th& hA, std::vector& A, bool test = true) { if(CPU) { rocblas_init(hA, true); // scale A to avoid singularities for(int b = 0; b < bc; ++b) { for(I i = 0; i < n; i++) { for(I j = 0; j < n; j++) { if(i == j) hA[b][i + j * lda] += 400; else hA[b][i + j * lda] -= 4; } } // make copy of original data to test vectors if required if(test && evect == HIPSOLVER_EIG_MODE_VECTOR) { for(I i = 0; i < n; i++) { for(I j = 0; j < n; j++) A[b * lda * n + i + j * lda] = hA[b][i + j * lda]; } } } } if(GPU) { // now copy to the GPU CHECK_HIP_ERROR(dA.transfer_from(hA)); } } template void syevd_heevd_getError(const hipsolverHandle_t handle, const hipsolverDnParams_t params, const hipsolverEigMode_t evect, const hipsolverFillMode_t uplo, const I n, Td& dA, const I lda, Sd& dD, Td& dWork, const SIZE lwork, Th& hWork, const SIZE lworkHost, Id& dinfo, const int bc, Th& hA, Th& hAres, Sh& hD, Sh& hDres, Ih& hinfo, Ih& hinfoRes, double* max_err) { constexpr bool COMPLEX = is_complex; using S = decltype(std::real(T{})); int sizeE, ltwork; if(!COMPLEX) { sizeE = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? 2 * n + 1 : 1 + 6 * n + 2 * n * n); ltwork = 0; } else { sizeE = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? n : 1 + 5 * n + 2 * n * n); ltwork = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? n + 1 : 2 * n + n * n); } int liwork = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? 1 : 3 + 5 * n); std::vector work(ltwork); std::vector hE(sizeE); std::vector iwork(liwork); std::vector A(int64_t(lda) * n * bc); // input data initialization syevd_heevd_initData(handle, evect, n, dA, lda, bc, hA, A); // execute computations // GPU lapack CHECK_ROCBLAS_ERROR(hipsolver_syevd_heevd(API, handle, params, evect, uplo, n, dA.data(), lda, dD.data(), dWork.data(), lwork, hWork.data(), lworkHost, dinfo.data(), bc)); CHECK_HIP_ERROR(hDres.transfer_from(dD)); CHECK_HIP_ERROR(hinfoRes.transfer_from(dinfo)); if(evect == HIPSOLVER_EIG_MODE_VECTOR) CHECK_HIP_ERROR(hAres.transfer_from(dA)); // CPU lapack for(int b = 0; b < bc; ++b) cpu_syevd_heevd(evect, uplo, n, hA[b], lda, hD[b], work.data(), ltwork, hE.data(), sizeE, iwork.data(), liwork, hinfo[b]); // Check info for non-convergence *max_err = 0; for(int b = 0; b < bc; ++b) { EXPECT_EQ(hinfo[b][0], hinfoRes[b][0]) << "where b = " << b; if(hinfo[b][0] != hinfoRes[b][0]) *max_err += 1; } // (We expect the used input matrices to always converge. Testing // implicitly the equivalent non-converged matrix is very complicated and it boils // down to essentially run the algorithm again and until convergence is achieved). double err = 0; for(int b = 0; b < bc; ++b) { if(evect != HIPSOLVER_EIG_MODE_VECTOR) { // only eigenvalues needed; can compare with LAPACK // error is ||hD - hDRes|| / ||hD|| // using frobenius norm if(hinfo[b][0] == 0) err = norm_error('F', 1, n, 1, hD[b], hDres[b]); *max_err = err > *max_err ? err : *max_err; } else { // both eigenvalues and eigenvectors needed; need to implicitly test // eigenvectors due to non-uniqueness of eigenvectors under scaling if(hinfo[b][0] == 0) { // multiply A with each of the n eigenvectors and divide by corresponding // eigenvalues T alpha; T beta = 0; for(I j = 0; j < n; j++) { alpha = T(1) / hDres[b][j]; cpu_symv_hemv(uplo, n, alpha, A.data() + b * lda * n, lda, hAres[b] + j * lda, 1, beta, hA[b] + j * lda, 1); } // error is ||hA - hARes|| / ||hA|| // using frobenius norm err = norm_error('F', n, n, lda, hA[b], hAres[b]); *max_err = err > *max_err ? err : *max_err; } } } } template void syevd_heevd_getPerfData(const hipsolverHandle_t handle, const hipsolverDnParams_t params, const hipsolverEigMode_t evect, const hipsolverFillMode_t uplo, const I n, Td& dA, const I lda, Sd& dD, Td& dWork, const SIZE lwork, Th& hWork, const SIZE lworkHost, Id& dinfo, const int bc, Th& hA, Sh& hD, Ih& hinfo, double* gpu_time_used, double* cpu_time_used, const int hot_calls, const bool perf) { constexpr bool COMPLEX = is_complex; using S = decltype(std::real(T{})); int sizeE, ltwork; if(!COMPLEX) { sizeE = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? 2 * n + 1 : 1 + 6 * n + 2 * n * n); ltwork = 0; } else { sizeE = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? n : 1 + 5 * n + 2 * n * n); ltwork = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? n + 1 : 2 * n + n * n); } int liwork = (evect == HIPSOLVER_EIG_MODE_NOVECTOR ? 1 : 3 + 5 * n); std::vector work(ltwork); std::vector hE(sizeE); std::vector iwork(liwork); std::vector A; if(!perf) { syevd_heevd_initData(handle, evect, n, dA, lda, bc, hA, A, 0); // cpu-lapack performance (only if not in perf mode) *cpu_time_used = get_time_us_no_sync(); for(int b = 0; b < bc; ++b) cpu_syevd_heevd(evect, uplo, n, hA[b], lda, hD[b], work.data(), ltwork, hE.data(), sizeE, iwork.data(), liwork, hinfo[b]); *cpu_time_used = get_time_us_no_sync() - *cpu_time_used; } syevd_heevd_initData(handle, evect, n, dA, lda, bc, hA, A, 0); // cold calls for(int iter = 0; iter < 2; iter++) { syevd_heevd_initData(handle, evect, n, dA, lda, bc, hA, A, 0); CHECK_ROCBLAS_ERROR(hipsolver_syevd_heevd(API, handle, params, evect, uplo, n, dA.data(), lda, dD.data(), dWork.data(), lwork, hWork.data(), lworkHost, dinfo.data(), bc)); } // gpu-lapack performance hipStream_t stream; CHECK_ROCBLAS_ERROR(hipsolverGetStream(handle, &stream)); double start; for(int iter = 0; iter < hot_calls; iter++) { syevd_heevd_initData(handle, evect, n, dA, lda, bc, hA, A, 0); start = get_time_us_sync(stream); hipsolver_syevd_heevd(API, handle, params, evect, uplo, n, dA.data(), lda, dD.data(), dWork.data(), lwork, hWork.data(), lworkHost, dinfo.data(), bc); *gpu_time_used += get_time_us_sync(stream) - start; } *gpu_time_used /= hot_calls; } template void testing_syevd_heevd(Arguments& argus) { using S = decltype(std::real(T{})); // get arguments hipsolver_local_handle handle; hipsolver_local_params params; char evectC = argus.get("jobz"); char uploC = argus.get("uplo"); I n = argus.get("n"); I lda = argus.get("lda", n); hipsolverEigMode_t evect = char2hipsolver_evect(evectC); hipsolverFillMode_t uplo = char2hipsolver_fill(uploC); int bc = argus.batch_count; int hot_calls = argus.iters; // determine sizes size_t size_A = size_t(lda) * n; size_t size_D = n; size_t size_Ares = (argus.unit_check || argus.norm_check) ? size_A : 0; size_t size_Dres = (argus.unit_check || argus.norm_check) ? size_D : 0; double max_error = 0, gpu_time_used = 0, cpu_time_used = 0; // check invalid sizes bool invalid_size = (n < 0 || lda < n || bc < 0); if(invalid_size) { if(BATCHED) { // EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, // handle, // params, // evect, // uplo, // n, // (T* const*)nullptr, // lda, // (S*)nullptr, // (T*)nullptr, // (SIZE)0, // (T*)nullptr, // (SIZE)0, // (int*)nullptr, // bc), // HIPSOLVER_STATUS_INVALID_VALUE); } else { EXPECT_ROCBLAS_STATUS(hipsolver_syevd_heevd(API, handle, params, evect, uplo, n, (T*)nullptr, lda, (S*)nullptr, (T*)nullptr, (SIZE)0, (T*)nullptr, (SIZE)0, (int*)nullptr, bc), HIPSOLVER_STATUS_INVALID_VALUE); } if(argus.timing) rocsolver_bench_inform(inform_invalid_size); return; } // memory size query is necessary SIZE size_dW, size_hW; hipsolver_syevd_heevd_bufferSize( API, handle, params, evect, uplo, n, (T*)nullptr, lda, (S*)nullptr, &size_dW, &size_hW); size_t bytes_dW; if constexpr(std::is_same_v) bytes_dW = std::getenv("HIPSOLVER_BUFFERSIZE_RETURN_BYTES") != nullptr ? size_dW : sizeof(T) * size_dW; else bytes_dW = size_dW; if(argus.mem_query) { rocsolver_bench_inform(inform_mem_query, bytes_dW); return; } // memory allocations (all cases) // host host_strided_batch_vector hD(size_D, 1, size_D, bc); host_strided_batch_vector hinfo(1, 1, 1, bc); host_strided_batch_vector hinfoRes(1, 1, 1, bc); host_strided_batch_vector hDres(size_Dres, 1, size_D, bc); host_strided_batch_vector hWork(size_hW, 1, size_hW, 1); // device device_strided_batch_vector dD(size_D, 1, size_D, bc); device_strided_batch_vector dinfo(1, 1, 1, bc); device_strided_batch_vector dWork(bytes_dW, 1, bytes_dW, 1); // bytes_dW accounts for bc if(size_D) CHECK_HIP_ERROR(dD.memcheck()); CHECK_HIP_ERROR(dinfo.memcheck()); if(size_dW) CHECK_HIP_ERROR(dWork.memcheck()); if(BATCHED) { // // memory allocations // host_batch_vector hA(size_A, 1, bc); // host_batch_vector hAres(size_Ares, 1, bc); // device_batch_vector dA(size_A, 1, bc); // if(size_A) // CHECK_HIP_ERROR(dA.memcheck()); // // check computations // if(argus.unit_check || argus.norm_check) // { // syevd_heevd_getError(handle, // params, // evect, // uplo, // n, // dA, // lda, // dD, // dWork, // size_dW, // hWork, // size_hW, // dinfo, // bc, // hA, // hAres, // hD, // hDres, // hinfo, // hinfoRes, // &max_error); // } // // collect performance data // if(argus.timing) // { // syevd_heevd_getPerfData(handle, // params, // evect, // uplo, // n, // dA, // lda, // dD, // dWork, // size_dW, // hWork, // size_hW, // dinfo, // bc, // hA, // hD, // hinfo, // &gpu_time_used, // &cpu_time_used, // hot_calls, // argus.perf); // } } else { // memory allocations host_strided_batch_vector hA(size_A, 1, size_A, bc); host_strided_batch_vector hAres(size_Ares, 1, size_A, bc); device_strided_batch_vector dA(size_A, 1, size_A, bc); if(size_A) CHECK_HIP_ERROR(dA.memcheck()); // check computations if(argus.unit_check || argus.norm_check) { syevd_heevd_getError(handle, params, evect, uplo, n, dA, lda, dD, dWork, size_dW, hWork, size_hW, dinfo, bc, hA, hAres, hD, hDres, hinfo, hinfoRes, &max_error); } // collect performance data if(argus.timing) { syevd_heevd_getPerfData(handle, params, evect, uplo, n, dA, lda, dD, dWork, size_dW, hWork, size_hW, dinfo, bc, hA, hD, hinfo, &gpu_time_used, &cpu_time_used, hot_calls, argus.perf); } } // validate results for rocsolver-test // using n * machine_precision as tolerance if(argus.unit_check) ROCSOLVER_TEST_CHECK(T, max_error, n); // output results for rocsolver-bench if(argus.timing) { if(!argus.perf) { std::cerr << "\n============================================\n"; std::cerr << "Arguments:\n"; std::cerr << "============================================\n"; if(BATCHED) { rocsolver_bench_output("jobz", "uplo", "n", "lda", "batch_c"); rocsolver_bench_output(evectC, uploC, n, lda, bc); } else { rocsolver_bench_output("jobz", "uplo", "n", "lda"); rocsolver_bench_output(evectC, uploC, n, lda); } std::cerr << "\n============================================\n"; std::cerr << "Results:\n"; std::cerr << "============================================\n"; if(argus.norm_check) { rocsolver_bench_output("cpu_time", "gpu_time", "error"); rocsolver_bench_output(cpu_time_used, gpu_time_used, max_error); } else { rocsolver_bench_output("cpu_time", "gpu_time"); rocsolver_bench_output(cpu_time_used, gpu_time_used); } std::cerr << std::endl; } else { if(argus.norm_check) rocsolver_bench_output(gpu_time_used, max_error); else rocsolver_bench_output(gpu_time_used); } } // ensure all arguments were consumed argus.validate_consumed(); }