f_dst_norm_ppf Function

public impure function f_dst_norm_ppf(p, mu, sigma) result(x)

Impure wrapper function for f_dst_norm_ppf_core. Handles optional arguments and invalid values for arguments.

Arguments

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

probability between 0.0 - 1.0
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)

sample position


Calls

proc~~f_dst_norm_ppf~~CallsGraph proc~f_dst_norm_ppf f_dst_norm_ppf proc~f_dst_norm_ppf_core f_dst_norm_ppf_core proc~f_dst_norm_ppf->proc~f_dst_norm_ppf_core proc~s_err_print s_err_print proc~f_dst_norm_ppf->proc~s_err_print proc~s_err_warn s_err_warn proc~f_dst_norm_ppf->proc~s_err_warn proc~f_dst_norm_cdf_core f_dst_norm_cdf_core proc~f_dst_norm_ppf_core->proc~f_dst_norm_cdf_core proc~f_utl_r2c f_utl_r2c proc~s_err_print->proc~f_utl_r2c

Called by

proc~~f_dst_norm_ppf~~CalledByGraph proc~f_dst_norm_ppf f_dst_norm_ppf interface~fsml_norm_ppf fsml_norm_ppf interface~fsml_norm_ppf->proc~f_dst_norm_ppf

Source Code

impure function f_dst_norm_ppf(p, mu, sigma) result(x)

! ==== Description
!! Impure wrapper function for `f_dst_norm_ppf_core`.
!! Handles optional arguments and invalid values for arguments.

! ==== Declarations
  real(wp)   , intent(in)           :: p                !! probability between 0.0 - 1.0
  real(wp)   , intent(in), optional :: mu               !! distribution location (mean)
  real(wp)   , intent(in), optional :: sigma            !! distribution dispersion/scale (standard deviation)
  real(wp)                          :: mu_w             !! final value of mu
  real(wp)                          :: sigma_w          !! final value of sigma
  real(wp)                          :: x                !! sample position

! ==== Instructions

! ---- handle input

  ! assume location/mean = 0, overwrite if specified
  mu_w = 0.0_wp
  if (present(mu)) mu_w = mu

  ! assume sigma = 1, overwrite if specified
  sigma_w = 1.0_wp
  if (present(sigma)) sigma_w = sigma

  ! check if sigma value is valid
  if (sigma_w .le. 0.0_wp) then
     ! write error message and assign sentinel value if invalid
     call s_err_print(fsml_error(1))
     x = c_sentinel_r
     return
  endif

  ! check if p value is valid
  if (p .gt. 1.0_wp .or. p .lt. 0.0_wp) then
     ! write error message and assign sentinel value if invalid
     call s_err_print(fsml_error(1))
     x = c_sentinel_r
     return
  endif

! ---- compute PPF

  ! call pure function to calculate x
  x = f_dst_norm_ppf_core(p, mu_w, sigma_w)

  ! issue warning in case of suspicious result
  if (x .eq. c_sentinel_r) call s_err_warn(fsml_warning(1))

end function f_dst_norm_ppf