Home > freetb4matlab > statistics > base > var.m

var

PURPOSE ^

% For vector arguments, return the (real) variance of the values.

SYNOPSIS ^

function retval = var (x, opt, dim)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} var (@var{x})
% For vector arguments, return the (real) variance of the values.
% For matrix arguments, return a row vector containing the variance for
% each column.
%
% The argument @var{opt} determines the type of normalization to use.
% Valid values are
%
% @table @asis 
% @item 0:
% Normalizes with @math{N-1}, provides the best unbiased estimator of the
% variance [default].
% @item 1:
% Normalizes with @math{N}, this provides the second moment around the mean.
% @end table
%
% The third argument @var{dim} determines the dimension along which the 
% variance is calculated.
% @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