Package org.tribuo.reproducibility

Record Class ReproUtil.ModelReproduction<T extends Output<T>>

java.lang.Object

java.lang.Record

org.tribuo.reproducibility.ReproUtil.ModelReproduction<T>

Type Parameters:

T - The output type.

Record Components:

model - The reproduced model.

featureDiff - Any differences between the features.

outputDiff - Any differences between the output domain.

provenanceDiff - The provenance diff.

Enclosing class:

ReproUtil<T extends Output<T>>

public static record ReproUtil.ModelReproduction<T extends Output<T>>(Model<T extends Output<T>> model, ReproUtil.FeatureDiff featureDiff, ReproUtil.OutputDiff<T extends Output<T>> outputDiff, String provenanceDiff)
extends Record

Record for a model reproduction.

Constructor Summary

Constructors

Constructor	Description
ModelReproduction(Model<T> model, ReproUtil.FeatureDiff featureDiff, ReproUtil.OutputDiff<T> outputDiff, String provenanceDiff)	Creates an instance of a ModelReproduction record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ReproUtil.FeatureDiff	featureDiff()	Returns the value of the featureDiff record component.
final int	hashCode()	Returns a hash code value for this object.
Model<T>	model()	Returns the value of the model record component.
ReproUtil.OutputDiff<T>	outputDiff()	Returns the value of the outputDiff record component.
String	provenanceDiff()	Returns the value of the provenanceDiff record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ModelReproduction

public ModelReproduction(Model<T> model,
 ReproUtil.FeatureDiff featureDiff,
 ReproUtil.OutputDiff<T> outputDiff,
 String provenanceDiff)

Creates an instance of a ModelReproduction record class.

Parameters:

model - the value for the model record component

featureDiff - the value for the featureDiff record component

outputDiff - the value for the outputDiff record component

provenanceDiff - the value for the provenanceDiff 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.

model

public Model<T> model()

Returns the value of the model record component.

Returns:

the value of the model record component

featureDiff

public ReproUtil.FeatureDiff featureDiff()

Returns the value of the featureDiff record component.

Returns:

the value of the featureDiff record component

outputDiff

public ReproUtil.OutputDiff<T> outputDiff()

Returns the value of the outputDiff record component.

Returns:

the value of the outputDiff record component

provenanceDiff

public String provenanceDiff()

Returns the value of the provenanceDiff record component.

Returns:

the value of the provenanceDiff record component