octave_packages/nan-2.5.5/kurtosis.m

   1 function R=kurtosis(i,DIM)
   2 % KURTOSIS estimates the kurtosis
   3 %
   4 % y = kurtosis(x,DIM)
   5 %   calculates kurtosis of x in dimension DIM
   6 %
   7 % DIM   dimension
   8 %       1: STATS of columns
   9 %       2: STATS of rows
  10 %       default or []: first DIMENSION, with more than 1 element
  11 %
  12 % features:
  13 % - can deal with NaN's (missing values)
  14 % - dimension argument
  15 % - compatible to Matlab and Octave
  16 %
  17 % see also: SUMSKIPNAN, VAR, STD, VAR, SKEWNESS, MOMENT, STATISTIC,
  18 %    IMPLICIT_SKIP_NAN
  19 %
  20 % REFERENCE(S):
  21 % http://mathworld.wolfram.com/
  22
  23 %    This program is free software; you can redistribute it and/or modify
  24 %    it under the terms of the GNU General Public License as published by
  25 %    the Free Software Foundation; either version 2 of the License, or
  26 %    (at your option) any later version.
  27 %
  28 %    This program is distributed in the hope that it will be useful,
  29 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
  30 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31 %    GNU General Public License for more details.
  32 %
  33 %    You should have received a copy of the GNU General Public License
  34 %    along with this program; If not, see <http://www.gnu.org/licenses/>.
  35
  36 %       $Id: kurtosis.m 8223 2011-04-20 09:16:06Z schloegl $
  37 %       Copyright (C) 2000-2003 by Alois Schloegl <alois.schloegl@gmail.com>
  38 %       This function is part of the NaN-toolbox for Octave and Matlab
  39 %       http://pub.ist.ac.at/~schloegl/matlab/NaN/
  40
  41
  42 if nargin==1,
  43         DIM=min(find(size(i)>1));
  44         if isempty(DIM), DIM=1; end;
  45 end;
  46
  47 [R.SUM,R.N,R.SSQ] = sumskipnan(i,DIM);  % sum
  48
  49 R.MEAN  = R.SUM./R.N;                   % mean
  50 R.SSQ0  = R.SSQ - real(R.SUM).*real(R.MEAN) - imag(R.SUM).*imag(R.MEAN);        % sum square with mean removed
  51
  52 %if flag_implicit_unbiased_estim;    %% ------- unbiased estimates -----------
  53     n1  = max(R.N-1,0);                 % in case of n=0 and n=1, the (biased) variance, STD and SEM are INF
  54 %else
  55 %    n1 = R.N;
  56 %end;
  57
  58 R.VAR   = R.SSQ0./n1;                   % variance (unbiased)
  59 %R.STD  = sqrt(R.VAR);                  % standard deviation
  60
  61 i       = i - repmat(R.MEAN,size(i)./size(R.MEAN));
  62 %R.CM3  = sumskipnan(i.^3,DIM)./n1;
  63 R.CM4   = sumskipnan(i.^4,DIM)./n1;
  64
  65 %R.SKEWNESS = R.CM3./(R.STD.^3);
  66 R = R.CM4./(R.VAR.^2)-3;