time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/triangular/mode/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

37 lines
612 B
Plaintext

{{alias}}( a, b, c )
Returns the mode of a triangular distribution.
If provided `NaN` as any argument, the function returns `NaN`.
If the condition `a <= c <= b` is not satisfied, the function returns `NaN`.
Parameters
----------
a: number
Minimum support.
b: number
Maximum support.
c: number
Mode.
Returns
-------
out: number
Mode.
Examples
--------
> var v = {{alias}}( 0.0, 1.0, 0.8 )
0.8
> v = {{alias}}( 4.0, 12.0, 5.0 )
5.0
> v = {{alias}}( 2.0, 8.0, 5.0 )
5.0
See Also
--------