libhwloc-doc 1.8-1ubuntu1 / usr / share / doc / libhwloc-doc / html / a00094.html

This file is indexed.

/usr/share/doc/libhwloc-doc/html/a00094.html is in libhwloc-doc 1.8-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.5"/>
<title>Hardware Locality (hwloc): Manipulating Distances</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 style="padding-left: 0.5em;">
   <div id="projectname">Hardware Locality (hwloc)
   &#160;<span id="projectnumber">1.8</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Manipulating Distances</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga48dfec8b8ba1fb8f2073ecd0728f0ca6"><td class="memItemLeft" align="right" valign="top">static inline struct <br class="typebreak"/>
<a class="el" href="a00035.html">hwloc_distances_s</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#ga48dfec8b8ba1fb8f2073ecd0728f0ca6">hwloc_get_whole_distance_matrix_by_depth</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, unsigned depth)</td></tr>
<tr class="separator:ga48dfec8b8ba1fb8f2073ecd0728f0ca6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9979237728f7a00a38836e15a8e8cd17"><td class="memItemLeft" align="right" valign="top">static inline struct <br class="typebreak"/>
<a class="el" href="a00035.html">hwloc_distances_s</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#ga9979237728f7a00a38836e15a8e8cd17">hwloc_get_whole_distance_matrix_by_type</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00075.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a> type)</td></tr>
<tr class="separator:ga9979237728f7a00a38836e15a8e8cd17"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga186ac2711b98a12cf46d58cd005fbb51"><td class="memItemLeft" align="right" valign="top">static inline struct <br class="typebreak"/>
<a class="el" href="a00035.html">hwloc_distances_s</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#ga186ac2711b98a12cf46d58cd005fbb51">hwloc_get_distance_matrix_covering_obj_by_depth</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj, unsigned depth, unsigned *firstp)</td></tr>
<tr class="separator:ga186ac2711b98a12cf46d58cd005fbb51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9addde99e34b815df47625f1d6191839"><td class="memItemLeft" align="right" valign="top">static inline int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00094.html#ga9addde99e34b815df47625f1d6191839">hwloc_get_latency</a> (<a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a> topology, <a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj1, <a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj2, float *latency, float *reverse_latency)</td></tr>
<tr class="separator:ga9addde99e34b815df47625f1d6191839"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga186ac2711b98a12cf46d58cd005fbb51"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static inline struct <a class="el" href="a00035.html">hwloc_distances_s</a>* hwloc_get_distance_matrix_covering_obj_by_depth </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a>&#160;</td>
          <td class="paramname"><em>topology</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td>
          <td class="paramname"><em>obj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>depth</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned *&#160;</td>
          <td class="paramname"><em>firstp</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get distances for the given depth and covering some objects. </p>
<p>Return a distance matrix that describes depth <code>depth</code> and covers at least object <code>obj</code> and all its children.</p>
<p>When looking for the distance between some objects, a common ancestor should be passed in <code>obj</code>.</p>
<p><code>firstp</code> is set to logical index of the first object described by the matrix.</p>
<p>The returned structure belongs to the hwloc library. The caller should not modify or free it. </p>

</div>
</div>
<a class="anchor" id="ga9addde99e34b815df47625f1d6191839"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static inline int hwloc_get_latency </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a>&#160;</td>
          <td class="paramname"><em>topology</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td>
          <td class="paramname"><em>obj1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00076.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a>&#160;</td>
          <td class="paramname"><em>obj2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>latency</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float *&#160;</td>
          <td class="paramname"><em>reverse_latency</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the latency in both directions between two objects. </p>
<p>Look at ancestor objects from the bottom to the top until one of them contains a distance matrix that matches the objects exactly.</p>
<p><code>latency</code> gets the value from object <code>obj1</code> to <code>obj2</code>, while <code>reverse_latency</code> gets the reverse-direction value, which may be different on some architectures.</p>
<dl class="section return"><dt>Returns</dt><dd>-1 if no ancestor contains a matching latency matrix. </dd></dl>

</div>
</div>
<a class="anchor" id="ga48dfec8b8ba1fb8f2073ecd0728f0ca6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static inline struct <a class="el" href="a00035.html">hwloc_distances_s</a>* hwloc_get_whole_distance_matrix_by_depth </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a>&#160;</td>
          <td class="paramname"><em>topology</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>depth</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the distances between all objects at the given depth. </p>
<dl class="section return"><dt>Returns</dt><dd>a distances structure containing a matrix with all distances between all objects at the given depth.</dd></dl>
<p>Slot i+nbobjs*j contains the distance from the object of logical index i the object of logical index j.</p>
<dl class="section note"><dt>Note</dt><dd>This function only returns matrices covering the whole topology, without any unknown distance value. Those matrices are available in top-level object of the hierarchy. Matrices of lower objects are not reported here since they cover only part of the machine.</dd></dl>
<p>The returned structure belongs to the hwloc library. The caller should not modify or free it.</p>
<dl class="section return"><dt>Returns</dt><dd><code>NULL</code> if no such distance matrix exists. </dd></dl>

</div>
</div>
<a class="anchor" id="ga9979237728f7a00a38836e15a8e8cd17"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static inline struct <a class="el" href="a00035.html">hwloc_distances_s</a>* hwloc_get_whole_distance_matrix_by_type </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00077.html#ga9d1e76ee15a7dee158b786c30b6a6e38">hwloc_topology_t</a>&#160;</td>
          <td class="paramname"><em>topology</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00075.html#gacd37bb612667dc437d66bfb175a8dc55">hwloc_obj_type_t</a>&#160;</td>
          <td class="paramname"><em>type</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get the distances between all objects of a given type. </p>
<dl class="section return"><dt>Returns</dt><dd>a distances structure containing a matrix with all distances between all objects of the given type.</dd></dl>
<p>Slot i+nbobjs*j contains the distance from the object of logical index i the object of logical index j.</p>
<dl class="section note"><dt>Note</dt><dd>This function only returns matrices covering the whole topology, without any unknown distance value. Those matrices are available in top-level object of the hierarchy. Matrices of lower objects are not reported here since they cover only part of the machine.</dd></dl>
<p>The returned structure belongs to the hwloc library. The caller should not modify or free it.</p>
<dl class="section return"><dt>Returns</dt><dd><code>NULL</code> if no such distance matrix exists. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Dec 15 2013 16:14:34 for Hardware Locality (hwloc) by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>

APT Browse - Built by Thomas Orozco.