18.2.236. PMIx_Check_procid

PMIx_Check_procid — Compare two pmix_proc_t(5) process identifiers for equality

18.2.236.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Check_procid(const pmix_proc_t *a,
                       const pmix_proc_t *b);

18.2.236.1.1. Python Syntax

No Python equivalent

18.2.236.2. INPUT PARAMETERS

a: Pointer to the first pmix_proc_t(5) to be compared.
b: Pointer to the second pmix_proc_t(5) to be compared.

18.2.236.3. DESCRIPTION

Compare two process identifiers for equality. The two are considered equal when both their namespaces match (as determined by PMIx_Check_nspace(3)) and their ranks match (as determined by PMIx_Check_rank(3)).

Because the underlying namespace and rank comparisons both apply wildcard semantics, this is a matching test rather than a strict byte-for-byte comparison: an invalid namespace matches any namespace, and PMIX_RANK_WILDCARD matches any rank.

18.2.236.4. RETURN VALUE

Returns true if both the namespace and rank of a and b are considered equal, and false otherwise.

18.2.236.5. NOTES

PMIx_Check_procid is an OpenPMIx convenience routine and is the backing implementation of the PMIX_CHECK_PROCID macro. Both arguments must point to valid structures; the routine performs no NULL checking.