Home > freetb4matlab > statistics > raylrnd.m

raylrnd

PURPOSE ^

% Generate a matrix of random samples from the Rayleigh distribution.

SYNOPSIS ^

function x = raylrnd (sigma, r, c)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {@var{x} =} raylrnd (@var{sigma})
% @deftypefnx {Function File} {@var{x} =} raylrnd (@var{sigma}, @var{sz})
% @deftypefnx {Function File} {@var{x} =} raylrnd (@var{sigma}, @var{r}, @var{c})
% Generate a matrix of random samples from the Rayleigh distribution.
%
% @subheading Arguments
%
% @itemize @bullet
% @item
% @var{sigma} is the parameter of the Rayleigh distribution. The elements
% of @var{sigma} must be positive.
%
% @item
% @var{sz} is the size of the matrix to be generated. @var{sz} must be a
% vector of non-negative integers.
%
% @item
% @var{r} is the number of rows of the matrix to be generated. @var{r} must
% be a non-negative integer.
%
% @item
% @var{c} is the number of columns of the matrix to be generated. @var{c}
% must be a non-negative integer.
% @end itemize
%
% @subheading Return values
%
% @itemize @bullet
% @item
% @var{x} is a matrix of random samples from the Rayleigh distribution with
% corresponding parameter @var{sigma}. If neither @var{sz} nor @var{r} and
% @var{c} are specified, then @var{x} is of the same size as @var{sigma}.
% @end itemize
%
% @subheading Examples
%
% @example
% @group
% sigma = 1:6;
% x = raylrnd (sigma)
% @end group
%
% @group
% sz = [2, 3];
% x = raylrnd (0.5, sz)
% @end group
%
% @group
% r = 2;
% c = 3;
% x = raylrnd (0.5, r, c)
% @end group
% @end example
%
% @subheading References
%
% @enumerate
% @item
% Wendy L. Martinez and Angel R. Martinez. @cite{Computational Statistics
% Handbook with MATLAB}. Appendix E, pages 547-557, Chapman & Hall/CRC,
% 2001.
%
% @item
% Athanasios Papoulis. @cite{Probability, Random Variables, and Stochastic
% Processes}. pages 104 and 148, McGraw-Hill, New York, second edition,
% 1984.
% @end enumerate
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003