ca.yorku.cse.mack.softkeyboard

Class MSD2

java.lang.Object

ca.yorku.cse.mack.softkeyboard.MSD2

public class MSD2
extends java.lang.Object

This class implements the Minimum String Distance (MSD) algorithm. An interface is provided to separate the input data from the implementation, and so this implementation can be applied not just to strings of characters but also to words (and it should be relatively easy to support other data types as well.

This class has a main(java.lang.String[]) function that provides command-line functionality for experimenting with the MSD algorithm.

This software is Copyright (C) 2004, by William Soukoreff and Scott MacKenzie.

Author:

William Soukoreff & Scott MacKenzie, 2004

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MSD2.Alignment The purpose of this sub-class is to hold the information for one alignment.
static interface	MSD2.MSDCollection The parameters to the MSD algorithm are provided through this interface.
static class	MSD2.TwoStringCollection An MSDCollection where the presented and transcribed text strings are simple Java Strings, and the MSD compares the individual characters within the strings.
static class	MSD2.WordCollection An MSDCollection object where the presented and transcribed texts are Vectors of Strings (viz.

Constructor Summary

Constructors

Constructor and Description
MSD2(MSD2.MSDCollection c) This constructor takes an instance of a MSD2.MSDCollection object, and calculates the Minimum String Distance.
MSD2(java.lang.String PresentedText, java.lang.String TranscribedText) This constructor takes two strings (the presented and transcribed strings) and constructs a MSD object, using the MSD2.TwoStringCollection implementation of the MSD2.MSDCollection interface.
MSD2(java.lang.String PresentedText, java.lang.String TranscribedText, boolean TranspositionsAllowed) This constructor takes two strings (the presented and transcribed strings) and constructs a MSD object, using the MSD2.TwoStringCollection implementation of the MSD2.MSDCollection interface.
MSD2(java.util.Vector<java.lang.String> PresentedData, java.util.Vector<java.lang.String> TranscribedData) This constructor takes two Vectors of strings (the presented and transcribed data) and constructs a MSD object, using the MSD2.WordCollection implementation of the MSD2.MSDCollection interface.
MSD2(java.util.Vector<java.lang.String> PresentedData, java.util.Vector<java.lang.String> TranscribedData, boolean TranspositionsAllowed) This constructor takes two Vectors of strings (the presented and transcribed data) and constructs a MSD object, using the MSD2.WordCollection implementation of the MSD2.MSDCollection interface.

Method Summary

Modifier and Type	Method and Description
MSD2.Alignment	getAlignment(int alignment) Get one of the alignments.
java.util.Vector<MSD2.Alignment>	getAlignmentVector() This function returns a Vector containing the alignments (containing MSD2.Alignment objects).
int	getAlignmentVectorSize() This function returns the number of alignments.
double	getAverageAlignmentLength() Return the average alignment length.
double	getErrorRateNew()
int	getMSD() This function returns the minimum string distance (MSD) from the MSD matrix.
java.lang.String	getPresentedItem(int index) Returns an element from the presented text.
int	getPresentedSize() This function returns the size of the presented text.
java.lang.String	getTranscribedItem(int index) Returns a element from the transcribed text.
int	getTranscribedSize() This function returns the size of the transcribed text.
static void	main(java.lang.String[] args)
void	printMSDMatrix() This function prints the contents of the MSD matrix to standard out.

Methods inherited from class java.lang.Object

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

Constructor Detail

MSD2

public MSD2(MSD2.MSDCollection c)

This constructor takes an instance of a MSD2.MSDCollection object, and calculates the Minimum String Distance.

Parameters:

c - is the source of data for the MSD algorithm (a MSD2.MSDCollection object)

See Also:

MSD2.MSDCollection

MSD2

public MSD2(java.lang.String PresentedText,
            java.lang.String TranscribedText,
            boolean TranspositionsAllowed)

This constructor takes two strings (the presented and transcribed strings) and constructs a MSD object, using the MSD2.TwoStringCollection implementation of the MSD2.MSDCollection interface.

Parameters:

PresentedText - the presented text string

TranscribedText - the transcribed text string

TraqnspositionsAllowed - a flag the specifies whether the MSD algorithm should allow transpositions (reversals of neighbouring elements in the presented and transcribed text strings

See Also:

MSD2.TwoStringCollection, MSD2.WordCollection, MSD2.MSDCollection, MSD2(java.util.Vector<java.lang.String>, java.util.Vector<java.lang.String>)

MSD2

public MSD2(java.lang.String PresentedText,
            java.lang.String TranscribedText)

This constructor takes two strings (the presented and transcribed strings) and constructs a MSD object, using the MSD2.TwoStringCollection implementation of the MSD2.MSDCollection interface.

Parameters:

PresentedText - the presented text string

TranscribedText - the transcribed text string

See Also:

MSD2.TwoStringCollection, MSD2.WordCollection, MSD2.MSDCollection, MSD2(java.util.Vector<java.lang.String>, java.util.Vector<java.lang.String>)

MSD2

public MSD2(java.util.Vector<java.lang.String> PresentedData,
            java.util.Vector<java.lang.String> TranscribedData,
            boolean TranspositionsAllowed)

This constructor takes two Vectors of strings (the presented and transcribed data) and constructs a MSD object, using the MSD2.WordCollection implementation of the MSD2.MSDCollection interface.

Parameters:

PresentedText - the presented text string

TranscribedText - the transcribed text string

TraqnspositionsAllowed - a flag the specifies whether the MSD algorithm should allow transpositions (reversals of neighbouring elements in the presented and transcribed text strings

See Also:

MSD2.WordCollection, MSD2.TwoStringCollection, MSD2.MSDCollection, MSD2(java.util.Vector<java.lang.String>, java.util.Vector<java.lang.String>)

MSD2

public MSD2(java.util.Vector<java.lang.String> PresentedData,
            java.util.Vector<java.lang.String> TranscribedData)

This constructor takes two Vectors of strings (the presented and transcribed data) and constructs a MSD object, using the MSD2.WordCollection implementation of the MSD2.MSDCollection interface.

Parameters:

PresentedText - the presented text string

TranscribedText - the transcribed text string

See Also:

MSD2.WordCollection, MSD2.TwoStringCollection, MSD2.MSDCollection, MSD2(java.util.Vector<java.lang.String>, java.util.Vector<java.lang.String>)

Method Detail

getPresentedSize

public int getPresentedSize()

This function returns the size of the presented text.

Returns:

the number of elements in the presented text.

getPresentedItem

public java.lang.String getPresentedItem(int index)

Returns an element from the presented text.

Parameters:

index - indicates which element of the presented text is desired

Returns:

the requested element

getTranscribedSize

public int getTranscribedSize()

This function returns the size of the transcribed text.

Returns:

the number of elements in the transcribed text.

getTranscribedItem

public java.lang.String getTranscribedItem(int index)

Returns a element from the transcribed text.

Parameters:

index - indicates which element of the transcribed text is desired

Returns:

the requested element

getMSD

public int getMSD()

This function returns the minimum string distance (MSD) from the MSD matrix. The MSD corresponds to the value in the bottom-right co-ordinate of the matrix.

Returns:

the MSD corresponding to the MSD matrix

getAlignmentVector

public java.util.Vector<MSD2.Alignment> getAlignmentVector()

This function returns a Vector containing the alignments (containing MSD2.Alignment objects).

Returns:

the alignments for this presented and transcribed text strings

See Also:

MSD2.Alignment

getAlignmentVectorSize

public int getAlignmentVectorSize()

This function returns the number of alignments.

Returns:

the number of alignments

See Also:

getAlignment(int)

getAlignment

public MSD2.Alignment getAlignment(int alignment)

Get one of the alignments.

Parameters:

alignment - indicates which alignment should be returned.

See Also:

#getAlignmentSize, MSD2.Alignment

getAverageAlignmentLength

public double getAverageAlignmentLength()

Return the average alignment length.

Returns:

the average length of the alignments.

printMSDMatrix

public void printMSDMatrix()

This function prints the contents of the MSD matrix to standard out.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:

java.io.IOException

getErrorRateNew

public double getErrorRateNew()