time-to-botec/squiggle/node_modules/@stdlib/stats/base/dists/beta/logpdf/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

84 lines
1.7 KiB
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}}( x, α, β )
Evaluates the natural logarithm of the probability density function (PDF)
for a beta distribution with first shape parameter `α` and second shape
parameter `β` at a value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If `α <= 0` or `β <= 0`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
α: number
First shape parameter.
β: number
Second shape parameter.
Returns
-------
out: number
Natural logarithm of the PDF.
Examples
--------
> var y = {{alias}}( 0.5, 1.0, 1.0 )
0.0
> y = {{alias}}( 0.5, 2.0, 4.0 )
~0.223
> y = {{alias}}( 0.2, 2.0, 2.0 )
~-0.041
> y = {{alias}}( 0.8, 4.0, 4.0 )
~-0.556
> y = {{alias}}( -0.5, 4.0, 2.0 )
-Infinity
> y = {{alias}}( 1.5, 4.0, 2.0 )
-Infinity
> y = {{alias}}( 0.5, -1.0, 0.5 )
NaN
> y = {{alias}}( 0.5, 0.5, -1.0 )
NaN
> y = {{alias}}( NaN, 1.0, 1.0 )
NaN
> y = {{alias}}( 0.5, NaN, 1.0 )
NaN
> y = {{alias}}( 0.5, 1.0, NaN )
NaN
{{alias}}.factory( α, β )
Returns a function for evaluating the natural logarithm of the probability
density function (PDF) of a beta distribution with first shape parameter `α`
and second shape parameter `β`.
Parameters
----------
α: number
First shape parameter.
β: number
Second shape parameter.
Returns
-------
fcn: Function
Function to evaluate the natural logarithm of the PDF.
Examples
--------
> var mylogpdf = {{alias}}.factory( 0.5, 0.5 );
> var y = mylogpdf( 0.8 )
~-0.228
> y = mylogpdf( 0.3 )
~-0.364
See Also
--------