This file is indexed.

/usr/share/octave/packages/statistics-1.3.0/copularnd.m is in octave-statistics 1.3.0-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
## Copyright (C) 2012  Arno Onken
##
## This program 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.
##
## This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {@var{x} =} copularnd (@var{family}, @var{theta}, @var{n})
## @deftypefnx {Function File} {} copularnd (@var{family}, @var{theta}, @var{n}, @var{d})
## @deftypefnx {Function File} {} copularnd ('t', @var{theta}, @var{nu}, @var{n})
## Generate random samples from a copula family.
##
## @subheading Arguments
##
## @itemize @bullet
## @item
## @var{family} is the copula family name. Currently, @var{family} can be
## @code{'Gaussian'} for the Gaussian family, @code{'t'} for the Student's t
## family, or @code{'Clayton'} for the Clayton family.
##
## @item
## @var{theta} is the parameter of the copula. For the Gaussian and Student's t
## copula, @var{theta} must be a correlation matrix. For bivariate copulas
## @var{theta} can also be a correlation coefficient. For the Clayton family,
## @var{theta} must be a vector with the same number of elements as samples to
## be generated or be scalar.
##
## @item
## @var{nu} is the degrees of freedom for the Student's t family. @var{nu} must
## be a vector with the same number of elements as samples to be generated or
## be scalar.
##
## @item
## @var{n} is the number of rows of the matrix to be generated. @var{n} must be
## a non-negative integer and corresponds to the number of samples to be
## generated.
##
## @item
## @var{d} is the number of columns of the matrix to be generated. @var{d} must
## be a positive integer and corresponds to the dimension of the copula.
## @end itemize
##
## @subheading Return values
##
## @itemize @bullet
## @item
## @var{x} is a matrix of random samples from the copula with @var{n} samples
## of distribution dimension @var{d}.
## @end itemize
##
## @subheading Examples
##
## @example
## @group
## theta = 0.5;
## x = copularnd ("Gaussian", theta);
## @end group
##
## @group
## theta = 0.5;
## nu = 2;
## x = copularnd ("t", theta, nu);
## @end group
##
## @group
## theta = 0.5;
## n = 2;
## x = copularnd ("Clayton", theta, n);
## @end group
## @end example
##
## @subheading References
##
## @enumerate
## @item
## Roger B. Nelsen. @cite{An Introduction to Copulas}. Springer, New York,
## second edition, 2006.
## @end enumerate
## @end deftypefn

## Author: Arno Onken <asnelt@asnelt.org>
## Description: Random samples from a copula family

function x = copularnd (family, theta, nu, n)

  # Check arguments
  if (nargin < 2)
    print_usage ();
  endif

  if (! ischar (family))
    error ("copularnd: family must be one of 'Gaussian', 't', and 'Clayton'");
  endif

  lower_family = lower (family);

  # Check family and copula parameters
  switch (lower_family)

    case {"gaussian"}
      # Gaussian family
      if (isscalar (theta))
        # Expand a scalar to a correlation matrix
        theta = [1, theta; theta, 1];
      endif
      if (! ismatrix (theta) || any (diag (theta) != 1) || any (any (theta != theta')) || min (eig (theta)) <= 0)
        error ("copularnd: theta must be a correlation matrix");
      endif
      if (nargin > 3)
        d = n;
        if (! isscalar (d) || d != size (theta, 1))
          error ("copularnd: d must correspond to dimension of theta");
        endif
      else
        d = size (theta, 1);
      endif
      if (nargin < 3)
        n = 1;
      else
        n = nu;
        if (! isscalar (n) || (n < 0) || round (n) != n)
          error ("copularnd: n must be a non-negative integer");
        endif
      endif

    case {"t"}
      # Student's t family
      if (nargin < 3)
        print_usage ();
      endif
      if (isscalar (theta))
        # Expand a scalar to a correlation matrix
        theta = [1, theta; theta, 1];
      endif
      if (! ismatrix (theta) || any (diag (theta) != 1) || any (any (theta != theta')) || min (eig (theta)) <= 0)
        error ("copularnd: theta must be a correlation matrix");
      endif
      if (! isscalar (nu) && (! isvector (nu) || length (nu) != n))
        error ("copularnd: nu must be a vector with the same number of rows as x or be scalar");
      endif
      nu = nu(:);
      if (nargin < 4)
        n = 1;
      else
        if (! isscalar (n) || (n < 0) || round (n) != n)
          error ("copularnd: n must be a non-negative integer");
        endif
      endif

    case {"clayton"}
      # Archimedian one parameter family
      if (nargin < 4)
        # Default is bivariate
        d = 2;
      else
        d = n;
        if (! isscalar (d) || (d < 2) || round (d) != d)
          error ("copularnd: d must be an integer greater than 1");
        endif
      endif
      if (nargin < 3)
        # Default is one sample
        n = 1;
      else
        n = nu;
        if (! isscalar (n) || (n < 0) || round (n) != n)
          error ("copularnd: n must be a non-negative integer");
        endif
      endif
      if (! isvector (theta) || (! isscalar (theta) && size (theta, 1) != n))
        error ("copularnd: theta must be a column vector with the number of rows equal to n or be scalar");
      endif
      if (n > 1 && isscalar (theta))
        theta = repmat (theta, n, 1);
      endif

    otherwise
      error ("copularnd: unknown copula family '%s'", family);

  endswitch

  if (n == 0)
    # Input is empty
    x = zeros (0, d);
  else

    # Draw random samples according to family
    switch (lower_family)

      case {"gaussian"}
        # The Gaussian family
        x = normcdf (mvnrnd (zeros (1, d), theta, n), 0, 1);
        # No parameter bounds check
        k = [];

      case {"t"}
        # The Student's t family
        x = tcdf (mvtrnd (theta, nu, n), nu);
        # No parameter bounds check
        k = [];

      case {"clayton"}
        # The Clayton family
        u = rand (n, d);
        if (d == 2)
          x = zeros (n, 2);
          # Conditional distribution method for the bivariate case which also
          # works for theta < 0
          x(:, 1) = u(:, 1);
          x(:, 2) = (1 + u(:, 1) .^ (-theta) .* (u(:, 2) .^ (-theta ./ (1 + theta)) - 1)) .^ (-1 ./ theta);
        else
          # Apply the algorithm by Marshall and Olkin:
          # Frailty distribution for Clayton copula is gamma
          y = randg (1 ./ theta, n, 1);
          x = (1 - log (u) ./ repmat (y, 1, d)) .^ (-1 ./ repmat (theta, 1, d));
        endif
        k = find (theta == 0);
        if (any (k))
          # Produkt copula at columns k
          x(k, :) = u(k, :);
        endif
        # Continue argument check
        if (d == 2)
          k = find (! (theta >= -1) | ! (theta < inf));
        else
          k = find (! (theta >= 0) | ! (theta < inf));
        endif

    endswitch

    # Out of bounds parameters
    if (any (k))
      x(k, :) = NaN;
    endif

  endif

endfunction

%!test
%! theta = 0.5;
%! x = copularnd ("Gaussian", theta);
%! assert (size (x), [1, 2]);
%! assert (all ((x >= 0) & (x <= 1)));

%!test
%! theta = 0.5;
%! nu = 2;
%! x = copularnd ("t", theta, nu);
%! assert (size (x), [1, 2]);
%! assert (all ((x >= 0) & (x <= 1)));

%!test
%! theta = 0.5;
%! x = copularnd ("Clayton", theta);
%! assert (size (x), [1, 2]);
%! assert (all ((x >= 0) & (x <= 1)));

%!test
%! theta = 0.5;
%! n = 2;
%! x = copularnd ("Clayton", theta, n);
%! assert (size (x), [n, 2]);
%! assert (all ((x >= 0) & (x <= 1)));

%!test
%! theta = [1; 2];
%! n = 2;
%! d = 3;
%! x = copularnd ("Clayton", theta, n, d);
%! assert (size (x), [n, d]);
%! assert (all ((x >= 0) & (x <= 1)));