Mercurial > hg > octave-lyh

annotate scripts/deprecated/pascal_pdf.m @ 7696:0a362fa8f3c8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1995, 1996, 1997, 2007 Kurt Hornik
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
2 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
4 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
6 ## 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: 6349
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6349
diff changeset
8 ## your option) any later version.
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
9 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
14 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
15 ## 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: 6349
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6349
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
18
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefn {Function File} {} pascal_pdf (@var{x}, @var{n}, @var{p})
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
21 ## For each element of @var{x}, compute the probability density function
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
22 ## (PDF) at @var{x} of the Pascal (negative binomial) distribution with
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
23 ## parameters @var{n} and @var{p}.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
24 ##
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
25 ## The number of failures in a Bernoulli experiment with success
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
26 ## probability @var{p} before the @var{n}-th success follows this
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
27 ## distribution.
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
28 ## @end deftypefn
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
29
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
30 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
31 ## Description: PDF of the Pascal (negative binomial) distribution
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
32
7693
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
33 ## Deprecated in version 3.0
8e5371d47da6 note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
34
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
35 function pdf = pascal_pdf (varargin)
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
36
7696
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
37 persistent warned = false;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
38 if (! warned)
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
39 warned = true;
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
40 warning ("Octave:deprecated-function",
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
41 ["pascal_pdf 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
42 "version of Octave, please use nbinpdf instead"]);
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
43 endif
0a362fa8f3c8 Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 7693
diff changeset
44
6349
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
45 pdf = nbinpdf (varargin{:});
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
46
859f7aaea254 [project @ 2007-02-23 14:20:42 by dbateman]
dbateman
parents:
diff changeset
47 endfunction