view scripts/statistics/distributions/exprnd.m @ 11472:1740012184f9

Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
author Rik <octave@nomad.inbox5.com>
date Sun, 09 Jan 2011 21:33:04 -0800
parents c776f063fefe
children fd0a3ac60b0e
line wrap: on
line source

## Copyright (C) 1995, 1996, 1997, 2005, 2006, 2007, 2008, 2009 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 (lambda, 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 (lambda) != 1)
        && (length (size (lambda)) != length (sz) || any (size (lambda) != 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 (lambda) != 1)
        && ((length (size (lambda)) != length (sz)) || any (size (lambda) != sz)))
      error ("exprnd: LAMBDA must be scalar or of size SZ");
    endif
  elseif (nargin == 1)
    sz = size (lambda);
  else
    print_usage ();
  endif


  if (isscalar (lambda))
    if ((lambda > 0) && (lambda < Inf))
      rnd = rande(sz) * lambda;
    else
      rnd = NaN (sz);
    endif
  else
    rnd = zeros (sz);
    k = find (!(lambda > 0) | !(lambda < Inf));
    if (any (k))
      rnd(k) = NaN;
    endif
    k = find ((lambda > 0) & (lambda < Inf));
    if (any (k))
      rnd(k) = rande(size(k)) .* lambda(k);
    endif
  endif

endfunction