hetrf.hpp

Go to the documentation of this file.

 
//
// 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_HETRF_HH
#define TLAPACK_HETRF_HH
 
#include "tlapack/base/utils.hpp"
#include "tlapack/lapack/hetrf_blocked.hpp"
 
namespace tlapack {
 
enum class HetrfVariant : char {
    Blocked = 'B'  // blocked Bunch-Kaufman with diagonal pivoting
};
 
struct HetrfOpts : public BlockedLDLOpts {
    constexpr HetrfOpts(const EcOpts& opts = {}) : BlockedLDLOpts(opts){};
 
    HetrfVariant variant = HetrfVariant::Blocked;
};
 
template <TLAPACK_UPLO uplo_t,
          TLAPACK_MATRIX matrix_t,
          TLAPACK_VECTOR ipiv_t,
          TLAPACK_WORKSPACE work_t>
int hetrf_work(uplo_t uplo,
               matrix_t& A,
               ipiv_t& ipiv,
               work_t& work,
               const HetrfOpts& opts = {})
{
    // check arguments
    tlapack_check(uplo == Uplo::Lower || uplo == Uplo::Upper);
    tlapack_check(nrows(A) == ncols(A));
    tlapack_check(opts.invariant == Op::Trans ||
                  opts.invariant == Op::ConjTrans);
    tlapack_check(opts.variant == HetrfVariant::Blocked);
    // Call variant
    if (opts.variant == HetrfVariant::Blocked)
        return hetrf_blocked_work(uplo, A, ipiv, work, opts);
    else
        return 0;
}
 
template <TLAPACK_UPLO uplo_t, TLAPACK_MATRIX matrix_t, TLAPACK_VECTOR ipiv_t>
int hetrf(uplo_t uplo, matrix_t& A, ipiv_t& ipiv, const HetrfOpts& opts = {})
{
    // check arguments
    tlapack_check(uplo == Uplo::Lower || uplo == Uplo::Upper);
    tlapack_check(nrows(A) == ncols(A));
    tlapack_check(opts.invariant == Op::Trans ||
                  opts.invariant == Op::ConjTrans);
    tlapack_check(opts.variant == HetrfVariant::Blocked);
    // Call variant
    if (opts.variant == HetrfVariant::Blocked)
        return hetrf_blocked(uplo, A, ipiv, opts);
    else
        return 0;
}
 
}  // namespace tlapack
 
#endif  // TLAPACK_HETRF_HH