Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BLAS, LAPACK: Refactor comments for FORD compatibility #786

Merged
merged 3 commits into from
Apr 3, 2024
Merged

BLAS, LAPACK: Refactor comments for FORD compatibility #786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9092621
refactor comments for FORD
perazz Apr 3, 2024
5735af9
replace `!>` with `!!`
perazz Apr 3, 2024
2c4f087
remove inadvertently added script
perazz Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
458 changes: 227 additions & 231 deletions src/stdlib_linalg_blas.fypp
View file
Open in desktop

Large diffs are not rendered by default.

64 changes: 32 additions & 32 deletions src/stdlib_linalg_blas_aux.fypp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ module stdlib_linalg_blas_aux

contains

!> DCABS1: computes |Re(.)| + |Im(.)| of a double complex number

pure real(dp) function stdlib_dcabs1(z)
!! DCABS1 computes |Re(.)| + |Im(.)| of a double complex number
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand All @@ -43,9 +43,9 @@ module stdlib_linalg_blas_aux
return
end function stdlib_dcabs1

!> ISAMAX: finds the index of the first element having maximum absolute value.

pure integer(ilp) function stdlib_isamax(n,sx,incx)
!! ISAMAX finds the index of the first element having maximum absolute value.
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand Down Expand Up @@ -88,9 +88,9 @@ module stdlib_linalg_blas_aux
return
end function stdlib_isamax

!> IZAMAX: finds the index of the first element having maximum |Re(.)| + |Im(.)|

pure integer(ilp) function stdlib_izamax(n,zx,incx)
!! IZAMAX finds the index of the first element having maximum |Re(.)| + |Im(.)|
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand Down Expand Up @@ -131,10 +131,10 @@ module stdlib_linalg_blas_aux
return
end function stdlib_izamax

!> LSAME: returns .TRUE. if CA is the same letter as CB regardless of
!> case.

pure logical(lk) function stdlib_lsame(ca,cb)
!! LSAME returns .TRUE. if CA is the same letter as CB regardless of
!! case.
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand Down Expand Up @@ -178,9 +178,9 @@ module stdlib_linalg_blas_aux
! return
end function stdlib_lsame

!> SCABS1: computes |Re(.)| + |Im(.)| of a complex number

pure real(sp) function stdlib_scabs1(z)
!! SCABS1 computes |Re(.)| + |Im(.)| of a complex number
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand All @@ -193,13 +193,13 @@ module stdlib_linalg_blas_aux
return
end function stdlib_scabs1

!> XERBLA: is an error handler for the LAPACK routines.
!> It is called by an LAPACK routine if an input parameter has an
!> invalid value. A message is printed and execution stops.
!> Installers may consider modifying the STOP statement in order to
!> call system-specific exception-handling facilities.

pure subroutine stdlib_xerbla( srname, info )
!! XERBLA is an error handler for the LAPACK routines.
!! It is called by an LAPACK routine if an input parameter has an
!! invalid value. A message is printed and execution stops.
!! Installers may consider modifying the STOP statement in order to
!! call system-specific exception-handling facilities.
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand All @@ -214,24 +214,24 @@ module stdlib_linalg_blas_aux

end subroutine stdlib_xerbla

!> XERBLA_ARRAY: assists other languages in calling XERBLA, the LAPACK
!> and BLAS error handler. Rather than taking a Fortran string argument
!> as the function's name, XERBLA_ARRAY takes an array of single
!> characters along with the array's length. XERBLA_ARRAY then copies
!> up to 32 characters of that array into a Fortran string and passes
!> that to XERBLA. If called with a non-positive SRNAME_LEN,
!> XERBLA_ARRAY will call XERBLA with a string of all blank characters.
!> Say some macro or other device makes XERBLA_ARRAY available to C99
!> by a name lapack_xerbla and with a common Fortran calling convention.
!> Then a C99 program could invoke XERBLA via:
!> {
!> int flen = strlen(__func__);
!> lapack_xerbla(__func__,
!> }
!> Providing XERBLA_ARRAY is not necessary for intercepting LAPACK
!> errors. XERBLA_ARRAY calls XERBLA.

pure subroutine stdlib_xerbla_array(srname_array, srname_len, info)
!! XERBLA_ARRAY assists other languages in calling XERBLA, the LAPACK
!! and BLAS error handler. Rather than taking a Fortran string argument
!! as the function's name, XERBLA_ARRAY takes an array of single
!! characters along with the array's length. XERBLA_ARRAY then copies
!! up to 32 characters of that array into a Fortran string and passes
!! that to XERBLA. If called with a non-positive SRNAME_LEN,
!! XERBLA_ARRAY will call XERBLA with a string of all blank characters.
!! Say some macro or other device makes XERBLA_ARRAY available to C99
!! by a name lapack_xerbla and with a common Fortran calling convention.
!! Then a C99 program could invoke XERBLA via:
!! {
!! int flen = strlen(__func__);
!! lapack_xerbla(__func__,
!! }
!! Providing XERBLA_ARRAY is not necessary for intercepting LAPACK
!! errors. XERBLA_ARRAY calls XERBLA.
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand All @@ -257,9 +257,9 @@ module stdlib_linalg_blas_aux

#:if WITH_QP

!> DCABS1: computes |Re(.)| + |Im(.)| of a double complex number

pure real(qp) function stdlib_qcabs1(z)
!! DCABS1: computes |Re(.)| + |Im(.)| of a double complex number
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand All @@ -275,9 +275,9 @@ module stdlib_linalg_blas_aux

#:if WITH_QP

!> IDAMAX: finds the index of the first element having maximum absolute value.

pure integer(ilp) function stdlib_iqamax(n,dx,incx)
!! IDAMAX: finds the index of the first element having maximum absolute value.
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand Down Expand Up @@ -323,9 +323,9 @@ module stdlib_linalg_blas_aux

#:if WITH_QP

!> IZAMAX: finds the index of the first element having maximum |Re(.)| + |Im(.)|

pure integer(ilp) function stdlib_iwamax(n,zx,incx)
!! IZAMAX: finds the index of the first element having maximum |Re(.)| + |Im(.)|
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand Down Expand Up @@ -367,9 +367,9 @@ module stdlib_linalg_blas_aux
end function stdlib_iwamax
#:endif

!> ICAMAX: finds the index of the first element having maximum |Re(.)| + |Im(.)|

pure integer(ilp) function stdlib_icamax(n,cx,incx)
!! ICAMAX finds the index of the first element having maximum |Re(.)| + |Im(.)|
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand Down Expand Up @@ -410,9 +410,9 @@ module stdlib_linalg_blas_aux
return
end function stdlib_icamax

!> IDAMAX: finds the index of the first element having maximum absolute value.

pure integer(ilp) function stdlib_idamax(n,dx,incx)
!! IDAMAX finds the index of the first element having maximum absolute value.
! -- reference blas level1 routine --
! -- reference blas is a software package provided by univ. of tennessee, --
! -- univ. of california berkeley, univ. of colorado denver and nag ltd..--
Expand Down
Loading
Loading