changeset 14273:bedccd0abe39

Add comment in var.m docs about behaviour when input is a scalar * var.m: Add comment in docs about behaviour when input is a scalar
author Carlo de Falco <kingcrimson@tiscali.it>
date Sat, 28 Jan 2012 13:25:20 +0100
parents 4f8d2931f886
children 727b74f512af
files scripts/statistics/base/var.m
diffstat 1 files changed, 3 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/scripts/statistics/base/var.m	Fri Jan 27 20:54:15 2012 -0800
+++ b/scripts/statistics/base/var.m	Sat Jan 28 13:25:20 2012 +0100
@@ -51,6 +51,9 @@
 ##   normalizes with @math{N}, this provides the second moment around the mean
 ## @end table
 ##
+## If @math{N==1} the value of @var{opt} is ignored and normalization 
+## by @math{N} is used.
+##
 ## If the optional argument @var{dim} is given, operate along this dimension.
 ## @seealso{cov, std, skewness, kurtosis, moment}
 ## @end deftypefn