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
No related branches found
No related tags found
No related merge requests found
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment