| 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): Helpers for consulting distance matrices</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"> 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">Helpers for consulting distance matrices </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:gaef9d6bb018286de69f8ac023129805aa" id="r_gaef9d6bb018286de69f8ac023129805aa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#gaef9d6bb018286de69f8ac023129805aa">hwloc_distances_obj_index</a> (struct <a class="el" href="a00296.html">hwloc_distances_s</a> *distances, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj)</td></tr> |
| 54 |
<tr class="memitem:ga29b891f8737ce5b35495240d977ac2c2" id="r_ga29b891f8737ce5b35495240d977ac2c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#ga29b891f8737ce5b35495240d977ac2c2">hwloc_distances_obj_pair_values</a> (struct <a class="el" href="a00296.html">hwloc_distances_s</a> *distances, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj1, <a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a> obj2, hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)</td></tr> |
| 55 |
</table> |
| 56 |
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2> |
| 57 |
<a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2> |
| 58 |
<a id="gaef9d6bb018286de69f8ac023129805aa" name="gaef9d6bb018286de69f8ac023129805aa"></a> |
| 59 |
<h2 class="memtitle"><span class="permalink"><a href="#gaef9d6bb018286de69f8ac023129805aa">◆ </a></span>hwloc_distances_obj_index()</h2> |
| 60 |
|
| 61 |
<div class="memitem"> |
| 62 |
<div class="memproto"> |
| 63 |
<table class="mlabels"> |
| 64 |
<tr> |
| 65 |
<td class="mlabels-left"> |
| 66 |
<table class="memname"> |
| 67 |
<tr> |
| 68 |
<td class="memname">int hwloc_distances_obj_index </td> |
| 69 |
<td>(</td> |
| 70 |
<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>, </td> |
| 71 |
</tr> |
| 72 |
<tr> |
| 73 |
<td class="paramkey"></td> |
| 74 |
<td></td> |
| 75 |
<td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>obj</em></span> )</td> |
| 76 |
</tr> |
| 77 |
</table> |
| 78 |
</td> |
| 79 |
<td class="mlabels-right"> |
| 80 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 81 |
</tr> |
| 82 |
</table> |
| 83 |
</div><div class="memdoc"> |
| 84 |
|
| 85 |
<p>Find the index of an object in a distances structure. </p> |
| 86 |
<dl class="section return"><dt>Returns</dt><dd>the index of the object in the distances structure if any. </dd> |
| 87 |
<dd> |
| 88 |
-1 if object <code class="param">obj</code> is not involved in structure <code class="param">distances</code>. </dd></dl> |
| 89 |
|
| 90 |
</div> |
| 91 |
</div> |
| 92 |
<a id="ga29b891f8737ce5b35495240d977ac2c2" name="ga29b891f8737ce5b35495240d977ac2c2"></a> |
| 93 |
<h2 class="memtitle"><span class="permalink"><a href="#ga29b891f8737ce5b35495240d977ac2c2">◆ </a></span>hwloc_distances_obj_pair_values()</h2> |
| 94 |
|
| 95 |
<div class="memitem"> |
| 96 |
<div class="memproto"> |
| 97 |
<table class="mlabels"> |
| 98 |
<tr> |
| 99 |
<td class="mlabels-left"> |
| 100 |
<table class="memname"> |
| 101 |
<tr> |
| 102 |
<td class="memname">int hwloc_distances_obj_pair_values </td> |
| 103 |
<td>(</td> |
| 104 |
<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>, </td> |
| 105 |
</tr> |
| 106 |
<tr> |
| 107 |
<td class="paramkey"></td> |
| 108 |
<td></td> |
| 109 |
<td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>obj1</em></span>, </td> |
| 110 |
</tr> |
| 111 |
<tr> |
| 112 |
<td class="paramkey"></td> |
| 113 |
<td></td> |
| 114 |
<td class="paramtype"><a class="el" href="a00168.html#ga79b8ab56877ef99ac59b833203391c7d">hwloc_obj_t</a></td> <td class="paramname"><span class="paramname"><em>obj2</em></span>, </td> |
| 115 |
</tr> |
| 116 |
<tr> |
| 117 |
<td class="paramkey"></td> |
| 118 |
<td></td> |
| 119 |
<td class="paramtype">hwloc_uint64_t *</td> <td class="paramname"><span class="paramname"><em>value1to2</em></span>, </td> |
| 120 |
</tr> |
| 121 |
<tr> |
| 122 |
<td class="paramkey"></td> |
| 123 |
<td></td> |
| 124 |
<td class="paramtype">hwloc_uint64_t *</td> <td class="paramname"><span class="paramname"><em>value2to1</em></span> )</td> |
| 125 |
</tr> |
| 126 |
</table> |
| 127 |
</td> |
| 128 |
<td class="mlabels-right"> |
| 129 |
<span class="mlabels"><span class="mlabel inline">inline</span></span> </td> |
| 130 |
</tr> |
| 131 |
</table> |
| 132 |
</div><div class="memdoc"> |
| 133 |
|
| 134 |
<p>Find the values between two objects in a distance matrices. </p> |
| 135 |
<p>The distance from <code class="param">obj1</code> to <code class="param">obj2</code> is stored in the value pointed by <code class="param">value1to2</code> and reciprocally.</p> |
| 136 |
<dl class="section return"><dt>Returns</dt><dd>0 on success. </dd> |
| 137 |
<dd> |
| 138 |
-1 if object <code class="param">obj1</code> or <code class="param">obj2</code> is not involved in structure <code class="param">distances</code>. </dd></dl> |
| 139 |
|
| 140 |
</div> |
| 141 |
</div> |
| 142 |
</div><!-- contents --> |
| 143 |
<!-- start footer part --> |
| 144 |
<hr class="footer"/><address class="footer"><small> |
| 145 |
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.15.0 |
| 146 |
</small></address> |
| 147 |
</div><!-- doc-content --> |
| 148 |
</body> |
| 149 |
</html> |