[#bsl-equal_to-09-operator_call]
= xref:bsl.adoc[bsl]::xref:bsl/equal_to-09.adoc[equal_to<void>]::operator()
:relfileprefix: ../../
:mrdocs:

Return `true` if the specified `lhs` compares equal to the specified `rhs` using the equality‐comparison operator, `lhs == rhs`.

== Synopsis

Declared in `<bslstl_equalto.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class TYPE1,
    class TYPE2>
[[nodiscard]]
constexpr
decltype(std::forward<TYPE1>(lhs) == std::forward<TYPE2>(rhs))
operator()(
    TYPE1&& lhs,
    TYPE2&& rhs) const noexcept(/* see-below */);
----

== Description

Implemented inline because of all the duplication of `std::forward<TYPE1>(lhs) == std::forward<TYPE2>(rhs)`.

== Exception specification

This function is potentially-throwing unless `noexcept(std::forward<TYPE1>(lhs) == std::forward<TYPE2>(rhs))`.

== Return Value

`true` if `lhs` compares equal to `rhs`, and `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*
| left‐hand operand to compare for equality
| *rhs*
| right‐hand operand to compare for equality
|===


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