package/gonum
1
0
Fork 0
mirror of https://github.com/gonum/gonum.git synced 2025-11-01 02:52:49 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

mat: remove mention of "induced" from mat.Norm docs

Browse Source
This commit is contained in:
Vladimir Chalupecky
2020-11-02 09:23:02 +01:00
committed by Vladimír Chalupecký
parent cdda7148b1
commit 4b187d6cf7
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
mat/matrix.go
View File

@@ -745,15 +745,13 @@ func Min(a Matrix) float64 {
} }
} }
// Norm returns the specified (induced) norm of the matrix a. See // Norm returns the specified norm of the matrix A. Valid norms are:
// https://en.wikipedia.org/wiki/Matrix_norm for the definition of an induced norm.
//
// Valid norms are:
// 1 - The maximum absolute column sum // 1 - The maximum absolute column sum
// 2 - Frobenius norm, the square root of the sum of the squares of the elements. // 2 - The Frobenius norm, the square root of the sum of the squares of the elements
// Inf - The maximum absolute row sum. // Inf - The maximum absolute row sum
//
// Norm will panic with ErrNormOrder if an illegal norm order is specified and // Norm will panic with ErrNormOrder if an illegal norm order is specified and
// with matrix.ErrShape if the matrix has zero size. // with ErrShape if the matrix has zero size.
func Norm(a Matrix, norm float64) float64 { func Norm(a Matrix, norm float64) float64 {
r, c := a.Dims() r, c := a.Dims()
if r == 0 || c == 0 { if r == 0 || c == 0 {