changelog shortlog tags changeset files revisions annotate raw

scripts/deprecated/chisquare_rnd.m

changeset 9846: 1d90fc211872
parent:1cdb42b372e8
author: John W. Eaton <jwe@octave.org>
date: Sat Nov 21 21:44:51 2009 -0500 (33 hours ago)
permissions: -rw-r--r--
description: configure.ac: report freetype, fontconfig, and fltk cflags and libs info 
     1## Copyright (C) 1995, 1996, 1997, 2005, 2007, 2008 Kurt Hornik

     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} {} chisquare_rnd (@var{n}, @var{r}, @var{c})

    21## @deftypefnx {Function File} {} chisquare_rnd (@var{n}, @var{sz})

    22## Return an @var{r} by @var{c}  or a @code{size (@var{sz})} matrix of 

    23## random samples from the chisquare distribution with @var{n} degrees 

    24## of freedom.  @var{n} must be a scalar or of size @var{r} by @var{c}.

    25##

    26## If @var{r} and @var{c} are omitted, the size of the result matrix is

    27## the size of @var{n}.

    28## @end deftypefn

    29

    30## Author: KH <Kurt.Hornik@wu-wien.ac.at>

    31## Description: Random deviates from the chi-square distribution

    32

    33## Deprecated in version 3.0

    34

    35function rnd = chisquare_rnd (varargin)

    36

    37  persistent warned = false;

    38  if (! warned)

    39    warned = true;

    40    warning ("Octave:deprecated-function",

    41             "chisquare_rnd is obsolete and will be removed from a future version of Octave; please use chi2rnd instead");

    42  endif

    43

    44 rnd =  chi2rnd (varargin{:});

    45

    46endfunction