Skip to contents

Function written to match MATLAB's diag function

Source: R/diag_matlab.R
diag_matlab.Rd

There are some differences between tha MATLAB and the R version of diag. Specifically, if a 1xN or a Nx1 matrix is supplied to the R diag function then just the first element of this vector is returned. This function tries to match the MATLAB version in handling vectors (matricies with one dimension equal to one), and will return a diagonal matrix in these situations.

Usage

diag_matlab(mat)

Arguments

mat

Either a vector to make into a diagonal matrix or a matrix you want to extract the diagonal from

Value

Either a diagonal matrix or the diagonal of a matrix.

See also

Other MATLAB: cell(), feval(), fileparts(), isempty(), ones(), rand(), randn(), size(), tic(), toc(), zeros()

Examples


diag_matlab(3)
#>      [,1] [,2] [,3]
#> [1,]    1    0    0
#> [2,]    0    1    0
#> [3,]    0    0    1
diag_matlab(c(1,2,3))
#>      [,1] [,2] [,3]
#> [1,]    1    0    0
#> [2,]    0    2    0
#> [3,]    0    0    3
diag_matlab(cbind(1,2,3))
#>      [,1] [,2] [,3]
#> [1,]    1    0    0
#> [2,]    0    2    0
#> [3,]    0    0    3
diag_matlab(rbind(1,2,3))
#>      [,1] [,2] [,3]
#> [1,]    1    0    0
#> [2,]    0    2    0
#> [3,]    0    0    3

diag_matlab(matrix(c(1, 2, 3),6,6))
#> [1] 1 2 3 1 2 3

# here is where the R default does something different
diag(cbind(1,2,3))
#> [1] 1
diag(rbind(1,2,3))
#> [1] 1