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

Class Rule

java.lang.Object

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

All Implemented Interfaces:

Measurable, Proposition<Condition>, java.io.Serializable, java.lang.Iterable<Condition>, java.util.function.Predicate<AttributeMap>

public class Rule
extends java.lang.Object
implements Proposition<Condition>, Measurable, java.io.Serializable

A rule that consists of a Body and a Head. A rule is meant to cover an example (given as an AttributeMap), if its body is satisfied. If a rule covers an example all conditions in its head should be taken into account for making a prediction.

This class implements the method Predicate.test(Object) to check whether a rule covers an example or not.

Since:

0.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Rule() Creates a new conjunctive rule with an empty body and an empty head.
Rule(@NotNull Body body) Creates a new rule with a specific body and an empty head.
Rule(@NotNull Body body, @NotNull Head head) Creates a new rule with a specific body and head.
Rule(@NotNull Head head) Creates a new conjunctive rule with an empty body and a specific head.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
@NotNull Body	getBody() Returns the body of the rule.
@NotNull ConfusionMatrix	getConfusionMatrix() Returns the confusion matrix that specifies how many true positives, false positives, true negatives, and false negatives are predicted by the rule.
@NotNull Head	getHead() Returns the head of the rule.
int	hashCode()
boolean	isConjunctive() Returns, whether the proposition is conjunctive, or not.
java.util.Iterator<Condition>	iterator()
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.rules.Proposition

getAllMatches, getFirstMatch, isDisjunctive, test

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Rule

public Rule()

Creates a new conjunctive rule with an empty body and an empty head.

Rule

public Rule(@NotNull
            @NotNull Body body)

Creates a new rule with a specific body and an empty head.

Parameters:

body - The body of the rule

Rule

public Rule(@NotNull
            @NotNull Head head)

Creates a new conjunctive rule with an empty body and a specific head.

Parameters:

head - The head of the rule

Rule

public Rule(@NotNull
            @NotNull Body body,
            @NotNull
            @NotNull Head head)

Creates a new rule with a specific body and head.

Parameters:

body - The body of the rule

head - The head of the rule

Method Detail

getBody

@NotNull
public final @NotNull Body getBody()

Returns the body of the rule.

Returns:

The body of the rule

getHead

@NotNull
public final @NotNull Head getHead()

Returns the head of the rule.

Returns:

The head of the rule

getConfusionMatrix

@NotNull
public @NotNull ConfusionMatrix getConfusionMatrix()

Returns the confusion matrix that specifies how many true positives, false positives, true negatives, and false negatives are predicted by the rule.

Specified by:

getConfusionMatrix in interface Measurable

Returns:

The confusion matrix of the rule

isConjunctive

public boolean isConjunctive()

Description copied from interface: Proposition

Returns, whether the proposition is conjunctive, or not.

Specified by:

isConjunctive in interface Proposition<Condition>

Returns:

True, if the proposition is conjunctive, false otherwise

iterator

public java.util.Iterator<Condition> iterator()

Specified by:

iterator in interface java.lang.Iterable<Condition>

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