octave_packages/m/statistics/distributions/frnd.m

   1 ## Copyright (C) 2012 Rik Wehbring
   2 ## Copyright (C) 1995-2012 Kurt Hornik
   3 ##
   4 ## This file is part of Octave.
   5 ##
   6 ## Octave is free software; you can redistribute it and/or modify it
   7 ## under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 3 of the License, or (at
   9 ## your option) any later version.
  10 ##
  11 ## Octave is distributed in the hope that it will be useful, but
  12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ## General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with Octave; see the file COPYING.  If not, see
  18 ## <http://www.gnu.org/licenses/>.
  19
  20 ## -*- texinfo -*-
  21 ## @deftypefn  {Function File} {} frnd (@var{m}, @var{n})
  22 ## @deftypefnx {Function File} {} frnd (@var{m}, @var{n}, @var{r})
  23 ## @deftypefnx {Function File} {} frnd (@var{m}, @var{n}, @var{r}, @var{c}, @dots{})
  24 ## @deftypefnx {Function File} {} frnd (@var{m}, @var{n}, [@var{sz}])
  25 ## Return a matrix of random samples from the F distribution with
  26 ## @var{m} and @var{n} degrees of freedom.
  27 ##
  28 ## When called with a single size argument, return a square matrix with
  29 ## the dimension specified.  When called with more than one scalar argument the
  30 ## first two arguments are taken as the number of rows and columns and any
  31 ## further arguments specify additional matrix dimensions.  The size may also
  32 ## be specified with a vector of dimensions @var{sz}.
  33 ##
  34 ## If no size arguments are given then the result matrix is the common size of
  35 ## @var{m} and @var{n}.
  36 ## @end deftypefn
  37
  38 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  39 ## Description: Random deviates from the F distribution
  40
  41 function rnd = frnd (m, n, varargin)
  42
  43   if (nargin < 2)
  44     print_usage ();
  45   endif
  46
  47   if (!isscalar (m) || !isscalar (n))
  48     [retval, m, n] = common_size (m, n);
  49     if (retval > 0)
  50       error ("frnd: M and N must be of common size or scalars");
  51     endif
  52   endif
  53
  54   if (iscomplex (m) || iscomplex (n))
  55     error ("frnd: M and N must not be complex");
  56   endif
  57
  58   if (nargin == 2)
  59     sz = size (m);
  60   elseif (nargin == 3)
  61     if (isscalar (varargin{1}) && varargin{1} >= 0)
  62       sz = [varargin{1}, varargin{1}];
  63     elseif (isrow (varargin{1}) && all (varargin{1} >= 0))
  64       sz = varargin{1};
  65     else
  66       error ("frnd: dimension vector must be row vector of non-negative integers");
  67     endif
  68   elseif (nargin > 3)
  69     if (any (cellfun (@(x) (!isscalar (x) || x < 0), varargin)))
  70       error ("frnd: dimensions must be non-negative integers");
  71     endif
  72     sz = [varargin{:}];
  73   endif
  74
  75   if (!isscalar (m) && !isequal (size (m), sz))
  76     error ("frnd: M and N must be scalar or of size SZ");
  77   endif
  78
  79   if (isa (m, "single") || isa (n, "single"))
  80     cls = "single";
  81   else
  82     cls = "double";
  83   endif
  84
  85   if (isscalar (m) && isscalar (n))
  86     if ((m > 0) && (m < Inf) && (n > 0) && (n < Inf))
  87       rnd = n/m * randg (m/2, sz) ./ randg (n/2, sz);
  88     else
  89       rnd = NaN (sz, cls);
  90     endif
  91   else
  92     rnd = NaN (sz, cls);
  93
  94     k = (m > 0) & (m < Inf) & (n > 0) & (n < Inf);
  95     rnd(k) = n(k) ./ m(k) .* randg (m(k)/2) ./ randg (n(k)/2);
  96   endif
  97
  98 endfunction
  99
 100
 101 %!assert(size (frnd (1,2)), [1, 1]);
 102 %!assert(size (frnd (ones(2,1), 2)), [2, 1]);
 103 %!assert(size (frnd (ones(2,2), 2)), [2, 2]);
 104 %!assert(size (frnd (1, 2*ones(2,1))), [2, 1]);
 105 %!assert(size (frnd (1, 2*ones(2,2))), [2, 2]);
 106 %!assert(size (frnd (1, 2, 3)), [3, 3]);
 107 %!assert(size (frnd (1, 2, [4 1])), [4, 1]);
 108 %!assert(size (frnd (1, 2, 4, 1)), [4, 1]);
 109
 110 %% Test class of input preserved
 111 %!assert(class (frnd (1, 2)), "double");
 112 %!assert(class (frnd (single(1), 2)), "single");
 113 %!assert(class (frnd (single([1 1]), 2)), "single");
 114 %!assert(class (frnd (1, single(2))), "single");
 115 %!assert(class (frnd (1, single([2 2]))), "single");
 116
 117 %% Test input validation
 118 %!error frnd ()
 119 %!error frnd (1)
 120 %!error frnd (ones(3),ones(2))
 121 %!error frnd (ones(2),ones(3))
 122 %!error frnd (i, 2)
 123 %!error frnd (2, i)
 124 %!error frnd (1,2, -1)
 125 %!error frnd (1,2, ones(2))
 126 %!error frnd (1, 2, [2 -1 2])
 127 %!error frnd (1,2, 1, ones(2))
 128 %!error frnd (1,2, 1, -1)
 129 %!error frnd (ones(2,2), 2, 3)
 130 %!error frnd (ones(2,2), 2, [3, 2])
 131 %!error frnd (ones(2,2), 2, 2, 3)
 132