54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function or
|
||
|
|
|
||
|
|
Logical `or`. Test if at least one value is defined with a nonzero/nonempty value.
|
||
|
|
For matrices, the function is evaluated element wise.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.or(x, y)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`x` | number | BigNumber | Complex | Unit | Array | Matrix | First value to check
|
||
|
|
`y` | number | BigNumber | Complex | Unit | Array | Matrix | Second value to check
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
boolean | Array | Matrix | Returns true when one of the inputs is defined with a nonzero/nonempty value.
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.or(2, 4) // returns true
|
||
|
|
|
||
|
|
a = [2, 5, 0]
|
||
|
|
b = [0, 22, 0]
|
||
|
|
c = 0
|
||
|
|
|
||
|
|
math.or(a, b) // returns [true, true, false]
|
||
|
|
math.or(b, c) // returns [false, true, false]
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[and](and.md),
|
||
|
|
[not](not.md),
|
||
|
|
[xor](xor.md)
|