Debian Codegraph @

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

raw
1 .TH "hwlocality_components_distances" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*-
2 .ad l
3 .nh
4 .SH NAME
5 hwlocality_components_distances \- Components and Plugins: distances
6 .SH SYNOPSIS
7 .br
8 .PP
9 .SS "Typedefs"
10
11 .in +1c
12 .ti -1c
13 .RI "typedef void * \fBhwloc_backend_distances_add_handle_t\fP"
14 .br
15 .in -1c
16 .SS "Functions"
17
18 .in +1c
19 .ti -1c
20 .RI "\fBhwloc_backend_distances_add_handle_t\fP \fBhwloc_backend_distances_add_create\fP (\fBhwloc_topology_t\fP topology, const char *name, unsigned long kind, unsigned long flags)"
21 .br
22 .ti -1c
23 .RI "int \fBhwloc_backend_distances_add_values\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_backend_distances_add_handle_t\fP handle, unsigned nbobjs, \fBhwloc_obj_t\fP *objs, hwloc_uint64_t *values, unsigned long flags)"
24 .br
25 .ti -1c
26 .RI "int \fBhwloc_backend_distances_add_commit\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_backend_distances_add_handle_t\fP handle, unsigned long flags)"
27 .br
28 .in -1c
29 .SH "Detailed Description"
30 .PP
31
32 .PP
33 \fBNote\fP
34 .RS 4
35 These structures and functions may change when \fBHWLOC_COMPONENT_ABI\fP is modified\&.
36 .RE
37 .PP
38
39 .SH "Typedef Documentation"
40 .PP
41 .SS "typedef void* \fBhwloc_backend_distances_add_handle_t\fP"
42
43 .PP
44 Handle to a new distances structure during its addition to the topology\&.
45 .SH "Function Documentation"
46 .PP
47 .SS "int hwloc_backend_distances_add_commit (\fBhwloc_topology_t\fP topology, \fBhwloc_backend_distances_add_handle_t\fP handle, unsigned long flags)"
48
49 .PP
50 Commit a new distances structure\&. This is similar to \fBhwloc_distances_add_commit()\fP but this variant is designed for backend inserting distances during topology discovery\&.
51 .SS "\fBhwloc_backend_distances_add_handle_t\fP hwloc_backend_distances_add_create (\fBhwloc_topology_t\fP topology, const char * name, unsigned long kind, unsigned long flags)"
52
53 .PP
54 Create a new empty distances structure\&. This is identical to \fBhwloc_distances_add_create()\fP but this variant is designed for backend inserting distances during topology discovery\&.
55 .SS "int hwloc_backend_distances_add_values (\fBhwloc_topology_t\fP topology, \fBhwloc_backend_distances_add_handle_t\fP handle, unsigned nbobjs, \fBhwloc_obj_t\fP * objs, hwloc_uint64_t * values, unsigned long flags)"
56
57 .PP
58 Specify the objects and values in a new empty distances structure\&. This is similar to \fBhwloc_distances_add_values()\fP but this variant is designed for backend inserting distances during topology discovery\&.
59
60 .PP
61 The only semantical difference is that \fRobjs\fP and \fRvalues\fP are not duplicated, but directly attached to the topology\&. On success, these arrays are given to the core and should not ever be freed by the caller anymore\&.
62 .SH "Author"
63 .PP
64 Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.