| 1 |
.TH "hwlocality_distances_remove" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwlocality_distances_remove \- Remove distances between objects |
| 6 |
.SH SYNOPSIS |
| 7 |
.br |
| 8 |
.PP |
| 9 |
.SS "Functions" |
| 10 |
|
| 11 |
.in +1c |
| 12 |
.ti -1c |
| 13 |
.RI "int \fBhwloc_distances_remove\fP (\fBhwloc_topology_t\fP topology)" |
| 14 |
.br |
| 15 |
.ti -1c |
| 16 |
.RI "int \fBhwloc_distances_remove_by_depth\fP (\fBhwloc_topology_t\fP topology, int depth)" |
| 17 |
.br |
| 18 |
.ti -1c |
| 19 |
.RI "int \fBhwloc_distances_remove_by_type\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_type_t\fP type)" |
| 20 |
.br |
| 21 |
.ti -1c |
| 22 |
.RI "int \fBhwloc_distances_release_remove\fP (\fBhwloc_topology_t\fP topology, struct \fBhwloc_distances_s\fP *distances)" |
| 23 |
.br |
| 24 |
.in -1c |
| 25 |
.SH "Detailed Description" |
| 26 |
.PP |
| 27 |
|
| 28 |
.SH "Function Documentation" |
| 29 |
.PP |
| 30 |
.SS "int hwloc_distances_release_remove (\fBhwloc_topology_t\fP topology, struct \fBhwloc_distances_s\fP * distances)" |
| 31 |
|
| 32 |
.PP |
| 33 |
Release and remove the given distance matrice from the topology\&. This function includes a call to \fBhwloc_distances_release()\fP\&. |
| 34 |
|
| 35 |
.PP |
| 36 |
\fBReturns\fP |
| 37 |
.RS 4 |
| 38 |
0 on success, -1 on error\&. |
| 39 |
.RE |
| 40 |
.PP |
| 41 |
|
| 42 |
.SS "int hwloc_distances_remove (\fBhwloc_topology_t\fP topology)" |
| 43 |
|
| 44 |
.PP |
| 45 |
Remove all distance matrices from a topology\&. Remove all distance matrices, either provided by the user or gathered through the OS\&. |
| 46 |
|
| 47 |
.PP |
| 48 |
If these distances were used to group objects, these additional Group objects are not removed from the topology\&. |
| 49 |
|
| 50 |
.PP |
| 51 |
\fBReturns\fP |
| 52 |
.RS 4 |
| 53 |
0 on success, -1 on error\&. |
| 54 |
.RE |
| 55 |
.PP |
| 56 |
|
| 57 |
.SS "int hwloc_distances_remove_by_depth (\fBhwloc_topology_t\fP topology, int depth)" |
| 58 |
|
| 59 |
.PP |
| 60 |
Remove distance matrices for objects at a specific depth in the topology\&. Identical to \fBhwloc_distances_remove()\fP but only applies to one level of the topology\&. |
| 61 |
|
| 62 |
.PP |
| 63 |
\fBReturns\fP |
| 64 |
.RS 4 |
| 65 |
0 on success, -1 on error\&. |
| 66 |
.RE |
| 67 |
.PP |
| 68 |
|
| 69 |
.SS "int hwloc_distances_remove_by_type (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_type_t\fP type)\fR [inline]\fP" |
| 70 |
|
| 71 |
.PP |
| 72 |
Remove distance matrices for objects of a specific type in the topology\&. Identical to \fBhwloc_distances_remove()\fP but only applies to one level of the topology\&. |
| 73 |
|
| 74 |
.PP |
| 75 |
\fBReturns\fP |
| 76 |
.RS 4 |
| 77 |
0 on success, -1 on error\&. |
| 78 |
.RE |
| 79 |
.PP |
| 80 |
|
| 81 |
.SH "Author" |
| 82 |
.PP |
| 83 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |