Mercurial > hg > octave-lyh
annotate scripts/deprecated/hypergeometric_rnd.m @ 7693:8e5371d47da6
note version when functions were deprecated
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Thu, 03 Apr 2008 21:56:23 -0400 |
parents | a1dbe9d80eee |
children | 0a362fa8f3c8 |
rev | line source |
---|---|
7017 | 1 ## Copyright (C) 1997, 2005, 2006, 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 -*- | |
5691 | 20 ## @deftypefn {Function File} {} hypergeometric_rnd (@var{m}, @var{t}, @var{n}, @var{r}, @var{c}) |
21 ## @deftypefnx {Function File} {} hygernd (@var{m}, @var{t}, @var{n}, @var{sz}) | |
22 ## Return an @var{r} by @var{c} matrix of random samples from the | |
23 ## hypergeometric distribution with parameters @var{m}, @var{t}, | |
5411 | 24 ## and @var{n}. |
25 ## | |
26 ## The parameters @var{m}, @var{t}, and @var{n} must positive integers | |
27 ## with @var{m} and @var{n} not greater than @var{t}. | |
28 ## @end deftypefn | |
29 | |
7693
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
30 ## Deprecated in version 3.0 |
8e5371d47da6
note version when functions were deprecated
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
31 |
5691 | 32 function rnd = hypergeometric_rnd (varargin) |
5411 | 33 |
5691 | 34 rnd = hygernd (varargin{:}); |
5411 | 35 |
36 endfunction |