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

Class Head

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Condition>, java.util.Collection<Condition>, java.util.Set<Condition>

public class Head
extends ConditionSet

The head (consequence) of a Rule. It may consist of several conditions that should be taken into account for making a prediction if the rule's body covers an example.

This class provides a ConfusionMatrix for each Condition that is contained by a head (accessible via or {@link #getConfusionMatrix(int)}). The confusion matrices can be used to store the true positives, false positives, true negatives, and false negatives that are predicted by the head.

Since:

0.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Head() Creates an empty head.
Head(Condition... conditions) Creates a new head that consists of several conditions.
Head(@NotNull java.lang.Iterable<? extends Condition> conditions) Creates a new head that consists of several conditions.

Method Summary

Modifier and Type	Method and Description
@NotNull ConfusionMatrix	getConfusionMatrix(@NotNull Attribute attribute)
@NotNull ConfusionMatrix	getConfusionMatrix(int attributeIndex)
boolean	remove(java.lang.Object o)
java.lang.String	toString()

Methods inherited from class de.tud.ke.mrapp.rulelearning.core.model.rules.ConditionSet

add, addAll, clear, contains, containsAll, equals, get, get, hashCode, isEmpty, iterator, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Set

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

Head

public Head()

Creates an empty head.

Head

public Head(@NotNull
            Condition... conditions)

Creates a new head that consists of several conditions.

Parameters:

conditions - An array that contains the conditions, the head should consist of

Head

public Head(@NotNull
            @NotNull java.lang.Iterable<? extends Condition> conditions)

Creates a new head that consists of several conditions.

Parameters:

conditions - An Iterable that allows to iterate the conditions, the head should consist of

Method Detail

getConfusionMatrix

@NotNull
public @NotNull ConfusionMatrix getConfusionMatrix(@NotNull
                                                            @NotNull Attribute attribute)

getConfusionMatrix

@NotNull
public @NotNull ConfusionMatrix getConfusionMatrix(int attributeIndex)

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<Condition>

Specified by:

remove in interface java.util.Set<Condition>

Overrides:

remove in class ConditionSet

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object