[#mp_units-operator_eq-0e]
= xref:mp_units.adoc[mp_units]::operator==
:relfileprefix: ../
:mrdocs:

Equality operator

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    xref:mp_units/Dimension.adoc[Dimension] Lhs,
    xref:mp_units/Dimension.adoc[Dimension] Rhs>
[[nodiscard]]
consteval
bool
operator==(
    Lhs lhs,
    Rhs rhs);
----

[NOTE]
====
This function is a https://en.cppreference.com/w/cpp/language/friend[hidden friend] of xref:mp_units/dimension_one-063.adoc[dimension_one], declared inside an implementation-defined base class: it can be found only through argument-dependent lookup.
====

== Return Value

`true` if the objects are equal, `false` otherwise

[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]#