Record Class SimulationStudy.StudyResult

java.lang.Object

java.lang.Record

edu.cmu.tetrad.search.harness.tsc.SimulationStudy.StudyResult

Record Components:

studyName - human-readable name of the study.

conditions - one SimulationStudy.ConditionResult per sample-size level.

Enclosing class:

SimulationStudy

public static record SimulationStudy.StudyResult(String studyName, List<SimulationStudy.ConditionResult> conditions)
extends Record

Aggregated results for one complete study (one rank condition).

Author:

josephramsey

Constructor Summary

Constructors

Constructor	Description
StudyResult(String studyName, List<SimulationStudy.ConditionResult> conditions)	Creates an instance of a StudyResult record class.

Method Summary

Modifier and Type	Method	Description
List<SimulationStudy.ConditionResult>	conditions()	Returns the value of the conditions record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	studyName()	Returns the value of the studyName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StudyResult

public StudyResult(String studyName,
 List<SimulationStudy.ConditionResult> conditions)

Creates an instance of a StudyResult record class.

Parameters:

studyName - the value for the studyName record component

conditions - the value for the conditions 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 Objects::equals(Object,Object).

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.

studyName

public String studyName()

Returns the value of the studyName record component.

Returns:

the value of the studyName record component

conditions

public List<SimulationStudy.ConditionResult> conditions()

Returns the value of the conditions record component.

Returns:

the value of the conditions record component