18.2.237. PMIx_Check_rank

PMIx_Check_rank — Compare two pmix_rank_t(5) values for equality

18.2.237.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Check_rank(pmix_rank_t a,
                     pmix_rank_t b);

18.2.237.1.1. Python Syntax

No Python equivalent

18.2.237.2. INPUT PARAMETERS

a: The first pmix_rank_t(5) to be compared.
b: The second pmix_rank_t(5) to be compared.

18.2.237.3. DESCRIPTION

Compare two ranks for equality, honoring wildcard semantics. The two ranks are considered equal if their values are identical, or if either value is PMIX_RANK_WILDCARD, in which case the wildcard matches any rank.

18.2.237.4. RETURN VALUE

Returns true if the ranks are equal, or if either rank is PMIX_RANK_WILDCARD; returns false otherwise.

18.2.237.5. NOTES

PMIx_Check_rank is an OpenPMIx convenience routine and is the backing implementation of the PMIX_CHECK_RANK macro.