octave_packages/m/deprecated/weibrnd.m

   1 ## Copyright (C) 2006-2012 John W. Eaton
   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
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   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
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{r}, @var{c})
  21 ## @deftypefnx {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{sz})
  22 ## Return an @var{r} by @var{c} matrix of random samples from the
  23 ## Weibull distribution with parameters @var{scale} and @var{shape}
  24 ## which must be scalar or of size @var{r} by @var{c}.  Or if @var{sz}
  25 ## is a vector return a matrix of size @var{sz}.
  26 ##
  27 ## If @var{r} and @var{c} are omitted, the size of the result matrix is
  28 ## the common size of @var{alpha} and @var{sigma}.
  29 ## @end deftypefn
  30
  31 ## Deprecated in version 3.0
  32 ## Matlab still has this function, so don't remove just yet.
  33
  34 function rnd = weibrnd (varargin)
  35
  36   persistent warned = false;
  37   if (! warned)
  38     warned = true;
  39     warning ("Octave:deprecated-function",
  40              "weibrnd is obsolete and will be removed from a future version of Octave; please use wblrnd instead");
  41   endif
  42
  43   rnd = wblrnd (varargin{:});
  44
  45 endfunction
  46