Commit 72dc0e5b authored by Andreas Marek's avatar Andreas Marek

Man page for procedure solve_tridiagonal

parent f279a1b8
......@@ -372,6 +372,7 @@ dist_man_MANS = \
man/elpa_eigenvectors.3 \
man/elpa_cholesky.3 \
man/elpa_invert_triangular.3 \
man/elpa_solve_tridiagonal.3 \
man/elpa_deallocate.3 \
man/elpa_uninit.3
......
......@@ -23,5 +23,5 @@ A. Marek, MPCDF
.SH "Reporting bugs"
Report bugs to the ELPA mail elpa-library@mpcdf.mpg.de
.SH "SEE ALSO"
\fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.RI "class(elpa_t) :: \fBelpa\fP ! returns an instance of the ELPA object"
......@@ -34,7 +34,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.br
......@@ -45,4 +45,4 @@ Allocate an ELPA object. The function \fBelpa_init\fP(3) must be called once \fI
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.TP
......@@ -38,7 +38,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.TP
......@@ -55,4 +55,4 @@ Compute the Cholesky decomposition of a real symmtric or complex hermetian matri
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fB(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.RI "class(elpa_t) :: \fBelpa\fP ! the pointer to the instance of the ELPA library which should be deallocated"
......@@ -34,7 +34,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.br
......@@ -45,4 +45,4 @@ Deallocate an ELPA object. The functions \fBelpa_init\fP(3) and \fBelpa_allocate
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_uninit\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_uninit\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.RI "class(elpa_t) :: \fBelpa\fP ! returns an instance of the ELPA object"
......@@ -43,7 +43,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.TP
......@@ -64,4 +64,4 @@ Compute the eigenvalues of a real symmtric or complex hermetian matrix.The funct
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.RI "class(elpa_t) :: \fBelpa\fP ! returns an instance of the ELPA object"
......@@ -45,7 +45,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.TP
......@@ -69,4 +69,4 @@ Compute the eigenvalues and (parts of) the eigenvector spectrum of a real symmtr
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.RI "integer, intent(in) :: \fBapi_version\fP ! the api version that you want to initialize, currently the version is 20170403"
......@@ -36,7 +36,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.br
......@@ -50,4 +50,4 @@ with the \fBelpa_strerr\fP(3) function.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_allocate\fP(3) \fPelpa_set\fP(3) \fPelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_choleksy\fP(3) \fBelpa_invert_triangular\fP(3) \fPelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_allocate\fP(3) \fPelpa_set\fP(3) \fPelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_choleksy\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fPelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.TP
......@@ -38,7 +38,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.TP
......@@ -55,4 +55,4 @@ Inverts an upper triangular real or complex matrix. The functions \fBelpa_init\f
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_choleksy\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.TP
......@@ -43,7 +43,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.br
......@@ -123,4 +123,4 @@ Choose whether, in case of an error, more debug information should be provided.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_deallocate\fP(3) \fBelpa_uninit\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_deallocate\fP(3) \fBelpa_uninit\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.RI "integer :: \fBsucces\fP ! the returned error code. Should normally be ELPA_OK. Can be querried with \fBelpa_strerr\fP(3)"
......@@ -34,7 +34,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.br
......@@ -47,4 +47,4 @@ Setups an ELPA object. \fIPrior\fP to calling the setup, the functions \fBelpa_
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_deallocate\fP(3) \fBelpa_uninit\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_deallocate\fP(3) \fBelpa_uninit\fP(3)
.TH "elpa_solve_tridiagonal" 3 "Sat Jul 15 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_solve_tridiagonal \- computes the eigenvalue problem for real symmetric tridiagonal matrix
.br
.SH SYNOPSIS
.br
.SS FORTRAN INTERFACE
use elpa
.br
class(elpa_t), pointer :: elpa
.br
.RI "call elpa%\fBeigenvectors\fP (d, e, q, error)"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.RI "class(elpa_t) :: \fBelpa\fP ! returns an instance of the ELPA object"
.br
.TP
.RI "datatype :: \fBd\fP"
The diagonal elements of a matrix whose dimensions have been defined in \fBelpa_setup\fP(3). On exist the eigenvalues are stored in this 1d-array. The datatype of the diagonal elements can either be "real(kind=c_double)" or "real(kind=c_float)".
.TP
.RI "datatype :: \fBe\fP"
The offdiagonal elements of the matrix. The datatype of the diagonal elements can either be "real(kind=c_double)" or "real(kind=c_float)".
.RI "datatype :: \fBq\fP"
The storage space for the computed eigenvectors. The datatype of the matrix can be either "real(kind=c_double)" or "real(kind=c_float)".
.TP
.RI "integer, optional :: \fBerror\fP"
The return error code of the function. Should be "ELPA_OK". The error code can be querried with the function \fBelpa_strerr\fP(3)
.br
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
.br
.RI "void \fBelpa_eigenvalues\fP(\fBelpa_t\fP handle, \fBdatatype\fP *d, \fBdatatype\fP *e, \fBdatatype\fP *q, \fBint\fP *error);"
.br
.RI " "
.br
.RI "With the definitions of the input and output variables:"
.br
.TP
.RI "elpa_t \fBhandle\fP;"
The handle to the ELPA object
.TP
.RI "datatype *\fBd\fP;"
The diagonal elements of the matrix. The dimensions of the matrix must be set \fIBEFORE\fP with \fBelpa_setup\fP(3). On exist the eigenvalues are stored in d. The \fBdatatype\fP can be one of "double" or "float".
.TP
.RI "datatype *\fBe\fP;"
The offdiagonal elements of the matrix. The \fBdatatype\fP can be one of "double" or "float".
.TP
.RI "datatype *\fBq\fP;"
The storage space for the computed eigenvectors. The dimensions of the matrix must be set \fIBEFORE\fP with the methods \fBelpa_set\fP(3) and \fBelpa_setup\fP(3). The \fBdatatype\fP can be one of "double", "float", "double complex", or "float complex".
.TP
.RI "int *\fBerror\fP;"
The error code of the function. Should be "ELPA_OK". The error codes can be querried with \fBelpa_strerr\fP(3)
.SH DESCRIPTION
Computes the eigenvalue problem of a real symmtric tridiagonal matrix.The functions \fBelpa_init\fP(3), \fBelpa_allocate\fP(3), \fBelpa_set\fP(3), and \fBelpa_setup\fP(3) must be called \fIBEFORE\fP \fBelpa_solve_tridiagonal\fP can be called.
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_setup\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_uninit\fP(3) \fBelpa_deallocate\fP(3)
......@@ -17,7 +17,7 @@ class(elpa_t), pointer :: elpa
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.RI "No input or output is needed."
......@@ -35,7 +35,7 @@ elpa_t handle;
.br
.RI " "
.br
.RI "With the definintions of the input and output variables:"
.RI "With the definitions of the input and output variables:"
.br
.br
......@@ -47,4 +47,4 @@ Uninitializes the ELPA library after usage. The function \fBelpa_init\fP(3) must
.br
.SH "SEE ALSO"
.br
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_setup\fP(3) \fBelpa_deallocate\fP(3)
\fBelpa2_print_kernels\fP(1) \fBelpa_init\fP(3) \fBelpa_allocate\fP(3) \fBelpa_set\fP(3) \fBelpa_strerr\fP(3) \fBelpa_eigenvalues\fP(3) \fBelpa_eigenvectors\fP(3) \fBelpa_cholesky\fP(3) \fBelpa_invert_triangular\fP(3) \fBelpa_solve_tridiagonal\fP(3) \fBelpa_setup\fP(3) \fBelpa_deallocate\fP(3)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment