18.3.18. pmix_value_cmp_t

pmix_value_cmp_t — Result of comparing two PMIx values

18.3.18.1. SYNTAX

18.3.18.1.1. C Syntax

#include <pmix_common.h>

typedef enum {
    PMIX_EQUAL,
    PMIX_VALUE1_GREATER,
    PMIX_VALUE2_GREATER,
    PMIX_VALUE_TYPE_DIFFERENT,
    PMIX_VALUE_INCOMPATIBLE_OBJECTS,
    PMIX_VALUE_COMPARISON_NOT_AVAIL
} pmix_value_cmp_t;

18.3.18.1.2. Python Syntax

from pmix import *

result = PMIX_EQUAL

where result is one of the pmix_value_cmp_t enumerated values.

18.3.18.2. DESCRIPTION

The pmix_value_cmp_t enumeration expresses the outcome of comparing two PMIx values (typically two pmix_value_t(5) structures). The defined values are:

  • PMIX_EQUAL — the two values are of the same type and compare as equal.

  • PMIX_VALUE1_GREATER — the two values are of comparable type and the first value is greater than the second.

  • PMIX_VALUE2_GREATER — the two values are of comparable type and the second value is greater than the first.

  • PMIX_VALUE_TYPE_DIFFERENT — the two values carry different data types and therefore cannot be ordered against one another.

  • PMIX_VALUE_INCOMPATIBLE_OBJECTS — the two values are of the same type, but that type describes composite objects whose contents are not compatible for comparison.

  • PMIX_VALUE_COMPARISON_NOT_AVAIL — a comparison operation is not available for the given data type.

A human-readable string representation of a pmix_value_cmp_t value can be obtained from PMIx_Value_comparison_string(3).