https://github.com/cran/pracma
Tip revision: 708a2ad382a163d1eef5af0665e3ae2aad200ced authored by HwB on 21 March 2013, 00:00:00 UTC
version 1.4.5
version 1.4.5
Tip revision: 708a2ad
squareform.Rd
\name{squareform}
\alias{squareform}
\title{
Format Distance Matrix (Matlab Style)
}
\description{
Format or generate a distance matrix.
}
\usage{
squareform(x)
}
\arguments{
\item{x}{numeric vector or matrix.}
}
\details{
If \code{x} is a vector as created by the \code{dist} function, it converts
it into a fulll square, symmetric matrix.
And if \code{x} is a distance matrix, i.e. square, symmetric amd with zero
diagonal elements, it returns the flattened lower triangular submatrix.
}
\value{
Returns a matrix if \code{x} is a vector,
and a vextor if \code{x} is a matrix.
}
\seealso{
\code{\link{dist}}
}
\examples{
x <- 1:6
y <- squareform(x)
# 0 1 2 3
# 1 0 4 5
# 2 4 0 6
# 3 5 6 0
all(squareform(y) == x)
# TRUE
}
\keyword{ array }