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

Class RuleSet

java.lang.Object

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

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

All Implemented Interfaces:

Proposition<Rule>, java.io.Serializable, java.lang.Iterable<Rule>, java.util.Collection<Rule>, java.util.function.Predicate<AttributeMap>, java.util.Set<Rule>

public class RuleSet
extends RuleCollection
implements java.util.Set<Rule>

A rule set that consists of several (unordered) Rules.

Since:

0.1.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleSet(@NotNull Head defaultPrediction) Creates an empty rule set.
RuleSet(@NotNull Head defaultPrediction, @NotNull java.lang.Iterable<? extends Rule> rules) Creates a new rule set that contains several rules.
RuleSet(@NotNull Head defaultPrediction, Rule... rules) Creates a rule set that contains several rules.

Method Summary

Modifier and Type	Method and Description
boolean	add(Rule rule)
boolean	addAll(@NotNull java.util.Collection<? extends Rule> c)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(@NotNull java.util.Collection<?> c)
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isConjunctive() Returns, whether the proposition is conjunctive, or not.
boolean	isEmpty()
@NotNull java.util.Iterator<Rule>	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(@NotNull java.util.Collection<?> c)
boolean	retainAll(@NotNull java.util.Collection<?> c)
int	size()
@NotNull java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toString()

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

getDefaultPrediction

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

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

Constructor Detail

RuleSet

public RuleSet(@NotNull
               @NotNull Head defaultPrediction)

Creates an empty rule set.

Parameters:

defaultPrediction - The default prediction that should be made if no rule covers an example

RuleSet

public RuleSet(@NotNull
               @NotNull Head defaultPrediction,
               @NotNull
               Rule... rules)

Creates a rule set that contains several rules.

Parameters:

defaultPrediction - The default prediction that should be made if no rule covers an example

rules - An array that contains the rules that should be contained by the rule set

RuleSet

public RuleSet(@NotNull
               @NotNull Head defaultPrediction,
               @NotNull
               @NotNull java.lang.Iterable<? extends Rule> rules)

Creates a new rule set that contains several rules.

Parameters:

defaultPrediction - The default prediction that should be made if no rule covers an example

rules - An Iterable that allows to iterate the rules that should be contained by the rule set

Method Detail

size

public int size()

Specified by:

size in interface java.util.Collection<Rule>

Specified by:

size in interface java.util.Set<Rule>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<Rule>

Specified by:

isEmpty in interface java.util.Set<Rule>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<Rule>

Specified by:

contains in interface java.util.Set<Rule>

iterator

@NotNull
public @NotNull java.util.Iterator<Rule> iterator()

Specified by:

iterator in interface java.lang.Iterable<Rule>

Specified by:

iterator in interface java.util.Collection<Rule>

Specified by:

iterator in interface java.util.Set<Rule>

toArray

@NotNull
public @NotNull java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<Rule>

Specified by:

toArray in interface java.util.Set<Rule>

toArray

@NotNull
public <T> T[] toArray(@NotNull
                                T[] a)

Specified by:

toArray in interface java.util.Collection<Rule>

Specified by:

toArray in interface java.util.Set<Rule>

add

public boolean add(Rule rule)

Specified by:

add in interface java.util.Collection<Rule>

Specified by:

add in interface java.util.Set<Rule>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<Rule>

Specified by:

remove in interface java.util.Set<Rule>

containsAll

public boolean containsAll(@NotNull
                           @NotNull java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<Rule>

Specified by:

containsAll in interface java.util.Set<Rule>

addAll

public boolean addAll(@NotNull
                      @NotNull java.util.Collection<? extends Rule> c)

Specified by:

addAll in interface java.util.Collection<Rule>

Specified by:

addAll in interface java.util.Set<Rule>

retainAll

public boolean retainAll(@NotNull
                         @NotNull java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<Rule>

Specified by:

retainAll in interface java.util.Set<Rule>

removeAll

public boolean removeAll(@NotNull
                         @NotNull java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<Rule>

Specified by:

removeAll in interface java.util.Set<Rule>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<Rule>

Specified by:

clear in interface java.util.Set<Rule>

isConjunctive

public boolean isConjunctive()

Description copied from interface: Proposition

Returns, whether the proposition is conjunctive, or not.

Specified by:

isConjunctive in interface Proposition<Rule>

Returns:

True, if the proposition is conjunctive, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<Rule>

Specified by:

hashCode in interface java.util.Set<Rule>

Overrides:

hashCode in class RuleCollection

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Collection<Rule>

Specified by:

equals in interface java.util.Set<Rule>

Overrides:

equals in class RuleCollection