File: matrix.trace.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 (29 lines) | stat: -rw-r--r-- 813 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
\name{matrix.trace}
\alias{matrix.trace}
\title{ The trace of a matrix }
\description{
  This function returns the trace of a given square numeric matrix.
}
\usage{
matrix.trace(x)
}
\arguments{
  \item{x}{ a matrix }
}
\value{
  A numeric value which is the sum of the values on the diagonal.
}
\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 x is not numeric, the function presents and error message and terminates.
  If the argument x is not a square matrix, the function presents an error message and terminates.
}
\examples{
A <- matrix( seq( 1, 16, 1 ), nrow=4, byrow=TRUE )
matrix.trace( A )
}
\keyword{ math }