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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>2.1.3. NvRules non-member functions. — NsightCompute 12.4 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/design-style.b7bb847fb20b106c3d81b95245e65545.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/omni-style.css" type="text/css" />
<link rel="stylesheet" href="../_static/api-styles.css" type="text/css" />
<link rel="shortcut icon" href="../_static/nsight-compute.ico"/>
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/mermaid-init.js"></script>
<script src="../_static/design-tabs.js"></script>
<script src="../_static/version.js"></script>
<script src="../_static/social-media.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="2.2. Data Structures" href="data-structures.html" />
<link rel="prev" title="2.1.2. NvRules Tool lifetime-managed classes." href="group__NVRULES__HW.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html">
<img src="../_static/nsight-compute.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Nsight Compute</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../ReleaseNotes/index.html">1. Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../ProfilingGuide/index.html">2. Kernel Profiling Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../NsightCompute/index.html">3. Nsight Compute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../NsightComputeCli/index.html">4. Nsight Compute CLI</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Developer Interfaces</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../CustomizationGuide/index.html">1. Customization Guide</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../NvRulesAPI/index.html">2. NvRules API</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="modules.html">2.1. Modules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="group__NVRULES__LW.html">2.1.1. NvRules Python garbage-collected classes.</a></li>
<li class="toctree-l3"><a class="reference internal" href="group__NVRULES__HW.html">2.1.2. NvRules Tool lifetime-managed classes.</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">2.1.3. NvRules non-member functions.</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#functions">Functions</a></li>
<li class="toctree-l4"><a class="reference internal" href="#typedefs">Typedefs</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="data-structures.html">2.2. Data Structures</a></li>
<li class="toctree-l2"><a class="reference internal" href="namespaces.html">2.3. Namespaces</a></li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Training</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Training/index.html">Training</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Release Information</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../Archives/index.html">Archives</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Copyright and Licenses</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../CopyrightAndLicenses/index.html">Copyright and Licenses</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">NsightCompute</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home"></a> »</li>
<li><a href="../NvRulesAPI/index.html"><span class="section-number">2. </span>NvRules API</a> »</li>
<li><a href="modules.html"><span class="section-number">2.1. </span>Modules</a> »</li>
<li><span class="section-number">2.1.3. </span>NvRules non-member functions.</li>
<li class="wy-breadcrumbs-aside">
</li>
<li class="wy-breadcrumbs-aside">
<span>v2024.1.1 |</span>
<a href="https://developer.nvidia.com/nsight-compute-history" class="reference external">Archive</a>
<span> </span>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="nvrules-non-member-functions">
<h1><span class="section-number">2.1.3. </span>NvRules non-member functions.<a class="headerlink" href="#nvrules-non-member-functions" title="Permalink to this headline"></a></h1>
<p id="group__nvrules__nm">Non-member utility functions. </p>
<p class="rubric-h4 rubric">Functions</p>
<ul class="simple">
<li><p><a class="reference internal" href="#group__nvrules__nm_1ga3d82ff6567894725acca3fd61efc935c"><span class="std std-ref">NV::Rules::get_context(ContextHandle h)</span></a>: Converts the context handle.</p></li>
<li><p><a class="reference internal" href="#group__nvrules__nm_1ga4f5ee5a7e299a8aa4d4fe881f399701a"><span class="std std-ref">NV::Rules::get_evaluator(ContextHandle h)</span></a>: Returns the evaluator object.</p></li>
<li><p><a class="reference internal" href="#group__nvrules__nm_1ga9dce07e8e99cf88e06a47095d9515522"><span class="std std-ref">NV::Rules::get_version(ContextHandle h)</span></a>: Get version number of this interface.</p></li>
<li><p><a class="reference internal" href="#group__nvrules__nm_1gaeaa0d437069f2fcc2313627f99338d7e"><span class="std std-ref">NV::Rules::raise_exception(ContextHandle h, const char *msg)</span></a>: Raises a python exception.</p></li>
</ul>
<p class="rubric-h4 rubric">Typedefs</p>
<ul class="simple">
<li><p><a class="reference internal" href="#group__nvrules__nm_1gae802c5504a360245d55b7a8582ce27f2"><span class="std std-ref">NV::Rules::ContextHandle</span></a></p></li>
</ul>
<section id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline"></a></h2>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules11get_contextE13ContextHandle">
<span id="_CPPv3N2NV5Rules11get_contextE13ContextHandle"></span><span id="_CPPv2N2NV5Rules11get_contextE13ContextHandle"></span><span id="NV::Rules::get_context__ContextHandle"></span><span class="target" id="group__nvrules__nm_1ga3d82ff6567894725acca3fd61efc935c"></span><a class="reference internal" href="classNV_1_1Rules_1_1IContext.html#_CPPv4N2NV5Rules8IContextE" title="NV::Rules::IContext"><span class="n"><span class="pre">IContext</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-prename descclassname"><a class="reference internal" href="namespaceNV.html#_CPPv42NV" title="NV"><span class="n"><span class="pre">NV</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="namespaceNV_1_1Rules.html#_CPPv4N2NV5RulesE" title="NV::Rules"><span class="n"><span class="pre">Rules</span></span></a><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">get_context</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N2NV5Rules13ContextHandleE" title="NV::Rules::ContextHandle"><span class="n"><span class="pre">ContextHandle</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">h</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N2NV5Rules11get_contextE13ContextHandle" title="Permalink to this definition"></a><br /></dt>
<dd><p>Converts the context handle. </p>
<p>Converts the context handle <code class="docutils literal notranslate"><span class="pre">h</span></code> to an IContext object </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules13get_evaluatorE13ContextHandle">
<span id="_CPPv3N2NV5Rules13get_evaluatorE13ContextHandle"></span><span id="_CPPv2N2NV5Rules13get_evaluatorE13ContextHandle"></span><span id="NV::Rules::get_evaluator__ContextHandle"></span><span class="target" id="group__nvrules__nm_1ga4f5ee5a7e299a8aa4d4fe881f399701a"></span><a class="reference internal" href="classNV_1_1Rules_1_1IEvaluator.html#_CPPv4N2NV5Rules10IEvaluatorE" title="NV::Rules::IEvaluator"><span class="n"><span class="pre">IEvaluator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-prename descclassname"><a class="reference internal" href="namespaceNV.html#_CPPv42NV" title="NV"><span class="n"><span class="pre">NV</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="namespaceNV_1_1Rules.html#_CPPv4N2NV5RulesE" title="NV::Rules"><span class="n"><span class="pre">Rules</span></span></a><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">get_evaluator</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N2NV5Rules13ContextHandleE" title="NV::Rules::ContextHandle"><span class="n"><span class="pre">ContextHandle</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">h</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N2NV5Rules13get_evaluatorE13ContextHandle" title="Permalink to this definition"></a><br /></dt>
<dd><p>Returns the evaluator object. </p>
<p>Return the IEvaluator object from the context handle <code class="docutils literal notranslate"><span class="pre">h</span></code> </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules11get_versionE13ContextHandle">
<span id="_CPPv3N2NV5Rules11get_versionE13ContextHandle"></span><span id="_CPPv2N2NV5Rules11get_versionE13ContextHandle"></span><span id="NV::Rules::get_version__ContextHandle"></span><span class="target" id="group__nvrules__nm_1ga9dce07e8e99cf88e06a47095d9515522"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="sig-prename descclassname"><a class="reference internal" href="namespaceNV.html#_CPPv42NV" title="NV"><span class="n"><span class="pre">NV</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="namespaceNV_1_1Rules.html#_CPPv4N2NV5RulesE" title="NV::Rules"><span class="n"><span class="pre">Rules</span></span></a><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">get_version</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N2NV5Rules13ContextHandleE" title="NV::Rules::ContextHandle"><span class="n"><span class="pre">ContextHandle</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">h</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N2NV5Rules11get_versionE13ContextHandle" title="Permalink to this definition"></a><br /></dt>
<dd><p>Get version number of this interface. </p>
<p>Returns the version number of this interface as a string of the form <year>.<major>.<minor> It matches the Nsight Compute version this interface originates from. </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules15raise_exceptionE13ContextHandlePKc">
<span id="_CPPv3N2NV5Rules15raise_exceptionE13ContextHandlePKc"></span><span id="_CPPv2N2NV5Rules15raise_exceptionE13ContextHandlePKc"></span><span id="NV::Rules::raise_exception__ContextHandle.cCP"></span><span class="target" id="group__nvrules__nm_1gaeaa0d437069f2fcc2313627f99338d7e"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-prename descclassname"><a class="reference internal" href="namespaceNV.html#_CPPv42NV" title="NV"><span class="n"><span class="pre">NV</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="namespaceNV_1_1Rules.html#_CPPv4N2NV5RulesE" title="NV::Rules"><span class="n"><span class="pre">Rules</span></span></a><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">raise_exception</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N2NV5Rules13ContextHandleE" title="NV::Rules::ContextHandle"><span class="n"><span class="pre">ContextHandle</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">h</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">msg</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N2NV5Rules15raise_exceptionE13ContextHandlePKc" title="Permalink to this definition"></a><br /></dt>
<dd><p>Raises a python exception. </p>
<p>Raise a python exception with <code class="docutils literal notranslate"><span class="pre">msg</span></code>. This will terminate the script execution, if the context does not chose to mask the exception </p>
</dd></dl>
</section>
<section id="typedefs">
<h2>Typedefs<a class="headerlink" href="#typedefs" title="Permalink to this headline"></a></h2>
<dl class="cpp type">
<dt class="sig sig-object cpp" id="_CPPv4N2NV5Rules13ContextHandleE">
<span id="_CPPv3N2NV5Rules13ContextHandleE"></span><span id="_CPPv2N2NV5Rules13ContextHandleE"></span><span id="NV::Rules::ContextHandle"></span><span class="target" id="group__nvrules__nm_1gae802c5504a360245d55b7a8582ce27f2"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="sig-prename descclassname"><a class="reference internal" href="namespaceNV.html#_CPPv42NV" title="NV"><span class="n"><span class="pre">NV</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="namespaceNV_1_1Rules.html#_CPPv4N2NV5RulesE" title="NV::Rules"><span class="n"><span class="pre">Rules</span></span></a><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">ContextHandle</span></span></span><a class="headerlink" href="#_CPPv4N2NV5Rules13ContextHandleE" title="Permalink to this definition"></a><br /></dt>
<dd></dd></dl>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2018-2024, NVIDIA Corporation & Affiliates. All rights reserved.
<span class="lastupdated">Last updated on Mar 06, 2024.
</span></p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
