[#mp_units-operator_3way-01]
= xref:mp_units.adoc[mp_units]::operator<=>
:relfileprefix: ../
:mrdocs:

Three‐way comparison operator

== Synopsis

Declared in `<mp‐units/framework/quantity_character.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
constexpr
auto
operator<=>(
    xref:mp_units/quantity_character.adoc[quantity_character] lhs,
    xref:mp_units/quantity_character.adoc[quantity_character] rhs) = default;
----

== Return Value

The relative order of the objects

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *lhs*
| The left operand
| *rhs*
| The right operand
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#