lapack/gonum: clarify ok return from Dpstrf and Dpstf2

This commit is contained in:
Vladimir Chalupecky
2022-02-04 08:52:23 +01:00
committed by Vladimír Chalupecký
parent ce4adcfbd5
commit b091b0b4e2
3 changed files with 12 additions and 9 deletions

View File

@@ -27,9 +27,10 @@ import (
// On return, A contains the factor U or L from the Cholesky factorization and // On return, A contains the factor U or L from the Cholesky factorization and
// piv contains P stored such that P[piv[k],k] = 1. // piv contains P stored such that P[piv[k],k] = 1.
// //
// Dpstf2 returns the computed rank of A and whether the algorithm completed // Dpstf2 returns the computed rank of A and whether the factorization can be
// successfully. If ok is false, the matrix A is either rank deficient or is not // used to solve a system. Dpstf2 does not attempt to check that A is positive
// positive semidefinite. // semi-definite, so if ok is false, the matrix A is either rank deficient or is
// not positive semidefinite.
// //
// The length of piv must be n and the length of work must be at least 2*n, // The length of piv must be n and the length of work must be at least 2*n,
// otherwise Dpstf2 will panic. // otherwise Dpstf2 will panic.

View File

@@ -27,9 +27,10 @@ import (
// On return, A contains the factor U or L from the Cholesky factorization and // On return, A contains the factor U or L from the Cholesky factorization and
// piv contains P stored such that P[piv[k],k] = 1. // piv contains P stored such that P[piv[k],k] = 1.
// //
// Dpstrf returns the computed rank of A and whether the algorithm completed // Dpstrf returns the computed rank of A and whether the factorization can be
// successfully. If ok is false, the matrix A is either rank deficient or is not // used to solve a system. Dpstrf does not attempt to check that A is positive
// positive semidefinite. // semi-definite, so if ok is false, the matrix A is either rank deficient or is
// not positive semidefinite.
// //
// The length of piv must be n and the length of work must be at least 2*n, // The length of piv must be n and the length of work must be at least 2*n,
// otherwise Dpstrf will panic. // otherwise Dpstrf will panic.

View File

@@ -145,9 +145,10 @@ func Pbtrs(t blas64.TriangularBand, b blas64.General) {
// and the underlying data between a and t is shared. P is stored on return in // and the underlying data between a and t is shared. P is stored on return in
// vector piv such that P[piv[k],k] = 1. // vector piv such that P[piv[k],k] = 1.
// //
// Pstrf also returns the computed rank of A and whether the algorithm completed // Pstrf returns the computed rank of A and whether the factorization can be
// successfully. If ok is false, the matrix A is either rank deficient or is not // used to solve a system. Pstrf does not attempt to check that A is positive
// positive semidefinite. // semi-definite, so if ok is false, the matrix A is either rank deficient or is
// not positive semidefinite.
// //
// The length of piv must be n and the length of work must be at least 2*n, // The length of piv must be n and the length of work must be at least 2*n,
// otherwise Pstrf will panic. // otherwise Pstrf will panic.