myDataset

java.lang.Object
- keel.Algorithms.Associative_Classification.ClassifierCBA.myDataset

```
public class myDataset
extends java.lang.Object
```
It contains the methods to read a Classification/Regression Dataset.

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

myDataset()
Init a new set of instances.

Constructors
Constructor and Description
`myDataset()` Init a new set of instances.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String[]`	`clases()` Returns the different classes in the data-set.
`void`	`computeInstancesPerClass()` Counts and stores the number of instances that belong to each class.
`java.lang.String`	`copyHeader()` It copies the header of the dataset.
`int[]`	`getemax()` It returns an array with the maximum values of the attributes.
`int[]`	`getemin()` It returns an array with the minimum values of the attributes.
`int[]`	`getExample(int pos)` Output a specific example.
`java.lang.String`	`getInputAsString(int var, int pos)` It returns the input value of the example "pos" as string.
`int`	`getMax(int variable)` Gets the maximum value of the variable as argument.
`int`	`getMin(int variable)` Gets the minimum value of the variable as argument.
`int`	`getnClasses()` It gets the number of output attributes of the data-set (for example number of classes in classification).
`int`	`getnData()` It gets the size of the data-set.
`int`	`getnInputs()` It gets the number of input attributes of the data-set.
`int`	`getnVars()` 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)` Returns the nominal output value which corresponds to the integer passed as argument.
`int`	`getTipo(int variable)` Returns the type of the attribute with index passed as argument.
`int[][]`	`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()` Checks if the data-set has any numeric 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.
`boolean`	`isNominal(int i)` This function checks if the attribute value is nominal.
`java.lang.String[]`	`names()` Returns the names of the different attributes of the data-set.
`int`	`numberInstances(int clas)` Returns the number of instances of the class with index passed as argument ("clas").
`int`	`numberValues(int attribute)` Returns the number of different values of the attribute with index passed as argument.
`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.
`int[]`	`returnNumberInstances()` Returns an Array with the number of instances that belong to each class.
`int[][]`	`returnRanks()` Returns the minimum and maximum values of every attributes as a matrix.
`int`	`size()` Returns the total number of instances in the data-set.
`int`	`sizeWithoutMissing()` It return the size of the data-set without having account the missing values.

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
  - myDataset
```
public myDataset()
```
    Init a new set of instances.
- Method Detail
  - getX
```
public int[][] getX()
```
    Outputs an array of examples with their corresponding attribute values.
    
    Returns:
    
    double[][] an array of examples with their corresponding attribute values
  - getExample
```
public int[] getExample(int pos)
```
    Output a specific example.
    
    Parameters:
    
    pos - 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 - the position (id) of the example
    
    Returns:
    
    String a string containing the output value
  - getInputAsString
```
public java.lang.String getInputAsString(int var,
                                         int pos)
```
    It returns the input value of the example "pos" as string.
    
    Parameters:
    
    var - the variable (id) of the example
    
    pos - the position (id) of the example
    
    Returns:
    
    String a string containing the input value
  - getOutputAsInteger
```
public int getOutputAsInteger(int pos)
```
    It returns the output value of the example "pos".
    
    Parameters:
    
    pos - the position (id) of the example
    
    Returns:
    
    an integer containing the output value
  - getOutputAsReal
```
public double getOutputAsReal(int pos)
```
    It returns the output value of the example "pos".
    
    Parameters:
    
    pos - the position (id) of the example
    
    Returns:
    
    a real containing the output value
  - getemax
```
public int[] 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 int[] 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 int getMax(int variable)
```
    Gets the maximum value of the variable as argument.
    
    Parameters:
    
    variable - index of the attribute/variable is being asked for
    
    Returns:
    
    the maximun value of the attribute as argument.
  - getMin
```
public int getMin(int variable)
```
    Gets the minimum value of the variable as argument.
    
    Parameters:
    
    variable - index of the attribute/variable is being asked for
    
    Returns:
    
    the minimum value of the attribute as argument.
  - getnData
```
public int getnData()
```
    It gets the size of the data-set.
    
    Returns:
    
    int the number of examples in the data-set
  - getnVars
```
public int getnVars()
```
    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)
  - 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 - Example id
    
    j - Variable id
    
    Returns:
    
    boolean True is the value is missing, else it returns false
  - isNominal
```
public boolean isNominal(int i)
```
    This function checks if the attribute value is nominal.
    
    Parameters:
    
    i - attribute id
    
    Returns:
    
    boolean True is the value is nominal, 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 - name of the file containing the dataset
    
    train - 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
  - 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()
```
    Checks if the data-set has any numeric value.
    
    Returns:
    
    boolean True if it has some numeric value, 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()
```
    Returns the total number of instances in the data-set.
    
    Returns:
    
    Number of instances in the data-set.
  - computeInstancesPerClass
```
public void computeInstancesPerClass()
```
    Counts and stores the number of instances that belong to each class.
  - numberInstances
```
public int numberInstances(int clas)
```
    Returns the number of instances of the class with index passed as argument ("clas").
    
    Parameters:
    
    clas - Index of the class being asked.
    
    Returns:
    
    Number of instances of the class "clas"
  - returnNumberInstances
```
public int[] returnNumberInstances()
```
    Returns an Array with the number of instances that belong to each class.
    
    Returns:
    
    Number of instances of each class.
  - numberValues
```
public int numberValues(int attribute)
```
    Returns the number of different values of the attribute with index passed as argument.
    
    Parameters:
    
    attribute - Index of the attribute being asked.
    
    Returns:
    
    Number of different values of the attribute passed as argument.
  - getOutputValue
```
public java.lang.String getOutputValue(int intValue)
```
    Returns the nominal output value which corresponds to the integer passed as argument.
    
    Parameters:
    
    intValue - Integer value which determinate the nominal output.
    
    Returns:
    
    String value which corresponds to the integer passed as argument ("intValue").
  - getTipo
```
public int getTipo(int variable)
```
    Returns the type of the attribute with index passed as argument. Possible returned values: INTEGER(1), REAL(0), NOMINAL(2) and UNDEFINED(0)
    
    Parameters:
    
    variable - Index of the attribute.
    
    Returns:
    
    the type of the attribute as a integer value.
  - returnRanks
```
public int[][] returnRanks()
```
    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.
  - names
```
public java.lang.String[] names()
```
    Returns the names of the different attributes of the data-set.
    
    Returns:
    
    An array with the manes of the attributes.
  - clases
```
public java.lang.String[] clases()
```
    Returns the different classes in the data-set.
    
    Returns:
    
    An array with the different classes.

Class myDataset

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REAL

INTEGER

NOMINAL

Constructor Detail

myDataset

Method Detail

getX

getExample

getOutputAsInteger

getOutputAsReal

getOutputAsString

getOutputAsString

getInputAsString

getOutputAsInteger

getOutputAsReal

getemax

getemin

getMax

getMin

getnData

getnVars

getnInputs

getnClasses

isMissing

isNominal

readClassificationSet

copyHeader

hasRealAttributes

hasNumericalAttributes

hasMissingAttributes

sizeWithoutMissing

size

computeInstancesPerClass

numberInstances

returnNumberInstances

numberValues

getOutputValue

getTipo

returnRanks

names

clases