diff --git a/Utilities/Generic/MATLAB/Functions/diagMetric.m b/Utilities/Generic/MATLAB/Functions/diagMetric.m index 0f02f3b35b344c5d1ce9bf854693f12715aa051c..890d3f9980952ba06fbed7f430650681beb468e2 100644 --- a/Utilities/Generic/MATLAB/Functions/diagMetric.m +++ b/Utilities/Generic/MATLAB/Functions/diagMetric.m @@ -31,11 +31,14 @@ % Frobenius norm. % [Default: "Fro"]. % -% normalise [logical] (Optional): Whether to normalise the result with the -% norm of the matrix. This will provide a -% results between 0, when all the elements -% along the diagonal are zero and 1 when -% the matrix is diagonal. +% normalise [logical/numeric] (Optional): Whether to normalise the result +% with the norm of the matrix. This +% will provide a results between 0, +% when all the elements along the +% diagonal are zero and 1 when the +% matrix is diagonal. The value of +% the argument will be converted to +% logical. [Default: true]. % % -------------------------------------------------- % Output