cblas_api.cpp

Go to the documentation of this file.

/*
 *  SPDX-FileCopyrightText: Copyright 2021, Siavash Ameli <sameli@berkeley.edu>
 *  SPDX-License-Identifier: BSD-3-Clause
 *  SPDX-FileType: SOURCE
 *
 *  This program is free software: you can redistribute it and/or modify it
 *  under the terms of the license found in the LICENSE.txt file in the root
 *  directory of this source tree.
 */
 
 
// =======
// Headers
// =======
 
#include "./cblas_api.h"
 
# if defined(USE_ANY_CBLAS) && (USE_ANY_CBLAS == 1)
 
#include <cstdlib>  // abort
#include <iostream>  // std::cerr
 
 
// ===============
// cblas interface
// ===============
 
 
namespace cblas_api
{
 
    // =====
    // xgemv (float)
    // =====
 
 
    template<>
    void xgemv<float>(
            const CBLAS_LAYOUT layout,
            const CBLAS_TRANSPOSE TransA,
            const int M,
            const int N,
            const float alpha,
            const float* RESTRICT A,
            const int lda,
            const float* RESTRICT X,
            const int incX,
            const float beta,
            float* RESTRICT Y,
            const int incY)
    {
        cblas_sgemv(layout, TransA, M, N, alpha, A, lda, X, incX, beta, Y,
                    incY);
    }
 
 
    // =====
    // xgemv (double)
    // =====
 
 
    template<>
    void xgemv<double>(
            const CBLAS_LAYOUT layout,
            const CBLAS_TRANSPOSE TransA,
            const int M,
            const int N,
            const double alpha,
            const double* RESTRICT A,
            const int lda,
            const double* RESTRICT X,
            const int incX,
            const double beta,
            double* RESTRICT Y,
            const int incY)
    {
        cblas_dgemv(layout, TransA, M, N, alpha, A, lda, X, incX, beta, Y,
                    incY);
    }
 
 
    // =====
    // xgemv (long double)
    // =====
 
 
    template<>
    void xgemv<long double>(
            const CBLAS_LAYOUT layout,
            const CBLAS_TRANSPOSE TransA,
            const int M,
            const int N,
            const long double alpha,
            const long double* RESTRICT A,
            const int lda,
            const long double* RESTRICT X,
            const int incX,
            const long double beta,
            long double* RESTRICT Y,
            const int incY)
    {
        // Mark unused variables to avoid compiler warnings
        // (-Wno-unused-parameter)
        (void) layout;
        (void) TransA;
        (void) M;
        (void) N;
        (void) alpha;
        (void) A;
        (void) lda;
        (void) X;
        (void) incX;
        (void) beta;
        (void) Y;
        (void) incY;
 
        std::cerr << "Error: cblas_?gemv for long double type is not "
                  << "implemented. To use long double type, set USE_CBLAS "
                  << "and USE_MKL to 0 and recompile the package."
                  << std::endl;
        abort();
    }
 
 
    // =====
    // xsymv (float)
    // =====
 
 
    template<>
    void xsymv<float>(
            const CBLAS_LAYOUT layout,
            const CBLAS_UPLO Uplo,
            const int N,
            const float alpha,
            const float* RESTRICT A,
            const int lda,
            const float* RESTRICT X,
            const int incX,
            const float beta,
            float* RESTRICT Y,
            const int incY)
    {
        cblas_ssymv(layout, Uplo, N, alpha, A, lda, X, incX, beta, Y, incY);
    }
 
 
    // =====
    // xsymv (double)
    // =====
 
 
    template<>
    void xsymv<double>(
            const CBLAS_LAYOUT layout,
            const CBLAS_UPLO Uplo,
            const int N,
            const double alpha,
            const double* RESTRICT A,
            const int lda,
            const double* RESTRICT X,
            const int incX,
            const double beta,
            double* RESTRICT Y,
            const int incY)
    {
        cblas_dsymv(layout, Uplo, N, alpha, A, lda, X, incX, beta, Y, incY);
    }
 
 
    // =====
    // xsymv (long double)
    // =====
 
 
    template<>
    void xsymv<long double>(
            const CBLAS_LAYOUT layout,
            const CBLAS_UPLO Uplo,
            const int N,
            const long double alpha,
            const long double* RESTRICT A,
            const int lda,
            const long double* RESTRICT X,
            const int incX,
            const long double beta,
            long double* RESTRICT Y,
            const int incY)
    {
        // Mark unused variables to avoid compiler warnings
        // (-Wno-unused-parameter)
        (void) layout;
        (void) Uplo;
        (void) N;
        (void) alpha;
        (void) A;
        (void) lda;
        (void) X;
        (void) incX;
        (void) beta;
        (void) Y;
        (void) incY;
 
        std::cerr << "Error: cblas_?symv for long double type is not "
                  << "implemented. To use long double type, set USE_CBLAS "
                  << "and USE_MKL to 0 and recompile the package."
                  << std::endl;
        abort();
    }
 
 
    // =====
    // xcopy (float)
    // =====
 
 
    template <>
    void xcopy<float>(
            const int N,
            const float* RESTRICT X,
            const int incX,
            float* RESTRICT Y,
            const int incY)
    {
        cblas_scopy(N, X, incX, Y, incY);
    }
 
 
    // =====
    // xcopy (double)
    // =====
 
 
    template <>
    void xcopy<double>(
            const int N,
            const double* RESTRICT X,
            const int incX,
            double* RESTRICT Y,
            const int incY)
    {
        cblas_dcopy(N, X, incX, Y, incY);
    }
 
 
    // =====
    // xcopy (long double)
    // =====
 
 
    template <>
    void xcopy<long double>(
            const int N,
            const long double* RESTRICT X,
            const int incX,
            long double* RESTRICT Y,
            const int incY)
    {
        // Mark unused variables to avoid compiler warnings
        // (-Wno-unused-parameter)
        (void) N;
        (void) X;
        (void) incX;
        (void) Y;
        (void) incY;
 
        std::cerr << "Error: cblas_?copy for long double type is not "
                  << "implemented. To use long double type, set USE_CBLAS "
                  << "and USE_MKL to 0 and recompile the package."
                  << std::endl;
        abort();
    }
 
 
    // =====
    // xaxpy (float)
    // =====
 
 
    template <>
    void xaxpy<float>(
            const int N,
            const float alpha,
            const float* RESTRICT X,
            const int incX,
            float* RESTRICT Y,
            const int incY)
    {
        cblas_saxpy(N, alpha, X, incX, Y, incY);
    }
 
 
    // =====
    // xaxpy (double)
    // =====
 
 
    template <>
    void xaxpy<double>(
            const int N,
            const double alpha,
            const double* RESTRICT X,
            const int incX,
            double* RESTRICT Y,
            const int incY)
    {
        cblas_daxpy(N, alpha, X, incX, Y, incY);
    }
 
 
    // =====
    // xaxpy (long double)
    // =====
 
 
    template <>
    void xaxpy<long double>(
            const int N,
            const long double alpha,
            const long double* RESTRICT X,
            const int incX,
            long double* RESTRICT Y,
            const int incY)
    {
        // Mark unused variables to avoid compiler warnings
        // (-Wno-unused-parameter)
        (void) N;
        (void) alpha;
        (void) X;
        (void) incX;
        (void) Y;
        (void) incY;
 
        std::cerr << "Error: cblas_?axpy for long double type is not "
                  << "implemented. To use long double type, set USE_CBLAS "
                  << "and USE_MKL to 0 and recompile the package."
                  << std::endl;
        abort();
    }
 
 
    // ====
    // xdot (float)
    // ====
 
 
    template <>
    float xdot<float>(
            const int N,
            const float* RESTRICT X,
            const int incX,
            const float* RESTRICT Y,
            const int incY)
    {
        return cblas_sdot(N, X, incX, Y, incY);
    }
 
 
    // ====
    // xdot (double)
    // ====
 
 
    template <>
    double xdot<double>(
            const int N,
            const double* RESTRICT X,
            const int incX,
            const double* RESTRICT Y,
            const int incY)
    {
        return cblas_ddot(N, X, incX, Y, incY);
    }
 
 
    // ====
    // xdot (long double)
    // ====
 
 
    template <>
    long double xdot<long double>(
            const int N,
            const long double* RESTRICT X,
            const int incX,
            const long double* RESTRICT Y,
            const int incY)
    {
        // Mark unused variables to avoid compiler warnings
        // (-Wno-unused-parameter)
        (void) N;
        (void) X;
        (void) incX;
        (void) Y;
        (void) incY;
 
        std::cerr << "Error: cblas_?dot for long double type is not "
                  << "implemented. To use long double type, set USE_CBLAS "
                  << "and USE_MKL to 0 and recompile the package."
                  << std::endl;
        abort();
    }
 
 
    // =====
    // xnrm2 (float)
    // =====
 
 
    template <>
    float xnrm2<float>(
            const int N,
            const float* RESTRICT X,
            const int incX)
    {
        return cblas_snrm2(N, X, incX);
    }
 
 
    // =====
    // xnrm2 (double)
    // =====
 
 
    template <>
    double xnrm2<double>(
            const int N,
            const double* RESTRICT X,
            const int incX)
    {
        return cblas_dnrm2(N, X, incX);
    }
 
 
    // =====
    // xnrm2 (long double)
    // =====
 
 
    template <>
    long double xnrm2<long double>(
            const int N,
            const long double* RESTRICT X,
            const int incX)
    {
        // Mark unused variables to avoid compiler warnings
        // (-Wno-unused-parameter)
        (void) N;
        (void) X;
        (void) incX;
 
        std::cerr << "Error: cblas_?nrm2 for long double type is not "
                  << "implemented. To use long double type, set USE_CBLAS "
                  << "i and USE_MKL to 0 and recompile the package."
                  << std::endl;
        abort();
    }
 
 
    // =====
    // xscal (float)
    // =====
 
 
    template <>
    void xscal<float>(
            const int N,
            const float alpha,
            float* RESTRICT X,
            const int incX)
    {
        cblas_sscal(N, alpha, X, incX);
    }
 
 
    // =====
    // xscal (double)
    // =====
 
 
    template <>
    void xscal<double>(
            const int N,
            const double alpha,
            double* RESTRICT X,
            const int incX)
    {
        cblas_dscal(N, alpha, X, incX);
    }
 
 
    // =====
    // xscal (long double)
    // =====
 
 
    template <>
    void xscal<long double>(
            const int N,
            const long double alpha,
            long double* RESTRICT X,
            const int incX)
    {
        // Mark unused variables to avoid compiler warnings
        // (-Wno-unused-parameter)
        (void) N;
        (void) alpha;
        (void) X;
        (void) incX;
 
        std::cerr << "Error: cblas_?scal for long double type is not "
                  << "implemented. To use long double type, set USE_CBLAS "
                  << "and USE_MKL to 0 and recompile the package."
                  << std::endl;
        abort();
    }
}  // namespace cblas_api
 
#endif  // USE_ANY_CBLAS