fsml_t_pdf Interface

public interface fsml_t_pdf

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.

Calls

interface~~fsml_t_pdf~~CallsGraph interface~fsml_t_pdf fsml_t_pdf proc~f_dst_t_pdf f_dst_t_pdf interface~fsml_t_pdf->proc~f_dst_t_pdf proc~f_dst_t_pdf_core f_dst_t_pdf_core proc~f_dst_t_pdf->proc~f_dst_t_pdf_core proc~s_err_print s_err_print proc~f_dst_t_pdf->proc~s_err_print proc~f_utl_r2c f_utl_r2c proc~s_err_print->proc~f_utl_r2c

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 IntentOptional 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)

Return Value real(kind=wp)