Mercurial > hg > octave-lyh
view scripts/statistics/distributions/exprnd.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 16f53d29049f |
line wrap: on
line source
## Copyright (C) 1995, 1996, 1997, 2005, 2006, 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} {} exprnd (@var{lambda}, @var{r}, @var{c}) ## @deftypefnx {Function File} {} exprnd (@var{lambda}, @var{sz}) ## Return an @var{r} by @var{c} matrix of random samples from the ## exponential distribution with mean @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 function rnd = exprnd (l, r, c) if (nargin == 3) if (! (isscalar (r) && (r > 0) && (r == round (r)))) error ("exprnd: r must be a positive integer"); endif if (! (isscalar (c) && (c > 0) && (c == round (c)))) error ("exprnd: c must be a positive integer"); endif sz = [r, c]; if (any (size (l) != 1) && (length (size (l)) != length (sz) || any (size (l) != sz))) error ("exprnd: lambda must be scalar or of size [r, c]"); endif elseif (nargin == 2) if (isscalar (r) && (r > 0)) sz = [r, r]; elseif (isvector(r) && all (r > 0)) sz = r(:)'; else error ("exprnd: r must be a positive integer or vector"); endif if (any (size (l) != 1) && ((length (size (l)) != length (sz)) || any (size (l) != sz))) error ("exprnd: lambda must be scalar or of size sz"); endif elseif (nargin == 1) sz = size (l); else print_usage (); endif if (isscalar (l)) if ((l > 0) && (l < Inf)) rnd = rande(sz) * l; else rnd = NaN * ones (sz); endif else rnd = zeros (sz); k = find (!(l > 0) | !(l < Inf)); if (any (k)) rnd(k) = NaN; endif k = find ((l > 0) & (l < Inf)); if (any (k)) rnd(k) = rande(size(k)) .* l(k); endif endif endfunction