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

Return the signed distance between the specified `lhs` and `rhs`.

== Synopsis

Declared in `<bdlc_compactedarray.h>`

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

== Description

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`.

== Return Value

signed distance from `rhs` to `lhs`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *lhs*
| left‐hand‐side iterator
| *rhs*
| right‐hand‐side iterator
|===


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