Skip to content

Commit a3fb05f

Browse files
langoulangou
authored
Merge pull request #159 from thielema/cleanup-comments
Several fixes to the parameter description comments. I need these for automated processing. More patches will follow.
2 parents 969a680 + ec1063e commit a3fb05f

33 files changed

Lines changed: 167 additions & 168 deletions

‎SRC/cbbcsd.f‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@
190190
*>
191191
*> \param[in,out] V2T
192192
*> \verbatim
193-
*> V2T is COMPLEX array, dimenison (LDV2T,M-Q)
193+
*> V2T is COMPLEX array, dimension (LDV2T,M-Q)
194194
*> On entry, an (M-Q)-by-(M-Q) matrix. On exit, V2T is
195195
*> premultiplied by the conjugate transpose of the right
196196
*> singular vector matrix common to [ B12 0 0 ; 0 -I 0 ] and

‎SRC/cggesx.f‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@
104104
*>
105105
*> \param[in] SELCTG
106106
*> \verbatim
107-
*> SELCTG is procedure) LOGICAL FUNCTION of two COMPLEX arguments
107+
*> SELCTG is a LOGICAL FUNCTION of two COMPLEX arguments
108108
*> SELCTG must be declared EXTERNAL in the calling subroutine.
109109
*> If SORT = 'N', SELCTG is not referenced.
110110
*> If SORT = 'S', SELCTG is used to select eigenvalues to sort

‎SRC/claqr1.f‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
*
5151
*> \param[in] N
5252
*> \verbatim
53-
*> N is integer
53+
*> N is INTEGER
5454
*> Order of the matrix H. N must be either 2 or 3.
5555
*> \endverbatim
5656
*>
@@ -62,7 +62,7 @@
6262
*>
6363
*> \param[in] LDH
6464
*> \verbatim
65-
*> LDH is integer
65+
*> LDH is INTEGER
6666
*> The leading dimension of H as declared in
6767
*> the calling procedure. LDH.GE.N
6868
*> \endverbatim

‎SRC/claqr2.f‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@
118118
*>
119119
*> \param[in] LDH
120120
*> \verbatim
121-
*> LDH is integer
121+
*> LDH is INTEGER
122122
*> Leading dimension of H just as declared in the calling
123123
*> subroutine. N .LE. LDH
124124
*> \endverbatim
@@ -146,29 +146,29 @@
146146
*>
147147
*> \param[in] LDZ
148148
*> \verbatim
149-
*> LDZ is integer
149+
*> LDZ is INTEGER
150150
*> The leading dimension of Z just as declared in the
151151
*> calling subroutine. 1 .LE. LDZ.
152152
*> \endverbatim
153153
*>
154154
*> \param[out] NS
155155
*> \verbatim
156-
*> NS is integer
156+
*> NS is INTEGER
157157
*> The number of unconverged (ie approximate) eigenvalues
158158
*> returned in SR and SI that may be used as shifts by the
159159
*> calling subroutine.
160160
*> \endverbatim
161161
*>
162162
*> \param[out] ND
163163
*> \verbatim
164-
*> ND is integer
164+
*> ND is INTEGER
165165
*> The number of converged eigenvalues uncovered by this
166166
*> subroutine.
167167
*> \endverbatim
168168
*>
169169
*> \param[out] SH
170170
*> \verbatim
171-
*> SH is COMPLEX array, dimension KBOT
171+
*> SH is COMPLEX array, dimension (KBOT)
172172
*> On output, approximate eigenvalues that may
173173
*> be used for shifts are stored in SH(KBOT-ND-NS+1)
174174
*> through SR(KBOT-ND). Converged eigenvalues are
@@ -183,14 +183,14 @@
183183
*>
184184
*> \param[in] LDV
185185
*> \verbatim
186-
*> LDV is integer scalar
186+
*> LDV is INTEGER
187187
*> The leading dimension of V just as declared in the
188188
*> calling subroutine. NW .LE. LDV
189189
*> \endverbatim
190190
*>
191191
*> \param[in] NH
192192
*> \verbatim
193-
*> NH is integer scalar
193+
*> NH is INTEGER
194194
*> The number of columns of T. NH.GE.NW.
195195
*> \endverbatim
196196
*>
@@ -201,14 +201,14 @@
201201
*>
202202
*> \param[in] LDT
203203
*> \verbatim
204-
*> LDT is integer
204+
*> LDT is INTEGER
205205
*> The leading dimension of T just as declared in the
206206
*> calling subroutine. NW .LE. LDT
207207
*> \endverbatim
208208
*>
209209
*> \param[in] NV
210210
*> \verbatim
211-
*> NV is integer
211+
*> NV is INTEGER
212212
*> The number of rows of work array WV available for
213213
*> workspace. NV.GE.NW.
214214
*> \endverbatim
@@ -220,7 +220,7 @@
220220
*>
221221
*> \param[in] LDWV
222222
*> \verbatim
223-
*> LDWV is integer
223+
*> LDWV is INTEGER
224224
*> The leading dimension of W just as declared in the
225225
*> calling subroutine. NW .LE. LDV
226226
*> \endverbatim
@@ -234,7 +234,7 @@
234234
*>
235235
*> \param[in] LWORK
236236
*> \verbatim
237-
*> LWORK is integer
237+
*> LWORK is INTEGER
238238
*> The dimension of the work array WORK. LWORK = 2*NW
239239
*> suffices, but greater efficiency may result from larger
240240
*> values of LWORK.

‎SRC/claqr3.f‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
*>
116116
*> \param[in] LDH
117117
*> \verbatim
118-
*> LDH is integer
118+
*> LDH is INTEGER
119119
*> Leading dimension of H just as declared in the calling
120120
*> subroutine. N .LE. LDH
121121
*> \endverbatim
@@ -143,29 +143,29 @@
143143
*>
144144
*> \param[in] LDZ
145145
*> \verbatim
146-
*> LDZ is integer
146+
*> LDZ is INTEGER
147147
*> The leading dimension of Z just as declared in the
148148
*> calling subroutine. 1 .LE. LDZ.
149149
*> \endverbatim
150150
*>
151151
*> \param[out] NS
152152
*> \verbatim
153-
*> NS is integer
153+
*> NS is INTEGER
154154
*> The number of unconverged (ie approximate) eigenvalues
155155
*> returned in SR and SI that may be used as shifts by the
156156
*> calling subroutine.
157157
*> \endverbatim
158158
*>
159159
*> \param[out] ND
160160
*> \verbatim
161-
*> ND is integer
161+
*> ND is INTEGER
162162
*> The number of converged eigenvalues uncovered by this
163163
*> subroutine.
164164
*> \endverbatim
165165
*>
166166
*> \param[out] SH
167167
*> \verbatim
168-
*> SH is COMPLEX array, dimension KBOT
168+
*> SH is COMPLEX array, dimension (KBOT)
169169
*> On output, approximate eigenvalues that may
170170
*> be used for shifts are stored in SH(KBOT-ND-NS+1)
171171
*> through SR(KBOT-ND). Converged eigenvalues are
@@ -180,14 +180,14 @@
180180
*>
181181
*> \param[in] LDV
182182
*> \verbatim
183-
*> LDV is integer scalar
183+
*> LDV is INTEGER
184184
*> The leading dimension of V just as declared in the
185185
*> calling subroutine. NW .LE. LDV
186186
*> \endverbatim
187187
*>
188188
*> \param[in] NH
189189
*> \verbatim
190-
*> NH is integer scalar
190+
*> NH is INTEGER
191191
*> The number of columns of T. NH.GE.NW.
192192
*> \endverbatim
193193
*>
@@ -198,14 +198,14 @@
198198
*>
199199
*> \param[in] LDT
200200
*> \verbatim
201-
*> LDT is integer
201+
*> LDT is INTEGER
202202
*> The leading dimension of T just as declared in the
203203
*> calling subroutine. NW .LE. LDT
204204
*> \endverbatim
205205
*>
206206
*> \param[in] NV
207207
*> \verbatim
208-
*> NV is integer
208+
*> NV is INTEGER
209209
*> The number of rows of work array WV available for
210210
*> workspace. NV.GE.NW.
211211
*> \endverbatim
@@ -217,7 +217,7 @@
217217
*>
218218
*> \param[in] LDWV
219219
*> \verbatim
220-
*> LDWV is integer
220+
*> LDWV is INTEGER
221221
*> The leading dimension of W just as declared in the
222222
*> calling subroutine. NW .LE. LDV
223223
*> \endverbatim
@@ -231,7 +231,7 @@
231231
*>
232232
*> \param[in] LWORK
233233
*> \verbatim
234-
*> LWORK is integer
234+
*> LWORK is INTEGER
235235
*> The dimension of the work array WORK. LWORK = 2*NW
236236
*> suffices, but greater efficiency may result from larger
237237
*> values of LWORK.

‎SRC/claqr4.f‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,6 @@
181181
*>
182182
*> \param[out] INFO
183183
*> \verbatim
184-
*> \verbatim
185184
*> INFO is INTEGER
186185
*> = 0: successful exit
187186
*> .GT. 0: if INFO = i, CLAQR4 failed to compute all of

‎SRC/claqr5.f‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
*>
6262
*> \param[in] KACC22
6363
*> \verbatim
64-
*> KACC22 is integer with value 0, 1, or 2.
64+
*> KACC22 is INTEGER with value 0, 1, or 2.
6565
*> Specifies the computation mode of far-from-diagonal
6666
*> orthogonal updates.
6767
*> = 0: CLAQR5 does not accumulate reflections and does not
@@ -77,19 +77,19 @@
7777
*>
7878
*> \param[in] N
7979
*> \verbatim
80-
*> N is integer scalar
80+
*> N is INTEGER
8181
*> N is the order of the Hessenberg matrix H upon which this
8282
*> subroutine operates.
8383
*> \endverbatim
8484
*>
8585
*> \param[in] KTOP
8686
*> \verbatim
87-
*> KTOP is integer scalar
87+
*> KTOP is INTEGER
8888
*> \endverbatim
8989
*>
9090
*> \param[in] KBOT
9191
*> \verbatim
92-
*> KBOT is integer scalar
92+
*> KBOT is INTEGER
9393
*> These are the first and last rows and columns of an
9494
*> isolated diagonal block upon which the QR sweep is to be
9595
*> applied. It is assumed without a check that
@@ -100,7 +100,7 @@
100100
*>
101101
*> \param[in] NSHFTS
102102
*> \verbatim
103-
*> NSHFTS is integer scalar
103+
*> NSHFTS is INTEGER
104104
*> NSHFTS gives the number of simultaneous shifts. NSHFTS
105105
*> must be positive and even.
106106
*> \endverbatim
@@ -123,7 +123,7 @@
123123
*>
124124
*> \param[in] LDH
125125
*> \verbatim
126-
*> LDH is integer scalar
126+
*> LDH is INTEGER
127127
*> LDH is the leading dimension of H just as declared in the
128128
*> calling procedure. LDH.GE.MAX(1,N).
129129
*> \endverbatim
@@ -151,7 +151,7 @@
151151
*>
152152
*> \param[in] LDZ
153153
*> \verbatim
154-
*> LDZ is integer scalar
154+
*> LDZ is INTEGER
155155
*> LDA is the leading dimension of Z just as declared in
156156
*> the calling procedure. LDZ.GE.N.
157157
*> \endverbatim
@@ -163,7 +163,7 @@
163163
*>
164164
*> \param[in] LDV
165165
*> \verbatim
166-
*> LDV is integer scalar
166+
*> LDV is INTEGER
167167
*> LDV is the leading dimension of V as declared in the
168168
*> calling procedure. LDV.GE.3.
169169
*> \endverbatim
@@ -176,14 +176,14 @@
176176
*>
177177
*> \param[in] LDU
178178
*> \verbatim
179-
*> LDU is integer scalar
179+
*> LDU is INTEGER
180180
*> LDU is the leading dimension of U just as declared in the
181181
*> in the calling subroutine. LDU.GE.3*NSHFTS-3.
182182
*> \endverbatim
183183
*>
184184
*> \param[in] NH
185185
*> \verbatim
186-
*> NH is integer scalar
186+
*> NH is INTEGER
187187
*> NH is the number of columns in array WH available for
188188
*> workspace. NH.GE.1.
189189
*> \endverbatim
@@ -195,14 +195,14 @@
195195
*>
196196
*> \param[in] LDWH
197197
*> \verbatim
198-
*> LDWH is integer scalar
198+
*> LDWH is INTEGER
199199
*> Leading dimension of WH just as declared in the
200200
*> calling procedure. LDWH.GE.3*NSHFTS-3.
201201
*> \endverbatim
202202
*>
203203
*> \param[in] NV
204204
*> \verbatim
205-
*> NV is integer scalar
205+
*> NV is INTEGER
206206
*> NV is the number of rows in WV agailable for workspace.
207207
*> NV.GE.1.
208208
*> \endverbatim
@@ -215,7 +215,7 @@
215215
*>
216216
*> \param[in] LDWV
217217
*> \verbatim
218-
*> LDWV is integer scalar
218+
*> LDWV is INTEGER
219219
*> LDWV is the leading dimension of WV as declared in the
220220
*> in the calling subroutine. LDWV.GE.NV.
221221
*> \endverbatim

‎SRC/ctgsen.f‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
*
7373
*> \param[in] IJOB
7474
*> \verbatim
75-
*> IJOB is integer
75+
*> IJOB is INTEGER
7676
*> Specifies whether condition numbers are required for the
7777
*> cluster of eigenvalues (PL and PR) or the deflating subspaces
7878
*> (Difu and Difl):

‎SRC/dbbcsd.f‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@
190190
*>
191191
*> \param[in,out] V2T
192192
*> \verbatim
193-
*> V2T is DOUBLE PRECISION array, dimenison (LDV2T,M-Q)
193+
*> V2T is DOUBLE PRECISION array, dimension (LDV2T,M-Q)
194194
*> On entry, an (M-Q)-by-(M-Q) matrix. On exit, V2T is
195195
*> premultiplied by the transpose of the right
196196
*> singular vector matrix common to [ B12 0 0 ; 0 -I 0 ] and

‎SRC/dgejsv.f‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,7 @@
362362
*>
363363
*> \param[out] IWORK
364364
*> \verbatim
365-
*> IWORK is INTEGER array, dimension M+3*N.
365+
*> IWORK is INTEGER array, dimension (M+3*N).
366366
*> On exit,
367367
*> IWORK(1) = the numerical rank determined after the initial
368368
*> QR factorization with pivoting. See the descriptions

0 commit comments

Comments
 (0)