f_dst_chi2_pdf Function

public impure function f_dst_chi2_pdf(x, df, loc, scale) result(fx)

Impure wrapper function for f_dst_chi2_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 :: loc

location parameter
real(kind=wp), intent(in), optional :: scale

scale parameter

Return Value real(kind=wp)

resulting PDF value


Calls

proc~~f_dst_chi2_pdf~~CallsGraph proc~f_dst_chi2_pdf f_dst_chi2_pdf proc~f_dst_chi2_pdf_core f_dst_chi2_pdf_core proc~f_dst_chi2_pdf->proc~f_dst_chi2_pdf_core proc~s_err_print s_err_print proc~f_dst_chi2_pdf->proc~s_err_print proc~f_utl_r2c f_utl_r2c proc~s_err_print->proc~f_utl_r2c

Called by

proc~~f_dst_chi2_pdf~~CalledByGraph proc~f_dst_chi2_pdf f_dst_chi2_pdf interface~fsml_chi2_pdf fsml_chi2_pdf interface~fsml_chi2_pdf->proc~f_dst_chi2_pdf

Source Code

impure function f_dst_chi2_pdf(x, df, loc, scale) result(fx)

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

! ==== Declarations
  real(wp), intent(in)           :: x       !! sample position
  real(wp), intent(in)           :: df      !! degrees of freedom
  real(wp), intent(in), optional :: loc     !! location parameter
  real(wp), intent(in), optional :: scale   !! scale parameter
  real(wp)                       :: loc_w   !! final value for loc
  real(wp)                       :: scale_w !! final value for scale
  real(wp)                       :: fx      !! resulting PDF value

! ==== Instructions

! ---- handle input

  ! assume loc = 0, overwrite if specified
  loc_w = 0.0_wp
  if (present(loc)) loc_w = loc

  ! assume scale = 1, overwrite if specified
  scale_w = 1.0_wp
  if (present(scale)) scale_w = scale

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

  ! check if degrees of freedom value is valid
  if (df .le. 0.0_wp) then
     ! write error message and assign sentinel value if invalid
     call s_err_print(fsml_error(1))
     fx = c_sentinel_r
     return
  endif

! ----compute PDF

  ! call pure function to calculate probability/fx
  fx = f_dst_chi2_pdf_core(x, df, loc_w, scale_w)

end function f_dst_chi2_pdf