mat: remove from docs references to "matrix" package
MODIFY
mat/dense_arithmetic.go
mat/dense_arithmetic.go
@@ -468,7 +468,7 @@ func strictCopy(m *Dense, a Matrix) {
}
// Exp calculates the exponential of the matrix a, e^a, placing the result
-// in the receiver. Exp will panic with matrix.ErrShape if a is not square.
+// in the receiver. Exp will panic with ErrShape if a is not square.
func (m *Dense) Exp(a Matrix) {
// The implementation used here is from Functions of Matrices: Theory and Computation
// Chapter 10, Algorithm 10.20. https://doi.org/10.1137/1.9780898717778.ch10

MODIFY
mat/gsvd.go
mat/gsvd.go
@@ -72,7 +72,7 @@ func (gsvd *GSVD) succFact() bool {
// It is frequently not necessary to compute the full GSVD. Computation time and
// storage costs can be reduced using the appropriate kind. Either only the singular
// values can be computed (kind == SVDNone), or in conjunction with specific singular
-// vectors (kind bit set according to matrix.GSVDU, matrix.GSVDV and matrix.GSVDQ).
+// vectors (kind bit set according to GSVDU, GSVDV and GSVDQ).
//
// Factorize returns whether the decomposition succeeded. If the decomposition
// failed, routines that require a successful factorization will panic.
@@ -164,7 +164,7 @@ func (gsvd *GSVD) Rank() (k, l int) {
// GeneralizedValues returns the generalized singular values of the factorized matrices.
// If the input slice is non-nil, the values will be stored in-place into the slice.
// In this case, the slice must have length min(r,c)-k, and GeneralizedValues will
-// panic with matrix.ErrSliceLengthMismatch otherwise. If the input slice is nil,
+// panic with ErrSliceLengthMismatch otherwise. If the input slice is nil,
// a new slice of the appropriate length will be allocated and returned.
//
// GeneralizedValues will panic if the receiver does not contain a successful factorization.
@@ -189,7 +189,7 @@ func (gsvd *GSVD) GeneralizedValues(v []float64) []float64 {
// ValuesA returns the singular values of the factorized A matrix.
// If the input slice is non-nil, the values will be stored in-place into the slice.
// In this case, the slice must have length min(r,c)-k, and ValuesA will panic with
-// matrix.ErrSliceLengthMismatch otherwise. If the input slice is nil,
+// ErrSliceLengthMismatch otherwise. If the input slice is nil,
// a new slice of the appropriate length will be allocated and returned.
//
// ValuesA will panic if the receiver does not contain a successful factorization.
@@ -214,7 +214,7 @@ func (gsvd *GSVD) ValuesA(s []float64) []float64 {
// ValuesB returns the singular values of the factorized B matrix.
// If the input slice is non-nil, the values will be stored in-place into the slice.
// In this case, the slice must have length min(r,c)-k, and ValuesB will panic with
-// matrix.ErrSliceLengthMismatch otherwise. If the input slice is nil,
+// ErrSliceLengthMismatch otherwise. If the input slice is nil,
// a new slice of the appropriate length will be allocated and returned.
//
// ValuesB will panic if the receiver does not contain a successful factorization.

MODIFY
mat/hogsvd.go
mat/hogsvd.go
@@ -190,7 +190,7 @@ func (gsvd *HOGSVD) UTo(dst *Dense, n int) {
// Values returns the nth set of singular values of the factorized system.
// If the input slice is non-nil, the values will be stored in-place into the slice.
// In this case, the slice must have length c, and Values will panic with
-// matrix.ErrSliceLengthMismatch otherwise. If the input slice is nil,
+// ErrSliceLengthMismatch otherwise. If the input slice is nil,
// a new slice of the appropriate length will be allocated and returned.
//
// Values will panic if the receiver does not contain a successful factorization.

MODIFY
mat/io.go
mat/io.go
@@ -132,7 +132,7 @@ func (m Dense) MarshalBinaryTo(w io.Writer) (int, error) {
// See MarshalBinary for the on-disk layout.
//
// Limited checks on the validity of the binary input are performed:
-// - matrix.ErrShape is returned if the number of rows or columns is negative,
+// - ErrShape is returned if the number of rows or columns is negative,
// - an error is returned if the resulting Dense matrix is too
// big for the current architecture (e.g. a 16GB matrix written by a
// 64b application and read back from a 32b application.)
@@ -191,7 +191,7 @@ func (m *Dense) UnmarshalBinary(data []byte) error {
// See MarshalBinary for the on-disk layout.
//
// Limited checks on the validity of the binary input are performed:
-// - matrix.ErrShape is returned if the number of rows or columns is negative,
+// - ErrShape is returned if the number of rows or columns is negative,
// - an error is returned if the resulting Dense matrix is too
// big for the current architecture (e.g. a 16GB matrix written by a
// 64b application and read back from a 32b application.)
@@ -318,7 +318,7 @@ func (v VecDense) MarshalBinaryTo(w io.Writer) (int, error) {
// See MarshalBinary for the on-disk layout.
//
// Limited checks on the validity of the binary input are performed:
-// - matrix.ErrShape is returned if the number of rows is negative,
+// - ErrShape is returned if the number of rows is negative,
// - an error is returned if the resulting VecDense is too
// big for the current architecture (e.g. a 16GB vector written by a
// 64b application and read back from a 32b application.)

mat: remove from docs references to "matrix" package