File: PAPI_num_events.3

package info (click to toggle)
papi 5.3.2-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 27,244 kB
  • ctags: 37,740
  • sloc: ansic: 384,780; makefile: 3,319; fortran: 3,306; xml: 2,460; sh: 791; python: 515; perl: 269; asm: 24
file content (63 lines) | stat: -rw-r--r-- 1,368 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.TH "PAPI_num_events" 3 "Mon Jun 30 2014" "Version 5.3.2.0" "PAPI" \" -*- nroff -*-
.ad l
.nh
.SH NAME
PAPI_num_events \- 
.PP
Return the number of events in an event set\&.  

.SH SYNOPSIS
.br
.PP
.SH "Detailed Description"
.PP 
\fBPAPI_num_events()\fP returns the number of preset and/or native events contained in an event set\&. The event set should be created by \fBPAPI_create_eventset\fP \&.
.PP
\fBC Interface:\fP
.RS 4
#include <\fBpapi\&.h\fP> 
.br
 int \fBPAPI_num_events(int  EventSet )\fP;
.RE
.PP
\fBParameters:\fP
.RS 4
\fIEventSet\fP -- an integer handle for a PAPI event set created by \fBPAPI_create_eventset\fP\&. 
.br
\fI*count\fP -- (Fortran only) On output the variable contains the number of events in the event set
.RE
.PP
\fBReturn values:\fP
.RS 4
\fIOn\fP success, this function returns the positive number of events in the event set\&. 
.br
\fIPAPI_EINVAL\fP The event count is zero; only if code is compiled with debug enabled\&. 
.br
\fIPAPI_ENOEVST\fP The EventSet specified does not exist\&.
.RE
.PP
\fBExample\fP
.RS 4

.PP
.nf
* // Count the events in our EventSet 
* printf(\"%d events found in EventSet\&.\\n\", PAPI_num_events(EventSet));
* 

.fi
.PP
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBPAPI_add_event\fP 
.PP
\fBPAPI_create_eventset\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for PAPI from the source code\&.