Mercurial > hg > octave-lyh
view scripts/deprecated/gamma_rnd.m @ 8920:eb63fbe60fab
update copyright notices
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Sat, 07 Mar 2009 10:41:27 -0500 |
parents | 1cdb42b372e8 |
children |
line wrap: on
line source
## Copyright (C) 1995, 1996, 1997, 2005, 2007, 2008 Kurt Hornik ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} gamma_rnd (@var{a}, @var{b}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} gamma_rnd (@var{a}, @var{b}, @var{sz}) ## Return an @var{r} by @var{c} or a @code{size (@var{sz})} matrix of ## random samples from the Gamma distribution with parameters @var{a} ## and @var{b}. Both @var{a} and @var{b} must be scalar or of size ## @var{r} by @var{c}. ## ## If @var{r} and @var{c} are omitted, the size of the result matrix is ## the common size of @var{a} and @var{b}. ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Random deviates from the Gamma distribution ## Deprecated in version 3.0 function rnd = gamma_rnd (varargin) persistent warned = false; if (! warned) warned = true; warning ("Octave:deprecated-function", "gamma_rnd is obsolete and will be removed from a future version of Octave; please use gamrnd instead"); endif if (nargin > 1) varargin{2} = 1 ./ varargin{2}; endif rnd = gamrnd (varargin{:}); endfunction