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

Equality operators

== Synopses

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

Checks whether a safe_int and a constrained value are equal


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

[.small]#xref:mp_units/utility/operator_eq-07.adoc[_» more..._]#

Checks whether a `safe_int` equals a floating‐point value.


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

[.small]#xref:mp_units/utility/operator_eq-0e.adoc[_» more..._]#

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


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

[.small]#xref:mp_units/utility/operator_eq-01.adoc[_» more..._]#

Checks whether two `safe_int` values wrap equal underlying values.


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

[.small]#xref:mp_units/utility/operator_eq-0b.adoc[_» more..._]#

== Return Value

* `true` if the underlying values are equal
* `true` if the wrapped value equals `rhs`
* `true` if the wrapped values are equal

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

[cols="1,4"]
|===
| Name| Description
| *U*
| a floating‐point‐like type (`treat_as_floating_point<U>` is `true`)
|===

== Parameters

[cols="1,4"]
|===
| Name| Description
| *lhs*
| the safe_int to compare
| *rhs*
| the constrained value to compare against
|===


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