Regla

java.lang.Object
- keel.Algorithms.Genetic_Rule_Learning.Ant_Miner.Regla

```
public class Regla
extends java.lang.Object
```
Title: Regla (Rule)

Description:Rule class. Represents a rule extracted by the ACO algorithm.

Version:

1.0

Author:

Vicente Rubén del Pino Ruiz

Constructor Summary

Constructors
Constructor and Description
`Regla()` Default constructor.
`Regla(Regla regla)` Copy Constructor.
`Regla(java.util.Vector conjuntoAtributos, Atributo claseOriginal)` Parameter Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`asignarCalidad(float original)` Assigns the given quality to the rule.
`void`	`asignarMuestrasCubiertas(float numero)` Sets the number of examples covered by the rule.
`void`	`copia(Regla regla)` Copies the rule given as argument.
`boolean`	`cubreMuestra(Muestra ejemplo)` Checks if the given example is covered by the whole rule (covered by the conditions and with the same class of the rule).
`void`	`eliminaCondicion(Atributo condicion)` Removes the condition passed as parameter.
`boolean`	`esIgual(Regla regla)` Checks if the rule is equal to the given one.
`boolean`	`estaAtributo(Atributo original)` Checks if the given attribute/condition is already in the example.
`boolean`	`estanAtributosEn(Muestra mt)` Checks if in the sample, all the rule conditions/attributes are found.
`void`	`imprime()` Prints on the standard output the rule.
`void`	`imprimeFichero(java.io.PrintStream salida)` Prints on the given file (PrintStream) the rule.
`void`	`insertaAtributos(java.util.Vector atributos)` Adds all the conditions given.
`void`	`insertarAtributo(Atributo original)` Adds a condition (an attribute with its value and an operator).
`void`	`insertarClase(Atributo original)` Adds a class that identifies the rule with all its attributes.
`java.util.Vector`	`listaCondiciones()` Returns the list of conditions of the rule.
`float`	`obtenerCalidad()` Returns the quality of the rule.
`static ComparadorRegla`	`obtenerComparador()` Returns the rules comparative method.
`float`	`obtenerMuestrasCubiertas()` Returns the number of covered samples.
`int`	`obtenerNumCondiciones()` Returns the number of conditions in the rule.
`Atributo`	`obtenerReglaPredicha()` Returns the predicted class for the rule.
`void`	`ordenaAtributos()` Sorts the attributs in increasing order.
`Atributo`	`prediccion(Muestra mt)` Returns the predicted class of the given sample it they have compatible conditions, null otherwise.
`boolean`	`tieneValorAtributo(int atributo)` Checks if the given attribute is already in the rule with a value.

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

- Constructor Detail
  - Regla
```
public Regla()
```
    Default constructor. An empty rule is built.
  - Regla
```
public Regla(Regla regla)
```
    Copy Constructor. Creates a new rule object by copying the one given as argument.
    
    Parameters:
    
    regla - rule to be copied.
  - Regla
```
public Regla(java.util.Vector conjuntoAtributos,
             Atributo claseOriginal)
```
    Parameter Constructor. Creates a new rule with the given attribute values and class passed as parameters.
    
    Parameters:
    
    conjuntoAtributos - Atributes values Vector
    
    claseOriginal - String class to set.
- Method Detail
  - insertarAtributo
```
public void insertarAtributo(Atributo original)
```
    Adds a condition (an attribute with its value and an operator).
    
    Parameters:
    
    original - Condition condition to add.
  - insertarClase
```
public void insertarClase(Atributo original)
```
    Adds a class that identifies the rule with all its attributes.
    
    Parameters:
    
    original - Atributo class added to the rule.
  - ordenaAtributos
```
public void ordenaAtributos()
```
    Sorts the attributs in increasing order.
  - asignarCalidad
```
public void asignarCalidad(float original)
```
    Assigns the given quality to the rule.
    
    Parameters:
    
    original - double Quality to assign.
  - asignarMuestrasCubiertas
```
public void asignarMuestrasCubiertas(float numero)
```
    Sets the number of examples covered by the rule.
    
    Parameters:
    
    numero - int number of covered examples to be set.
  - estaAtributo
```
public boolean estaAtributo(Atributo original)
```
    Checks if the given attribute/condition is already in the example.
    
    Parameters:
    
    original - given attribute to be checked.
    
    Returns:
    
    True if the given attribute/condition is already in the example, false otherwise.
  - tieneValorAtributo
```
public boolean tieneValorAtributo(int atributo)
```
    Checks if the given attribute is already in the rule with a value.
    
    Parameters:
    
    atributo - given attribute to be checked.
    
    Returns:
    
    True if the given attribute is already in the example, false otherwise.
  - prediccion
```
public Atributo prediccion(Muestra mt)
```
    Returns the predicted class of the given sample it they have compatible conditions, null otherwise.
    
    Parameters:
    
    mt - Muestra given sample.
    
    Returns:
    
    the predicted class or null.
  - cubreMuestra
```
public boolean cubreMuestra(Muestra ejemplo)
```
    Checks if the given example is covered by the whole rule (covered by the conditions and with the same class of the rule). If it is correctly covered by the rule.
    
    Parameters:
    
    ejemplo - given example to check.
    
    Returns:
    
    True if it is covered, false otherwise.
  - estanAtributosEn
```
public boolean estanAtributosEn(Muestra mt)
```
    Checks if in the sample, all the rule conditions/attributes are found.
    
    Parameters:
    
    mt - Sample to check.
    
    Returns:
    
    True if in the sample, all the rule conditions are found.
  - obtenerReglaPredicha
```
public Atributo obtenerReglaPredicha()
```
    Returns the predicted class for the rule.
    
    Returns:
    
    the predicted class for the rule.
  - listaCondiciones
```
public java.util.Vector listaCondiciones()
```
    Returns the list of conditions of the rule.
    
    Returns:
    
    Vector the list of conditions of the rule.
  - obtenerCalidad
```
public float obtenerCalidad()
```
    Returns the quality of the rule.
    
    Returns:
    
    the quality of the rule.
  - imprime
```
public void imprime()
```
    Prints on the standard output the rule.
  - imprimeFichero
```
public void imprimeFichero(java.io.PrintStream salida)
```
    Prints on the given file (PrintStream) the rule.
    
    Parameters:
    
    salida - given file (PrintStream).
  - obtenerNumCondiciones
```
public int obtenerNumCondiciones()
```
    Returns the number of conditions in the rule.
    
    Returns:
    
    int the number of conditions in the rule.
  - insertaAtributos
```
public void insertaAtributos(java.util.Vector atributos)
```
    Adds all the conditions given.
    
    Parameters:
    
    atributos - Vector of conditions to add.
  - eliminaCondicion
```
public void eliminaCondicion(Atributo condicion)
```
    Removes the condition passed as parameter.
    
    Parameters:
    
    condicion - condition to be removed.
  - esIgual
```
public boolean esIgual(Regla regla)
```
    Checks if the rule is equal to the given one.
    
    Parameters:
    
    regla - Rule to compare with.
    
    Returns:
    
    True if the rules are equal.
  - obtenerComparador
```
public static ComparadorRegla obtenerComparador()
```
    Returns the rules comparative method.
    
    Returns:
    
    the rules comparative method.
  - copia
```
public void copia(Regla regla)
```
    Copies the rule given as argument.
    
    Parameters:
    
    regla - rule to be copied.
  - obtenerMuestrasCubiertas
```
public float obtenerMuestrasCubiertas()
```
    Returns the number of covered samples.
    
    Returns:
    
    the number of covered samples.

Class Regla

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Regla

Regla

Regla

Method Detail

insertarAtributo

insertarClase

ordenaAtributos

asignarCalidad

asignarMuestrasCubiertas

estaAtributo

tieneValorAtributo

prediccion

cubreMuestra

estanAtributosEn

obtenerReglaPredicha

listaCondiciones

obtenerCalidad

imprime

imprimeFichero

obtenerNumCondiciones

insertaAtributos

eliminaCondicion

esIgual

obtenerComparador

copia

obtenerMuestrasCubiertas