rms {gsignal}

Root-mean-square

Description

Compute the root-mean-square (RMS) of the object x.

Usage

rms(x, MARGIN = 2)

Arguments

x

the data, expected to be a vector, a matrix, an array.

MARGIN

a vector giving the subscripts which the function will be applied over. E.g., for a matrix 1 indicates rows, 2 indicates columns, c(1, 2) indicates rows and columns. Where x has named dimnames, it can be a character vector selecting dimension names. Default: 2 (columns)

Details

The input x can be a vector, a matrix or an array. If the input is a vector, a single value is returned representing the root-mean-square of the vector. If the input is a matrix or an array, a vector or an array of values is returned representing the root-mean-square of the dimensions of x indicated by the MARGIN argument.

Support for complex valued input is provided. The sum of squares of complex numbers is defined by sum(x * Conj(x))

Value

Vector or array of values containing the root-mean-squares of the specified MARGIN of x.

Author(s)

Andreas Weber, [e-mail].
Conversion to R by Geert van Boxtel, [e-mail].

Examples

## numeric vector
x <- c(1:5)
r <- rms(x)

## numeric matrix
x <- matrix(c(1,2,3, 100, 150, 200, 1000, 1500, 2000), 3, 3)
p <- rms(x)
p <- rms(x, 1)

## numeric array
x <- array(c(1, 1.5, 2, 100, 150, 200, 1000, 1500,
           2000, 10000, 15000, 20000), c(2,3,2))
p <- rms(x, 1)
p <- rms(x, 2)
p <- rms(x, 3)

## complex input
x <- c(1+1i, 2+3i, 3+5i, 4+7i, 5+9i)
p <- rms(x)