octave_packages/m/signal/hurst.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} {} hurst (@var{x})
  21 ## Estimate the Hurst parameter of sample @var{x} via the rescaled range
  22 ## statistic.  If @var{x} is a matrix, the parameter is estimated for
  23 ## every single column.
  24 ## @end deftypefn
  25
  26 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at>
  27 ## Description: Estimate the Hurst parameter
  28
  29 function H = hurst (x)
  30
  31   if (nargin != 1)
  32     print_usage ();
  33   endif
  34
  35   if (isscalar (x))
  36     error ("hurst: X must not be a scalar");
  37   elseif (isvector (x))
  38     x = reshape (x, length (x), 1);
  39   endif
  40
  41   [xr, xc] = size (x);
  42
  43   s = std (x);
  44   w = cumsum (x - mean (x));
  45   RS = (max(w) - min(w)) ./ s;
  46   H = log (RS) / log (xr);
  47
  48 endfunction