mode_check.m 9.01 KB
Newer Older
1
function mode_check(fun,x,hessian_mat,DynareDataset,DatasetInfo,DynareOptions,Model,EstimatedParameters,BayesInfo,BoundsInfo,DynareResults)
2 3 4
% Checks the estimated ML mode or Posterior mode.

%@info:
5
%! @deftypefn {Function File} mode_check (@var{fun}, @var{x}, @var{hessian_mat}, @var{DynareDataset}, @var{DynareOptions}, @var{Model}, @var{EstimatedParameters}, @var{BayesInfo}, @var{DynareResults})
Stéphane Adjemian's avatar
Stéphane Adjemian committed
6
%! @anchor{mode_check}
7 8 9 10 11 12 13
%! @sp 1
%! Checks the estimated ML mode or Posterior mode by plotting sections of the likelihood/posterior kernel.
%! Each plot shows the variation of the likelihood implied by the variations of a single parameter, ceteris paribus)
%! @sp 2
%! @strong{Inputs}
%! @sp 1
%! @table @ @var
Stéphane Adjemian's avatar
Stéphane Adjemian committed
14 15 16 17
%! @item fun
%! Objective function.
%! @item x
%! Estimated mode.
18
%! @item start
Stéphane Adjemian's avatar
Stéphane Adjemian committed
19 20 21
%! Hessian of the objective function at the estimated mode @var{x}.
%! @item DynareDataset
%! Structure specifying the dataset used for estimation (dataset_).
22
%! @item DynareOptions
Stéphane Adjemian's avatar
Stéphane Adjemian committed
23 24 25 26 27 28 29 30 31
%! Structure defining dynare's options (options_).
%! @item Model
%! Structure specifying the (estimated) model (M_).
%! @item EstimatedParameters
%! Structure specifying the estimated parameters (estimated_params_).
%! @item BayesInfo
%! Structure containing information about the priors used for estimation (bayestopt_).
%! @item DynareResults
%! Structure gathering the results (oo_).
32 33 34 35 36 37 38
%! @end table
%! @sp 2
%! @strong{Outputs}
%! @sp 2
%! @strong{This function is called by:}
%! @sp 2
%! @strong{This function calls:}
Stéphane Adjemian's avatar
Stéphane Adjemian committed
39
%! The objective function (@var{func}).
40 41 42
%! @end deftypefn
%@eod:

43
% Copyright (C) 2003-2017 Dynare Team
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
%
% 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 <http://www.gnu.org/licenses/>.
assia's avatar
assia committed
59

60
TeX = DynareOptions.TeX;
61
if ~isempty(hessian_mat)
62
    [ s_min, k ] = min(diag(hessian_mat));
63
end
64

65
fval = feval(fun,x,DynareDataset,DatasetInfo,DynareOptions,Model,EstimatedParameters,BayesInfo,BoundsInfo,DynareResults);
66

67
if ~isempty(hessian_mat)
68
    skipline()
69
    disp('MODE CHECK')
70
    skipline()
71
    fprintf('Fval obtained by the minimization routine (minus the posterior/likelihood)): %f', fval);
72
    skipline()
73
    if s_min<eps
74
        disp(sprintf('Most negative variance %f for parameter %d (%s = %f)', s_min, k , BayesInfo.name{k}, x(k)))
75
    end
stepan's avatar
 
stepan committed
76
end
michel's avatar
michel committed
77 78 79

[nbplt,nr,nc,lr,lc,nstar] = pltorg(length(x));

80
if TeX && any(strcmp('eps',cellstr(DynareOptions.graph_format)))
81
    fidTeX = fopen([Model.fname '_CheckPlots.tex'],'w');
michel's avatar
michel committed
82 83 84 85 86
    fprintf(fidTeX,'%% TeX eps-loader file generated by mode_check.m (Dynare).\n');
    fprintf(fidTeX,['%% ' datestr(now,0) '\n']);
    fprintf(fidTeX,' \n');
end

87
ll = DynareOptions.mode_check.neighbourhood_size;
88
if isinf(ll)
89
    DynareOptions.mode_check.symmetric_plots = 0;
90
end
91

92 93
mcheck = struct('cross',struct(),'emode',struct());

94
for plt = 1:nbplt
michel's avatar
michel committed
95 96 97 98
    if TeX
        NAMES = [];
        TeXNAMES = [];
    end
99
    hh = dyn_figure(DynareOptions.nodisplay,'Name','Mode check plots');
100 101 102
    for k=1:min(nstar,length(x)-(plt-1)*nstar)
        subplot(nr,nc,k)
        kk = (plt-1)*nstar+k;
103
        [name,texname] = get_the_name(kk,TeX,Model,EstimatedParameters,DynareOptions);
michel's avatar
michel committed
104
        if TeX
105 106 107 108 109 110 111
            if isempty(NAMES)
                NAMES = name;
                TeXNAMES = texname;
            else
                NAMES = char(NAMES,name);
                TeXNAMES = char(TeXNAMES,texname);
            end
112
        end
michel's avatar
michel committed
113
        xx = x;
114
        if x(kk)~=0 || ~isinf(BoundsInfo.lb(kk)) || ~isinf(BoundsInfo.lb(kk))
115 116 117 118 119
            l1 = max(BoundsInfo.lb(kk),(1-sign(x(kk))*ll)*x(kk)); m1 = 0; %lower bound
            l2 = min(BoundsInfo.ub(kk),(1+sign(x(kk))*ll)*x(kk)); %upper bound
        else
            %size info for 0 parameter is missing, use prior standard
            %deviation
120 121 122 123 124 125 126 127 128 129
            upper_bound=BoundsInfo.lb(kk);
            if isinf(upper_bound)
                upper_bound=-1e-6*DynareOptions.huge_number;
            end
            lower_bound=BoundsInfo.ub(kk);
            if isinf(lower_bound)
                lower_bound=-1e-6*DynareOptions.huge_number;
            end
            l1 = max(lower_bound,-BayesInfo.p2(kk)); m1 = 0; %lower bound
            l2 = min(upper_bound,BayesInfo.p2(kk)); %upper bound
130
        end            
131 132
        binding_lower_bound=0;
        binding_upper_bound=0;
133
        if isequal(x(kk),BoundsInfo.lb(kk))
134
            binding_lower_bound=1;
135 136
            bound_value=BoundsInfo.lb(kk);
        elseif isequal(x(kk),BoundsInfo.ub(kk))
137
            binding_upper_bound=1;
138
            bound_value=BoundsInfo.ub(kk);
139
        end
140 141 142
        if DynareOptions.mode_check.symmetric_plots && ~binding_lower_bound && ~binding_upper_bound
            if l2<(1+ll)*x(kk) %test whether upper bound is too small due to prior binding
                l1 = x(kk) - (l2-x(kk)); %adjust lower bound to become closer
143 144
                m1 = 1;
            end
145
            if ~m1 && (l1>(1-ll)*x(kk)) && (x(kk)+(x(kk)-l1)<BoundsInfo.ub(kk)) % if lower bound was truncated and using difference from lower bound does not violate upper bound
146
                l2 = x(kk) + (x(kk)-l1); %set upper bound to same distance as lower bound
147
            end
148
        end
149 150
        z1 = l1:((x(kk)-l1)/(DynareOptions.mode_check.number_of_points/2)):x(kk);
        z2 = x(kk):((l2-x(kk))/(DynareOptions.mode_check.number_of_points/2)):l2;
151
        z  = union(z1,z2);
152
        if DynareOptions.mode_check.nolik==0
153
            y = zeros(length(z),2);
154
            dy = priordens(xx,BayesInfo.pshape,BayesInfo.p6,BayesInfo.p7,BayesInfo.p3,BayesInfo.p4);
155
        end
michel's avatar
michel committed
156 157
        for i=1:length(z)
            xx(kk) = z(i);
158
            [fval, info, exit_flag] = feval(fun,xx,DynareDataset,DatasetInfo,DynareOptions,Model,EstimatedParameters,BayesInfo,BoundsInfo,DynareResults);
159 160
            if exit_flag
                y(i,1) = fval;
adjemian's avatar
adjemian committed
161
            else
162
                y(i,1) = NaN;
163 164 165
                if DynareOptions.debug
                    fprintf('mode_check:: could not solve model for parameter %s at value %4.3f, error code: %u\n',name,z(i),info(1))
                end
166
            end
167
            if DynareOptions.mode_check.nolik==0
168
                lnprior = priordens(xx,BayesInfo.pshape,BayesInfo.p6,BayesInfo.p7,BayesInfo.p3,BayesInfo.p4);
stepan's avatar
 
stepan committed
169
                y(i,2)  = (y(i,1)+lnprior-dy);
170
            end
michel's avatar
michel committed
171
        end
172 173
        mcheck.cross = setfield(mcheck.cross, name, [transpose(z), -y]);
        mcheck.emode = setfield(mcheck.emode, name, x(kk));
174
        fighandle=plot(z,-y);
michel's avatar
michel committed
175 176 177
        hold on
        yl=get(gca,'ylim');
        plot( [x(kk) x(kk)], yl, 'c', 'LineWidth', 1)
stepan's avatar
 
stepan committed
178 179 180 181
        NaN_index = find(isnan(y(:,1)));
        zNaN = z(NaN_index);
        yNaN = yl(1)*ones(size(NaN_index));
        plot(zNaN,yNaN,'o','MarkerEdgeColor','r','MarkerFaceColor','r','MarkerSize',6);
michel's avatar
michel committed
182
        title(name,'interpreter','none')
stepan's avatar
 
stepan committed
183
        axis tight
184 185 186 187 188 189
        if binding_lower_bound || binding_upper_bound
            xl=get(gca,'xlim');
            plot( [bound_value bound_value], yl, 'r--', 'LineWidth', 1)
            xlim([xl(1)-0.5*binding_lower_bound*(xl(2)-xl(1)) xl(2)+0.5*binding_upper_bound*(xl(2)-xl(1))])
        end
        hold off
michel's avatar
michel committed
190 191
        drawnow
    end
192
    if DynareOptions.mode_check.nolik==0
193
        if isoctave
194 195 196 197
            axes('outerposition',[0.3 0.93 0.42 0.07],'box','on'),
        else
            axes('position',[0.3 0.01 0.42 0.05],'box','on'),
        end
198 199 200
        line_color=get(fighandle,'color');
        plot([0.48 0.68],[0.5 0.5],'color',line_color{2})
        hold on, plot([0.04 0.24],[0.5 0.5],'color',line_color{1})
201 202 203 204
        set(gca,'xlim',[0 1],'ylim',[0 1],'xtick',[],'ytick',[])
        text(0.25,0.5,'log-post')
        text(0.69,0.5,'log-lik kernel')
    end
205
    dyn_saveas(hh,[ Model.fname '_CheckPlots' int2str(plt) ],DynareOptions.nodisplay,DynareOptions.graph_format);
206
    if TeX && any(strcmp('eps',cellstr(DynareOptions.graph_format)))
207
        % TeX eps loader file
michel's avatar
michel committed
208
        fprintf(fidTeX,'\\begin{figure}[H]\n');
209
        for jj = 1:min(nstar,length(x)-(plt-1)*nstar)
michel's avatar
michel committed
210
            fprintf(fidTeX,'\\psfrag{%s}[1][][0.5][0]{%s}\n',deblank(NAMES(jj,:)),deblank(TeXNAMES(jj,:)));
211
        end
michel's avatar
michel committed
212
        fprintf(fidTeX,'\\centering \n');
213
        fprintf(fidTeX,'\\includegraphics[width=%2.2f\\textwidth]{%s_CheckPlots%s}\n',DynareOptions.figures.textwidth*min(k/nc,1),Model.fname,int2str(plt));
michel's avatar
michel committed
214
        fprintf(fidTeX,'\\caption{Check plots.}');
215
        fprintf(fidTeX,'\\label{Fig:CheckPlots:%s}\n',int2str(plt));
michel's avatar
michel committed
216 217 218
        fprintf(fidTeX,'\\end{figure}\n');
        fprintf(fidTeX,' \n');
    end
219
end
220
if TeX && any(strcmp('eps',cellstr(DynareOptions.graph_format)))
221
    fclose(fidTeX);
222
end
223

224
OutputDirectoryName = CheckPath('modecheck',Model.dname);
225
save([OutputDirectoryName '/check_plot_data.mat'],'mcheck');