her.hpp

Go to the documentation of this file.

 
//
// Copyright (c) 2017-2021, University of Tennessee. All rights reserved.
// Copyright (c) 2025, University of Colorado Denver. All rights reserved.
//
// This file is part of <T>LAPACK.
// <T>LAPACK is free software: you can redistribute it and/or modify it under
// the terms of the BSD 3-Clause license. See the accompanying LICENSE file.
 
#ifndef TLAPACK_BLAS_HER_HH
#define TLAPACK_BLAS_HER_HH
 
#include "tlapack/base/utils.hpp"
 
namespace tlapack {
 
template <TLAPACK_MATRIX matrixA_t,
          TLAPACK_VECTOR vectorX_t,
          TLAPACK_REAL alpha_t,
          enable_if_t<(
                          /* Requires: */
                          is_real<alpha_t>),
                      int> = 0,
          class T = type_t<matrixA_t>,
          disable_if_allow_optblas_t<pair<alpha_t, real_type<T> >,
                                     pair<matrixA_t, T>,
                                     pair<vectorX_t, T> > = 0>
void her(Uplo uplo, const alpha_t& alpha, const vectorX_t& x, matrixA_t& A)
{
    // data traits
    using idx_t = size_type<matrixA_t>;
    using scalar_t = scalar_type<alpha_t, type_t<vectorX_t> >;
 
    // constants
    const idx_t n = nrows(A);
 
    // check arguments
    tlapack_check_false(uplo != Uplo::Lower && uplo != Uplo::Upper);
    tlapack_check_false(size(x) != n);
    tlapack_check_false(ncols(A) != n);
 
    if (uplo == Uplo::Upper) {
        for (idx_t j = 0; j < n; ++j) {
            const scalar_t tmp = alpha * conj(x[j]);
            for (idx_t i = 0; i < j; ++i)
                A(i, j) += x[i] * tmp;
            A(j, j) =
                real(A(j, j)) + real(x[j]) * real(tmp) - imag(x[j]) * imag(tmp);
        }
    }
    else {
        for (idx_t j = 0; j < n; ++j) {
            const scalar_t tmp = alpha * conj(x[j]);
            A(j, j) =
                real(A(j, j)) + real(x[j]) * real(tmp) - imag(x[j]) * imag(tmp);
            for (idx_t i = j + 1; i < n; ++i)
                A(i, j) += x[i] * tmp;
        }
    }
}
 
#ifdef TLAPACK_USE_LAPACKPP
 
template <TLAPACK_LEGACY_MATRIX matrixA_t,
          TLAPACK_LEGACY_VECTOR vectorX_t,
          TLAPACK_REAL alpha_t,
          class T = type_t<matrixA_t>,
          enable_if_allow_optblas_t<pair<alpha_t, real_type<T> >,
                                    pair<matrixA_t, T>,
                                    pair<vectorX_t, T> > = 0>
void her(Uplo uplo, const alpha_t alpha, const vectorX_t& x, matrixA_t& A)
{
    // Legacy objects
    auto A_ = legacy_matrix(A);
    auto x_ = legacy_vector(x);
 
    // Constants to forward
    constexpr Layout L = layout<matrixA_t>;
    const auto& n = A_.n;
 
    return ::blas::her((::blas::Layout)L, (::blas::Uplo)uplo, n, alpha, x_.ptr,
                       x_.inc, A_.ptr, A_.ldim);
}
 
#endif
 
}  // namespace tlapack
 
#endif  //  #ifndef TLAPACK_BLAS_HER_HH