[#mp_units-utility-operator_eq-01]
= xref:mp_units.adoc[mp_units]::xref:mp_units/utility.adoc[utility]::operator==
:relfileprefix: ../../
:mrdocs:

Checks whether a `safe_int` equals an integral scalar, comparing safely across signedness.

== Synopsis

Declared in `<mp‐units/utility/safe_int.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
constexpr
bool
operator==(
    xref:mp_units/utility/safe_int-07.adoc[safe_int] lhs,
    U rhs);
----

== Return Value

`true` if the wrapped value equals `rhs`

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

[cols="1,4"]
|===
| Name| Description
| *U*
| the integral scalar type
|===

== Parameters

[cols="1,4"]
|===
| Name| Description
| *lhs*
| the `safe_int` operand
| *rhs*
| the integral scalar to compare against
|===


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