keel.Algorithms.Decision_Trees.FunctionalTrees

Class myDataset

java.lang.Object

keel.Algorithms.Decision_Trees.FunctionalTrees.myDataset

public class myDataset
extends java.lang.Object

This class contains the most useful information about a dataset, and provides a set of functions to manage this information easily.

Since:

JDK1.6

Version:

0.1

Author:

Written by Victoria Lopez Morales (University of Granada) 15/05/2009

Constructor Summary

Constructors

Constructor and Description
myDataset(myDataset dataset) Creates a dataset from another existing dataset
myDataset(java.lang.String nameFile, int newkind) Creates a dataset by reading the .dat file that contains the information of it, and gives values to every field of the class

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Check if a dataset is the same dataset as another object
myAttribute	getAttributeI(int i) Gets all the information about ith the attribute that the dataset uses
java.util.ArrayList<myAttribute>	getAttributes() Gets all the information about the attributes that the dataset uses
double	getDataI(int i, int j) Gets the value of the jth attribute for the ith instance in the dataset
double[]	getDataItem(int i) Gets the value of the ith instance in the dataset
int	getKind() Gets the kind of the dataset we are considering (training, reference, test)
java.lang.String	getName() Gets the name of the dataset
int	getNInstancesI(int i) Gets the number of instances of each class that there are in the dataset
int	getNumAtr() Gets the number of attributes that the dataset has
int	getNumClasses() Gets the number of different classes that there are in the dataset
int	getNumIns() Gets the number of instances that the dataset has
myAttribute	getOutputAttribute() Gets all the information about the output attribute of the dataset
int	getOutputI(int i) Gets the class of each instance in the dataset
int	hashCode() Hash-code function for the class that is used when object is inserted in a structure like a hashtable
void	setAttributeI(int i, myAttribute att) Replaces the information about the ith attribute that the dataset uses with new information about that attribute
void	setAttributes(java.util.ArrayList<myAttribute> attributes) Replaces all the information about the attributes that the dataset uses with new information about the attributes
void	setDataI(int i, int j, double data) Replaces the value of the ith instance at the jth attribute in this dataset with the specified value
void	setKind(int kind) Changes the kind of dataset to a new kind
void	setName(java.lang.String name) Replaces the name of the dataset with another new name
void	setNInstancesI(int i, int instances) Replaces the number of instances of a class that there are in the dataset with a another number of instances for that class
void	setNumAtr(int numAtr) Replaces the number of attributes in this dataset with a new number of attributes
void	setNumClasses(int numClasses) Replaces the number of classes in this dataset with a new number of classes
void	setNumIns(int numIns) Replaces the number of instances in this dataset with a new number of instances
void	setOutputAttribute(myAttribute outputAttribute) Replaces the information about the output attribute with new information about that attribute
void	setOutputI(int i, int output) Replaces the output attribute value at the specified instance in this dataset with the specified value
java.lang.String	toString() Overriden function that converts the class to a string

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

myDataset

public myDataset(java.lang.String nameFile,
                 int newkind)
          throws CheckException

Creates a dataset by reading the .dat file that contains the information of it, and gives values to every field of the class

Parameters:

nameFile - The name of the file that is going to be read

newkind - The kind of dataset to determine if the file is for training, reference or test

Throws:

CheckException - Thrown from the CheckException class

myDataset

public myDataset(myDataset dataset)

Creates a dataset from another existing dataset

Parameters:

dataset - Original dataset from which we are going to create a copy

Method Detail

equals

public boolean equals(java.lang.Object obj)

Check if a dataset is the same dataset as another object

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object that is checked to see if it is the same dataset

Returns:

true if the datasets are the same, false otherwise

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Hash-code function for the class that is used when object is inserted in a structure like a hashtable

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code obtained

See Also:

Object.hashCode()

toString

public java.lang.String toString()

Overriden function that converts the class to a string

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the class

See Also:

Object.toString()

getName

public java.lang.String getName()

Gets the name of the dataset

Returns:

the name of the dataset

setName

public void setName(java.lang.String name)

Replaces the name of the dataset with another new name

Parameters:

name - New name for the dataset

getNumAtr

public int getNumAtr()

Gets the number of attributes that the dataset has

Returns:

the number of attributes that the dataset has

setNumAtr

public void setNumAtr(int numAtr)

Replaces the number of attributes in this dataset with a new number of attributes

Parameters:

numAtr - New number of attributes for this dataset

getNumIns

public int getNumIns()

Gets the number of instances that the dataset has

Returns:

the number of instances that the dataset has

setNumIns

public void setNumIns(int numIns)

Replaces the number of instances in this dataset with a new number of instances

Parameters:

numIns - New number of instances for this dataset

getAttributes

public java.util.ArrayList<myAttribute> getAttributes()

Gets all the information about the attributes that the dataset uses

Returns:

all the information about the attributes that the dataset uses

setAttributes

public void setAttributes(java.util.ArrayList<myAttribute> attributes)

Replaces all the information about the attributes that the dataset uses with new information about the attributes

Parameters:

attributes - New information about the attributes that the dataset uses

getAttributeI

public myAttribute getAttributeI(int i)

Gets all the information about ith the attribute that the dataset uses

Parameters:

i - index of the attribute asked

Returns:

all the information about the ith attribute that the dataset uses

setAttributeI

public void setAttributeI(int i,
                          myAttribute att)

Replaces the information about the ith attribute that the dataset uses with new information about that attribute

Parameters:

i - Position of the attribute that is going to be replaced

att - New information about the attribute that the dataset uses

getOutputAttribute

public myAttribute getOutputAttribute()

Gets all the information about the output attribute of the dataset

Returns:

all the information about the output attribute of the dataset

setOutputAttribute

public void setOutputAttribute(myAttribute outputAttribute)

Replaces the information about the output attribute with new information about that attribute

Parameters:

outputAttribute - Attribute to be stored like the output attribute

getNumClasses

public int getNumClasses()

Gets the number of different classes that there are in the dataset

Returns:

the number of different classes that there are in the dataset

setNumClasses

public void setNumClasses(int numClasses)

Replaces the number of classes in this dataset with a new number of classes

Parameters:

numClasses - New number of classes for this dataset

getNInstancesI

public int getNInstancesI(int i)

Gets the number of instances of each class that there are in the dataset

Parameters:

i - class index.

Returns:

the number of instances of each class that there are in the dataset

setNInstancesI

public void setNInstancesI(int i,
                           int instances)

Replaces the number of instances of a class that there are in the dataset with a another number of instances for that class

Parameters:

i - Class which number of instances is going to be modified

instances - New number of instances for the ith class

getDataI

public double getDataI(int i,
                       int j)

Gets the value of the jth attribute for the ith instance in the dataset

Parameters:

i - index of the instance.

j - index of the attribute.

Returns:

the value of the jth attribute for the ith instance in the dataset

getDataItem

public double[] getDataItem(int i)

Gets the value of the ith instance in the dataset

Parameters:

i - instance's index.

Returns:

the value of the ith instance in the dataset

setDataI

public void setDataI(int i,
                     int j,
                     double data)

Replaces the value of the ith instance at the jth attribute in this dataset with the specified value

Parameters:

i - Position of the instance which value is going to be replaced

j - Attribute which value is going to be replaced

data - Value to be stored at the specified instance and attribute

getOutputI

public int getOutputI(int i)

Gets the class of each instance in the dataset

Parameters:

i - instance's index.

Returns:

the class of each instance in the dataset

setOutputI

public void setOutputI(int i,
                       int output)

Replaces the output attribute value at the specified instance in this dataset with the specified value

Parameters:

i - Index of the instance output value to replace

output - Value to be stored at the specified instance

getKind

public int getKind()

Gets the kind of the dataset we are considering (training, reference, test)

Returns:

the name of the dataset

setKind

public void setKind(int kind)

Changes the kind of dataset to a new kind

Parameters:

kind - New kind for the dataset