Mercurial > octave

changeset 31355:4c6c8f14766c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add normalize to manual and clean up docstring * normalize.m: Add one line function summary and clean up docstring text. * doc/interpreter/stats.txi: Link normalize docstring to octave manual in statistics section on data preparation.
author Nicholas R. Jankowski <jankowski.nicholas@gmail.com>
date Thu, 27 Oct 2022 10:20:10 -0400
parents 38b954c0c0c1
children 07a3ceab58d6
files doc/interpreter/stats.txi scripts/statistics/normalize.m
diffstat 2 files changed, 16 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/stats.txi	Thu Oct 27 09:35:01 2022 -0400
+++ b/doc/interpreter/stats.txi	Thu Oct 27 10:20:10 2022 -0400
@@ -151,6 +151,8 @@
 
 @DOCSTRING(zscore)
 
+@DOCSTRING(normalize)
+
 @DOCSTRING(histc)
 
 @noindent
--- a/scripts/statistics/normalize.m	Thu Oct 27 09:35:01 2022 -0400
+++ b/scripts/statistics/normalize.m	Thu Oct 27 10:20:10 2022 -0400
@@ -31,11 +31,17 @@
 ## @deftypefnx {} {@var{Z} =} normalize (@dots{}, @var{scale}, @var{ScaleOption}, @var{center}, @var{CenterOption})
 ## @deftypefnx {} {[@var{Z}, @var{C}, @var{S}] =} normalize (@dots{})
 ##
-## Returns a normalization of @var{X}.  The default normalization is the
-## @code{zscore} of @var{X}, defined as the number of standard deviations each
-## element is from the mean of @var{X}.  The returned value @var{Z} will have
-## the same size as @var{X}. The optional return variables @var{C} and @var{S}
-## are the centering and scaling factors used in the normalization such that:
+## Return a normalization of the data in @var{X} using one of several available
+## scaling and centering methods.
+##
+## @code{normalize} by default will return the @code{zscore} of @var{X}, defined
+## as the number of standard deviations each element is from the mean of
+## @var{X}.  This is equivalent to centering at the mean of the data and scaling
+## by the standard deviation.
+##
+## The returned value @var{Z} will have the same size as @var{X}. The optional
+## return variables @var{C} and @var{S} are the centering and scaling factors
+## used in the normalization such that:
 ##
 ## @example
 ## @group
@@ -51,8 +57,9 @@
 ## If @var{X} is a n-dimensional array, @code{normalize} will operate
 ## independently on the first non-singleton dimension in @var{X}.
 ##
-## The optional second input variable @var{DIM} can be used to force @code{normalize}
-## to operate over the specified dimension. @var{DIM} must be an integer scalar.
+## The optional second input variable @var{DIM} can be used to force
+## code{normalize} to operate over the specified dimension. @var{DIM} must be an
+## integer scalar.
 ##
 ## The optional input variables @var{Method} and @var{Option} can be used to
 ## specify the type of normalization performed on @var{X}.  Note that only the