Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
elpa_cholesky(3)	    Library Functions Manual		elpa_cholesky(3)

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_com-
     plex.

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_dou-
	    ble)", or "complex(kind=c_float)".

     integer, optional :: error
	    The  return error code of the function. Should be "ELPA_OK". The er-
	    ror 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::com-
	    plex<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  hermit-
     ian 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
      elpa_init(3)  elpa_allocate(3)  elpa_set(3)  elpa_setup(3)  elpa_strerr(3)
     elpa_eigenvalues(3)      elpa_eigenvectors(3)     elpa_invert_triangular(3)
     elpa_solve_tridiagonal(3)	   elpa_hermitian_multiply(3)	  elpa_uninit(3)
     elpa_deallocate(3)

ELPA				 Thu Nov 28 2024		elpa_cholesky(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=elpa_cholesky&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help