[#BloombergLP-bdlc-operator_lshift-0683]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlc.adoc[bdlc]::operator<<
:relfileprefix: ../../
:mrdocs:

Left shift operators

== Synopses

Declared in `<bdlc_bitarray.h>`

Write `array` to `stream` in a single‐line format.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
std::ostream&
xref:BloombergLP/bdlc/operator_lshift-00.adoc[operator<<](
    std::ostream& stream,
    xref:BloombergLP/bdlc/PackedIntArray-0b.adoc[PackedIntArray<TYPE>] const& array);
----

[.small]#xref:BloombergLP/bdlc/operator_lshift-00.adoc[_» more..._]#

Return `array` left‐shifted by `numBits`, filling low bits with zeros.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:BloombergLP/bdlc/BitArray.adoc[bdlc::BitArray]
xref:BloombergLP/bdlc/operator_lshift-0688.adoc[operator<<](
    xref:BloombergLP/bdlc/BitArray.adoc[BitArray] const& array,
    std::size_t numBits);
----

[.small]#xref:BloombergLP/bdlc/operator_lshift-0688.adoc[_» more..._]#

Format the bits in the specified `rhs` bit array to the specified output `stream` in a single‐line format, and return a reference to `stream`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::ostream&
xref:BloombergLP/bdlc/operator_lshift-0f.adoc[operator<<](
    std::ostream& stream,
    xref:BloombergLP/bdlc/BitArray.adoc[BitArray] const& rhs);
----

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

Write the value of the specified `array` to the specified output `stream` in a single‐line format, and return a reference providing modifiable access to `stream`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class TYPE>
std::ostream&
xref:BloombergLP/bdlc/operator_lshift-0d3.adoc[operator<<](
    std::ostream& stream,
    xref:BloombergLP/bdlc/CompactedArray.adoc[CompactedArray<TYPE>] const& array);
----

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

Write the value of `map` to the specified output `stream`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class KEY,
    class VALUE,
    class HASH,
    class EQUAL>
std::ostream&
xref:BloombergLP/bdlc/operator_lshift-04.adoc[operator<<](
    std::ostream& stream,
    xref:BloombergLP/bdlc/FlatHashMap.adoc[FlatHashMap<KEY, VALUE, HASH, EQUAL>] const& map);
----

[.small]#xref:BloombergLP/bdlc/operator_lshift-04.adoc[_» more..._]#

Write the specified `queue` to the specified output `stream`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class T>
std::ostream&
xref:BloombergLP/bdlc/operator_lshift-08.adoc[operator<<](
    std::ostream& stream,
    xref:BloombergLP/bdlc/Queue.adoc[Queue<T>] const& queue);
----

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

Write the specified `rhs` index clerk to the specified output `stream`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::ostream&
xref:BloombergLP/bdlc/operator_lshift-0d5.adoc[operator<<](
    std::ostream& stream,
    xref:BloombergLP/bdlc/IndexClerk.adoc[IndexClerk] const& rhs);
----

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

Write the specified set to the specified output stream.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class KEY,
    class HASH,
    class EQUAL>
std::ostream&
xref:BloombergLP/bdlc/operator_lshift-0c.adoc[operator<<](
    std::ostream& stream,
    xref:BloombergLP/bdlc/FlatHashSet.adoc[FlatHashSet<KEY, HASH, EQUAL>] const& set);
----

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

== Return Value

* reference providing modifiable access to `stream`
* `array` left‐shifted by `numBits`
* reference to `stream`
* modifiable reference to `stream`
* reference to the modifiable `stream`

== Parameters

[cols="1,4"]
|===
| Name| Description
| *stream*
| output stream to write to
| *array*
| array to write
| *numBits*
| number of positions to shift left
| *rhs*
| bit array to format
| *map*
| map whose value is written
| *queue*
| queue whose value is written
| *set*
| set whose value is written
|===


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