Skip to content

Commit 90f553f

Browse files
committed
Merge branch 'least_squares' of github.com:perazz/stdlib into least_squares
2 parents 78a8f6e + 37857f0 commit 90f553f

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/specs/stdlib_linalg.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -622,9 +622,9 @@ Result vector `x` returns the approximate solution that minimizes the 2-norm \(
622622

623623
`b`: Shall be a rank-1 array containing the right-hand-side vector. It is an `intent(in)` argument.
624624

625-
`cond` (optional): Singular value cut-off threshold for rank evaluation: `s_i >= cond*maxval(s), i=1:rank`. Shall be a scalar, `intent(in)` argument.
625+
`cond` (optional): Shall be a scalar `real` value cut-off threshold for rank evaluation: `s_i >= cond*maxval(s), i=1:rank`. Shall be a scalar, `intent(in)` argument.
626626

627-
`overwrite_a` (optional): Shall be an input logical flag. if `.true.`, input matrix a will be used as temporary storage and overwritten. This avoids internal data allocation. This is an `intent(in)` argument.
627+
`overwrite_a` (optional): Shall be an input `logical` flag. If `.true.`, input matrix `A` will be used as temporary storage and overwritten. This avoids internal data allocation. This is an `intent(in)` argument.
628628

629629
`rank` (optional): Shall be an `integer` scalar value, that contains the rank of input matrix `A`. This is an `intent(out)` argument.
630630

@@ -634,8 +634,8 @@ Result vector `x` returns the approximate solution that minimizes the 2-norm \(
634634

635635
Returns an array value that represents the solution to the least squares system.
636636

637-
Raises `LINALG_ERROR` if the underlying SVD process did not converge.
638-
Raises `LINALG_VALUE_ERROR` if the matrix and rhs vectors have invalid/incompatible sizes.
637+
Raises `LINALG_ERROR` if the underlying Singular Value Decomposition process did not converge.
638+
Raises `LINALG_VALUE_ERROR` if the matrix and right-hand-side vector have invalid/incompatible sizes.
639639
Exceptions trigger an `error stop`.
640640

641641
### Example

0 commit comments

Comments
 (0)