elpa_cholesky(3)

1elpa_cholesky(3)           Library Functions Manual           elpa_cholesky(3)
2
3
4

NAME

6       elpa_cholesky - do a Cholesky factorization of a real symmetric or
7       complex hermitian matrix also exists in explicit form
8       elpa_cholesky_double, elpa_cholesky_float,
9       elpa_cholesky_double_complex, elpa_cholesky_float_complex
10
11

SYNOPSIS

13   FORTRAN INTERFACE
14       use elpa
15       class(elpa_t), pointer :: elpa
16
17       call elpa%cholesky (a, error)
18
19       With the definitions of the input and output variables:
20
21
22       datatype :: a:canalsobeadevicepointeroftype(c_ptr)
23              The matrix a which should be decomposed. The dimensions of
24              matrix a must be set BEFORE with the methods elpa_set(3) and
25              elpa_setup(3). The datatype of the matrix can be one of
26              "real(kind=c_double)", "real(kind=c_float)",
27              "complex(kind=c_double)", or "complex(kind=c_float)"
28
29       integer, optional :: error
30              The return error code of the function. Should be "ELPA_OK". The
31              error code can be querried with the function elpa_strerr(3)
32
33
34   C INTERFACE
35       #include <elpa/elpa.h>
36       elpa_t handle;
37
38       void elpa_cholesky(elpa_t handle, datatype *a, int *error);
39
40       With the definitions of the input and output variables:
41
42
43       elpa_t handle;
44              The handle to the ELPA object
45
46       datatype *a;canalsobeadevicepointer
47              The matrix which should be decomposed. The dimensions of the
48              matrix must be set BEFORE with the methods elpa_set(3) and
49              elpa_setup(3). The datatype can be one of "double", "float",
50              "double complex", or "float complex".  int *error; The error
51              code of the function. Should be "ELPA_OK". The error codes can
52              be querried with elpa_strerr(3)
53
54

DESCRIPTION

56       Compute the Cholesky decomposition of a real symmtric or complex
57       hermitian matrix.The functions elpa_init(3), elpa_allocate(3),
58       elpa_set(3), and elpa_setup(3) must be called BEFORE elpa_eigenvalues
59       can be called.
60

NAME

SYNOPSIS

DESCRIPTION

SEE ALSO