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

29 lines
472 B
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{{alias}}( σ )
Returns the expected value of a Rayleigh distribution.
If provided `NaN` as any argument, the function returns `NaN`.
If provided `σ <= 0`, the function returns `NaN`.
Parameters
----------
σ: number
Scale parameter.
Returns
-------
out: number
Expected value.
Examples
--------
> var v = {{alias}}( 11.0 )
~13.786
> v = {{alias}}( 4.5 )
~5.64
See Also
--------