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

Interface GroundTruth

All Superinterfaces:

AttributeMap, java.io.Serializable

public interface GroundTruth
extends AttributeMap

Defines the interface, all classes that represent the ground truth of an Instance, must implement. The ground truth specifies the (true) class labels an Instance is associated with.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
static @NotNull GroundTruth	forSingleClass(@NotNull Attribute classAttribute, double value) Creates and returns a GroundTruth for a single class.
static @NotNull GroundTruth	forSingleClass(int classIndex, double value) Creates and returns a GroundTruth for a single class.

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

contains, contains, getValue, getValue, isEmpty, size

Method Detail

forSingleClass

@NotNull
static @NotNull GroundTruth forSingleClass(@NotNull
                                                    @NotNull Attribute classAttribute,
                                                    double value)

Creates and returns a GroundTruth for a single class.

Parameters:

classAttribute - The Attribute that corresponds to the class

value - The value to be associated with the class

Returns:

The ground truth that has been created

forSingleClass

@NotNull
static @NotNull GroundTruth forSingleClass(int classIndex,
                                                    double value)

Creates and returns a GroundTruth for a single class.

Parameters:

classIndex - The index of the Attribute that corresponds to the class

value - The value to be associated with the class

Returns:

The ground truth that has been created