R isSymmetric-methods “Matrix”包中函数“isSymmetric”的方法

说明

isSymmetric 测试其参数是否是对称方阵，默认情况下可以容忍一些数值模糊，并且除了数学意义上的对称性之外还需要对称 [dD]imnames。 isSymmetric 是 base 中的通用函数，它具有用于隐式 class "matrix" 传统矩阵的 method 。此处为 Matrix 中的各种固有类和虚拟类定义了方法，以便 isSymmetric 适用于从虚拟类 "Matrix" 继承的所有对象。

用法

## S4 method for signature 'symmetricMatrix'
isSymmetric(object, ...)
## S4 method for signature 'triangularMatrix'
isSymmetric(object, checkDN = TRUE, ...)
## S4 method for signature 'diagonalMatrix'
isSymmetric(object, checkDN = TRUE, ...)
## S4 method for signature 'indMatrix'
isSymmetric(object, checkDN = TRUE, ...)
## S4 method for signature 'dgeMatrix'
isSymmetric(object, tol = 100 * .Machine$double.eps, tol1 = 8 * tol, checkDN = TRUE, ...)
## S4 method for signature 'lgeMatrix'
isSymmetric(object, checkDN = TRUE, ...)
## S4 method for signature 'ngeMatrix'
isSymmetric(object, checkDN = TRUE, ...)
## S4 method for signature 'dgCMatrix'
isSymmetric(object, tol = 100 * .Machine$double.eps, checkDN = TRUE, ...)
## S4 method for signature 'lgCMatrix'
isSymmetric(object, checkDN = TRUE, ...)
## S4 method for signature 'ngCMatrix'
isSymmetric(object, checkDN = TRUE, ...)

参数

object	"Matrix" 。
tol , tol1	允许数字(而不是逻辑)矩阵近似对称的数值公差。另请参阅isSymmetric.matrix。
checkDN	logical 指示是否应检查 object 的 Dimnames slot 的对称性。
...	更多参数传递给方法(通常是 all.equal 的方法)。

细节

object 的 Dimnames slot ，例如 dn ，被认为是对称的当且仅当

• dn[[1]] 和 dn[[2]] 相同或者其中之一是 NULL ；和

• ndn <- names(dn) 是 NULL 或 ndn[1] 和 ndn[2] 相同或其中之一是空字符串 "" 。

因此 list(a=nms, a=nms) 被认为是对称的，list(a=nms, NULL) 和 list(NULL, a=nms) 也是对称的。

请注意，此定义比 isSymmetric.matrix 所采用的定义更宽松，后者要求 dn[1] 和 dn[2] 相同，其中 dn 是传统矩阵的 dimnames attribute。

值

logical ， TRUE 或 FALSE (绝不是 NA )。

例子

isSymmetric(Diagonal(4)) # TRUE of course
M <- Matrix(c(1,2,2,1), 2,2)
isSymmetric(M) # TRUE (*and* of formal class "dsyMatrix")
isSymmetric(as(M, "generalMatrix")) # still symmetric, even if not "formally"
isSymmetric(triu(M)) # FALSE

## Look at implementations:
showMethods("isSymmetric", includeDefs = TRUE) # includes S3 generic from base

也可以看看

forceSymmetric; symmpart 和skewpart ；虚拟类"symmetricMatrix" 及其子类。