The D Programming Language's Unofficial Docs beta

Tuple.opCmp

std typecons Tuple Tuple

Comparison for ordering.

  1. int opCmp(R rhs)
    struct Tuple
    int
    opCmp
    (
    R
    )
    (
    R rhs
    )
    if (
    areCompatibleTuples!(typeof(this), R, "<")
    )
  2. int opCmp(R rhs)

Parameters

rhs R

The Tuple to compare against. It must meet the criteria for comparison between Tuples.

Return Value

Type: int

For any values v1 on the right-hand side and v2 on the left-hand side:

  • A negative integer if the expression v1 < v2 is true.
  • A positive integer if the expression v1 > v2 is true.
  • 0 if the expression v1 == v2 is true.

Examples

The first v1 for which v1 > v2 is true determines the result. This could lead to unexpected behaviour.

auto tup1 = tuple(1, 1, 1);
auto tup2 = tuple(1, 100, 100);
assert(tup1 < tup2);

//Only the first result matters for comparison
tup1[0] = 2;
assert(tup1 > tup2);

Meta

Source

See Implementation

std typecons Tuple Tuple aliasesconstructorsfunctionspropertiesvariables
Page generated by adrdox
Suggestion Box / Bug Report