Debian Codegraph @

doc/doxygen-doc/html/a00194.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
3 <head>
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
6 <meta name="generator" content="Doxygen 1.15.0"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>Hardware Locality (hwloc): Remove distances between objects</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <script type="text/javascript" src="clipboard.js"></script>
13 <link href="doxygen.css" rel="stylesheet" type="text/css" />
14 </head>
15 <body>
16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
17 <div id="titlearea">
18 <table cellspacing="0" cellpadding="0">
19 <tbody>
20 <tr id="projectrow">
21 <td id="projectalign">
22 <div id="projectname">Hardware Locality (hwloc)<span id="projectnumber">&#160;2.14.0</span>
23 </div>
24 </td>
25 </tr>
26 </tbody>
27 </table>
28 </div>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.15.0 -->
31 <script type="text/javascript">
32 $(function() { codefold.init(); });
33 </script>
34 <script type="text/javascript" src="menudata.js"></script>
35 <script type="text/javascript" src="menu.js"></script>
36 <script type="text/javascript">
37 $(function() {
38 initMenu('',false,false,'search.php','Search',false);
39 });
40 </script>
41 <div id="main-nav"></div>
42 </div><!-- top -->
43 <div id="doc-content">
44 <div class="header">
45 <div class="summary">
46 <a href="#func-members">Functions</a> </div>
47 <div class="headertitle"><div class="title">Remove distances between objects </div></div>
48 </div><!--header-->
49 <div class="contents">
50 <table class="memberdecls">
51 <tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
52 Functions</h2></td></tr>
53 <tr class="memitem:gac188d9b64d9560255ce5f6d0a20f9c0a" id="r_gac188d9b64d9560255ce5f6d0a20f9c0a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gac188d9b64d9560255ce5f6d0a20f9c0a">hwloc_distances_remove</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology)</td></tr>
54 <tr class="memitem:gaa642a4c1a21c84f38ae23fca8a27845d" id="r_gaa642a4c1a21c84f38ae23fca8a27845d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaa642a4c1a21c84f38ae23fca8a27845d">hwloc_distances_remove_by_depth</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, int depth)</td></tr>
55 <tr class="memitem:gaf8515586661b32fd615d3dd0163612f3" id="r_gaf8515586661b32fd615d3dd0163612f3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#gaf8515586661b32fd615d3dd0163612f3">hwloc_distances_remove_by_type</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
56 <tr class="memitem:ga80bbf6f0db9af48c61780dd5152664c2" id="r_ga80bbf6f0db9af48c61780dd5152664c2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ga80bbf6f0db9af48c61780dd5152664c2">hwloc_distances_release_remove</a> (<a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, struct <a class="el" href="a00296.html">hwloc_distances_s</a> *distances)</td></tr>
57 </table>
58 <a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
59 <a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
60 <a id="ga80bbf6f0db9af48c61780dd5152664c2" name="ga80bbf6f0db9af48c61780dd5152664c2"></a>
61 <h2 class="memtitle"><span class="permalink"><a href="#ga80bbf6f0db9af48c61780dd5152664c2">&#9670;&#160;</a></span>hwloc_distances_release_remove()</h2>
62
63 <div class="memitem">
64 <div class="memproto">
65 <table class="memname">
66 <tr>
67 <td class="memname">int hwloc_distances_release_remove </td>
68 <td>(</td>
69 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
70 </tr>
71 <tr>
72 <td class="paramkey"></td>
73 <td></td>
74 <td class="paramtype">struct <a class="el" href="a00296.html">hwloc_distances_s</a> *</td> <td class="paramname"><span class="paramname"><em>distances</em></span>&#160;)</td>
75 </tr>
76 </table>
77 </div><div class="memdoc">
78
79 <p>Release and remove the given distance matrice from the topology. </p>
80 <p>This function includes a call to <a class="el" href="a00191.html#ga1dd78c1f9acd54f26aba0e284e97e51d" title="Release a distance matrix structure previously returned by hwloc_distances_get().">hwloc_distances_release()</a>.</p>
81 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
82
83 </div>
84 </div>
85 <a id="gac188d9b64d9560255ce5f6d0a20f9c0a" name="gac188d9b64d9560255ce5f6d0a20f9c0a"></a>
86 <h2 class="memtitle"><span class="permalink"><a href="#gac188d9b64d9560255ce5f6d0a20f9c0a">&#9670;&#160;</a></span>hwloc_distances_remove()</h2>
87
88 <div class="memitem">
89 <div class="memproto">
90 <table class="memname">
91 <tr>
92 <td class="memname">int hwloc_distances_remove </td>
93 <td>(</td>
94 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span></td><td>)</td>
95 <td></td>
96 </tr>
97 </table>
98 </div><div class="memdoc">
99
100 <p>Remove all distance matrices from a topology. </p>
101 <p>Remove all distance matrices, either provided by the user or gathered through the OS.</p>
102 <p>If these distances were used to group objects, these additional Group objects are not removed from the topology.</p>
103 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
104
105 </div>
106 </div>
107 <a id="gaa642a4c1a21c84f38ae23fca8a27845d" name="gaa642a4c1a21c84f38ae23fca8a27845d"></a>
108 <h2 class="memtitle"><span class="permalink"><a href="#gaa642a4c1a21c84f38ae23fca8a27845d">&#9670;&#160;</a></span>hwloc_distances_remove_by_depth()</h2>
109
110 <div class="memitem">
111 <div class="memproto">
112 <table class="memname">
113 <tr>
114 <td class="memname">int hwloc_distances_remove_by_depth </td>
115 <td>(</td>
116 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
117 </tr>
118 <tr>
119 <td class="paramkey"></td>
120 <td></td>
121 <td class="paramtype">int</td> <td class="paramname"><span class="paramname"><em>depth</em></span>&#160;)</td>
122 </tr>
123 </table>
124 </div><div class="memdoc">
125
126 <p>Remove distance matrices for objects at a specific depth in the topology. </p>
127 <p>Identical to <a class="el" href="#gac188d9b64d9560255ce5f6d0a20f9c0a" title="Remove all distance matrices from a topology.">hwloc_distances_remove()</a> but only applies to one level of the topology.</p>
128 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
129
130 </div>
131 </div>
132 <a id="gaf8515586661b32fd615d3dd0163612f3" name="gaf8515586661b32fd615d3dd0163612f3"></a>
133 <h2 class="memtitle"><span class="permalink"><a href="#gaf8515586661b32fd615d3dd0163612f3">&#9670;&#160;</a></span>hwloc_distances_remove_by_type()</h2>
134
135 <div class="memitem">
136 <div class="memproto">
137 <table class="mlabels">
138 <tr>
139 <td class="mlabels-left">
140 <table class="memname">
141 <tr>
142 <td class="memname">int hwloc_distances_remove_by_type </td>
143 <td>(</td>
144 <td class="paramtype"><a class="el" href="a00169.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></td> <td class="paramname"><span class="paramname"><em>topology</em></span>, </td>
145 </tr>
146 <tr>
147 <td class="paramkey"></td>
148 <td></td>
149 <td class="paramtype"><a class="el" href="a00167.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>&#160;)</td>
150 </tr>
151 </table>
152 </td>
153 <td class="mlabels-right">
154 <span class="mlabels"><span class="mlabel inline">inline</span></span> </td>
155 </tr>
156 </table>
157 </div><div class="memdoc">
158
159 <p>Remove distance matrices for objects of a specific type in the topology. </p>
160 <p>Identical to <a class="el" href="#gac188d9b64d9560255ce5f6d0a20f9c0a" title="Remove all distance matrices from a topology.">hwloc_distances_remove()</a> but only applies to one level of the topology.</p>
161 <dl class="section return"><dt>Returns</dt><dd>0 on success, -1 on error. </dd></dl>
162
163 </div>
164 </div>
165 </div><!-- contents -->
166 <!-- start footer part -->
167 <hr class="footer"/><address class="footer"><small>
168 Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0
169 </small></address>
170 </div><!-- doc-content -->
171 </body>
172 </html>