time-to-botec/js/node_modules/@stdlib/stats/base/dists/laplace/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

39 lines
676 B
Plaintext

{{alias}}( μ, b )
Returns the mode of a Laplace distribution with location parameter `μ` and
scale parameter `b`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `b <= 0`, the function returns `NaN`.
Parameters
----------
μ: number
Location parameter.
b: number
Scale parameter.
Returns
-------
out: number
Mode.
Examples
--------
> var y = {{alias}}( 0.0, 1.0 )
0.0
> y = {{alias}}( 4.0, 2.0 )
4.0
> y = {{alias}}( NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN )
NaN
> y = {{alias}}( 0.0, 0.0 )
NaN
See Also
--------