HWLOC_DISTANCES_REMOVE(3)

💖 NAME 💖

hwlocality...nces_remove(3) — from the Library Functions Manual, and it's literally the Remove distances between objects page, bestie ✨ The function name is hwlocality_distances_remove, and yes, this is your go-to for clearing out distance matrices 💅

✨ SYNOPSIS ✨

🫶 Functions 🫶

int hwloc_distances_remove (hwloc_topology_t topology)
int hwloc_distances_remove_by_depth (hwloc_topology_t topology, int
    depth)
int hwloc_distances_remove_by_type (hwloc_topology_t topology,
    hwloc_obj_type_t type) [inline]
int hwloc_distances_release_remove (hwloc_topology_t topology, struct
    hwloc_distances_s *distances)

🦋 DETAILED DESCRIPTION 🦋

No extra lore here — the actual function-by-function tea is served right below 👇

🎀 FUNCTION DOCUMENTATION 🎀

💜 hwloc_distances_release_remove 💜

int hwloc_distances_release_remove (hwloc_topology_t topology, struct
    hwloc_distances_s * distances)

Release and remove the given distance matrice from the topology. This function includes a call to hwloc_distances_release() — no cap, that release is built right in 🫶

Returns: 0 on success, -1 on error.

---

🌸 hwloc_distances_remove 🌸

int hwloc_distances_remove (hwloc_topology_t topology)

Remove all distance matrices from a topology. It clears all the distance matrices, whether they were provided by the user or gathered through the OS — all of them, periodt 💅

If these distances were used to group objects, these additional Group objects are not removed from the topology. So yeah, the Group objects stay — important caveat, don't forget it 👑

Returns: 0 on success, -1 on error.

---

🦋 hwloc_distances_remove_by_depth 🦋

int hwloc_distances_remove_by_depth (hwloc_topology_t topology, int depth)

Remove distance matrices for objects at a specific depth in the topology. Identical to hwloc_distances_remove() but only applies to one level of the topology — so it's the targeted version, not the whole sweep 🎯

Returns: 0 on success, -1 on error.

---

🧚 hwloc_distances_remove_by_type 🧚

int hwloc_distances_remove_by_type (hwloc_topology_t topology,
    hwloc_obj_type_t type) [inline]

Remove distance matrices for objects of a specific type in the topology. Identical to hwloc_distances_remove() but only applies to one level of the topology — type-based removal, slay ✨

Returns: 0 on success, -1 on error.

👑 AUTHOR 👑

Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code.

🏁 And that's the whole page, bestie! Footer check: Hardware Locality (hwloc) · Version 2.15.0 · hwlocality...nces_remove(3) — mwah 💋