From f879eb4ab00dda4f14c403883b932a5bf631ac99 Mon Sep 17 00:00:00 2001 From: Johannes Pfeifer <jpfeifer@gmx.de> Date: Tue, 23 Jul 2024 15:09:43 +0200 Subject: [PATCH] smc_samplers_initialization.m: clean up header --- .../smc/smc_samplers_initialization.m | 28 +++++++------------ 1 file changed, 10 insertions(+), 18 deletions(-) diff --git a/matlab/estimation/smc/smc_samplers_initialization.m b/matlab/estimation/smc/smc_samplers_initialization.m index fb27f251e7..4c17ef0ade 100644 --- a/matlab/estimation/smc/smc_samplers_initialization.m +++ b/matlab/estimation/smc/smc_samplers_initialization.m @@ -1,32 +1,24 @@ -function [particles, tlogpostkernel, loglikelihood, SimulationFolder] = smc_samplers_initialization(funobj, sampler, n, Prior, SimulationFolder, nsteps) - +function [particles, tlogpostkernel, loglikelihood] = smc_samplers_initialization(funobj, sampler, n, Prior, SimulationFolder, nsteps) +% function [particles, tlogpostkernel, loglikelihood] = smc_samplers_initialization(funobj, sampler, n, Prior, SimulationFolder, nsteps) % Initialize SMC samplers by drawing initial particles in the prior distribution. % % INPUTS -% - TargetFun [char] string specifying the name of the objective function (posterior kernel). +% - funobj [char] string specifying the name of the objective function (posterior kernel). % - sampler [char] name of the sampler. % - n [integer] scalar, number of particles. -% - mh_bounds [double] p×2 matrix defining lower and upper bounds for the estimated parameters. -% - dataset_ [dseries] sample -% - dataset_info [struct] informations about the dataset -% - options_ [struct] dynare's options -% - M_ [struct] model description -% - estim_params_ [struct] estimated parameters -% - bayestopt_ [struct] estimated parameters -% - oo_ [struct] outputs +% - Prior [class] prior information +% - SimulationFolder [char] name of output folder +% - nsteps [integer] number of steps % % OUTPUTS -% - ix2 [double] p×n matrix of particles -% - ilogpo2 [double] n×1 vector of posterior kernel values for the particles -% - iloglik2 [double] n×1 vector of likelihood values for the particles -% - ModelName [string] name of the mod-file -% - MetropolisFolder [string] path to the Metropolis subfolder -% - bayestopt_ [structure] estimation options structure +% - particles [double] p×n matrix of particles +% - tlogpostkernel [double] n×1 vector of posterior kernel values for the particles +% - loglikelihood [double] n×1 vector of likelihood values for the particles % % SPECIAL REQUIREMENTS % None. -% Copyright © 2022-2023 Dynare Team +% Copyright © 2022-2024 Dynare Team % % This file is part of Dynare. % -- GitLab