Man pages for elpa_invert_trm_real

55f5fb8b · Andreas Marek · 555fcf83 · 55f5fb8b · 55f5fb8b · 55f5fb8b
Commit 55f5fb8b authored Sep 29, 2016 by Andreas Marek
Showing with 150 additions and 0 deletions

Makefile.am Makefile.am +2 -0

man/elpa_invert_trm_real_double.3 man/elpa_invert_trm_real_double.3 +74 -0

man/elpa_invert_trm_real_single.3 man/elpa_invert_trm_real_single.3 +74 -0

No files found.
--- a/Makefile.am
+++ b/Makefile.am
@@ -254,6 +254,8 @@ dist_man_MANS = \
 	   man/elpa_mult_at_b_real_single.3 \
 	   man/elpa_mult_ah_b_complex_double.3 \
 	   man/elpa_mult_ah_b_complex_single.3 \
+	   man/elpa_invert_trm_real_double.3 \
+	   man/elpa_invert_trm_real_single.3 \
 	   man/elpa2_print_kernels.1

 if WANT_SINGLE_PRECISION_REAL

--- a/man/elpa_invert_trm_real_double.3
+++ b/man/elpa_invert_trm_real_double.3
+.TH "elpa_invert_trm_real_double" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+elpa_invert_trm_real_double \- Invert a upper triangular matrix
+.br
+
+.SH SYNOPSIS
+.br
+.SS FORTRAN INTERFACE
+use elpa1
+.br
+.br
+.RI  "success = \fBelpa_invert_trm_real_double\fP (na, a, lda, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, wantDebug)"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "integer, intent(in)    \fBna\fP:            Order of matrix \fBa\fP"
+.br
+.RI "real*8,  intent(inout) \fBa\fP:             locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBldaCols\fP. Only upper triangule needs to be set. The lower triangle is not referenced"
+.br
+.RI "integer, intent(in)    \fBlda\fP:           leading dimension of locally distributed matrix \fBa\fP"
+.br
+.RI "integer, intent(in)    \fBnblk\fP:          blocksize of cyclic distribution, must be the same in both directions"
+.br
+.RI "integer, intent(in)    \fBmatrixCols\fP:    number of columns of locally distributed matrices \fBa\fP"
+.br
+.RI "integer, intent(in)    \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "integer, intent(in)    \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "logical, intent(in)    \fBwantDebug\fP:     if .true. , print more debug information in case of an error"
+
+.br
+.RI "logical                \fBsuccess\fP:       return value indicating success or failure"
+.br
+.SS C INTERFACE
+#include "elpa.h"
+
+.br
+.RI "\fBint\fP success = \fBelpa_invert_trm_real_double\fP (\fBint\fP na, \fB double *\fPa, \fBint\fP lda, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols,  \fBint\fP wantDebug);"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "int \fBna\fP:               Order of matrix \fBa\fP"
+.br
+.RI "double *\fBa\fP:            locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBmatrixCols\fP"
+.br
+.RI "int \fBlda\fP:              leading dimension of locally distributed matrix \fBa\fP"
+.br
+.RI "int \fBnblk\fP:             blocksize of cyclic distribution, must be the same in both directions"
+.br
+.RI "int \fBmatrixCols\fP:       number of columns of locally distributed matrices \fBa\fP"
+.br
+.RI "int \fBmpi_comm_rows\fP:    communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "int \fBmpi_comm_cols\fP:    communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "int \fBwantDebug\fP:        give more debugging information"
+.br
+
+.RI "int     \fBsuccess\fP:       return value indicating success (1) or failure (0)
+
+.SH DESCRIPTION
+Inverts a upper triangular matrix a. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
+.br
+.SH "SEE ALSO"
+\fBelpa_get_communicators\fP(3) \fBelpa_invert_trm_real_single\fP(3) \fBelpa_invert_trm_complex_double\fP(3) \fBelpa_invert_trm_complex_single\fP(3)
--- a/man/elpa_invert_trm_real_single.3
+++ b/man/elpa_invert_trm_real_single.3
+.TH "elpa_invert_trm_real_single" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+elpa_invert_trm_real_single \- Invert a upper triangular matrix
+.br
+
+.SH SYNOPSIS
+.br
+.SS FORTRAN INTERFACE
+use elpa1
+.br
+.br
+.RI  "success = \fBelpa_invert_trm_real_single\fP (na, a, lda, nblk, matrixCols, mpi_comm_rows, mpi_comm_cols, wantDebug)"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "integer, intent(in)    \fBna\fP:            Order of matrix \fBa\fP"
+.br
+.RI "real*4,  intent(inout) \fBa\fP:             locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBldaCols\fP. Only upper triangule needs to be set. The lower triangle is not referenced"
+.br
+.RI "integer, intent(in)    \fBlda\fP:           leading dimension of locally distributed matrix \fBa\fP"
+.br
+.RI "integer, intent(in)    \fBnblk\fP:          blocksize of cyclic distribution, must be the same in both directions"
+.br
+.RI "integer, intent(in)    \fBmatrixCols\fP:    number of columns of locally distributed matrices \fBa\fP"
+.br
+.RI "integer, intent(in)    \fBmpi_comm_rows\fP: communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "integer, intent(in)    \fBmpi_comm_cols\fP: communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "logical, intent(in)    \fBwantDebug\fP:     if .true. , print more debug information in case of an error"
+
+.br
+.RI "logical                \fBsuccess\fP:       return value indicating success or failure"
+.br
+.SS C INTERFACE
+#include "elpa.h"
+
+.br
+.RI "\fBint\fP success = \fBelpa_invert_trm_real_single\fP (\fBint\fP na, \fB float *\fPa, \fBint\fP lda, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols,  \fBint\fP wantDebug);"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "int \fBna\fP:               Order of matrix \fBa\fP"
+.br
+.RI "float *\fBa\fP:             locally distributed part of the matrix \fBa\fP. The local dimensions are \fBlda\fP x \fBmatrixCols\fP"
+.br
+.RI "int \fBlda\fP:              leading dimension of locally distributed matrix \fBa\fP"
+.br
+.RI "int \fBnblk\fP:             blocksize of cyclic distribution, must be the same in both directions"
+.br
+.RI "int \fBmatrixCols\fP:       number of columns of locally distributed matrices \fBa\fP"
+.br
+.RI "int \fBmpi_comm_rows\fP:    communicator for communication in rows. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "int \fBmpi_comm_cols\fP:    communicator for communication in colums. Constructed with \fBelpa_get_communicators\fP(3)"
+.br
+.RI "int \fBwantDebug\fP:        give more debugging information"
+.br
+
+.RI "int     \fBsuccess\fP:       return value indicating success (1) or failure (0)
+
+.SH DESCRIPTION
+Inverts a upper triangular matrix a. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
+.br
+.SH "SEE ALSO"
+\fBelpa_get_communicators\fP(3) \fBelpa_invert_trm_real_double\fP(3) \fBelpa_invert_trm_complex_double\fP(3) \fBelpa_invert_trm_complex_single\fP(3)