Skip to content

missing code documentation of hwloc #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lterrac merged 1 commit into from
Sep 18, 2025
Merged

missing code documentation of hwloc #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions include/hicr/backends/hwloc/computeResource.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ class ComputeResource final : public HiCR::ComputeResource

/**
* Constructor for the compute resource class of the hwloc backend
* \param topology HWLoc topology object for discovery
* \param hwlocObjectIndex The index of the core within the hwloc topology
* \param[in] topology HWLoc topology object for discovery
* \param[in] hwlocObjectIndex The index of the core within the hwloc topology
*/
ComputeResource(hwloc_topology_t topology, const hwlocObjectIndex_t hwlocObjectIndex)
: HiCR::ComputeResource(),
Expand All @@ -79,10 +79,11 @@ class ComputeResource final : public HiCR::ComputeResource

/**
* Constructor for the compute resource class of the hwloc backend
* \param[in] hwlocObjectIndex The index of the core within the hwloc topology
* \param[in] logicalProcessorId Unique identifier for the core assigned to this compute resource
* \param[in] physicalProcessorId The identifier of the physical core as assigned by the OS
* \param[in] numaAffinity The NUMA domain associated to this core
* \param[in] caches The set of caches contained to or accessible by this core
* \param[in] physicalProcessorId The identifier of the physical core as assigned by the OS
*/
ComputeResource(const hwlocObjectIndex_t hwlocObjectIndex,
const logicalProcessorId_t logicalProcessorId,
Expand Down