CheckConsistency Method (RDKCorrelation Object)

Description

Determines whether a correlation matrix is self-consistent and optionally corrects the matrix if it is not.

Syntax

object.CheckConsistency(Optional correctIfNotValid as Boolean = False)

Arguments

correctIfNotValid (Optional Boolean) – if the matrix is not valid, setting this argument to TRUE tells the RDKX to automatically correct the matrix with the "closest" correct matrix. If FALSE (the default value) the matrix is not changed, if it is not valid.

Return Value

(Boolean) – TRUE if the matrix is valid, FALSE if not.

Example

If RDKApp.Correlations("myMatrix").CheckConsistency() then
    MsgBox "Matrix is valid."
Else
    MsgBox "Matrix is NOT valid."
End If