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

64 lines
1.2 KiB
Plaintext

{{alias}}( x, v )
Evaluates the cumulative distribution function (CDF) for a Student's t
distribution with degrees of freedom `v` at a value `x`.
If provided `NaN` as any argument, the function returns `NaN`.
If provided a non-positive value for `v`, the function returns `NaN`.
Parameters
----------
x: number
Input value.
v: number
Degrees of freedom.
Returns
-------
out: number
Evaluated CDF.
Examples
--------
> var y = {{alias}}( 2.0, 0.1 )
~0.611
> y = {{alias}}( 1.0, 2.0 )
~0.789
> y = {{alias}}( -1.0, 4.0 )
~0.187
> y = {{alias}}( NaN, 1.0 )
NaN
> y = {{alias}}( 0.0, NaN )
NaN
> y = {{alias}}( 2.0, -1.0 )
NaN
{{alias}}.factory( v )
Returns a function for evaluating the cumulative distribution function (CDF)
of a Student's t distribution with degrees of freedom `v`.
Parameters
----------
v: number
Degrees of freedom.
Returns
-------
cdf: Function
Cumulative distribution function (CDF).
Examples
--------
> var mycdf = {{alias}}.factory( 0.5 );
> var y = mycdf( 3.0 )
~0.816
> y = mycdf( 1.0 )
~0.699
See Also
--------