Display the source code in std/typecons.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone.

Function `std.typecons.Tuple.opCmp`

Comparison for ordering.


						
				int opCmp(R)
				(
				

				  R rhs
				

				)
				

				if (areCompatibleTuples!(typeof(this), R, "<"));
				

				

				int opCmp(R)
				(
				

				  R rhs
				

				) const
				

				if (areCompatibleTuples!(typeof(this), R, "<"));

Parameters

Name	Description
rhs	The `Tuple` to compare against. It must meet the criteria for comparison between `Tuple`s.

Returns

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.

Example

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);

Authors

Andrei Alexandrescu, Bartosz Milewski, Don Clugston, Shin Fujishiro, Kenji Hara

License

Boost License 1.0.