rms

Root-mean-square value

Introduction

For a given vector $x=\begin{bmatrix}x_1,x_2,\ldots,x_n\end{bmatrix}$, its root-mean-square (RMS) value is given by the following formula:

where $|x_i|$ is the absolute value if $x_i$ is real and modulus if complex.

Usages

r = rms(A)

r = rms(A, nanFlag)

• If A is empty, r is an empty array.
• If A is a scalar, r is equal to A.
• If A is a vector, r is the RMS value of elements along the longer dimension of A.
• If A is a matrix or multi-dimensional array, elements of s are RMS values of vectors of A along the first non-singleton dimension.
• nanFlag should be either 'includeNaN' or 'omitNaN', which indicate that NaN values in A should be included or omitted when calculating r, respectively.

r = rms(A, dim)

r = rms(A, dim, nanFlag)

• dim should be a dimension number, i.e., a real positive integer scalar.
• Same as r = rms(A) and r = rms(A, nanFlag), except that r contains RMS values of vectors along the dim-th dimension.

r = rms(A, dimVec)

r = rms(A, dimVec, nanFlag)

• dimVec should be a vector of dimension numbers, i.e., vector of real positive integer scalars.
• Same as r = rms(A) and r = rms(A, nanFlag), except that r contains RMS values of elements in the spaces of dimensions dimVec(1), dimVec(2), ..., dimVec(end).

r = rms(A, 'all')

r = rms(A, 'all', nanFlag)

• Same as r = rms(A) and r = rms(A, nanFlag), except that r contains RMS values of all elements of A.
• r is always a scalar.