std

Return standard deviation values in DataMatrix object

Syntax

S = std(DMObj)
S = std(DMObj, Flag)
S = std(DMObj, Flag, Dim)
S = std(DMObj, Flag, Dim, IgnoreNaN)

Input Arguments

DMObj

DataMatrix object, such as created by DataMatrix (object constructor).

Flag

Scalar specifying how to normalize the data. Choices are:

  • 0 — Default. Normalizes using a sample size of N – 1, unless N = 1, in which case, normalizes using a sample size of 1.

  • 1 — Normalizes using a sample size of N.

N = the number of elements in each column or row, as specified by Dim. For more information on the normalization equations, see the function std.

Dim

Scalar specifying the dimension of DMObj to calculate the standard deviations. Choices are:

  • 1 — Default. Returns standard deviation values for elements in each column.

  • 2 — Returns standard deviation values for elements in each row.

IgnoreNaN

Specifies if NaNs should be ignored. Choices are true (default) or false.

Output Arguments

S

Either of the following:

  • Row vector containing the standard deviation values from elements in each column in DMObj (when Dim = 1)

  • Column vector containing the standard deviation values from elements in each row in DMObj (when Dim = 2)

Description

S = std(DMObj) returns the standard deviation values of the elements in the columns of a DataMatrix object, treating NaNs as missing values. The data is normalized using a sample size of N – 1, where N = the number of elements in each column. S is a row vector containing the standard deviation values for elements in each column in DMObj.

S = std(DMObj, Flag) specifies how to normalize the data. If Flag = 0, normalizes using a sample size of N – 1. If Flag = 1, normalizes using a sample size of N. N = the number of elements in each column or row, as specified by Dim. For more information on the normalization equations, see the function std. Default Flag = 0.

S = std(DMObj, Flag, Dim) returns the standard deviation values of the elements in the columns or rows of a DataMatrix object, as specified by Dim. If Dim = 1, returns S, a row vector containing the standard deviation values for elements in each column in DMObj. If Dim = 2, returns S, a column vector containing the standard deviation values for elements in each row in DMObj. Default Dim = 1.

S = std(DMObj, Flag, Dim, IgnoreNaN) specifies if NaNs should be ignored. IgnoreNaN can be true (default) or false.

Version History

Introduced in R2008b

See Also

| | |