keel.Algorithms.Subgroup_Discovery.SDMap.SDMap

Class AssociationRule

java.lang.Object

keel.Algorithms.Subgroup_Discovery.SDMap.SDMap.AssociationRule

public class AssociationRule
extends java.lang.Object

It is used for representing and handling an Association Rule

Since:

JDK1.6

Version:

1.0

Author:

Written by Nicola Flugy Papa (Politecnico di Milano) 24/03/2009, Modified by Cristobal J. Carmona (University of Jaen) 10/07/2010

Constructor Summary

Constructors

Constructor and Description
AssociationRule(short[] antecedent, short[] consequent, double ruleSupport, double antecedentSupport, double confidence, int clases) It creates a new association rule by setting up its properties
AssociationRule(short[] antecedent, short[] consequent, double ruleSupport, double antecedentSupport, double confidence, int clases, int[] dist) It creates a new association rule by setting up its properties

Method Summary

Modifier and Type	Method and Description
void	adjustDistrib() Convert the distribution between 0 and 1
void	deleteDistrib() Reset the value of the distribution
short[]	getAntecedent() It retrieves the antecedent part of an association rule
double	getAntecedentSupport() It returns the antecedent support of an association rule
double	getConfidence() It returns the confidence of an association rule
short[]	getConsequent() It retrieves the consequent part of an association rule
double[]	getDistrib() Return the value of the complete distribution
double	getDistribClass(int value) Return the value of a distribution
int	getDistribClassEx(int value) Return the value of the distribution for the example of a class
int[]	getDistribEx() Return the value of the complete distribution for the example of a class
double	getRuleSupport() It returns the support of an association rule
void	incrementDistrib(int value) Increments the number of example for the class cover for the complex
java.lang.String	printDistribucionString() Print in a string the distribution values of the class
java.lang.String	toString() It returns a raw string representation of an association rule

Methods inherited from class java.lang.Object

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

Constructor Detail

AssociationRule

public AssociationRule(short[] antecedent,
                       short[] consequent,
                       double ruleSupport,
                       double antecedentSupport,
                       double confidence,
                       int clases)

It creates a new association rule by setting up its properties

Parameters:

antecedent - The antecedent part of the rule

consequent - The consequent part of the rule

ruleSupport - The value representing the rule support

antecedentSupport - The value representing the antecedent support

confidence - The value representing the rule confidence

clases - Values of the target variable

AssociationRule

public AssociationRule(short[] antecedent,
                       short[] consequent,
                       double ruleSupport,
                       double antecedentSupport,
                       double confidence,
                       int clases,
                       int[] dist)

It creates a new association rule by setting up its properties

Parameters:

antecedent - The antecedent part of the rule

consequent - The consequent part of the rule

ruleSupport - The value representing the rule support

antecedentSupport - The value representing the antecedent support

confidence - The value representing the rule confidence

clases - Values of the target variable

dist - Distribution values of the class

Method Detail

getAntecedent

public short[] getAntecedent()

It retrieves the antecedent part of an association rule

Returns:

An array of numbers representing antecedent attributes

getConsequent

public short[] getConsequent()

It retrieves the consequent part of an association rule

Returns:

An array of numbers representing consequent attributes

getRuleSupport

public double getRuleSupport()

It returns the support of an association rule

Returns:

A value representing the support of the association rule

getAntecedentSupport

public double getAntecedentSupport()

It returns the antecedent support of an association rule

Returns:

A value representing the antecedent support of the association rule

getConfidence

public double getConfidence()

It returns the confidence of an association rule

Returns:

A value representing the confidence of the association rule

deleteDistrib

public void deleteDistrib()

Reset the value of the distribution

incrementDistrib

public void incrementDistrib(int value)

Increments the number of example for the class cover for the complex

Parameters:

value - The value of the class

adjustDistrib

public void adjustDistrib()

Convert the distribution between 0 and 1

getDistribClass

public double getDistribClass(int value)

Return the value of a distribution

Parameters:

value - Index of the class

Returns:

The value of the distribution for this class

getDistrib

public double[] getDistrib()

Return the value of the complete distribution

Returns:

double[] The value of the complete distribution

getDistribClassEx

public int getDistribClassEx(int value)

Return the value of the distribution for the example of a class

Parameters:

value - Index of the class

Returns:

Value of the distribution

getDistribEx

public int[] getDistribEx()

Return the value of the complete distribution for the example of a class

Returns:

Value of the distribution

printDistribucionString

public java.lang.String printDistribucionString()

Print in a string the distribution values of the class

Returns:

A string with the distribution values of the class

toString

public java.lang.String toString()

It returns a raw string representation of an association rule

Overrides:

toString in class java.lang.Object

Returns:

A raw string representation of the association rule