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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Hardware Locality (hwloc): distances.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Hardware Locality (hwloc)
 <span id="projectnumber">2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_5cb306d949c7931a3b6c77517393dd34.html">hwloc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">distances.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright © 2010-2020 Inria. All rights reserved.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * See COPYING in top-level directory.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#ifndef HWLOC_DISTANCES_H</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define HWLOC_DISTANCES_H</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef HWLOC_H</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#error Please include the main hwloc.h instead</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#elif 0</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> }</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="a00316.html"> 42</a></span> <span class="keyword">struct </span><a class="code" href="a00316.html">hwloc_distances_s</a> {</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="a00316.html#a4ca2af858cebbce7324ec49903d09474"> 43</a></span>  <span class="keywordtype">unsigned</span> <a class="code" href="a00316.html#a4ca2af858cebbce7324ec49903d09474">nbobjs</a>; </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="a00316.html#af1e78b2d628d191fa6cae3fbfe891078"> 44</a></span>  <a class="code" href="a00244.html">hwloc_obj_t</a> *<a class="code" href="a00316.html#af1e78b2d628d191fa6cae3fbfe891078">objs</a>; </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="a00316.html#aef9c83cf467da1b1fa4c36493febb3b5"> 49</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="a00316.html#aef9c83cf467da1b1fa4c36493febb3b5">kind</a>; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="a00316.html#ae43e19b2c743de05c93d71a30beaca75"> 50</a></span>  hwloc_uint64_t *<a class="code" href="a00316.html#ae43e19b2c743de05c93d71a30beaca75">values</a>; </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> };</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="a00214.html#gab1bb10d3adb85b52cdc6fe5a7f74f108"> 68</a></span> <span class="keyword">enum</span> <a class="code" href="a00214.html#gab1bb10d3adb85b52cdc6fe5a7f74f108">hwloc_distances_kind_e</a> {</div>
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a90dc38248c8d5392d4dd3e88f391e984"> 72</a></span>  <a class="code" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a90dc38248c8d5392d4dd3e88f391e984">HWLOC_DISTANCES_KIND_FROM_OS</a> = (1UL<<0),</div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a0148d7f9be833a04f5a55455437c227b"> 76</a></span>  <a class="code" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a0148d7f9be833a04f5a55455437c227b">HWLOC_DISTANCES_KIND_FROM_USER</a> = (1UL<<1),</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108afd6a3503fbc8f7c1a31235373cefc4c6"> 84</a></span>  <a class="code" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108afd6a3503fbc8f7c1a31235373cefc4c6">HWLOC_DISTANCES_KIND_MEANS_LATENCY</a> = (1UL<<2),</div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a41b19f141a3c0ffe85f9affaca4b0293"> 91</a></span>  <a class="code" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a41b19f141a3c0ffe85f9affaca4b0293">HWLOC_DISTANCES_KIND_MEANS_BANDWIDTH</a> = (1UL<<3),</div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108aa6cf2b6dfcf148b65952f811814efbe1">HWLOC_DISTANCES_KIND_HETEROGENEOUS_TYPES</a> = (1UL<<4)</div>
<div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108aa6cf2b6dfcf148b65952f811814efbe1"> 97</a></span> };</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="a00214.html#ga613e6b2a5d0f06626ee8d0c12fa46691"> 123</a></span> <a class="code" href="a00214.html#ga613e6b2a5d0f06626ee8d0c12fa46691">hwloc_distances_get</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keywordtype">unsigned</span> *nr, <span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> **distances,</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> kind, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"><a class="line" href="a00214.html#ga5d1d35eccfcc2ebcef71a10972ce9b03"> 132</a></span> <a class="code" href="a00214.html#ga5d1d35eccfcc2ebcef71a10972ce9b03">hwloc_distances_get_by_depth</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <span class="keywordtype">int</span> depth,</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keywordtype">unsigned</span> *nr, <span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> **distances,</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> kind, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"><a class="line" href="a00214.html#gaaa6bfbc20072a4f4de132eec859067f6"> 141</a></span> <a class="code" href="a00214.html#gaaa6bfbc20072a4f4de132eec859067f6">hwloc_distances_get_by_type</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="code" href="a00190.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type,</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keywordtype">unsigned</span> *nr, <span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> **distances,</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> kind, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> HWLOC_DECLSPEC <span class="keywordtype">int</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="a00214.html#gaa457f35b8745ca41ec17797c0d7b20f0"> 152</a></span> <a class="code" href="a00214.html#gaa457f35b8745ca41ec17797c0d7b20f0">hwloc_distances_get_by_name</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <span class="keyword">const</span> <span class="keywordtype">char</span> *name,</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">unsigned</span> *nr, <span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> **distances,</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> HWLOC_DECLSPEC <span class="keyword">const</span> <span class="keywordtype">char</span> *</div>
<div class="line"><a name="l00162"></a><span class="lineno"><a class="line" href="a00214.html#gaa6f9697028c589cef0458edef5fe273f"> 162</a></span> <a class="code" href="a00214.html#gaa6f9697028c589cef0458edef5fe273f">hwloc_distances_get_name</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> *distances);</div>
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  </div>
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> HWLOC_DECLSPEC <span class="keywordtype">void</span></div>
<div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="a00214.html#ga1dd78c1f9acd54f26aba0e284e97e51d"> 169</a></span> <a class="code" href="a00214.html#ga1dd78c1f9acd54f26aba0e284e97e51d">hwloc_distances_release</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> *distances);</div>
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  </div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="keyword">static</span> __hwloc_inline <span class="keywordtype">int</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"><a class="line" href="a00215.html#gab9e770c7d56c5d6040f26bd1dc8854cd"> 184</a></span> <a class="code" href="a00215.html#gab9e770c7d56c5d6040f26bd1dc8854cd">hwloc_distances_obj_index</a>(<span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> *distances, <a class="code" href="a00244.html">hwloc_obj_t</a> obj)</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span> {</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">unsigned</span> i;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  <span class="keywordflow">for</span>(i=0; i<distances-><a class="code" href="a00316.html#a4ca2af858cebbce7324ec49903d09474">nbobjs</a>; i++)</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="keywordflow">if</span> (distances-><a class="code" href="a00316.html#af1e78b2d628d191fa6cae3fbfe891078">objs</a>[i] == obj)</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="keywordflow">return</span> (<span class="keywordtype">int</span>)i;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> }</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  </div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="keyword">static</span> __hwloc_inline <span class="keywordtype">int</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"><a class="line" href="a00215.html#ga3c665b23056e3269f777b21a67148c82"> 201</a></span> <a class="code" href="a00215.html#ga3c665b23056e3269f777b21a67148c82">hwloc_distances_obj_pair_values</a>(<span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> *distances,</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <a class="code" href="a00244.html">hwloc_obj_t</a> obj1, <a class="code" href="a00244.html">hwloc_obj_t</a> obj2,</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> {</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="keywordtype">int</span> i1 = <a class="code" href="a00215.html#gab9e770c7d56c5d6040f26bd1dc8854cd">hwloc_distances_obj_index</a>(distances, obj1);</div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="keywordtype">int</span> i2 = <a class="code" href="a00215.html#gab9e770c7d56c5d6040f26bd1dc8854cd">hwloc_distances_obj_index</a>(distances, obj2);</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="keywordflow">if</span> (i1 < 0 || i2 < 0)</div>
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keywordflow">return</span> -1;</div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  *value1to2 = distances-><a class="code" href="a00316.html#ae43e19b2c743de05c93d71a30beaca75">values</a>[i1 * distances-><a class="code" href="a00316.html#a4ca2af858cebbce7324ec49903d09474">nbobjs</a> + i2];</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  *value2to1 = distances-><a class="code" href="a00316.html#ae43e19b2c743de05c93d71a30beaca75">values</a>[i2 * distances-><a class="code" href="a00316.html#a4ca2af858cebbce7324ec49903d09474">nbobjs</a> + i1];</div>
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> }</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  </div>
<div class="line"><a name="l00223"></a><span class="lineno"><a class="line" href="a00216.html#ga22428b6bab271411e3834e6b4ca22e37"> 223</a></span> <span class="keyword">enum</span> <a class="code" href="a00216.html#ga22428b6bab271411e3834e6b4ca22e37">hwloc_distances_add_flag_e</a> {</div>
<div class="line"><a name="l00227"></a><span class="lineno"><a class="line" href="a00216.html#gga22428b6bab271411e3834e6b4ca22e37a7f6baba797d70538d03c9d13052c62ab"> 227</a></span>  <a class="code" href="a00216.html#gga22428b6bab271411e3834e6b4ca22e37a7f6baba797d70538d03c9d13052c62ab">HWLOC_DISTANCES_ADD_FLAG_GROUP</a> = (1UL<<0),</div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  <a class="code" href="a00216.html#gga22428b6bab271411e3834e6b4ca22e37a5233ccf631c3bc53dd5c3e7a5d5c9b77">HWLOC_DISTANCES_ADD_FLAG_GROUP_INACCURATE</a> = (1UL<<1)</div>
<div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="a00216.html#gga22428b6bab271411e3834e6b4ca22e37a5233ccf631c3bc53dd5c3e7a5d5c9b77"> 234</a></span> };</div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  </div>
<div class="line"><a name="l00250"></a><span class="lineno"><a class="line" href="a00216.html#gac5a71d96cd86efe31d6f8d282aae3d97"> 250</a></span> HWLOC_DECLSPEC <span class="keywordtype">int</span> <a class="code" href="a00216.html#gac5a71d96cd86efe31d6f8d282aae3d97">hwloc_distances_add</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology,</div>
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  <span class="keywordtype">unsigned</span> nbobjs, <a class="code" href="a00244.html">hwloc_obj_t</a> *objs, hwloc_uint64_t *values,</div>
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> kind, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);</div>
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span>  </div>
<div class="line"><a name="l00262"></a><span class="lineno"><a class="line" href="a00216.html#gac188d9b64d9560255ce5f6d0a20f9c0a"> 262</a></span> HWLOC_DECLSPEC <span class="keywordtype">int</span> <a class="code" href="a00216.html#gac188d9b64d9560255ce5f6d0a20f9c0a">hwloc_distances_remove</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology);</div>
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  </div>
<div class="line"><a name="l00268"></a><span class="lineno"><a class="line" href="a00216.html#gaa642a4c1a21c84f38ae23fca8a27845d"> 268</a></span> HWLOC_DECLSPEC <span class="keywordtype">int</span> <a class="code" href="a00216.html#gaa642a4c1a21c84f38ae23fca8a27845d">hwloc_distances_remove_by_depth</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <span class="keywordtype">int</span> depth);</div>
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span>  </div>
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="keyword">static</span> __hwloc_inline <span class="keywordtype">int</span></div>
<div class="line"><a name="l00275"></a><span class="lineno"><a class="line" href="a00216.html#ga93db53773c96f5b83815e8441e2ebb93"> 275</a></span> <a class="code" href="a00216.html#ga93db53773c96f5b83815e8441e2ebb93">hwloc_distances_remove_by_type</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="code" href="a00190.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</div>
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> {</div>
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span>  <span class="keywordtype">int</span> depth = <a class="code" href="a00193.html#ga8bec782e21be313750da70cf7428b374">hwloc_get_type_depth</a>(topology, type);</div>
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span>  <span class="keywordflow">if</span> (depth == <a class="code" href="a00193.html#ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad">HWLOC_TYPE_DEPTH_UNKNOWN</a> || depth == <a class="code" href="a00193.html#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c">HWLOC_TYPE_DEPTH_MULTIPLE</a>)</div>
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span>  <span class="keywordflow">return</span> 0;</div>
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span>  <span class="keywordflow">return</span> <a class="code" href="a00216.html#gaa642a4c1a21c84f38ae23fca8a27845d">hwloc_distances_remove_by_depth</a>(topology, depth);</div>
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> }</div>
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span>  </div>
<div class="line"><a name="l00287"></a><span class="lineno"><a class="line" href="a00216.html#ga80bbf6f0db9af48c61780dd5152664c2"> 287</a></span> HWLOC_DECLSPEC <span class="keywordtype">int</span> <a class="code" href="a00216.html#ga80bbf6f0db9af48c61780dd5152664c2">hwloc_distances_release_remove</a>(<a class="code" href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <span class="keyword">struct</span> <a class="code" href="a00316.html">hwloc_distances_s</a> *distances);</div>
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span>  </div>
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> } <span class="comment">/* extern "C" */</span></div>
<div class="line"><a name="l00294"></a><span class="lineno"> 294</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  </div>
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  </div>
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span> <span class="preprocessor">#endif </span><span class="comment">/* HWLOC_DISTANCES_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aa00190_html_gacd37bb612667dc437d66bfb175a8dc55"><div class="ttname"><a href="a00190.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a></div><div class="ttdeci">hwloc_obj_type_t</div><div class="ttdoc">Type of topology object.</div><div class="ttdef"><b>Definition:</b> hwloc.h:176</div></div>
<div class="ttc" id="aa00192_html_ga9d1e76ee15a7dee158b786c30b6a6e38"><div class="ttname"><a href="a00192.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a></div><div class="ttdeci">struct hwloc_topology * hwloc_topology_t</div><div class="ttdoc">Topology context.</div><div class="ttdef"><b>Definition:</b> hwloc.h:691</div></div>
<div class="ttc" id="aa00193_html_ga8bec782e21be313750da70cf7428b374"><div class="ttname"><a href="a00193.html#ga8bec782e21be313750da70cf7428b374">hwloc_get_type_depth</a></div><div class="ttdeci">int hwloc_get_type_depth(hwloc_topology_t topology, hwloc_obj_type_t type)</div><div class="ttdoc">Returns the depth of objects of type type.</div></div>
<div class="ttc" id="aa00193_html_ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad"><div class="ttname"><a href="a00193.html#ggaf4e663cf42bbe20756b849c6293ef575a0565ab92ab72cb0cec91e23003294aad">HWLOC_TYPE_DEPTH_UNKNOWN</a></div><div class="ttdeci">@ HWLOC_TYPE_DEPTH_UNKNOWN</div><div class="ttdoc">No object of given type exists in the topology.</div><div class="ttdef"><b>Definition:</b> hwloc.h:821</div></div>
<div class="ttc" id="aa00193_html_ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c"><div class="ttname"><a href="a00193.html#ggaf4e663cf42bbe20756b849c6293ef575ae99465995cacde6c210d5fc2e409798c">HWLOC_TYPE_DEPTH_MULTIPLE</a></div><div class="ttdeci">@ HWLOC_TYPE_DEPTH_MULTIPLE</div><div class="ttdoc">Objects of given type exist at different depth in the topology (only for Groups).</div><div class="ttdef"><b>Definition:</b> hwloc.h:822</div></div>
<div class="ttc" id="aa00214_html_ga1dd78c1f9acd54f26aba0e284e97e51d"><div class="ttname"><a href="a00214.html#ga1dd78c1f9acd54f26aba0e284e97e51d">hwloc_distances_release</a></div><div class="ttdeci">void hwloc_distances_release(hwloc_topology_t topology, struct hwloc_distances_s *distances)</div><div class="ttdoc">Release a distance matrix structure previously returned by hwloc_distances_get().</div></div>
<div class="ttc" id="aa00214_html_ga5d1d35eccfcc2ebcef71a10972ce9b03"><div class="ttname"><a href="a00214.html#ga5d1d35eccfcc2ebcef71a10972ce9b03">hwloc_distances_get_by_depth</a></div><div class="ttdeci">int hwloc_distances_get_by_depth(hwloc_topology_t topology, int depth, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)</div><div class="ttdoc">Retrieve distance matrices for object at a specific depth in the topology.</div></div>
<div class="ttc" id="aa00214_html_ga613e6b2a5d0f06626ee8d0c12fa46691"><div class="ttname"><a href="a00214.html#ga613e6b2a5d0f06626ee8d0c12fa46691">hwloc_distances_get</a></div><div class="ttdeci">int hwloc_distances_get(hwloc_topology_t topology, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)</div><div class="ttdoc">Retrieve distance matrices.</div></div>
<div class="ttc" id="aa00214_html_gaa457f35b8745ca41ec17797c0d7b20f0"><div class="ttname"><a href="a00214.html#gaa457f35b8745ca41ec17797c0d7b20f0">hwloc_distances_get_by_name</a></div><div class="ttdeci">int hwloc_distances_get_by_name(hwloc_topology_t topology, const char *name, unsigned *nr, struct hwloc_distances_s **distances, unsigned long flags)</div><div class="ttdoc">Retrieve a distance matrix with the given name.</div></div>
<div class="ttc" id="aa00214_html_gaa6f9697028c589cef0458edef5fe273f"><div class="ttname"><a href="a00214.html#gaa6f9697028c589cef0458edef5fe273f">hwloc_distances_get_name</a></div><div class="ttdeci">const char * hwloc_distances_get_name(hwloc_topology_t topology, struct hwloc_distances_s *distances)</div><div class="ttdoc">Get a description of what a distances structure contains.</div></div>
<div class="ttc" id="aa00214_html_gaaa6bfbc20072a4f4de132eec859067f6"><div class="ttname"><a href="a00214.html#gaaa6bfbc20072a4f4de132eec859067f6">hwloc_distances_get_by_type</a></div><div class="ttdeci">int hwloc_distances_get_by_type(hwloc_topology_t topology, hwloc_obj_type_t type, unsigned *nr, struct hwloc_distances_s **distances, unsigned long kind, unsigned long flags)</div><div class="ttdoc">Retrieve distance matrices for object of a specific type.</div></div>
<div class="ttc" id="aa00214_html_gab1bb10d3adb85b52cdc6fe5a7f74f108"><div class="ttname"><a href="a00214.html#gab1bb10d3adb85b52cdc6fe5a7f74f108">hwloc_distances_kind_e</a></div><div class="ttdeci">hwloc_distances_kind_e</div><div class="ttdoc">Kinds of distance matrices.</div><div class="ttdef"><b>Definition:</b> distances.h:68</div></div>
<div class="ttc" id="aa00214_html_ggab1bb10d3adb85b52cdc6fe5a7f74f108a0148d7f9be833a04f5a55455437c227b"><div class="ttname"><a href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a0148d7f9be833a04f5a55455437c227b">HWLOC_DISTANCES_KIND_FROM_USER</a></div><div class="ttdeci">@ HWLOC_DISTANCES_KIND_FROM_USER</div><div class="ttdoc">These distances were provided by the user.</div><div class="ttdef"><b>Definition:</b> distances.h:76</div></div>
<div class="ttc" id="aa00214_html_ggab1bb10d3adb85b52cdc6fe5a7f74f108a41b19f141a3c0ffe85f9affaca4b0293"><div class="ttname"><a href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a41b19f141a3c0ffe85f9affaca4b0293">HWLOC_DISTANCES_KIND_MEANS_BANDWIDTH</a></div><div class="ttdeci">@ HWLOC_DISTANCES_KIND_MEANS_BANDWIDTH</div><div class="ttdoc">Distance values are similar to bandwidths between objects. Values are higher for closer objects,...</div><div class="ttdef"><b>Definition:</b> distances.h:91</div></div>
<div class="ttc" id="aa00214_html_ggab1bb10d3adb85b52cdc6fe5a7f74f108a90dc38248c8d5392d4dd3e88f391e984"><div class="ttname"><a href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108a90dc38248c8d5392d4dd3e88f391e984">HWLOC_DISTANCES_KIND_FROM_OS</a></div><div class="ttdeci">@ HWLOC_DISTANCES_KIND_FROM_OS</div><div class="ttdoc">These distances were obtained from the operating system or hardware.</div><div class="ttdef"><b>Definition:</b> distances.h:72</div></div>
<div class="ttc" id="aa00214_html_ggab1bb10d3adb85b52cdc6fe5a7f74f108aa6cf2b6dfcf148b65952f811814efbe1"><div class="ttname"><a href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108aa6cf2b6dfcf148b65952f811814efbe1">HWLOC_DISTANCES_KIND_HETEROGENEOUS_TYPES</a></div><div class="ttdeci">@ HWLOC_DISTANCES_KIND_HETEROGENEOUS_TYPES</div><div class="ttdoc">This distances structure covers objects of different types.</div><div class="ttdef"><b>Definition:</b> distances.h:96</div></div>
<div class="ttc" id="aa00214_html_ggab1bb10d3adb85b52cdc6fe5a7f74f108afd6a3503fbc8f7c1a31235373cefc4c6"><div class="ttname"><a href="a00214.html#ggab1bb10d3adb85b52cdc6fe5a7f74f108afd6a3503fbc8f7c1a31235373cefc4c6">HWLOC_DISTANCES_KIND_MEANS_LATENCY</a></div><div class="ttdeci">@ HWLOC_DISTANCES_KIND_MEANS_LATENCY</div><div class="ttdoc">Distance values are similar to latencies between objects. Values are smaller for closer objects,...</div><div class="ttdef"><b>Definition:</b> distances.h:84</div></div>
<div class="ttc" id="aa00215_html_ga3c665b23056e3269f777b21a67148c82"><div class="ttname"><a href="a00215.html#ga3c665b23056e3269f777b21a67148c82">hwloc_distances_obj_pair_values</a></div><div class="ttdeci">static int hwloc_distances_obj_pair_values(struct hwloc_distances_s *distances, hwloc_obj_t obj1, hwloc_obj_t obj2, hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)</div><div class="ttdoc">Find the values between two objects in a distance matrices.</div><div class="ttdef"><b>Definition:</b> distances.h:201</div></div>
<div class="ttc" id="aa00215_html_gab9e770c7d56c5d6040f26bd1dc8854cd"><div class="ttname"><a href="a00215.html#gab9e770c7d56c5d6040f26bd1dc8854cd">hwloc_distances_obj_index</a></div><div class="ttdeci">static int hwloc_distances_obj_index(struct hwloc_distances_s *distances, hwloc_obj_t obj)</div><div class="ttdoc">Find the index of an object in a distances structure.</div><div class="ttdef"><b>Definition:</b> distances.h:184</div></div>
<div class="ttc" id="aa00216_html_ga22428b6bab271411e3834e6b4ca22e37"><div class="ttname"><a href="a00216.html#ga22428b6bab271411e3834e6b4ca22e37">hwloc_distances_add_flag_e</a></div><div class="ttdeci">hwloc_distances_add_flag_e</div><div class="ttdoc">Flags for adding a new distances to a topology.</div><div class="ttdef"><b>Definition:</b> distances.h:223</div></div>
<div class="ttc" id="aa00216_html_ga80bbf6f0db9af48c61780dd5152664c2"><div class="ttname"><a href="a00216.html#ga80bbf6f0db9af48c61780dd5152664c2">hwloc_distances_release_remove</a></div><div class="ttdeci">int hwloc_distances_release_remove(hwloc_topology_t topology, struct hwloc_distances_s *distances)</div><div class="ttdoc">Release and remove the given distance matrice from the topology.</div></div>
<div class="ttc" id="aa00216_html_ga93db53773c96f5b83815e8441e2ebb93"><div class="ttname"><a href="a00216.html#ga93db53773c96f5b83815e8441e2ebb93">hwloc_distances_remove_by_type</a></div><div class="ttdeci">static int hwloc_distances_remove_by_type(hwloc_topology_t topology, hwloc_obj_type_t type)</div><div class="ttdoc">Remove distance matrices for objects of a specific type in the topology.</div><div class="ttdef"><b>Definition:</b> distances.h:275</div></div>
<div class="ttc" id="aa00216_html_gaa642a4c1a21c84f38ae23fca8a27845d"><div class="ttname"><a href="a00216.html#gaa642a4c1a21c84f38ae23fca8a27845d">hwloc_distances_remove_by_depth</a></div><div class="ttdeci">int hwloc_distances_remove_by_depth(hwloc_topology_t topology, int depth)</div><div class="ttdoc">Remove distance matrices for objects at a specific depth in the topology.</div></div>
<div class="ttc" id="aa00216_html_gac188d9b64d9560255ce5f6d0a20f9c0a"><div class="ttname"><a href="a00216.html#gac188d9b64d9560255ce5f6d0a20f9c0a">hwloc_distances_remove</a></div><div class="ttdeci">int hwloc_distances_remove(hwloc_topology_t topology)</div><div class="ttdoc">Remove all distance matrices from a topology.</div></div>
<div class="ttc" id="aa00216_html_gac5a71d96cd86efe31d6f8d282aae3d97"><div class="ttname"><a href="a00216.html#gac5a71d96cd86efe31d6f8d282aae3d97">hwloc_distances_add</a></div><div class="ttdeci">int hwloc_distances_add(hwloc_topology_t topology, unsigned nbobjs, hwloc_obj_t *objs, hwloc_uint64_t *values, unsigned long kind, unsigned long flags)</div><div class="ttdoc">Provide a new distance matrix.</div></div>
<div class="ttc" id="aa00216_html_gga22428b6bab271411e3834e6b4ca22e37a5233ccf631c3bc53dd5c3e7a5d5c9b77"><div class="ttname"><a href="a00216.html#gga22428b6bab271411e3834e6b4ca22e37a5233ccf631c3bc53dd5c3e7a5d5c9b77">HWLOC_DISTANCES_ADD_FLAG_GROUP_INACCURATE</a></div><div class="ttdeci">@ HWLOC_DISTANCES_ADD_FLAG_GROUP_INACCURATE</div><div class="ttdoc">If grouping, consider the distance values as inaccurate and relax the comparisons during the grouping...</div><div class="ttdef"><b>Definition:</b> distances.h:233</div></div>
<div class="ttc" id="aa00216_html_gga22428b6bab271411e3834e6b4ca22e37a7f6baba797d70538d03c9d13052c62ab"><div class="ttname"><a href="a00216.html#gga22428b6bab271411e3834e6b4ca22e37a7f6baba797d70538d03c9d13052c62ab">HWLOC_DISTANCES_ADD_FLAG_GROUP</a></div><div class="ttdeci">@ HWLOC_DISTANCES_ADD_FLAG_GROUP</div><div class="ttdoc">Try to group objects based on the newly provided distance information.</div><div class="ttdef"><b>Definition:</b> distances.h:227</div></div>
<div class="ttc" id="aa00244_html"><div class="ttname"><a href="a00244.html">hwloc_obj</a></div><div class="ttdoc">Structure of a topology object.</div><div class="ttdef"><b>Definition:</b> hwloc.h:395</div></div>
<div class="ttc" id="aa00316_html"><div class="ttname"><a href="a00316.html">hwloc_distances_s</a></div><div class="ttdoc">Matrix of distances between a set of objects.</div><div class="ttdef"><b>Definition:</b> distances.h:42</div></div>
<div class="ttc" id="aa00316_html_a4ca2af858cebbce7324ec49903d09474"><div class="ttname"><a href="a00316.html#a4ca2af858cebbce7324ec49903d09474">hwloc_distances_s::nbobjs</a></div><div class="ttdeci">unsigned nbobjs</div><div class="ttdoc">Number of objects described by the distance matrix.</div><div class="ttdef"><b>Definition:</b> distances.h:43</div></div>
<div class="ttc" id="aa00316_html_ae43e19b2c743de05c93d71a30beaca75"><div class="ttname"><a href="a00316.html#ae43e19b2c743de05c93d71a30beaca75">hwloc_distances_s::values</a></div><div class="ttdeci">hwloc_uint64_t * values</div><div class="ttdoc">Matrix of distances between objects, stored as a one-dimension array.</div><div class="ttdef"><b>Definition:</b> distances.h:50</div></div>
<div class="ttc" id="aa00316_html_aef9c83cf467da1b1fa4c36493febb3b5"><div class="ttname"><a href="a00316.html#aef9c83cf467da1b1fa4c36493febb3b5">hwloc_distances_s::kind</a></div><div class="ttdeci">unsigned long kind</div><div class="ttdoc">OR'ed set of hwloc_distances_kind_e.</div><div class="ttdef"><b>Definition:</b> distances.h:49</div></div>
<div class="ttc" id="aa00316_html_af1e78b2d628d191fa6cae3fbfe891078"><div class="ttname"><a href="a00316.html#af1e78b2d628d191fa6cae3fbfe891078">hwloc_distances_s::objs</a></div><div class="ttdeci">hwloc_obj_t * objs</div><div class="ttdoc">Array of objects described by the distance matrix. These objects are not in any particular order,...</div><div class="ttdef"><b>Definition:</b> distances.h:44</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
