Blame man/man3/PAPI_flops.3

Packit 577717
.TH "PAPI_flops" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-
Packit 577717
.ad l
Packit 577717
.nh
Packit 577717
.SH NAME
Packit 577717
PAPI_flops \- 
Packit 577717
.PP
Packit 577717
Simplified call to get Mflops/s (floating point operation rate), real and processor time\&.  
Packit 577717
Packit 577717
.SH SYNOPSIS
Packit 577717
.br
Packit 577717
.PP
Packit 577717
.SH "Detailed Description"
Packit 577717
.PP 
Packit 577717
Packit 577717
.PP
Packit 577717
\fBC Interface: \fP
Packit 577717
.RS 4
Packit 577717
#include <\fBpapi\&.h\fP> 
Packit 577717
.br
Packit 577717
int \fBPAPI_flops( float *rtime, float *ptime, long long *flpops, float *mflops )\fP;
Packit 577717
.RE
Packit 577717
.PP
Packit 577717
\fBParameters:\fP
Packit 577717
.RS 4
Packit 577717
\fI*rtime\fP total realtime since the first call 
Packit 577717
.br
Packit 577717
\fI*ptime\fP total process time since the first call 
Packit 577717
.br
Packit 577717
\fI*flpops\fP total floating point operations since the first call 
Packit 577717
.br
Packit 577717
\fI*mflops\fP incremental (Mega) floating point operations per seconds since the last call
Packit 577717
.RE
Packit 577717
.PP
Packit 577717
\fBReturn values:\fP
Packit 577717
.RS 4
Packit 577717
\fIPAPI_EINVAL\fP The counters were already started by something other than \fBPAPI_flops()\fP\&. 
Packit 577717
.br
Packit 577717
\fIPAPI_ENOEVNT\fP The floating point operations event does not exist\&. 
Packit 577717
.br
Packit 577717
\fIPAPI_ENOMEM\fP Insufficient memory to complete the operation\&.
Packit 577717
.RE
Packit 577717
.PP
Packit 577717
The first call to \fBPAPI_flops()\fP will initialize the PAPI High Level interface, set up the counters to monitor the PAPI_FP_OPS event and start the counters\&.
Packit 577717
.PP
Packit 577717
Subsequent calls will read the counters and return total real time, total process time, total floating point operations since the start of the measurement and the Mflop/s rate since latest call to \fBPAPI_flops()\fP\&. A call to \fBPAPI_stop_counters()\fP will stop the counters from running and then calls such as \fBPAPI_start_counters()\fP or other rate calls can safely be used\&.
Packit 577717
.PP
Packit 577717
\fBPAPI_flops\fP returns information related to theoretical floating point operations rather than simple instructions\&. It uses the PAPI_FP_OPS event which attempts to 'correctly' account for, e\&.g\&., FMA undercounts and FP Store overcounts, etc\&.
Packit 577717
.PP
Packit 577717
\fBSee Also:\fP
Packit 577717
.RS 4
Packit 577717
\fBPAPI_flips()\fP 
Packit 577717
.PP
Packit 577717
\fBPAPI_ipc()\fP 
Packit 577717
.PP
Packit 577717
\fBPAPI_epc()\fP 
Packit 577717
.PP
Packit 577717
\fBPAPI_stop_counters()\fP 
Packit 577717
.RE
Packit 577717
.PP
Packit 577717
Packit 577717
Packit 577717
.SH "Author"
Packit 577717
.PP 
Packit 577717
Generated automatically by Doxygen for PAPI from the source code\&.