keel.Algorithms.Rule_Learning.Slipper

Class Ruleset

java.lang.Object

keel.Algorithms.Rule_Learning.Slipper.Ruleset

public class Ruleset
extends java.lang.Object

Representation of a disjuction of rules with a common consecuent. It may be represented as: if (rule1 || rule2) then output=consecuent Besides each rule has a positive value (confidence) associated. The entire ruleset has also a default rule whose confidence value must be always negative.

Since:

JDK1.2

Version:

1.1

Author:

Written by Alberto Fernández (University of Granada) 01/07/2008, Modified by Xavi Solé (La Salle, Ramón Llull University - Barcelona) 03/12/2008

Constructor Summary

Constructors

Constructor and Description
Ruleset() Constructs an empty ruleset.

Method Summary

Modifier and Type	Method and Description
void	addRule(Rule r) Adds a new rule to the ruleset.
void	addToDefaultCr(double Cr) Adds a given value to the confidence of the default rule.
boolean	contains(Rule r) It returns wether a rule belongs to the ruleset
double	getDefaultCr() Returns the confidence of the default rule.
double	getDefaultCr(MyDataset data, Mask positives, Mask negatives, double[] distribution) Computes the confidence of the default rule, according to the equation 4 of [AAAI99]: Cr=1/2ln((W+ + 1/(2n))/(W_ + 1/(2n))) W+: sum of the weights of the positive instances that are covered by the current rule W_: sum of the weights of the negative instances that are covered by the current rule n: |p|+|n|
Rule	getRule(int pos) Returns the rule in the i-th position of the ruleset.
java.lang.String	getType() Returns the common output (consecuent) of the rules in the ruleset.
int	indexOf(Rule r) It returns the position of a rule (if it is belongs to the ruleset)
void	insertRule(Rule r, int pos) Inserts a new rule in a given position of the ruleset.
void	removeRule(int pos) Deletes a given rule of the ruleset.
void	setType(java.lang.String type) Sets the common output (consecuent) of the rules in the ruleset.
int	size() Returns the size (number of rules) of the ruleset.
java.lang.String	toString() Returns a string representation of this Ruleset, containing the String representation of each Rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Ruleset

public Ruleset()

Constructs an empty ruleset.

Method Detail

contains

public boolean contains(Rule r)

It returns wether a rule belongs to the ruleset

Parameters:

r - Rule the simple rule

Returns:

true if the rule is part of the ruleset

indexOf

public int indexOf(Rule r)

It returns the position of a rule (if it is belongs to the ruleset)

Parameters:

r - Rule the simple rule

Returns:

true if the rule is part of the ruleset

addRule

public void addRule(Rule r)

Adds a new rule to the ruleset. If the rule is already in it, just adds its confidence.

Parameters:

r - Rule the new rule

addToDefaultCr

public void addToDefaultCr(double Cr)

Adds a given value to the confidence of the default rule.

Parameters:

Cr - the value

getDefaultCr

public double getDefaultCr(MyDataset data,
                           Mask positives,
                           Mask negatives,
                           double[] distribution)

Computes the confidence of the default rule, according to the equation 4 of [AAAI99]: Cr=1/2ln((W+ + 1/(2n))/(W_ + 1/(2n))) W+: sum of the weights of the positive instances that are covered by the current rule W_: sum of the weights of the negative instances that are covered by the current rule n: |p|+|n|

Parameters:

data - MyDataset the dataset

positives - Mask the positive entries

negatives - Mask the negative entries

distribution - double[] the distribution D

Returns:

the confidence of the default rule

getDefaultCr

public double getDefaultCr()

Returns the confidence of the default rule.

Returns:

the confidence of the default rule.

getRule

public Rule getRule(int pos)

Returns the rule in the i-th position of the ruleset.

Parameters:

pos - int position of the rule in the ruleset

Returns:

the rule in the pos-th position of the ruleset.

getType

public java.lang.String getType()

Returns the common output (consecuent) of the rules in the ruleset.

Returns:

the common output (consecuent) of the rules in the ruleset.

insertRule

public void insertRule(Rule r,
                       int pos)

Inserts a new rule in a given position of the ruleset.

Parameters:

r - Rule the new rule

pos - int the position where r must be inserted

removeRule

public void removeRule(int pos)

Deletes a given rule of the ruleset.

Parameters:

pos - int position of the rule in the ruleset.

setType

public void setType(java.lang.String type)

Sets the common output (consecuent) of the rules in the ruleset.

Parameters:

type - String the common output (consecuent) of the rules in the ruleset.

size

public int size()

Returns the size (number of rules) of the ruleset.

Returns:

the size (number of rules) of the ruleset.

toString

public java.lang.String toString()

Returns a string representation of this Ruleset, containing the String representation of each Rule.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this Ruleset, containing the String representation of each Rule.