householder_ql.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_HOUSEHOLDER_QL_HH
#define TLAPACK_HOUSEHOLDER_QL_HH
 
#include "tlapack/base/utils.hpp"
#include "tlapack/lapack/geql2.hpp"
#include "tlapack/lapack/geqlf.hpp"
 
namespace tlapack {
 
enum class HouseholderQLVariant : char { Level2 = '2', Blocked = 'B' };
 
struct HouseholderQLOpts : public GeqlfOpts {
    HouseholderQLVariant variant = HouseholderQLVariant::Blocked;
};
 
template <class T, TLAPACK_MATRIX matrix_t, TLAPACK_VECTOR vector_t>
constexpr WorkInfo householder_ql_worksize(const matrix_t& A,
                                           const vector_t& tau,
                                           const HouseholderQLOpts& opts = {})
{
    // Call variant
    if (opts.variant == HouseholderQLVariant::Level2)
        return geql2_worksize<T>(A, tau);
    else
        return geqlf_worksize<T>(A, tau, opts);
}
 
template <TLAPACK_MATRIX matrix_t,
          TLAPACK_VECTOR vector_t,
          TLAPACK_WORKSPACE work_t>
int householder_ql_work(matrix_t& A,
                        vector_t& tau,
                        work_t& work,
                        const HouseholderQLOpts& opts = {})
{
    // Call variant
    if (opts.variant == HouseholderQLVariant::Level2)
        return geql2_work(A, tau, work);
    else
        return geqlf_work(A, tau, work, opts);
}
 
template <TLAPACK_MATRIX matrix_t, TLAPACK_VECTOR vector_t>
int householder_ql(matrix_t& A,
                   vector_t& tau,
                   const HouseholderQLOpts& opts = {})
{
    // Call variant
    if (opts.variant == HouseholderQLVariant::Level2)
        return geql2(A, tau);
    else
        return geqlf(A, tau, opts);
}
 
}  // namespace tlapack
 
#endif  // TLAPACK_HOUSEHOLDER_QL_HH