simple-squiggle/node_modules/mathjs/docs/reference/functions/bitOr.md

53 lines
1.0 KiB
Markdown

<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
# Function bitOr
Bitwise OR two values, `x | y`.
For matrices, the function is evaluated element wise.
For units, the function is evaluated on the lowest print base.
## Syntax
```js
math.bitOr(x, y)
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`x` | number &#124; BigNumber &#124; Array &#124; Matrix | First value to or
`y` | number &#124; BigNumber &#124; Array &#124; Matrix | Second value to or
### Returns
Type | Description
---- | -----------
number &#124; BigNumber &#124; Array &#124; Matrix | OR of `x` and `y`
### Throws
Type | Description
---- | -----------
## Examples
```js
math.bitOr(1, 2) // returns number 3
math.bitOr([1, 2, 3], 4) // returns Array [5, 6, 7]
```
## See also
[bitAnd](bitAnd.md),
[bitNot](bitNot.md),
[bitXor](bitXor.md),
[leftShift](leftShift.md),
[rightArithShift](rightArithShift.md),
[rightLogShift](rightLogShift.md)