keel.Algorithms.Associative_Classification.ClassifierCMAR

Class RuleList

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

keel.Algorithms.Associative_Classification.ClassifierCMAR.AssocRuleMining

keel.Algorithms.Associative_Classification.ClassifierCMAR.RuleList

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class RuleList
extends AssocRuleMining

Set of utilities to support various Association Rule Mining (ARM) algorithms included in the LUCS-KDD suite of ARM programs.

Since:

JDK1.5

Version:

1.0

Author:

Frans Coenen 2 March 2004, Modified by Jesus Alcala (University of Granada) 09/02/2010, Modified by Sergio Almecija (University of Granada) 23/05/2010

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RuleList.RuleNode Rule node in linked list of rules (either ARs or CRs).
protected class	RuleList.RuleNodeCMAR Rule node in linked list of rules (either ARs or CRs) for CMAR algorithm.

Nested classes/interfaces inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected RuleList.RuleNodeCMAR	startCMARrulelist The reference to start of the CMAR rule list.
protected RuleList.RuleNode	startRulelist The reference to start of the rule list.

Fields inherited from class keel.Algorithms.Associative_Classification.ClassifierCMAR.AssocRuleMining

confidence, conversionArray, dataArray, errorFlag, fileInput, fileName, filePath, inputFormatOkFlag, minSupport, numClasses, numCols, numOneItemSets, numRows, reconversionArray, support

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
RuleList(int delta) Default constructor to create an instance of the class RuleList

Method Summary

Modifier and Type	Method and Description
protected short	classifyRecordWCS(short[] itemSet) Selects the best rule in a rule list according to the Weighted Chi- Squared (WCS) Value.
int	getNumCMAR_CRs() Returns the number of generated CMAR classification rules.
int	getNumCRs() Returns the number of generated rules (usually used in conjunction with classification rule mining algorithms rather than ARM algorithms).
protected void	insertRinRlistCMARranking(short[] antecedent, short[] consequent, double supportForAntecedent, double supportForConsequent, double supportForRule, double confidenceForRule) Inserts an (association/classification) rule into the linkedlist of rules pointed at by startRulelist.
void	outputCMARrules(java.lang.String filename) Outputs contents of CMAR rule linked list (if any)
void	outputCMARrulesWithReconversion() Outputs contents of CMAR rule linked list (if any)
void	outputNumCMARrules() Outputs number of generated rules (ARs or CARS).
void	outputNumRules() Outputs number of generated rules (ARs or CARS).
java.lang.String	outputRules(RuleList.RuleNodeCMAR ruleList) Outputs given CMAR rule list.
void	outputRulesWithReconversion(RuleList.RuleNodeCMAR ruleList) Outputs contents of rule linked list (if any) with reconversion.
protected void	pruneUsingCover(short[][] trainingSet) Prunes the current CMAR list of rules according to the "cover" principle.
protected void	setNumClasses(int numC) Sets number of classes field.
protected void	setNumOneItemSets(int nois) Sets number of one item sets field.
protected void	setNumRows(int numR) Sets number of rows field.
protected void	setReconversionArrayRefs(int[][] conversionArrayRef, short[] reconversionArrayRef) Sets the reconversion array reference values.
protected void	setStartCMARrulelistToNull() Sets START CMAR RULE LIST to null.
boolean	testRuleUsingChiSquaredTesting(double supA, double supC, double supAC, double numR) Tests a classification rule with the given parameters to determine the interestingness/surprisingness of the rule.

Methods inherited from class keel.Algorithms.Associative_Classification.ClassifierCMAR.AssocRuleMining

append, binConversion, checkForLeadingSubString, checkItemSets, combinations, complement, copyItemSet, copyItemSet, countSingles, defConvertArrays, getConfidence, getDuration, getLastElement, getNumSupOneItemSets, idInputDataOrdering, inputDataSet, isBefore, isEqual, isSubset, notMemberOf, orderFirstNofCountArray, outputConversionArrays, outputDataArray, outputDataArray, outputDataArraySize, outputDuration, outputItemSet, outputItemSetWithReconversion, outputMenu, outputSettings, outputSettings2, outputSuppAndConf, readFile, realloc1, realloc2, realloc3, realloc4, reallocInsert, recastInputData, recastInputDataAndPruneUnsupportedAtts, removeFirstNelements, resizeInputData, similar2dec, sortItemSet, threeDecPlaces, twoDecPlaces

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

startRulelist

protected RuleList.RuleNode startRulelist

The reference to start of the rule list.

startCMARrulelist

protected RuleList.RuleNodeCMAR startCMARrulelist

The reference to start of the CMAR rule list.

Constructor Detail

RuleList

public RuleList(int delta)

Default constructor to create an instance of the class RuleList

Parameters:

delta - Minimum times a record mist be covered

Method Detail

insertRinRlistCMARranking

protected void insertRinRlistCMARranking(short[] antecedent,
                                         short[] consequent,
                                         double supportForAntecedent,
                                         double supportForConsequent,
                                         double supportForRule,
                                         double confidenceForRule)

Inserts an (association/classification) rule into the linkedlist of rules pointed at by startRulelist.

List is ordered according to "CMAR" ranking.

Parameters:

antecedent - the antecedent (LHS) of the rule.

consequent - the consequent (RHS) of the rule.

supportForAntecedent - the associated support for the antecedent.

supportForConsequent - the associated support for the consequent.

supportForRule - the associated support value.

confidenceForRule - the associated confidence value.

testRuleUsingChiSquaredTesting

public boolean testRuleUsingChiSquaredTesting(double supA,
                                              double supC,
                                              double supAC,
                                              double numR)

Tests a classification rule with the given parameters to determine the interestingness/surprisingness of the rule.

Parameters:

supA - the support value for the antecedent of the rule.

supC - the support value for the consequent of the rule.

supAC - the support for the rule.

numR - the number of records in the input (training) sets.

Returns:

true if Chi squared value is above critical threshold and false otherwise.

pruneUsingCover

protected void pruneUsingCover(short[][] trainingSet)

Prunes the current CMAR list of rules according to the "cover" principle.

Parameters:

trainingSet - the input data set.

classifyRecordWCS

protected short classifyRecordWCS(short[] itemSet)

Selects the best rule in a rule list according to the Weighted Chi- Squared (WCS) Value.

Proceed as follows:

1. Collect rules that satisfy the record. if
   1. If consequents of all rules are all identical, or only one rule, classify record.
   2. Else group rules according to classifier and determine the combined effect of the rules in each group, the classifier associated with the "strongest group" is then selected.

Parameters:

itemSet - the record to be classified.

Returns:

the class label (or 0 if no class found).

getNumCRs

public int getNumCRs()

Returns the number of generated rules (usually used in conjunction with classification rule mining algorithms rather than ARM algorithms).

Returns:

the number of CRs.

getNumCMAR_CRs

public int getNumCMAR_CRs()

Returns the number of generated CMAR classification rules.

Returns:

the number of CRs.

setNumRows

protected void setNumRows(int numR)

Sets number of rows field.

Parameters:

numR - number of rows

setNumClasses

protected void setNumClasses(int numC)

Sets number of classes field.

Parameters:

numC - number of classes

setNumOneItemSets

protected void setNumOneItemSets(int nois)

Sets number of one item sets field.

Parameters:

nois - number of one item sets

setStartCMARrulelistToNull

protected void setStartCMARrulelistToNull()

Sets START CMAR RULE LIST to null.

setReconversionArrayRefs

protected void setReconversionArrayRefs(int[][] conversionArrayRef,
                                        short[] reconversionArrayRef)

Sets the reconversion array reference values.

Parameters:

conversionArrayRef - the reference to the 2-D array used to renumber coulmns for input data in terms of frequency of single attributes (reordering will enhance performance for some ARM and CARM algorithms).

reconversionArrayRef - the reference to the 1-D array used to reconvert input data column numbers to their original numbering where the input data has been ordered to enhance computational efficienvy.

outputCMARrules

public void outputCMARrules(java.lang.String filename)

Outputs contents of CMAR rule linked list (if any)

Parameters:

filename - file's name where the rule linked list will be stored

outputCMARrulesWithReconversion

public void outputCMARrulesWithReconversion()

Outputs contents of CMAR rule linked list (if any)

outputRules

public java.lang.String outputRules(RuleList.RuleNodeCMAR ruleList)

Outputs given CMAR rule list.

Parameters:

ruleList - the given rule list.

Returns:

the CMAR rule list given as argument as String

outputRulesWithReconversion

public void outputRulesWithReconversion(RuleList.RuleNodeCMAR ruleList)

Outputs contents of rule linked list (if any) with reconversion. The list of rules are presented in the standard output.

Parameters:

ruleList - CMAR rule list given

outputNumRules

public void outputNumRules()

Outputs number of generated rules (ARs or CARS).

outputNumCMARrules

public void outputNumCMARrules()

Outputs number of generated rules (ARs or CARS).