Probability density function for student t distribution.
Uses intrinsic gamma function (Fortran 2008 and later).
where = degrees of freedom (df) and is the gamma function.
The value for degrees of freedom (df) must be 1.0 or higher.
The location parameter (mu) is an optional argument and will default to 0.0 if not passed.
The scale parameter (sigma) is an optional argument. If passed, it must be non-zero positive.
It will default to 1.0 if not passed.
Nodes of different colours represent the following:
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Module Procedures
public impure function f_dst_t_pdf(x, df, mu, sigma) result(fx)
Impure wrapper function for f_dst_t_pdf_core.
Handles optional arguments and invalid values for arguments.
Arguments
Type
Intent
Optional
Attributes
Name
real(kind=wp),
intent(in)
::
x
sample position
real(kind=wp),
intent(in)
::
df
degrees of freedom
real(kind=wp),
intent(in),
optional
::
mu
distribution location (~mean)
real(kind=wp),
intent(in),
optional
::
sigma
distribution dispersion/scale (~standard deviation)