keel.Algorithms.Rule_Learning.Swap1

Class Instance

java.lang.Object

keel.Algorithms.Rule_Learning.Swap1.Instance

public class Instance
extends java.lang.Object

Instance

This class keeps all the information of an instance. It stores nominal, integer and real values read from the file (in KEEL format). Also, it provides a set of methods to get information about the instance.

Version:

keel0.1

Author:

Albert Orriols Puig

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATT_INPUT Input attributes location
static int	ATT_NONDEF Non-defined direction attributes location
static int	ATT_OUTPUT Output attributes location

Constructor Summary

Constructors

Constructor and Description
Instance(double[] values, InstanceAttributes ats) Creates an instance from a set of given values.
Instance(Instance inst) Creates a deep copy of the Instance
Instance(java.lang.String def, boolean _isTrain, int instanceNum) It parses a new attribute line.

Method Summary

Modifier and Type	Method and Description
boolean	existsAnyMissingValue() It returns if there is any missing value.
boolean	existsInputMissingValues() It informs about the existence of missing values in the inputs
boolean	existsOutputMissingValues() It informs about the existence of missing values in the outputs.
double[]	getAllInputValues() It does return all the input values.
double[]	getAllOutputValues() It does return all the output values.
boolean[]	getInputMissingValues() Get Input Missing Values
boolean	getInputMissingValues(int pos) Get Input Missing Values
java.lang.String[]	getInputNominalValues() Get Input Nominal Values
java.lang.String	getInputNominalValues(int pos) Get Input Nominal Values
int[]	getInputNominalValuesInt() It does return all the input nominal values.
int	getInputNominalValuesInt(int pos) It does return the input nominal value at the specified position.
double[]	getInputRealValues() Get Input Real Values
double	getInputRealValues(int pos) Get Input Real Values
double[]	getNormalizedInputValues() It does return the normalized values in a double[].
double[]	getNormalizedInputValues(InstanceAttributes instAttributes) Obtains the normalized input attributes from a InstanceAttribute definition
double[]	getNormalizedOutputValues() It does return the normalized values in a double[].
double[]	getNormalizedOutputValues(InstanceAttributes instAttributes) Obtains the normalized output attributes from a InstanceAttribute definition
boolean[]	getOutputMissingValues() Get Output Missing Values
boolean	getOutputMissingValues(int pos) Get Output Missing Values
java.lang.String[]	getOutputNominalValues() Get Output Nominal Values
java.lang.String	getOutputNominalValues(int pos) Get Output Nominal Values
int[]	getOutputNominalValuesInt() It does return the output value at the specified position
int	getOutputNominalValuesInt(int pos) It does return the output value at the specified position
double[]	getOutputRealValues() Get Output Real Values
double	getOutputRealValues(int pos) Get Output Real Values
void	print() It does print the instance information
void	print(InstanceAttributes instAttributes) It does print the instance information
void	print(InstanceAttributes instAttributes, java.io.PrintWriter out)
void	print(java.io.PrintWriter out) It prints the instance to the specified PrintWriter.
void	printAsOriginal(InstanceAttributes instAttributes, java.io.PrintWriter out) It prints the instance to the specified PrintWriter.
void	printAsOriginal(java.io.PrintWriter out) It prints the instance to the specified PrintWriter.
boolean	setInputNominalValue(InstanceAttributes instAttributes, int pos, java.lang.String value) Set a new value of a given input attribute in this instance (nominal)
boolean	setInputNominalValue(int pos, java.lang.String value) It set the nominal attribute value to the one passed.
boolean	setInputNumericValue(InstanceAttributes instAttributes, int pos, double value) Set a new value of a given input attribute in this instance (integer or real)
boolean	setInputNumericValue(int pos, double value) It changes the attribute value.
boolean	setOutputNominalValue(InstanceAttributes instAttributes, int pos, java.lang.String value) Set a new value of a given output attribute in this instance (nominal)
boolean	setOutputNominalValue(int pos, java.lang.String value) It set the nominal attribute value to the one passed.
boolean	setOutputNumericValue(InstanceAttributes instAttributes, int pos, double value) Set a new value of a given output attribute in this instance (integer or real)
boolean	setOutputNumericValue(int pos, double value) It changes the attribute value.
java.lang.String	toString() It does return an string with the instance information.
java.lang.String	toString(InstanceAttributes instAttributes) Prints the instance in KEEL format, according to the given Attributes definition

Methods inherited from class java.lang.Object

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

Field Detail

ATT_INPUT

public static final int ATT_INPUT

Input attributes location

See Also:

Constant Field Values

ATT_OUTPUT

public static final int ATT_OUTPUT

Output attributes location

See Also:

Constant Field Values

ATT_NONDEF

public static final int ATT_NONDEF

Non-defined direction attributes location

See Also:

Constant Field Values

Constructor Detail

Instance

public Instance(java.lang.String def,
                boolean _isTrain,
                int instanceNum)

It parses a new attribute line.

Parameters:

def - is the line to be parsed.

_isTrain - is a flag that indicates if the BD is for a train run.

instanceNum - is the number of the current instance. It's used to write error message with the maximum amount of information.

Instance

public Instance(Instance inst)

Creates a deep copy of the Instance

Parameters:

inst - Original Instance to be copied

Instance

public Instance(double[] values,
                InstanceAttributes ats)

Creates an instance from a set of given values. It is supposed that the values correspond to the current Attributes static definition or InstanceAttributes non-static definition (it depends on the InstanceSet to which this new instance will belong). If ats is null, we will use the Attributes static definiton. If not the ats definition instead.

Parameters:

values - A double array with the values (either real or nominals' index). Missing values are stored as Double.NaN

ats - The definition of the attributes (optional, if null we use Attributes definition).

Method Detail

print

public void print(java.io.PrintWriter out)

It prints the instance to the specified PrintWriter.

Parameters:

out - is the PrintWriter where to print.

printAsOriginal

public void printAsOriginal(java.io.PrintWriter out)

It prints the instance to the specified PrintWriter. The attribtes order is the same as the one in the original file.

Parameters:

out - is the PrintWriter where to print.

print

public void print()

It does print the instance information

getInputRealValues

public double[] getInputRealValues()

Get Input Real Values

Returns:

a double[] of size equal to the number of input attributes with the values of real attributes. Positions of the vector that doesn't correspond to a real attribute has no rellevant data.

getInputNominalValues

public java.lang.String[] getInputNominalValues()

Get Input Nominal Values

Returns:

a string[] of size equal to the number of input attributes with the values of nominal attributes. Positions of the vector that doesn't correspond to a nominal attribute has no rellevant data.

getInputMissingValues

public boolean[] getInputMissingValues()

Get Input Missing Values

Returns:

a boolean[] of size equal to the number of input attributes. A true value in the position i of a vector indicates that the ith input value is not known.

getOutputRealValues

public double[] getOutputRealValues()

Get Output Real Values

Returns:

a double[] of size equal to the number of output attributes with the values of real attributes. Positions of the vector that doesn't correspond to a real attribute has no rellevant data.

getOutputNominalValues

public java.lang.String[] getOutputNominalValues()

Get Output Nominal Values

Returns:

a string[] of size equal to the number of Output attributes with the values of nominal attributes. Positions of the vector that doesn't correspond to a nominal attribute has no rellevant data.

getOutputMissingValues

public boolean[] getOutputMissingValues()

Get Output Missing Values

Returns:

a boolean[] of size equal to the number of Output attributes. A true value in the position i of a vector indicates that the ith Output value is not known.

getInputRealValues

public double getInputRealValues(int pos)

Get Input Real Values

Returns:

a double with the indicated real input value.

getInputNominalValues

public java.lang.String getInputNominalValues(int pos)

Get Input Nominal Values

Returns:

a string with the indicated nominal input value.

getInputNominalValuesInt

public int getInputNominalValuesInt(int pos)

It does return the input nominal value at the specified position. The nominal value is returned as an integer.

Parameters:

pos - is the position.

Returns:

an int with the nominal value.

getInputNominalValuesInt

public int[] getInputNominalValuesInt()

It does return all the input nominal values.

getInputMissingValues

public boolean getInputMissingValues(int pos)

Get Input Missing Values

Returns:

a boolean indicating if that input value is missing.

getOutputRealValues

public double getOutputRealValues(int pos)

Get Output Real Values

Returns:

a double with the indicated real output value.

getOutputNominalValues

public java.lang.String getOutputNominalValues(int pos)

Get Output Nominal Values

Returns:

a string with the indicated nominal output value.

getOutputNominalValuesInt

public int getOutputNominalValuesInt(int pos)

It does return the output value at the specified position

Parameters:

pos - is the position.

Returns:

an int with the nominal value.

getOutputNominalValuesInt

public int[] getOutputNominalValuesInt()

It does return the output value at the specified position

getOutputMissingValues

public boolean getOutputMissingValues(int pos)

Get Output Missing Values

Returns:

a boolean indicating if that output value is missing.

getAllInputValues

public double[] getAllInputValues()

It does return all the input values. Doesn't care the type of the attributes. Nominal attributes are transformed to an integer, that is codified with a double. And integer attributes are codified with a double to. So all the values are returnes as doubles.

Returns:

a double[] with all input values.

getNormalizedInputValues

public double[] getNormalizedInputValues()

It does return the normalized values in a double[]. It means that integers are normalized o [0..N], reals to [0..1] and nominals are transformed to an integer value between [0..N], where N is the number of values that this nominal can take. In addition, missing values are represented with a -1 value.

getNormalizedOutputValues

public double[] getNormalizedOutputValues()

It does return the normalized values in a double[]. It means that integers are normalized o [0..N], reals to [0..1] and nominals are transformed to an integer value between [0..N], where N is the number of values that this nominal can take.

getAllOutputValues

public double[] getAllOutputValues()

It does return all the output values. Doesn't care the type of the attributes. Nominal attributes are transformed to an integer, that is codified with a double. And integer attributes are codified with a double to. So all the values are returnes as doubles.

Returns:

a double[] with all output values.

setInputNumericValue

public boolean setInputNumericValue(int pos,
                                    double value)

It changes the attribute value. If it can't do that, it returns a false value.

Parameters:

pos - is the attribute that has to be changed

value - is the new value

Returns:

a boolean in false state if the update of the value can't have been done.

setOutputNumericValue

public boolean setOutputNumericValue(int pos,
                                     double value)

It changes the attribute value. If it can't do that, it returns a false value.

Parameters:

pos - is the attribute that has to be changed

value - is the new value

Returns:

a boolean in false state if the update of the value can't have been done.

setInputNominalValue

public boolean setInputNominalValue(int pos,
                                    java.lang.String value)

It set the nominal attribute value to the one passed.

Parameters:

pos - is the position of the attribute.

value - is the new value.

Returns:

boolean set to false if the update has not been done.

setOutputNominalValue

public boolean setOutputNominalValue(int pos,
                                     java.lang.String value)

It set the nominal attribute value to the one passed.

Parameters:

pos - is the position of the attribute.

value - is the new value.

Returns:

boolean set to false if the update has not been done.

existsAnyMissingValue

public boolean existsAnyMissingValue()

It returns if there is any missing value.

Returns:

a boolean indicating if there's any missing value.

existsInputMissingValues

public boolean existsInputMissingValues()

It informs about the existence of missing values in the inputs

Returns:

a boolean indicating if there's any missing value in the input

existsOutputMissingValues

public boolean existsOutputMissingValues()

It informs about the existence of missing values in the outputs.

Returns:

a boolean indicating if there's any missing value in the outputs.

toString

public java.lang.String toString()

It does return an string with the instance information. The format is the same as the read one (keel format). Only are included in the string those attributes that are defined as inputs or outputs. So, NON-SPECIFIED-DIRECTION attributes are not included to this string. The order followed is: first, all input attributes are writen, in the order in which they have been read. After that, the output attributes are write. This can alter the initial order, but never mind if the output writen has the inputs and outputs correctly defined.

Overrides:

toString in class java.lang.Object

Returns:

a String with the attribute information.

print

public void print(InstanceAttributes instAttributes,
                  java.io.PrintWriter out)

printAsOriginal

public void printAsOriginal(InstanceAttributes instAttributes,
                            java.io.PrintWriter out)

It prints the instance to the specified PrintWriter. The attribtes order is the same as the one in the original file.

Parameters:

out - is the PrintWriter where to print.

print

public void print(InstanceAttributes instAttributes)

It does print the instance information

getNormalizedInputValues

public double[] getNormalizedInputValues(InstanceAttributes instAttributes)

Obtains the normalized input attributes from a InstanceAttribute definition

Parameters:

instAttributes - The Attributes definition needed to normalize

Returns:

A new allocated array with the input values normalized

getNormalizedOutputValues

public double[] getNormalizedOutputValues(InstanceAttributes instAttributes)

Obtains the normalized output attributes from a InstanceAttribute definition

Parameters:

instAttributes - The Attributes definition needed to normalize

Returns:

A new allocated array with the output values normalized

setInputNumericValue

public boolean setInputNumericValue(InstanceAttributes instAttributes,
                                    int pos,
                                    double value)

Set a new value of a given input attribute in this instance (integer or real)

Parameters:

instAttributes - The Attributes reference definition

pos - The position of the input attribute to be changed in instAttributes

value - The new value

Returns:

true if succeeded, false otherwise

setOutputNumericValue

public boolean setOutputNumericValue(InstanceAttributes instAttributes,
                                     int pos,
                                     double value)

Set a new value of a given output attribute in this instance (integer or real)

Parameters:

instAttributes - The Attributes reference definition

pos - The position of the output attribute to be changed in instAttributes

value - The new value

Returns:

true if succeeded, false otherwise

setInputNominalValue

public boolean setInputNominalValue(InstanceAttributes instAttributes,
                                    int pos,
                                    java.lang.String value)

Set a new value of a given input attribute in this instance (nominal)

Parameters:

instAttributes - The Attributes reference definition

pos - The position of the input attribute to be changed in instAttributes

value - The new value

Returns:

true if succeeded, false otherwise

setOutputNominalValue

public boolean setOutputNominalValue(InstanceAttributes instAttributes,
                                     int pos,
                                     java.lang.String value)

Set a new value of a given output attribute in this instance (nominal)

Parameters:

instAttributes - The Attributes reference definition

pos - The position of the output attribute to be changed in instAttributes

value - The new value

Returns:

true if succeeded, false otherwise

toString

public java.lang.String toString(InstanceAttributes instAttributes)

Prints the instance in KEEL format, according to the given Attributes definition

Parameters:

instAttributes - The reference Attributes definition for printing

Returns:

A new allocated String with the instance in KEEL format (CSV).