Mercurial > hg > octave-nkf

annotate scripts/deprecated/hypergeometric_rnd.m @ 11744:eb0a86b3deb9 release-3-0-x

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
don't embed newline in warning messages in deprecated functions
author John W. Eaton <jwe@octave.org>
date Wed, 09 Apr 2008 12:57:36 -0400
parents 72830070a17b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11740
72830070a17b update copyright dates
John W. Eaton <jwe@octave.org>
parents: 11737
diff changeset
1 ## Copyright (C) 1997, 2005, 2006, 2007, 2008 Kurt Hornik
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
2 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
4 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
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: 5691
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: 5691
diff changeset
8 ## your option) any later version.
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
9 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
14 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
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: 5691
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: 5691
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
18
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
5691
9be68956e450 [project @ 2006-03-17 15:14:41 by jwe]
jwe
parents: 5413
diff changeset
20 ## @deftypefn {Function File} {} hypergeometric_rnd (@var{m}, @var{t}, @var{n}, @var{r}, @var{c})
9be68956e450 [project @ 2006-03-17 15:14:41 by jwe]
jwe
parents: 5413
diff changeset
21 ## @deftypefnx {Function File} {} hygernd (@var{m}, @var{t}, @var{n}, @var{sz})
9be68956e450 [project @ 2006-03-17 15:14:41 by jwe]
jwe
parents: 5413
diff changeset
22 ## Return an @var{r} by @var{c} matrix of random samples from the
9be68956e450 [project @ 2006-03-17 15:14:41 by jwe]
jwe
parents: 5413
diff changeset
23 ## hypergeometric distribution with parameters @var{m}, @var{t},
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
24 ## and @var{n}.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
25 ##
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
26 ## The parameters @var{m}, @var{t}, and @var{n} must positive integers
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
27 ## with @var{m} and @var{n} not greater than @var{t}.
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
28 ## @end deftypefn
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
29
11736
9d412bc1d54f note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
30 ## Deprecated in version 3.0
9d412bc1d54f note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
31
5691
9be68956e450 [project @ 2006-03-17 15:14:41 by jwe]
jwe
parents: 5413
diff changeset
32 function rnd = hypergeometric_rnd (varargin)
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
33
11737
dd93a39fa8fe Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 11736
diff changeset
34 persistent warned = false;
dd93a39fa8fe Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 11736
diff changeset
35 if (! warned)
dd93a39fa8fe Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 11736
diff changeset
36 warned = true;
dd93a39fa8fe Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 11736
diff changeset
37 warning ("Octave:deprecated-function",
11744
eb0a86b3deb9 don't embed newline in warning messages in deprecated functions
John W. Eaton <jwe@octave.org>
parents: 11740
diff changeset
38 "hypergeometric_rnd is obsolete and will be removed from a future version of Octave; please use hygernd instead");
11737
dd93a39fa8fe Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 11736
diff changeset
39 endif
dd93a39fa8fe Add warning to rest of deprecated functions
David Bateman <dbateman@free.fr>
parents: 11736
diff changeset
40
5691
9be68956e450 [project @ 2006-03-17 15:14:41 by jwe]
jwe
parents: 5413
diff changeset
41 rnd = hygernd (varargin{:});
5411
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
42
bee21f388110 [project @ 2005-07-13 17:53:44 by jwe]
jwe
parents:
diff changeset
43 endfunction