https://github.com/cran/pracma
Raw File
Tip revision: 71455748623ef69836470c75c5f9384f6e872d45 authored by HwB on 28 June 2011, 00:00:00 UTC
version 0.6-3
Tip revision: 7145574
mdiag.Rd
\name{mdiag}
\alias{mdiag}
\title{Matrix diagonal}
\description{
Generate diagonal matrices or return diagonal of a matrix
}
\usage{
mdiag(x, k = 0)
}
\arguments{
  \item{x}{vector or matrix}
  \item{k}{integer indicating a secondary diagonal}
}
\details{
If \code{x} is a vector, \code{mdiag(x, k)} generates a matrix with \code{x}
as the (k-th secondary) diagonal.

If \code{x} is a matrix, \code{mdiag(x, k)} returns the (\code{k}-th secondary) diagonal of \code{x}.

The \code{k}-th secondary diagonal is above the main diagonal for \code{k > 0}
and below the main diagonal for \code{k < 0}.
}
\value{
matrix or vector
}
\note{
In Matlab/Octave this function is called \code{diag()} and has a different
signature than the corresponding function in \R.
}
\seealso{
\code{\link{diag}}, \code{\link{mtrace}}
}
\examples{
mdiag(matrix(1:12,3,4),  1)
mdiag(matrix(1:12,3,4), -1)

mdiag(c(1,5,9), 1)
mdiag(c(1,5,9), -1)
}
\keyword{ array }
back to top