mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-18 14:59:29 +00:00
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# Function rightArithShift
|
|
|
|
Bitwise right arithmetic 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
|
|
|
|
```js
|
|
math.rightArithShift(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` sign-filled shifted right `y` times
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
math.rightArithShift(4, 2); // returns Number 1
|
|
|
|
math.rightArithShift([16, -32, 64], 4); // returns Array [1, -2, 3]
|
|
```
|
|
|
|
|
|
## See also
|
|
|
|
[bitAnd](bitAnd.md),
|
|
[bitNot](bitNot.md),
|
|
[bitOr](bitOr.md),
|
|
[bitXor](bitXor.md),
|
|
[leftShift](leftShift.md),
|
|
[rightLogShift](rightLogShift.md)
|
|
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|