Skip to content

Commit

Permalink
add note instead of warning to parameter limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
@RMeli
RMeli committed Jul 10, 2024
1 parent 835344a commit 923d052
Showing 1 changed file with 56 additions and 36 deletions.
92 changes: 56 additions & 36 deletions src/dlaf_fortran.f90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,14 +145,16 @@ subroutine dlaf_pspotrf(uplo, n, a, ia, ja, desca, info)
!! Local part of the global matrix \(\mathbf{A}\)
integer, intent(in) :: ia
!! Row index of the global matrix identifying the first row of the sub-matrix \(\mathbf{A}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: ja
!! Column index of the global matrix identifying the first column of the sub-matrix \(\mathbf{A}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, dimension(9), intent(in) :: desca
!! ScaLAPACK descriptor of the global matrix \(\mathbf{A}\)
integer, target, intent(out) :: info
Expand Down Expand Up @@ -274,20 +276,26 @@ subroutine dlaf_pssyevd(uplo, n, a, ia, ja, desca, w, z, iz, jz, descz, info)
character, intent(in) :: uplo
!! Indicates whether the upper (`"U"`) or lower (`"L"`) triangular part of the global sub-matrix
!! \(\mathbf{A}\) is referenced
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: n
!! Order of the sub-matrix \(\mathbf{A}\) used in the computation
real(kind=sp), dimension(:, :), target, intent(inout) :: a
!! Local part of the global matrix \(\mathbf{A}\)
integer, intent(in) :: ia
!! Row index in the global matrix identifying the first row of the sub-matrix \(\mathbf{A}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: ja
!! Column index in the global matrix identifying the first column of the sub-matrix \(\mathbf{A}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, dimension(9), intent(in) :: desca
!! ScaLAPACK descriptor of the global matrix \(\mathbf{A}\)
real(kind=sp), dimension(:), target, intent(out) :: w
Expand All @@ -296,14 +304,16 @@ subroutine dlaf_pssyevd(uplo, n, a, ia, ja, desca, w, z, iz, jz, descz, info)
!! Local part of the global matrix \(\mathbf{Z}\)
integer, intent(in) :: iz
!! Row index in the global matrix identifying the first row of the sub-matrix \(\mathbf{Z}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: jz
!! Column index in the global matrix identifying the first column of the sub-matrix \(\mathbf{Z}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, dimension(9), intent(in) :: descz
!! ScaLAPACK descriptor of the global matrix \(\mathbf{Z}\)
integer, target, intent(out) :: info
Expand Down Expand Up @@ -453,34 +463,42 @@ subroutine dlaf_pssygvd(uplo, n, a, ia, ja, desca, b, ib, jb, descb, w, z, iz, j
character, intent(in) :: uplo
!! Indicates whether the upper (`"U"`) or lower (`"L"`) triangular part of the global sub-matrix
!! \(\mathbf{A}\) is referenced
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: n
!! Order of the sub-matrix \(\mathbf{A}\) used in the computation
real(kind=sp), dimension(:, :), target, intent(inout) :: a
!! Local part of the global matrix \(\mathbf{A}\)
integer, intent(in) :: ia
!! Row index in the global matrix identifying the first row of the sub-matrix \(\mathbf{A}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: ja
!! Column index in the global matrix identifying the first column of the sub-matrix \(\mathbf{A}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, dimension(9), intent(in) :: desca
!! ScaLAPACK descriptor of the global matrix \(\mathbf{A}\)
real(kind=sp), dimension(:, :), target, intent(inout) :: b
!! Local part of the global matrix \(\mathbf{B}\)
integer, intent(in) :: ib
!! Row index in the global matrix identifying the first row of the sub-matrix \(\mathbf{B}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: jb
!! Column index in the global matrix identifying the first column of the sub-matrix \(\mathbf{B}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, dimension(9), intent(in) :: descb
!! ScaLAPACK descriptor of the global matrix \(\mathbf{B}\)
real(kind=sp), dimension(:), target, intent(out) :: w
Expand All @@ -489,14 +507,16 @@ subroutine dlaf_pssygvd(uplo, n, a, ia, ja, desca, b, ib, jb, descb, w, z, iz, j
!! Local part of the global matrix \(\mathbf{Z}\)
integer, intent(in) :: iz
!! Row index in the global matrix identifying the first row of the sub-matrix \(\mathbf{Z}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, intent(in) :: jz
!! Column index in the global matrix identifying the first column of the sub-matrix \(\mathbf{Z}\)
!! @warning
!! Has to be `1`.
!! @endwarning
!! @note
!! Check restrictions on this parameter on the DLA-Future documentation, for the DLA-Future
!! version you are using.
!! @endnote
integer, dimension(9), intent(in) :: descz
!! ScaLAPACK descriptor of the global matrix \(\mathbf{Z}\)
integer, target, intent(out) :: info
Expand Down

0 comments on commit 923d052

Please sign in to comment.