20.2.237. PMIx_Check_procid

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

20.2.237.1. SYNOPSIS

#include <pmix.h>

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

20.2.237.1.1. Python Syntax

No Python equivalent

20.2.237.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.

20.2.237.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. Both wildcards are easy to inherit by accident from data that is legitimately unset. Where the question being asked is “do these two name the same process” rather than “does this match the specification”, use PMIx_Check_procid_strict(3).

A NULL argument is accepted: two absent procIDs are reported as equal, and an absent one is not equal to a present one.

20.2.237.4. RETURN VALUE

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

20.2.237.5. NOTES

PMIx_Check_procid is an OpenPMIx convenience routine and is the backing implementation of the PMIX_CHECK_PROCID macro.