keel.Algorithms.Genetic_Rule_Learning.Hider

Class Dataset

java.lang.Object

keel.Algorithms.Genetic_Rule_Learning.Hider.Dataset

public class Dataset
extends java.lang.Object

Title: Dataset

Description: It contains the methods to read a Classification/Regression Dataset

Company: KEEL

Version:

1.0

Author:

Alberto Fernández

Field Summary

Fields

Modifier and Type	Field and Description
static int	INTEGER Number to represent type of variable integer.
static int	NOMINAL Number to represent type of variable nominal.
static int	REAL Number to represent type of variable real or double.

Constructor Summary

Constructors

Constructor and Description
Dataset() Init a new set of instances

Method Summary

Modifier and Type	Method and Description
double	average(int position) It return the average of an specific attribute
void	computeInstancesPerClass() It computes the number of instances of the dataset match to each existing class.
java.lang.String	copyHeader() It copies the header of the dataset
double[][]	devuelveRangos() Returns the minimum and maximum values of every attributes as a matrix.
java.util.Vector	getAtributos() Returns the all attributes names.
java.lang.String	getDatosIndex(int i, int j) Returns the value of a given attribute for a given instance.
double[]	getemax() It returns an array with the maximum values of the attributes
double[]	getemin() It returns an array with the minimum values of the attributes
double[]	getExample(int pos) Output a specific example
double	getMax(int variable) It returns the maximum value of the given attribute
double	getMin(int variable) It returns the minimum value of the given attribute
int	getnClasses() It gets the number of output attributes of the data-set (for example number of classes in classification)
int	getNdatos() It gets the size of the data-set
int	getnInputs() It gets the number of input attributes of the data-set
int	getNvariables() It gets the number of variables of the data-set (including the output)
int[]	getOutputAsInteger() Returns the output of the data-set as integer values
int	getOutputAsInteger(int pos) It returns the output value of the example "pos"
double[]	getOutputAsReal() Returns the output of the data-set as real values
double	getOutputAsReal(int pos) It returns the output value of the example "pos"
java.lang.String[]	getOutputAsString() Returns the output of the data-set as nominal values
java.lang.String	getOutputAsString(int pos) It returns the output value of the example "pos"
java.lang.String	getOutputValue(int intValue) It returns the output value (string) which matchs with a given integer value
java.util.Vector	getRangos() Returns the minimum and maximum values of every attributes as a matrix.
int	getTipo(int variable) It returns the type of an attribute
java.util.Vector	getTipos() Returns the types of every attribute.
java.lang.String	getTiposIndex(int index) Returns the type of the attribute given.
java.lang.String	getTiposIndex2(int index) Returns the type of the attribute given.
double[][]	getX() Outputs an array of examples with their corresponding attribute values.
boolean	hasMissingAttributes() It checks if the data-set has any missing value
boolean	hasNumericalAttributes() It checks if the data-set has any numerical value
boolean	hasRealAttributes() It checks if the data-set has any real value
boolean	isMissing(int i, int j) This function checks if the attribute value is missing
void	normalize() It transform the input space into the [0,1] range
int	numberInstances(int clas) It returns the number of instances in the data set for a given class.
int	numberValues(int attribute) Function to get the number of different feasible values for a given attribute
void	ponValor(int ejemplo, int atributo, java.lang.String valor) Sets a value to an attribute of a given instance.
void	print() Prints the String representation given by printString.
java.lang.String	printString() Returns a String representation of the dataset (A list of all the instances).
void	readClassificationSet(java.lang.String datasetFile, boolean train) It reads the whole input data-set and it stores each example and its associated output value in local arrays to ease their use.
void	readRegressionSet(java.lang.String datasetFile, boolean train) It reads the whole input data-set and it stores each example and its associated output value in local arrays to ease their use.
int	size() It return the size of the data-set
int	sizeWithoutMissing() It return the size of the data-set without having account the missing values
double	stdDev(int position) It return the standard deviation of an specific attribute

Methods inherited from class java.lang.Object

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

Field Detail

REAL

public static final int REAL

Number to represent type of variable real or double.

See Also:

Constant Field Values

INTEGER

public static final int INTEGER

Number to represent type of variable integer.

See Also:

Constant Field Values

NOMINAL

public static final int NOMINAL

Number to represent type of variable nominal.

See Also:

Constant Field Values

Constructor Detail

Dataset

public Dataset()

Init a new set of instances

Method Detail

getX

public double[][] getX()

Outputs an array of examples with their corresponding attribute values.

Returns:

double[][] an array of examples with their corresponding attribute values

getExample

public double[] getExample(int pos)

Output a specific example

Parameters:

pos - int position (id) of the example in the data-set

Returns:

double[] the attributes of the given example

getOutputAsInteger

public int[] getOutputAsInteger()

Returns the output of the data-set as integer values

Returns:

int[] an array of integer values corresponding to the output values of the dataset

getOutputAsReal

public double[] getOutputAsReal()

Returns the output of the data-set as real values

Returns:

double[] an array of real values corresponding to the output values of the dataset

getOutputAsString

public java.lang.String[] getOutputAsString()

Returns the output of the data-set as nominal values

Returns:

String[] an array of nomianl values corresponding to the output values of the dataset

getOutputAsString

public java.lang.String getOutputAsString(int pos)

It returns the output value of the example "pos"

Parameters:

pos - int the position (id) of the example

Returns:

String a string containing the output value

getOutputAsInteger

public int getOutputAsInteger(int pos)

It returns the output value of the example "pos"

Parameters:

pos - int the position (id) of the example

Returns:

int an integer containing the output value

getOutputAsReal

public double getOutputAsReal(int pos)

It returns the output value of the example "pos"

Parameters:

pos - int the position (id) of the example

Returns:

double a real containing the output value

getemax

public double[] getemax()

It returns an array with the maximum values of the attributes

Returns:

double[] an array with the maximum values of the attributes

getemin

public double[] getemin()

It returns an array with the minimum values of the attributes

Returns:

double[] an array with the minimum values of the attributes

getMax

public double getMax(int variable)

It returns the maximum value of the given attribute

Parameters:

variable - the index of the attribute

Returns:

the maximum value of the given attribute

getMin

public double getMin(int variable)

It returns the minimum value of the given attribute

Parameters:

variable - the index of the attribute

Returns:

the minimum value of the given attribute

getNdatos

public int getNdatos()

It gets the size of the data-set

Returns:

int the number of examples in the data-set

getNvariables

public int getNvariables()

It gets the number of variables of the data-set (including the output)

Returns:

int the number of variables of the data-set (including the output)

getTiposIndex

public java.lang.String getTiposIndex(int index)

Returns the type of the attribute given.

Parameters:

index - attribute's index.

Returns:

the type of the attribute given.

getTiposIndex2

public java.lang.String getTiposIndex2(int index)

Returns the type of the attribute given.

Parameters:

index - attribute's index.

Returns:

the type of the attribute given.

getTipos

public java.util.Vector getTipos()

Returns the types of every attribute.

Returns:

the types of every attribute.

getAtributos

public java.util.Vector getAtributos()

Returns the all attributes names.

Returns:

the all attributes names.

getnInputs

public int getnInputs()

It gets the number of input attributes of the data-set

Returns:

int the number of input attributes of the data-set

getnClasses

public int getnClasses()

It gets the number of output attributes of the data-set (for example number of classes in classification)

Returns:

int the number of different output values of the data-set

isMissing

public boolean isMissing(int i,
                         int j)

This function checks if the attribute value is missing

Parameters:

i - int Example id

j - int Variable id

Returns:

boolean True is the value is missing, else it returns false

readClassificationSet

public void readClassificationSet(java.lang.String datasetFile,
                                  boolean train)
                           throws java.io.IOException

It reads the whole input data-set and it stores each example and its associated output value in local arrays to ease their use.

Parameters:

datasetFile - String name of the file containing the dataset

train - boolean It must have the value "true" if we are reading the training data-set

Throws:

java.io.IOException - If there ocurs any problem with the reading of the data-set

readRegressionSet

public void readRegressionSet(java.lang.String datasetFile,
                              boolean train)
                       throws java.io.IOException

It reads the whole input data-set and it stores each example and its associated output value in local arrays to ease their use.

Parameters:

datasetFile - String name of the file containing the dataset

train - boolean It must have the value "true" if we are reading the training data-set

Throws:

java.io.IOException - If there ocurs any problem with the reading of the data-set

copyHeader

public java.lang.String copyHeader()

It copies the header of the dataset

Returns:

String A string containing all the data-set information

normalize

public void normalize()

It transform the input space into the [0,1] range

hasRealAttributes

public boolean hasRealAttributes()

It checks if the data-set has any real value

Returns:

boolean True if it has some real values, else false.

hasNumericalAttributes

public boolean hasNumericalAttributes()

It checks if the data-set has any numerical value

Returns:

boolean True if it has some numerical values, else false.

hasMissingAttributes

public boolean hasMissingAttributes()

It checks if the data-set has any missing value

Returns:

boolean True if it has some missing values, else false.

sizeWithoutMissing

public int sizeWithoutMissing()

It return the size of the data-set without having account the missing values

Returns:

int the size of the data-set without having account the missing values

size

public int size()

It return the size of the data-set

Returns:

the size of the data-set

stdDev

public double stdDev(int position)

It return the standard deviation of an specific attribute

Parameters:

position - int attribute id (position of the attribute)

Returns:

double the standard deviation of the attribute

average

public double average(int position)

It return the average of an specific attribute

Parameters:

position - int attribute id (position of the attribute)

Returns:

double the average of the attribute

computeInstancesPerClass

public void computeInstancesPerClass()

It computes the number of instances of the dataset match to each existing class.

numberInstances

public int numberInstances(int clas)

It returns the number of instances in the data set for a given class.

Parameters:

clas - int Given class.

Returns:

int Number of instances for the given class.

numberValues

public int numberValues(int attribute)

Function to get the number of different feasible values for a given attribute

Parameters:

attribute - int Given attribute

Returns:

int Number of different feasible values for a given attribute

getOutputValue

public java.lang.String getOutputValue(int intValue)

It returns the output value (string) which matchs with a given integer value

Parameters:

intValue - int Given value

Returns:

String Output value in an understanding way

getDatosIndex

public java.lang.String getDatosIndex(int i,
                                      int j)

Returns the value of a given attribute for a given instance.

Parameters:

i - instance's index.

j - attribute's index.

Returns:

String values of a given attribute for a given instance.

getTipo

public int getTipo(int variable)

It returns the type of an attribute

Parameters:

variable - Given attribute

Returns:

int Type of the attribute, it is an integer which corresponds to an enummerate field

devuelveRangos

public double[][] devuelveRangos()

Returns the minimum and maximum values of every attributes as a matrix. The matrix has a size of number_of_attributes x 2 ([nAttributes][2]). The minimum value is located at the first position of each array and the maximum, at the second.

Returns:

Matrix which stores the minimum and maximum values of every attributes.

ponValor

public void ponValor(int ejemplo,
                     int atributo,
                     java.lang.String valor)

Sets a value to an attribute of a given instance.

Parameters:

ejemplo - instance's index.

atributo - attribute's index.

valor - value to set.

getRangos

public java.util.Vector getRangos()

Returns the minimum and maximum values of every attributes as a matrix. The matrix has a size of number_of_attributes x 2 ([nAttributes][2]). The minimum value is located at the first position of each array and the maximum, at the second.

Returns:

Matrix which stores the minimum and maximum values of every attributes.

printString

public java.lang.String printString()

Returns a String representation of the dataset (A list of all the instances).

Returns:

a String representation of the dataset.

print

public void print()

Prints the String representation given by printString.