blox (version 0.0.1)

is.ultrametric: Ultrametric Distance Property

Description

This function checks the ultrametric property of a distance matrix obtained by HC-SVD.

Usage

is.ultrametric(hcsvd.obj)

Value

Returns TRUE if the ultrametric property is fulfilled. Otherwise FALSE.

Arguments

hcsvd.obj

An object of type hcsvd(...)

References

Bauer, J.O. (202Xa). Divisive hierarchical clustering using block diagonal matrix approximations. Working paper.

See Also

hcsvd

Examples

# \donttest{
#Load the correlation matrix Bechtoldt from the psych
#package (see ?Bechtoldt for more information).
if (requireNamespace("psych", quietly = TRUE)) {
  data("Bechtoldt", package = "psych")
}

#Compute HC-SVD (with average linkage).
hcsvd.obj <- hcsvd(Bechtoldt)

#Check the ultrametric property
is.ultrametric(hcsvd.obj)
# }