f_sts_slope Function

public impure function f_sts_slope(x, y) result(slope)

Impure wrapper function for f_sts_slope_core.

Arguments

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

x vector (assumed size array)
real(kind=wp), intent(in) :: y(:)

y vector (assumed size array)

Return Value real(kind=wp)

slope/regression slope


Calls

proc~~f_sts_slope~~CallsGraph proc~f_sts_slope f_sts_slope proc~f_sts_slope_core f_sts_slope_core proc~f_sts_slope->proc~f_sts_slope_core proc~f_utl_assign_nan f_utl_assign_nan proc~f_sts_slope->proc~f_utl_assign_nan proc~s_err_print s_err_print proc~f_sts_slope->proc~s_err_print proc~f_sts_cov_core f_sts_cov_core proc~f_sts_slope_core->proc~f_sts_cov_core proc~f_sts_var_core f_sts_var_core proc~f_sts_slope_core->proc~f_sts_var_core proc~f_sts_mean_core f_sts_mean_core proc~f_sts_cov_core->proc~f_sts_mean_core proc~f_sts_var_core->proc~f_sts_mean_core

Called by

proc~~f_sts_slope~~CalledByGraph proc~f_sts_slope f_sts_slope interface~fsml_slope fsml_slope interface~fsml_slope->proc~f_sts_slope

Source Code

impure function f_sts_slope(x, y) result(slope)

! ==== Description
!! Impure wrapper function for `f_sts_slope_core`.

! ==== Declarations
  real(wp), intent(in) :: x(:)  !! x vector (assumed size array)
  real(wp), intent(in) :: y(:)  !! y vector (assumed size array)
  real(wp)             :: slope !! slope/regression slope

! ==== Instructions

! ---- handle input

  ! check if size is valid
  if (size(x) .le. 1) then
     ! write error message and assign NaN value if invalid
     call s_err_print(fsml_error(4))
     slope = f_utl_assign_nan()
     return
  endif

  ! check if x and y have same size
  if (size(x) .ne. size(y)) then
     ! write error message and assign NaN value if invalid
     call s_err_print(fsml_error(4))
     slope = f_utl_assign_nan()
     return
  endif

! ---- compute slope

  ! call pure function
  slope = f_sts_slope_core(x, y)

end function f_sts_slope