[#mp_units-operator_eq-02f]
= xref:mp_units.adoc[mp_units]::operator==
:relfileprefix: ../
:mrdocs:

Checks whether a reference is equal to a unit

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:mp_units/Unit.adoc[Unit] U2>
[[nodiscard]]
consteval
bool
operator==(
    xref:mp_units/reference-0b2.adoc[reference] r,
    U2 u2);
----

[NOTE]
====
This function is a https://en.cppreference.com/w/cpp/language/friend[hidden friend] of xref:mp_units/reference-0b2.adoc[reference], declared only inside that class: it can be found only through argument-dependent lookup.
====

== Return Value

`true` if the reference's quantity specification and unit match those implied by `u2`

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

[cols="1,4"]
|===
| Name| Description
| *r*
| the reference to compare
| *u2*
| the unit to compare against
|===


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