view scripts/deprecated/weibrnd.m @ 13749:62d1f56b0be7

New nthargout function * nthargout.m: New function. * func.txi (Multiple Return Values): document nthargout. * module.mk (general_FCN_FILES): Add nthargout.m * help.cc (varargin, varargout): Cross-reference other arg functions. * ov-user-fucn.cc (nargin, nargout, isargout): Ditto. * NEWS (3.6): Mention this new file.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Tue, 25 Oct 2011 09:46:38 -0700
parents fd0a3ac60b0e
children 72c96de7a403
line wrap: on
line source

## Copyright (C) 2006-2011 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
## <http://www.gnu.org/licenses/>.

## -*- 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