51 lines
2.0 KiB
Groff
51 lines
2.0 KiB
Groff
.TH "hwlocality_distances_remove" 3 "Wed Dec 14 2022" "Version 2.9.0" "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\&.
|
|
.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\&.
|
|
.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\&.
|
|
.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\&.
|
|
.SH "Author"
|
|
.PP
|
|
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.
|