18.2.183. PMIx_Cpuset_construct

PMIx_Cpuset_construct — Initialize a caller-provided pmix_cpuset_t(5) structure.

18.2.183.1. SYNOPSIS

#include <pmix.h>

void PMIx_Cpuset_construct(pmix_cpuset_t *cpuset);

18.2.183.1.1. Python Syntax

No Python equivalent

18.2.183.2. INPUT PARAMETERS

cpuset: Pointer to the pmix_cpuset_t(5) structure to be initialized. The storage for the structure itself must already exist — it is supplied by the caller (typically declared on the stack or embedded within another object).

18.2.183.3. DESCRIPTION

Initialize a pmix_cpuset_t that the caller has already allocated. The function zeroes the entire structure, clearing the source string pointer and the bitmap pointer. No heap memory is allocated and no bitmap is attached.

18.2.183.4. RETURN VALUE

PMIx_Cpuset_construct returns no value (void).

18.2.183.5. NOTES

Because PMIx_Cpuset_construct operates on caller-provided storage, it must be paired with PMIx_Cpuset_destruct(3) to release any bitmap the structure subsequently acquires. Do not pass a constructed (as opposed to created) structure to PMIx_Cpuset_free(3), as that would attempt to free storage the library did not allocate.

The convenience macro PMIX_CPUSET_CONSTRUCT is provided as a direct wrapper around this function.

18.2.183.6. EXAMPLES

Construct a structure:

pmix_cpuset_t cpuset;

PMIx_Cpuset_construct(&cpuset);