octave_packages/m/statistics/distributions/wienrnd.m

   1 ## Copyright (C) 1995-2012 Friedrich Leisch
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} wienrnd (@var{t}, @var{d}, @var{n})
  21 ## Return a simulated realization of the @var{d}-dimensional Wiener Process
  22 ## on the interval [0, @var{t}].  If @var{d} is omitted, @var{d} = 1 is
  23 ## used.  The first column of the return matrix contains time, the
  24 ## remaining columns contain the Wiener process.
  25 ##
  26 ## The optional parameter @var{n} gives the number of summands used for
  27 ## simulating the process over an interval of length 1.  If @var{n} is
  28 ## omitted, @var{n} = 1000 is used.
  29 ## @end deftypefn
  30
  31 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at>
  32 ## Description: Simulate a Wiener process
  33
  34 function retval = wienrnd (t, d, n)
  35
  36   if (nargin == 1)
  37     d = 1;
  38     n = 1000;
  39   elseif (nargin == 2)
  40     n = 1000;
  41   elseif (nargin > 3)
  42     print_usage ();
  43   endif
  44
  45   if (!isscalar (t) || !isscalar (d) || !isscalar (n))
  46     error ("wienrnd: T, D and N must all be positive integers");
  47   endif
  48
  49   retval = randn (n * t, d);
  50   retval = cumsum (retval) / sqrt (n);
  51
  52   retval = [((1: n*t)' / n), retval];
  53
  54 endfunction