From 41e3de04cee9843fdebd3040163319e16d5d14c7 Mon Sep 17 00:00:00 2001 From: Vladimir Chalupecky Date: Wed, 12 May 2021 17:51:17 +0200 Subject: [PATCH] mat: document Normer --- mat/matrix.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/mat/matrix.go b/mat/matrix.go index b38afdc5..c5f9c3f3 100644 --- a/mat/matrix.go +++ b/mat/matrix.go @@ -756,7 +756,10 @@ func Min(a Matrix) float64 { } } -// A Normer can compute a norm of the matrix. +// A Normer can compute a norm of the matrix. Valid norms are: +// 1 - The maximum absolute column sum +// 2 - The Frobenius norm, the square root of the sum of the squares of the elements +// Inf - The maximum absolute row sum type Normer interface { Norm(norm float64) float64 }