octave_packages/m/statistics/distributions/stdnormal_rnd.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} {} stdnormal_rnd (@var{r})
  22 ## @deftypefnx {Function File} {} stdnormal_rnd (@var{r}, @var{c}, @dots{})
  23 ## @deftypefnx {Function File} {} stdnormal_rnd ([@var{sz}])
  24 ## Return a matrix of random samples from the standard normal distribution
  25 ## (mean = 0, standard deviation = 1).
  26 ##
  27 ## When called with a single size argument, return a square matrix with
  28 ## the dimension specified.  When called with more than one scalar argument the
  29 ## first two arguments are taken as the number of rows and columns and any
  30 ## further arguments specify additional matrix dimensions.  The size may also
  31 ## be specified with a vector of dimensions @var{sz}.
  32 ## @end deftypefn
  33
  34 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
  35 ## Description: Random deviates from the standard normal distribution
  36
  37 function rnd = stdnormal_rnd (varargin)
  38
  39   if (nargin < 1)
  40     print_usage ();
  41   endif
  42
  43   if (nargin == 1)
  44     if (isscalar (varargin{1}) && varargin{1} >= 0)
  45       sz = [varargin{1}, varargin{1}];
  46     elseif (isrow (varargin{1}) && all (varargin{1} >= 0))
  47       sz = varargin{1};
  48     else
  49       error ("stdnormal_rnd: dimension vector must be row vector of non-negative integers");
  50     endif
  51   elseif (nargin > 1)
  52     if (any (cellfun (@(x) (!isscalar (x) || x < 0), varargin)))
  53       error ("stdnormal_rnd: dimensions must be non-negative integers");
  54     endif
  55     sz = [varargin{:}];
  56   endif
  57
  58   rnd = randn (sz);
  59
  60 endfunction
  61
  62
  63 %!assert(size (stdnormal_rnd (3)), [3, 3]);
  64 %!assert(size (stdnormal_rnd ([4 1])), [4, 1]);
  65 %!assert(size (stdnormal_rnd (4,1)), [4, 1]);
  66
  67 %% Test input validation
  68 %!error stdnormal_rnd ()
  69 %!error stdnormal_rnd (-1)
  70 %!error stdnormal_rnd (ones(2))
  71 %!error stdnormal_rnd ([2 -1 2])
  72 %!error stdnormal_rnd (1, ones(2))
  73 %!error stdnormal_rnd (1, -1)
  74