Skip to content

Commit 1915bbb

Browse files
committed
Clarify return value documentation
1 parent a759929 commit 1915bbb

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/specs/stdlib_linalg.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ Checks if a matrix is square
227227

228228
### Return value
229229

230-
Returns a logical value that is true if the input matrix is square, and false otherwise.
230+
Returns a `logical` scalar that is `.true.` if the input matrix is square, and `.false.` otherwise.
231231

232232
### Example
233233

@@ -264,7 +264,7 @@ Checks if a matrix is diagonal
264264

265265
### Return value
266266

267-
Returns a logical value that is true if the input matrix is diagonal, and false otherwise.
267+
Returns a `logical` scalar that is `.true.` if the input matrix is diagonal, and `.false.` otherwise.
268268
Note that nonsquare matrices may be diagonal, so long as `a_ij = 0` when `i /= j`.
269269

270270
### Example
@@ -302,7 +302,7 @@ Checks if a matrix is symmetric
302302

303303
### Return value
304304

305-
Returns a logical value that is true if the input matrix is symmetric, and false otherwise.
305+
Returns a `logical` scalar that is `.true.` if the input matrix is symmetric, and `.false.` otherwise.
306306

307307
### Example
308308

@@ -339,7 +339,7 @@ Checks if a matrix is skew-symmetric
339339

340340
### Return value
341341

342-
Returns a logical value that is true if the input matrix is skew-symmetric, and false otherwise.
342+
Returns a `logical` scalar that is `.true.` if the input matrix is skew-symmetric, and `.false.` otherwise.
343343

344344
### Example
345345

@@ -376,7 +376,7 @@ Checks if a matrix is Hermitian
376376

377377
### Return value
378378

379-
Returns a logical value that is true if the input matrix is Hermitian, and false otherwise.
379+
Returns a `logical` scalar that is `.true.` if the input matrix is Hermitian, and `.false.` otherwise.
380380

381381
### Example
382382

@@ -415,8 +415,8 @@ Checks if a matrix is triangular
415415

416416
### Return value
417417

418-
Returns a logical value that is true if the input matrix is the type of triangular specified by `uplo` (upper or lower), and false otherwise.
419-
Note that the definition of triangular used here allows nonsquare matrices to be triangular.
418+
Returns a `logical` scalar that is `.true.` if the input matrix is the type of triangular specified by `uplo` (upper or lower), and `.false.` otherwise.
419+
Note that the definition of triangular used in this implementation allows nonsquare matrices to be triangular.
420420
Specifically, upper triangular matrices satisfy `a_ij = 0` when `j < i`, and lower triangular matrices satisfy `a_ij = 0` when `j > i`.
421421

422422
### Example
@@ -456,8 +456,8 @@ Checks if a matrix is Hessenberg
456456

457457
### Return value
458458

459-
Returns a logical value that is true if the input matrix is the type of Hessenberg specified by `uplo` (upper or lower), and false otherwise.
460-
Note that the definition of Hessenberg used here allows nonsquare matrices to be Hessenberg.
459+
Returns a `logical` scalar that is `.true.` if the input matrix is the type of Hessenberg specified by `uplo` (upper or lower), and `.false.` otherwise.
460+
Note that the definition of Hessenberg used in this implementation allows nonsquare matrices to be Hessenberg.
461461
Specifically, upper Hessenberg matrices satisfy `a_ij = 0` when `j < i-1`, and lower Hessenberg matrices satisfy `a_ij = 0` when `j > i+1`.
462462

463463
### Example

0 commit comments

Comments
 (0)