permute: Permutation of a matricized array

View source: R/utils.R

permuteR Documentation

Permutation of a matricized array

Description

Permutes the matricized (n x m x p) array X to the matricized array Y of order (m x p x n).

Usage

 permute(X,n,m,p)

Arguments

X

Matrix (or data.frame coerced to a matrix) containing the matricized array

n

Number of A-mode entities of the array X

m

Number of B-mode entities of the array X

p

Number of C-mode entities of the array X

Value

Y

Matrix containing the permuted matricized array

References

H.A.L. Kiers (2000). Towards a standardized notation and terminology in multiway analysis. Journal of Chemometrics 14:105–122.

Examples

X <- array(1:24, c(4,3,2))
dim(X)

##  matricize the array
Xa <- unfold(X)     # matricized X with the A-mode entities in its rows
dim(Xa)
Xa

## matricized X with the B-mode entities in its rows
Xb <- permute(Xa, 4, 3, 2)
dim(Xb)
Xb

## matricized X with the C-mode entities in its rows
Xc <- permute(Xb, 3, 2, 4)
dim(Xc)
Xc

rrcov3way documentation built on July 9, 2023, 7:44 p.m.