herk.hpp

Go to the documentation of this file.

 
//
// Copyright (c) 2017-2021, University of Tennessee. All rights reserved.
// Copyright (c) 2021-2023, 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_LEGACY_HERK_HH
#define TLAPACK_LEGACY_HERK_HH
 
#include "tlapack/blas/herk.hpp"
#include "tlapack/legacy_api/base/types.hpp"
#include "tlapack/legacy_api/base/utils.hpp"
 
namespace tlapack {
namespace legacy {
 
    template <typename TA, typename TC>
    void herk(Layout layout,
              Uplo uplo,
              Op trans,
              idx_t n,
              idx_t k,
              real_type<TA, TC> alpha,  // note: real
              TA const* A,
              idx_t lda,
              real_type<TA, TC> beta,  // note: real
              TC* C,
              idx_t ldc)
    {
        using internal::create_matrix;
        using real_t = real_type<TA, TC>;
 
        // check arguments
        tlapack_check_false(layout != Layout::ColMajor &&
                            layout != Layout::RowMajor);
        tlapack_check_false(uplo != Uplo::Lower && uplo != Uplo::Upper &&
                            uplo != Uplo::General);
        tlapack_check_false(trans != Op::NoTrans && trans != Op::Trans &&
                            trans != Op::ConjTrans);
        tlapack_check_false(is_complex<TA> && trans == Op::Trans);
        tlapack_check_false(n < 0);
        tlapack_check_false(k < 0);
        tlapack_check_false(lda < ((layout == Layout::RowMajor)
                                       ? ((trans == Op::NoTrans) ? k : n)
                                       : ((trans == Op::NoTrans) ? n : k)));
        tlapack_check_false(ldc < n);
 
        // quick return
        if (n == 0 || ((alpha == real_t(0) || k == 0) && (beta == real_t(1))))
            return;
 
        // This algorithm only works with Op::NoTrans or Op::ConjTrans
        if (trans == Op::Trans) trans = Op::ConjTrans;
 
        // adapt if row major
        if (layout == Layout::RowMajor) {
            if (uplo == Uplo::Lower)
                uplo = Uplo::Upper;
            else if (uplo == Uplo::Upper)
                uplo = Uplo::Lower;
            trans = (trans == Op::NoTrans) ? Op::ConjTrans : Op::NoTrans;
            alpha = conj(alpha);
        }
 
        // Matrix views
        const auto A_ = (trans == Op::NoTrans)
                            ? create_matrix<TA>((TA*)A, n, k, lda)
                            : create_matrix<TA>((TA*)A, k, n, lda);
        auto C_ = create_matrix<TC>(C, n, n, ldc);
 
        if (alpha == real_t(0)) {
            if (beta == real_t(0)) {
                for (idx_t j = 0; j < n; ++j)
                    for (idx_t i = 0; i < n; ++i)
                        C_(i, j) = TC(0);
            }
            else {
                for (idx_t j = 0; j < n; ++j)
                    for (idx_t i = 0; i < n; ++i)
                        C_(i, j) *= beta;
            }
        }
        else {
            if (beta == real_t(0))
                herk(uplo, trans, alpha, A_, C_);
            else
                herk(uplo, trans, alpha, A_, beta, C_);
        }
    }
 
}  // namespace legacy
}  // namespace tlapack
 
#endif  //  #ifndef TLAPACK_LEGACY_HERK_HH