.TH "hwlocality_helper_topology_sets" 3 "Fri Feb 8 2019" "Version 1.11.12" "Hardware Locality (hwloc)" \" -*- nroff -*-
.ad l
.nh
.SH NAME
hwlocality_helper_topology_sets
.SH SYNOPSIS
.br
.PP
.SS "Functions"

.in +1c
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_complete_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_topology_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_online_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_cpuset_t\fP \fBhwloc_topology_get_allowed_cpuset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_complete_nodeset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_topology_nodeset\fP (\fBhwloc_topology_t\fP topology)"
.br
.ti -1c
.RI "static \fBhwloc_const_nodeset_t\fP \fBhwloc_topology_get_allowed_nodeset\fP (\fBhwloc_topology_t\fP topology)"
.br
.in -1c
.SH "Detailed Description"
.PP 

.SH "Function Documentation"
.PP 
.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_allowed_cpuset (\fBhwloc_topology_t\fP topology)\fC [inline]\fP, \fC [static]\fP"

.PP
Get allowed CPU set\&. 
.PP
\fBReturns:\fP
.RS 4
the CPU set of allowed logical processors of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
The returned cpuset is not newly allocated and should thus not be changed or freed, \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&. 
.RE
.PP

.SS "static \fBhwloc_const_nodeset_t\fP hwloc_topology_get_allowed_nodeset (\fBhwloc_topology_t\fP topology)\fC [inline]\fP, \fC [static]\fP"

.PP
Get allowed node set\&. 
.PP
\fBReturns:\fP
.RS 4
the node set of allowed memory of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
The returned nodeset is not newly allocated and should thus not be changed or freed, \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&. 
.RE
.PP

.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_complete_cpuset (\fBhwloc_topology_t\fP topology)\fC [inline]\fP, \fC [static]\fP"

.PP
Get complete CPU set\&. 
.PP
\fBReturns:\fP
.RS 4
the complete CPU set of logical processors of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
The returned cpuset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&. 
.RE
.PP

.SS "static \fBhwloc_const_nodeset_t\fP hwloc_topology_get_complete_nodeset (\fBhwloc_topology_t\fP topology)\fC [inline]\fP, \fC [static]\fP"

.PP
Get complete node set\&. 
.PP
\fBReturns:\fP
.RS 4
the complete node set of memory of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
The returned nodeset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&. 
.RE
.PP

.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_online_cpuset (\fBhwloc_topology_t\fP topology)\fC [inline]\fP, \fC [static]\fP"

.PP
Get online CPU set\&. 
.PP
\fBReturns:\fP
.RS 4
the CPU set of online logical processors of the system\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
The returned cpuset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&. 
.RE
.PP

.SS "static \fBhwloc_const_cpuset_t\fP hwloc_topology_get_topology_cpuset (\fBhwloc_topology_t\fP topology)\fC [inline]\fP, \fC [static]\fP"

.PP
Get topology CPU set\&. 
.PP
\fBReturns:\fP
.RS 4
the CPU set of logical processors of the system for which hwloc provides topology information\&. This is equivalent to the cpuset of the system object\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
The returned cpuset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&. 
.RE
.PP

.SS "static \fBhwloc_const_nodeset_t\fP hwloc_topology_get_topology_nodeset (\fBhwloc_topology_t\fP topology)\fC [inline]\fP, \fC [static]\fP"

.PP
Get topology node set\&. 
.PP
\fBReturns:\fP
.RS 4
the node set of memory of the system for which hwloc provides topology information\&. This is equivalent to the nodeset of the system object\&. If the topology is the result of a combination of several systems, NULL is returned\&.
.RE
.PP
\fBNote:\fP
.RS 4
The returned nodeset is not newly allocated and should thus not be changed or freed; \fBhwloc_bitmap_dup()\fP must be used to obtain a local copy\&. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&.