[#SaturatingLeftShift]
= SaturatingLeftShift
:mrdocs:

Left bit shift with safe minimum and maximum values.

== Synopsis

Declared in `<util/overflow.h>`

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

== Return Value

(input * 2ˆshift) clamped to fit between the lowest and highest representable values of the type T.

== Parameters

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


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