ggev.hpp

Go to the documentation of this file.

// Copyright (c) 2024--present, The Simons Foundation
// This file is part of TRIQS/nda and is licensed under the Apache License, Version 2.0.
// SPDX-License-Identifier: Apache-2.0
// See LICENSE in the root of this distribution for details.

 
#pragma once
 
#include "./interface/cxx_interface.hpp"
#include "../basic_array.hpp"
#include "../basic_functions.hpp"
#include "../blas/tools.hpp"
#include "../concepts.hpp"
#include "../declarations.hpp"
#include "../macros.hpp"
#include "../mem/address_space.hpp"
#include "../traits.hpp"
 
#include <cmath>
#include <complex>
#include <concepts>
 
namespace nda::lapack {

  template <BlasArrayReal<2> A, BlasArrayFor<A, 2> B, BlasArrayFor<A, 1> AR, BlasArrayFor<A, 1> AI, BlasArrayFor<A, 1> B2, BlasArrayFor<A, 2> VL,
            BlasArrayFor<A, 2> VR, BlasArrayFor<A, 1> W1 = vector_value_t<A>>
    requires(mem::have_host_compatible_addr_space<A> and has_F_layout<A, B, VL, VR>)
  int ggev(A &&a, B &&b, AR &&alphar, AI &&alphai, B2 &&beta, VL &&vl, VR &&vr, char jobvl = 'N', char jobvr = 'V', // NOLINT
           W1 &&work = vector_value_t<A>{}) {                                                                       // NOLINT
    // check the dimensions of the input/output arrays/views
    auto const [m, n] = a.shape();
    EXPECTS(m == n);
    EXPECTS(b.shape() == a.shape());
    resize_or_check_if_view(alphar, {n});
    resize_or_check_if_view(alphai, {n});
    resize_or_check_if_view(beta, {n});
 
    // check other input parameters for consistency
    EXPECTS(jobvl == 'V' or jobvl == 'N');
    EXPECTS(jobvr == 'V' or jobvr == 'N');
 
    // resize eigenvector matrices if needed
    int ldvl = 1;
    int ldvr = 1;
    if (jobvl == 'V') {
      resize_or_check_if_view(vl, {n, n});
      ldvl = get_ld(vl);
    }
    if (jobvr == 'V') {
      resize_or_check_if_view(vr, {n, n});
      ldvr = get_ld(vr);
    }
 
    // arrays/views must be LAPACK compatible
    EXPECTS(a.indexmap().min_stride() == 1);
    EXPECTS(b.indexmap().min_stride() == 1);
    EXPECTS(alphar.indexmap().min_stride() == 1);
    EXPECTS(alphai.indexmap().min_stride() == 1);
    EXPECTS(beta.indexmap().min_stride() == 1);
    EXPECTS(jobvl == 'N' or vl.indexmap().min_stride() == 1);
    EXPECTS(jobvr == 'N' or vr.indexmap().min_stride() == 1);
 
    // first call to get the optimal buffer size
    auto tmp_lwork = get_value_t<A>{};
    int info       = 0;
    lapack::f77::ggev(jobvl, jobvr, n, a.data(), get_ld(a), b.data(), get_ld(b), alphar.data(), alphai.data(), beta.data(), vl.data(), ldvl,
                      vr.data(), ldvr, &tmp_lwork, -1, info);
    int lwork = static_cast<int>(std::ceil(tmp_lwork));
 
    // resize/check work buffer
    resize_or_check_work_buffer(work, lwork);
 
    // perform actual library call
    lapack::f77::ggev(jobvl, jobvr, n, a.data(), get_ld(a), b.data(), get_ld(b), alphar.data(), alphai.data(), beta.data(), vl.data(), ldvl,
                      vr.data(), ldvr, work.data(), lwork, info);
 
    return info;
  }

  template <BlasArrayCplx<2> A, BlasArrayFor<A, 2> B, BlasArrayFor<A, 1> A2, BlasArrayFor<A, 1> B2, BlasArrayFor<A, 2> VL, BlasArrayFor<A, 2> VR,
            BlasArrayFor<A, 1> W1 = vector_value_t<A>, BlasArrayRealFor<A, 1> W2 = vector_fp_t<A>>
    requires(mem::have_host_compatible_addr_space<A> and has_F_layout<A, B, VL, VR>)
  int ggev(A &&a, B &&b, A2 &&alpha, B2 &&beta, VL &&vl, VR &&vr, char jobvl = 'N', char jobvr = 'V', // NOLINT
           W1 &&work = vector_value_t<A>{}, W2 &&rwork = vector_fp_t<A>{}) {                          // NOLINT
    // check the dimensions of the input/output arrays/views
    auto const [m, n] = a.shape();
    EXPECTS(m == n);
    EXPECTS(b.shape() == a.shape());
    resize_or_check_if_view(alpha, {n});
    resize_or_check_if_view(beta, {n});
    resize_or_check_work_buffer(rwork, 8 * n);
 
    // check parameters
    EXPECTS(jobvl == 'V' or jobvl == 'N');
    EXPECTS(jobvr == 'V' or jobvr == 'N');
 
    // resize eigenvector matrices if needed
    int ldvl = 1;
    int ldvr = 1;
    if (jobvl == 'V') {
      resize_or_check_if_view(vl, {n, n});
      ldvl = get_ld(vl);
    }
    if (jobvr == 'V') {
      resize_or_check_if_view(vr, {n, n});
      ldvr = get_ld(vr);
    }
 
    // arrays/views must be LAPACK compatible
    EXPECTS(a.indexmap().min_stride() == 1);
    EXPECTS(b.indexmap().min_stride() == 1);
    EXPECTS(alpha.indexmap().min_stride() == 1);
    EXPECTS(beta.indexmap().min_stride() == 1);
    EXPECTS(jobvl == 'N' or vl.indexmap().min_stride() == 1);
    EXPECTS(jobvr == 'N' or vr.indexmap().min_stride() == 1);
 
    // first call to get the optimal buffer size
    auto tmp_lwork = get_value_t<A>{};
    int info       = 0;
    lapack::f77::ggev(jobvl, jobvr, n, a.data(), get_ld(a), b.data(), get_ld(b), alpha.data(), beta.data(), vl.data(), ldvl, vr.data(), ldvr,
                      &tmp_lwork, -1, rwork.data(), info);
    int lwork = static_cast<int>(std::ceil(std::real(tmp_lwork)));
 
    // resize/check work buffer
    resize_or_check_work_buffer(work, lwork);
 
    // perform actual library call
    lapack::f77::ggev(jobvl, jobvr, n, a.data(), get_ld(a), b.data(), get_ld(b), alpha.data(), beta.data(), vl.data(), ldvl, vr.data(), ldvr,
                      work.data(), lwork, rwork.data(), info);
 
    return info;
  }
 
} // namespace nda::lapack