From e845ffbd4cec7b534c99b24bb206d2a38ee50ab3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Adjemian=20=28Argos=29?=
<stepan@adjemian.eu>
Date: Thu, 5 Sep 2024 16:39:40 +0200
Subject: [PATCH] Update doc headers.
---
matlab/run_simulations.m | 5 +++++
matlab/write_steady_state.m | 2 +-
matlab/write_table_short.m | 12 +++++++++++-
3 files changed, 17 insertions(+), 2 deletions(-)
diff --git a/matlab/run_simulations.m b/matlab/run_simulations.m
index 00e70c0..7dad1d9 100644
--- a/matlab/run_simulations.m
+++ b/matlab/run_simulations.m
@@ -1,5 +1,7 @@
function run_simulations(model, stack_solve_algo, static_solve_algo, niter, ccrit)
+% Run perfect foresight model with different options and algorithms.
+%
% INPUTS
% - model [char] 1×n array, name of the mod file (without extension).
% - stack_solve_algo [integer] 1×p array, identifiers for the solver of the stack model.
@@ -9,6 +11,9 @@ function run_simulations(model, stack_solve_algo, static_solve_algo, niter, ccri
%
% OUTPUTS
% None
+%
+% REMARKS
+% Results (timings) are stored in a .mat file named simulations-{model}.mat.
% Copyright © 2024 Dynare Team
diff --git a/matlab/write_steady_state.m b/matlab/write_steady_state.m
index 8406915..bcd3606 100644
--- a/matlab/write_steady_state.m
+++ b/matlab/write_steady_state.m
@@ -7,7 +7,7 @@ function write_steady_state(output, DynareModel, DynareOutput)
% - DynareModel [struct] aka M_
% - DynareOutput [struct] aka oo_
-% Copyright (C) 2024 by Stéphane ADjemian
+% Copyright (C) 2024 Dynare Team
fid = fopen(output, 'w');
fprintf(fid, '// File generated on %s.', char(datetime));
diff --git a/matlab/write_table_short.m b/matlab/write_table_short.m
index 03c53cd..cb7c885 100644
--- a/matlab/write_table_short.m
+++ b/matlab/write_table_short.m
@@ -1,5 +1,15 @@
function write_table_short(datafile, texfilename)
-% Copyright (C) 2024 by Stéphane Adjemian
+
+% Produce a table of results with LaTex compiled as a pdf file and converted to a png file.
+%
+% INPUTS
+% - datafile [char] 1×n array, name of a .mat (without extension)
+% - texfilename [char] 1×m array, name of the .{tex,png,pdf} file containing the table of results.
+%
+% OUTPUTS
+% None
+
+% Copyright (C) 2024 Dynare Team
stack_solve_algo = [0, 1, 2, 3, 4, 5];
id = 1:length(stack_solve_algo);
--
GitLab