File: classNV_1_1Rules_1_1IRange.html

package info (click to toggle)
nvidia-cuda-toolkit 11.8.0-5~deb12u1
  • links: PTS, VCS
  • area: non-free
  • in suites: bookworm
  • size: 18,338,396 kB
  • sloc: ansic: 172,472; cpp: 57,058; javascript: 21,597; python: 12,656; xml: 12,438; makefile: 2,949; sh: 2,056; perl: 352
file content (121 lines) | stat: -rw-r--r-- 6,248 bytes parent folder | download | duplicates (3)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>NvRulesAPI: NV::Rules::IRange Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><b>NV</b>::<b>Rules</b>::<a class="el" href="classNV_1_1Rules_1_1IRange.html">IRange</a>
  </div>
</div>
<div class="contents">
<h1>NV::Rules::IRange Class Reference<br>
<small>
[<a class="el" href="group__NVRULES__LW.html">NvRules Python garbage-collected classes.</a>]</small>
</h1><!-- doxytag: class="NV::Rules::IRange" -->Range interface.  
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual PYRETURN <a class="el" href="classNV_1_1Rules_1_1IAction.html">IAction</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IRange.html#26f2a2901fc90e9671c9d3b914bb5776">action_by_idx</a> (size_t idx)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a single action by index.  <a href="#26f2a2901fc90e9671c9d3b914bb5776"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual std::set&lt; long long <br class="typebreak">
unsigned &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IRange.html#459409276362a834eb5f3862b5706e18">actions_by_nvtx</a> (const std::vector&lt; std::string &gt; &amp;includes, const std::vector&lt; std::string &gt; &amp;excludes)=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a set of actions by their NVTX state.  <a href="#459409276362a834eb5f3862b5706e18"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual size_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNV_1_1Rules_1_1IRange.html#2a39ea86c47d1408ad590b917b513ab8">num_actions</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the number of actions.  <a href="#2a39ea86c47d1408ad590b917b513ab8"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a serial, ordered stream of execution, such as a CUDA stream. It holds one or more actions that were logically executing in this range <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="26f2a2901fc90e9671c9d3b914bb5776"></a><!-- doxytag: member="NV::Rules::IRange::action_by_idx" ref="26f2a2901fc90e9671c9d3b914bb5776" args="(size_t idx)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual PYRETURN <a class="el" href="classNV_1_1Rules_1_1IAction.html">IAction</a>* NV::Rules::IRange::action_by_idx           </td>
          <td>(</td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>idx</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a single <a class="el" href="classNV_1_1Rules_1_1IAction.html" title="Action interface.">IAction</a> by index <code>idx</code>. 
</div>
</div><p>
<a class="anchor" name="459409276362a834eb5f3862b5706e18"></a><!-- doxytag: member="NV::Rules::IRange::actions_by_nvtx" ref="459409276362a834eb5f3862b5706e18" args="(const std::vector&lt; std::string &gt; &amp;includes, const std::vector&lt; std::string &gt; &amp;excludes)=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual std::set&lt;long long unsigned&gt; NV::Rules::IRange::actions_by_nvtx           </td>
          <td>(</td>
          <td class="paramtype">const std::vector&lt; std::string &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>includes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::vector&lt; std::string &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>excludes</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a set of indizes to <a class="el" href="classNV_1_1Rules_1_1IAction.html" title="Action interface.">IAction</a> objects by their NVTX state. The state is defined using a series of <code>includes</code> and <code>excludes</code> . 
</div>
</div><p>
<a class="anchor" name="2a39ea86c47d1408ad590b917b513ab8"></a><!-- doxytag: member="NV::Rules::IRange::num_actions" ref="2a39ea86c47d1408ad590b917b513ab8" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual size_t NV::Rules::IRange::num_actions           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the number of available actions in this range 
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 24 21:21:30 2022 for NvRulesAPI by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>