File: wblinv.m

package info (click to toggle)
dynare 7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 79,248 kB
  • sloc: cpp: 82,011; ansic: 28,583; objc: 12,573; yacc: 5,105; pascal: 2,374; lex: 1,502; python: 1,118; sh: 1,116; makefile: 605; lisp: 162; xml: 18
file content (194 lines) | stat: -rw-r--r-- 4,178 bytes parent folder | download
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
function t = wblinv(proba, scale, shape)

% Inverse cumulative distribution function.
%
% INPUTS
% - proba [double] Probability, scalar or vector with values in [0,1].
% - scale [double] Positive hyperparameter (scalar).
% - shape [double] Positive hyperparameter (scalar).
%
% OUTPUTS
% - t     [double] Quantile(s), same size as proba.

% Copyright © 2015-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/>.

% Check input arguments.

if nargin<3
    error('Three input arguments required!')
end

if ~isnumeric(proba) || ~isreal(proba) || any(proba(:)<0) || any(proba(:)>1)
    error('First input argument must be a real scalar or vector with values in [0,1] (probability)!')
end

if ~isnumeric(scale) || ~isscalar(scale) || ~isreal(scale) || scale<=0
    error('Second input argument must be a real positive scalar (scale parameter of the Weibull distribution)!')
end

if ~isnumeric(shape) || ~isscalar(shape) || ~isreal(shape) || shape<=0
    error('Third input argument must be a real positive scalar (shape parameter of the Weibull distribution)!')
end

% Vectorized closed-form inverse CDF.
t = zeros(size(proba));
t(proba > 1-2*eps()) = Inf;
k = proba >= 2*eps() & proba <= 1-2*eps();
if any(k(:))
    t(k) = exp(log(scale) + log(-log(1-proba(k)))./shape);
end

return % --*-- Unit tests --*--

%@test:1
try
   x = wblinv(0, 1, 2);
   t(1) = true;
catch
    t(1) = false;
end

if t(1)
    t(2) = isequal(x, 0);
end
T = all(t);
%@eof:1

%@test:2
try
   x = wblinv(1, 1, 2);
   t(1) = true;
catch
    t(1) = false;
end

if t(1)
    t(2) = isinf(x);
end
T = all(t);
%@eof:2

%@test:3
scales = [.5, 1, 5];
shapes = [.1, 1, 2];
x = NaN(9,1);

try
   k = 0;
   for i=1:3
      for j=1:3
          k = k+1;
          x(k) = wblinv(.5, scales(i), shapes(j));
      end
   end
   t(1) = true;
catch
   t(1) = false;
end

if t(1)
    k = 1;
    for i=1:3
        for j=1:3
            k = k+1;
            t(k) = abs(x(k-1)-scales(i)*log(2)^(1/shapes(j)))<1e-12;
        end
    end
end
T = all(t);
%@eof:3

%@test:4
debug = false;
scales = [ .5, 1, 5];
shapes = [ 1, 2, 3];
x = NaN(9,1);
p = 1e-1;

try
   k = 0;
   for i=1:3
      for j=1:3
          k = k+1;
          x(k) = wblinv(p, scales(i), shapes(j));
      end
   end
   t(1) = true;
catch
   t(1) = false;
end

if t(1)
   k = 1;
   for i=1:3
      for j=1:3
          k = k+1;
          shape = shapes(j);
          scale = scales(i);
          density = @(z) exp(lpdfgweibull(z,shape,scale));
          if debug
              [shape, scale, x(k-1)]
          end
          if isoctave
              s = quadv(density, 0, x(k-1),1e-10);
          else
              s = integral(density, 0, x(k-1));
          end
          if debug
              [s, abs(p-s)]
          end
          if isoctave
              t(k) = abs(p-s)<1e-9;
          else
              t(k) = abs(p-s)<1e-12;
          end
      end
   end
end
T = all(t);
%@eof:4

%@test:5
% Test with vector-valued proba input.

% Set the hyperparameters of a Weibull distribution.
scale = .5;
shape = 1.5;

% Build a probability vector including boundary cases.
q = [0, 0.25, 0.5, 0.75, 1];

try
    x = wblinv(q, scale, shape);
    t(1) = true;
catch
    t(1) = false;
end

% Check the results.
if t(1)
    t(2) = isequal(size(x), size(q));
    t(3) = isequal(x(1), 0);     % p = 0 → x = 0
    t(4) = isinf(x(end));         % p = 1 → x = Inf
    % Check round-trip consistency with wblcdf for interior points.
    for i = 2:length(q)-1
        t(i+3) = abs(wblcdf(x(i), scale, shape) - q(i)) < 1e-12;
    end
end
T = all(t);
%@eof:5