keel.Algorithms.Associative_Classification.ClassifierCBA2

Class Itemset

java.lang.Object

keel.Algorithms.Associative_Classification.ClassifierCBA2.Itemset

All Implemented Interfaces:

java.lang.Comparable

public class Itemset
extends java.lang.Object
implements java.lang.Comparable

This class stores an itemset representation for classification by association algorithms. Also, it stores some useful information to manage the itemset

Since:

JDK1.5

Version:

1.0

Author:

Jesus Alcalá (University of Granada) 09/02/2010

Constructor Summary

Constructors

Constructor and Description
Itemset() Default Constructor
Itemset(int clas) Parameters Constructor

Method Summary

Modifier and Type	Method and Description
void	add(Item item) Function to add an item to our itemset
void	calculateSupports(myDataset train) It computes the support, rule support, hits, misses and PER of our itemset for a given dataset
Itemset	clone() Clone function.
int	compareTo(java.lang.Object a) Function to compare objects of the Itemset class.
Item	get(int pos) It returns the item located in the given position of the itemset
int	getClas() It returns the output class of the itemset
int	getHits() It returns the number of hits of the itemset against the training set
int	getMisses() It returns the number of misses of the itemset against the training set
double	getPer() It returns the Pessimistic Error Rate of the itemset
double	getSupport() It returns the support of the antecedent of the itemset
double	getSupportClass() It returns the support of the itemset for its related output class
boolean	isEqual(Itemset a) Function to check if an itemset is equal to another given
boolean	isEqualAnt(Itemset a) Function to check if the antecedent of our itemset is equal to another given
boolean	isSubItemset(Itemset a) Function to check if our itemset is Subitemset (can be contained) of a given itemset
Item	remove(int pos) Function to remove the item located in the given position
void	setClas(int clas) Function which sets the itemset's output class
int	size() It returns the size of the itemset (the number of items it has)

Methods inherited from class java.lang.Object

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

Constructor Detail

Itemset

public Itemset()

Default Constructor

Itemset

public Itemset(int clas)

Parameters Constructor

Parameters:

clas - Associated output of the Itemset

Method Detail

clone

public Itemset clone()

Clone function.

Overrides:

clone in class java.lang.Object

Returns:

A copy of the Itemset object.

add

public void add(Item item)

Function to add an item to our itemset

Parameters:

item - Element to be added

get

public Item get(int pos)

It returns the item located in the given position of the itemset

Parameters:

pos - Position of the requested item into the itemset

Returns:

Item The requested item of the itemset

remove

public Item remove(int pos)

Function to remove the item located in the given position

Parameters:

pos - Position of the requested item into the itemset

Returns:

Item The removed item of the itemset

size

public int size()

It returns the size of the itemset (the number of items it has)

Returns:

int Number of items the itemset stores

getSupport

public double getSupport()

It returns the support of the antecedent of the itemset

Returns:

double Support of the antecedent of the itemset

getSupportClass

public double getSupportClass()

It returns the support of the itemset for its related output class

Returns:

double Support of the itemset for its related output class

getHits

public int getHits()

It returns the number of hits of the itemset against the training set

Returns:

int Number of hits of the itemset against the training set

getMisses

public int getMisses()

It returns the number of misses of the itemset against the training set

Returns:

int Number of misses of the itemset against the training set

getPer

public double getPer()

It returns the Pessimistic Error Rate of the itemset

Returns:

double Pessimistic Error Rate of the itemset

getClas

public int getClas()

It returns the output class of the itemset

Returns:

int output class of the itemset

setClas

public void setClas(int clas)

Function which sets the itemset's output class

Parameters:

clas - Itemset's output class

isEqual

public boolean isEqual(Itemset a)

Function to check if an itemset is equal to another given

Parameters:

a - Itemset to compare with ours

Returns:

boolean true = they are equal, false = they aren't.

isEqualAnt

public boolean isEqualAnt(Itemset a)

Function to check if the antecedent of our itemset is equal to another given

Parameters:

a - Itemset which antecedents we are going to compare with ours

Returns:

boolean true = they are equal, false = they aren't.

isSubItemset

public boolean isSubItemset(Itemset a)

Function to check if our itemset is Subitemset (can be contained) of a given itemset

Parameters:

a - Itemset to check if can contain ours

Returns:

boolean true = our itemset is subitemset of a, false = it isn't.

calculateSupports

public void calculateSupports(myDataset train)

It computes the support, rule support, hits, misses and PER of our itemset for a given dataset

Parameters:

train - Given training dataset to be able to calculate supports

compareTo

public int compareTo(java.lang.Object a)

Function to compare objects of the Itemset class. Necessary to be able to use "sort" function. It sorts in an decreasing order of attribute. If equals, in an decreasing order of value of the attribute. If equals, in an decreasing order of class.

Specified by:

compareTo in interface java.lang.Comparable

Parameters:

a - Itemset object to compare with.

Returns:

-1 if a is bigger, 1 if smaller and 0 otherwise.