UNPKG

1 kBMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function bitOr
4
5Bitwise OR two values, `x | y`.
6For matrices, the function is evaluated element wise.
7For units, the function is evaluated on the lowest print base.
8
9
10## Syntax
11
12```js
13math.bitOr(x, y)
14```
15
16### Parameters
17
18Parameter | Type | Description
19--------- | ---- | -----------
20`x` | number &#124; BigNumber &#124; Array &#124; Matrix | First value to or
21`y` | number &#124; BigNumber &#124; Array &#124; Matrix | Second value to or
22
23### Returns
24
25Type | Description
26---- | -----------
27number &#124; BigNumber &#124; Array &#124; Matrix | OR of `x` and `y`
28
29
30## Examples
31
32```js
33math.bitOr(1, 2) // returns number 3
34
35math.bitOr([1, 2, 3], 4) // returns Array [5, 6, 7]
36```
37
38
39## See also
40
41[bitAnd](bitAnd.md),
42[bitNot](bitNot.md),
43[bitXor](bitXor.md),
44[leftShift](leftShift.md),
45[rightArithShift](rightArithShift.md),
46[rightLogShift](rightLogShift.md)