keel.Algorithms.Rule_Learning.SRI

Class Regla

java.lang.Object

keel.Algorithms.Rule_Learning.SRI.Regla

public class Regla
extends java.lang.Object

Title: Regla (Rule).

Description: This class implements a rule object for this rule learning algorithm. This class stores the antecedents, consequents and the list of invalid attributes.

Company: KEEL

Version:

1.0

Author:

Ismael Duque García

Constructor Summary

Constructors

Constructor and Description
Regla(Regla r) Copy Constructor.
Regla(java.lang.String c, int numAtributos) Parameter constructor.

Method Summary

Modifier and Type	Method and Description
void	addAntecedente(Atributo_valor av) Adds the given antecent to the list of the rule.
void	addValoresInv(java.lang.Integer i, java.lang.Double vinv) Adds an attribute with its value to the invalid values list.
boolean	contenidoValoreInval(java.lang.Integer atributo, java.lang.Double valor) Checks if the given attribute and its value is invalid for this rule.
boolean	equals(Regla rule) Checks if the rule is equal to the given one.
java.util.LinkedList<Atributo_valor>	getAntecedente() Returns the list with the antecedents of the rule.
Atributo_valor	getAV(int i) Returns the pair attribute - values asked from the antecedents list.
java.lang.String	getConsecuente() Returns the consequent of the rule.
boolean	getConsistencia() Return the consistency of the rule.
Atributo_valor	getLastAV() Returns the last pair attribute - values from the antecedents list.
java.lang.Double	getScore(Instances instances) Computes the quality of the rule with the m-probability-estimation.
int	getSizeAntecedentes() Returns the size of the antecedents list.
java.util.LinkedList<java.util.LinkedList<java.lang.Double>>	getValoresInvalidos() Returns the list with the invalid values for the rule.
void	mostrarRegla() Prints on the standard output the rule information.
Regla	parentRule() Returns the father of this rule, its ancestor.
void	removeValorInv(java.lang.Integer i, java.lang.Double vinv) Removes an attribute with its value to the invalid values list.

Methods inherited from class java.lang.Object

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

Constructor Detail

Regla

public Regla(java.lang.String c,
             int numAtributos)

Parameter constructor. Builds a rule with the parameters given.

Parameters:

c - String rule consequent

numAtributos - int number of attributes of the dataset.

Regla

public Regla(Regla r)

Copy Constructor. Creates a new rule object by copying the one given as argument.

Parameters:

r - rule to be copied.

Method Detail

getAntecedente

public java.util.LinkedList<Atributo_valor> getAntecedente()

Returns the list with the antecedents of the rule.

Returns:

the list with the antecedents of the rule.

getValoresInvalidos

public java.util.LinkedList<java.util.LinkedList<java.lang.Double>> getValoresInvalidos()

Returns the list with the invalid values for the rule.

Returns:

the list with the invalid values for the rule.

getConsecuente

public java.lang.String getConsecuente()

Returns the consequent of the rule.

Returns:

String the consequent of the rule.

getSizeAntecedentes

public int getSizeAntecedentes()

Returns the size of the antecedents list.

Returns:

the size of the antecedents list.

getConsistencia

public boolean getConsistencia()

Return the consistency of the rule.

Returns:

boolean the consistency of the rule.

contenidoValoreInval

public boolean contenidoValoreInval(java.lang.Integer atributo,
                                    java.lang.Double valor)

Checks if the given attribute and its value is invalid for this rule. The attribute and the value are in the invalid values list.

Parameters:

atributo - Integer given attribute.

valor - Double given value.

Returns:

boolean true if the given attribute and its value is invalid, false otherwise.

getAV

public Atributo_valor getAV(int i)

Returns the pair attribute - values asked from the antecedents list.

Parameters:

i - index of the antecedent asked.

Returns:

the pair attribute - values asked from the antecedents list.

getLastAV

public Atributo_valor getLastAV()

Returns the last pair attribute - values from the antecedents list.

Returns:

the last antecedent.

addAntecedente

public void addAntecedente(Atributo_valor av)

Adds the given antecent to the list of the rule. (pair attribute - values)

Parameters:

av - Atributo_valor antecedent to be added.

addValoresInv

public void addValoresInv(java.lang.Integer i,
                          java.lang.Double vinv)

Adds an attribute with its value to the invalid values list.

Parameters:

i - Integer attribute to be added.

vinv - Double value of the attribute to be added.

removeValorInv

public void removeValorInv(java.lang.Integer i,
                           java.lang.Double vinv)

Removes an attribute with its value to the invalid values list.

Parameters:

i - Integer attribute to be removed.

vinv - Double value of the attribute to be removed.

equals

public boolean equals(Regla rule)

Checks if the rule is equal to the given one.

Parameters:

rule - Rule to compare with.

Returns:

True if the rules are equal.

parentRule

public Regla parentRule()

Returns the father of this rule, its ancestor.

Returns:

Regla the rule without the last antecedent added.

mostrarRegla

public void mostrarRegla()

Prints on the standard output the rule information.

getScore

public java.lang.Double getScore(Instances instances)

Computes the quality of the rule with the m-probability-estimation.

Parameters:

instances - training dataset.

Returns:

Double the m-probability-estimation of the rule.