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

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

== Synopsis

Declared in `<bdlb_bitstringutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
bool
areEqual(
    uint64_t const* bitString1,
    uint64_t const* bitString2,
    std::size_t numBits);
----

== Description

Return `true` if the specified low‐order `numBits` in the specified `bitString1` are bitwise equal to the corresponding bits in the specified `bitString2`, and `false` otherwise. The behavior is undefined unless both `bitString1` and `bitString2` have a length of at least `numBits`.

== 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
|===


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