keel.Algorithms.Genetic_Rule_Learning.M5Rules

Class Itemset

java.lang.Object

keel.Algorithms.Genetic_Rule_Learning.M5Rules.Itemset

public class Itemset
extends java.lang.Object

Class to manipulate an itemset.

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

Modifier	Constructor and Description
protected	Itemset() Default Constructor.
	Itemset(double w, double[] attributeValues) Constructor that sets the values and the weight.
	Itemset(int numAttributes) Constructor of an instance that sets weight to one, all values to be missing, and the reference to the dataset to null.
	Itemset(Itemset itemset) Constructor that copies the values and the weight.

Method Summary

Modifier and Type	Method and Description
MyAttribute	attributeSparse(int indexOfIndex) Returns the attribute with the given index.
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.
void	deleteAttributeAt(int position) Deletes an attribute at the given position (0 to numAttributes() - 1).
java.util.Enumeration	enumerateAttributes() Returns an enumeration of all the attributes.
boolean	equalHeaders(Itemset inst) Tests if the headers of two instances are equivalent.
MyAttribute	getAttribute(int index) Returns the attribute with the given index.
MyAttribute	getClassAttribute() Returns class attribute.
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.
java.lang.String	getStringValue(int index) Returns the value of the given attribute.
java.lang.String	getStringValue(MyAttribute att) Returns the value of the given attribute.
double	getValue(int index) Returns the value of the given attribute.
double	getValue(MyAttribute att) Returns the value of the given attribute.
double	getValueSparse(int indexOfIndex) Returns an instance's attribute value in internal format.
double	getWeight() Returns the itemset weight.
int	index(int position) Returns the index of the attribute stored at the given position.
void	insertAttributeAt(int position) Inserts an attribute at the given position (0 to numAttributes()).
boolean	isMissing(int index) Function to check if a value is missing.
boolean	isMissing(MyAttribute att) Tests if a specific value is "missing".
boolean	isMissingSparse(int indexOfIndex) Tests if a specific value is "missing".
static boolean	isMissingValue(double val) Function to check if the value given is the missing value.
Itemset	mergeInstance(Itemset inst) Merges this instance with the given instance and returns the result.
int	numAttributes() Returns the number of attributes.
int	numClasses() Returns the number of class values.
int	numValues() Returns the number of values.
void	replaceMissingValues(double[] array) Replaces all missing values in the instance with the values contained in the given array.
void	setClassMissing() Function to set as missing the class value.
void	setClassValue(double value) Function to set a value.
void	setClassValue(java.lang.String value) Function to set a value.
void	setDataset(MyDataset data) Function to set the dataset.
void	setMissing(int index) Function to set a value as missing.
void	setMissing(MyAttribute att) Sets a specific value to be "missing".
void	setValue(int index, double value) Function to set a value.
void	setValue(int attIndex, java.lang.String value) Sets a value of a nominal or string attribute to the given value.
void	setValue(MyAttribute att, double value) Sets a specific value in the instance to the given value (internal floating-point format).
void	setValue(MyAttribute att, java.lang.String value) Sets a value of an nominal or string attribute to the given value.
void	setValueSparse(int indexOfIndex, double value) Sets a specific value in the instance to the given value (internal floating-point format).
void	setWeight(double w) Function to set the weight.
java.lang.String	toString() Function to print the itemset.
java.lang.String	toString(int attIndex) Returns the description of one value of the instance as a string.
java.lang.String	toString(MyAttribute att) Function to print of one value of 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.

Itemset

public Itemset(int numAttributes)

Constructor of an instance that sets weight to one, all values to be missing, and the reference to the dataset to null. (ie. the instance doesn't have access to information about the attribute types)

Parameters:

numAttributes - the size of the instance

Itemset

protected Itemset()

Default Constructor.

Method Detail

index

public int index(int position)

Returns the index of the attribute stored at the given position. Just returns the given value.

Parameters:

position - the position

Returns:

the index of the attribute stored at the given position

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.

getClassAttribute

public MyAttribute getClassAttribute()
                              throws java.lang.Exception

Returns class attribute.

Returns:

the class attribute

Throws:

java.lang.Exception - UnassignedDatasetException if the class is not set or the instance doesn't have access to a dataset

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.

numAttributes

public int numAttributes()

Returns the number of attributes.

Returns:

the number of attributes.

numValues

public int numValues()

Returns the number of values. Always the same as numAttributes().

Returns:

the number of values.

attributeSparse

public MyAttribute attributeSparse(int indexOfIndex)
                            throws java.lang.Exception

Returns the attribute with the given index. Does the same thing as attribute().

Parameters:

indexOfIndex - the index of the attribute's index

Returns:

the attribute at the given position

Throws:

java.lang.Exception - UnassignedDatasetException if instance doesn't have access to a dataset

setClassValue

public void setClassValue(double value)

Function to set a value.

Parameters:

value - The value.

setClassValue

public void setClassValue(java.lang.String value)
                   throws java.lang.Exception

Function to set a value.

Parameters:

value - The value.

Throws:

java.lang.Exception - If the index of the class is not set.

setValue

public void setValue(int index,
                     double value)

Function to set a value.

Parameters:

index - The index of the attribute.

value - The value.

setValueSparse

public void setValueSparse(int indexOfIndex,
                           double value)

Sets a specific value in the instance to the given value (internal floating-point format). Performs a deep copy of the vector of attribute values before the value is set. Does exactly the same thing as setValue().

Parameters:

indexOfIndex - the index of the attribute's index

value - the new attribute value (If the corresponding attribute is nominal (or a string) then this is the new value's index as a double).

setValue

public final void setValue(int attIndex,
                           java.lang.String value)
                    throws java.lang.Exception

Sets a value of a nominal or string attribute to the given value. Performs a deep copy of the vector of attribute values before the value is set.

Parameters:

attIndex - the attribute's index

value - the new attribute value (If the attribute is a string attribute and the value can't be found, the value is added to the attribute).

Throws:

java.lang.Exception - UnassignedDatasetException if the dataset is not set or IllegalArgumentException if the selected attribute is not nominal or a string, or the supplied value couldn't be found for a nominal attribute

setValue

public final void setValue(MyAttribute att,
                           double value)

Sets a specific value in the instance to the given value (internal floating-point format). Performs a deep copy of the vector of attribute values before the value is set, so if you are planning on calling setValue many times it may be faster to create a new instance using toDoubleArray. The given attribute has to belong to a dataset.

Parameters:

att - the attribute

value - the new attribute value (If the corresponding attribute is nominal (or a string) then this is the new value's index as a double).

setValue

public final void setValue(MyAttribute att,
                           java.lang.String value)
                    throws java.lang.Exception

Sets a value of an nominal or string attribute to the given value. Performs a deep copy of the vector of attribute values before the value is set, so if you are planning on calling setValue many times it may be faster to create a new instance using toDoubleArray. The given attribute has to belong to a dataset.

Parameters:

att - the attribute

value - the new attribute value (If the attribute is a string attribute and the value can't be found, the value is added to the attribute).

Throws:

java.lang.Exception - if the the attribute is not nominal or a string, or the value couldn't be found for a nominal attribute

getValueSparse

public double getValueSparse(int indexOfIndex)

Returns an instance's attribute value in internal format. Does exactly the same thing as value() if applied to an Itemset.

Parameters:

indexOfIndex - the index of the attribute's index

Returns:

the specified value as a double (If the corresponding attribute is nominal (or a string) then it returns the value's index as a double).

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.

getStringValue

public java.lang.String getStringValue(int index)
                                throws java.lang.Exception

Returns the value of the given attribute.

Parameters:

index - the attribute's index

Returns:

the value of the given attribute.

Throws:

java.lang.Exception - if the Itemset doesn't have access to a dataset or the attribute neither nominal nor string.

getStringValue

public java.lang.String getStringValue(MyAttribute att)
                                throws java.lang.Exception

Returns the value of the given attribute.

Parameters:

att - the attribute

Returns:

the value of the given attribute.

Throws:

java.lang.Exception - if the Itemset doesn't have access to a dataset or the attribute neither nominal nor string.

getValue

public double getValue(MyAttribute att)

Returns the value of the given attribute.

Parameters:

att - the attribute

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.

isMissing

public boolean isMissing(MyAttribute att)

Tests if a specific value is "missing". The given attribute has to belong to a dataset.

Parameters:

att - the attribute

Returns:

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

isMissingSparse

public boolean isMissingSparse(int indexOfIndex)

Tests if a specific value is "missing". Does the same thing as isMissing() if applied to an Instance.

Parameters:

indexOfIndex - the index of the attribute's index

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.

setMissing

public final void setMissing(MyAttribute att)

Sets a specific value to be "missing". Performs a deep copy of the vector of attribute values before the value is set to be missing. The given attribute has to belong to a dataset.

Parameters:

att - the attribute

copy

public java.lang.Object copy()

Function to copy an itemset.

Returns:

The itemset created.

insertAttributeAt

public void insertAttributeAt(int position)

Inserts an attribute at the given position (0 to numAttributes()). Only succeeds if the instance does not have access to any dataset because otherwise inconsistencies could be introduced.

Parameters:

position - the attribute's position

Throws:

java.lang.RuntimeException - if the instance has accesss to a dataset

java.lang.IllegalArgumentException - if the position is out of range

mergeInstance

public Itemset mergeInstance(Itemset inst)

Merges this instance with the given instance and returns the result. Dataset is set to null.

Parameters:

inst - the instance to be merged with this one

Returns:

the merged instances

deleteAttributeAt

public void deleteAttributeAt(int position)

Deletes an attribute at the given position (0 to numAttributes() - 1). Only succeeds if the instance does not have access to any dataset because otherwise inconsistencies could be introduced.

Parameters:

position - the attribute's position

Throws:

java.lang.RuntimeException - if the instance has access to a dataset

replaceMissingValues

public void replaceMissingValues(double[] array)

Replaces all missing values in the instance with the values contained in the given array. A deep copy of the vector of attribute values is performed before the values are replaced.

Parameters:

array - containing the means and modes

Throws:

java.lang.IllegalArgumentException - if numbers of attributes are unequal

equalHeaders

public boolean equalHeaders(Itemset inst)
                     throws java.lang.Exception

Tests if the headers of two instances are equivalent.

Parameters:

inst - another instance

Returns:

true if the header of the given instance is equivalent to this instance's header

Throws:

java.lang.Exception - UnassignedDatasetException if instance doesn't have access to any dataset

enumerateAttributes

public java.util.Enumeration enumerateAttributes()
                                          throws java.lang.Exception

Returns an enumeration of all the attributes.

Returns:

enumeration of all the attributes

Throws:

java.lang.Exception - UnassignedDatasetException if the instance doesn't have access to a dataset

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.

toString

public final java.lang.String toString(MyAttribute att)
                                throws java.lang.Exception

Function to print of one value of the itemset.

Parameters:

att - the attribute

Returns:

the value's description as a string

Throws:

java.lang.Exception

toString

public final java.lang.String toString(int attIndex)
                                throws java.lang.Exception

Returns the description of one value of the instance as a string. If the instance doesn't have access to a dataset, it returns the internal floating-point value. Quotes string values that contain whitespace characters, or if they are a question mark.

Parameters:

attIndex - the attribute's index

Returns:

the value's description as a string

Throws:

java.lang.Exception