File: is.symmetric.matrix.Rd

package info (click to toggle)
r-cran-matrixcalc 1.0.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 552 kB
  • sloc: makefile: 2
file content (34 lines) | stat: -rw-r--r-- 958 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
\name{is.symmetric.matrix}
\alias{is.symmetric.matrix}
\title{ Test for symmetric numeric matrix }
\description{
  This function returns TRUE if the argument is a numeric symmetric square matrix and FALSE otherwise.
}
\usage{
is.symmetric.matrix(x)
}
\arguments{
  \item{x}{ an R object }
}
\value{
  TRUE or FALSE.
}
\author{ Frederick Novomestky \email{fnovomes@poly.edu} }
\references{
  Bellman, R. (1987). \emph{Matrix Analysis}, Second edition, Classics in Applied Mathematics,
  Society for Industrial and Applied Mathematics.
}
\note{ 
  If the argument is not a numeric matrix, the function displays an error message and stops.
  If the argument is not a square matrix, the function displays an error message and stops.
}
\seealso{
  \code{\link{is.square.matrix}}
}
\examples{
A <- matrix( c( 1, 2, 3, 4 ), nrow=2, byrow=TRUE )
is.symmetric.matrix( A )
B <- matrix( c( 1, 2, 2, 1 ), nrow=2, byrow=TRUE )
is.symmetric.matrix( B )
}
\keyword{ math }