Skip to content

GitLab

elpa
elpa
Commit e5a3670c authored by Andreas Marek's avatar Andreas Marek
Browse files
Options

Update man pages for legacy API 

-man pages have been updated
-man pages for legacy API are only installed if legacy API is enabled
parent 2d684ef0
Hide whitespace changes
Inline Side-by-side
Showing with 524 additions and 178 deletions
Makefile.am
View file @ e5a3670c
......@@ -345,6 +345,10 @@ elpa_includedir = $(includedir)/elpa@SUFFIX@-@PACKAGE_VERSION@
nobase_elpa_include_HEADERS = $(wildcard modules/*) $(wildcard elpa/*)
dist_man_MANS = \
man/elpa2_print_kernels.1
if ENABLE_LEGACY
dist_man_MANS += \
man/solve_evp_real.3 \
man/solve_evp_real_1stage_double.3 \
man/solve_evp_complex.3 \
......@@ -369,24 +373,29 @@ dist_man_MANS = \
man/elpa_solve_evp_real_single.3 \
man/elpa_solve_evp_complex_double.3 \
man/elpa_solve_evp_complex_single.3 \
man/elpa_tests.1 \
man/elpa2_print_kernels.1
man/elpa_tests.1
endif
if WANT_SINGLE_PRECISION_REAL
if ENABLE_LEGACY
dist_man_MANS += \
man/solve_evp_real_1stage_single.3 \
man/elpa_solve_evp_real_1stage_single.3 \
man/elpa_solve_evp_real_2stage_single.3 \
man/solve_evp_real_2stage_single.3
endif
endif
if WANT_SINGLE_PRECISION_COMPLEX
if ENABLE_LEGACY
dist_man_MANS += \
man/solve_evp_complex_1stage_single.3 \
man/elpa_solve_evp_complex_1stage_single.3 \
man/elpa_solve_evp_complex_2stage_single.3 \
man/solve_evp_complex_2stage_single.3
endif
endif
dist_doc_DATA = README.md USERS_GUIDE.md INSTALL.md CONTRIBUTING.md LICENSE Changelog COPYING/COPYING COPYING/gpl.txt COPYING/lgpl.txt
......
man/elpa_cholesky_complex.3
View file @ e5a3670c
.TH "elpa_cholesky_complex" 3 "Wed Jun 29 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_cholesky_complex" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_cholesky_complex \- Cholesky factorization of a complex hermetian matrix
elpa_cholesky_complex \- Cholesky factorization of a complex hermetian matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -37,7 +37,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -71,5 +71,12 @@ use elpa1
.SH DESCRIPTION
Does a Cholesky factorization of a complex, hermetian matrix. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_cholesky_complex_double\fP(3) \fBelpa_cholesky_complex_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_cholesky_complex_double.3
View file @ e5a3670c
.TH "elpa_cholesky_complex_double" 3 "Wed Jun 29 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_cholesky_complex_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_cholesky_complex_double \- Cholesky factorization of a complex hermetian matrix
elpa_cholesky_complex_double \- Cholesky factorization of a complex hermetian matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -37,7 +37,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -71,5 +71,11 @@ use elpa1
.SH DESCRIPTION
Does a Cholesky factorization of a complex, hermetian matrix. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_cholesky_complex\fP(3) \fBelpa_cholesky_complex_single\fP(3)
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_cholesky_complex_single.3
View file @ e5a3670c
.TH "elpa_cholesky_complex_single" 3 "Wed Jun 29 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_cholesky_complex_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_cholesky_complex_single \- Cholesky factorization of a complex hermetian matrix
elpa_cholesky_complex_single \- Cholesky factorization of a complex hermetian matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -37,7 +37,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -71,5 +71,12 @@ use elpa1
.SH DESCRIPTION
Does a Cholesky factorization of a complex, hermetian matrix. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_cholesky_complex\fP(3) \fBelpa_cholesky_complex_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_cholesky_real.3
View file @ e5a3670c
.TH "elpa_cholesky_real" 3 "Wed Jun 29 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_cholesky_real" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_cholesky_real \- Cholesky factorization of a real symmetric matrix
elpa_cholesky_real \- Cholesky factorization of a real symmetric matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -37,7 +37,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_cholesky_real\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 );"
......@@ -69,5 +69,12 @@ use elpa1
.SH DESCRIPTION
Does a Cholesky factorization of a real, symmetric matrix. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_cholesky_real_double\fP(3) \fBelpa_cholesky_real_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_cholesky_real_double.3
View file @ e5a3670c
.TH "elpa_cholesky_real_double" 3 "Wed Jun 29 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_cholesky_real_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_cholesky_real_double \- Cholesky factorization of a real symmetric matrix
elpa_cholesky_real_double \- Cholesky factorization of a real symmetric matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -37,7 +37,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_cholesky_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 );"
......@@ -69,5 +69,11 @@ use elpa1
.SH DESCRIPTION
Does a Cholesky factorization of a real, symmetric matrix. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_cholesky_real\fP(3) \fBelpa_cholesky_real_single\fP(3)
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_cholesky_real_single.3
View file @ e5a3670c
.TH "elpa_cholesky_real_single" 3 "Wed Jun 29 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_cholesky_real_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_cholesky_real_single \- Cholesky factorization of a real symmetric matrix
elpa_cholesky_real_single \- Cholesky factorization of a real symmetric matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -37,7 +37,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_cholesky_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 );"
......@@ -69,5 +69,12 @@ use elpa1
.SH DESCRIPTION
Does a Cholesky factorization of a real, symmetric matrix. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function. The distributed quadratic marix \fBa\fP has global dimensions \fBna\fP x \fBna\fP, and a local size \fBlda\fP x \fBmatrixCols\fP.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_cholesky_real\fP(3) \fBelpa_cholesky_real_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_invert_trm_complex.3
View file @ e5a3670c
.TH "elpa_invert_trm_complex" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_invert_trm_complex" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_invert_trm_complex \- Invert a upper triangular matrix
elpa_invert_trm_complex \- Invert a upper triangular matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -38,7 +38,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_invert_trm_complex\fP (\fBint\fP na, \fB double complex *\fPa, \fBint\fP lda, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP wantDebug);"
......@@ -70,5 +70,12 @@ use elpa1
.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
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_invert_trm_real\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_invert_trm_complex_double.3
View file @ e5a3670c
.TH "elpa_invert_trm_complex_double" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_invert_trm_complex_double" 3 "Wed Mai 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_invert_trm_complex_double \- Invert a upper triangular matrix
elpa_invert_trm_complex_double \- Invert a upper triangular matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -38,7 +38,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_invert_trm_complex_double\fP (\fBint\fP na, \fB double complex *\fPa, \fBint\fP lda, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP wantDebug);"
......@@ -70,5 +70,12 @@ use elpa1
.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
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_invert_trm_real_double\fP(3) \fBelpa_invert_trm_real_single\fP(3) \fBelpa_invert_trm_complex_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_invert_trm_complex_single.3
View file @ e5a3670c
.TH "elpa_invert_trm_complex_single" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_invert_trm_complex_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_invert_trm_complex_single \- Invert a upper triangular matrix
elpa_invert_trm_complex_single \- Invert a upper triangular matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -38,7 +38,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_invert_trm_complex_single\fP (\fBint\fP na, \fB complex *\fPa, \fBint\fP lda, \fBint\fP nblk, \fBint\fP matrixCols, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fBint\fP wantDebug);"
......@@ -70,5 +70,12 @@ use elpa1
.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
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_invert_trm_real_double\fP(3) \fBelpa_invert_trm_real_single\fP(3) \fBelpa_invert_trm_complex_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_invert_trm_real.3
View file @ e5a3670c
.TH "elpa_invert_trm_real" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_invert_trm_real" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_invert_trm_real \- Invert a upper triangular matrix
elpa_invert_trm_real \- Invert a upper triangular matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -38,7 +38,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_invert_trm_real\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);"
......@@ -70,5 +70,12 @@ use elpa1
.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
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_invert_trm_complex\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_invert_trm_real_double.3
View file @ e5a3670c
.TH "elpa_invert_trm_real_double" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_invert_trm_real_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_invert_trm_real_double \- Invert a upper triangular matrix
elpa_invert_trm_real_double \- Invert a upper triangular matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -38,7 +38,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.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);"
......@@ -70,5 +70,12 @@ use elpa1
.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
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\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)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_invert_trm_real_single.3
View file @ e5a3670c
.TH "elpa_invert_trm_real_single" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_invert_trm_real_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_invert_trm_real_single \- Invert a upper triangular matrix
elpa_invert_trm_real_single \- Invert a upper triangular matrix (legacy interface)
.br
.SH SYNOPSIS
......@@ -38,7 +38,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.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);"
......@@ -70,5 +70,12 @@ use elpa1
.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
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\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)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_mult_ah_b_complex.3
View file @ e5a3670c
.TH "elpa_mult_ah_b_complex" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_mult_ah_b_complex" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_mult_ah_b_complex \- Performs C = herm_transpose(A) * B
elpa_mult_ah_b_complex \- Performs C = herm_transpose(A) * B (legacy interface)
.br
.SH SYNOPSIS
......@@ -53,7 +53,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
.br
......@@ -102,6 +102,12 @@ use elpa1
.SH DESCRIPTION
Does c = herm_transpose(a) * b. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_mult_at_b_real\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_mult_ah_b_complex_double.3
View file @ e5a3670c
.TH "elpa_mult_ah_b_complex_double" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_mult_ah_b_complex_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_mult_ah_b_complex_double \- Performs C = herm_transpose(A) * B
elpa_mult_ah_b_complex_double \- Performs C = herm_transpose(A) * B (legacy interface)
.br
.SH SYNOPSIS
......@@ -53,7 +53,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
.br
......@@ -102,6 +102,12 @@ use elpa1
.SH DESCRIPTION
Does c = herm_transpose(a) * b. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_mult_at_b_real_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_mult_ah_b_complex_single.3
View file @ e5a3670c
.TH "elpa_mult_ah_b_complex_single" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_mult_ah_b_complex_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_mult_ah_b_complex_single \- Performs C = herm_transpose(A) * B
elpa_mult_ah_b_complex_single \- Performs C = herm_transpose(A) * B (legacy interface)
.br
.SH SYNOPSIS
......@@ -53,7 +53,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
.br
......@@ -102,6 +102,13 @@ use elpa1
.SH DESCRIPTION
Does c = herm_transpose(a) * b. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_mult_at_b_real_single\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_mult_at_b_real.3
View file @ e5a3670c
.TH "elpa_mult_at_b_real" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_mult_at_b_real" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_mult_at_b_real \- Performs C = transpose(A) * B
elpa_mult_at_b_real \- Performs C = transpose(A) * B (legacy interface)
.br
.SH SYNOPSIS
......@@ -53,7 +53,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_mult_at_b_real\fP (\fBchar\fP uplo_a, \fBchar\fP uplo_c, \fBint\fP na, \fBint\fP ncb, \fB double *\fPa, \fBint\fP lda, \fBint\fP ldaCols, \fB double *\fPb, \fBint\fP ldb, \fBint\fP ldbCols, \fBint\fP nblk, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fB double *\fPc, \fBint\fP lc, \fBint\fP ldcCols );"
......@@ -101,5 +101,12 @@ use elpa1
.SH DESCRIPTION
Does c = transpose(a) * b. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_mult_ah_b_complex\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_mult_at_b_real_double.3
View file @ e5a3670c
.TH "elpa_mult_at_b_real_double" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_mult_at_b_real_double" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_mult_at_b_ral_double \- Performs C = transpose(A) * B
elpa_mult_at_b_ral_double \- Performs C = transpose(A) * B (legacy interface)
.br
.SH SYNOPSIS
......@@ -53,7 +53,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_mult_at_b_real_double\fP (\fBchar\fP uplo_a, \fBchar\fP uplo_c, \fBint\fP na, \fBint\fP ncb, \fB double *\fPa, \fBint\fP lda, \fBint\fP ldaCols, \fB double *\fPb, \fBint\fP ldb, \fBint\fP ldbCols, \fBint\fP nblk, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fB double *\fPc, \fBint\fP lc, \fBint\fP ldcCols );"
......@@ -101,5 +101,12 @@ use elpa1
.SH DESCRIPTION
Does c = transpose(a) * b. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_mult_at_b_real_single\fP(3) \fBelpa_mult_ah_b_complex_single\fP(3) \fBelpa_mult_ah_b_complex_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_mult_at_b_real_single.3
View file @ e5a3670c
.TH "elpa_mult_at_b_real_single" 3 "Wed Sept 28 2016" "ELPA" \" -*- nroff -*-
.TH "elpa_mult_at_b_real_single" 3 "Wed May 17 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_mult_at_b_single \- Performs C = transpose(A) * B
elpa_mult_at_b_single \- Performs C = transpose(A) * B (legacy interface)
.br
.SH SYNOPSIS
......@@ -53,7 +53,7 @@ use elpa1
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
.RI "\fBint\fP success = \fBelpa_mult_at_b_real_single\fP (\fBchar\fP uplo_a, \fBchar\fP uplo_c, \fBint\fP na, \fBint\fP ncb, \fB float *\fPa, \fBint\fP lda, \fBint\fP ldaCols, \fB float *\fPb, \fBint\fP ldb, \fBint\fP ldbCols, \fBint\fP nblk, \fBint\fP mpi_comm_rows, \fBint\fP mpi_comm_cols, \fB float *\fPc, \fBint\fP lc, \fBint\fP ldcCols );"
......@@ -101,5 +101,12 @@ use elpa1
.SH DESCRIPTION
Does c = transpose(a) * b. The ELPA communicators \fBmpi_comm_rows\fP and \fBmpi_comm_cols\fP are obtained with the \fBelpa_get_communicators\fP(3) function.
.br
This function is part of the legacy API of the ELPA library. Better use the current API.
.br
.SH "SEE ALSO"
.br
Old interface:
\fBelpa_get_communicators\fP(3) \fBelpa_mult_at_b_real_double\fP(3) \fBelpa_mult_ah_b_complex_single\fP(3) \fBelpa_mult_ah_b_complex_double\fP(3)
.br
Current interface:
\fBelpa2_print_kernels\fP(1)
man/elpa_solve_evp_complex.3
View file @ e5a3670c
.TH "elpa_solve_evp_complex" 3 "Sun Mar 23 2017" "ELPA" \" -*- nroff -*-
.TH "elpa_solve_evp_complex" 3 "Wed May 27 2017" "ELPA" \" -*- nroff -*-
.ad l
.nh
.SH NAME
elpa_solve_evp_complex \- solve the complex eigenvalue problem with either the 1-satge or the 2-stage ELPA solver
elpa_solve_evp_complex \- solve the complex eigenvalue problem with either the 1-satge or the 2-stage ELPA solver (legacy interface)
.br
.SH SYNOPSIS
......@@ -51,7 +51,7 @@ use elpa_driver
.RI "logical \fBsuccess\fP: return value indicating success or failure"
.br
.SS C INTERFACE
#include "elpa.h"
#include "elpa_legacy.h"
.br
#include <complex.h>
......@@ -98,5 +98,12 @@ use elpa_driver