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" 及其子類。