f_dst_logistic_ppf_core Function

public elemental function f_dst_logistic_ppf_core(p, mu, scale) result(x)

Percent point function/quantile function for logistic distribution.

Arguments

Type IntentOptional Attributes Name
real(kind=wp), intent(in) :: p

probability between 0.0 - 1.0

real(kind=wp), intent(in) :: mu

distribution location (mean)

real(kind=wp), intent(in) :: scale

distribution scale

Return Value real(kind=wp)


Called by

proc~~f_dst_logistic_ppf_core~~CalledByGraph proc~f_dst_logistic_ppf_core f_dst_logistic_ppf_core proc~f_dst_logistic_ppf f_dst_logistic_ppf proc~f_dst_logistic_ppf->proc~f_dst_logistic_ppf_core interface~fsml_logistic_ppf fsml_logistic_ppf interface~fsml_logistic_ppf->proc~f_dst_logistic_ppf

Source Code

elemental function f_dst_logistic_ppf_core(p, mu, scale) result(x)

! ==== Description
!! Percent point function/quantile function for logistic distribution.

! ==== Declarations
  real(wp), intent(in) :: p     !! probability between 0.0 - 1.0
  real(wp), intent(in) :: mu    !! distribution location (mean)
  real(wp), intent(in) :: scale !! distribution scale
  real(wp)             :: x

! ==== Instructions

  ! calculate position based on probability
  x = mu + scale * log(p / (1.0_wp - p))

end function f_dst_logistic_ppf_core