The Spaceship Operator and Expression Rewriting

Let's imagine we have the following custom type, which simply stores a value, and implements an == operator:

1class Number {
2public:
3  bool operator==(const Number& Other) const {
4    std::cout << "Hello from the == operator\n";
5    return Value == Other.Value;
6  }
7
8  int Value;
9};

We create two objects of this type, and compare them using the != operator:

1int main(){
2  Number A{1};
3  Number B{2};
4
5  if (A != B) { std::cout << "Not equal!"; }
6}

Our type doesn’t have the != operator, so we’d expect this to fail. In C++17 and earlier, that’s exactly what happens:

1error: binary '!=': 'Number' does not define this operator

But, from C++20 onwards, this program will compile, and run as we expect:

1Hello from the == operator
2Not equal!

This works because, behind the scenes, the compiler has rewritten our expression.

Expression Rewriting

As the previous output would indicate, the expression using the != operator is calling the == operator of our class.

This is an example of expression rewriting, which was added to comparison operators in C++20

Specifically, if our type doesn't have the != operator, the compiler can rewrite any expression using it in terms of the == iterator. So, A != B will be rewritten to !(A == B)

Specifically, any expression using a secondary comparison operator can be rewritten in terms of the corresponding primary comparison operator.

• The secondary comparison operator != corresponds to the primary comparison operator ==
• The secondary comparison operators !=, <, <=, > and >= correspond to the primary comparison operator <=>, which we’ll cover next

The <=> Operator

To support expression rewriting, the three-way comparison operator was added in C++20 and uses the syntax <=>:

1A <=> B

Because of its visual appearance, it is often called the Spaceship Operator

The <=> operator accepts two operands, and returns one of three possible values. The return value depends on whether the left operand is less than, equal to, or greater than the right operand.

These three possibilities are contained within the std::strong_ordering struct:

• If A < B it returns std::strong_ordering::less
• If A == B it returns std::strong_ordering::equal
• If A > B it returns std::strong_ordering::greater

In code, we could use the <=> operator and std::strong_ordering type like this:

1if (A <=> B == std::strong_ordering::less) {
2  std::cout << "A is less than B";
3}
4
5if (A <=> B == std::strong_ordering::equal) {
6  std::cout << "A is equal to B";
7}
8
9if (A <=> B == std::strong_ordering::greater) {
10  std::cout << "A is greater than B";
11}

The previous example shows the mechanics of the <=> operator and the std::strong_ordering type, but it’s quite unusual that we’d use them like this. The <=> syntax and std::strong_ordering reference will typically only be used in one place - in our class code, to define the three-way comparison operation.

Any other code seeking to compare our objects will still be using the regular comparison operators, like > and >= to return booleans.

The key point is that, as of C++20, these operators no longer need to be defined. The compiler can rewrite any expression that attempts to use them to secretly call the <=> operator instead

Below, our class only defines the <=> operator, but because of expression rewriting, code using our class can use regular comparison operators, like < and >=:

1#include <iostream>
2
3class Number {
4public:
5  // Our class defines the <=> operator
6  // which returns a strong_ordering...
7  std::strong_ordering operator<=>(
8    const Number& Other) const{
9    std::cout << "Hello from <=>\n";
10    return Value <=> Other.Value;
11  }
12
13  int Value;
14};
15
16int main(){
17  Number A{1};
18  Number B{2};
19
20  // ...but our consumers use the normal
21  // comparison operators to return booleans
22  if (A < B) { std::cout << "A < B\n"; }
23  if (A <= B) { std::cout << "A <= B\n"; }
24}

1Hello from <=>
2A < B
3Hello from <=>
4A <= B

In summary, as of C++20, we now only need to define the two primary comparison operators for our types: == and <=>. All of the secondary comparison operators can be automatically generated from these.

1bool operator==(const T& A, const T& B){
2  return A <=> B == std::strong_ordering::equal;
3}

Summary

In this lesson, we explored the power of C++20's spaceship operator (<=>) and expression rewriting, showcasing how these features make it easier to implement comparison operators for custom types.

Key Takeaways

• Through the use of these C++20 features, only two primary comparison operators need to be defined (== and <=>).
• The spaceship operator (<=>) enables three-way comparisons, returning one of three possible outcomes: less, equal, or greater.
• Expression rewriting allows the compiler to automatically generate secondary comparison operators (!=, <, <=, >, >=) from the primary comparison operators (==, <=>).
• std::strong_ordering is used with the spaceship operator to define the outcome of comparisons.
• An explicit definition of == is necessary alongside <=> to improve our type’s runtime performance.

Next Lesson

C++20 Modules

A detailed overview of C++20 modules - the modern alternative to #include directives. We cover import and export statements, partitions, submodules, how to combine modules with legacy code, and more.

ContinueView Course