elpa_cholesky(3)

📦 version 2026.02.002, in nixpkgs unstable

🌸 elpa_cholesky(3) 🌸

okay so bestie, welcome to the Library Functions Manual page for elpa_cholesky(3) 💅 this one is giving major linear algebra main character energy ✨

✨ NAME ✨

elpa_cholesky — performs a Cholesky factorization of a real symmetric or complex hermitian positive-definite matrix: A = U^T*U or A = U^H*U, where U is an upper triangular matrix.

There are also variations of this routine that can accept not only host but also device pointers as input/output. Names of these routines explicitly contain the corresponding datatypes: elpa_cholesky_double, elpa_cholesky_float, elpa_cholesky_double_complex, elpa_cholesky_float_complex.

🛠️ SYNOPSIS 🛠️

🧮 FORTRAN INTERFACE 🧮

use elpa
class(elpa_t), pointer :: elpa_handle

call elpa_handle%cholesky (a, error)

With the definitions of the input and output variables:

  • datatype :: a — on input: the local part of matrix A that should be decomposed. On output: the local part upper triangular matrix U. The dimensions of matrix a must be set BEFORE with the methods elpa_set(3) and elpa_setup(3). The datatype of the matrix can be one of "real(kind=c_double)", "real(kind=c_float)", "complex(kind=c_double)", or "complex(kind=c_float)".
  • integer, optional :: error — the return error code of the function. Should be "ELPA_OK". The error code can be queried with the function elpa_strerr(3).

💻 C/C++ INTERFACE 💻

#include <elpa/elpa.h>
elpa_t elpa_handle;

void  elpa_cholesky(elpa_t elpa_handle, datatype *a, int *error);

With the definitions of the input and output variables:

  • elpa_t elpa_handle; — the handle to the ELPA object.
  • datatype *a; — on input: the local part of matrix A that should be decomposed. On output: the local part of upper triangular matrix U. The dimensions of the matrix must be set BEFORE with the methods elpa_set(3) and elpa_setup(3). The datatype can be one of "double", "float", "double complex"/"std::complex<double>", "float complex"/"std::complex<float>" for C/C++.
  • int *error; — the error code of the function. Should be "ELPA_OK". The error codes can be queried with elpa_strerr(3).

💖 DESCRIPTION 💖

Computes the Cholesky decomposition of a real symmetric or complex hermitian positive-definite matrix. The functions elpa_init(3), elpa_allocate(3), elpa_set(3), and elpa_setup(3) must be called BEFORE elpa_cholesky can be called.

👀 SEE ALSO 👀

bye bestie 🫶 this elpa_cholesky(3) page is brought to you by ELPA, dated Thu Nov 28 2024 — go decompose something cute 💅✨

📦 where this page comes from