dynare/matlab/dyntable.m

86 lines
2.8 KiB
Matlab

function dyntable(options_, title, headers, labels, values, label_width, val_width, val_precis, optional_header)
% Prints a table of results in main command window.
%
% INPUTS
% - options_ [structure] Dynare options structure
% - title [string] Table title
% - headers [cell] labels for header row (each element is a row characater array)
% - labels [cell] labels for label column (each element is a row characater array)
% - values [double] matrix of values to display
% - label_width [integer] scalar, width of the label
% - val_width [integer] scalar, width of value column
% - val_precis [integer] scalar, precision of displayed values
%
% OUTPUTS
% none
% Copyright © 2002-2023 Dynare Team
%
% This file is part of Dynare.
%
% Dynare is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
% the Free Software Foundation, either version 3 of the License, or
% (at your option) any later version.
%
% Dynare is distributed in the hope that it will be useful,
% but WITHOUT ANY WARRANTY; without even the implied warranty of
% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
% GNU General Public License for more details.
%
% You should have received a copy of the GNU General Public License
% along with Dynare. If not, see <https://www.gnu.org/licenses/>.
if options_.noprint
return
end
% Set width of label column
if isempty(label_width)
label_width = cellofchararraymaxlength(vertcat(headers{1}, labels))+2;
else
label_width = max(cellofchararraymaxlength(vertcat(headers{1}, labels))+2, label_width);
end
label_format_leftbound = sprintf('%%-%ds', label_width);
% Set width of other columns
if all(all(~isfinite(values)))
values_length = 4;
else
values_length = max(ceil(max(max(log10(abs(values(isfinite(values))))))),1)+val_precis+1;
end
if any(any(values < 0)) %add one character for minus sign
values_length = values_length+1;
end
headers_length = cellofchararraymaxlength(headers(2:end));
if isempty(val_width)
val_width = max(headers_length, values_length)+2;
else
val_width = max(max(headers_length, values_length)+2, val_width);
end
value_format = sprintf('%%%d.%df', val_width, val_precis);
header_string_format = sprintf('%%%ds', val_width);
if ~isempty(title)
fprintf('\n\n%s\n',title);
end
% Create and print header string
if nargin==9
disp(optional_header)
end
if ~isempty(headers)
hh_tbl = sprintf(label_format_leftbound , headers{1});
for i=2:length(headers)
hh_tbl = [hh_tbl sprintf(header_string_format, headers{i})];
end
disp(hh_tbl)
end
for i=1:size(values,1)
disp([sprintf(label_format_leftbound, labels{i}) sprintf(value_format, values(i,:))])
end