1.1 KiB
1.1 KiB
Function leftShift
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.
Syntax
math.leftShift(x, y)
Parameters
| Parameter | Type | Description |
|---|---|---|
x |
number | BigNumber | Array | Matrix | Value to be shifted |
y |
number | BigNumber | Amount of shifts |
Returns
| Type | Description |
|---|---|
| number | BigNumber | Array | Matrix | x shifted left y times |
Throws
| Type | Description |
|---|
Examples
math.leftShift(1, 2) // returns number 4
math.leftShift([1, 2, 3], 4) // returns Array [16, 32, 64]
See also
leftShift, bitNot, bitOr, bitXor, rightArithShift, rightLogShift