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