updated math functions with correct names, resolves #522

pull/523/head
Scott Anderson 2019-10-15 13:36:43 -06:00
parent bd460647b5
commit a9f3fd12bd
6 changed files with 124 additions and 121 deletions

View File

@ -1,30 +0,0 @@
---
title: math.m_inf() function
description: The math.m_inf() function returns positive infinity if `sign >= 0`, negative infinity if `sign < 0`.
aliases:
- /v2.0/reference/flux/functions/math/m_inf/
menu:
v2_0_ref:
name: math.m_inf
parent: Math
weight: 301
---
The `math.m_inf()` function returns positive infinity if `sign >= 0`, negative infinity if `sign < 0`.
_**Output data type:** Float_
```js
import "math"
math.m_inf(sign: 1)
// Returns +Inf
```
## Parameters
### sign
The sign value used in the operation.
_**Data type:** Integer_

View File

@ -1,46 +0,0 @@
---
title: math.m_max() function
description: The math.m_max() function returns the larger of `x` or `y`.
aliases:
- /v2.0/reference/flux/functions/math/m_max/
menu:
v2_0_ref:
name: math.m_max
parent: Math
weight: 301
---
The `math.m_max()` function returns the larger of `x` or `y`.
_**Output data type:** Float_
```js
import "math"
math.m_max(x: 1.23, y: 4.56)
// Returns 4.56
```
## Parameters
### x
The X value used in the operation.
_**Data type:** Float_
### y
The Y value used in the operation.
_**Data type:** Float_
## Special cases
```js
math.m_max(x:x, y:+Inf) // Returns +Inf
math.m_max(x: +Inf, y:y) // Returns +Inf
math.m_max(x:x, y: NaN) // Returns NaN
math.m_max(x: NaN, y:y) // Returns NaN
math.m_max(x: +0, y: ±0) // Returns +0
math.m_max(x: ±0, y: +0) // Returns +0
math.m_max(x: -0, y: -0) // Returns -0
```

View File

@ -1,45 +0,0 @@
---
title: math.m_min() function
description: The math.m_min() function returns the smaller of `x` or `y`.
aliases:
- /v2.0/reference/flux/functions/math/m_min/
menu:
v2_0_ref:
name: math.m_min
parent: Math
weight: 301
---
The `math.m_min()` function returns the smaller of `x` or `y`.
_**Output data type:** Float_
```js
import "math"
math.m_min(x: 1.23, y: 4.56)
// Returns 1.23
```
## Parameters
### x
The X value used in the operation.
_**Data type:** Float_
### y
The Y value used in the operation.
_**Data type:** Float_
## Special cases
```js
Min(x:x, y: -Inf) // Returns -Inf
Min(x: -Inf, y:y) // Returns -Inf
Min(x:x, y: NaN) // Returns NaN
Min(x: NaN, y:y) // Returns NaN
Min(x: -0, y: ±0) // Returns -0
Min(x: ±0, y: -0) // Returns -0
```

View File

@ -0,0 +1,31 @@
---
title: math.mInf() function
description: The math.mInf() function returns positive infinity if `sign >= 0`, negative infinity if `sign < 0`.
aliases:
- /v2.0/reference/flux/functions/math/m_inf/
- /v2.0/reference/flux/stdlib/math/m_inf/
menu:
v2_0_ref:
name: math.mInf
parent: Math
weight: 301
---
The `math.mInf()` function returns positive infinity if `sign >= 0`, negative infinity if `sign < 0`.
_**Output data type:** Float_
```js
import "math"
math.mInf(sign: 1)
// Returns +Inf
```
## Parameters
### sign
The sign value used in the operation.
_**Data type:** Integer_

View File

@ -0,0 +1,47 @@
---
title: math.mMax() function
description: The math.mMax() function returns the larger of `x` or `y`.
aliases:
- /v2.0/reference/flux/functions/math/m_max/
- /v2.0/reference/flux/stdlib/math/m_max/
menu:
v2_0_ref:
name: math.mMax
parent: Math
weight: 301
---
The `math.mMax()` function returns the larger of `x` or `y`.
_**Output data type:** Float_
```js
import "math"
math.mMax(x: 1.23, y: 4.56)
// Returns 4.56
```
## Parameters
### x
The X value used in the operation.
_**Data type:** Float_
### y
The Y value used in the operation.
_**Data type:** Float_
## Special cases
```js
math.mMax(x:x, y:+Inf) // Returns +Inf
math.mMax(x: +Inf, y:y) // Returns +Inf
math.mMax(x:x, y: NaN) // Returns NaN
math.mMax(x: NaN, y:y) // Returns NaN
math.mMax(x: +0, y: ±0) // Returns +0
math.mMax(x: ±0, y: +0) // Returns +0
math.mMax(x: -0, y: -0) // Returns -0
```

View File

@ -0,0 +1,46 @@
---
title: math.mMin() function
description: The math.mMin() function returns the smaller of `x` or `y`.
aliases:
- /v2.0/reference/flux/functions/math/m_min/
- /v2.0/reference/flux/stdlib/math/m_min/
menu:
v2_0_ref:
name: math.mMin
parent: Math
weight: 301
---
The `math.mMin()` function returns the smaller of `x` or `y`.
_**Output data type:** Float_
```js
import "math"
math.mMin(x: 1.23, y: 4.56)
// Returns 1.23
```
## Parameters
### x
The X value used in the operation.
_**Data type:** Float_
### y
The Y value used in the operation.
_**Data type:** Float_
## Special cases
```js
math.mMin(x:x, y: -Inf) // Returns -Inf
math.mMin(x: -Inf, y:y) // Returns -Inf
math.mMin(x:x, y: NaN) // Returns NaN
math.mMin(x: NaN, y:y) // Returns NaN
math.mMin(x: -0, y: ±0) // Returns -0
math.mMin(x: ±0, y: -0) // Returns -0
```