[#BloombergLP-bdlc-operator_minus-0a4]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlc.adoc[bdlc]::operator‐
:relfileprefix: ../../
:mrdocs:

Subtraction operators

== Synopses

Declared in `<bdlc_bitarray.h>`

Return the value that is the bitwise MINUS of the specified `lhs` and `rhs` arrays. The length of the resulting bit array will be the maximum of that of `lhs` and `rhs`, with any unmatched high‐order `lhs` bits copied unchanged, and any unmatched high‐order `rhs` bits set to 0. Note that this behavior is consistent with zero‐extending a copy of the shorter array.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlc/BitArray.adoc[bdlc::BitArray]
xref:BloombergLP/bdlc/operator_minus-0a9.adoc[operator‐](
    xref:BloombergLP/bdlc/BitArray.adoc[BitArray] const& lhs,
    xref:BloombergLP/bdlc/BitArray.adoc[BitArray] const& rhs);
----

[.small]#xref:BloombergLP/bdlc/operator_minus-0a9.adoc[_» more..._]#

Return the signed distance between two iterators (see free `operator‐`).


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<>
std::ptrdiff_t
xref:BloombergLP/bdlc/operator_minus-0af.adoc[operator‐](
    xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[CompactedArray_ConstIterator] const&,
    xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[CompactedArray_ConstIterator] const&);
----

[.small]#xref:BloombergLP/bdlc/operator_minus-0af.adoc[_» more..._]#


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<>
std::ptrdiff_t
xref:BloombergLP/bdlc/operator_minus-05.adoc[operator‐<>](
    xref:BloombergLP/bdlc/PackedIntArrayConstIterator.adoc[PackedIntArrayConstIterator] const&,
    xref:BloombergLP/bdlc/PackedIntArrayConstIterator.adoc[PackedIntArrayConstIterator] const&);
----

[.small]#xref:BloombergLP/bdlc/operator_minus-05.adoc[_» more..._]#

Return an iterator at the negated specified offset from the given iterator (see free `operator‐`).


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<>
xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[CompactedArray_ConstIterator<TYPE>]
xref:BloombergLP/bdlc/operator_minus-01.adoc[operator‐](
    xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[CompactedArray_ConstIterator<TYPE>] const&,
    std::ptrdiff_t);
----

[.small]#xref:BloombergLP/bdlc/operator_minus-01.adoc[_» more..._]#

Return an iterator referencing the location at the specified `offset` from the location referenced by the specified `iterator`. The returned iterator, `it`, referencing a `CompactedArray` `array`, remains valid as long as `0 <= it ‐ array.begin() <= array.length()`. The behavior is undefined unless `CompactedArray_ConstIterator() != iterator` and `0 <= iterator ‐ array.begin() ‐ offset <= array.length()`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[bdlc::CompactedArray_ConstIterator<TYPE>]
xref:BloombergLP/bdlc/operator_minus-03.adoc[operator‐](
    xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[CompactedArray_ConstIterator<TYPE>] const& iterator,
    std::ptrdiff_t offset);
----

[.small]#xref:BloombergLP/bdlc/operator_minus-03.adoc[_» more..._]#

Return the number of elements between the specified `lhs` and `rhs` as a signed value. The behavior is undefined unless `lhs` and `rhs` reference the same array. Note that the return value is positive when a positive number of `rhs++` invocations would result in `lhs == rhs`, and negative when a positive number of `rhs‐‐` invocations would result in `lhs == rhs`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
std::ptrdiff_t
xref:BloombergLP/bdlc/operator_minus-08.adoc[operator‐](
    xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[CompactedArray_ConstIterator<TYPE>] const& lhs,
    xref:BloombergLP/bdlc/CompactedArray_ConstIterator.adoc[CompactedArray_ConstIterator<TYPE>] const& rhs);
----

[.small]#xref:BloombergLP/bdlc/operator_minus-08.adoc[_» more..._]#

Return the number of elements between specified `lhs` and `rhs`. The behavior is undefined unless `lhs` and `rhs` reference the same array.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
std::ptrdiff_t
xref:BloombergLP/bdlc/operator_minus-09.adoc[operator‐](
    xref:BloombergLP/bdlc/PackedIntArrayConstIterator.adoc[PackedIntArrayConstIterator<TYPE>] const& lhs,
    xref:BloombergLP/bdlc/PackedIntArrayConstIterator.adoc[PackedIntArrayConstIterator<TYPE>] const& rhs);
----

[.small]#xref:BloombergLP/bdlc/operator_minus-09.adoc[_» more..._]#


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