potrf.hpp

Go to the documentation of this file.

 
//
// 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_POTRF_HH
#define TLAPACK_POTRF_HH
 
#include "tlapack/base/utils.hpp"
#include "tlapack/lapack/potf2.hpp"
#include "tlapack/lapack/potrf2.hpp"
#include "tlapack/lapack/potrf_blocked.hpp"
#include "tlapack/lapack/potrf_blocked_right_looking.hpp"
 
namespace tlapack {
 
enum class PotrfVariant : char {
    Blocked = 'B',
    Recursive = 'R',
    Level2 = '2',
    RightLooking
};
 
struct PotrfOpts : public BlockedCholeskyOpts {
    constexpr PotrfOpts(const EcOpts& opts = {}) : BlockedCholeskyOpts(opts){};
 
    PotrfVariant variant = PotrfVariant::Blocked;
};
 
template <TLAPACK_UPLO uplo_t, TLAPACK_MATRIX matrix_t>
int potrf(uplo_t uplo, matrix_t& A, const PotrfOpts& opts = {})
{
    // check arguments
    tlapack_check(uplo == Uplo::Lower || uplo == Uplo::Upper);
    tlapack_check(nrows(A) == ncols(A));
    tlapack_check(opts.variant == PotrfVariant::Blocked ||
                  opts.variant == PotrfVariant::Recursive ||
                  opts.variant == PotrfVariant::Level2 ||
                  opts.variant == PotrfVariant::RightLooking);
 
    // Call variant
    if (opts.variant == PotrfVariant::Blocked)
        return potrf_blocked(uplo, A, opts);
    else if (opts.variant == PotrfVariant::Recursive)
        return potrf2(uplo, A, opts);
    else if (opts.variant == PotrfVariant::Level2)
        return potf2(uplo, A);
    else
        return potrf_rl(uplo, A, opts);
}
 
}  // namespace tlapack
 
#endif  // TLAPACK_POTRF_HH