18.2.241. PMIx_Rank_valid

PMIx_Rank_valid — Test whether a pmix_rank_t(5) is a valid process rank

18.2.241.1. SYNOPSIS

#include <pmix.h>

bool PMIx_Rank_valid(pmix_rank_t a);

18.2.241.1.1. Python Syntax

No Python equivalent

18.2.241.2. INPUT PARAMETERS

a: The pmix_rank_t(5) value to be tested.

18.2.241.3. DESCRIPTION

Test whether a rank is a valid process rank. The upper end of the pmix_rank_t value space is reserved for special sentinel values such as PMIX_RANK_WILDCARD, PMIX_RANK_UNDEF, and PMIX_RANK_INVALID. This routine returns true only for values that fall below PMIX_RANK_VALID — that is, ranks that denote an actual process position rather than one of the reserved markers.

18.2.241.4. RETURN VALUE

Returns true if a is strictly less than PMIX_RANK_VALID (a valid process rank), and false otherwise.

18.2.241.5. NOTES

PMIx_Rank_valid is an OpenPMIx convenience routine and is the backing implementation of the PMIX_RANK_IS_VALID macro.