Mercurial > octave-nkf
annotate scripts/statistics/tests/var_test.m @ 19867:9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Try to trim long lines to < 80 chars.
Use '##' for single line comments.
Use '(...)' around tests for if/elseif/switch/while.
Abut cell indexing operator '{' next to variable.
Abut array indexing operator '(' next to variable.
Use space between negation operator '!' and following expression.
Use two newlines between endfunction and start of %!test or %!demo code.
Remove unnecessary parens grouping between short-circuit operators.
Remove stray extra spaces (typos) between variables and assignment operators.
Remove stray extra spaces from ends of lines.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 23 Feb 2015 14:54:39 -0800 |
| parents | 4197fc428c7d |
| children | d9341b422488 |
| rev | line source |
|---|---|
|
19731
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
17744
diff
changeset
|
1 ## Copyright (C) 1995-2015 Kurt Hornik |
| 3426 | 2 ## |
| 3922 | 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 | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 3426 | 9 ## |
| 3922 | 10 ## Octave is distributed in the hope that it will be useful, but |
| 3200 | 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 3426 | 13 ## General Public License for more details. |
| 14 ## | |
| 3200 | 15 ## You should have received a copy of the GNU General Public License |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 3200 | 18 |
| 3454 | 19 ## -*- texinfo -*- |
| 20 ## @deftypefn {Function File} {[@var{pval}, @var{f}, @var{df_num}, @var{df_den}] =} var_test (@var{x}, @var{y}, @var{alt}) | |
| 21 ## For two samples @var{x} and @var{y} from normal distributions with | |
| 22 ## unknown means and unknown variances, perform an F-test of the null | |
| 6754 | 23 ## hypothesis of equal variances. Under the null, the test statistic |
| 24 ## @var{f} follows an F-distribution with @var{df_num} and @var{df_den} | |
| 25 ## degrees of freedom. | |
| 3200 | 26 ## |
| 3454 | 27 ## With the optional argument string @var{alt}, the alternative of |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
28 ## interest can be selected. If @var{alt} is @qcode{"!="} or |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
29 ## @qcode{"<>"}, the null is tested against the two-sided alternative |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
30 ## @code{var (@var{x}) != var (@var{y})}. If @var{alt} is @qcode{">"}, |
| 3454 | 31 ## the one-sided alternative @code{var (@var{x}) > var (@var{y})} is |
| 3457 | 32 ## used. Similarly for "<", the one-sided alternative @code{var |
| 33 ## (@var{x}) > var (@var{y})} is used. The default is the two-sided | |
| 34 ## case. | |
| 3200 | 35 ## |
| 3454 | 36 ## The p-value of the test is returned in @var{pval}. |
| 3426 | 37 ## |
| 3200 | 38 ## If no output argument is given, the p-value of the test is displayed. |
| 3454 | 39 ## @end deftypefn |
| 3200 | 40 |
| 5428 | 41 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 3456 | 42 ## Description: F test to compare two variances |
| 3200 | 43 |
| 44 function [pval, f, df_num, df_den] = var_test (x, y, alt) | |
| 3426 | 45 |
|
19867
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
46 if (nargin < 2 || nargin > 3) |
| 6046 | 47 print_usage (); |
| 3200 | 48 endif |
| 3426 | 49 |
| 4030 | 50 if (! (isvector (x) && isvector (y))) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
51 error ("var_test: both X and Y must be vectors"); |
| 3200 | 52 endif |
| 53 | |
| 54 df_num = length (x) - 1; | |
| 55 df_den = length (y) - 1; | |
| 56 f = var (x) / var (y); | |
|
13752
6f068e3f3f9c
Change f_cdf references to fcdf in statistics/test directory (Bug #34628)
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
57 cdf = fcdf (f, df_num, df_den); |
| 3426 | 58 |
| 3200 | 59 if (nargin == 2) |
|
19867
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19731
diff
changeset
|
60 alt = "!="; |
| 3200 | 61 endif |
| 3426 | 62 |
| 5443 | 63 if (! ischar (alt)) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
7017
diff
changeset
|
64 error ("var_test: ALT must be a string"); |
| 3200 | 65 endif |
| 66 if (strcmp (alt, "!=") || strcmp (alt, "<>")) | |
| 67 pval = 2 * min (cdf, 1 - cdf); | |
| 68 elseif (strcmp (alt, ">")) | |
| 69 pval = 1 - cdf; | |
| 70 elseif (strcmp (alt, "<")) | |
| 71 pval = cdf; | |
| 72 else | |
| 3456 | 73 error ("var_test: option %s not recognized", alt); |
| 3200 | 74 endif |
| 3426 | 75 |
| 3200 | 76 if (nargout == 0) |
| 3456 | 77 printf ("pval: %g\n", pval); |
| 3200 | 78 endif |
| 79 | |
| 80 endfunction | |
|
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
81 |