octave-nkf: scripts/statistics/base/kurtosis.m annotate

annotate scripts/statistics/base/kurtosis.m @ 20550:76f67400649e

Use '-local' option to warning to simplify BIST tests. * dos.m, unix.m, savepath.m, kurtosis.m, skewness.m: Use '-local' option to warning instead of unwind/protect block.

author	Rik <rik@octave.org>
date	Fri, 25 Sep 2015 21:00:29 -0700
parents	d9341b422488
children

rev	line source
19731 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19627 diff changeset	1 ## Copyright (C) 2013-2015 Julien Bect
4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19627 diff changeset	2 ## Copyright (C) 1996-2015 John W. Eaton
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	3 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	4 ## This file is part of Octave.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	5 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	6 ## Octave is free software; you can redistribute it and/or modify it
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	7 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	9 ## your option) any later version.
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	10 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	11 ## Octave is distributed in the hope that it will be useful, but
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	14 ## General Public License for more details.
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	15 ##
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	16 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6754 diff changeset	18 ## <http://www.gnu.org/licenses/>.
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	19
3367 0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	20 ## -- texinfo --
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	21 ## @deftypefn {Function File} {} kurtosis (@var{x})
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	22 ## @deftypefnx {Function File} {} kurtosis (@var{x}, @var{flag})
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	23 ## @deftypefnx {Function File} {} kurtosis (@var{x}, @var{flag}, @var{dim})
20209 d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19867 diff changeset	24 ## Compute the sample kurtosis of the elements of @var{x}.
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19867 diff changeset	25 ##
d9341b422488 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19867 diff changeset	26 ## The sample kurtosis is defined as
3367 0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	27 ## @tex
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	28 ## $$
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	29 ## \kappa_1 = {{{1\over N}\,
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	30 ## \sum_{i=1}^N (@var{x}_i - \bar{@var{x}})^4} \over \sigma^4},
3367 0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	31 ## $$
17698 9bb5d3f63cdd NEWS: Announce change in definition of kurtosis function for Matlab compatibility. Rik <rik@octave.org> parents: 17697 diff changeset	32 ## where $N$ is the length of @var{x}, $\bar{@var{x}}$ its mean, and $\sigma$
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	33 ## its (uncorrected) standard deviation.
3367 0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	34 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7411 diff changeset	35 ## @ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3367 diff changeset	36 ##
3367 0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	37 ## @example
14399 d931d9b458fc kurtosis.m: Make docstring equation prettier in Info format Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	38 ## @group
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	39 ## mean ((@var{x} - mean (@var{x})).^4)
17698 9bb5d3f63cdd NEWS: Announce change in definition of kurtosis function for Matlab compatibility. Rik <rik@octave.org> parents: 17697 diff changeset	40 ## k1 = ------------------------
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	41 ## std (@var{x}).^4
14399 d931d9b458fc kurtosis.m: Make docstring equation prettier in Info format Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	42 ## @end group
3367 0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	43 ## @end example
10821 693e22af08ae Grammarcheck documentation of m-files Rik <octave@nomad.inbox5.com> parents: 10669 diff changeset	44 ##
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7411 diff changeset	45 ## @end ifnottex
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	46 ##
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	47 ## @noindent
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	48 ## The optional argument @var{flag} controls which normalization is used.
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	49 ## If @var{flag} is equal to 1 (default value, used when @var{flag} is omitted
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	50 ## or empty), return the sample kurtosis as defined above. If @var{flag} is
17698 9bb5d3f63cdd NEWS: Announce change in definition of kurtosis function for Matlab compatibility. Rik <rik@octave.org> parents: 17697 diff changeset	51 ## equal to 0, return the @w{"bias-corrected"} kurtosis coefficient instead:
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	52 ## @tex
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	53 ## $$
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	54 ## \kappa_0 = 3 + {\scriptstyle N - 1 \over \scriptstyle (N - 2)(N - 3)} \,
17698 9bb5d3f63cdd NEWS: Announce change in definition of kurtosis function for Matlab compatibility. Rik <rik@octave.org> parents: 17697 diff changeset	55 ## \left( (N + 1)\, \kappa_1 - 3 (N - 1) \right)
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	56 ## $$
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	57 ## @end tex
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	58 ## @ifnottex
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	59 ##
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	60 ## @example
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	61 ## @group
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	62 ## N - 1
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	63 ## k0 = 3 + -------------- * ((N + 1) * k1 - 3 * (N - 1))
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	64 ## (N - 2)(N - 3)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	65 ## @end group
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	66 ## @end example
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	67 ##
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	68 ## @end ifnottex
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	69 ## The bias-corrected kurtosis coefficient is obtained by replacing the sample
17698 9bb5d3f63cdd NEWS: Announce change in definition of kurtosis function for Matlab compatibility. Rik <rik@octave.org> parents: 17697 diff changeset	70 ## second and fourth central moments by their unbiased versions. It is an
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	71 ## unbiased estimate of the population kurtosis for normal populations.
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	72 ##
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	73 ## If @var{x} is a matrix, or more generally a multi-dimensional array, return
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	74 ## the kurtosis along the first non-singleton dimension. If the optional
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	75 ## @var{dim} argument is given, operate along this dimension.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	76 ##
12575 d0b799dafede Grammarcheck files for 3.4.1 release. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	77 ## @seealso{var, skewness, moment}
3367 0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe] jwe parents: 3200 diff changeset	78 ## @end deftypefn
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	79
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	80 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	81 ## Created: 29 July 1994
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	82 ## Adapted-By: jwe
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	83
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	84 function y = kurtosis (x, flag, dim)
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	85
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	86 if (nargin < 1) \|\| (nargin > 3)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	87 print_usage ();
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	88 endif
781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	89
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	90 if (! (isnumeric (x) \|\| islogical (x)))
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	91 error ("kurtosis: X must be a numeric vector or matrix");
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	92 endif
cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	93
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	94 if (nargin < 2 \|\| isempty (flag))
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	95 flag = 1; # default: do not use the "bias corrected" version
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	96 else
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	97 if (! isscalar (flag) \|\| (flag != 0 && flag != 1))
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	98 error ("kurtosis: FLAG must be 0 or 1");
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	99 endif
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	100 endif
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	101
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	102 nd = ndims (x);
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	103 sz = size (x);
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	104 if (nargin < 3)
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	105 ## Find the first non-singleton dimension.
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	106 (dim = find (sz > 1, 1)) \|\| (dim = 1);
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	107 else
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	108 if (! (isscalar (dim) && dim == fix (dim)) \|\| ! (1 <= dim && dim <= nd))
10669 cab3b148d4e4 Improve validation of input arguments for base statistics functions. Rik <octave@nomad.inbox5.com> parents: 10549 diff changeset	109 error ("kurtosis: DIM must be an integer and a valid dimension");
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	110 endif
28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	111 endif
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	112
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	113 n = sz(dim);
4886 54b076a24718 [project @ 2004-04-30 04:31:51 by jwe] jwe parents: 4885 diff changeset	114 sz(dim) = 1;
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	115
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	116 x = center (x, dim); # center also promotes integer, logical to double
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	117 v = var (x, 1, dim); # normalize with 1/N
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	118 y = sum (x .^ 4, dim);
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	119 idx = (v != 0);
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	120 y(idx) = y(idx) ./ (n * v(idx) .^ 2);
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	121 y(! idx) = NaN;
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	122
19627 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	123 ## Apply bias correction to the second and fourth central sample moment
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	124 if (flag == 0)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	125 if (n > 3)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	126 C = (n - 1) / ((n - 2) * (n - 3));
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	127 y = 3 + C * ((n + 1) * y - 3 * (n - 1));
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	128 else
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	129 y(:) = NaN;
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	130 endif
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	131 endif
4885 28ab079d8f0e [project @ 2004-04-30 04:21:33 by jwe] jwe parents: 4030 diff changeset	132
3200 781c930425fd [project @ 1998-10-29 05:23:08 by jwe] jwe parents: diff changeset	133 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	134
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	135
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	136 %!test
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	137 %! x = [-1; 0; 0; 0; 1];
83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	138 %! y = [x, 2*x];
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	139 %! assert (kurtosis (y), [2.5, 2.5], sqrt (eps));
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	140
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	141 %!assert (kurtosis ([-3, 0, 1]) == kurtosis ([-1, 0, 3]))
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	142 %!assert (kurtosis (ones (3, 5)), NaN (1, 5))
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	143
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	144 %!assert (kurtosis ([1:5 10; 1:5 10], 0, 2), 5.4377317925288901 * [1; 1], 8 * eps)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	145 %!assert (kurtosis ([1:5 10; 1:5 10], 1, 2), 2.9786509002956195 * [1; 1], 8 * eps)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	146 %!assert (kurtosis ([1:5 10; 1:5 10], [], 2), 2.9786509002956195 * [1; 1], 8 * eps)
12656 6b2f14af2360 Overhaul functions in statistics/base directory. Rik <octave@nomad.inbox5.com> parents: 12575 diff changeset	147
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	148 ## Test behaviour on single input
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	149 %!assert (kurtosis (single ([1:5 10])), single (2.9786513), eps ("single"))
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	150 %!assert (kurtosis (single ([1 2]), 0), single (NaN))
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	151
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	152 ## Verify no "divide-by-zero" warnings
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	153 %!test
20550 76f67400649e Use '-local' option to warning to simplify BIST tests. Rik <rik@octave.org> parents: 20209 diff changeset	154 %! warning ("on", "Octave:divide-by-zero", "local");
76f67400649e Use '-local' option to warning to simplify BIST tests. Rik <rik@octave.org> parents: 20209 diff changeset	155 %! lastwarn (""); # clear last warning
76f67400649e Use '-local' option to warning to simplify BIST tests. Rik <rik@octave.org> parents: 20209 diff changeset	156 %! kurtosis (1);
76f67400649e Use '-local' option to warning to simplify BIST tests. Rik <rik@octave.org> parents: 20209 diff changeset	157 %! assert (lastwarn (), "");
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	158
19867 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19731 diff changeset	159 ## Test input validation
11436 e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	160 %!error kurtosis ()
e151e23f73bc Overhaul base statistics functions and documentation of same. Rik <octave@nomad.inbox5.com> parents: 11149 diff changeset	161 %!error kurtosis (1, 2, 3)
17697 f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	162 %!error <X must be a numeric vector or matrix> kurtosis (['A'; 'B'])
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	163 %!error <FLAG must be 0 or 1> kurtosis (1, 2)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	164 %!error <FLAG must be 0 or 1> kurtosis (1, [1 0])
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	165 %!error <DIM must be an integer> kurtosis (1, [], ones (2,2))
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	166 %!error <DIM must be an integer> kurtosis (1, [], 1.5)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	167 %!error <DIM must be .* a valid dimension> kurtosis (1, [], 0)
f0e777cf348f kurtosis.m: Improve compatibility with Matlab's kurtosis function Julien Bect <julien.bect@supelec.fr> parents: 14399 diff changeset	168 %!error <DIM must be .* a valid dimension> kurtosis (1, [], 3)
20550 76f67400649e Use '-local' option to warning to simplify BIST tests. Rik <rik@octave.org> parents: 20209 diff changeset	169

Mercurial > octave-nkf

annotate scripts/statistics/base/kurtosis.m @ 20550:76f67400649e