Debian Codegraph @

doc/doxygen-doc/man/man3/hwlocality_distances_consult.3

raw
1 .TH "hwlocality_distances_consult" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_distances_consult \- Helpers for consulting distance matrices
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Functions"
10
11 .in +1c
12 .ti -1c
13 .RI "int \fBhwloc_distances_obj_index\fP (struct \fBhwloc_distances_s\fP *distances, \fBhwloc_obj_t\fP obj)"
14 .br
15 .ti -1c
16 .RI "int \fBhwloc_distances_obj_pair_values\fP (struct \fBhwloc_distances_s\fP *distances, \fBhwloc_obj_t\fP obj1, \fBhwloc_obj_t\fP obj2, hwloc_uint64_t *value1to2, hwloc_uint64_t *value2to1)"
17 .br
18 .in -1c
19 .SH "Detailed Description"
20 .PP
21
22 .SH "Function Documentation"
23 .PP
24 .SS "int hwloc_distances_obj_index (struct \fBhwloc_distances_s\fP * distances, \fBhwloc_obj_t\fP obj)\fR [inline]\fP"
25
26 .PP
27 Find the index of an object in a distances structure\&.
28 .PP
29 \fBReturns\fP
30 .RS 4
31 the index of the object in the distances structure if any\&.
32
33 .PP
34 -1 if object \fRobj\fP is not involved in structure \fRdistances\fP\&.
35 .RE
36 .PP
37
38 .SS "int hwloc_distances_obj_pair_values (struct \fBhwloc_distances_s\fP * distances, \fBhwloc_obj_t\fP obj1, \fBhwloc_obj_t\fP obj2, hwloc_uint64_t * value1to2, hwloc_uint64_t * value2to1)\fR [inline]\fP"
39
40 .PP
41 Find the values between two objects in a distance matrices\&. The distance from \fRobj1\fP to \fRobj2\fP is stored in the value pointed by \fRvalue1to2\fP and reciprocally\&.
42
43 .PP
44 \fBReturns\fP
45 .RS 4
46 0 on success\&.
47
48 .PP
49 -1 if object \fRobj1\fP or \fRobj2\fP is not involved in structure \fRdistances\fP\&.
50 .RE
51 .PP
52
53 .SH "Author"
54 .PP
55 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.