File: log_transform.m

package info (click to toggle)
dynare 6.3-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 67,632 kB
  • sloc: cpp: 79,090; ansic: 28,916; objc: 12,430; yacc: 4,528; pascal: 1,993; lex: 1,441; sh: 1,121; python: 634; makefile: 626; lisp: 163; xml: 18
file content (112 lines) | stat: -rw-r--r-- 3,463 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
function [yy, xdir, isig, lam]=log_transform(y0,xdir0,isig,lam)
% [yy, xdir, isig, lam]=log_transform(y0,xdir0,isig,lam)
% Conduct automatic log transformation lam(yy/isig+lam)
% Inputs:
%   - y0    [double]    series to transform
%   - xdir  [char]      string indating the type of transformation:
%                           - log: standard log transformation
%                           - minuslog: log of minus (y0)
%                           - logsquared: log of y0^2
%                           - logskew: log of y0 shifted by lam
%   - isig  [double]    scaling factor for y0
%   - lam   [double]    shifting for y0
%
% Outputs:
%   - yy    [double]    transformed series
%   - xdir  [char]      string indating the type of transformation:
%                           - log: standard log transformation
%                           - minuslog: log of minus (y0)
%                           - logsquared: log of y0^2
%                           - logskew: log of y0 shifted by lam
%   - isig  [double]    scaling factor for y0
%   - lam   [double]    shifting for y0
%
% Notes: takes either one or four arguments. For one argument, the log
% transformation is conducted. For four arguments, the inverse
% transformation is applied.

% Written by Marco Ratto
% Joint Research Centre, The European Commission,
% marco.ratto@ec.europa.eu

% Copyright © 2012 European Commission
% Copyright © 2012-2017 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 nargin==4
    % inverse transformation
    yy = (exp(y0)-lam)*isig;
    return
end

if nargin==1
    xdir0='';
end
f=@(lam,y)gsa.skewness(log(y+lam));
isig=1;
if ~(max(y0)<0 || min(y0)>0)
    if gsa.skewness(y0)<0
        isig=-1;
        y0=-y0;
    end
    if isoctave
        n=hist(y0,10);
    else
        n=histcounts(y0,10);
    end
    if n(1)>20*n(end)
        try
            lam=fzero(f,[-min(y0)+10*eps -min(y0)+abs(median(y0))],[],y0);
        catch
            yl(1)=f(-min(y0)+10*eps,y0);
            yl(2)=f(-min(y0)+abs(median(y0)),y0);
            if abs(yl(1))<abs(yl(2))
                lam=-min(y0)+eps;
            else
                lam = -min(y0)+abs(median(y0));
            end
        end
        yy = log(y0+lam);
        xdir=[xdir0,'_logskew'];
    else
        isig=0;
        lam=0;
        yy = log(y0.^2);
        xdir=[xdir0,'_logsquared'];
    end
else
    if max(y0)<0
        isig=-1;
        y0=-y0;
        xdir=[xdir0,'_minuslog'];
    elseif min(y0)>0
        xdir=[xdir0,'_log'];
    end
    try
        lam=fzero(f,[-min(y0)+10*eps -min(y0)+median(y0)],[],y0);
    catch
        yl(1)=f(-min(y0)+10*eps,y0);
        yl(2)=f(-min(y0)+abs(median(y0)),y0);
        if abs(yl(1))<abs(yl(2))
            lam=-min(y0)+eps;
        else
            lam = -min(y0)+abs(median(y0));
        end
    end
    lam = max(lam,0);
    yy = log(y0+lam);
end