Skip to content
Snippets Groups Projects
Commit ceffcd18 authored by Achilles Kappis's avatar Achilles Kappis
Browse files

Fill missing information about the normalisation argument in diagMetric's header

parent 5acfdf5f
Branches
No related tags found
No related merge requests found
...@@ -31,11 +31,14 @@ ...@@ -31,11 +31,14 @@
% Frobenius norm. % Frobenius norm.
% [Default: "Fro"]. % [Default: "Fro"].
% %
% normalise [logical] (Optional): Whether to normalise the result with the % normalise [logical/numeric] (Optional): Whether to normalise the result
% norm of the matrix. This will provide a % with the norm of the matrix. This
% results between 0, when all the elements % will provide a results between 0,
% along the diagonal are zero and 1 when % when all the elements along the
% the matrix is diagonal. % diagonal are zero and 1 when the
% matrix is diagonal. The value of
% the argument will be converted to
% logical. [Default: true].
% %
% -------------------------------------------------- % --------------------------------------------------
% Output % Output
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment