myDataset

java.lang.Object
- keel.Algorithms.Associative_Classification.ClassifierCPAR.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()` It returns the name of every output values (possible classes).
`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
`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)` It returns the maximum value of the given attribute
`int`	`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`	`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)` It returns the output value (string) which matchs with a given integer value
`int`	`getTipo(int variable)` It returns the type of an attribute
`double`	`getWeight(int pos)` It returns the weight of the given example
`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()` It checks if the data-set has any numerical value
`boolean`	`hasRealAttributes()` It checks if the data-set has any real value
`void`	`iniWeight()` It initializes the weights for each example to 1.
`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()` It returns the name of every input attributes.
`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`	`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`	`reduceWeight(int pos, double alfa)` It reduces the weight of the given example in a factor alfa
`int[]`	`returnNumberInstances()` It returns the number of instances in the dataset for each class.
`int[][]`	`returnRanks()` Returns the minimum and maximum values of every attributes as a matrix.
`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

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 - 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
  - getInputAsString
```
public java.lang.String getInputAsString(int var,
                                         int pos)
```
    It returns the input value of the example "pos" as string
    
    Parameters:
    
    var - int the variable (id) of the example
    
    pos - int 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 - 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 int[] getemax()
```
    It returns an array with the maximum values of the attributes
    
    Returns:
    
    int[] 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:
    
    int[] an array with the minimum values of the attributes
  - getMax
```
public int 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 int 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
  - 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 - int Example id
    
    j - int 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 - int 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 - 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
  - 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
  - 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.
  - returnNumberInstances
```
public int[] returnNumberInstances()
```
    It returns the number of instances in the dataset for each class.
    
    Returns:
    
    int [] Array of integers with the number of instances for each class.
  - iniWeight
```
public void iniWeight()
```
    It initializes the weights for each example to 1.
  - reduceWeight
```
public void reduceWeight(int pos,
                         double alfa)
```
    It reduces the weight of the given example in a factor alfa
    
    Parameters:
    
    pos - index of the example
    
    alfa - reduction factor
  - getWeight
```
public double getWeight(int pos)
```
    It returns the weight of the given example
    
    Parameters:
    
    pos - index of the example
    
    Returns:
    
    the weight of the given example
  - 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
  - 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
  - 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()
```
    It returns the name of every input attributes.
    
    Returns:
    
    String [] Array of strings with the name of every input attribute's names.
  - clases
```
public java.lang.String[] clases()
```
    It returns the name of every output values (possible classes).
    
    Returns:
    
    String [] Array of strings with the name of every output attribute's names.

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

iniWeight

reduceWeight

getWeight

numberValues

getOutputValue

getTipo

returnRanks

names

clases