metdetection.meter.lpcfg

Class MetricalLpcfg

java.lang.Object

metdetection.meter.lpcfg.MetricalLpcfg

All Implemented Interfaces:

java.io.Serializable

public class MetricalLpcfg
extends java.lang.Object
implements java.io.Serializable

A MetricalLpcfg keeps track of the lexicalized pcfg we've generated with a MetricalLpcfgGenerator.

Author:

Andrew McLeod - 29 February, 2016

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private MetricalLpcfgProbabilityTracker	probabilities The probability tracker for this grammar.
private static long	serialVersionUID Version 1 Serializable
private java.util.List<MetricalLpcfgTree>	trees A List of the trees contained in this lpcfg.

Constructor Summary

Constructors

Modifier	Constructor and Description
	MetricalLpcfg() Create a new empty grammar.
private	MetricalLpcfg(MetricalLpcfg lpcfg) Create a new grammar, used by the deepCopy() method.

Method Summary

Methods

Modifier and Type	Method and Description
void	addTree(MetricalLpcfgTree tree) Add a tree to our list of trees (trees).
MetricalLpcfg	deepCopy() Get a deep copy of this grammar.
static MetricalLpcfg	deserialize(java.io.File serialized) Load a grammar from a serialized file.
void	extractTree(MetricalLpcfgTree toExtract) Extract the given tree from our list of trees.
java.util.Set<Measure>	getMeasures() Get a Set of the Measures which are contained in any tree from within this lpcfg.
private double	getNodeLogProbability(MetricalLpcfgNode node, MetricalLpcfgHead parentHead, Measure measure) Get the log probability of the given Node.
MetricalLpcfgProbabilityTracker	getProbabilityTracker() Get the probability tracker of this grammar.
double	getTreeLogProbability(MetricalLpcfgTree tree) Get the log probability that the given tree would occur in this grammar.
java.util.List<MetricalLpcfgTree>	getTrees() Get the trees contained in this grammar.
static void	serialize(MetricalLpcfg grammar, java.io.File file) Serialize the given grammar and write it out to the given file.
java.lang.String	toString()
java.lang.String	toStringPretty() Get the pretty, recursive version of this grammar with the default tab String (\t).
java.lang.String	toStringPretty(java.lang.String tab) Get the pretty, recursive version of this grammar with the given tab String.
private void	updateCounts(MetricalLpcfgNode node, MetricalLpcfgHead parentHead, Measure measure, boolean adding) Update the counts maps recursively for each node under the given one.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Version 1 Serializable

See Also:

Constant Field Values

trees

private final java.util.List<MetricalLpcfgTree> trees

A List of the trees contained in this lpcfg.

probabilities

private final MetricalLpcfgProbabilityTracker probabilities

The probability tracker for this grammar.

Constructor Detail

MetricalLpcfg

public MetricalLpcfg()

Create a new empty grammar.

MetricalLpcfg

private MetricalLpcfg(MetricalLpcfg lpcfg)

Create a new grammar, used by the deepCopy() method.

Parameters:

lpcfg - The old grammar this one is to be a copy of.

Method Detail

getTreeLogProbability

public double getTreeLogProbability(MetricalLpcfgTree tree)

Get the log probability that the given tree would occur in this grammar.

Parameters:

tree - The tree whose log probability we want.

Returns:

The log probability of the given tree in our grammar.

getNodeLogProbability

private double getNodeLogProbability(MetricalLpcfgNode node,
                           MetricalLpcfgHead parentHead,
                           Measure measure)

Get the log probability of the given Node.

Parameters:

node - The node whose log probability we want.

parentHead - The head of the parent of this node.

measure - The measure of the tree.

Returns:

The log probability of the given node.

extractTree

public void extractTree(MetricalLpcfgTree toExtract)
                 throws MetricalLpcfgElementNotFoundException

Extract the given tree from our list of trees.

Parameters:

toExtract - The tree we want to remove from this grammar.

Throws:

MetricalLpcfgElementNotFoundException - If the given tree is not found in the grammar.

addTree

public void addTree(MetricalLpcfgTree tree)

Add a tree to our list of trees (trees).

Parameters:

tree - A new tree we want to add to this grammar.

updateCounts

private void updateCounts(MetricalLpcfgNode node,
                MetricalLpcfgHead parentHead,
                Measure measure,
                boolean adding)
                   throws MetricalLpcfgElementNotFoundException

Update the counts maps recursively for each node under the given one.

Parameters:

node - The node whose counts we want to update.

parentHead - The head of the parent of this node.

measure - The measure of the tree.

adding - True if we are adding to the counts, false if we're removing.

Throws:

MetricalLpcfgElementNotFoundException - If some

getMeasures

public java.util.Set<Measure> getMeasures()

Get a Set of the Measures which are contained in any tree from within this lpcfg.

Returns:

The Set of the Measures which are in this grammar.

getTrees

public java.util.List<MetricalLpcfgTree> getTrees()

Get the trees contained in this grammar.

Returns:

trees

getProbabilityTracker

public MetricalLpcfgProbabilityTracker getProbabilityTracker()

Get the probability tracker of this grammar.

Returns:

probabilities

deepCopy

public MetricalLpcfg deepCopy()

Get a deep copy of this grammar.

Returns:

A deep copy of this grammar.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toStringPretty

public java.lang.String toStringPretty()

Get the pretty, recursive version of this grammar with the default tab String (\t).

Returns:

The pretty recursive version of this grammar.

toStringPretty

public java.lang.String toStringPretty(java.lang.String tab)

Get the pretty, recursive version of this grammar with the given tab String.

Parameters:

tab - The tab String to use for indenting tree levels.

Returns:

The pretty recursive version of this grammar.

serialize

public static void serialize(MetricalLpcfg grammar,
             java.io.File file)
                      throws java.io.FileNotFoundException,
                             java.io.IOException

Serialize the given grammar and write it out to the given file.

Parameters:

grammar - The grammar we want to serialize.

file - The file to write out the grammar to.

Throws:

java.io.FileNotFoundException - The file could not be opened for writing.

java.io.IOException - Some IO error occurred.

See Also:

deserialize(File)

deserialize

public static MetricalLpcfg deserialize(java.io.File serialized)
                                 throws java.lang.ClassNotFoundException,
                                        java.io.IOException

Load a grammar from a serialized file.

Parameters:

serialized - The file containing a serialized grammar.

Returns:

The grammar loaded from the given file.

Throws:

java.lang.ClassNotFoundException - The class could not be deserialized properly.

java.io.IOException - Some IO error occurred.

See Also:

serialize(MetricalLpcfg, File)