fsml_t_cdf Interface

public interface fsml_t_cdf

Cumulative distribution function for student t distribution.

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. The tail option (tail) is an optional argument. If passed, it must be one of the following: "left", "right", "two", or "confidence". If not passed, it will default to "left".

Calls

interface~~fsml_t_cdf~~CallsGraph interface~fsml_t_cdf fsml_t_cdf proc~f_dst_t_cdf f_dst_t_cdf interface~fsml_t_cdf->proc~f_dst_t_cdf proc~f_dst_t_cdf_core f_dst_t_cdf_core proc~f_dst_t_cdf->proc~f_dst_t_cdf_core proc~f_utl_assign_nan f_utl_assign_nan proc~f_dst_t_cdf->proc~f_utl_assign_nan proc~s_err_print s_err_print proc~f_dst_t_cdf->proc~s_err_print proc~f_dst_betai_core f_dst_betai_core proc~f_dst_t_cdf_core->proc~f_dst_betai_core

Module Procedures

public impure function f_dst_t_cdf(x, df, mu, sigma, tail) result(p)

Impure wrapper function for f_dst_t_cdf_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)
character(len=*), intent(in), optional :: tail

tail options

Return Value real(kind=wp)

returned probability integral