keel.Algorithms.Associative_Classification.ClassifierFuzzyFARCHD

Class Rule

java.lang.Object

keel.Algorithms.Associative_Classification.ClassifierFuzzyFARCHD.Rule

All Implemented Interfaces:

java.lang.Comparable

public class Rule
extends java.lang.Object
implements java.lang.Comparable

Title: Rule

Description: This class codes a Fuzzy Rule

Copyright: KEEL Copyright (c) 2008

Company: KEEL

Since:

JDK1.6

Version:

1.0

Author:

Written by Jesus Alcala (University of Granada) 09/02/2011

Constructor Summary

Constructors

Constructor and Description
Rule(DataBase dataBase) Create a new rule
Rule(Rule r) Create a rule with another one

Method Summary

Modifier and Type	Method and Description
void	asignaAntecedente(int[] antecedent) It sets the antecedent of the rule
void	calculateWracc(myDataset train, java.util.ArrayList<ExampleWeight> exampleWeight) Calculate Wracc for this rule.
Rule	clone() Clone
int	compareTo(java.lang.Object a) Function to compare objects of the Rule class.
int	getClas() It returns the output class of the rule
double	getConfidence() It returns the Confidence of the rule
double	getSupport() It returns the support of the rule
double	getWracc() It returns the Wracc of the rule
boolean	isSubset(Rule a) Function to check if a given rule is a subrule of this rule
double	matching(double[] example) Function to check if a given example matchs with the rule (the rule correctly classifies it)
int	reduceWeight(myDataset train, java.util.ArrayList<ExampleWeight> exampleWeight) Reduces the weight of the examples that match with the rule (the rule correctly classifies them)
void	setConfidence(double conf) It sets the confidence of the rule
void	setConsequent(int clas) It sets the consequent of the rule
void	setLabel(int pos, int label) It sets the label for a given position in the antecedent (for a given attribute)
void	setSupport(double supp) It sets the support of the rule
void	setWracc(double wracc) It sets the Wracc of the rule

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule(Rule r)

Create a rule with another one

Parameters:

r - This a rule

Rule

public Rule(DataBase dataBase)

Create a new rule

Parameters:

dataBase - The database

Method Detail

clone

public Rule clone()

Clone

Overrides:

clone in class java.lang.Object

Returns:

A copy of the rule

asignaAntecedente

public void asignaAntecedente(int[] antecedent)

It sets the antecedent of the rule

Parameters:

antecedent - Antecedent of the rule

setConsequent

public void setConsequent(int clas)

It sets the consequent of the rule

Parameters:

clas - Class of the rule

matching

public double matching(double[] example)

Function to check if a given example matchs with the rule (the rule correctly classifies it)

Parameters:

example - Example to be classified

Returns:

0.0 = doesn't match, >0.0 = does.

setConfidence

public void setConfidence(double conf)

It sets the confidence of the rule

Parameters:

conf - Confidence to be set

setSupport

public void setSupport(double supp)

It sets the support of the rule

Parameters:

supp - Support to be set

setWracc

public void setWracc(double wracc)

It sets the Wracc of the rule

Parameters:

wracc - Wracc to be set

getConfidence

public double getConfidence()

It returns the Confidence of the rule

Returns:

Confidence of the rule

getSupport

public double getSupport()

It returns the support of the rule

Returns:

Support of the rule

getWracc

public double getWracc()

It returns the Wracc of the rule

Returns:

Wracc of the rule

getClas

public int getClas()

It returns the output class of the rule

Returns:

Output class of the rule

isSubset

public boolean isSubset(Rule a)

Function to check if a given rule is a subrule of this rule

Parameters:

a - Rule to be examinated

Returns:

false = it isn't, true = it is.

calculateWracc

public void calculateWracc(myDataset train,
                           java.util.ArrayList<ExampleWeight> exampleWeight)

Calculate Wracc for this rule. The value of the measure Wracc for this rule will be stored on the attribute "wracc".

Parameters:

train - Training dataset

exampleWeight - Weights of the patterns

reduceWeight

public int reduceWeight(myDataset train,
                        java.util.ArrayList<ExampleWeight> exampleWeight)

Reduces the weight of the examples that match with the rule (the rule correctly classifies them)

Parameters:

train - training examples given to match them to the rule.

exampleWeight - Each example weight to be updated.

Returns:

Number of examples that have become not active after the weight reduction.

setLabel

public void setLabel(int pos,
                     int label)

It sets the label for a given position in the antecedent (for a given attribute)

Parameters:

pos - Location of the attribute which we want to set the label

label - New label value to set

compareTo

public int compareTo(java.lang.Object a)

Function to compare objects of the Rule class. Necessary to be able to use "sort" function It sorts in an decreasing order of wracc

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

a - Rule object to compare with.

Returns:

1 if a is bigger, -1 if smaller and 0 otherwise.