From ceffcd18eef324e13b62f21ba5e8c86267326350 Mon Sep 17 00:00:00 2001 From: ZaellixA <axilleaz@protonmail.com> Date: Tue, 18 Feb 2025 10:31:29 +0000 Subject: [PATCH] Fill missing information about the normalisation argument in diagMetric's header --- Utilities/Generic/MATLAB/Functions/diagMetric.m | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/Utilities/Generic/MATLAB/Functions/diagMetric.m b/Utilities/Generic/MATLAB/Functions/diagMetric.m index 0f02f3b..890d3f9 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 -- GitLab