keel.Algorithms.Rule_Learning.C45RulesSA

Class Itemset

java.lang.Object

keel.Algorithms.Rule_Learning.C45RulesSA.Itemset

public class Itemset
extends java.lang.Object

Class to manipulate an itemset.

Since:

JDK1.2

Version:

1.1

Author:

Written by Antonio Alejandro Tortosa (University of Granada) 01/07/2008, Modified by Xavi Solé (La Salle, Ramón Llull University - Barcelona) 16/12/2008

Field Summary

Fields

Modifier and Type	Field and Description
protected MyDataset	dataset The dataset which the itemset has access to.
protected static double	MISSING_VALUE Constant that represents the missing value.
protected double[]	values Values of the itemset.
protected double	weight The weight of the itemset.

Constructor Summary

Constructors

Constructor and Description
Itemset(double w, double[] attributeValues) Constructor that sets the values and the weight.
Itemset(Itemset itemset) Constructor that copies the values and the weight.

Method Summary

Modifier and Type	Method and Description
int	classIndex() Returns the index of the class attribute.
boolean	classIsMissing() Function to test if the class attribute is missing.
java.lang.Object	copy() Function to copy an itemset.
MyAttribute	getAttribute(int index) Returns the attribute with the given index.
double	getClassValue() Returns the index of the value of the class.
MyDataset	getDataset() Returns the dataset of this itemset.
static double	getMissingValue() Returns the missing value.
double	getValue(int index) Returns the value of the given attribute.
double	getWeight() Returns the itemset weight.
boolean	isMissing(int index) Function to check if a value is missing.
static boolean	isMissingValue(double val) Function to check if the value given is the missing value.
int	numClasses() Returns the number of class values.
void	setClassMissing() Function to set as missing the class value.
void	setDataset(MyDataset data) Function to set the dataset.
void	setMissing(int index) Function to set a value as missing.
void	setValue(int index, double value) Function to set a value.
void	setWeight(double w) Function to set the weight.
java.lang.String	toString() Function to print the itemset.

Methods inherited from class java.lang.Object

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

Field Detail

dataset

protected MyDataset dataset

The dataset which the itemset has access to.

values

protected double[] values

Values of the itemset.

weight

protected double weight

The weight of the itemset.

MISSING_VALUE

protected static final double MISSING_VALUE

Constant that represents the missing value.

See Also:

Constant Field Values

Constructor Detail

Itemset

public Itemset(Itemset itemset)

Constructor that copies the values and the weight.

Parameters:

itemset - The itemset to copy.

Itemset

public Itemset(double w,
               double[] attributeValues)

Constructor that sets the values and the weight.

Parameters:

w - The weight.

attributeValues - The values.

Method Detail

classIndex

public int classIndex()

Returns the index of the class attribute.

Returns:

the index of the class attribute.

classIsMissing

public boolean classIsMissing()

Function to test if the class attribute is missing.

Returns:

True if the value of the class attribute is missing.

getClassValue

public double getClassValue()

Returns the index of the value of the class.

Returns:

the index of the value of the class.

numClasses

public int numClasses()

Returns the number of class values.

Returns:

the number of class values.

getAttribute

public MyAttribute getAttribute(int index)

Returns the attribute with the given index.

Parameters:

index - the attribute's index

Returns:

the attribute with the given index.

setValue

public void setValue(int index,
                     double value)

Function to set a value.

Parameters:

index - The index of the attribute.

value - The value.

getValue

public double getValue(int index)

Returns the value of the given attribute.

Parameters:

index - the attribute's index

Returns:

the value of the given attribute.

setWeight

public final void setWeight(double w)

Function to set the weight.

Parameters:

w - The weight.

getWeight

public final double getWeight()

Returns the itemset weight.

Returns:

the itemset weight.

getDataset

public MyDataset getDataset()

Returns the dataset of this itemset.

Returns:

the dataset of this itemset.

setDataset

public final void setDataset(MyDataset data)

Function to set the dataset.

Parameters:

data - The dataset.

isMissing

public boolean isMissing(int index)

Function to check if a value is missing.

Parameters:

index - The index of the attribute to check.

Returns:

True is the value of the attribute is missing. False otherwise.

isMissingValue

public static boolean isMissingValue(double val)

Function to check if the value given is the missing value.

Parameters:

val - The value to check.

Returns:

True if the value given is the missing value. False otherwise.

getMissingValue

public static double getMissingValue()

Returns the missing value.

Returns:

the missing value.

setClassMissing

public void setClassMissing()

Function to set as missing the class value.

setMissing

public final void setMissing(int index)

Function to set a value as missing.

Parameters:

index - The index of the attribute.

copy

public java.lang.Object copy()

Function to copy an itemset.

Returns:

The itemset created.

toString

public java.lang.String toString()

Function to print the itemset.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of this itemset.