Lodestar.Stats 0.2.0. This page is frozen at that release. Read the current documentation for what main says now. A link to a decision or a migration page follows main, and leaves the archive.

Distributions.StudentQuantile

The value a Student's t falls below with probability p.

public static double StudentQuantile(double p, double df)

Parameters — p is a probability strictly inside (0, 1). df is the degrees of freedom, which must be positive.

Returns — scipy.stats.t.ppf(p, df).

Exceptions — ArgumentOutOfRangeException when p is not strictly inside (0, 1), or when df is not positive. NaN is refused on both.

Example — the multiplier a 95% interval asks for.

using Lodestar.Stats;

double multiplier = Distributions.StudentQuantile(0.975, 12.0);  // => 2.1788128296672298

// It is the value whose upper tail is the other 2.5%.
double tail = Distributions.StudentSf(multiplier, 12.0);          // => 0.024999999999999998

// An interval is then estimate ± multiplier × standard error.
double halfWidth = multiplier * 0.4;                              // => 0.871525…

Remarks — this is the quantile, not the inverse survival function, and the distinction is not pedantic. The internal helper it delegates to solves P(T > x) = p and therefore carries the opposite sign; the two are related by the distribution's symmetry about zero. Published under that helper's own convention, this method would have returned -2.18 where every printed table shows +2.18, and an interval built on it would have been reflected through its own estimate.

The endpoints are refused rather than answered. 0 and 1 map to the two infinities, which is a shape a caller means to handle rather than to receive.

Applies to — net10.0, netstandard2.0.

See also — Distributions.StudentSf, Distributions.FisherSf.