Package edu.cmu.tetrad.util

Class EssLikePython.Result

java.lang.Object

edu.cmu.tetrad.util.EssLikePython.Result

Enclosing class:

EssLikePython

public static final class EssLikePython.Result
extends Object

Encapsulates the results of an estimation process, including average row correlation, effective sample size (ESS), and the number of rows used in the computation.

avgRowCorr represents the average off-diagonal value of the row-row correlation matrix derived during the estimation process.

ess is the effective sample size, calculated as N / (1 + (N-1)*avgRowCorr), which may optionally be clamped.

mRowsUsed indicates the number of rows sampled and used in the computation.

Field Summary

Fields

Modifier and Type	Field	Description
final double	avgRowCorr	Represents the average off-diagonal value of the row-row correlation matrix computed during an estimation process.
final double	ess	Represents the effective sample size (ESS) calculated as N / (1 + (N-1)*avgRowCorr).
final int	nRowsUsed	Represents the number of rows used in the computation.

Method Summary

Modifier and Type	Method	Description
String	toString()	Returns a string representation of the Result object, which includes the average row correlation (avgRowCorr), effective sample size (ESS), and the number of rows used in the computation (m).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

avgRowCorr

public final double avgRowCorr

Represents the average off-diagonal value of the row-row correlation matrix computed during an estimation process. This value is used to assess the interdependence between rows in the data and influences other derived statistics such as the effective sample size (ESS).

ess

public final double ess

Represents the effective sample size (ESS) calculated as N / (1 + (N-1)*avgRowCorr). This statistic is used to adjust the sample size based on the average row correlation of the dataset. The value may optionally be clamped to a specific range, depending on the application context.

nRowsUsed

public final int nRowsUsed

Represents the number of rows used in the computation.

Method Details

toString

public String toString()

Returns a string representation of the Result object, which includes the average row correlation (avgRowCorr), effective sample size (ESS), and the number of rows used in the computation (m).

Overrides:

toString in class Object

Returns:

a formatted string containing avgRowCorr, ESS, and m values