Blame man/man3/PAPI_accum.3

Packit 577717
.TH "PAPI_accum" 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_accum \- 
Packit 577717
.PP
Packit 577717
Accumulate and reset counters in an EventSet\&.  
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
.nf
Packit 577717
@par C Interface:
Packit 577717
\#include <papi.h> @n
Packit 577717
int PAPI_accum( int  EventSet, long_long * values );
Packit 577717
Packit 577717
These calls assume an initialized PAPI library and a properly added event set. 
Packit 577717
PAPI_accum adds the counters of the indicated event set into the array values. 
Packit 577717
The counters are zeroed and continue counting after the operation.
Packit 577717
Note the differences between PAPI_read and PAPI_accum, specifically 
Packit 577717
that PAPI_accum resets the values array to zero. 
Packit 577717
Packit 577717
@param EventSet
Packit 577717
    an integer handle for a PAPI Event Set 
Packit 577717
    as created by PAPI_create_eventset
Packit 577717
@param *values 
Packit 577717
    an array to hold the counter values of the counting events 
Packit 577717
Packit 577717
@retval PAPI_EINVAL 
Packit 577717
    One or more of the arguments is invalid.
Packit 577717
@retval PAPI_ESYS 
Packit 577717
    A system or C library call failed inside PAPI, see the errno variable.
Packit 577717
@retval PAPI_ENOEVST 
Packit 577717
    The event set specified does not exist. 
Packit 577717
Packit 577717
@par Examples:
Packit 577717
Packit 577717
.fi
Packit 577717
.PP
Packit 577717
 
Packit 577717
.PP
Packit 577717
.nf
Packit 577717
*   do_100events( );
Packit 577717
*   if ( PAPI_read( EventSet, values) != PAPI_OK )
Packit 577717
*   handle_error( 1 );
Packit 577717
*   // values[0] now equals 100
Packit 577717
*   do_100events( );
Packit 577717
*   if (PAPI_accum( EventSet, values ) != PAPI_OK )
Packit 577717
*   handle_error( 1 );
Packit 577717
*   // values[0] now equals 200
Packit 577717
*   values[0] = -100;
Packit 577717
*   do_100events( );
Packit 577717
*   if (PAPI_accum( EventSet, values ) != PAPI_OK )
Packit 577717
*   handle_error( 1 );
Packit 577717
*   // values[0] now equals 0
Packit 577717
*   
Packit 577717
Packit 577717
.fi
Packit 577717
.PP
Packit 577717
.PP
Packit 577717
\fBSee Also:\fP
Packit 577717
.RS 4
Packit 577717
\fBPAPIF_accum\fP 
Packit 577717
.PP
Packit 577717
\fBPAPI_start\fP 
Packit 577717
.PP
Packit 577717
\fBPAPI_set_opt\fP 
Packit 577717
.PP
Packit 577717
\fBPAPI_reset\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\&.