Rudimentary documentation of ELPA autotuning

Makefile.am

@@ -475,7 +475,11 @@ dist_man_MANS += \
   man/elpa_solve_evp_real_double.3 \
   man/elpa_solve_evp_real_single.3 \
   man/elpa_solve_evp_complex_double.3 \
-  man/elpa_solve_evp_complex_single.3
+  man/elpa_solve_evp_complex_single.3 \
+  man/elpa_autotune_setup.3 \
+  man/elpa_autotune_step.3 \
+  man/elpa_autotune_set_best.3 \
+  man/elpa_autotune_deallocate.3
 endif
 
 

man/elpa_autotune_deallocate.3

+.TH "elpa_autotune_deallocate" 3 "Tue Nov 28 2017" "ELPA" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+elpa_autotune_deallocate \- Deallocates an ELPA autotuning instance
+.br
+
+.SH SYNOPSIS
+.br
+.SS FORTRAN INTERFACE
+use elpa
+.br
+class(elpa_t), pointer :: elpa
+class(elpa_autotune_t), pointer :: tune_state
+.br
+
+.RI  "call\fBelpa%autotune_deallocate\fP (tune_state)"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "type(elpa_autotune_t) :: \fBtune_state\fP  !  the ELPA autotuning object, created with \fBelpa_autotune_setup\fP(3)
+.br
+.SS C INTERFACE
+#include <elpa/elpa.h>
+.br
+elpa_t handle;
+elpa_autotune_t autotune_handle;
+
+.br
+.RI "void \fBelpa_autotune_deallocate\fP (\fBelpa_t\fP handle, \fBelpa_autotune_t\fP autotune_handle);"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.br
+.RI "elpa_t \fBhandle\fP;  // the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
+.br
+.RI "elpa_autotune_t \fBautotune_handle\fP;  // the handle of an ELPA object, obtained before with \fBelpa_autotune_setup\fP(3)"
+
+.SH DESCRIPTION
+Deallocates an ELPA autotuning instance.  \fIPrior\fP to calling the elpa_autotune_deallocate method, an ELPA autotuning object must have been created. See \fBelpa_autotune_setup\fP(3)
+.SH "SEE ALSO"
+.br
+\fBelpa_autotune_step\fP(3) \fBelpa_autotune_setup\fP(3) \fBelpa_autotune_deallocate\fp(3)
+

man/elpa_autotune_set_best.3

+.TH "elpa_autotune_set_best" 3 "Tue Nov 28 2017" "ELPA" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+elpa_autotune_set_best \- Sets the tunable parameters to the up-to-know best solution
+.br
+
+Before the autotuning options can be set, an autotuning step has to be done \fBelpa_autotune_step\fP(3)
+.SH SYNOPSIS
+.br
+.SS FORTRAN INTERFACE
+use elpa
+.br
+class(elpa_t), pointer :: elpa
+class(elpa_autotune_t), pointer :: tune_state
+.br
+
+.RI  "call\fBelpa%autotune_set_best\fP (tune_state)"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "type(elpa_autotune_t) :: \fBtune_state\fP  !  the ELPA autotuning object, created with \fBelpa_autotune_setup\fP(3)
+.br
+.SS C INTERFACE
+#include <elpa/elpa.h>
+.br
+elpa_t handle;
+elpa_autotune_t autotune_handle;
+
+.br
+.RI "void \fBelpa_autotune_set_best\fP (\fBelpa_t\fP handle, \fBelpa_autotune_t\fP autotune_handle);"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.br
+.RI "elpa_t \fBhandle\fP;  // the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
+.br
+.RI "elpa_autotune_t \fBautotune_handle\fP;  // the handle of an ELPA object, obtained before with \fBelpa_autotune_setup\fP(3)"
+
+.SH DESCRIPTION
+Sets the up-to-know best options for ELPA tunable parameters. \fIPrior\fP to calling the elpa_autotune_set_best method, an ELPA autotuning step must have been performed. See \fBelpa_autotune_set_best\fP(3)
+.SH "SEE ALSO"
+.br
+\fBelpa_autotune_step\fP(3) \fBelpa_autotune_setup\fP(3) \fBelpa_autotune_deallocate\fp(3)
+

man/elpa_autotune_setup.3

+.TH "elpa_autotune_setup" 3 "Tue Nov 28 2017" "ELPA" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+elpa_autotune_setup \- create an instance for autotuning of the ELPA library
+.br
+
+Before the autotuning object can be created, an instance of the ELPA library has to be setup, see e.g. \fBelpa_setup\fP(3)
+.SH SYNOPSIS
+.br
+.SS FORTRAN INTERFACE
+use elpa
+.br
+class(elpa_t), pointer :: elpa
+class(elpa_autotune_t), pointer :: tune_state
+.br
+
+.RI  "tune_state= \fBelpa%autotune_setup\fP (level, domain)"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "integer :: \fBlevel\fP  !  the level of the autotuning, at the moment ELPA_AUTOTUNE_FAST is supported"
+.br
+.RI "integer :: \fBdomain\fP  !  the domain (real or complex) of the autotuning, can be either ELPA_AUTOTUNE_DOMAIN_REAL or ELPA_AUTOTUNE_DOMAIN_COMPLEX"
+.br
+.SS C INTERFACE
+#include <elpa/elpa.h>
+.br
+elpa_t handle;
+elpa_autotune_t autotune_handle;
+
+.br
+.RI "\fBelpa_autotune_t\fP autotune_handle = \fBelpa_autotune_setup\fP (\fBelpa_t\fP handle, int level, int domain);"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.br
+.RI "elpa_t \fBhandle\fP;  // the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
+.br
+.RI "int \fBlevel\fP;      // the level of the autotuning, at the moment "ELPA_AUTOTUNE_FAST" is supported
+.br
+.RI "int \fBdomain\fP;      // the domain (real or complex) of the autotuning, can be either "ELPA_AUTOTUNE_DOMAIN_REAL"  and "ELPA_AUTOTUNE_DOMAIN_COMPLEX"
+.br
+.RI "elpa_autotune_t \fBautotune_handel\fP;    // the created handle of the autotune object
+
+.SH DESCRIPTION
+Creates an ELPA autotuning object. \fIPrior\fP to calling  the autotune_setup, an ELPA object must have been created. See \fBelpa_setup\fP(3)
+.SH "SEE ALSO"
+.br
+\fBelpa_autotune_step\fP(3) \fBelpa_autotune_set_best\fP(3) \fBelpa_autotune_deallocate\fp(3)
+

man/elpa_autotune_step.3

+.TH "elpa_autotune_step" 3 "Tue Nov 28 2017" "ELPA" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+elpa_autotune_step \- do one ELPA autotuning step
+.br
+
+Before the autotuning step can be done, an instance of the ELPA autotune object has to be created, see \fBelpa_autotune_setup\fP(3)
+.SH SYNOPSIS
+.br
+.SS FORTRAN INTERFACE
+use elpa
+.br
+class(elpa_t), pointer :: elpa
+class(elpa_autotune_t), pointer :: tune_state
+.br
+
+.RI  "unfinished = \fBelpa%autotune_step\fP (tune_state)"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.RI "type(elpa_autotune_t) :: \fBtune_state\fP  !  the ELPA autotuning object, created with \fBelpa_autotune_setup\fP(3)
+.br
+.RI "logical :: \fBunfinished\fP  !  logical, specifying whether autotuning has finined (.false.) or not (.true.)
+.br
+
+.SS C INTERFACE
+#include <elpa/elpa.h>
+.br
+elpa_t handle;
+elpa_autotune_t autotune_handle;
+
+.br
+.RI "\fBint\fP unfinished = \fBelpa_autotune_step\fP (\fBelpa_t\fP handle, \fBelpa_autotune_t\fP autotune_handle);"
+.br
+.RI " "
+.br
+.RI "With the definitions of the input and output variables:"
+
+.br
+.br
+.RI "elpa_t \fBhandle\fP;  // the handle of an ELPA object, obtained before with \fBelpa_allocate\fP(3)"
+.br
+.RI "elpa_autotune_t \fBautotune_handle\fP;  // the handle of the autotuning object, created with \fBelpa_autotune_setup\fP(3)
+.br
+.RI "int \fBunfinished\fP;      // int, specifying whether autotuning has finined (0) or not (1)
+
+.SH DESCRIPTION
+Does an ELPA autotuning step. \fIPrior\fP to calling  the autotune_step, an ELPA autotune object must have been created. See \fBelpa_autotune_setup\fP(3)
+.SH "SEE ALSO"
+.br
+\fBelpa_autotune_setup\fP(3) \fBelpa_autotune_set_best\fP(3) \fBelpa_autotune_deallocate\fp(3)
+