Mercurial > hg > octave-nkf
annotate scripts/deprecated/hypergeometric_cdf.m @ 7696:0a362fa8f3c8
Add warning to rest of deprecated functions
| author | David Bateman <dbateman@free.fr> |
|---|---|
| date | Fri, 04 Apr 2008 10:18:35 -0400 |
| parents | 8e5371d47da6 |
| children | 1cdb42b372e8 72830070a17b |
| rev | line source |
|---|---|
| 7017 | 1 ## Copyright (C) 1997, 2005, 2007 Kurt Hornik |
| 5411 | 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 | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 5411 | 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 | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 5411 | 18 |
| 19 ## -*- texinfo -*- | |
| 20 ## @deftypefn {Function File} {} hypergeometric_cdf (@var{x}, @var{m}, @var{t}, @var{n}) | |
| 21 ## Compute the cumulative distribution function (CDF) at @var{x} of the | |
| 22 ## hypergeometric distribution with parameters @var{m}, @var{t}, and | |
| 23 ## @var{n}. This is the probability of obtaining not more than @var{x} | |
| 24 ## marked items when randomly drawing a sample of size @var{n} without | |
| 25 ## replacement from a population of total size @var{t} containing | |
| 26 ## @var{m} marked items. | |
| 27 ## | |
| 28 ## The parameters @var{m}, @var{t}, and @var{n} must positive integers | |
| 29 ## with @var{m} and @var{n} not greater than @var{t}. | |
| 30 ## @end deftypefn | |
| 31 | |
| 5428 | 32 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> |
| 5411 | 33 ## Description: CDF of the hypergeometric distribution |
| 34 | |
|
7693
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
35 ## Deprecated in version 3.0 |
|
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
36 |
| 5411 | 37 function cdf = hypergeometric_cdf (varargin) |
| 38 | |
|
7696
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
39 persistent warned = false; |
|
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
40 if (! warned) |
|
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
41 warned = true; |
|
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
42 warning ("Octave:deprecated-function", |
|
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
43 ["hypergeometric_cdf is obsolete and will be removed from a future\n", |
|
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
44 "version of Octave, please use hygecdf instead"]); |
|
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
45 endif |
|
0a362fa8f3c8
Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents:
7693
diff
changeset
|
46 |
| 5411 | 47 cdf = hygecdf (varargin{:}); |
| 48 | |
| 49 endfunction | |
| 50 | |
| 51 |