keel.Algorithms.Genetic_Rule_Learning.XCS

Class PAREnvironment

java.lang.Object

keel.Algorithms.Genetic_Rule_Learning.XCS.PAREnvironment

All Implemented Interfaces:

Environment

public class PAREnvironment
extends java.lang.Object

This is the typical example for a single step problem, the parity problem.

Since:

JDK1.2

Version:

1.1

Author:

Written by Albert Orriols (La Salle, Ramón Llull University - Barcelona) 28/03/2004, Modified by Xavi Solé (La Salle, Ramón Llull University - Barcelona) 03/12/2008

Constructor Summary

Constructors

Constructor and Description
PAREnvironment() It is the constructor of the class.

Method Summary

Modifier and Type	Method and Description
void	beginSequentialExamples() It initializes the first example.
void	deleteMatchedExamples(Classifier cl) It deletes the examples of the database that match with the classifier given as a parameter.
double[]	getCurrentSate() The function returns the current state.
double[]	getCurrentState() The function returns the current state.
int	getEnvironmentClass() Returns the class of the environmental state.
double	getMaxPayoff() Returns the environment maximum payoff
double	getMinPayoff() Returns the environment minimum payoff
int	getNumberOfExamples() It returns the number of examples of the database.
double[]	getSequentialState() It returns the new Example of a single step file environment.
boolean	isPerformed() Returns if the class has been performed.
double	makeAction(int action) This function returns the reward given when applying the action to the environment.
double[]	newState() Creates a new state of the problem.
boolean	wasCorrect() Determines if the classification was good

Methods inherited from class java.lang.Object

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

Constructor Detail

PAREnvironment

public PAREnvironment()

It is the constructor of the class. It initializes the environment.

Method Detail

wasCorrect

public boolean wasCorrect()

Determines if the classification was good

Specified by:

wasCorrect in interface Environment

Returns:

a boolean that indicates if the last classification was good.

makeAction

public double makeAction(int action)

This function returns the reward given when applying the action to the environment.

Specified by:

makeAction in interface Environment

Parameters:

action - is the action chosen to do.

Returns:

a double with the reward

getCurrentState

public double[] getCurrentState()

The function returns the current state.

Returns:

a float[] with the current state.

newState

public double[] newState()

Creates a new state of the problem. XCS has to decide the action to do.

Specified by:

newState in interface Environment

Returns:

a float[] with the new state.

getMaxPayoff

public double getMaxPayoff()

Returns the environment maximum payoff

Specified by:

getMaxPayoff in interface Environment

Returns:

a double with the environment maximum payoff.

getMinPayoff

public double getMinPayoff()

Returns the environment minimum payoff

Specified by:

getMinPayoff in interface Environment

Returns:

a double with the environment minimum payoff.

isPerformed

public boolean isPerformed()

Returns if the class has been performed. It is used in multiple step problems.

Specified by:

isPerformed in interface Environment

Returns:

a boolean indicating if the problem has finished.

getEnvironmentClass

public int getEnvironmentClass()

Returns the class of the environmental state. It is used by UCS (supervised learning).

Specified by:

getEnvironmentClass in interface Environment

Returns:

an integer with the class associated with the current environmental state.

beginSequentialExamples

public void beginSequentialExamples()

It initializes the first example. It is used in the file environment to get the examples sequentially.

Specified by:

beginSequentialExamples in interface Environment

getSequentialState

public double[] getSequentialState()

It returns the new Example of a single step file environment.

Specified by:

getSequentialState in interface Environment

Returns:

the new Example of a single step file environment.

getNumberOfExamples

public int getNumberOfExamples()

It returns the number of examples of the database. It is only used in file environments.

Specified by:

getNumberOfExamples in interface Environment

Returns:

the number of examples of the database.

deleteMatchedExamples

public void deleteMatchedExamples(Classifier cl)

It deletes the examples of the database that match with the classifier given as a parameter. It is only used in the file environment.

Specified by:

deleteMatchedExamples in interface Environment

Parameters:

cl - classifier given

getCurrentSate

public double[] getCurrentSate()

The function returns the current state.

Returns:

a double[] with the current state.