Record Class RubinsRules.Pooled

java.lang.Object

java.lang.Record

edu.cmu.tetrad.data.missing.RubinsRules.Pooled

Record Components:

estimate - the mean of the estimates

standardError - the square root of the total variance

degreesOfFreedom - the degrees of freedom for the t reference distribution

t - the estimate over its standard error

pValue - the two-sided p-value for the estimate being zero

fractionMissingInformation - the share of the information about the parameter lost to missing data

withinVariance - the average squared standard error

betweenVariance - the variance of the estimates across data sets

min - the smallest estimate

max - the largest estimate

Enclosing class:

RubinsRules

public static record RubinsRules.Pooled(double estimate, double standardError, double degreesOfFreedom, double t, double pValue, double fractionMissingInformation, double withinVariance, double betweenVariance, double min, double max)
extends Record

A pooled parameter.

Author:

josephramsey

Constructor Summary

Constructors

Constructor	Description
Pooled(double estimate, double standardError, double degreesOfFreedom, double t, double pValue, double fractionMissingInformation, double withinVariance, double betweenVariance, double min, double max)	Creates an instance of a Pooled record class.

Method Summary

Modifier and Type	Method	Description
double	betweenVariance()	Returns the value of the betweenVariance record component.
double	degreesOfFreedom()	Returns the value of the degreesOfFreedom record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
double	estimate()	Returns the value of the estimate record component.
double	fractionMissingInformation()	Returns the value of the fractionMissingInformation record component.
final int	hashCode()	Returns a hash code value for this object.
double	max()	Returns the value of the max record component.
double	min()	Returns the value of the min record component.
double	pValue()	Returns the value of the pValue record component.
double	standardError()	Returns the value of the standardError record component.
double	t()	Returns the value of the t record component.
final String	toString()	Returns a string representation of this record class.
double	withinVariance()	Returns the value of the withinVariance record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Pooled

public Pooled(double estimate,
 double standardError,
 double degreesOfFreedom,
 double t,
 double pValue,
 double fractionMissingInformation,
 double withinVariance,
 double betweenVariance,
 double min,
 double max)

Creates an instance of a Pooled record class.

Parameters:

estimate - the value for the estimate record component

standardError - the value for the standardError record component

degreesOfFreedom - the value for the degreesOfFreedom record component

t - the value for the t record component

pValue - the value for the pValue record component

fractionMissingInformation - the value for the fractionMissingInformation record component

withinVariance - the value for the withinVariance record component

betweenVariance - the value for the betweenVariance record component

min - the value for the min record component

max - the value for the max record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

estimate

public double estimate()

Returns the value of the estimate record component.

Returns:

the value of the estimate record component

standardError

public double standardError()

Returns the value of the standardError record component.

Returns:

the value of the standardError record component

degreesOfFreedom

public double degreesOfFreedom()

Returns the value of the degreesOfFreedom record component.

Returns:

the value of the degreesOfFreedom record component

t

public double t()

Returns the value of the t record component.

Returns:

the value of the t record component

pValue

public double pValue()

Returns the value of the pValue record component.

Returns:

the value of the pValue record component

fractionMissingInformation

public double fractionMissingInformation()

Returns the value of the fractionMissingInformation record component.

Returns:

the value of the fractionMissingInformation record component

withinVariance

public double withinVariance()

Returns the value of the withinVariance record component.

Returns:

the value of the withinVariance record component

betweenVariance

public double betweenVariance()

Returns the value of the betweenVariance record component.

Returns:

the value of the betweenVariance record component

min

public double min()

Returns the value of the min record component.

Returns:

the value of the min record component

max

public double max()

Returns the value of the max record component.

Returns:

the value of the max record component