s_tst_ranksum Subroutine

public impure subroutine s_tst_ranksum(x1, x2, u, p, h1)

Impure wrapper procedure for s_tst_ranksum_core.

Arguments

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

x1 vector (samples)
real(kind=wp), intent(in) :: x2(:)

x2 vector (samples)
real(kind=wp), intent(out) :: u

U statistic
real(kind=wp), intent(out) :: p

p-value
character(len=*), intent(in), optional :: h1

option: "two" (default), "lt", or "gt"

Calls

proc~~s_tst_ranksum~~CallsGraph proc~s_tst_ranksum s_tst_ranksum proc~s_err_print s_err_print proc~s_tst_ranksum->proc~s_err_print proc~s_tst_ranksum_core s_tst_ranksum_core proc~s_tst_ranksum->proc~s_tst_ranksum_core proc~f_utl_r2c f_utl_r2c proc~s_err_print->proc~f_utl_r2c proc~f_dst_norm_cdf_core f_dst_norm_cdf_core proc~s_tst_ranksum_core->proc~f_dst_norm_cdf_core proc~s_utl_rank s_utl_rank proc~s_tst_ranksum_core->proc~s_utl_rank

Called by

proc~~s_tst_ranksum~~CalledByGraph proc~s_tst_ranksum s_tst_ranksum interface~fsml_ranksum fsml_ranksum interface~fsml_ranksum->proc~s_tst_ranksum

Source Code

impure subroutine s_tst_ranksum(x1, x2, u, p, h1)

! ==== Description
!! Impure wrapper procedure for `s_tst_ranksum_core`.

! ==== Declarations
  real(wp)         , intent(in)           :: x1(:) !! x1 vector (samples)
  real(wp)         , intent(in)           :: x2(:) !! x2 vector (samples)
  real(wp)         , intent(out)          :: u     !! U statistic
  real(wp)         , intent(out)          :: p     !! p-value
  character(len=*) , intent(in), optional :: h1    !! \( H_{1} \) option: "two" (default), "lt", or "gt"
  character(len=16)                       :: h1_w  !! final value for h1

! ==== Instructions

! ---- handle input

  ! assume two-sided, overwrite if option is passed
  h1_w = "two"
  if (present(h1)) h1_w = h1

  ! check if h1 (tail) options are valid
  if (h1_w .ne. "lt" .and. h1_w .ne. "gt" .and. h1_w .ne. "two") then
     ! write error message and assign sentinel value if invalid
     call s_err_print(fsml_error(2))
     u  = c_sentinel_r
     p  = c_sentinel_r
     return
  endif

  ! check if size is valid
  if (size(x1) .le. 1) then
     ! write error message and assign sentinel value if invalid
     call s_err_print(fsml_error(4))
     u  = c_sentinel_r
     p  = c_sentinel_r
     return
  endif

  ! check if x1 and x2 have same size
  if (size(x1) .ne. size(x2)) then
     ! write error message and assign sentinel value if invalid
     call s_err_print(fsml_error(4))
     u  = c_sentinel_r
     p  = c_sentinel_r
     return
  endif

! ---- conduct test

  ! call pure procedure
  call s_tst_ranksum_core(x1, x2, u, p, h1_w)

end subroutine s_tst_ranksum