Rule

java.lang.Object
- keel.Algorithms.Associative_Classification.ClassifierFuzzyCFAR.Rule

All Implemented Interfaces:

java.lang.Comparable
```
public class Rule
extends java.lang.Object
implements java.lang.Comparable
```
Codifies a Fuzzy Rule

Since:

JDK1.5

Version:

1.0

Author:

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

Constructor Summary

Constructors
Constructor and Description

Rule(DataBase dataBase)
Parameters Constructor

Rule(Rule r)
Copy Constructor

Constructors
Constructor and Description
`Rule(DataBase dataBase)` Parameters Constructor
`Rule(Rule r)` Copy Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`asignaAntecedente(int[] antecedente)` It sets the antecedent of the rule
`Rule`	`clone()` Clone Function
`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`	`getDF()` It returns the DF of the rule
`int`	`getRightN()` It returns the number of right of the rule
`double`	`getSupport()` It returns the support of the rule
`long`	`getTime()` It returns the time of the rule
`int`	`getWrongN()` It returns the number of wrong of the rule
`void`	`incrRightN()` It increases the number of right
`void`	`incrWrongN()` It increases the number of wrong
`boolean`	`isSubset(Rule a)` Function to check if a given rule is a subrule of this rule
`double`	`matching(double[] ejemplo)` Function to check if a given example matchs with the rule (the rule correctly classifies it)
`void`	`orderDF()` It selects to order by DF
`void`	`orderPrecede()` It selects to order by precede
`void`	`setConfidence(double Dconf)` It sets the confidence of the rule
`void`	`setConsequent(int clas)` It sets the consequent of the rule
`void`	`setIni()` It sets to 0 the number of right and wrong 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 Dsupp)` It sets the support of the rule
`void`	`setTime(long time)` It sets the time 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)
```
    Copy Constructor
    
    Parameters:
    
    r - Rule Rule to be copied
  - Rule
```
public Rule(DataBase dataBase)
```
    Parameters Constructor
    
    Parameters:
    
    dataBase - Set of training data which is necessary to generate a rule
- Method Detail
  - clone
```
public Rule clone()
```
    Clone Function
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    Copy of the Rule object.
  - asignaAntecedente
```
public void asignaAntecedente(int[] antecedente)
```
    It sets the antecedent of the rule
    
    Parameters:
    
    antecedente - 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[] ejemplo)
```
    Function to check if a given example matchs with the rule (the rule correctly classifies it)
    
    Parameters:
    
    ejemplo - Example to be classified
    
    Returns:
    
    0.0 = doesn't match, >0.0 = does.
  - setConfidence
```
public void setConfidence(double Dconf)
```
    It sets the confidence of the rule
    
    Parameters:
    
    Dconf - Confidence to be set
  - setSupport
```
public void setSupport(double Dsupp)
```
    It sets the support of the rule
    
    Parameters:
    
    Dsupp - Support to be set
  - setTime
```
public void setTime(long time)
```
    It sets the time of the rule
    
    Parameters:
    
    time - Time to be set
  - setIni
```
public void setIni()
```
    It sets to 0 the number of right and wrong of the rule
  - incrRightN
```
public void incrRightN()
```
    It increases the number of right
  - incrWrongN
```
public void incrWrongN()
```
    It increases the number of wrong
  - orderPrecede
```
public void orderPrecede()
```
    It selects to order by precede
  - orderDF
```
public void orderDF()
```
    It selects to order by DF
  - 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
  - getTime
```
public long getTime()
```
    It returns the time of the rule
    
    Returns:
    
    Time of the rule
  - getRightN
```
public int getRightN()
```
    It returns the number of right of the rule
    
    Returns:
    
    Rights of the rule
  - getWrongN
```
public int getWrongN()
```
    It returns the number of wrong of the rule
    
    Returns:
    
    Wrongs of the rule
  - getDF
```
public double getDF()
```
    It returns the DF of the rule
    
    Returns:
    
    DF 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.
  - 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 confidence If equals, in an decreasing order of support If equals, in an decreasing order of time
    
    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.

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Rule

Method Detail

clone

asignaAntecedente

setConsequent

matching

setConfidence

setSupport

setTime

setIni

incrRightN

incrWrongN

orderPrecede

orderDF

getConfidence

getSupport

getTime

getRightN

getWrongN

getDF

getClas

isSubset

setLabel

compareTo