[#bitset_detail-operator_eq-05]
= xref:bitset_detail.adoc[bitset_detail]::operator==
:relfileprefix: ../
:mrdocs:

Test whether we are done (can only compare with IteratorEnd).

== Synopsis

Declared in `<util/bitset.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
constexpr
bool
operator==(
    xref:bitset_detail/IntBitSet.adoc[Iterator] const& a,
    xref:bitset_detail/IntBitSet.adoc[IteratorEnd] const& end) noexcept;
----

== Return Value

true when no 1 bits remain to iterate.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *a*
| The iterator to test.
| *end*
| The end sentinel to compare against.
|===


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