Rule

java.lang.Object
- keel.Algorithms.ImbalancedClassification.Ensembles.Rule

```
public class Rule
extends java.lang.Object
```
Title: Rule

Description: Rule representation
Company: KEEL

Since:

JDK1.6

Version:

1.1

Author:

Alberto Fernandez (University of Jaen) 09/10/2012

Constructor Summary

Constructors
Constructor and Description
`Rule()` Default constructor
`Rule(myDataset train, java.lang.String linea)` Constructor with parameters.
`Rule(java.lang.String clase, myDataset train)` Constructor with parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contieneAtributo(int att)` Checks if an attribute given as a argument is considered in the rule.
`Rule`	`copy()` Creates a copy of a rule
`int`	`covered()` Returns the instances covered by the rule.
`void`	`coverExamples()` It counts how many examples are covered and also how many of them are positive
`void`	`coverExamples(double[] weights)` It checks the weights of the covered examples
`boolean`	`covers(double[] example)` To compute whether the rule covers an example
`void`	`incluyeSelector(Selector s)` Includes a selector given as an argument into the list of antecedents.
`int`	`positiveCovered()` Returns the instances covered by the rule and are correctly classified.
`java.lang.String`	`printString()` Returns the rule as a String
`java.lang.String`	`printStringF()` Returns the rule as a String (float representation of covers instances).
`int`	`size()` Returns the number of selectors in the rule.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Rule
```
public Rule()
```
    Default constructor
  - Rule
```
public Rule(java.lang.String clase,
            myDataset train)
```
    Constructor with parameters. It initializes a rule for a given class
    
    Parameters:
    
    clase - class value
    
    train - training set
  - Rule
```
public Rule(myDataset train,
            java.lang.String linea)
```
    Constructor with parameters. It initializes a rule from a C4.5 file of rules (just a single line)
    
    Parameters:
    
    train - training set
    
    linea - Line of the file which stores the C4.5 rule set
- Method Detail
  - incluyeSelector
```
public void incluyeSelector(Selector s)
```
    Includes a selector given as an argument into the list of antecedents.
    
    Parameters:
    
    s - Selector given.
  - printString
```
public java.lang.String printString()
```
    Returns the rule as a String
    
    Returns:
    
    String representation of the rule.
  - printStringF
```
public java.lang.String printStringF()
```
    Returns the rule as a String (float representation of covers instances).
    
    Returns:
    
    String representation of the rule.
  - copy
```
public Rule copy()
```
    Creates a copy of a rule
    
    Returns:
    
    a new copy of the rule
  - covered
```
public int covered()
```
    Returns the instances covered by the rule.
    
    Returns:
    
    instances covered by the rule.
  - positiveCovered
```
public int positiveCovered()
```
    Returns the instances covered by the rule and are correctly classified.
    
    Returns:
    
    instances covered by the rule.
  - coverExamples
```
public void coverExamples()
```
    It counts how many examples are covered and also how many of them are positive
  - coverExamples
```
public void coverExamples(double[] weights)
```
    It checks the weights of the covered examples
    
    Parameters:
    
    weights - the weights of all examples
  - covers
```
public boolean covers(double[] example)
```
    To compute whether the rule covers an example
    
    Parameters:
    
    example -
    
    Returns:
    
    True if the rule covers the example. False otherwise.
  - size
```
public int size()
```
    Returns the number of selectors in the rule.
    
    Returns:
    
    Number of selectors in the rule.
  - contieneAtributo
```
public boolean contieneAtributo(int att)
```
    Checks if an attribute given as a argument is considered in the rule.
    
    Parameters:
    
    att - attribute given to check.
    
    Returns:
    
    True if it is considered, False otherwise.

Class Rule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Rule

Rule

Method Detail

incluyeSelector

printString

printStringF

copy

covered

positiveCovered

coverExamples

coverExamples

covers

size

contieneAtributo