checkSymmetricPDMatrix: Checks if a matrix is symmetric and positive definite

Description Usage Arguments Value Author(s) Examples

View source: R/checkSymmetricPDMatrix.R

Description

Checks if a matrix is symmetric and positive definite using an eigen value decomposition.

Usage

1
 checkSymmetricPDMatrix(mat, tol = 1e-06)

Arguments

mat

(Required) The matrix to check

tol

(Optional) The tolorence to use when comparing the value to 0. The default is "1e-06"

Value

The function does not return anything. It only generate an error if something goes wrong.

Author(s)

Mike K Smith mstoolkit@googlemail.com

Examples

1
2
3
4
5
6
7
## Not run: 
  checkSymmetricPDMatrix( diag(4), 4)
  \dontrun{
    checkSymmetricPDMatrix( -diag(4),4 )
  }

## End(Not run)

MSToolkit documentation built on May 2, 2019, 6:30 p.m.