Rule

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

All Implemented Interfaces:

java.lang.Comparable
```
public class Rule
extends java.lang.Object
implements java.lang.Comparable
```
Class to store a non-fuzzy rule, together with some necessary information to manage the CBA algorithm.

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`	`addReplace(Replace r)` Function to add a replace entry in the "Replace" list.
`void`	`asignaAntecedente(int[] antecedent)` It sets the rule's antecedent.
`Rule`	`clone()` Clone function.
`int`	`compareTo(java.lang.Object a)` Function to compare objects of the Rule class.
`void`	`decrCovered(int clas)` Function to decrease in 1 the number of examples whose output class is the given class "clas" and are covered by this rule.
`int`	`getClas()` It returns the output class of the rule.
`int`	`getclassCasesCovered(int clas)` It returns the number of examples covered by the rule for the class "class".
`double`	`getConfidence()` It returns the confidence of the rule.
`int`	`getMark()` It returns the mark of the rule.
`int`	`getnReplace()` It returns the size of the Replace list in the rule.
`Replace`	`getReplace(int pos)` It returns the Replace element of the rule in the position "pos".
`double`	`getSupport()` It returns the Support of the rule.
`long`	`getTime()` It returns the time of the rule.
`void`	`incrCovered(int clas)` Function to increase in 1 the number of examples whose output class is the given class "clas" and are covered by this rule.
`boolean`	`isEqual(Rule rule)` Function to check if a rule is equal to another given.
`boolean`	`isMark()` It returns if the rule is marked.
`boolean`	`isPrecedence(Rule r)` Function to know whether our rule has more precedence than another given or not.
`boolean`	`isSubset(Rule a)` Function to check whether our rule is subset of a given rule "a".
`double`	`matching(int[] example)` Function to check if a given example matchs with the rule (the rule correctly classifies it).
`void`	`offMark()` Function to unmark the rule.
`void`	`onMark()` Function to mark the rule.
`void`	`setConfidence(double conf)` It sets the rule's confidence.
`void`	`setConsequent(int clas)` It returns the rule's consequent.
`void`	`setLabel(int pos, int label)` It sets the label for a given position in the antecedent (for a given attribute).
`void`	`setMark(int mark)` It sets the rule's mark.
`void`	`setSupport(double supp)` It sets the rule's support.
`void`	`setTime(long time)` It sets the time the rule was added to the rule set.

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 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:
    
    A copy of the Rule object.
  - asignaAntecedente
```
public void asignaAntecedente(int[] antecedent)
```
    It sets the rule's antecedent.
    
    Parameters:
    
    antecedent - Array of values. Each position in the array represents an attribute.
  - setConsequent
```
public void setConsequent(int clas)
```
    It returns the rule's consequent.
    
    Parameters:
    
    clas - Consequent of the rule
  - matching
```
public double matching(int[] example)
```
    Function to check if a given example matchs with the rule (the rule correctly classifies it).
    
    Parameters:
    
    example - Example to be classified
    
    Returns:
    
    double 0.0 = doesn't match, >0.0 = does.
  - addReplace
```
public void addReplace(Replace r)
```
    Function to add a replace entry in the "Replace" list.
    
    Parameters:
    
    r - Element to be inserted
  - isEqual
```
public boolean isEqual(Rule rule)
```
    Function to check if a rule is equal to another given.
    
    Parameters:
    
    rule - Rule to compare with ours
    
    Returns:
    
    boolean true = they are equal, false = they aren't.
  - setConfidence
```
public void setConfidence(double conf)
```
    It sets the rule's confidence.
    
    Parameters:
    
    conf - double Confidence to be set
  - setSupport
```
public void setSupport(double supp)
```
    It sets the rule's support.
    
    Parameters:
    
    supp - Support to be set
  - setMark
```
public void setMark(int mark)
```
    It sets the rule's mark.
    
    Parameters:
    
    mark - Whether the rule is marked (1) or not (0)
  - getConfidence
```
public double getConfidence()
```
    It returns the confidence of the rule.
    
    Returns:
    
    double Confidence of the rule
  - getSupport
```
public double getSupport()
```
    It returns the Support of the rule.
    
    Returns:
    
    double Support of the rule
  - getClas
```
public int getClas()
```
    It returns the output class of the rule.
    
    Returns:
    
    int Output class of the rule
  - getTime
```
public long getTime()
```
    It returns the time of the rule.
    
    Returns:
    
    long Time the rule has been added to the rule set
  - setTime
```
public void setTime(long time)
```
    It sets the time the rule was added to the rule set.
    
    Parameters:
    
    time - long Time to be set
  - getMark
```
public int getMark()
```
    It returns the mark of the rule.
    
    Returns:
    
    int 1 = rule is marked, 0 = rule isn't.
  - onMark
```
public void onMark()
```
    Function to mark the rule.
  - offMark
```
public void offMark()
```
    Function to unmark the rule.
  - getnReplace
```
public int getnReplace()
```
    It returns the size of the Replace list in the rule.
    
    Returns:
    
    int Size of the Replace list in the rule
  - getReplace
```
public Replace getReplace(int pos)
```
    It returns the Replace element of the rule in the position "pos".
    
    Parameters:
    
    pos - Position of the "replace element" we are looking for
    
    Returns:
    
    Replace Replace element of the rule in the position "pos"
  - isMark
```
public boolean isMark()
```
    It returns if the rule is marked.
    
    Returns:
    
    boolean true = Rule is marked, false = rule is not.
  - isPrecedence
```
public boolean isPrecedence(Rule r)
```
    Function to know whether our rule has more precedence than another given or not.
    
    Parameters:
    
    r - Given rule to compare
    
    Returns:
    
    boolean true = our rule has more precedence, false = it hasn't.
  - incrCovered
```
public void incrCovered(int clas)
```
    Function to increase in 1 the number of examples whose output class is the given class "clas" and are covered by this rule.
    
    Parameters:
    
    clas - Output class of the covered example
  - decrCovered
```
public void decrCovered(int clas)
```
    Function to decrease in 1 the number of examples whose output class is the given class "clas" and are covered by this rule.
    
    Parameters:
    
    clas - Output class of the covered example
  - getclassCasesCovered
```
public int getclassCasesCovered(int clas)
```
    It returns the number of examples covered by the rule for the class "class".
    
    Parameters:
    
    clas - Class to know how many examples with this class are covered by our rule
    
    Returns:
    
    int Number of examples covered by our rule for the given class
  - isSubset
```
public boolean isSubset(Rule a)
```
    Function to check whether our rule is subset of a given rule "a".
    
    Parameters:
    
    a - Given rule to compare
    
    Returns:
    
    boolean true = our rule is subset of a, false = it isn't.
  - 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

addReplace

isEqual

setConfidence

setSupport

setMark

getConfidence

getSupport

getClas

getTime

setTime

getMark

onMark

offMark

getnReplace

getReplace

isMark

isPrecedence

incrCovered

decrCovered

getclassCasesCovered

isSubset

setLabel

compareTo