[#SaturatingLeftShift]
= SaturatingLeftShift
:mrdocs:

Left bit shift with safe minimum and maximum values&period;

== Synopsis

Declared in `&lt;util&sol;overflow&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;std::integral T&gt;
constexpr
T
SaturatingLeftShift(
    T input,
    unsigned int shift) noexcept;
----

== Return Value

(input &ast; 2&circ;shift) clamped to fit between the lowest and highest representable values of the type T&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *input*
| The input value to be left shifted&period;
| *shift*
| The number of bits to left shift&period;
|===


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