2014-12-25 17:05:29 +01:00

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 | Boolean | Array | Matrix | null Value to be shifted
y Number | BigNumber | Boolean | null Amount of shifts

Returns

Type Description
Number | BigNumber | Array | Matrix x shifted left y times

Examples

math.leftShift(1, 2);               // returns Number 4

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

See also

bitAnd, bitNot, bitOr, bitXor, rightArithShift, rightLogShift