| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778 |
- .TH "hwlocality_distances_remove" 3 "Thu Sep 7 2023" "Version 2.9.3" "Hardware Locality (hwloc)" \" -*- nroff -*-
- .ad l
- .nh
- .SH NAME
- hwlocality_distances_remove \- Remove distances between objects
- .SH SYNOPSIS
- .br
- .PP
- .SS "Functions"
- .in +1c
- .ti -1c
- .RI "int \fBhwloc_distances_remove\fP (\fBhwloc_topology_t\fP topology)"
- .br
- .ti -1c
- .RI "int \fBhwloc_distances_remove_by_depth\fP (\fBhwloc_topology_t\fP topology, int depth)"
- .br
- .ti -1c
- .RI "static int \fBhwloc_distances_remove_by_type\fP (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_type_t\fP type)"
- .br
- .ti -1c
- .RI "int \fBhwloc_distances_release_remove\fP (\fBhwloc_topology_t\fP topology, struct \fBhwloc_distances_s\fP *distances)"
- .br
- .in -1c
- .SH "Detailed Description"
- .PP
- .SH "Function Documentation"
- .PP
- .SS "int hwloc_distances_release_remove (\fBhwloc_topology_t\fP topology, struct \fBhwloc_distances_s\fP * distances)"
- .PP
- Release and remove the given distance matrice from the topology\&. This function includes a call to \fBhwloc_distances_release()\fP\&.
- .PP
- \fBReturns\fP
- .RS 4
- 0 on success, -1 on error\&.
- .RE
- .PP
- .SS "int hwloc_distances_remove (\fBhwloc_topology_t\fP topology)"
- .PP
- Remove all distance matrices from a topology\&. Remove all distance matrices, either provided by the user or gathered through the OS\&.
- .PP
- If these distances were used to group objects, these additional Group objects are not removed from the topology\&.
- .PP
- \fBReturns\fP
- .RS 4
- 0 on success, -1 on error\&.
- .RE
- .PP
- .SS "int hwloc_distances_remove_by_depth (\fBhwloc_topology_t\fP topology, int depth)"
- .PP
- 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\&.
- .PP
- \fBReturns\fP
- .RS 4
- 0 on success, -1 on error\&.
- .RE
- .PP
- .SS "static int hwloc_distances_remove_by_type (\fBhwloc_topology_t\fP topology, \fBhwloc_obj_type_t\fP type)\fC [inline]\fP, \fC [static]\fP"
- .PP
- 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\&.
- .PP
- \fBReturns\fP
- .RS 4
- 0 on success, -1 on error\&.
- .RE
- .PP
- .SH "Author"
- .PP
- Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|
