elpa_autotune_deallocate.3 1.53 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
.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

17
.RI  "call\fBelpa%autotune_deallocate\fP (tune_state, error)"
18 19 20 21 22 23 24 25
.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
26 27 28
.RI "integer, optional     :: \fBerror\fP       ! the returned error code
.br
.br
29 30 31 32 33 34 35
.SS C INTERFACE
#include <elpa/elpa.h>
.br
elpa_t handle;
elpa_autotune_t autotune_handle;

.br
36
.RI "void \fBelpa_autotune_deallocate\fP (\fBelpa_t\fP handle, \fBelpa_autotune_t\fP autotune_handle, \fBint\fP *error);"
37 38 39 40 41 42 43 44 45 46
.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)"
47 48 49 50
.br
.RI "int \fB*error\fP; // the returned error code"
.br
.br
51 52 53 54 55 56
.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)