TRIQS/nda 1.3.0
Multi-dimensional array library for C++
Loading...
Searching...
No Matches
heev.hpp
Go to the documentation of this file.
1// Copyright (c) 2024--present, The Simons Foundation
2// This file is part of TRIQS/nda and is licensed under the Apache License, Version 2.0.
3// SPDX-License-Identifier: Apache-2.0
4// See LICENSE in the root of this distribution for details.
5
10
11#pragma once
12
14#include "../basic_array.hpp"
16#include "../concepts.hpp"
17#include "../declarations.hpp"
18#include "../macros.hpp"
20#include "../traits.hpp"
21
22#include <algorithm>
23#include <cmath>
24#include <complex>
25#include <concepts>
26
27namespace nda::lapack {
28
48 template <MemoryMatrix A, MemoryVector W>
49 requires(mem::have_host_compatible_addr_space<A> and std::same_as<std::complex<double>, get_value_t<A>> and std::same_as<double, get_value_t<W>>)
50 int heev(A &&a, W &&w, char jobz = 'V') { // NOLINT (temporary views are allowed here)
51 static_assert(has_F_layout<A>, "Error in nda::lapack::heev: A must have Fortran layout");
52
53 // check the dimensions of the input/output arrays/views and resize if necessary
54 auto const [m, n] = a.shape();
55 EXPECTS(m == n);
57
58 // arrays/views must be LAPACK compatible
59 EXPECTS(a.indexmap().min_stride() == 1);
60 EXPECTS(w.indexmap().min_stride() == 1);
61
62 // check other input parameters for consistency
63 EXPECTS(jobz == 'V' or jobz == 'N');
64
65 // first call to get the optimal buffer size
66 array<double, 1> rwork(std::max(1l, 3 * n - 2));
67 std::complex<double> tmp_lwork{};
68 int info = 0;
69 lapack::f77::heev(jobz, 'U', n, a.data(), get_ld(a), w.data(), &tmp_lwork, -1, rwork.data(), info);
70 int lwork = static_cast<int>(std::ceil(std::real(tmp_lwork)));
71
72 // allocate work buffer and perform actual library call
73 array<std::complex<double>, 1> work(lwork);
74 lapack::f77::heev(jobz, 'U', n, a.data(), get_ld(a), w.data(), work.data(), lwork, rwork.data(), info);
75
76 return info;
77 }
78
79} // namespace nda::lapack
Provides definitions and type traits involving the different memory address spaces supported by nda.
Provides the generic class for arrays.
Provides basic functions to create and manipulate arrays and views.
ValueType const * data() const noexcept
Get a pointer to the actual data (in general this is not the beginning of the memory block for a view...
Provides concepts for the nda library.
Provides various convenient aliases and helper functions for nda::basic_array and nda::basic_array_vi...
void resize_or_check_if_view(A &a, std::array< long, A::rank > const &sha)
Resize a given regular array to the given shape or check if a given view as the correct shape.
basic_array< ValueType, Rank, Layout, 'A', ContainerPolicy > array
Alias template of an nda::basic_array with an 'A' algebra.
std::decay_t< decltype(get_first_element(std::declval< A const >()))> get_value_t
Get the value type of an array/view or a scalar type.
Definition traits.hpp:182
int heev(A &&a, W &&w, char jobz='V')
Interface to the LAPACK heev routine.
Definition heev.hpp:50
static constexpr bool have_host_compatible_addr_space
Constexpr variable that is true if all given types have an address space compatible with Host.
Provides a C++ interface for various LAPACK routines.
int get_ld(A const &a)
Get the leading dimension of an nda::MemoryArray with rank 1 or 2 for BLAS/LAPACK calls.
Definition tools.hpp:122
static constexpr bool has_F_layout
Constexpr variable that is true if the given nda::Array type has nda::F_layout.
Definition tools.hpp:73
Macros used in the nda library.
Provides type traits for the nda library.