---
layout: default
---

<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->

<h1 id="function-leftshift">Function leftShift <a href="#function-leftshift" title="Permalink">#</a></h1>

Bitwise left logical shift of a value x by y number of bits, `x << y`.
For matrices, the function is evaluated element wise.
For units, the function is evaluated on the best prefix base.


<h2 id="syntax">Syntax <a href="#syntax" title="Permalink">#</a></h2>

```js
math.leftShift(x, y)
```

<h3 id="parameters">Parameters <a href="#parameters" title="Permalink">#</a></h3>

Parameter | Type | Description
--------- | ---- | -----------
`x` | number &#124; BigNumber &#124; Array &#124; Matrix | Value to be shifted
`y` | number &#124; BigNumber | Amount of shifts

<h3 id="returns">Returns <a href="#returns" title="Permalink">#</a></h3>

Type | Description
---- | -----------
number &#124; BigNumber &#124; Array &#124; Matrix | `x` shifted left `y` times


<h3 id="throws">Throws <a href="#throws" title="Permalink">#</a></h3>

Type | Description
---- | -----------


<h2 id="examples">Examples <a href="#examples" title="Permalink">#</a></h2>

```js
math.leftShift(1, 2)               // returns number 4

math.leftShift([1, 2, 4], 4)       // returns Array [16, 32, 64]
```


<h2 id="see-also">See also <a href="#see-also" title="Permalink">#</a></h2>

[leftShift](leftShift.html),
[bitNot](bitNot.html),
[bitOr](bitOr.html),
[bitXor](bitXor.html),
[rightArithShift](rightArithShift.html),
[rightLogShift](rightLogShift.html)