X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=octave_packages%2Fm%2Fdeprecated%2Fweibrnd.m;fp=octave_packages%2Fm%2Fdeprecated%2Fweibrnd.m;h=a419934a5bd650a3ca7be1cba88608e7bd620c8a;hb=1c0469ada9531828709108a4882a751d2816994a;hp=0000000000000000000000000000000000000000;hpb=63de9f36673d49121015e3695f2c336ea92bc278;p=CreaPhase.git diff --git a/octave_packages/m/deprecated/weibrnd.m b/octave_packages/m/deprecated/weibrnd.m new file mode 100644 index 0000000..a419934 --- /dev/null +++ b/octave_packages/m/deprecated/weibrnd.m @@ -0,0 +1,46 @@ +## Copyright (C) 2006-2012 John W. Eaton +## +## 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 +## . + +## -*- texinfo -*- +## @deftypefn {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{r}, @var{c}) +## @deftypefnx {Function File} {} weibrnd (@var{scale}, @var{shape}, @var{sz}) +## Return an @var{r} by @var{c} matrix of random samples from the +## Weibull distribution with parameters @var{scale} and @var{shape} +## which must be scalar or of size @var{r} by @var{c}. Or if @var{sz} +## is a vector return a matrix of size @var{sz}. +## +## If @var{r} and @var{c} are omitted, the size of the result matrix is +## the common size of @var{alpha} and @var{sigma}. +## @end deftypefn + +## Deprecated in version 3.0 +## Matlab still has this function, so don't remove just yet. + +function rnd = weibrnd (varargin) + + persistent warned = false; + if (! warned) + warned = true; + warning ("Octave:deprecated-function", + "weibrnd is obsolete and will be removed from a future version of Octave; please use wblrnd instead"); + endif + + rnd = wblrnd (varargin{:}); + +endfunction +