de.tud.ke.mrapp.rulelearning.core.model

Class TrainingInstance

java.lang.Object

de.tud.ke.mrapp.rulelearning.core.model.TrainingInstance

All Implemented Interfaces:

AttributeMap, Instance, Weighted, java.io.Serializable

public class TrainingInstance
extends java.lang.Object
implements Instance

Represents a training instance (also referred to as as a training example).

Since:

0.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TrainingInstance(@NotNull AttributeMap features, @NotNull GroundTruth groundTruth) Creates a new training instance with weight 1.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
@NotNull GroundTruth	getGroundTruth() Returns the ground truth of the instance.
@Nullable java.lang.Double	getValue(int attributeIndex) Returns the value that is associated with the Attribute with a specific index.
double	getWeight() Returns the weight of the object.
int	hashCode()
void	setWeight(double weight) Sets the weight of the object.
int	size() Returns the number of attribute-value mappings that are contained by the map.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.tud.ke.mrapp.rulelearning.core.model.AttributeMap

contains, contains, getValue, isEmpty

Constructor Detail

TrainingInstance

public TrainingInstance(@NotNull
                        @NotNull AttributeMap features,
                        @NotNull
                        @NotNull GroundTruth groundTruth)

Creates a new training instance with weight 1.

Parameters:

features - The features of the training instance

groundTruth - The ground truth of the training instance

Method Detail

size

public int size()

Description copied from interface: AttributeMap

Returns the number of attribute-value mappings that are contained by the map.

Specified by:

size in interface AttributeMap

Returns:

The number of attribute-value mappings that are contained by the map

getValue

@Nullable
public @Nullable java.lang.Double getValue(int attributeIndex)

Description copied from interface: AttributeMap

Returns the value that is associated with the Attribute with a specific index.

Specified by:

getValue in interface AttributeMap

Parameters:

attributeIndex - The index of the attribute for which the associated value should be returned

Returns:

The value that is associated with the given attribute or null, if no such value is available

getGroundTruth

@NotNull
public @NotNull GroundTruth getGroundTruth()

Description copied from interface: Instance

Returns the ground truth of the instance.

Specified by:

getGroundTruth in interface Instance

Returns:

The ground truth of the instance

getWeight

public double getWeight()

Description copied from interface: Weighted

Returns the weight of the object.

Specified by:

getWeight in interface Weighted

Returns:

The weight of the object

setWeight

public void setWeight(double weight)

Description copied from interface: Weighted

Sets the weight of the object.

Specified by:

setWeight in interface Weighted

Parameters:

weight - The weight to be set

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object