Skip to content

Commit d3b555b

Browse files
committed
some ford mods
added graphs, private procedures, and docstring cleanups
1 parent 4ae366a commit d3b555b

File tree

2 files changed

+20
-22
lines changed

2 files changed

+20
-22
lines changed

ford.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ predocmark: <
1111
docmark_alt:
1212
docmark: !
1313
display: public
14+
private
1415
source: true
15-
graph: false
16+
graph: true
1617
search: true
1718
preprocessor: gfortran -E
1819
extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html

src/polyroots_module.F90

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3592,8 +3592,8 @@ recursive subroutine cmplx_laguerre(poly, degree, root, iter, success)
35923592
!!```
35933593
integer, intent(out) :: iter !! number of iterations performed (the number of polynomial
35943594
!! evaluations and stopping criterion evaluation)
3595-
complex(wp), intent(inout) :: root !! input: guess for the value of a root
3596-
!! output: a root of the polynomial
3595+
complex(wp), intent(inout) :: root !! * input: guess for the value of a root
3596+
!! * output: a root of the polynomial
35973597
!!
35983598
!! Uses 'root' value as a starting point (!!!!!)
35993599
!! Remember to initialize 'root' to some initial guess or to
@@ -3793,12 +3793,12 @@ recursive subroutine cmplx_laguerre2newton(poly, degree, root, iter, success, st
37933793
!! 1 2 3
37943794
!! poly(1) x^0 + poly(2) x^1 + poly(3) x^2 + ...
37953795
!!```
3796-
complex(wp), intent(inout) :: root !! input: guess for the value of a root
3797-
!! output: a root of the polynomial
3798-
!!
3799-
!! Uses 'root' value as a starting point (!!!!!)
3800-
!! Remember to initialize 'root' to some initial guess or to
3801-
!! point (0,0) if you have no prior knowledge.
3796+
complex(wp), intent(inout) :: root !! * input: guess for the value of a root
3797+
!! * output: a root of the polynomial
3798+
!!
3799+
!! Uses 'root' value as a starting point (!!!!!)
3800+
!! Remember to initialize 'root' to some initial guess or to
3801+
!! point (0,0) if you have no prior knowledge.
38023802
integer, intent(in) :: starting_mode !! this should be by default = 2. However if you
38033803
!! choose to start with SG method put 1 instead.
38043804
!! Zero will cause the routine to
@@ -5262,13 +5262,10 @@ function ctest(n, a, il, i, ir)
52625262
integer,intent(in) :: il !! integers such that il<i<ir
52635263
integer,intent(in) :: ir !! integers such that il<i<ir
52645264
real(wp),intent(in) :: a(n) !! vector of double
5265-
logical :: ctest !! Result:
5266-
!!
5267-
!! * .true. if the angle formed by (il,a(il)), (i,a(i)), (ir,a(ir)) at
5265+
logical :: ctest !! * .true. if the angle formed by (il,a(il)), (i,a(i)), (ir,a(ir)) at
52685266
!! the vertex (i,a(i)), is convex up to within the tolerance
52695267
!! toler, i.e., if
52705268
!! (a(i)-a(il))*(ir-i)-(a(ir)-a(i))*(i-il)>toler.
5271-
!!
52725269
!! * .false., otherwise.
52735270

52745271
real(wp) :: s1, s2
@@ -6599,16 +6596,16 @@ subroutine scomqr(nm,n,low,igh,hr,hi,z,ierr)
65996596
integer,intent(in) :: igh !! low and igh are integers determined by the balancing
66006597
!! subroutine cbal. if cbal has not been used,
66016598
!! set low=1, igh=n
6602-
real(wp),intent(inout) :: hi(nm,n) !! Input: hr and hi contain the real and imaginary parts,
6603-
!! respectively, of the complex upper hessenberg matrix.
6604-
!! their lower triangles below the subdiagonal contain
6605-
!! information about the unitary transformations used in
6606-
!! the reduction by corth, if performed.
6599+
real(wp),intent(inout) :: hi(nm,n) !! * Input: hr and hi contain the real and imaginary parts,
6600+
!! respectively, of the complex upper hessenberg matrix.
6601+
!! their lower triangles below the subdiagonal contain
6602+
!! information about the unitary transformations used in
6603+
!! the reduction by corth, if performed.
66076604
!!
6608-
!! Output: the upper hessenberg portions of hr and hi have been
6609-
!! destroyed. therefore, they must be saved before
6610-
!! calling comqr if subsequent calculation of
6611-
!! eigenvectors is to be performed,
6605+
!! * Output: the upper hessenberg portions of hr and hi have been
6606+
!! destroyed. therefore, they must be saved before
6607+
!! calling comqr if subsequent calculation of
6608+
!! eigenvectors is to be performed,
66126609
real(wp),intent(inout) :: hr(nm,n) !! see `hi` description
66136610
complex(wp),intent(out) :: z(n) !! the real and imaginary parts,
66146611
!! respectively, of the eigenvalues. if an error

0 commit comments

Comments
 (0)