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 - do a Cholesky factorization of a	real symmetric or
       complex hermitian matrix

SYNOPSIS
   FORTRAN INTERFACE
       use elpa
       class(elpa_t), pointer :: elpa

       call elpa%cholesky (a, error)

       With the	definitions of the input and output variables:

       datatype	:: a
	      The matrix a which should	be decomposed. 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	querried with the function elpa_strerr(3)

   C INTERFACE
       #include	<elpa/elpa.h>
       elpa_t handle;

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

       With the	definitions of the input and output variables:

       elpa_t handle;
	      The handle to the	ELPA object

       datatype	*a;
	      The matrix which should be decomposed. 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",	or "float complex".  int *error; The error
	      code of the function. Should be "ELPA_OK". The error codes can
	      be querried with elpa_strerr(3)

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

SEE ALSO
       elpa2_print_kernels(1) 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				Sat Jul	15 2017		      elpa_cholesky(3)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO

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

home | help