diff --git a/cgo/lapack.go b/cgo/lapack.go index c76dcb16..ef92d752 100644 --- a/cgo/lapack.go +++ b/cgo/lapack.go @@ -82,10 +82,10 @@ func (impl Implementation) Dpotrf(ul blas.Uplo, n int, a []float64, lda int) (ok // In a QR factorization, Q is an m×m orthonormal matrix, and R is an // upper triangular m×n matrix. // -// During Dgeqr2, a is modified to contain the information to construct Q and R. +// A is modified to contain the information to construct Q and R. // The upper triangle of a contains the matrix R. The lower triangular elements // (not including the diagonal) contain the elementary reflectors. Tau is modified -// to contain the reflector scales. Tau must have length at least k = min(m,n), and +// to contain the reflector scales. tau must have length at least min(m,n), and // this function will panic otherwise. // // The ith elementary reflector can be explicitly constructed by first extracting @@ -115,14 +115,14 @@ func (impl Implementation) Dgeqr2(m, n int, a []float64, lda int, tau, work []fl } // Dgeqrf computes the QR factorization of the m×n matrix A using a blocked -// algorithm. Please see the documentation for Dgeqr2 for a description of the +// algorithm. See the documentation for Dgeqr2 for a description of the // parameters at entry and exit. // // The C interface does not support providing temporary storage. To provide compatibility // with native, lwork == -1 will not run Dgeqrf but will instead write the minimum // work necessary to work[0]. If len(work) < lwork, Dgels will panic. // -// tau must be at least len min(m,n), and this function will panic otherwise. +// tau must have length at least min(m,n), and this function will panic otherwise. func (impl Implementation) Dgeqrf(m, n int, a []float64, lda int, tau, work []float64, lwork int) { if lwork == -1 { work[0] = float64(n) diff --git a/lapack64/lapack64.go b/lapack64/lapack64.go index c2d58eb1..1474153c 100644 --- a/lapack64/lapack64.go +++ b/lapack64/lapack64.go @@ -49,10 +49,10 @@ func Potrf(a blas64.Symmetric) (t blas64.Triangular, ok bool) { } // Geqrf computes the QR factorization of the m×n matrix A using a blocked -// algorithm. During Dgeqr2, A is modified to contain the information to construct Q and R. +// algorithm. A is modified to contain the information to construct Q and R. // The upper triangle of a contains the matrix R. The lower triangular elements // (not including the diagonal) contain the elementary reflectors. Tau is modified -// to contain the reflector scales. Tau must have length at least k = min(m,n), and +// to contain the reflector scales. Tau must have length at least min(m,n), and // this function will panic otherwise. // // The ith elementary reflector can be explicitly constructed by first extracting diff --git a/native/dgeqr2.go b/native/dgeqr2.go index a1bb4d74..38678b63 100644 --- a/native/dgeqr2.go +++ b/native/dgeqr2.go @@ -11,10 +11,10 @@ import "github.com/gonum/blas" // In a QR factorization, Q is an m×m orthonormal matrix, and R is an // upper triangular m×n matrix. // -// During Dgeqr2, a is modified to contain the information to construct Q and R. +// A is modified to contain the information to construct Q and R. // The upper triangle of a contains the matrix R. The lower triangular elements // (not including the diagonal) contain the elementary reflectors. Tau is modified -// to contain the reflector scales. Tau must have length at least k = min(m,n), and +// to contain the reflector scales. tau must have length at least min(m,n), and // this function will panic otherwise. // // The ith elementary reflector can be explicitly constructed by first extracting diff --git a/native/dgeqrf.go b/native/dgeqrf.go index 4745a08a..94c8b649 100644 --- a/native/dgeqrf.go +++ b/native/dgeqrf.go @@ -10,7 +10,7 @@ import ( ) // Dgeqrf computes the QR factorization of the m×n matrix A using a blocked -// algorithm. Please see the documentation for Dgeqr2 for a description of the +// algorithm. See the documentation for Dgeqr2 for a description of the // parameters at entry and exit. // // Work is temporary storage, and lwork specifies the usable memory length. @@ -19,7 +19,7 @@ import ( // by the temporary space available. If lwork == -1, instead of performing Dgelqf, // the optimal work length will be stored into work[0]. // -// tau must be at least len min(m,n), and this function will panic otherwise. +// tau must have length at least min(m,n), and this function will panic otherwise. func (impl Implementation) Dgeqrf(m, n int, a []float64, lda int, tau, work []float64, lwork int) { // nb is the optimal blocksize, i.e. the number of columns transformed at a time. nb := impl.Ilaenv(1, "DGEQRF", " ", m, n, -1, -1)