Mercurial > hg > octave-lyh
view scripts/deprecated/exponential_rnd.m @ 8874:bd1b1fe9c6e9 ss-3-1-53
bump version info for snapshot
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 25 Feb 2009 18:35:47 -0500 |
parents | 1cdb42b372e8 |
children | eb63fbe60fab |
line wrap: on
line source
## Copyright (C) 1995, 1996, 1997, 2005, 2007 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} {} exponential_rnd (@var{lambda}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} exponential_rnd (@var{lambda}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the ## exponential distribution with parameter @var{lambda}, which must be a ## scalar or of size @var{r} by @var{c}. Or if @var{sz} is a vector, ## create a matrix of size @var{sz}. ## ## If @var{r} and @var{c} are omitted, the size of the result matrix is ## the size of @var{lambda}. ## @end deftypefn ## Author: KH <Kurt.Hornik@wu-wien.ac.at> ## Description: Random deviates from the exponential distribution ## Deprecated in version 3.0 function rnd = exponential_rnd (varargin) persistent warned = false; if (! warned) warned = true; warning ("Octave:deprecated-function", "exponential_rnd is obsolete and will be removed from a future version of Octave; please use exprnd instead"); endif if (nargin > 0) varargin{1} = 1 ./ varargin{1}; endif rnd = exprnd (varargin{:}); endfunction