[#BloombergLP-bdlb-BitStringUtil-areEqual-0a]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlb.adoc[bdlb]::xref:BloombergLP/bdlb/BitStringUtil.adoc[BitStringUtil]::areEqual
:relfileprefix: ../../../
:mrdocs:

`areEqual` overloads

== Synopses

Declared in `<bdlb_bitstringutil.h>`

Return whether the low‐order bits of two bit strings are equal.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
bool
xref:BloombergLP/bdlb/BitStringUtil/areEqual-06.adoc[areEqual](
    uint64_t const* bitString1,
    uint64_t const* bitString2,
    std::size_t numBits);
----

[.small]#xref:BloombergLP/bdlb/BitStringUtil/areEqual-06.adoc[_» more..._]#

Return whether corresponding bit ranges of two bit strings are equal.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
bool
xref:BloombergLP/bdlb/BitStringUtil/areEqual-01.adoc[areEqual](
    uint64_t const* bitString1,
    std::size_t index1,
    uint64_t const* bitString2,
    std::size_t index2,
    std::size_t numBits);
----

[.small]#xref:BloombergLP/bdlb/BitStringUtil/areEqual-01.adoc[_» more..._]#

== Return Value

`true` if the compared bits are equal, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *bitString1*
| first bit string
| *bitString2*
| second bit string
| *numBits*
| number of low‐order bits to compare
| *index1*
| starting bit index in `bitString1`
| *index2*
| starting bit index in `bitString2`
|===


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