fsm

Class MealyFSM

java.lang.Object

core.AbstractComponent

core.AbstractRepresentation

fsm.MealyFSM

All Implemented Interfaces:

java.lang.Comparable<AbstractRepresentation>

public class MealyFSM
extends AbstractRepresentation

Creates a Mealy finite state machine representation. A Mealy machine is a special type of finite state machine, whose output values are determined both by its current state and the current input values. Thus, previous states will have an effect on the current outputs creating a slight notion of memory.

Author:

Agnes Pinter-Bartha

Constructor Summary

Constructors

Constructor and Description
MealyFSM(int nInput, int nOutput, NESRandom random, java.util.Hashtable<java.lang.String,XMLFieldEntry> properties)

Method Summary

Methods

Modifier and Type	Method and Description
static int	calcHammingDistance(MealyFSM fsm1, MealyFSM fsm2) Calculates Hamming distance between two Mealy FSMs.
static int	calcMaxEqualPrefix(MealyFSM fsm1, MealyFSM fsm2) Calculates maximal equal prefix for two Mealy FSMs.
AbstractRepresentation	cloneFunction() Creates a full clone of this representation.
double	diffTo(AbstractRepresentation representation) Compares this representation to another one.
void	exportToFile(java.io.File saveFile) Exports the content of this representation to a file.
org.dom4j.Element	exportToXmlElement(org.dom4j.Element element) Exports this representation and all its necessary data to the provided XML element.
void	exportToYEDxmlFormat(java.lang.String name) Export FSM as a graph's edge-list into a csv (comma separated) file.
void	genRandomFSM() Generate Mealy FSM with random generation.
MealyFSM	genSimaoRandomFSM() Generates a Mealy FSM so that all of the states are reachable.
java.lang.String	genStringRepr() Generate String representation of Mealy FSM.
int	getCountOfUsedStates() Return how many states were used during evaluation of FSM.
int	getCurrentState() Return current state of the FSM.
java.util.Hashtable<java.lang.String,java.lang.String>	getDetails() Returns a table of key-value pairs that describes this representation.
java.util.ArrayList<java.lang.Float>	getFloatOutputs(java.util.ArrayList<java.lang.Integer> outputs) Return outputs associated with a transition as FREVO expects: a list of floats.
java.util.ArrayList<java.lang.Integer>	getNextStates() Get next states associated with all transitions (part of the encoding of state transition table).
int	getNStates() Returns the number of states of the Mealy FSM.
int	getNumberofMutationFunctions() Returns the number of implemented mutation functions.
int	getNumberOfRecombinationFunctions() Returns the number of implemented crossover functions.
java.util.ArrayList<java.lang.Float>	getOutput(java.util.ArrayList<java.lang.Float> input) Processes the given list of inputs and returns the corresponding output values.
java.lang.String	getOutputsAsString(java.util.ArrayList<java.lang.Integer> outputs, java.lang.String separator) Returns output list as a string.
java.util.ArrayList<java.util.ArrayList<java.lang.Integer>>	getOutputsList() Get outputs associated with all transitions (part of the encoding of state transition table).
int	getPositionInSortedInputList(java.util.ArrayList<java.lang.Float> input) Returns position of an input value combination in a sorted list, where all input value combinations are listed.
int[]	getStateHistogram() Return state histogram as an array of integer, each item specifying how many times was the FSM in a specific state.
java.lang.String	getUniqueName() Returns a unique name of this representation calculated by its parameters/structure.
java.util.ArrayList<java.lang.Integer>	getUsedStateList() Return list of used states.
AbstractRepresentation	loadFromXML(org.dom4j.Node nd) Reconstructs this representation from the given XML node.
void	mutateThresholds(float prob) Apply mutation to thresholds with a given probability
void	mutationAddState(float prob) Apply mutation add state with a given probability.
void	mutationChangeInitState(float prob) Apply mutation change initial state with a given probability
void	mutationChangeNextStates(float prob) Apply mutation to next states with a given probability
void	mutationChangeOutputs(float prob) Apply mutation to outputs with a given probability
void	mutationRemoveState(float prob) Remove a random state with a given probability
void	onepointCrossover(MealyFSM other) Performs one-point crossover between this Mealy FSM and another one.
void	recombinationFunction(AbstractRepresentation other, int method) Specific implementation of the recombination function that initiates a crossover on this representation and with the given representation with the provided function. Use AbstractRepresentation.getNumberOfRecombinationFunctions() to obtain the number of implemented recombination functions.
void	reset() Resets the representation to its base state.
void	setNextState(int pos, int nextState) Set next state in the encoded state transition table.
void	uniformCrossover(MealyFSM other) Performes uniform-crossover between this Mealy FSM and another one.

Methods inherited from class core.AbstractRepresentation

clone, compareTo, getFitness, isEvaluated, mutate, setFitness, toString, xOverWith

Methods inherited from class core.AbstractComponent

getProperties, getPropertyValue, getTypeOfProperty, getXMLData, setProperties, setXMLData

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MealyFSM

public MealyFSM(int nInput,
        int nOutput,
        NESRandom random,
        java.util.Hashtable<java.lang.String,XMLFieldEntry> properties)

Method Detail

exportToYEDxmlFormat

public void exportToYEDxmlFormat(java.lang.String name)

Export FSM as a graph's edge-list into a csv (comma separated) file. Please mind that for being able to use it with yED, you still have to transform the csv file into an xls file (e.g. open in Excel and save it as xls).

Parameters:

name - name of the file to which to export

cloneFunction

public AbstractRepresentation cloneFunction()

Description copied from class: AbstractRepresentation

Creates a full clone of this representation. The returned object must be a deep copy of this representation.

Returns:

a deep copy of this representation.

diffTo

public double diffTo(AbstractRepresentation representation)

Description copied from class: AbstractRepresentation

Compares this representation to another one. Basically, this function should provide a value measuring the distance from another representation of the same type.

Specified by:

diffTo in class AbstractRepresentation

Parameters:

representation - The other representation to compare to.

Returns:

a value representing the distance between the two candidates.

calcHammingDistance

public static int calcHammingDistance(MealyFSM fsm1,
                      MealyFSM fsm2)

Calculates Hamming distance between two Mealy FSMs. Currently compares the string representation of the two FSM.

Parameters:

fsm1 - first Mealy FSM

fsm2 - second Mealy FSM

Returns:

Hamming distance of the two FSM

calcMaxEqualPrefix

public static int calcMaxEqualPrefix(MealyFSM fsm1,
                     MealyFSM fsm2)

Calculates maximal equal prefix for two Mealy FSMs. Currently compares the string representation of the two FSM.

Parameters:

fsm1 - first Mealy FSM

fsm2 - second Mealy FSM

Returns:

maximal equal prefix of the two FSM

mutationAddState

public void mutationAddState(float prob)

Apply mutation add state with a given probability. New transition's target source is chosen randomly.

Parameters:

prob - probability of applying the mutation

mutationRemoveState

public void mutationRemoveState(float prob)

Remove a random state with a given probability

Parameters:

prob - probability of applying the mutation

mutationChangeInitState

public void mutationChangeInitState(float prob)

Apply mutation change initial state with a given probability

Parameters:

prob - probability of applying the mutation

mutationChangeOutputs

public void mutationChangeOutputs(float prob)

Apply mutation to outputs with a given probability

Parameters:

prob - probability of applying the mutation

mutationChangeNextStates

public void mutationChangeNextStates(float prob)

Apply mutation to next states with a given probability

Parameters:

prob - probability of applying the mutation

mutateThresholds

public void mutateThresholds(float prob)

Apply mutation to thresholds with a given probability

Parameters:

prob - probability of applying the mutation

getNStates

public int getNStates()

Returns the number of states of the Mealy FSM.

Returns:

number of states for this Mealy FSM

uniformCrossover

public void uniformCrossover(MealyFSM other)

Performes uniform-crossover between this Mealy FSM and another one.

Parameters:

other - The other parent (Mealy FSM) used to perform crossover.

onepointCrossover

public void onepointCrossover(MealyFSM other)

Performs one-point crossover between this Mealy FSM and another one.

Parameters:

other - The other parent (Mealy FSM) used to perform crossover.

genSimaoRandomFSM

public MealyFSM genSimaoRandomFSM()

Generates a Mealy FSM so that all of the states are reachable. Based on the following article: Simao, A., Petrenko, A. and Maldonado, J. C.: Comparing finite state machine test coverage criteria, IET Software, 3 (2) April 2009 : 91-105.

genRandomFSM

public void genRandomFSM()

Generate Mealy FSM with random generation.

exportToFile

public void exportToFile(java.io.File saveFile)

Description copied from class: AbstractRepresentation

Exports the content of this representation to a file. Format and type is custom defined.

Specified by:

exportToFile in class AbstractRepresentation

Parameters:

saveFile - The file to be saved to

exportToXmlElement

public org.dom4j.Element exportToXmlElement(org.dom4j.Element element)

Description copied from class: AbstractRepresentation

Exports this representation and all its necessary data to the provided XML element. The representation must be reconstructible from the saved data using AbstractRepresentation.loadFromXML(Node).

Specified by:

exportToXmlElement in class AbstractRepresentation

Parameters:

element - The root element to be used for saving.

getDetails

public java.util.Hashtable<java.lang.String,java.lang.String> getDetails()

Description copied from class: AbstractRepresentation

Returns a table of key-value pairs that describes this representation. This data is mostly used to visualize this specific representation instance.

Specified by:

getDetails in class AbstractRepresentation

Returns:

a human-readable table about the details/configuration of this specific instance

getNumberofMutationFunctions

public int getNumberofMutationFunctions()

Description copied from class: AbstractRepresentation

Returns the number of implemented mutation functions.

Specified by:

getNumberofMutationFunctions in class AbstractRepresentation

Returns:

the number of mutation functions implemented by this class.

getNumberOfRecombinationFunctions

public int getNumberOfRecombinationFunctions()

Description copied from class: AbstractRepresentation

Returns the number of implemented crossover functions.

Specified by:

getNumberOfRecombinationFunctions in class AbstractRepresentation

Returns:

the number of recombination functions implemented by this class.

getUniqueName

public java.lang.String getUniqueName()

Description copied from class: AbstractRepresentation

Returns a unique name of this representation calculated by its parameters/structure. This is mostly used for identification.

Specified by:

getUniqueName in class AbstractRepresentation

Returns:

a unique name of this representation instance.

loadFromXML

public AbstractRepresentation loadFromXML(org.dom4j.Node nd)

Description copied from class: AbstractRepresentation

Reconstructs this representation from the given XML node.

Specified by:

loadFromXML in class AbstractRepresentation

Parameters:

nd - The root XML node to load the data from.

Returns:

a newly created representation built from the provided data.

reset

public void reset()

Description copied from class: AbstractRepresentation

Resets the representation to its base state. Typically this is meant to erases cache for representations possessing some memory.

Specified by:

reset in class AbstractRepresentation

recombinationFunction

public void recombinationFunction(AbstractRepresentation other,
                         int method)

Description copied from class: AbstractRepresentation

Specific implementation of the recombination function that initiates a crossover on this representation and with the given representation with the provided function.
Use AbstractRepresentation.getNumberOfRecombinationFunctions() to obtain the number of implemented recombination functions.

genStringRepr

public java.lang.String genStringRepr()

Generate String representation of Mealy FSM. String representation contains the initial state, thresholds and the encoded state transition table (having format of "next state (outputs)").

A part of the Mealy FSM's string representation is the following (the FSM has 6 states, its initial state is 0 and it has two threshold values: 6 and 28):

000,06,28,1(072,020),4(053,066),3(044,067),3(040,021), ...1(063,087).

Returns:

String representation of Mealy FSM

getOutputsAsString

public java.lang.String getOutputsAsString(java.util.ArrayList<java.lang.Integer> outputs,
                                  java.lang.String separator)

Returns output list as a string.

Parameters:

outputs - output list associated with a transition

separater - String separator used to separate output values

Returns:

formatted output or null in case output is not set

getCountOfUsedStates

public int getCountOfUsedStates()

Return how many states were used during evaluation of FSM.

Returns:

count of used states

getStateHistogram

public int[] getStateHistogram()

Return state histogram as an array of integer, each item specifying how many times was the FSM in a specific state. First value is for state 0, second is for state 1 etc.

Returns:

array of integer representing histogram of used states

getUsedStateList

public java.util.ArrayList<java.lang.Integer> getUsedStateList()

Return list of used states.

Returns:

a list of used states

getFloatOutputs

public java.util.ArrayList<java.lang.Float> getFloatOutputs(java.util.ArrayList<java.lang.Integer> outputs)

Return outputs associated with a transition as FREVO expects: a list of floats.

Returns:

a list of output values

getOutput

public java.util.ArrayList<java.lang.Float> getOutput(java.util.ArrayList<java.lang.Float> input)

Description copied from class: AbstractRepresentation

Processes the given list of inputs and returns the corresponding output values. The output values must be within the range of 0..1.

Specified by:

getOutput in class AbstractRepresentation

Parameters:

input - The list of input values to be processed.

Returns:

a list of output values.

getOutputsList

public java.util.ArrayList<java.util.ArrayList<java.lang.Integer>> getOutputsList()

Get outputs associated with all transitions (part of the encoding of state transition table).

Returns:

list of outputs

getNextStates

public java.util.ArrayList<java.lang.Integer> getNextStates()

Get next states associated with all transitions (part of the encoding of state transition table).

Returns:

list of next states

setNextState

public void setNextState(int pos,
                int nextState)

Set next state in the encoded state transition table.

Parameters:

pos - position of the transition in the state transition table

nextState - next state to be set for a transition

getPositionInSortedInputList

public int getPositionInSortedInputList(java.util.ArrayList<java.lang.Float> input)

Returns position of an input value combination in a sorted list, where all input value combinations are listed.

Returns:

position of input in the sorted input list

getCurrentState

public int getCurrentState()

Return current state of the FSM.

Returns:

current state