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
8
9

SYNOPSIS

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

DESCRIPTION

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

SEE ALSO

60       elpa2_print_kernels(1) elpa_init(3) elpa_allocate(3) elpa_set(3)
61       elpa_setup(3) elpa_strerr(3) elpa_eigenvalues(3) elpa_eigenvectors(3)
62       elpa_invert_triangular(3) elpa_solve_tridiagonal(3)
63       elpa_hermitian_multiply(3) elpa_uninit(3) elpa_deallocate(3)
64
65
66
67ELPA                            Sat Jul 15 2017               elpa_cholesky(3)
Impressum